Add possibility to auto select record format based on available forma…

…ts factory services.
neo4j · Apr 3, 2016 · d930d8a · d930d8a
1 parent 11e5367
commit d930d8a
Show file tree

Hide file tree

Showing 22 changed files with 107 additions and 135 deletions.
diff --git a/community/consistency-check/src/main/java/org/neo4j/consistency/ConsistencyCheckService.java b/community/consistency-check/src/main/java/org/neo4j/consistency/ConsistencyCheckService.java
@@ -126,8 +126,8 @@ public Result runFullConsistencyCheck( final File storeDir, Config tuningConfigu
                 MapUtil.stringMap( GraphDatabaseSettings.read_only.name(), Settings.TRUE ) );
         StoreFactory factory = new StoreFactory( storeDir, consistencyCheckerConfig,
                 new DefaultIdGeneratorFactory( fileSystem ), pageCache, fileSystem,
-                RecordFormatSelector.select( consistencyCheckerConfig, LowLimitV3_0.RECORD_FORMATS,
+                RecordFormatSelector.autoSelectFormat( consistencyCheckerConfig, NullLogService.getInstance() ),
-                        NullLogService.getInstance()), logProvider );
+                logProvider );
 
         ConsistencySummaryStatistics summary;
         final File reportFile = chooseReportPath(tuningConfiguration );

diff --git a/...ncy-check/src/test/java/org/neo4j/consistency/ConsistencyCheckServiceIntegrationTest.java b/...ncy-check/src/test/java/org/neo4j/consistency/ConsistencyCheckServiceIntegrationTest.java
@@ -46,8 +46,6 @@
 import org.neo4j.kernel.configuration.Config;
 import org.neo4j.kernel.configuration.Settings;
 import org.neo4j.kernel.impl.factory.GraphDatabaseFacadeFactory;
-import org.neo4j.kernel.impl.store.format.RecordFormats;
-import org.neo4j.kernel.impl.store.format.lowlimit.LowLimitV3_0;
 import org.neo4j.kernel.impl.store.record.NodeRecord;
 import org.neo4j.logging.NullLogProvider;
 import org.neo4j.test.TargetDirectory;
