Include index information when throwing index population failure

neo4j · Mar 11, 2019 · 6f703c8 · 6f703c8
1 parent 53f28b2
commit 6f703c8
Show file tree

Hide file tree

Showing 5 changed files with 10 additions and 4 deletions.
diff --git a/...y-it/kernel-it/src/test/java/org/neo4j/kernel/impl/coreapi/schema/SchemaImplMockTest.java b/...y-it/kernel-it/src/test/java/org/neo4j/kernel/impl/coreapi/schema/SchemaImplMockTest.java
@@ -48,13 +48,15 @@ void includeCauseOfFailure() throws IndexNotFoundKernelException
     {
         // given
         IndexDefinitionImpl indexDefinition = mockIndexDefinition();
+        when( indexDefinition.toString() ).thenReturn( "IndexDefinition( of-some-sort )" );
         KernelTransaction kernelTransaction = mockKernelTransaction();
         SchemaImpl schema = new SchemaImpl( () -> kernelTransaction );
 
         // when
         IllegalStateException e = assertThrows( IllegalStateException.class, () -> schema.awaitIndexOnline( indexDefinition, 1, TimeUnit.MINUTES ) );
 
         // then
+        assertThat( e.getMessage(), Matchers.containsString( indexDefinition.toString() ) );
         assertThat( e.getMessage(), Matchers.containsString( Exceptions.stringify( cause ) ) );
     }
 

diff --git a/community/kernel/src/main/java/org/neo4j/kernel/impl/api/index/IndexingService.java b/community/kernel/src/main/java/org/neo4j/kernel/impl/api/index/IndexingService.java
@@ -422,7 +422,8 @@ private void awaitOnline( IndexProxy proxy )
                 return;
             case FAILED:
                 IndexPopulationFailure populationFailure = proxy.getPopulationFailure();
-                String message = String.format( "Index entered %s state while recovery waited for it to be fully populated.", FAILED );
+                String message =
+                        String.format( "Index entered %s state while recovery waited for it to be fully populated. Index: %s.", FAILED, proxy.getDescriptor() );
                 String causeOfFailure = populationFailure.asString();
                 throw new IllegalStateException( IndexPopulationFailure.appendCauseOfFailure( message, causeOfFailure ) );
             case POPULATING:

diff --git a/community/kernel/src/main/java/org/neo4j/kernel/impl/coreapi/schema/SchemaImpl.java b/community/kernel/src/main/java/org/neo4j/kernel/impl/coreapi/schema/SchemaImpl.java
@@ -203,7 +203,8 @@ public void awaitIndexOnline( IndexDefinition index, long duration, TimeUnit uni
                 return;
             case FAILED:
                 String cause = getIndexFailure( index );
-                String message = IndexPopulationFailure.appendCauseOfFailure( "Index entered a FAILED state. Please see database logs.", cause );
+                String message = IndexPopulationFailure
+                        .appendCauseOfFailure( String.format( "Index entered a %s state. Please see database logs. Index: %s", state, index ), cause );
                 throw new IllegalStateException( message );
             default:
                 try

diff --git a/community/kernel/src/test/java/org/neo4j/kernel/builtinprocs/AwaitIndexProcedureTest.java b/community/kernel/src/test/java/org/neo4j/kernel/builtinprocs/AwaitIndexProcedureTest.java
@@ -157,6 +157,7 @@ public void shouldThrowAnExceptionIfTheIndexHasFailed() throws IndexNotFoundKern
         catch ( ProcedureException e )
         {
             assertThat( e.status(), is( Status.Schema.IndexCreationFailed ) );
+            assertThat( e.getMessage(), containsString( ":Person(name)" ) );
             assertThat( e.getMessage(), containsString( "Kilroy was here" ) );
         }
     }

diff --git a/community/kernel/src/test/java/org/neo4j/kernel/impl/api/index/IndexingServiceTest.java b/community/kernel/src/test/java/org/neo4j/kernel/impl/api/index/IndexingServiceTest.java
@@ -1080,7 +1080,7 @@ public void shouldReportCauseOfPopulationFailureIfPopulationFailsDuringRecovery(
     {
         // given
         long indexId = 1;
-        StoreIndexDescriptor indexRule = uniqueIndex.withId( indexId );
+        CapableIndexDescriptor indexRule = uniqueIndex.withId( indexId ).withoutCapabilities();
         Barrier.Control barrier = new Barrier.Control();
         CountDownLatch exceptionBarrier = new CountDownLatch( 1 );
         IndexingService indexing = newIndexingServiceWithMockedDependencies( populator, accessor, withData(), new IndexingService.MonitorAdapter()
@@ -1123,12 +1123,13 @@ public void awaitingPopulationOfRecoveredIndex( StoreIndexDescriptor descriptor
             FlippableIndexProxy flippableIndexProxy = (FlippableIndexProxy) delegate;
             Exception expectedCause = new Exception( "index was failed on purpose" );
             IndexPopulationFailure indexFailure = IndexPopulationFailure.failure( expectedCause );
-            flippableIndexProxy.flipTo( new FailedIndexProxy( mock( CapableIndexDescriptor.class ), "string", mock( IndexPopulator.class ),
+            flippableIndexProxy.flipTo( new FailedIndexProxy( indexRule, "string", mock( IndexPopulator.class ),
                     indexFailure, mock( IndexCountsRemover.class ), internalLogProvider ) );
             barrier.release();
             exceptionBarrier.await();
             Throwable actual = startException.get();
 
+            assertThat( actual.getMessage(), Matchers.containsString( indexRule.toString() ) );
             assertThat( actual.getCause(), instanceOf( IllegalStateException.class ) );
             assertThat( Exceptions.stringify( actual.getCause() ), Matchers.containsString( Exceptions.stringify( expectedCause ) ) );
         }