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.

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

Introduce Webpack Loader and Node Require Extension #1579

Merged
merged 4 commits into from Jun 2, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
68 changes: 43 additions & 25 deletions packages/import/src/index.ts
Expand Up @@ -31,6 +31,8 @@ import {
SchemaDefinitionNode,
OperationTypeDefinitionNode,
DocumentNode,
ScalarTypeDefinitionNode,
ScalarTypeExtensionNode,
} from 'graphql';
import { readFileSync, realpathSync } from 'fs-extra';
import { dirname, join, isAbsolute } from 'path';
Expand Down Expand Up @@ -138,6 +140,12 @@ function visitFile(
case Kind.DIRECTIVE_DEFINITION:
visitDirectiveDefinitionNode(definition, dependencySet, dependenciesByDefinitionName);
break;
case Kind.SCALAR_TYPE_DEFINITION:
visitScalarDefinitionNode(definition, dependencySet);
break;
case Kind.SCHEMA_DEFINITION:
visitSchemaDefinitionNode(definition, dependencySet);
break;
case Kind.OBJECT_TYPE_EXTENSION:
visitObjectTypeExtensionNode(definition, dependencySet, dependenciesByDefinitionName);
break;
Expand All @@ -153,8 +161,8 @@ function visitFile(
case Kind.INPUT_OBJECT_TYPE_EXTENSION:
visitInputObjectTypeExtensionNode(definition, dependencySet, dependenciesByDefinitionName);
break;
case Kind.SCHEMA_DEFINITION:
visitSchemaDefinitionNode(definition, dependencySet);
case Kind.SCALAR_TYPE_EXTENSION:
visitScalarExtensionNode(definition, dependencySet);
break;
}
if ('fields' in definition) {
Expand Down Expand Up @@ -365,11 +373,11 @@ function visitObjectTypeDefinitionNode(
) {
const typeName = node.name.value;
dependencySet.add(typeName);
node.directives.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.fields.forEach(fieldDefinitionNode =>
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.fields?.forEach(fieldDefinitionNode =>
visitFieldDefinitionNode(fieldDefinitionNode, dependencySet, dependenciesByDefinitionName)
);
node.interfaces.forEach(namedTypeNode => {
node.interfaces?.forEach(namedTypeNode => {
visitNamedTypeNode(namedTypeNode, dependencySet);
const interfaceName = namedTypeNode.name.value;
// interface should be dependent to the type as well
Expand All @@ -392,10 +400,10 @@ function visitFieldDefinitionNode(
dependencySet: Set<string>,
dependenciesByDefinitionName: Map<string, Set<string>>
) {
node.arguments.forEach(inputValueDefinitionNode =>
node.arguments?.forEach(inputValueDefinitionNode =>
visitInputValueDefinitionNode(inputValueDefinitionNode, dependencySet, dependenciesByDefinitionName)
);
node.directives.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
visitTypeNode(node.type, dependencySet, dependenciesByDefinitionName);
}

Expand Down Expand Up @@ -445,7 +453,7 @@ function visitInputValueDefinitionNode(
dependencySet: Set<string>,
dependenciesByDefinitionName: Map<string, Set<string>>
) {
node.directives.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
visitTypeNode(node.type, dependencySet, dependenciesByDefinitionName);
}

Expand All @@ -456,8 +464,8 @@ function visitInterfaceTypeDefinitionNode(
) {
const typeName = node.name.value;
dependencySet.add(typeName);
node.directives.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.fields.forEach(fieldDefinitionNode =>
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.fields?.forEach(fieldDefinitionNode =>
visitFieldDefinitionNode(fieldDefinitionNode, dependencySet, dependenciesByDefinitionName)
);
(node as any).interfaces?.forEach((namedTypeNode: NamedTypeNode) => {
Expand All @@ -473,13 +481,13 @@ function visitInterfaceTypeDefinitionNode(

function visitUnionTypeDefinitionNode(node: UnionTypeDefinitionNode, dependencySet: Set<string>) {
dependencySet.add(node.name.value);
node.directives.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.types.forEach(namedTypeNode => visitNamedTypeNode(namedTypeNode, dependencySet));
}

function visitEnumTypeDefinitionNode(node: EnumTypeDefinitionNode, dependencySet: Set<string>) {
dependencySet.add(node.name.value);
node.directives.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
}

function visitInputObjectTypeDefinitionNode(
Expand All @@ -488,8 +496,8 @@ function visitInputObjectTypeDefinitionNode(
dependenciesByDefinitionName: Map<string, Set<string>>
) {
dependencySet.add(node.name.value);
node.directives.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.fields.forEach(inputValueDefinitionNode =>
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.fields?.forEach(inputValueDefinitionNode =>
visitInputValueDefinitionNode(inputValueDefinitionNode, dependencySet, dependenciesByDefinitionName)
);
}
Expand All @@ -500,7 +508,7 @@ function visitDirectiveDefinitionNode(
dependenciesByDefinitionName: Map<string, Set<string>>
) {
dependencySet.add(node.name.value);
node.arguments.forEach(inputValueDefinitionNode =>
node.arguments?.forEach(inputValueDefinitionNode =>
visitInputValueDefinitionNode(inputValueDefinitionNode, dependencySet, dependenciesByDefinitionName)
);
}
Expand All @@ -512,11 +520,11 @@ function visitObjectTypeExtensionNode(
) {
const typeName = node.name.value;
dependencySet.add(typeName);
node.directives.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.fields.forEach(fieldDefinitionNode =>
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.fields?.forEach(fieldDefinitionNode =>
visitFieldDefinitionNode(fieldDefinitionNode, dependencySet, dependenciesByDefinitionName)
);
node.interfaces.forEach(namedTypeNode => {
node.interfaces?.forEach(namedTypeNode => {
visitNamedTypeNode(namedTypeNode, dependencySet);
const interfaceName = namedTypeNode.name.value;
// interface should be dependent to the type as well
Expand All @@ -534,8 +542,8 @@ function visitInterfaceTypeExtensionNode(
) {
const typeName = node.name.value;
dependencySet.add(typeName);
node.directives.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.fields.forEach(fieldDefinitionNode =>
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.fields?.forEach(fieldDefinitionNode =>
visitFieldDefinitionNode(fieldDefinitionNode, dependencySet, dependenciesByDefinitionName)
);
(node as any).interfaces?.forEach((namedTypeNode: NamedTypeNode) => {
Expand All @@ -551,13 +559,13 @@ function visitInterfaceTypeExtensionNode(

function visitUnionTypeExtensionNode(node: UnionTypeExtensionNode, dependencySet: Set<string>) {
dependencySet.add(node.name.value);
node.directives.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.types.forEach(namedTypeNode => visitNamedTypeNode(namedTypeNode, dependencySet));
}

function visitEnumTypeExtensionNode(node: EnumTypeExtensionNode, dependencySet: Set<string>) {
dependencySet.add(node.name.value);
node.directives.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
}

function visitInputObjectTypeExtensionNode(
Expand All @@ -566,20 +574,30 @@ function visitInputObjectTypeExtensionNode(
dependenciesByDefinitionName: Map<string, Set<string>>
) {
dependencySet.add(node.name.value);
node.directives.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.fields.forEach(inputValueDefinitionNode =>
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.fields?.forEach(inputValueDefinitionNode =>
visitInputValueDefinitionNode(inputValueDefinitionNode, dependencySet, dependenciesByDefinitionName)
);
}

function visitSchemaDefinitionNode(node: SchemaDefinitionNode, dependencySet: Set<string>) {
dependencySet.add('schema');
node.directives.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
node.operationTypes.forEach(operationTypeDefinitionNode =>
visitOperationTypeDefinitionNode(operationTypeDefinitionNode, dependencySet)
);
}

function visitScalarDefinitionNode(node: ScalarTypeDefinitionNode, dependencySet: Set<string>) {
dependencySet.add(node.name.value);
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
}

function visitScalarExtensionNode(node: ScalarTypeExtensionNode, dependencySet: Set<string>) {
dependencySet.add(node.name.value);
node.directives?.forEach(directiveNode => visitDirectiveNode(directiveNode, dependencySet));
}

function visitOperationTypeDefinitionNode(node: OperationTypeDefinitionNode, dependencySet: Set<string>) {
visitNamedTypeNode(node.type, dependencySet);
}
Expand Up @@ -4,4 +4,5 @@ type A {
first: String
second: Float
b: B
date: Date
}
@@ -1,4 +1,5 @@
# import C1, C2 from '../import-all/c.graphql'
scalar Date
type B {
hello: String!
c1: C1
Expand Down
5 changes: 4 additions & 1 deletion packages/import/tests/schema/import-schema.spec.ts
Expand Up @@ -6,7 +6,7 @@ import { Kind, print } from 'graphql';

const importSchema = (schema: string, schemas?: Record<string, string>) => {
const document = processImport(schema, __dirname, schemas);
return print(mergeTypeDefs(document.definitions.map(definition => ({ kind: Kind.DOCUMENT, definitions: [definition]})), {
return print(mergeTypeDefs(document.definitions.map(definition => ({ kind: Kind.DOCUMENT, definitions: [definition] })), {
sort: true,
useSchemaDefinition: false,
}))
Expand Down Expand Up @@ -290,10 +290,13 @@ describe('importSchema', () => {

test(`importSchema: import all mix 'n match`, () => {
const expectedSDL = /* GraphQL */`\
scalar Date

type A {
first: String
second: Float
b: B
date: Date
}

type C1 {
Expand Down
29 changes: 29 additions & 0 deletions packages/node-require/package.json
@@ -0,0 +1,29 @@
{
"name": "@graphql-tools/node-require",
"version": "6.0.5",
"description": "A set of utils for faster development of GraphQL tools",
"repository": "git@github.com:ardatan/graphql-tools.git",
"license": "MIT",
"sideEffects": false,
"main": "dist/index.cjs.js",
"module": "dist/index.esm.js",
"typings": "dist/index.d.ts",
"typescript": {
"definition": "dist/index.d.ts"
},
"peerDependencies": {
"graphql": "^14.0.0 || ^15.0.0"
},
"buildOptions": {
"input": "./src/index.ts"
},
"dependencies": {
"@graphql-tools/load": "6.0.5",
"@graphql-tools/graphql-file-loader": "6.0.5",
"tslib": "~2.0.0"
},
"publishConfig": {
"access": "public",
"directory": "dist"
}
}
28 changes: 28 additions & 0 deletions packages/node-require/src/declarations.d.ts
@@ -0,0 +1,28 @@
/* eslint-disable import/no-duplicates */
declare module '*.graphql' {
import { DocumentNode } from 'graphql';

const value: DocumentNode;
export = value;
}

declare module '*.gql' {
import { DocumentNode } from 'graphql';

const value: DocumentNode;
export = value;
}

declare module '*.gqls' {
import { DocumentNode } from 'graphql';

const value: DocumentNode;
export = value;
}

declare module '*.graphqls' {
import { DocumentNode } from 'graphql';

const value: DocumentNode;
export = value;
}
30 changes: 30 additions & 0 deletions packages/node-require/src/index.ts
@@ -0,0 +1,30 @@
/* eslint-disable @typescript-eslint/triple-slash-reference */
/* eslint-disable spaced-comment */
/* eslint-disable node/no-deprecated-api */

///<reference path="declarations.d.ts" />

import { loadTypedefsSync } from '@graphql-tools/load';
import { GraphQLFileLoader } from '@graphql-tools/graphql-file-loader';
import { concatAST } from 'graphql';

const VALID_EXTENSIONS = ['graphql', 'graphqls', 'gql', 'gqls'];

function handleModule(m: NodeModule, filename: string) {
console.log(m, filename);
const sources = loadTypedefsSync(filename, {
loaders: [new GraphQLFileLoader()],
});

const documents = sources.map(source => source.document);
const mergedDoc = concatAST(documents);
m.exports = mergedDoc;
}

export function registerGraphQLExtensions(require: NodeRequire) {
VALID_EXTENSIONS.forEach(ext => {
require.extensions[`.${ext}`] = handleModule;
});
}

registerGraphQLExtensions(require);
3 changes: 3 additions & 0 deletions packages/node-require/test/fixtures/test.graphql
@@ -0,0 +1,3 @@
type Query {
foo: String
}
13 changes: 13 additions & 0 deletions packages/node-require/test/node-require.spec.ts
@@ -0,0 +1,13 @@
import '../src';
import { print } from 'graphql';
import { readFileSync } from 'fs';

describe('GraphQL Node Import', () => {
it.skip('should import correct definitions', () => {
const filePath = './fixtures/test.graphql';
const typeDefs = require(filePath);
expect(print(typeDefs).replace(/\s\s+/g, ' ')).toBe(
readFileSync(require.resolve(filePath), 'utf8').replace(/\s\s+/g, ' ')
);
});
});
29 changes: 29 additions & 0 deletions packages/webpack-loader/package.json
@@ -0,0 +1,29 @@
{
"name": "@graphql-tools/webpack-loader",
"version": "6.0.5",
"description": "A set of utils for faster development of GraphQL tools",
"repository": "git@github.com:ardatan/graphql-tools.git",
"license": "MIT",
"sideEffects": false,
"main": "dist/index.cjs.js",
"module": "dist/index.esm.js",
"typings": "dist/index.d.ts",
"typescript": {
"definition": "dist/index.d.ts"
},
"peerDependencies": {
"graphql": "^14.0.0 || ^15.0.0"
},
"buildOptions": {
"input": "./src/index.ts"
},
"dependencies": {
"@graphql-tools/load": "6.0.5",
"@graphql-tools/graphql-file-loader": "6.0.5",
"tslib": "~2.0.0"
},
"publishConfig": {
"access": "public",
"directory": "dist"
}
}
17 changes: 17 additions & 0 deletions packages/webpack-loader/src/index.ts
@@ -0,0 +1,17 @@
import { loadTypedefs } from '@graphql-tools/load';
import { GraphQLFileLoader } from 'packages/graphql-tools/src';
import { concatAST } from 'graphql';

export default function (this: any, path: string) {
const callback = this.async();

this.cacheable();

loadTypedefs(path, {
loaders: [new GraphQLFileLoader()],
}).then(sources => {
const documents = sources.map(source => source.document);
const mergedDoc = concatAST(documents);
return callback(null, `module.exports = ${JSON.stringify(mergedDoc)}`);
});
}