Skip to content

Commit 359eea3

Browse files
committed
Make addedToNewType consistent across changes
1 parent 6245082 commit 359eea3

File tree

6 files changed

+16
-16
lines changed

6 files changed

+16
-16
lines changed

packages/core/__tests__/diff/enum.test.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ describe('enum', () => {
4646
expect(change.meta).toMatchObject({
4747
addedEnumValueName: 'A',
4848
enumName: 'enumA',
49-
enumIsOld: false,
49+
addedToNewType: true,
5050
});
5151
}
5252
});

packages/core/src/diff/changes/change.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -254,7 +254,7 @@ export type EnumValueAddedChange = {
254254
meta: {
255255
enumName: string;
256256
addedEnumValueName: string;
257-
enumIsOld: boolean;
257+
addedToNewType: boolean;
258258
};
259259
};
260260

@@ -517,7 +517,7 @@ export type ObjectTypeInterfaceAddedChange = {
517517
meta: {
518518
objectTypeName: string;
519519
addedInterfaceName: string;
520-
isSafeChange: boolean;
520+
addedToNewType: boolean;
521521
};
522522
};
523523

@@ -635,7 +635,7 @@ export type UnionMemberAddedChange = {
635635
meta: {
636636
unionName: string;
637637
addedUnionMemberTypeName: string;
638-
isSafeChange: boolean;
638+
addedToNewType: boolean;
639639
};
640640
};
641641

packages/core/src/diff/changes/enum.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -55,12 +55,12 @@ const enumValueAddedCriticalityDangerousReason = `Adding an enum value may break
5555

5656
export function enumValueAddedFromMeta(args: EnumValueAddedChange) {
5757
/** Dangerous is there was a previous enum value */
58-
const isDangerous = args.meta.enumIsOld === true;
58+
const isSafe = args.meta.addedToNewType;
5959
return {
6060
type: ChangeType.EnumValueAdded,
6161
criticality: {
62-
level: isDangerous ? CriticalityLevel.Dangerous : CriticalityLevel.NonBreaking,
63-
reason: isDangerous ? enumValueAddedCriticalityDangerousReason : undefined,
62+
level: isSafe ? CriticalityLevel.NonBreaking : CriticalityLevel.Dangerous,
63+
reason: isSafe ? undefined : enumValueAddedCriticalityDangerousReason,
6464
},
6565
message: buildEnumValueAddedMessage(args),
6666
meta: args.meta,
@@ -71,14 +71,14 @@ export function enumValueAddedFromMeta(args: EnumValueAddedChange) {
7171
export function enumValueAdded(
7272
type: GraphQLEnumType,
7373
value: GraphQLEnumValue,
74-
enumIsOld: boolean,
74+
addedToNewType: boolean,
7575
): Change<typeof ChangeType.EnumValueAdded> {
7676
return enumValueAddedFromMeta({
7777
type: ChangeType.EnumValueAdded,
7878
meta: {
7979
enumName: type.name,
8080
addedEnumValueName: value.name,
81-
enumIsOld,
81+
addedToNewType,
8282
},
8383
});
8484
}

packages/core/src/diff/changes/object.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ export function objectTypeInterfaceAddedFromMeta(args: ObjectTypeInterfaceAddedC
1515
return {
1616
type: ChangeType.ObjectTypeInterfaceAdded,
1717
criticality: {
18-
level: args.meta.isSafeChange ? CriticalityLevel.NonBreaking : CriticalityLevel.Dangerous,
18+
level: args.meta.addedToNewType ? CriticalityLevel.NonBreaking : CriticalityLevel.Dangerous,
1919
reason:
2020
'Adding an interface to an object type may break existing clients that were not programming defensively against a new possible type.',
2121
},
@@ -28,14 +28,14 @@ export function objectTypeInterfaceAddedFromMeta(args: ObjectTypeInterfaceAddedC
2828
export function objectTypeInterfaceAdded(
2929
iface: GraphQLInterfaceType,
3030
type: GraphQLObjectType | GraphQLInterfaceType,
31-
isSafeChange: boolean,
31+
addedToNewType: boolean,
3232
): Change<typeof ChangeType.ObjectTypeInterfaceAdded> {
3333
return objectTypeInterfaceAddedFromMeta({
3434
type: ChangeType.ObjectTypeInterfaceAdded,
3535
meta: {
3636
objectTypeName: type.name,
3737
addedInterfaceName: iface.name,
38-
isSafeChange,
38+
addedToNewType,
3939
},
4040
});
4141
}

packages/core/src/diff/changes/union.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ function buildUnionMemberAddedMessage(args: UnionMemberAddedChange['meta']) {
4545
export function buildUnionMemberAddedMessageFromMeta(args: UnionMemberAddedChange) {
4646
return {
4747
criticality: {
48-
level: args.meta.isSafeChange ? CriticalityLevel.NonBreaking : CriticalityLevel.Dangerous,
48+
level: args.meta.addedToNewType ? CriticalityLevel.NonBreaking : CriticalityLevel.Dangerous,
4949
reason:
5050
'Adding a possible type to Unions may break existing clients that were not programming defensively against a new possible type.',
5151
},
@@ -59,14 +59,14 @@ export function buildUnionMemberAddedMessageFromMeta(args: UnionMemberAddedChang
5959
export function unionMemberAdded(
6060
union: GraphQLUnionType,
6161
type: GraphQLObjectType,
62-
isSafeChange: boolean,
62+
addedToNewType: boolean,
6363
): Change<typeof ChangeType.UnionMemberAdded> {
6464
return buildUnionMemberAddedMessageFromMeta({
6565
type: ChangeType.UnionMemberAdded,
6666
meta: {
6767
unionName: union.name,
6868
addedUnionMemberTypeName: type.name,
69-
isSafeChange,
69+
addedToNewType,
7070
},
7171
});
7272
}

packages/core/src/diff/enum.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ export function changesInEnum(
1818
) {
1919
compareLists(oldEnum?.getValues() ?? [], newEnum.getValues(), {
2020
onAdded(value) {
21-
addChange(enumValueAdded(newEnum, value, !!oldEnum));
21+
addChange(enumValueAdded(newEnum, value, oldEnum === null));
2222
changesInEnumValue({ newVersion: value, oldVersion: null }, newEnum, addChange);
2323
},
2424
onRemoved(value) {

0 commit comments

Comments
 (0)