Alternative approach for findSchemaChanges

graphql · Oct 14, 2024 · afcd663 · afcd663
1 parent 0254e5f
commit afcd663
Show file tree

Hide file tree

Showing 3 changed files with 90 additions and 6 deletions.
diff --git a/src/index.ts b/src/index.ts
@@ -474,6 +474,7 @@ export {
   DangerousChangeType,
   findBreakingChanges,
   findDangerousChanges,
+  findSchemaChanges,
 } from './utilities/index.js';
 
 export type {

diff --git a/src/utilities/findBreakingChanges.ts b/src/utilities/findBreakingChanges.ts
@@ -65,6 +65,20 @@ enum DangerousChangeType {
 }
 export { DangerousChangeType };
 
+enum SafeChangeType {
+  TYPE_ADDED = 'TYPE_ADDED',
+  OPTIONAL_INPUT_FIELD_ADDED = 'OPTIONAL_INPUT_FIELD_ADDED',
+  OPTIONAL_ARG_ADDED = 'OPTIONAL_ARG_ADDED',
+  DIRECTIVE_ADDED = 'DIRECTIVE_ADDED',
+  FIELD_ADDED = 'FIELD_ADDED',
+  DIRECTIVE_REPEATABLE_ADDED = 'DIRECTIVE_REPEATABLE_ADDED',
+  DIRECTIVE_LOCATION_ADDED = 'DIRECTIVE_LOCATION_ADDED',
+  OPTIONAL_DIRECTIVE_ARG_ADDED = 'OPTIONAL_DIRECTIVE_ARG_ADDED',
+  FIELD_CHANGED_KIND_SAFE = 'FIELD_CHANGED_KIND_SAFE',
+  ARG_CHANGED_KIND_SAFE = 'ARG_CHANGED_KIND_SAFE',
+}
+export { SafeChangeType };
+
 export interface BreakingChange {
   type: BreakingChangeType;
   description: string;
@@ -75,9 +89,18 @@ export interface DangerousChange {
   description: string;
 }
 
+export interface SafeChange {
+  type: SafeChangeType;
+  description: string;
+}
+
+export type SchemaChange = SafeChange | DangerousChange | BreakingChange;
+
 /**
  * Given two schemas, returns an Array containing descriptions of all the types
  * of breaking changes covered by the other functions down below.
+ *
+ * @deprecated Please use `findSchemaChanges` instead. Will be removed in v18.
  */
 export function findBreakingChanges(
   oldSchema: GraphQLSchema,
@@ -92,6 +115,8 @@ export function findBreakingChanges(
 /**
  * Given two schemas, returns an Array containing descriptions of all the types
  * of potentially dangerous changes covered by the other functions down below.
+ *
+ * @deprecated Please use `findSchemaChanges` instead. Will be removed in v18.
  */
 export function findDangerousChanges(
   oldSchema: GraphQLSchema,
@@ -103,10 +128,10 @@ export function findDangerousChanges(
   );
 }
 
-function findSchemaChanges(
+export function findSchemaChanges(
   oldSchema: GraphQLSchema,
   newSchema: GraphQLSchema,
-): Array<BreakingChange | DangerousChange> {
+): Array<SchemaChange> {
   return [
     ...findTypeChanges(oldSchema, newSchema),
     ...findDirectiveChanges(oldSchema, newSchema),
@@ -116,7 +141,7 @@ function findSchemaChanges(
 function findDirectiveChanges(
   oldSchema: GraphQLSchema,
   newSchema: GraphQLSchema,
-): Array<BreakingChange | DangerousChange> {
+): Array<SchemaChange> {
   const schemaChanges = [];
 
   const directivesDiff = diff(
@@ -131,6 +156,13 @@ function findDirectiveChanges(
     });
   }
 
+  for (const newDirective of directivesDiff.added) {
+    schemaChanges.push({
+      type: SafeChangeType.DIRECTIVE_ADDED,
+      description: `Directive @${newDirective.name} was added.`,
+    });
+  }
+
   for (const [oldDirective, newDirective] of directivesDiff.persisted) {
     const argsDiff = diff(oldDirective.args, newDirective.args);
 
@@ -140,6 +172,11 @@ function findDirectiveChanges(
           type: BreakingChangeType.REQUIRED_DIRECTIVE_ARG_ADDED,
           description: `A required argument @${oldDirective.name}(${newArg.name}:) was added.`,
         });
+      } else {
+        schemaChanges.push({
+          type: SafeChangeType.OPTIONAL_DIRECTIVE_ARG_ADDED,
+          description: `An optional argument @${oldDirective.name}(${newArg.name}:) was added.`,
+        });
       }
     }
 
@@ -155,6 +192,11 @@ function findDirectiveChanges(
         type: BreakingChangeType.DIRECTIVE_REPEATABLE_REMOVED,
         description: `Repeatable flag was removed from @${oldDirective.name}.`,
       });
+    } else if (newDirective.isRepeatable && !oldDirective.isRepeatable) {
+      schemaChanges.push({
+        type: SafeChangeType.DIRECTIVE_REPEATABLE_ADDED,
+        description: `Repeatable flag was added to @${oldDirective.name}.`,
+      });
     }
 
     for (const location of oldDirective.locations) {
@@ -165,6 +207,15 @@ function findDirectiveChanges(
         });
       }
     }
+
+    for (const location of newDirective.locations) {
+      if (!oldDirective.locations.includes(location)) {
+        schemaChanges.push({
+          type: SafeChangeType.DIRECTIVE_LOCATION_ADDED,
+          description: `${location} was added to @${oldDirective.name}.`,
+        });
+      }
+    }
   }
 
   return schemaChanges;
@@ -173,7 +224,7 @@ function findDirectiveChanges(
 function findTypeChanges(
   oldSchema: GraphQLSchema,
   newSchema: GraphQLSchema,
-): Array<BreakingChange | DangerousChange> {
+): Array<SchemaChange> {
   const schemaChanges = [];
 
   const typesDiff = diff(
@@ -190,6 +241,13 @@ function findTypeChanges(
     });
   }
 
+  for (const newType of typesDiff.added) {
+    schemaChanges.push({
+      type: SafeChangeType.TYPE_ADDED,
+      description: `${newType} was added.`,
+    });
+  }
+
   for (const [oldType, newType] of typesDiff.persisted) {
     if (isEnumType(oldType) && isEnumType(newType)) {
       schemaChanges.push(...findEnumTypeChanges(oldType, newType));
@@ -223,7 +281,7 @@ function findTypeChanges(
 function findInputObjectTypeChanges(
   oldType: GraphQLInputObjectType,
   newType: GraphQLInputObjectType,
-): Array<BreakingChange | DangerousChange> {
+): Array<SchemaChange> {
   const schemaChanges = [];
   const fieldsDiff = diff(
     Object.values(oldType.getFields()),
@@ -263,6 +321,13 @@ function findInputObjectTypeChanges(
           `Field ${oldType}.${oldField.name} changed type from ` +
           `${String(oldField.type)} to ${String(newField.type)}.`,
       });
+    } else {
+      schemaChanges.push({
+        type: SafeChangeType.FIELD_CHANGED_KIND_SAFE,
+        description:
+          `Field ${oldType}.${oldField.name} changed type from ` +
+          `${String(oldField.type)} to ${String(newField.type)}.`,
+      });
     }
   }
 
@@ -344,7 +409,7 @@ function findImplementedInterfacesChanges(
 function findFieldChanges(
   oldType: GraphQLObjectType | GraphQLInterfaceType,
   newType: GraphQLObjectType | GraphQLInterfaceType,
-): Array<BreakingChange | DangerousChange> {
+): Array<SchemaChange> {
   const schemaChanges = [];
   const fieldsDiff = diff(
     Object.values(oldType.getFields()),
@@ -358,6 +423,13 @@ function findFieldChanges(
     });
   }
 
+  for (const newField of fieldsDiff.added) {
+    schemaChanges.push({
+      type: SafeChangeType.FIELD_ADDED,
+      description: `Field ${oldType}.${newField.name} was removed.`,
+    });
+  }
+
   for (const [oldField, newField] of fieldsDiff.persisted) {
     schemaChanges.push(...findArgChanges(oldType, oldField, newField));
 
@@ -372,6 +444,13 @@ function findFieldChanges(
           `Field ${oldType}.${oldField.name} changed type from ` +
           `${String(oldField.type)} to ${String(newField.type)}.`,
       });
+    } else {
+      schemaChanges.push({
+        type: SafeChangeType.FIELD_CHANGED_KIND_SAFE,
+        description:
+          `Field ${oldType}.${oldField.name} changed type from ` +
+          `${String(oldField.type)} to ${String(newField.type)}.`,
+      });
     }
   }
 
@@ -425,6 +504,9 @@ function findArgChanges(
           });
         }
       }
+    } else {
+      // TODO: add default value added
+      // TODO: add safe change
     }
   }
 

diff --git a/src/utilities/index.ts b/src/utilities/index.ts
@@ -106,6 +106,7 @@ export {
   DangerousChangeType,
   findBreakingChanges,
   findDangerousChanges,
+  findSchemaChanges,
 } from './findBreakingChanges.js';
 export type { BreakingChange, DangerousChange } from './findBreakingChanges.js';