Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added duplicate check for ObjectTypeExtensionNode #316

Merged
merged 3 commits into from
Oct 2, 2024
Merged

Added duplicate check for ObjectTypeExtensionNode #316

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
123e058
added duplicate check for ObjectTypeExtensionNode
mgupta83 Oct 1, 2024
8995167
added a TODO for sourcery suggestion
mgupta83 Oct 2, 2024
9c47439
Merge branch 'main' into mg-graphql-op-dup-check
mgupta83 Oct 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 40 additions & 12 deletions data-access/src/functions/http-graphql/schema/builder/check-duplicate-types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,19 +8,43 @@
import fs from 'fs';
import path from 'path';
import {glob} from 'glob';
import { parse, DocumentNode, DefinitionNode, ObjectTypeDefinitionNode, InterfaceTypeDefinitionNode, InputObjectTypeDefinitionNode, FieldDefinitionNode, Kind, InputValueDefinitionNode } from 'graphql';
import { parse, DocumentNode, DefinitionNode, ObjectTypeExtensionNode, ObjectTypeDefinitionNode, InterfaceTypeDefinitionNode, InputObjectTypeDefinitionNode, FieldDefinitionNode, Kind, InputValueDefinitionNode } from 'graphql';
mgupta83 marked this conversation as resolved.
Show resolved Hide resolved
import { error } from 'console';

type AllowedOutputTypeDefinitionNodes = ObjectTypeDefinitionNode | InterfaceTypeDefinitionNode;
type AllowedInputTypeDefinitionNodes = InputObjectTypeDefinitionNode;

type AllowedOutputTypeDefinitionNode = ObjectTypeDefinitionNode | InterfaceTypeDefinitionNode;
type AllowedInputTypeDefinitionNode = InputObjectTypeDefinitionNode;
type AllowedExtensionTypeDefinitionNode = ObjectTypeExtensionNode;
mgupta83 marked this conversation as resolved.
Show resolved Hide resolved

const GRAPHQL_FILES_PATTERN = path.join(__dirname, "../../../http-graphql/**/*.graphql");
console.log(`... graphql-file-pattern | ${GRAPHQL_FILES_PATTERN}`);


// extension types
function processExtensionTypeNode(outputTypeNode: AllowedExtensionTypeDefinitionNode, processedNodes: string[] = [], errors: string[] = []) {
const fieldDefinitions = recursiveFunctionToFindExtensionFieldDefinitions(outputTypeNode);
fieldDefinitions.forEach(fieldDef => {
const extensionFieldName = `${outputTypeNode.name.value}.${fieldDef.name.value}`
if(processedNodes.includes(extensionFieldName)) {
errors.push(`duplicate-found | extension-field | ${extensionFieldName}`);
}
else {
processedNodes.push(extensionFieldName);
}
});
}
function recursiveFunctionToFindExtensionFieldDefinitions(node: AllowedExtensionTypeDefinitionNode | FieldDefinitionNode , fieldDefinitions: FieldDefinitionNode[] = []): FieldDefinitionNode[] {
if (node.kind === Kind.FIELD_DEFINITION) {
fieldDefinitions.push(node);
}
if (node.kind === Kind.OBJECT_TYPE_EXTENSION) {
node.fields.forEach((childNode: AllowedExtensionTypeDefinitionNode | FieldDefinitionNode) => recursiveFunctionToFindExtensionFieldDefinitions(childNode, fieldDefinitions));
}
return fieldDefinitions;
}


