YDBCloudCore internal API change - dropping `processOperations:inPipe…

…line:withGraphIdx:` in favor of more fine-grained control over modifying operations when they're added/inserted/modified.
yapstudios · Jul 3, 2019 · 3b0088b · 3b0088b
1 parent 30aeef9
commit 3b0088b
Show file tree

Hide file tree

Showing 3 changed files with 183 additions and 322 deletions.
diff --git a/YapDatabase/Extensions/CloudCore/Internal/YapDatabaseCloudCorePrivate.h b/YapDatabase/Extensions/CloudCore/Internal/YapDatabaseCloudCorePrivate.h
@@ -165,18 +165,32 @@ typedef NS_OPTIONS(uint8_t, YDBCloudCore_EnumOps) {
  * Subclass hooks
 **/
 
-// Allows subclasses to perform post-processing on operations before they are written to disk.
-// Examples of tasks a subclass may want to perform:
-//
-// - sanitization of various property values
-// - automatically merging duplicate operations within same commit
-// - automatically adding dependencies for operations in earlier commits (if using FlatGraph optimization)
-//
-- (NSArray<YapDatabaseCloudCoreOperation *> *)processOperations:(NSArray<YapDatabaseCloudCoreOperation *> *)operations
-                                                     inPipeline:(YapDatabaseCloudCorePipeline *)pipeline
-                                                   withGraphIdx:(NSUInteger)operationsGraphIdx;
-
-// Subclasses may override these methods to perform custom tasks as needed.
+- (void)validateOperation:(YapDatabaseCloudCoreOperation *)operation;
+
+- (void)willAddOperation:(YapDatabaseCloudCoreOperation *)operation
+              inPipeline:(YapDatabaseCloudCorePipeline *)pipeline
+            withGraphIdx:(NSUInteger)opGraphIdx;
+
+- (void)didAddOperation:(YapDatabaseCloudCoreOperation *)operation
+             inPipeline:(YapDatabaseCloudCorePipeline *)pipeline
+           withGraphIdx:(NSUInteger)opGraphIdx;
+
+- (void)willInsertOperation:(YapDatabaseCloudCoreOperation *)operation
+                 inPipeline:(YapDatabaseCloudCorePipeline *)pipeline
+               withGraphIdx:(NSUInteger)opGraphIdx;
+
+- (void)didInsertOperation:(YapDatabaseCloudCoreOperation *)operation
+                inPipeline:(YapDatabaseCloudCorePipeline *)pipeline
+              withGraphIdx:(NSUInteger)opGraphIdx;
+
+- (void)willModifyOperation:(YapDatabaseCloudCoreOperation *)operation
+                 inPipeline:(YapDatabaseCloudCorePipeline *)pipeline
+               withGraphIdx:(NSUInteger)opGraphIdx;
+
+- (void)didModifyOperation:(YapDatabaseCloudCoreOperation *)operation
+                 inPipeline:(YapDatabaseCloudCorePipeline *)pipeline
+               withGraphIdx:(NSUInteger)opGraphIdx;
+
 - (void)didCompleteOperation:(YapDatabaseCloudCoreOperation *)operation;
 - (void)didSkipOperation:(YapDatabaseCloudCoreOperation *)operation;
 

diff --git a/YapDatabase/Extensions/CloudCore/Utilities/Execution/YapDatabaseCloudCorePipeline.h b/YapDatabase/Extensions/CloudCore/Utilities/Execution/YapDatabaseCloudCorePipeline.h
@@ -55,8 +55,10 @@ typedef NS_ENUM(NSInteger, YDBCloudCorePipelineAlgorithm) {
 	 * - your formal dependency graph must determine if opB should depend on opA
 	 *
 	 * The recommended way of implementing your formal dependency graph is by
-	 * subclassing YapDatabaseCloudCoreTransaction & overriding the method
-	 * `processOperations:inPipeline:withGraphIdx:`.
+	 * subclassing YapDatabaseCloudCoreTransaction & overriding the various subclass hooks, such as:
+	 * - willAddOperation:inPipeline:withGraphIdx:
+	 * - willInsertOperation:inPipeline:withGraphIdx:
+	 * - willModifyOperation:inPipeline:withGraphIdx:
 	**/
 	YDBCloudCorePipelineAlgorithm_FlatGraph = 1
 };