System Settings are not properly stored and cannot be properly retrieved from the database when comments are included in a configuration file

• Type: Bug
• Status: Closed
• Resolution: Fixed
• Affects Version/s: 7.0.X, 7.1.X, Master
• Fix Version/s: 7.0.0 DXP FP72, 7.0.10.11 DXP SP11, 7.0.X, 7.1.10 DXP FP7, 7.1.10.2 SP2, 7.1.3 CE GA4, 7.1.X, Master
• Component/s: Portal Configuration > System Settings
• Labels:
  • ee-ts
  • liferay-dxp-70-sp11
  • liferay-dxp-71-sp2
  • liferay-fixpack-de-72-7010
  • liferay-fixpack-dxp-7-7110
• Branch Version/s:
  7.1.x, 7.0.x
• Backported to Branch:
  Committed
• Fix Priority: 3
• Git Pull Request: https://github.com/brianchandotcom/liferay-portal/pull/67302

Description

When a configuration file is used to provide a System Setting and the file contains a comment, the configuration is improperly stored in the database.

This may lead to inconsistent behavior, such as:

• Orphaned configuration entries in the database
• Inability to read the configuration entry that is stored in the database

Steps to Reproduce

1. Start Liferay and wait for startup to complete
2. Check database table: Configuration_
   • Notice that there is no entry for

     com.liferay.blogs.configuration.BlogsConfiguration
     

3. Create configuration file: [LIFERAY_HOME]/osgi/configs/com.liferay.blogs.configuration.BlogsConfiguration.config

   foobar=["foo","bar"]
   

4. Wait for 30 seconds
5. Check database table: Configuration_ for the entry:

   com.liferay.blogs.configuration.BlogsConfiguration
   

   • Notice that an entry now exists
6. Shutdown Liferay
7. Remove configuration file: [LIFERAY_HOME]/osgi/configs/com.liferay.blogs.configuration.BlogsConfiguration.config
8. Startup Liferay and wait for startup to complete
9. Check database table: Configuration_ for the entry:

   com.liferay.blogs.configuration.BlogsConfiguration
   

   • Notice that the entry is now gone
10. Next, let's test with a comment
11. Create configuration file with a comment: [LIFERAY_HOME]/osgi/configs/com.liferay.blogs.configuration.BlogsConfiguration.config

    #foobar=["foo","bar"]
    

12. Repeat steps 4-9

Expected Result
The configuration entry has been removed

Actual Result
The configuration entry still exists