// output types
function processOutputTypeNode(outputTypeNode: AllowedOutputTypeDefinitionNodes, processedNodes: string[] = [], errors: string[] = []) {
function processOutputTypeNode(outputTypeNode: AllowedOutputTypeDefinitionNode, processedNodes: string[] = [], errors: string[] = []) {
const nodeName = outputTypeNode.name.value;
if (processedNodes.includes(nodeName)) {
errors.push(`duplicate-found | output-node | ${nodeName}`);
Expand All @@ -29,7 +53,7 @@ function processOutputTypeNode(outputTypeNode: AllowedOutputTypeDefinitionNodes,
}
checkForDuplicateFieldsInOutputTypeNode(outputTypeNode, errors);
}
function checkForDuplicateFieldsInOutputTypeNode(outputTypeNode: AllowedOutputTypeDefinitionNodes, errors: string[]) {
function checkForDuplicateFieldsInOutputTypeNode(outputTypeNode: AllowedOutputTypeDefinitionNode, errors: string[]) {
const processedFields: string[] = [];
const fieldDefinitions = recursiveFunctionToFindOutputFieldDefinitions(outputTypeNode);
fieldDefinitions.forEach(fieldDef => {
Expand All @@ -42,19 +66,19 @@ function checkForDuplicateFieldsInOutputTypeNode(outputTypeNode: AllowedOutputTy
}
});
}
function recursiveFunctionToFindOutputFieldDefinitions(node: AllowedOutputTypeDefinitionNodes | FieldDefinitionNode , fieldDefinitions: FieldDefinitionNode[] = []): FieldDefinitionNode[] {
function recursiveFunctionToFindOutputFieldDefinitions(node: AllowedOutputTypeDefinitionNode | FieldDefinitionNode , fieldDefinitions: FieldDefinitionNode[] = []): FieldDefinitionNode[] {
if (node.kind === Kind.FIELD_DEFINITION) {
fieldDefinitions.push(node);
}
if (node.kind === Kind.OBJECT_TYPE_DEFINITION || node.kind === Kind.INTERFACE_TYPE_DEFINITION) {
node.fields.forEach((childNode: AllowedOutputTypeDefinitionNodes | FieldDefinitionNode) => recursiveFunctionToFindOutputFieldDefinitions(childNode, fieldDefinitions));
node.fields.forEach((childNode: AllowedOutputTypeDefinitionNode | FieldDefinitionNode) => recursiveFunctionToFindOutputFieldDefinitions(childNode, fieldDefinitions));
}
return fieldDefinitions;
}


// input types
function processInputTypeNode(inputTypeNode: AllowedInputTypeDefinitionNodes, processedNodes: string[] = [], errors: string[] = []) {
function processInputTypeNode(inputTypeNode: AllowedInputTypeDefinitionNode, processedNodes: string[] = [], errors: string[] = []) {
const nodeName = inputTypeNode.name.value;
if (processedNodes.includes(nodeName)) {
errors.push(`duplicate-found | input-node | ${nodeName}`);
Expand All @@ -63,7 +87,7 @@ function processInputTypeNode(inputTypeNode: AllowedInputTypeDefinitionNodes, pr
}
checkForDuplicateFieldsInInputTypeNode(inputTypeNode, errors);
}
function checkForDuplicateFieldsInInputTypeNode(inputTypeNode: AllowedInputTypeDefinitionNodes, errors: string[]) {
function checkForDuplicateFieldsInInputTypeNode(inputTypeNode: AllowedInputTypeDefinitionNode, errors: string[]) {
const processedFields: string[] = [];
const fieldDefinitions = recursiveFunctionToFindInputValueDefinitions(inputTypeNode);
fieldDefinitions.forEach(fieldDef => {
Expand All @@ -76,12 +100,12 @@ function checkForDuplicateFieldsInInputTypeNode(inputTypeNode: AllowedInputTypeD
}
});
}
function recursiveFunctionToFindInputValueDefinitions(node: AllowedInputTypeDefinitionNodes | InputValueDefinitionNode, inputValueDefinitions: InputValueDefinitionNode[] = []): InputValueDefinitionNode[] {
function recursiveFunctionToFindInputValueDefinitions(node: AllowedInputTypeDefinitionNode | InputValueDefinitionNode, inputValueDefinitions: InputValueDefinitionNode[] = []): InputValueDefinitionNode[] {
if (node.kind === Kind.INPUT_VALUE_DEFINITION) {
inputValueDefinitions.push(node);
}
if (node.kind === Kind.INPUT_OBJECT_TYPE_DEFINITION) {
node.fields.forEach((childNode: AllowedInputTypeDefinitionNodes | InputValueDefinitionNode) => recursiveFunctionToFindInputValueDefinitions(childNode, inputValueDefinitions));
node.fields.forEach((childNode: AllowedInputTypeDefinitionNode | InputValueDefinitionNode) => recursiveFunctionToFindInputValueDefinitions(childNode, inputValueDefinitions));
}
return inputValueDefinitions;
}
Expand All @@ -99,6 +123,9 @@ function traverseDefinitions(definitions: readonly DefinitionNode[]| unknown[],
else if (defNode.kind === Kind.INPUT_OBJECT_TYPE_DEFINITION) {
processInputTypeNode(defNode, processedNodesMap.get(defNode.kind), errors);
}
else if (defNode.kind === Kind.OBJECT_TYPE_EXTENSION) {
processExtensionTypeNode(defNode, processedNodesMap.get(defNode.kind), errors);
}
else if (defNode.definitions) {
traverseDefinitions(defNode.definitions, processedNodesMap, errors);
}
Expand All @@ -115,6 +142,7 @@ glob(GRAPHQL_FILES_PATTERN).then((files) => {
processedNodesMap.set(Kind.OBJECT_TYPE_DEFINITION, []);
processedNodesMap.set(Kind.INTERFACE_TYPE_DEFINITION, []);
processedNodesMap.set(Kind.INPUT_OBJECT_TYPE_DEFINITION, []);
processedNodesMap.set(Kind.OBJECT_TYPE_EXTENSION, []);
files.forEach((file) => {
console.log(`... processing ${file}`);
const content = fs.readFileSync(file, 'utf8');
Expand Down