deprecate old record differ

airbytehq · Aug 28, 2024 · 4ed0e22 · 4ed0e22
1 parent 06c9cfc
commit 4ed0e22
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/.../airbyte/integrations/base/destination/typing_deduping/BaseSqlGeneratorIntegrationTest.kt b/.../airbyte/integrations/base/destination/typing_deduping/BaseSqlGeneratorIntegrationTest.kt
@@ -47,7 +47,7 @@ private val LOGGER = KotlinLogging.logger {}
  */
 @Execution(ExecutionMode.CONCURRENT)
 abstract class BaseSqlGeneratorIntegrationTest<DestinationState : MinimumDestinationState> {
-    protected var DIFFER: RecordDiffer = mock()
+    protected var DIFFER: LegacyRecordDiffer = mock()
 
     /** Subclasses may use these four StreamConfigs in their tests. */
     protected var incrementalDedupStream: StreamConfig = mock()
@@ -200,7 +200,7 @@ abstract class BaseSqlGeneratorIntegrationTest<DestinationState : MinimumDestina
             AirbyteProtocolType.TIMESTAMP_WITH_TIMEZONE
 
         DIFFER =
-            RecordDiffer(
+            LegacyRecordDiffer(
                 rawMetadataColumnNames,
                 finalMetadataColumnNames,
                 id1 to AirbyteProtocolType.INTEGER,

diff --git a/...kotlin/io/airbyte/integrations/base/destination/typing_deduping/BaseTypingDedupingTest.kt b/...kotlin/io/airbyte/integrations/base/destination/typing_deduping/BaseTypingDedupingTest.kt
@@ -60,7 +60,7 @@ private val LOGGER = KotlinLogging.logger {}
 // execution.
 @Execution(ExecutionMode.CONCURRENT)
 abstract class BaseTypingDedupingTest {
-    protected var DIFFER: RecordDiffer? = null
+    protected var DIFFER: LegacyRecordDiffer? = null
 
     private var randomSuffix: String? = null
     protected var config: JsonNode? = null
@@ -205,7 +205,7 @@ abstract class BaseTypingDedupingTest {
 
         val generator = sqlGenerator
         DIFFER =
-            RecordDiffer(
+            LegacyRecordDiffer(
                 rawMetadataColumnNames,
                 finalMetadataColumnNames,
                 generator.buildColumnId("id1") to AirbyteProtocolType.INTEGER,

diff --git a/...stination/typing_deduping/RecordDiffer.kt → ...ion/typing_deduping/LegacyRecordDiffer.kt b/...stination/typing_deduping/RecordDiffer.kt → ...ion/typing_deduping/LegacyRecordDiffer.kt
@@ -22,8 +22,13 @@ import org.junit.jupiter.api.function.Executable
 /**
  * Utility class to generate human-readable diffs between expected and actual records. Assumes 1s1t
  * output format.
+ *
+ * Prefer [io.airbyte.cdk.test.RecordDiffer], which operates on strongly-typed objects instead of
+ * JsonNodes. This class is effectively deprecated; we're just keeping it around so that
+ * [BaseTypingDedupingTest] and [BaseSqlGeneratorIntegrationTest] continue to function. Once
+ * those classes are using the new RecordDiffer, we should remove this class.
  */
-class RecordDiffer
+class LegacyRecordDiffer
 @SafeVarargs
 constructor(
     private val rawRecordColumnNames: Map<String, String>,