Some checks failed
Build & Deploy / 🔍 Prepare (push) Successful in 20s
Build & Deploy / 🧪 QA (push) Failing after 34s
Build & Deploy / 🏗️ Build (push) Has started running
Build & Deploy / 🚀 Deploy (push) Has been cancelled
Build & Deploy / 🧪 Smoke Test (push) Has been cancelled
Build & Deploy / ⚡ Lighthouse (push) Has been cancelled
Build & Deploy / 🔔 Notify (push) Has been cancelled
149 lines
4.0 KiB
Plaintext
149 lines
4.0 KiB
Plaintext
import { didYouMean } from '../../jsutils/didYouMean.mjs';
|
|
import { inspect } from '../../jsutils/inspect.mjs';
|
|
import { invariant } from '../../jsutils/invariant.mjs';
|
|
import { suggestionList } from '../../jsutils/suggestionList.mjs';
|
|
import { GraphQLError } from '../../error/GraphQLError.mjs';
|
|
import { Kind } from '../../language/kinds.mjs';
|
|
import { isTypeDefinitionNode } from '../../language/predicates.mjs';
|
|
import {
|
|
isEnumType,
|
|
isInputObjectType,
|
|
isInterfaceType,
|
|
isObjectType,
|
|
isScalarType,
|
|
isUnionType,
|
|
} from '../../type/definition.mjs';
|
|
|
|
/**
|
|
* Possible type extension
|
|
*
|
|
* A type extension is only valid if the type is defined and has the same kind.
|
|
*/
|
|
export function PossibleTypeExtensionsRule(context) {
|
|
const schema = context.getSchema();
|
|
const definedTypes = Object.create(null);
|
|
|
|
for (const def of context.getDocument().definitions) {
|
|
if (isTypeDefinitionNode(def)) {
|
|
definedTypes[def.name.value] = def;
|
|
}
|
|
}
|
|
|
|
return {
|
|
ScalarTypeExtension: checkExtension,
|
|
ObjectTypeExtension: checkExtension,
|
|
InterfaceTypeExtension: checkExtension,
|
|
UnionTypeExtension: checkExtension,
|
|
EnumTypeExtension: checkExtension,
|
|
InputObjectTypeExtension: checkExtension,
|
|
};
|
|
|
|
function checkExtension(node) {
|
|
const typeName = node.name.value;
|
|
const defNode = definedTypes[typeName];
|
|
const existingType =
|
|
schema === null || schema === void 0 ? void 0 : schema.getType(typeName);
|
|
let expectedKind;
|
|
|
|
if (defNode) {
|
|
expectedKind = defKindToExtKind[defNode.kind];
|
|
} else if (existingType) {
|
|
expectedKind = typeToExtKind(existingType);
|
|
}
|
|
|
|
if (expectedKind) {
|
|
if (expectedKind !== node.kind) {
|
|
const kindStr = extensionKindToTypeName(node.kind);
|
|
context.reportError(
|
|
new GraphQLError(`Cannot extend non-${kindStr} type "${typeName}".`, {
|
|
nodes: defNode ? [defNode, node] : node,
|
|
}),
|
|
);
|
|
}
|
|
} else {
|
|
const allTypeNames = Object.keys({
|
|
...definedTypes,
|
|
...(schema === null || schema === void 0
|
|
? void 0
|
|
: schema.getTypeMap()),
|
|
});
|
|
const suggestedTypes = suggestionList(typeName, allTypeNames);
|
|
context.reportError(
|
|
new GraphQLError(
|
|
`Cannot extend type "${typeName}" because it is not defined.` +
|
|
didYouMean(suggestedTypes),
|
|
{
|
|
nodes: node.name,
|
|
},
|
|
),
|
|
);
|
|
}
|
|
}
|
|
}
|
|
const defKindToExtKind = {
|
|
[Kind.SCALAR_TYPE_DEFINITION]: Kind.SCALAR_TYPE_EXTENSION,
|
|
[Kind.OBJECT_TYPE_DEFINITION]: Kind.OBJECT_TYPE_EXTENSION,
|
|
[Kind.INTERFACE_TYPE_DEFINITION]: Kind.INTERFACE_TYPE_EXTENSION,
|
|
[Kind.UNION_TYPE_DEFINITION]: Kind.UNION_TYPE_EXTENSION,
|
|
[Kind.ENUM_TYPE_DEFINITION]: Kind.ENUM_TYPE_EXTENSION,
|
|
[Kind.INPUT_OBJECT_TYPE_DEFINITION]: Kind.INPUT_OBJECT_TYPE_EXTENSION,
|
|
};
|
|
|
|
function typeToExtKind(type) {
|
|
if (isScalarType(type)) {
|
|
return Kind.SCALAR_TYPE_EXTENSION;
|
|
}
|
|
|
|
if (isObjectType(type)) {
|
|
return Kind.OBJECT_TYPE_EXTENSION;
|
|
}
|
|
|
|
if (isInterfaceType(type)) {
|
|
return Kind.INTERFACE_TYPE_EXTENSION;
|
|
}
|
|
|
|
if (isUnionType(type)) {
|
|
return Kind.UNION_TYPE_EXTENSION;
|
|
}
|
|
|
|
if (isEnumType(type)) {
|
|
return Kind.ENUM_TYPE_EXTENSION;
|
|
}
|
|
|
|
if (isInputObjectType(type)) {
|
|
return Kind.INPUT_OBJECT_TYPE_EXTENSION;
|
|
}
|
|
/* c8 ignore next 3 */
|
|
// Not reachable. All possible types have been considered
|
|
|
|
false || invariant(false, 'Unexpected type: ' + inspect(type));
|
|
}
|
|
|
|
function extensionKindToTypeName(kind) {
|
|
switch (kind) {
|
|
case Kind.SCALAR_TYPE_EXTENSION:
|
|
return 'scalar';
|
|
|
|
case Kind.OBJECT_TYPE_EXTENSION:
|
|
return 'object';
|
|
|
|
case Kind.INTERFACE_TYPE_EXTENSION:
|
|
return 'interface';
|
|
|
|
case Kind.UNION_TYPE_EXTENSION:
|
|
return 'union';
|
|
|
|
case Kind.ENUM_TYPE_EXTENSION:
|
|
return 'enum';
|
|
|
|
case Kind.INPUT_OBJECT_TYPE_EXTENSION:
|
|
return 'input object';
|
|
// Not reachable. All possible types have been considered
|
|
|
|
/* c8 ignore next */
|
|
|
|
default:
|
|
false || invariant(false, 'Unexpected kind: ' + inspect(kind));
|
|
}
|
|
}
|