@@ -64,7 +62,7 @@
 public class ConsistencyCheckServiceIntegrationTest
 {
 
-    private final GraphStoreFixture fixture = new GraphStoreFixture(getRecordFormats(), getRecordFormatName())
+    private final GraphStoreFixture fixture = new GraphStoreFixture( getRecordFormatName() )
     {
         @Override
         protected void generateInitialData( GraphDatabaseService graphDb )
@@ -239,9 +237,4 @@ protected String getRecordFormatName()
     {
         return StringUtils.EMPTY;
     }
-
-    protected RecordFormats getRecordFormats()
-    {
-        return LowLimitV3_0.RECORD_FORMATS;
-    }
 }
diff --git a/...ity/consistency-check/src/test/java/org/neo4j/consistency/checking/GraphStoreFixture.java b/...ity/consistency-check/src/test/java/org/neo4j/consistency/checking/GraphStoreFixture.java
@@ -57,7 +57,7 @@
 import org.neo4j.kernel.impl.store.NodeStore;
 import org.neo4j.kernel.impl.store.StoreAccess;
 import org.neo4j.kernel.impl.store.StoreFactory;
-import org.neo4j.kernel.impl.store.format.RecordFormats;
+import org.neo4j.kernel.impl.store.format.RecordFormatSelector;
 import org.neo4j.kernel.impl.store.format.lowlimit.LowLimitV3_0;
 import org.neo4j.kernel.impl.store.record.DynamicRecord;
 import org.neo4j.kernel.impl.store.record.NeoStoreRecord;
@@ -103,30 +103,22 @@ public abstract class GraphStoreFixture extends PageCacheRule implements TestRul
     private long arrayPropId;
     private int relTypeId;
     private int propKeyId;
-    private RecordFormats recordFormats = LowLimitV3_0.RECORD_FORMATS;
     private String formatName = StringUtils.EMPTY;
 
-    public GraphStoreFixture( boolean keepStatistics, RecordFormats recordFormats, String formatName )
+    public GraphStoreFixture( boolean keepStatistics, String formatName )
     {
         this.keepStatistics = keepStatistics;
-        this.recordFormats = recordFormats;
         this.formatName = formatName;
     }
 
-    public GraphStoreFixture(RecordFormats recordFormats, String formatName)
+    public GraphStoreFixture( String formatName )
     {
-        this( false, recordFormats, formatName );
+        this( false, formatName );
     }
 
     public GraphStoreFixture()
     {
-        this( false, LowLimitV3_0.RECORD_FORMATS, LowLimitV3_0.NAME );
+        this( false, LowLimitV3_0.NAME );
-    }
-
-    public GraphStoreFixture withRecordFormats( RecordFormats recordFormats )
-    {
-        this.recordFormats = recordFormats;
-        return this;
     }
 
     public void apply( Transaction transaction ) throws TransactionFailureException
@@ -140,7 +132,7 @@ public DirectStoreAccess directStoreAccess()
         {
             DefaultFileSystemAbstraction fileSystem = new DefaultFileSystemAbstraction();
             PageCache pageCache = getPageCache( fileSystem );
-            neoStore = new StoreFactory( fileSystem, directory, pageCache, recordFormats,
+            neoStore = new StoreFactory( fileSystem, directory, pageCache, RecordFormatSelector.autoSelectFormat(),
                     NullLogProvider.getInstance() ).openAllNeoStores();
             StoreAccess nativeStores;
             if ( keepStatistics )

diff --git a/...test/java/org/neo4j/consistency/checking/full/DetectAllRelationshipInconsistenciesIT.java b/...test/java/org/neo4j/consistency/checking/full/DetectAllRelationshipInconsistenciesIT.java
@@ -47,8 +47,7 @@
 import org.neo4j.kernel.impl.store.StoreAccess;
 import org.neo4j.kernel.impl.store.StoreFactory;
 import org.neo4j.kernel.impl.store.StoreType;
-import org.neo4j.kernel.impl.store.format.RecordFormats;
+import org.neo4j.kernel.impl.store.format.RecordFormatSelector;
-import org.neo4j.kernel.impl.store.format.lowlimit.LowLimitV3_0;
 import org.neo4j.kernel.impl.store.record.RecordLoad;
 import org.neo4j.kernel.impl.store.record.RelationshipRecord;
 import org.neo4j.kernel.internal.GraphDatabaseAPI;
@@ -98,7 +97,7 @@ public void shouldDetectSabotagedRelationshipWhereEverItIs() throws Exception
             DependencyResolver resolver = db.getDependencyResolver();
             PageCache pageCache = resolver.resolveDependency( PageCache.class );
             StoreFactory storeFactory = new StoreFactory( fileSystem, directory.directory(), pageCache,
-                    getRecordFormats(), NullLogProvider.getInstance() );
+                    RecordFormatSelector.autoSelectFormat(), NullLogProvider.getInstance() );
 
             try ( NeoStores neoStores = storeFactory.openNeoStores( false, StoreType.RELATIONSHIP ) )
             {
@@ -119,7 +118,7 @@ public void shouldDetectSabotagedRelationshipWhereEverItIs() throws Exception
             DependencyResolver resolver = db.getDependencyResolver();
             PageCache pageCache = resolver.resolveDependency( PageCache.class );
             StoreFactory storeFactory = new StoreFactory( fileSystem, directory.directory(), pageCache,
-                    getRecordFormats(), NullLogProvider.getInstance() );
+                    RecordFormatSelector.autoSelectFormat(), NullLogProvider.getInstance() );
 
             try ( NeoStores neoStores = storeFactory.openAllNeoStores() )
             {
@@ -165,11 +164,6 @@ protected String getRecordFormatName()
         return StringUtils.EMPTY;
     }
 
-    protected RecordFormats getRecordFormats()
-    {
-        return LowLimitV3_0.RECORD_FORMATS;
-    }
-
     private static class Sabotage
     {
         private final RelationshipRecord before;

diff --git a/...heck/src/test/java/org/neo4j/consistency/checking/full/ExecutionOrderIntegrationTest.java b/...heck/src/test/java/org/neo4j/consistency/checking/full/ExecutionOrderIntegrationTest.java
@@ -32,7 +32,6 @@
 import java.util.Iterator;
 import java.util.Map;
 
-import org.neo4j.consistency.ConsistencyCheckSettings;
 import org.neo4j.consistency.checking.CheckDecorator;
 import org.neo4j.consistency.checking.CheckerEngine;
 import org.neo4j.consistency.checking.ComparativeRecordChecker;
@@ -58,8 +57,6 @@
 import org.neo4j.kernel.configuration.Config;
 import org.neo4j.kernel.impl.factory.GraphDatabaseFacadeFactory;
 import org.neo4j.kernel.impl.store.StoreAccess;
-import org.neo4j.kernel.impl.store.format.RecordFormats;
-import org.neo4j.kernel.impl.store.format.lowlimit.LowLimitV3_0;
 import org.neo4j.kernel.impl.store.record.AbstractBaseRecord;
 import org.neo4j.kernel.impl.store.record.DynamicRecord;
 import org.neo4j.kernel.impl.store.record.LabelTokenRecord;
@@ -87,7 +84,7 @@
 public class ExecutionOrderIntegrationTest
 {
     @Rule
-    public final GraphStoreFixture fixture = new GraphStoreFixture(getRecordFormats(), getRecordFormatName())
+    public final GraphStoreFixture fixture = new GraphStoreFixture( getRecordFormatName() )
     {
         @Override
         protected void generateInitialData( GraphDatabaseService graphDb )
@@ -139,11 +136,6 @@ protected String getRecordFormatName()
         return StringUtils.EMPTY;
     }
 
-    protected RecordFormats getRecordFormats()
-    {
-        return LowLimitV3_0.RECORD_FORMATS;
-    }
-
     private static class InvocationLog
     {
         private final Map<String, Throwable> data = new HashMap<>();

diff --git a/...ncy-check/src/test/java/org/neo4j/consistency/checking/full/FullCheckIntegrationTest.java b/...ncy-check/src/test/java/org/neo4j/consistency/checking/full/FullCheckIntegrationTest.java
@@ -90,8 +90,6 @@
 import org.neo4j.kernel.impl.store.SchemaStorage;
 import org.neo4j.kernel.impl.store.SchemaStore;
 import org.neo4j.kernel.impl.store.StoreAccess;
-import org.neo4j.kernel.impl.store.format.RecordFormats;
-import org.neo4j.kernel.impl.store.format.lowlimit.LowLimitV3_0;
 import org.neo4j.kernel.impl.store.record.AbstractSchemaRule;
 import org.neo4j.kernel.impl.store.record.DynamicRecord;
 import org.neo4j.kernel.impl.store.record.IndexRule;
@@ -203,7 +201,7 @@ public static void verifyThatWeHaveExercisedAllTypesOfInconsistenciesThatWeHave(
     }
 
 
-    private final GraphStoreFixture fixture = new GraphStoreFixture(getRecordFormats(), getRecordFormatName())
+    private final GraphStoreFixture fixture = new GraphStoreFixture( getRecordFormatName() )
     {
         @Override
         protected void generateInitialData( GraphDatabaseService db )
@@ -2059,11 +2057,6 @@ protected String getRecordFormatName()
         return StringUtils.EMPTY;
     }
 
-    protected RecordFormats getRecordFormats()
-    {
-        return LowLimitV3_0.RECORD_FORMATS;
-    }
-
     private int createLabel() throws Exception
     {
         final MutableInteger id = new MutableInteger( -1 );

diff --git a/...tency-check/src/test/java/org/neo4j/consistency/repair/RelationshipChainExplorerTest.java b/...tency-check/src/test/java/org/neo4j/consistency/repair/RelationshipChainExplorerTest.java
@@ -37,15 +37,12 @@
 import org.neo4j.kernel.impl.factory.GraphDatabaseFacadeFactory;
 import org.neo4j.kernel.impl.store.RecordStore;
 import org.neo4j.kernel.impl.store.StoreAccess;
-import org.neo4j.kernel.impl.store.format.RecordFormats;
-import org.neo4j.kernel.impl.store.format.lowlimit.LowLimitV3_0;
 import org.neo4j.kernel.impl.store.record.RelationshipRecord;
 import org.neo4j.test.PageCacheRule;
 import org.neo4j.test.TargetDirectory;
 import org.neo4j.test.TestGraphDatabaseFactory;
 
 import static org.junit.Assert.assertEquals;
-
 import static org.neo4j.kernel.impl.store.record.RecordLoad.NORMAL;
 
 public class RelationshipChainExplorerTest
@@ -144,12 +141,7 @@ private StoreAccess createStoreWithOneHighDegreeNodeAndSeveralDegreeTwoNodes( in
         }
         database.shutdown();
         PageCache pageCache = pageCacheRule.getPageCache( new DefaultFileSystemAbstraction() );
-        return new StoreAccess( pageCache, storeDirectory, getRecordFormats() ).initialize();
+        return new StoreAccess( pageCache, storeDirectory ).initialize();
-    }
-
-    protected RecordFormats getRecordFormats()
-    {
-        return LowLimitV3_0.RECORD_FORMATS;
     }
 
     protected String getRecordFormatName()

diff --git a/community/kernel/src/main/java/org/neo4j/kernel/impl/store/StoreAccess.java b/community/kernel/src/main/java/org/neo4j/kernel/impl/store/StoreAccess.java
@@ -24,11 +24,11 @@
 import org.neo4j.io.fs.DefaultFileSystemAbstraction;
 import org.neo4j.io.fs.FileSystemAbstraction;
 import org.neo4j.io.pagecache.PageCache;
-import org.neo4j.kernel.impl.store.format.RecordFormats;
-import org.neo4j.kernel.impl.store.format.lowlimit.LowLimitV3_0;
-import org.neo4j.kernel.impl.store.id.DefaultIdGeneratorFactory;
 import org.neo4j.kernel.configuration.Config;
 import org.neo4j.kernel.impl.api.CountsAccessor;
+import org.neo4j.kernel.impl.logging.NullLogService;
+import org.neo4j.kernel.impl.store.format.RecordFormatSelector;
+import org.neo4j.kernel.impl.store.id.DefaultIdGeneratorFactory;
 import org.neo4j.kernel.impl.store.record.AbstractBaseRecord;
 import org.neo4j.kernel.impl.store.record.DynamicRecord;
 import org.neo4j.kernel.impl.store.record.LabelTokenRecord;
@@ -74,21 +74,21 @@ public StoreAccess( NeoStores store )
         this.counts = store.getCounts();
     }
 
-    public StoreAccess( PageCache pageCache, File storeDir, RecordFormats recordFormats )
+    public StoreAccess( PageCache pageCache, File storeDir )
     {
-        this( new DefaultFileSystemAbstraction(), pageCache, storeDir, recordFormats);
+        this( new DefaultFileSystemAbstraction(), pageCache, storeDir );
     }
 
-    public StoreAccess( FileSystemAbstraction fileSystem, PageCache pageCache, File storeDir, RecordFormats recordFormats )
+    public StoreAccess( FileSystemAbstraction fileSystem, PageCache pageCache, File storeDir )
     {
-        this( fileSystem, pageCache, storeDir, Config.defaults(), recordFormats );
+        this( fileSystem, pageCache, storeDir, Config.defaults() );
     }
 
-    private StoreAccess( FileSystemAbstraction fileSystem, PageCache pageCache, File storeDir, Config config,
+    private StoreAccess( FileSystemAbstraction fileSystem, PageCache pageCache, File storeDir, Config config )
-            RecordFormats recordFormats )
     {
         this( new StoreFactory( storeDir, config, new DefaultIdGeneratorFactory( fileSystem ), pageCache,
-                fileSystem, recordFormats, NullLogProvider.getInstance() ).openAllNeoStores() );
+                fileSystem, RecordFormatSelector.autoSelectFormat(config, NullLogService.getInstance()),
+                NullLogProvider.getInstance() ).openAllNeoStores() );
         this.closeable = true;
     }
 

diff --git a/community/kernel/src/main/java/org/neo4j/kernel/impl/store/format/RecordFormatSelector.java b/community/kernel/src/main/java/org/neo4j/kernel/impl/store/format/RecordFormatSelector.java
@@ -21,6 +21,8 @@
 
 import org.apache.commons.lang3.StringUtils;
 
+import java.util.Iterator;
+
 import org.neo4j.helpers.Service;
 import org.neo4j.kernel.configuration.Config;
 import org.neo4j.kernel.impl.factory.GraphDatabaseFacadeFactory;
@@ -43,6 +45,9 @@
  */
 public class RecordFormatSelector
 {
+
+    private static final RecordFormats DEFAULT_AUTOSELECT_FORMAT = LowLimitV3_0.RECORD_FORMATS;
+
     private static final Iterable<RecordFormats> KNOWN_FORMATS = asList(
             LowLimitV2_0.RECORD_FORMATS,
             LowLimitV2_1.RECORD_FORMATS,
@@ -132,6 +137,30 @@ private static RecordFormats loadRecordFormat( String recordFormat )
         return null;
     }
 
+    public static RecordFormats autoSelectFormat()
+    {
+        return autoSelectFormat( Config.empty(), NullLogService.getInstance() );
+    }
+
+    public static RecordFormats autoSelectFormat( Config config, LogService logService )
+    {
+        String recordFormat = configuredRecordFormat( config );
+        RecordFormats formats = loadRecordFormat( recordFormat );
+        if ( formats != null )
+        {
+            logService.getInternalLog( RecordFormatSelector.class ).warn( "Selected " +
+                                                     recordFormat.getClass().getName() + " record format." );
+            return formats;
+        }
+        Iterable<RecordFormats.Factory> formatFactories = Service.load( RecordFormats.Factory.class );
+        Iterator<RecordFormats.Factory> factoryIterator = formatFactories.iterator();
+        RecordFormats recordFormats = factoryIterator.hasNext() ? factoryIterator.next().newInstance() : DEFAULT_AUTOSELECT_FORMAT;
+        logService.getInternalLog( RecordFormatSelector.class ).warn( "Selected " +
+                                                                      recordFormats.getClass().getName() + " record " +
+                                                                      "format." );
+        return recordFormats;
+    }
+
     private static RecordFormats handleMissingFormat( String recordFormat, LogService logService )
     {
         logService.getInternalLog( RecordFormatSelector.class )

diff --git a/community/kernel/src/test/java/org/neo4j/kernel/impl/store/TestStoreAccess.java b/community/kernel/src/test/java/org/neo4j/kernel/impl/store/TestStoreAccess.java
@@ -31,7 +31,6 @@
 import org.neo4j.io.fs.FileSystemAbstraction;
 import org.neo4j.io.pagecache.PageCache;
 import org.neo4j.kernel.impl.recovery.RecoveryRequiredChecker;
-import org.neo4j.kernel.impl.store.format.lowlimit.LowLimitV3_0;
 import org.neo4j.test.EphemeralFileSystemRule;
 import org.neo4j.test.PageCacheRule;
 import org.neo4j.test.TestGraphDatabaseFactory;
@@ -56,7 +55,7 @@ public void openingThroughStoreAccessShouldNotTriggerRecovery() throws Exception
         snapshot.deleteFile( messages );
 
         PageCache pageCache = pageCacheRule.getPageCache( snapshot );
-        new StoreAccess( snapshot, pageCache, storeDir, LowLimitV3_0.RECORD_FORMATS ).initialize().close();
+        new StoreAccess( snapshot, pageCache, storeDir ).initialize().close();
         assertTrue( "Store should be unclean", isUnclean( snapshot ) );
     }