Merge pull request #3984 from mgadda/add-interface-addition-event

bbakerman · web-flow · commit 1f92241e27ca · 2025-07-01T20:04:42.000+10:00
Add interface addition event in SchemaDiff
diff --git a/src/main/java/graphql/schema/diff/SchemaDiff.java b/src/main/java/graphql/schema/diff/SchemaDiff.java
@@ -135,8 +135,8 @@ public int diffSchema(DiffSet diffSet, DifferenceReporter reporter) {
      * This will perform a difference on the two schemas.  The reporter callback
      * interface will be called when differences are encountered.
      *
-     * @param schemaDiffSet  the two schemas to compare for difference
-     * @param reporter the place to report difference events to
+     * @param schemaDiffSet the two schemas to compare for difference
+     * @param reporter      the place to report difference events to
      *
      * @return the number of API breaking changes
      */
@@ -533,6 +533,19 @@ private void checkImplements(DiffCtx ctx, ObjectTypeDefinition old, List<Type> o
                 checkInterfaceType(ctx, oldInterface.get(), newInterface.get());
             }
         }
+
+        for (Map.Entry<String, Type> entry : newImplementsMap.entrySet()) {
+            Optional<InterfaceTypeDefinition> newInterface = ctx.getNewTypeDef(entry.getValue(), InterfaceTypeDefinition.class);
+            if (!oldImplementsMap.containsKey(entry.getKey())) {
+                ctx.report(DiffEvent.apiInfo()
+                        .category(DiffCategory.ADDITION)
+                        .typeName(old.getName())
+                        .typeKind(getTypeKind(old))
+                        .components(newInterface.get().getName())
+                        .reasonMsg("The new API has added the interface named '%s'", newInterface.get().getName())
+                        .build());
+            }
+        }
     }
 
 
diff --git a/src/test/groovy/graphql/schema/diff/SchemaDiffTest.groovy b/src/test/groovy/graphql/schema/diff/SchemaDiffTest.groovy
@@ -768,4 +768,43 @@ class SchemaDiffTest extends Specification {
         then:
         thrown(AssertException)
     }
+
+    def "checkImplements emits ADDITION events for new interfaces"() {
+        def oldSchema = TestUtil.schema('''
+        type Query {
+            foo: Foo
+        }
+        type Foo {
+            a: String
+        }
+        interface Bar {
+            a: String
+        }
+       ''')
+        def newSchema = TestUtil.schema('''
+        type Query {
+            foo: Foo
+        }
+        type Foo implements Bar {
+            a: String            
+        }
+        interface Bar {
+            a: String
+        }
+       ''')
+
+        when:
+        compareDiff(oldSchema, newSchema)
+
+        then:
+        validateReportersAreEqual()
+        introspectionReporter.breakageCount == 0
+        introspectionReporter.infos.any {
+            it.category == DiffCategory.ADDITION &&
+                    it.typeKind == TypeKind.Object &&
+                    it.typeName == "Foo" &&
+                    it.level == DiffLevel.INFO
+        }
+
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -135,8 +135,8 @@ public int diffSchema(DiffSet diffSet, DifferenceReporter reporter) {`
`135`	`135`	`* This will perform a difference on the two schemas. The reporter callback`
`136`	`136`	`* interface will be called when differences are encountered.`
`137`	`137`	`*`
`138`		`- * @param schemaDiffSet the two schemas to compare for difference`
`139`		`- * @param reporter the place to report difference events to`
	`138`	`+ * @param schemaDiffSet the two schemas to compare for difference`
	`139`	`+ * @param reporter the place to report difference events to`
`140`	`140`	`*`
`141`	`141`	`* @return the number of API breaking changes`
`142`	`142`	`*/`
`@@ -533,6 +533,19 @@ private void checkImplements(DiffCtx ctx, ObjectTypeDefinition old, List<Type> o`
`533`	`533`	`checkInterfaceType(ctx, oldInterface.get(), newInterface.get());`
`534`	`534`	`}`
`535`	`535`	`}`
	`536`	`+`
	`537`	`+ for (Map.Entry<String, Type> entry : newImplementsMap.entrySet()) {`
	`538`	`+ Optional<InterfaceTypeDefinition> newInterface = ctx.getNewTypeDef(entry.getValue(), InterfaceTypeDefinition.class);`
	`539`	`+ if (!oldImplementsMap.containsKey(entry.getKey())) {`
	`540`	`+ ctx.report(DiffEvent.apiInfo()`
	`541`	`+ .category(DiffCategory.ADDITION)`
	`542`	`+ .typeName(old.getName())`
	`543`	`+ .typeKind(getTypeKind(old))`
	`544`	`+ .components(newInterface.get().getName())`
	`545`	`+ .reasonMsg("The new API has added the interface named '%s'", newInterface.get().getName())`
	`546`	`+ .build());`
	`547`	`+ }`
	`548`	`+ }`
`536`	`549`	`}`
`537`	`550`
`538`	`551`