René's URL Explorer Experiment

{"@context":"https://schema.org","@type":"DiscussionForumPosting","headline":"SchemaDiff EnforceDirectives Option Does Not Identify Removal of Directive From Type or Field","articleBody":"**Describe the bug**\r\nThe enforceDirectives option for SchemaDiff does not properly detect if a directive was removed from a field or type. This is because it relies on an introspection result as input. The introspection query does not return directives on fields or types so they are not present when the diff of the document is ran. \r\n\r\n**To Reproduce**\r\n\r\nSchema 1:\r\n\r\n```\r\ndirective @someDirective on FIELD_DEFINITION\r\n\r\ntype test {\r\n  version: String! @someDirective\r\n}\r\n\r\ntype Query {\r\n  getTests: [test]!\r\n}\r\n```\r\n\r\nSchema 2:\r\n\r\n```\r\ndirective @someDirective on FIELD_DEFINITION\r\n\r\ntype test {\r\n  version: String!\r\n}\r\n\r\ntype Query {\r\n  getTests: [test]!\r\n}\r\n```\r\nWhen schema diff is run on these two schemas it will detect no changes even though removal of a directive could be a breaking change especially for composite schemas. \r\n\r\nPotential solution would be providing the ability for DiffSet to provide the SchemaDefinition directly so that it can be overridden to use an approach that does not require introspection:\r\n\r\n```\r\npublic interface DiffSet {\r\n     Document getOldSchemaDefinition();\r\n     Document getNewSchemaDefinition();\r\n}\r\n\r\n\r\npublic class IntrospectionDiffSet implements DiffSet  {\r\n   ....\r\n   @Override\r\n   public Document getOldSchemaDefinition() {\r\n        return new IntrospectionResultToSchema().createSchemaDefinition(this.introspectionOld);   \r\n    }\r\n    \r\n    @Override\r\n     public Document getNewSchemaDefinition() {\r\n        return new IntrospectionResultToSchema().createSchemaDefinition(this.introspectionNew);   \r\n    }\r\n}\r\n```\r\nThe SchemaDiff class can then use this hook rather than requiring the introspection result method. \r\n\r\n```\r\npublic class SchemaDiff {\r\n ...\r\n     private void diffSchemaImpl(DiffSet diffSet, DifferenceReporter reporter) {\r\n            Document oldDoc = diffSet.getOldSchemaDefinition();\r\n            Document newDoc = diffSet.getNewSchemaDefinition();\r\n            ...\r\n     }\r\n}\r\n```\r\n\r\nWe would then be able to override this implementation with something like this:\r\n```\r\n public class SDLDiffSet implements DiffSet {\r\n   ....\r\n   \r\n   @Override\r\n   public Document getOldSchemaDefinition() {\r\n        return Parser.parse(this.oldSchemaSdl);\r\n   }\r\n    \r\n    @Override\r\n    public Document getNewSchemaDefinition() {\r\n        return Parser.parse(this.newSchemaSdl);\r\n    }\r\n}\r\n```\r\n\r\nI am willing to help with a PR if there is some agreement on direction here. \r\n\r\n","author":{"url":"https://github.com/ndejaco2","@type":"Person","name":"ndejaco2"},"datePublished":"2023-10-03T21:09:08.000Z","interactionStatistic":{"@type":"InteractionCounter","interactionType":"https://schema.org/CommentAction","userInteractionCount":8},"url":"https://github.com/3343/graphql-java/issues/3343"}