HSEARCH-4227 Clarify that methods like "create" in DocumentWorkCallListContext are about the works, not the documents

yrodiere · yrodiere · commit 0adaa0158e35 · 2021-09-03T15:42:16.000+02:00
diff --git a/integrationtest/mapper/orm-spring/src/test/java/org/hibernate/search/integrationtest/spring/transaction/TransactionIT.java b/integrationtest/mapper/orm-spring/src/test/java/org/hibernate/search/integrationtest/spring/transaction/TransactionIT.java
@@ -56,7 +56,7 @@ public void innerTransactionRollback() {
 
 		// Check that inner transaction data is NOT pushed to the index (processed, but discarded).
 		backendMock.expectWorks( IndexedEntity.NAME )
-				.createAndDiscard()
+				.createAndDiscardFollowingWorks()
 				.add( innerId.toString(), b -> { } );
 		// Check that outer transaction data is pushed to the index.
 		backendMock.expectWorks( IndexedEntity.NAME )
@@ -75,15 +75,15 @@ public void innerTransactionRollback_flushBeforeInner() {
 
 		// Check that outer transaction data is processed.
 		backendMock.expectWorks( IndexedEntity.NAME )
-				.create()
+				.createFollowingWorks()
 				.add( outerId.toString(), b -> { } );
 		// Check that inner transaction data is NOT pushed to the index (processed, but discarded).
 		backendMock.expectWorks( IndexedEntity.NAME )
-				.createAndDiscard()
+				.createAndDiscardFollowingWorks()
 				.add( innerId.toString(), b -> { } );
 		// Check that outer transaction data is pushed to the index.
 		backendMock.expectWorks( IndexedEntity.NAME )
-				.execute()
+				.executeFollowingWorks()
 				.add( outerId.toString(), b -> { } );
 
 		helperService.doOuterFlushBeforeInner( outerId, innerId );
diff --git a/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/automaticindexing/AutomaticIndexingBasicIT.java b/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/automaticindexing/AutomaticIndexingBasicIT.java
@@ -130,7 +130,7 @@ public void rollback_discardPreparedWorks() {
 			session.persist( entity1 );
 
 			backendMock.expectWorks( IndexedEntity.INDEX )
-					.create()
+					.createFollowingWorks()
 					.add( "1", b -> b
 							.field( "indexedField", entity1.getIndexedField() )
 							.field( "shallowReindexOnUpdateField", null )
@@ -145,7 +145,7 @@ public void rollback_discardPreparedWorks() {
 			backendMock.verifyExpectationsMet();
 
 			backendMock.expectWorks( IndexedEntity.INDEX )
-					.discard()
+					.discardFollowingWorks()
 					.add( "1", b -> b
 							.field( "indexedField", entity1.getIndexedField() )
 							.field( "shallowReindexOnUpdateField", null )
@@ -703,7 +703,7 @@ public void sessionClear() {
 					.field( "noReindexOnUpdateField", null );
 
 			backendMock.expectWorks( IndexedEntity.INDEX )
-					.create()
+					.createFollowingWorks()
 					.add( "1", expectedValue( "number1" ) )
 					.add( "2", expectedValue( "number2" ) );
 
@@ -720,12 +720,12 @@ public void sessionClear() {
 
 			// without clear the session
 			backendMock.expectWorks( IndexedEntity.INDEX )
-					.create()
+					.createFollowingWorks()
 					.add( "3", expectedValue( "number3" ) )
 					.add( "4", expectedValue( "number4" ) );
 
 			backendMock.expectWorks( IndexedEntity.INDEX )
-					.execute()
+					.executeFollowingWorks()
 					.add( "1", expectedValue( "number1" ) )
 					.add( "2", expectedValue( "number2" ) )
 					.add( "3", expectedValue( "number3" ) )
@@ -743,7 +743,7 @@ public void sessionClear() {
 
 			// flush triggers the prepare of the current indexing plan
 			backendMock.expectWorks( IndexedEntity.INDEX )
-					.create()
+					.createFollowingWorks()
 					.add( "5", expectedValue( "number5" ) )
 					.add( "6", expectedValue( "number6" ) );
 
@@ -769,7 +769,7 @@ public void sessionClear() {
 			session.clear();
 
 			backendMock.expectWorks( IndexedEntity.INDEX )
-					.execute()
+					.executeFollowingWorks()
 					.add( "5", expectedValue( "number5" ) )
 					.add( "6", expectedValue( "number6" ) );
 		} );
diff --git a/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/automaticindexing/AutomaticIndexingSessionFlushIT.java b/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/automaticindexing/AutomaticIndexingSessionFlushIT.java
@@ -57,14 +57,14 @@ public void onExplicitFlush() {
 			session.persist( entity1 );
 
 			backendMock.expectWorks( IndexedEntity.INDEX_NAME )
-					.create()
+					.createFollowingWorks()
 					.add( "1", b -> b.field( "text", "number1" ) );
 
 			session.flush();
 			backendMock.verifyExpectationsMet();
 
 			backendMock.expectWorks( IndexedEntity.INDEX_NAME )
-					.execute()
+					.executeFollowingWorks()
 					.add( "1", b -> b.field( "text", "number1" ) );
 		} );
 		backendMock.verifyExpectationsMet();
@@ -78,7 +78,7 @@ public void onAutoFlush() {
 			session.persist( entity1 );
 
 			backendMock.expectWorks( IndexedEntity.INDEX_NAME )
-					.create()
+					.createFollowingWorks()
 					.add( "1", b -> b.field( "text", "number1" ) );
 
 			// An auto flush is performed on query invocation
@@ -91,7 +91,7 @@ public void onAutoFlush() {
 			assertEquals( 1, resultList.size() );
 
 			backendMock.expectWorks( IndexedEntity.INDEX_NAME )
-					.execute()
+					.executeFollowingWorks()
 					.add( "1", b -> b.field( "text", "number1" ) );
 		} );
 		backendMock.verifyExpectationsMet();
diff --git a/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/automaticindexing/AutomaticIndexingSynchronizationStrategyIT.java b/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/automaticindexing/AutomaticIndexingSynchronizationStrategyIT.java
@@ -528,7 +528,7 @@ private CompletableFuture<?> runTransactionInDifferentThread(SessionFactory sess
 				session.persist( entity2 );
 
 				backendMock.expectWorks( IndexedEntity.NAME, expectedCommitStrategy, expectedRefreshStrategy )
-						.createAndExecute( indexingWorkFuture )
+						.createAndExecuteFollowingWorks( indexingWorkFuture )
 						.add( "1", b -> b
 								.field( "indexedField", entity1.getIndexedField() )
 						)
diff --git a/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/massindexing/AbstractMassIndexingErrorIT.java b/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/massindexing/AbstractMassIndexingErrorIT.java
@@ -465,7 +465,7 @@ private Runnable expectIndexingWorks(ExecutionExpectation workTwoExecutionExpect
 									.field( "title", TITLE_3 )
 									.field( "author", AUTHOR_3 )
 							)
-							.createAndExecute( failingFuture )
+							.createAndExecuteFollowingWorks( failingFuture )
 							.add( "2", b -> b
 									.field( "title", TITLE_2 )
 									.field( "author", AUTHOR_2 )
diff --git a/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/massindexing/AbstractMassIndexingFailureIT.java b/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/massindexing/AbstractMassIndexingFailureIT.java
@@ -707,7 +707,7 @@ private Runnable expectIndexingWorks(ExecutionExpectation workTwoExecutionExpect
 									.field( "title", TITLE_3 )
 									.field( "author", AUTHOR_3 )
 							)
-							.createAndExecute( failingFuture )
+							.createAndExecuteFollowingWorks( failingFuture )
 							.add( "2", b -> b
 									.field( "title", TITLE_2 )
 									.field( "author", AUTHOR_2 )
diff --git a/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/massindexing/MassIndexingInterruptionIT.java b/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/massindexing/MassIndexingInterruptionIT.java
@@ -192,7 +192,7 @@ private MassIndexer prepareMassIndexingThatWillNotTerminate() {
 				Book.INDEX, DocumentCommitStrategy.NONE, DocumentRefreshStrategy.NONE
 		)
 				// Return a CompletableFuture that will never complete
-				.createAndExecute( new CompletableFuture<>() )
+				.createAndExecuteFollowingWorks( new CompletableFuture<>() )
 				.add( "1", b -> b
 						.field( "title", TITLE_1 )
 						.field( "author", AUTHOR_1 )
diff --git a/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/massindexing/MassIndexingMonitorIT.java b/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/massindexing/MassIndexingMonitorIT.java
@@ -77,7 +77,7 @@ public void simple() {
 							.field( "title", TITLE_3 )
 							.field( "author", AUTHOR_3 )
 					)
-					.createAndExecute( indexingFuture )
+					.createAndExecuteFollowingWorks( indexingFuture )
 					.add( "2", b -> b
 							.field( "title", TITLE_2 )
 							.field( "author", AUTHOR_2 )
diff --git a/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/nonregression/automaticindexing/FlushClearEvictAllIT.java b/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/nonregression/automaticindexing/FlushClearEvictAllIT.java
@@ -69,7 +69,7 @@ public void test() {
 			assertNotNull( postId );
 
 			backendMock.expectWorks( Post.NAME )
-					.create()
+					.createFollowingWorks()
 					.add( post.getId().toString(), b -> b.field( "name", "This is a post" ) );
 			entityManager.flush();
 			backendMock.verifyExpectationsMet();
@@ -78,7 +78,7 @@ public void test() {
 			sessionFactory.getCache().evictAll();
 
 			backendMock.expectWorks( Post.NAME )
-					.execute()
+					.executeFollowingWorks()
 					.add( post.getId().toString(), b -> b.field( "name", "This is a post" ) );
 			trx.commit();
 			backendMock.verifyExpectationsMet();
@@ -93,7 +93,7 @@ public void test() {
 			reloaded.getComments().add( comment );
 
 			backendMock.expectWorks( Comment.NAME )
-					.create()
+					.createFollowingWorks()
 					.add( "2", b -> b.field( "name", "This is a comment" ) );
 			entityManager.flush();
 			backendMock.verifyExpectationsMet();
@@ -102,7 +102,7 @@ public void test() {
 			sessionFactory.getCache().evictAll();
 
 			backendMock.expectWorks( Comment.NAME )
-					.execute()
+					.executeFollowingWorks()
 					.add( "2", b -> b.field( "name", "This is a comment" ) );
 			trx.commit();
 			backendMock.verifyExpectationsMet();
diff --git a/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/session/SearchIndexingPlanBaseIT.java b/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/session/SearchIndexingPlanBaseIT.java
@@ -250,7 +250,7 @@ public void earlyProcess() {
 
 			// flush triggers the prepare of the current indexing plan
 			defaultBackendMock.expectWorks( IndexedEntity1.INDEX_NAME )
-					.create()
+					.createFollowingWorks()
 					.add( "1", b -> b.field( "text", "number1" ) )
 					.add( "2", b -> b.field( "text", "number2" ) );
 
@@ -271,7 +271,7 @@ public void earlyProcess() {
 			entity2.text = "WRONG";
 
 			defaultBackendMock.expectWorks( IndexedEntity1.INDEX_NAME )
-					.execute()
+					.executeFollowingWorks()
 					.add( "1", b -> b.field( "text", "number1" ) )
 					.add( "2", b -> b.field( "text", "number2" ) );
 		} );
@@ -291,7 +291,7 @@ public void earlyExecute() {
 			session.persist( entity2 );
 
 			defaultBackendMock.expectWorks( IndexedEntity1.INDEX_NAME )
-					.create()
+					.createFollowingWorks()
 					.add( "1", b -> b.field( "text", "number1" ) )
 					.add( "2", b -> b.field( "text", "number2" ) );
 
@@ -301,7 +301,7 @@ public void earlyExecute() {
 			SearchIndexingPlan indexingPlan = Search.session( session ).indexingPlan();
 
 			defaultBackendMock.expectWorks( IndexedEntity1.INDEX_NAME )
-					.execute()
+					.executeFollowingWorks()
 					.add( "1", b -> b.field( "text", "number1" ) )
 					.add( "2", b -> b.field( "text", "number2" ) );
 
diff --git a/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/session/SearchIndexingPlanPersistBatchIndexingIT.java b/integrationtest/mapper/orm/src/test/java/org/hibernate/search/integrationtest/mapper/orm/session/SearchIndexingPlanPersistBatchIndexingIT.java
@@ -132,7 +132,7 @@ public void executePerBatch() {
 
 	private void expectCreateAddWorks(int firstId, int afterLastId) {
 		BackendMock.DocumentWorkCallListContext expectations = backendMock.expectWorks( IndexedEntity.INDEX_NAME )
-				.create();
+				.createFollowingWorks();
 		for ( int i = firstId; i < afterLastId; ++i ) {
 			final int id = i;
 			expectations.add( String.valueOf( id ), b -> b.field( "text", "number" + id ) );
@@ -141,7 +141,7 @@ private void expectCreateAddWorks(int firstId, int afterLastId) {
 
 	private void expectExecuteAddWorks(int firstId, int afterLastId) {
 		BackendMock.DocumentWorkCallListContext expectations = backendMock.expectWorks( IndexedEntity.INDEX_NAME )
-				.execute();
+				.executeFollowingWorks();
 		for ( int i = firstId; i < afterLastId; ++i ) {
 			final int id = i;
 			expectations.add( String.valueOf( id ), b -> b.field( "text", "number" + id ) );
diff --git a/integrationtest/mapper/pojo-base/src/test/java/org/hibernate/search/integrationtest/mapper/pojo/work/AbstractPojoIndexingOperationIT.java b/integrationtest/mapper/pojo-base/src/test/java/org/hibernate/search/integrationtest/mapper/pojo/work/AbstractPojoIndexingOperationIT.java
@@ -472,7 +472,7 @@ public void indexingPlan_notIndexed_previouslyIndexedWithDifferentRoute() {
 			if ( !isAdd() ) {
 				// For operations other than add, expect a delete for the previous route.
 				backendMock.expectWorks( IndexedEntity.INDEX, commitStrategy, refreshStrategy )
-						.createAndExecute( futureFromBackend )
+						.createAndExecuteFollowingWorks( futureFromBackend )
 						.delete( b -> addWorkInfo( b, tenantId, "1",
 								MyRoutingBridge.toRoutingKey( tenantId, 1, "1" ) ) );
 
@@ -500,7 +500,7 @@ public void indexingPlan_notIndexed_previouslyIndexedWithMultipleRoutes() {
 			if ( !isAdd() ) {
 				// For operations other than add, expect a delete for every previous route.
 				backendMock.expectWorks( IndexedEntity.INDEX, commitStrategy, refreshStrategy )
-						.createAndExecute( futureFromBackend )
+						.createAndExecuteFollowingWorks( futureFromBackend )
 						.delete( b -> addWorkInfo( b, tenantId, "1",
 								MyRoutingBridge.toRoutingKey( tenantId, 1, "1" ) ) )
 						.delete( b -> addWorkInfo( b, tenantId, "1",
@@ -620,7 +620,7 @@ private void expectOperation(CompletableFuture<?> futureFromBackend,
 		BackendMock.DocumentWorkCallListContext context = backendMock.expectWorks(
 				IndexedEntity.INDEX, commitStrategy, refreshStrategy
 		)
-				.createAndExecute( futureFromBackend );
+				.createAndExecuteFollowingWorks( futureFromBackend );
 		worksBefore.accept( context );
 		String expectedRoutingKey;
 		if ( providedRoutingKey != null ) {
diff --git a/integrationtest/mapper/pojo-base/src/test/java/org/hibernate/search/integrationtest/mapper/pojo/work/PojoIndexingPlanBaseIT.java b/integrationtest/mapper/pojo-base/src/test/java/org/hibernate/search/integrationtest/mapper/pojo/work/PojoIndexingPlanBaseIT.java
@@ -174,7 +174,7 @@ public void failure() {
 				session.indexingPlan().add( entity1 );
 
 				backendMock.expectWorks( IndexedEntity.INDEX )
-						.createAndExecute( failingFuture )
+						.createAndExecuteFollowingWorks( failingFuture )
 						.add( b -> b
 								.identifier( "1" )
 								.document( StubDocumentNode.document()
diff --git a/util/internal/integrationtest/common/src/main/java/org/hibernate/search/util/impl/integrationtest/common/rule/BackendMock.java b/util/internal/integrationtest/common/src/main/java/org/hibernate/search/util/impl/integrationtest/common/rule/BackendMock.java
@@ -316,31 +316,31 @@ private DocumentWorkCallListContext(String indexName, String tenantId,
 			this.executionFuture = executionFuture;
 		}
 
-		public DocumentWorkCallListContext create() {
+		public DocumentWorkCallListContext createFollowingWorks() {
 			return newContext( DocumentWorkCallKind.CREATE );
 		}
 
-		public DocumentWorkCallListContext discard() {
+		public DocumentWorkCallListContext discardFollowingWorks() {
 			return newContext( DocumentWorkCallKind.DISCARD );
 		}
 
-		public DocumentWorkCallListContext execute() {
+		public DocumentWorkCallListContext executeFollowingWorks() {
 			return newContext( DocumentWorkCallKind.EXECUTE );
 		}
 
-		public DocumentWorkCallListContext execute(CompletableFuture<?> executionFuture) {
+		public DocumentWorkCallListContext executeFollowingWorks(CompletableFuture<?> executionFuture) {
 			return newContext( DocumentWorkCallKind.EXECUTE, executionFuture );
 		}
 
-		public DocumentWorkCallListContext createAndExecute() {
+		public DocumentWorkCallListContext createAndExecuteFollowingWorks() {
 			return newContext( DocumentWorkCallKind.CREATE_AND_EXECUTE );
 		}
 
-		public DocumentWorkCallListContext createAndExecute(CompletableFuture<?> executionFuture) {
+		public DocumentWorkCallListContext createAndExecuteFollowingWorks(CompletableFuture<?> executionFuture) {
 			return newContext( DocumentWorkCallKind.CREATE_AND_EXECUTE, executionFuture );
 		}
 
-		public DocumentWorkCallListContext createAndDiscard() {
+		public DocumentWorkCallListContext createAndDiscardFollowingWorks() {
 			return newContext( DocumentWorkCallKind.CREATE_AND_DISCARD );
 		}
 

Original file line number	Diff line number	Diff line change
`@@ -528,7 +528,7 @@ private CompletableFuture<?> runTransactionInDifferentThread(SessionFactory sess`
`528`	`528`	`session.persist( entity2 );`
`529`	`529`
`530`	`530`	`backendMock.expectWorks( IndexedEntity.NAME, expectedCommitStrategy, expectedRefreshStrategy )`
`531`		`- .createAndExecute( indexingWorkFuture )`
	`531`	`+ .createAndExecuteFollowingWorks( indexingWorkFuture )`
`532`	`532`	`.add( "1", b -> b`
`533`	`533`	`.field( "indexedField", entity1.getIndexedField() )`
`534`	`534`	`)`
Original file line number	Diff line number	Diff line change
`@@ -465,7 +465,7 @@ private Runnable expectIndexingWorks(ExecutionExpectation workTwoExecutionExpect`
`465`	`465`	`.field( "title", TITLE_3 )`
`466`	`466`	`.field( "author", AUTHOR_3 )`
`467`	`467`	`)`
`468`		`- .createAndExecute( failingFuture )`
	`468`	`+ .createAndExecuteFollowingWorks( failingFuture )`
`469`	`469`	`.add( "2", b -> b`
`470`	`470`	`.field( "title", TITLE_2 )`
`471`	`471`	`.field( "author", AUTHOR_2 )`
Original file line number	Diff line number	Diff line change
`@@ -707,7 +707,7 @@ private Runnable expectIndexingWorks(ExecutionExpectation workTwoExecutionExpect`
`707`	`707`	`.field( "title", TITLE_3 )`
`708`	`708`	`.field( "author", AUTHOR_3 )`
`709`	`709`	`)`
`710`		`- .createAndExecute( failingFuture )`
	`710`	`+ .createAndExecuteFollowingWorks( failingFuture )`
`711`	`711`	`.add( "2", b -> b`
`712`	`712`	`.field( "title", TITLE_2 )`
`713`	`713`	`.field( "author", AUTHOR_2 )`
Original file line number	Diff line number	Diff line change
`@@ -192,7 +192,7 @@ private MassIndexer prepareMassIndexingThatWillNotTerminate() {`
`192`	`192`	`Book.INDEX, DocumentCommitStrategy.NONE, DocumentRefreshStrategy.NONE`
`193`	`193`	`)`
`194`	`194`	`// Return a CompletableFuture that will never complete`
`195`		`- .createAndExecute( new CompletableFuture<>() )`
	`195`	`+ .createAndExecuteFollowingWorks( new CompletableFuture<>() )`
`196`	`196`	`.add( "1", b -> b`
`197`	`197`	`.field( "title", TITLE_1 )`
`198`	`198`	`.field( "author", AUTHOR_1 )`
Original file line number	Diff line number	Diff line change
`@@ -77,7 +77,7 @@ public void simple() {`
`77`	`77`	`.field( "title", TITLE_3 )`
`78`	`78`	`.field( "author", AUTHOR_3 )`
`79`	`79`	`)`
`80`		`- .createAndExecute( indexingFuture )`
	`80`	`+ .createAndExecuteFollowingWorks( indexingFuture )`
`81`	`81`	`.add( "2", b -> b`
`82`	`82`	`.field( "title", TITLE_2 )`
`83`	`83`	`.field( "author", AUTHOR_2 )`