Elgato_dark/console
1
0
Fork 0
mirror of https://github.com/graphql-hive/console synced 2026-04-21 14:37:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Upgrade graphql-inspector to v7; update change models (#7267)

Browse source
This commit is contained in:
jdolle 2025-11-25 09:17:06 -08:00 committed by GitHub
parent adac87fad9
commit 114cd80a8e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
10 changed files with 503 additions and 203 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
.changeset/loose-dots-learn.md Normal file
View file

@ -0,0 +1,7 @@
---
'@graphql-hive/cli': minor
'hive': minor
---
Upgrade graphql-inspector/core to v7 and update the models to be able to handle the new change
objects. GraphQL Inspector now supports directive changes and improves the accuracy of the severity level for several change types. This will improve schema checks to make them more accurate and more complete. See graphql-inspector's changelog for details.

3
integration-tests/tests/api/policy/policy-check.spec.ts
View file

@ -323,13 +323,12 @@ describe('Schema policy checks', () => {
'',
' - Deprecation reason is required for field foo in type Query. (source: policy-require-deprecation-reason)',
'',
'ℹ Detected 4 changes',
'ℹ Detected 3 changes',
'',
' Safe changes:',
' - Type User was added',
' - Field user was added to object type Query',
' - Field Query.foo is deprecated',
' - Directive deprecated was added to field Query.foo',
'',
'View full report:',
expect.any(String),

174
integration-tests/tests/api/schema/publish.spec.ts
View file

@ -818,6 +818,9 @@ describe('schema publishing changes are persisted', () => {
equalsObject: {
meta: {
addedDirectiveName: 'foo',
addedDirectiveDescription: null,
addedDirectiveLocations: ['FIELD'],
addedDirectiveRepeatable: false,
},
type: 'DIRECTIVE_ADDED',
},
@ -1278,8 +1281,10 @@ describe('schema publishing changes are persisted', () => {
`,
equalsObject: {
meta: {
addedDirectiveDescription: null,
enumName: 'Foo',
addedEnumValueName: 'b',
addedToNewType: false,
},
type: 'ENUM_VALUE_ADDED',
},
@ -1523,6 +1528,7 @@ describe('schema publishing changes are persisted', () => {
typeName: 'Query',
addedFieldName: 'b',
typeType: 'object type',
addedFieldReturnType: 'String',
},
type: 'FIELD_ADDED',
},
@ -1786,6 +1792,7 @@ describe('schema publishing changes are persisted', () => {
addedArgumentType: 'String!',
hasDefaultValue: false,
isAddedFieldArgumentBreaking: true,
addedToNewField: false,
},
type: 'FIELD_ARGUMENT_ADDED',
},
@ -1811,6 +1818,7 @@ describe('schema publishing changes are persisted', () => {
addedArgumentType: 'String',
hasDefaultValue: false,
isAddedFieldArgumentBreaking: false,
addedToNewField: false,
},
type: 'FIELD_ARGUMENT_ADDED',
},
@ -1866,6 +1874,7 @@ describe('schema publishing changes are persisted', () => {
addedInputFieldName: 'b',
isAddedInputFieldTypeNullable: true,
addedInputFieldType: 'String',
addedToNewType: false,
},
type: 'INPUT_FIELD_ADDED',
},
@ -1898,6 +1907,7 @@ describe('schema publishing changes are persisted', () => {
addedInputFieldName: 'b',
isAddedInputFieldTypeNullable: false,
addedInputFieldType: 'String!',
addedToNewType: false,
},
type: 'INPUT_FIELD_ADDED',
},
@ -2125,6 +2135,7 @@ describe('schema publishing changes are persisted', () => {
meta: {
objectTypeName: 'Query',
addedInterfaceName: 'Foo',
addedToNewType: false,
},
type: 'OBJECT_TYPE_INTERFACE_ADDED',
},
@ -2337,6 +2348,7 @@ describe('schema publishing changes are persisted', () => {
equalsObject: {
meta: {
addedTypeName: 'A',
addedTypeKind: 'ObjectTypeDefinition',
},
type: 'TYPE_ADDED',
},
@ -2508,13 +2520,14 @@ describe('schema publishing changes are persisted', () => {
meta: {
unionName: 'C',
addedUnionMemberTypeName: 'B',
addedToNewType: false,
},
type: 'UNION_MEMBER_ADDED',
},
});
persistedTest({
name: 'UnionMemberAddedModel',
name: 'UnionMemberRemovedModel',
schemaBefore: /* GraphQL */ `
type Query {
a: String!
@ -2612,6 +2625,8 @@ describe('schema publishing changes are persisted', () => {
enumName: 'Role',
enumValueName: 'USER',
addedDirectiveName: 'auth',
addedToNewType: false,
directiveRepeatedTimes: 1,
},
type: 'DIRECTIVE_USAGE_ENUM_VALUE_ADDED',
},
@ -2648,6 +2663,7 @@ describe('schema publishing changes are persisted', () => {
enumName: 'Role',
enumValueName: 'USER',
removedDirectiveName: 'auth',
directiveRepeatedTimes: 1,
},
type: 'DIRECTIVE_USAGE_ENUM_VALUE_REMOVED',
},
@ -2681,6 +2697,7 @@ describe('schema publishing changes are persisted', () => {
`,
equalsObject: {
meta: {
deprecationReason: 'No longer supported',
typeName: 'User',
fieldName: 'name',
},
@ -2745,6 +2762,8 @@ describe('schema publishing changes are persisted', () => {
fieldName: 'user',
argumentName: 'id',
addedDirectiveName: 'validate',
addedToNewType: false,
directiveRepeatedTimes: 1,
},
type: 'DIRECTIVE_USAGE_ARGUMENT_DEFINITION_ADDED',
},
@ -2772,6 +2791,7 @@ describe('schema publishing changes are persisted', () => {
fieldName: 'user',
argumentName: 'id',
removedDirectiveName: 'validate',
directiveRepeatedTimes: 1,
},
type: 'DIRECTIVE_USAGE_ARGUMENT_DEFINITION_REMOVED',
},
@ -2805,6 +2825,8 @@ describe('schema publishing changes are persisted', () => {
meta: {
objectName: 'User',
addedDirectiveName: 'auth',
addedToNewType: false,
directiveRepeatedTimes: 1,
},
type: 'DIRECTIVE_USAGE_OBJECT_ADDED',
},
@ -2838,6 +2860,7 @@ describe('schema publishing changes are persisted', () => {
meta: {
objectName: 'User',
removedDirectiveName: 'auth',
directiveRepeatedTimes: 1,
},
type: 'DIRECTIVE_USAGE_OBJECT_REMOVED',
},
@ -2874,6 +2897,9 @@ describe('schema publishing changes are persisted', () => {
inputObjectName: 'UserInput',
inputFieldName: 'email',
addedDirectiveName: 'validate',
addedToNewType: false,
directiveRepeatedTimes: 1,
inputFieldType: 'String!',
},
type: 'DIRECTIVE_USAGE_INPUT_FIELD_DEFINITION_ADDED',
},
@ -2907,6 +2933,7 @@ describe('schema publishing changes are persisted', () => {
`,
equalsObject: {
meta: {
directiveRepeatedTimes: 0,
inputObjectName: 'UserInput',
inputFieldName: 'email',
removedDirectiveName: 'validate',
@ -2943,6 +2970,8 @@ describe('schema publishing changes are persisted', () => {
meta: {
interfaceName: 'Node',
addedDirectiveName: 'auth',
addedToNewType: false,
directiveRepeatedTimes: 1,
},
type: 'DIRECTIVE_USAGE_INTERFACE_ADDED',
},
@ -2974,12 +3003,155 @@ describe('schema publishing changes are persisted', () => {
`,
equalsObject: {
meta: {
directiveRepeatedTimes: 1,
interfaceName: 'Node',
removedDirectiveName: 'auth',
},
type: 'DIRECTIVE_USAGE_INTERFACE_REMOVED',
},
});
persistedTest({
name: 'DirectiveUsageArgumentAdded',
schemaBefore: /* GraphQL */ `
directive @auth(roles: [String!]) on OBJECT
interface Node {
id: ID!
}
type Query @auth {
node: Node
}
`,
schemaAfter: /* GraphQL */ `
directive @auth(roles: [String!]) on OBJECT
interface Node {
id: ID!
}
type Query @auth(roles: ["node:read"]) {
node: Node
}
`,
equalsObject: {
meta: {
addedArgumentName: 'roles',
addedArgumentValue: '["node:read"]',
directiveName: 'auth',
directiveRepeatedTimes: 1,
oldArgumentValue: null,
parentArgumentName: null,
parentEnumValueName: null,
parentFieldName: null,
parentTypeName: 'Query',
},
type: 'DIRECTIVE_USAGE_ARGUMENT_ADDED',
},
});
persistedTest({
name: 'DirectiveUsageArgumentRemoved',
schemaBefore: /* GraphQL */ `
directive @auth(roles: [String!]) on OBJECT
interface Node {
id: ID!
}
type Query @auth(roles: ["node:read"]) {
node: Node
}
`,
schemaAfter: /* GraphQL */ `
directive @auth(roles: [String!]) on OBJECT
interface Node {
id: ID!
}
type Query @auth {
node: Node
}
`,
equalsObject: {
meta: {
directiveName: 'auth',
directiveRepeatedTimes: 1,
parentArgumentName: null,
parentEnumValueName: null,
parentFieldName: null,
parentTypeName: 'Query',
removedArgumentName: 'roles',
},
type: 'DIRECTIVE_USAGE_ARGUMENT_REMOVED',
},
});
persistedTest({
name: 'DirectiveRepeatableAdded',
schemaBefore: /* GraphQL */ `
directive @auth on OBJECT
interface Node {
id: ID!
}
type Query @auth {
node: Node
}
`,
schemaAfter: /* GraphQL */ `
directive @auth repeatable on OBJECT
interface Node {
id: ID!
}
type Query @auth {
node: Node
}
`,
equalsObject: {
meta: {
directiveName: 'auth',
},
type: 'DIRECTIVE_REPEATABLE_ADDED',
},
});
persistedTest({
name: 'DirectiveRepeatableRemoved',
schemaBefore: /* GraphQL */ `
directive @auth repeatable on OBJECT
interface Node {
id: ID!
}
type Query @auth {
node: Node
}
`,
schemaAfter: /* GraphQL */ `
directive @auth on OBJECT
interface Node {
id: ID!
}
type Query @auth {
node: Node
}
`,
equalsObject: {
meta: {
directiveName: 'auth',
},
type: 'DIRECTIVE_REPEATABLE_REMOVED',
},
});
});
const SchemaCompareToPreviousVersionQuery = graphql(`

2
packages/libraries/cli/package.json
View file

@ -49,7 +49,7 @@
},
"dependencies": {
"@graphql-hive/core": "workspace:*",
"@graphql-inspector/core": "6.4.1",
"@graphql-inspector/core": "7.0.3",
"@graphql-tools/code-file-loader": "~8.1.0",
"@graphql-tools/graphql-file-loader": "~8.1.0",
"@graphql-tools/json-file-loader": "~8.0.0",

2
packages/services/api/package.json
View file

@ -17,7 +17,7 @@
"@date-fns/utc": "2.1.1",
"@graphql-hive/core": "workspace:*",
"@graphql-hive/signal": "1.0.0",
"@graphql-inspector/core": "6.4.1",
"@graphql-inspector/core": "7.0.3",
"@graphql-tools/merge": "9.1.1",
"@hive/cdn-script": "workspace:*",
"@hive/emails": "workspace:*",

4
packages/services/api/src/modules/schema/providers/inspector.ts
View file

@ -10,7 +10,7 @@ import {
type GraphQLSchema,
} from 'graphql';
import { Injectable, Scope } from 'graphql-modules';
import { Change, ChangeType, diff, TypeOfChangeType } from '@graphql-inspector/core';
import { Change, ChangeType, diff, DiffRule, TypeOfChangeType } from '@graphql-inspector/core';
import { traceFn } from '@hive/service-common';
import { HiveSchemaChangeModel } from '@hive/storage';
import { Logger } from '../../shared/providers/logger';
@ -34,7 +34,7 @@ export class Inspector {
async diff(existing: GraphQLSchema, incoming: GraphQLSchema) {
this.logger.debug('Comparing Schemas');
const changes = await diff(existing, incoming);
const changes = await diff(existing, incoming, [DiffRule.simplifyChanges]);
return changes
.filter(dropTrimmedDescriptionChangedChange)

3
packages/services/storage/package.json
View file

@ -16,7 +16,7 @@
"db:generate": "schemats generate --config schemats.cjs -o src/db/types.ts && prettier --write src/db/types.ts"
},
"devDependencies": {
"@graphql-inspector/core": "6.4.1",
"@graphql-inspector/core": "7.0.3",
"@hive/service-common": "workspace:*",
"@sentry/node": "7.120.2",
"@sentry/types": "7.120.2",
@ -26,6 +26,7 @@
"dotenv": "16.4.7",
"fast-json-stable-stringify": "2.1.0",
"got": "14.4.7",
"graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0",
"pg-promise": "11.10.2",
"slonik": "30.4.4",
"slonik-interceptor-query-logging": "46.4.0",

12
packages/services/storage/src/schema-change-meta.ts
View file

@ -13,8 +13,12 @@ import {
directiveLocationAddedFromMeta,
directiveLocationRemovedFromMeta,
directiveRemovedFromMeta,
directiveRepeatableAddedFromMeta,
directiveRepeatableRemovedFromMeta,
directiveUsageArgumentAddedFromMeta,
directiveUsageArgumentDefinitionAddedFromMeta,
directiveUsageArgumentDefinitionRemovedFromMeta,
directiveUsageArgumentRemovedFromMeta,
directiveUsageEnumAddedFromMeta,
directiveUsageEnumRemovedFromMeta,
directiveUsageEnumValueAddedFromMeta,
@ -195,6 +199,10 @@ export function schemaChangeFromSerializableChange(
return directiveUsageInputFieldDefinitionAddedFromMeta(change);
case ChangeType.DirectiveUsageInputFieldDefinitionRemoved:
return directiveUsageInputFieldDefinitionRemovedFromMeta(change);
case ChangeType.DirectiveUsageArgumentAdded:
return directiveUsageArgumentAddedFromMeta(change);
case ChangeType.DirectiveUsageArgumentRemoved:
return directiveUsageArgumentRemovedFromMeta(change);
case ChangeType.EnumValueRemoved:
return enumValueRemovedFromMeta(change);
case ChangeType.EnumValueAdded:
@ -273,6 +281,10 @@ export function schemaChangeFromSerializableChange(
return unionMemberRemovedFromMeta(change);
case ChangeType.UnionMemberAdded:
return buildUnionMemberAddedMessageFromMeta(change);
case ChangeType.DirectiveRepeatableAdded:
return directiveRepeatableAddedFromMeta(change);
case ChangeType.DirectiveRepeatableRemoved:
return directiveRepeatableRemovedFromMeta(change);
case 'REGISTRY_SERVICE_URL_CHANGED':
return buildRegistryServiceURLFromMeta(change);
default:

179
packages/services/storage/src/schema-change-model.ts
View file

@ -1,6 +1,7 @@
/** These mirror DB models from */
import crypto from 'node:crypto';
import stableJSONStringify from 'fast-json-stable-stringify';
import { Kind } from 'graphql';
import { SerializableValue } from 'slonik';
import { z } from 'zod';
import {
@ -16,9 +17,12 @@ import {
DirectiveLocationAddedChange,
DirectiveLocationRemovedChange,
DirectiveRemovedChange,
DirectiveRepeatableAddedChange,
DirectiveRepeatableRemovedChange,
DirectiveUsageArgumentAddedChange,
DirectiveUsageArgumentDefinitionAddedChange,
DirectiveUsageArgumentDefinitionChange,
DirectiveUsageArgumentDefinitionRemovedChange,
DirectiveUsageArgumentRemovedChange,
DirectiveUsageEnumAddedChange,
DirectiveUsageEnumRemovedChange,
DirectiveUsageEnumValueAddedChange,
@ -81,7 +85,6 @@ import {
TypeDescriptionChangedChange,
TypeDescriptionRemovedChange,
TypeKindChangedChange,
TypeOfChangeType,
TypeRemovedChange,
UnionMemberAddedChange,
UnionMemberRemovedChange,
@ -100,6 +103,10 @@ const FieldArgumentTypeChangedLiteral = z.literal("FIELD_ARGUMENT_TYPE_CHANGED"
// prettier-ignore
const DirectiveRemovedLiteral = z.literal("DIRECTIVE_REMOVED" satisfies `${typeof ChangeType.DirectiveRemoved}`)
// prettier-ignore
const DirectiveRepeatableAddedLiteral = z.literal("DIRECTIVE_REPEATABLE_ADDED" satisfies `${typeof ChangeType.DirectiveRepeatableAdded}`)
// prettier-ignore
const DirectiveRepeatableRemovedLiteral = z.literal("DIRECTIVE_REPEATABLE_REMOVED" satisfies `${typeof ChangeType.DirectiveRepeatableRemoved}`)
// prettier-ignore
const DirectiveAddedLiteral = z.literal("DIRECTIVE_ADDED" satisfies `${typeof ChangeType.DirectiveAdded}`)
// prettier-ignore
const DirectiveDescriptionChangedLiteral = z.literal("DIRECTIVE_DESCRIPTION_CHANGED" satisfies `${typeof ChangeType.DirectiveDescriptionChanged}`)
@ -243,20 +250,13 @@ const TypeDescriptionAddedLiteral = z.literal("TYPE_DESCRIPTION_ADDED" satisfie
const UnionMemberRemovedLiteral = z.literal("UNION_MEMBER_REMOVED" satisfies `${typeof ChangeType.UnionMemberRemoved}`)
// prettier-ignore
const UnionMemberAddedLiteral = z.literal("UNION_MEMBER_ADDED" satisfies `${typeof ChangeType.UnionMemberAdded}`)
// prettier-ignore
const DirectiveUsageArgumentAddedLiteral = z.literal("DIRECTIVE_USAGE_ARGUMENT_ADDED" satisfies `${typeof ChangeType.DirectiveUsageArgumentAdded}`)
// prettier-ignore
const DirectiveUsageArgumentRemovedLiteral = z.literal("DIRECTIVE_USAGE_ARGUMENT_REMOVED" satisfies `${typeof ChangeType.DirectiveUsageArgumentRemoved}`)
/**
* @source https://github.com/colinhacks/zod/issues/372#issuecomment-1280054492
*/
type Implements<Model> = {
[key in keyof Model]-?: undefined extends Model[key]
? null extends Model[key]
? z.ZodNullableType<z.ZodOptionalType<z.ZodType<Model[key]>>>
: z.ZodOptionalType<z.ZodType<Model[key]>>
: null extends Model[key]
? z.ZodNullableType<z.ZodType<Model[key]>>
: Model[key] extends TypeOfChangeType
? z.ZodLiteral<`${Model[key]}`>
: z.ZodType<Model[key]>;
[K in keyof Model]-?: z.ZodTypeAny & { _output: Model[K] };
};
export function implement<Model = never>() {
@ -315,10 +315,28 @@ export const DirectiveRemovedModel = implement<DirectiveRemovedChange>().with({
}),
});
export const DirectiveRepeatableAddedModel = implement<DirectiveRepeatableAddedChange>().with({
type: DirectiveRepeatableAddedLiteral,
meta: z.object({
directiveName: z.string(),
}),
});
export const DirectiveRepeatableRemovedModel = implement<DirectiveRepeatableRemovedChange>().with({
type: DirectiveRepeatableRemovedLiteral,
meta: z.object({
directiveName: z.string(),
}),
});
export const DirectiveAddedModel = implement<DirectiveAddedChange>().with({
type: DirectiveAddedLiteral,
meta: z.object({
addedDirectiveName: z.string(),
// for backwards compatibility
addedDirectiveRepeatable: z.boolean().default(false),
addedDirectiveLocations: z.array(z.string()).default([]),
addedDirectiveDescription: z.string().nullish().default(null), // string | null;
}),
});
@ -354,7 +372,11 @@ export const DirectiveArgumentAddedModel = implement<DirectiveArgumentAddedChang
meta: z.object({
directiveName: z.string(),
addedDirectiveArgumentName: z.string(),
addedDirectiveArgumentTypeIsNonNull: z.boolean(),
addedDirectiveArgumentTypeIsNonNull: z.boolean().default(false),
addedDirectiveArgumentType: z.string().default(''),
addedToNewDirective: z.boolean().default(false),
addedDirectiveArgumentDescription: z.optional(z.string()),
addedDirectiveDefaultValue: z.optional(z.string()),
}),
});
@ -407,6 +429,8 @@ export const DirectiveUsageEnumValueAddedModel =
enumName: z.string(),
enumValueName: z.string(),
addedDirectiveName: z.string(),
addedToNewType: z.boolean().default(false),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -417,6 +441,7 @@ export const DirectiveUsageEnumValueRemovedModel =
enumName: z.string(),
enumValueName: z.string(),
removedDirectiveName: z.string(),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -426,6 +451,7 @@ export const DirectiveUsageFieldAddedModel = implement<DirectiveUsageFieldAddedC
typeName: z.string(),
fieldName: z.string(),
addedDirectiveName: z.string(),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -435,6 +461,7 @@ export const DirectiveUsageFieldRemovedModel = implement<DirectiveUsageFieldRemo
typeName: z.string(),
fieldName: z.string(),
removedDirectiveName: z.string(),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -445,9 +472,10 @@ export const DirectiveUsageUnionMemberAddedModel =
unionName: z.string(),
addedUnionMemberTypeName: z.string(),
addedDirectiveName: z.string(),
addedToNewType: z.boolean().default(false),
directiveRepeatedTimes: z.number().default(1),
}),
});
export const DirectiveUsageUnionMemberRemovedModel =
implement<DirectiveUsageUnionMemberRemovedChange>().with({
type: DirectiveUsageUnionMemberRemovedLiteral,
@ -455,6 +483,7 @@ export const DirectiveUsageUnionMemberRemovedModel =
unionName: z.string(),
removedUnionMemberTypeName: z.string(),
removedDirectiveName: z.string(),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -465,6 +494,8 @@ export const DirectiveUsageFieldDefinitionAddedModel =
typeName: z.string(),
fieldName: z.string(),
addedDirectiveName: z.string(),
addedToNewType: z.boolean().default(false),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -475,6 +506,7 @@ export const DirectiveUsageFieldDefinitionRemovedModel =
typeName: z.string(),
fieldName: z.string(),
removedDirectiveName: z.string(),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -485,6 +517,9 @@ export const DirectiveUsageInputFieldDefinitionAddedModel =
inputObjectName: z.string(),
inputFieldName: z.string(),
addedDirectiveName: z.string(),
addedToNewType: z.boolean().default(false),
inputFieldType: z.string().default(''),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -495,6 +530,7 @@ export const DirectiveUsageInputFieldDefinitionRemovedModel =
inputObjectName: z.string(),
inputFieldName: z.string(),
removedDirectiveName: z.string(),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -506,17 +542,8 @@ export const DirectiveUsageArgumentDefinitionAddedModel =
fieldName: z.string(),
argumentName: z.string(),
addedDirectiveName: z.string(),
}),
});
export const DirectiveUsageArgumentDefinitionModel =
implement<DirectiveUsageArgumentDefinitionChange>().with({
type: DirectiveUsageArgumentDefinitionAddedLiteral,
meta: z.object({
typeName: z.string(),
fieldName: z.string(),
argumentName: z.string(),
addedDirectiveName: z.string(),
addedToNewType: z.boolean().default(false),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -528,6 +555,7 @@ export const DirectiveUsageArgumentDefinitionRemovedModel =
fieldName: z.string(),
argumentName: z.string(),
removedDirectiveName: z.string(),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -536,6 +564,8 @@ export const DirectiveUsageEnumAddedModel = implement<DirectiveUsageEnumAddedCha
meta: z.object({
enumName: z.string(),
addedDirectiveName: z.string(),
addedToNewType: z.boolean().default(false),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -544,6 +574,7 @@ export const DirectiveUsageEnumRemovedModel = implement<DirectiveUsageEnumRemove
meta: z.object({
enumName: z.string(),
removedDirectiveName: z.string(),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -556,6 +587,8 @@ export const DirectiveUsageInputObjectAddedModel =
isAddedInputFieldTypeNullable: z.boolean(),
addedInputFieldType: z.string(),
addedDirectiveName: z.string(),
addedToNewType: z.boolean().default(false),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -568,6 +601,7 @@ export const DirectiveUsageInputObjectRemovedModel =
isRemovedInputFieldTypeNullable: z.boolean(),
removedInputFieldType: z.string(),
removedDirectiveName: z.string(),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -576,6 +610,8 @@ export const DirectiveUsageScalarAddedModel = implement<DirectiveUsageScalarAdde
meta: z.object({
scalarName: z.string(),
addedDirectiveName: z.string(),
addedToNewType: z.boolean().default(false),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -585,6 +621,7 @@ export const DirectiveUsageScalarRemovedModel = implement<DirectiveUsageScalarRe
meta: z.object({
scalarName: z.string(),
removedDirectiveName: z.string(),
directiveRepeatedTimes: z.number().default(1),
}),
},
);
@ -594,6 +631,8 @@ export const DirectiveUsageObjectAddedModel = implement<DirectiveUsageObjectAdde
meta: z.object({
objectName: z.string(),
addedDirectiveName: z.string(),
addedToNewType: z.boolean().default(false),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -603,16 +642,18 @@ export const DirectiveUsageObjectRemovedModel = implement<DirectiveUsageObjectRe
meta: z.object({
objectName: z.string(),
removedDirectiveName: z.string(),
directiveRepeatedTimes: z.number().default(1),
}),
},
);
export const DirectiveUsageInterfaceAddedModel =
implement<DirectiveUsageInterfaceAddedChange>().with({
type: DirectiveUsageInterfaceAddedLiteral,
meta: z.object({
interfaceName: z.string(),
addedDirectiveName: z.string(),
addedToNewType: z.boolean().default(false),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -622,6 +663,7 @@ export const DirectiveUsageInterfaceRemovedModel =
meta: z.object({
interfaceName: z.string(),
removedDirectiveName: z.string(),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -630,6 +672,8 @@ export const DirectiveUsageSchemaAddedModel = implement<DirectiveUsageSchemaAdde
meta: z.object({
addedDirectiveName: z.string(),
schemaTypeName: z.string(),
addedToNewType: z.boolean().default(false),
directiveRepeatedTimes: z.number().default(1),
}),
});
@ -639,9 +683,40 @@ export const DirectiveUsageSchemaRemovedModel = implement<DirectiveUsageSchemaRe
meta: z.object({
removedDirectiveName: z.string(),
schemaTypeName: z.string(),
directiveRepeatedTimes: z.number().default(1),
}),
},
);
export const DirectiveUsageArgumentAddedModel = implement<DirectiveUsageArgumentAddedChange>().with(
{
type: DirectiveUsageArgumentAddedLiteral,
meta: z.object({
directiveName: z.string(),
addedArgumentName: z.string(),
addedArgumentValue: z.string(),
oldArgumentValue: z.string().nullable(),
parentTypeName: z.string().nullable(),
parentFieldName: z.string().nullable(),
parentArgumentName: z.string().nullable(),
parentEnumValueName: z.string().nullable(),
directiveRepeatedTimes: z.number().default(1),
}),
},
);
export const DirectiveUsageArgumentRemovedModel =
implement<DirectiveUsageArgumentRemovedChange>().with({
type: DirectiveUsageArgumentRemovedLiteral,
meta: z.object({
directiveName: z.string(),
removedArgumentName: z.string(),
parentTypeName: z.string().nullable(),
parentFieldName: z.string().nullable(),
parentArgumentName: z.string().nullable(),
parentEnumValueName: z.string().nullable(),
directiveRepeatedTimes: z.number().default(1),
}),
});
// Enum
@ -654,11 +729,13 @@ export const EnumValueRemovedModel = implement<EnumValueRemovedChange>().with({
}),
});
export const EnumValueAdded = implement<EnumValueAddedChange>().with({
export const EnumValueAddedModel = implement<EnumValueAddedChange>().with({
type: EnumValueAddedLiteral,
meta: z.object({
enumName: z.string(),
addedEnumValueName: z.string(),
addedToNewType: z.boolean().default(false),
addedDirectiveDescription: z.string().nullable().optional().default(null),
}),
});
@ -723,6 +800,7 @@ export const FieldAddedModel = implement<FieldAddedChange>().with({
typeName: z.string(),
addedFieldName: z.string(),
typeType: z.string(),
addedFieldReturnType: z.string().default(''), // optional for backwards compatibility
}),
});
@ -758,6 +836,7 @@ export const FieldDeprecationAddedModel = implement<FieldDeprecationAddedChange>
meta: z.object({
typeName: z.string(),
fieldName: z.string(),
deprecationReason: z.string().default('No longer supported'), // for backwards compatibility
}),
});
@ -820,6 +899,7 @@ export const FieldArgumentAddedModel = implement<FieldArgumentAddedChange>().wit
addedArgumentType: z.string(),
hasDefaultValue: z.boolean(),
isAddedFieldArgumentBreaking: z.boolean(),
addedToNewField: z.boolean().default(false), // for backwards compatibility
}),
});
@ -851,6 +931,8 @@ export const InputFieldAddedModel = implement<InputFieldAddedChange>().with({
addedInputFieldName: z.string(),
isAddedInputFieldTypeNullable: z.boolean(),
addedInputFieldType: z.string(),
addedToNewType: z.boolean().default(false), // default to make backwards compatible
addedFieldDefault: z.string().optional(),
}),
});
@ -913,6 +995,7 @@ export const ObjectTypeInterfaceAddedModel = implement<ObjectTypeInterfaceAddedC
meta: z.object({
objectTypeName: z.string(),
addedInterfaceName: z.string(),
addedToNewType: z.boolean().default(false), // optional for backwards compatibility
}),
});
@ -961,9 +1044,26 @@ export const TypeRemovedModel = implement<TypeRemovedChange>().with({
export const TypeAddedModel = implement<TypeAddedChange>().with({
type: TypeAddedLiteral,
meta: z.object({
addedTypeName: z.string(),
}),
meta: z.union([
z.object({
addedTypeName: z.string(),
addedTypeKind: z.literal(Kind.INPUT_OBJECT_TYPE_DEFINITION),
addedTypeIsOneOf: z.boolean().default(false),
}),
z.object({
addedTypeName: z.string(),
addedTypeKind: z
.union([
z.literal(Kind.ENUM_TYPE_DEFINITION),
z.literal(Kind.OBJECT_TYPE_DEFINITION),
z.literal(Kind.INTERFACE_TYPE_DEFINITION),
z.literal(Kind.UNION_TYPE_DEFINITION),
z.literal(Kind.SCALAR_TYPE_DEFINITION),
])
/** Default isn't important for old changes b/c they won't be patched but it keeps the model safe for them. */
.default(Kind.OBJECT_TYPE_DEFINITION),
}),
]),
});
export const TypeKindChangedModel = implement<TypeKindChangedChange>().with({
@ -1014,6 +1114,7 @@ export const UnionMemberAddedModel = implement<UnionMemberAddedChange>().with({
meta: z.object({
unionName: z.string(),
addedUnionMemberTypeName: z.string(),
addedToNewType: z.boolean().default(false), // default for backwards compatibility
}),
});
@ -1052,11 +1153,15 @@ export const SchemaChangeModel = z.union([
DirectiveDescriptionChangedModel,
DirectiveLocationAddedModel,
DirectiveLocationRemovedModel,
DirectiveRepeatableAddedModel,
DirectiveRepeatableRemovedModel,
DirectiveArgumentAddedModel,
DirectiveArgumentRemovedModel,
DirectiveArgumentDescriptionChangedModel,
DirectiveArgumentDefaultValueChangedModel,
DirectiveArgumentTypeChangedModel,
DirectiveUsageArgumentAddedModel,
DirectiveUsageArgumentRemovedModel,
DirectiveUsageEnumValueAddedModel,
DirectiveUsageEnumValueRemovedModel,
DirectiveUsageFieldAddedModel,
@ -1068,7 +1173,6 @@ export const SchemaChangeModel = z.union([
DirectiveUsageInputFieldDefinitionAddedModel,
DirectiveUsageInputFieldDefinitionRemovedModel,
DirectiveUsageArgumentDefinitionAddedModel,
DirectiveUsageArgumentDefinitionModel,
DirectiveUsageArgumentDefinitionRemovedModel,
DirectiveUsageEnumAddedModel,
DirectiveUsageEnumRemovedModel,
@ -1083,9 +1187,10 @@ export const SchemaChangeModel = z.union([
DirectiveUsageSchemaAddedModel,
DirectiveUsageSchemaRemovedModel,
EnumValueRemovedModel,
EnumValueAdded,
EnumValueAddedModel,
EnumValueDescriptionChangedModel,
EnumValueDeprecationReasonChangedModel,
DirectiveArgumentTypeChangedModel,
EnumValueDeprecationReasonAddedModel,
EnumValueDeprecationReasonRemovedModel,
FieldRemovedModel,
@ -1229,10 +1334,10 @@ export const HiveSchemaChangeModel = z
breakingChangeSchemaCoordinate = change.path ?? null;
if (
isInputFieldAddedChange(rawChange) &&
rawChange.meta.isAddedInputFieldTypeNullable === false
isInputFieldAddedChange(change) &&
change.meta.isAddedInputFieldTypeNullable === false
) {
breakingChangeSchemaCoordinate = rawChange.meta.inputName;
breakingChangeSchemaCoordinate = change.meta.inputName;
}
}

320
pnpm-lock.yaml
View file

File diff suppressed because it is too large Load diff