[HDDS-10008] Restrict allowed rocksdb imports in rocksdb-checkpoint-differ

• Type: Sub-task
• Status: Resolved
• Priority: Major
• Resolution: Duplicate
• Affects Version/s: 1.4.0
• Component/s: Snapshot
• Target Version/s: 1.5.0
• Assignee: Unassigned
• Reporter: Attila Doroszlai
• Created: 23/Dec/23 11:58
• Updated: 03/May/24 18:27
• Resolved: 03/May/24 18:27

Description

rocksdb-checkpoint-differ overrides import restrictions on rocksdb classes from root POM.

https://github.com/apache/ozone/blob/f9167a359e7ff6f54eafc8a7b1c3fd165050160f/hadoop-hdds/rocksdb-checkpoint-differ/pom.xml#L125-L150

                <RestrictImports>
                  <includeTestCode>false</includeTestCode>
                  <reason>Use managed RocksObjects under org.apache.hadoop.hdds.utils.db.managed instead.</reason>
                  <!-- By default, ban all the classes in org.rocksdb -->
                  <bannedImport>org.rocksdb.**</bannedImport>
                  <allowedImports>
                    <allowedImport>org.rocksdb.AbstractEventListener</allowedImport>
                    <allowedImport>org.rocksdb.Checkpoint</allowedImport>
                    <allowedImport>org.rocksdb.ColumnFamilyDescriptor</allowedImport>
                    <allowedImport>org.rocksdb.ColumnFamilyHandle</allowedImport>
                    <allowedImport>org.rocksdb.ColumnFamilyOptions</allowedImport>
                    <allowedImport>org.rocksdb.CompactionJobInfo</allowedImport>
                    <allowedImport>org.rocksdb.CompressionType</allowedImport>
                    <allowedImport>org.rocksdb.DBOptions</allowedImport>
                    <allowedImport>org.rocksdb.FlushOptions</allowedImport>
                    <allowedImport>org.rocksdb.LiveFileMetaData</allowedImport>
                    <allowedImport>org.rocksdb.Options</allowedImport>
                    <allowedImport>org.rocksdb.RocksDB</allowedImport>
                    <allowedImport>org.rocksdb.RocksDBException</allowedImport>
                    <allowedImport>org.rocksdb.SstFileReader</allowedImport>
                    <allowedImport>org.rocksdb.TableProperties</allowedImport>
                    <allowedImport>org.rocksdb.ReadOptions</allowedImport>
                    <allowedImport>org.rocksdb.SstFileReaderIterator</allowedImport>
                  </allowedImports>
                  <exclusion>org.apache.hadoop.hdds.utils.db.managed.*</exclusion>
                </RestrictImports>

• Some of these are unnecessary, this module could use Managed... classes instead. Using non-managed versions prevents leak detection.
• Some are OK to use and could be moved to root POM.
• exclusion is useless since this module does not define classes in the org.apache.hadoop.hdds.utils.db.managed package.

Issue Links

• is related to: HDDS-10001 Options not closed properly in rocksdb-checkpoint-differ
• relates to: HDDS-10787 Updated RocksdbCheckpointDiffer to use managed RocksDb objects