@graphql-inspector/introspect-command 3.1.0 → 3.1.3

package/__tests__/introspect-command.spec.ts

@@ -0,0 +1,129 @@
+import { mockGraphQLServer } from '@graphql-inspector/testing';
+import { LoadersRegistry } from '@graphql-inspector/loaders';
+import loader from '@graphql-inspector/url-loader';
+import { mockCommand } from '@graphql-inspector/commands';
+import { mockLogger, unmockLogger } from '@graphql-inspector/logger';
+import yargs from 'yargs';
+import { buildSchema } from 'graphql';
+import { unlinkSync, existsSync, readFileSync } from 'fs';
+import createCommand from '../src';
+
+function sleepFor(ms: number) {
+  return new Promise((resolve) => {
+    setTimeout(resolve, ms);
+  });
+}
+
+const schema = buildSchema(/* GraphQL */ `
+  type Post {
+    id: ID!
+    title: String!
+    createdAt: String!
+  }
+
+  type Query {
+    post: Post!
+  }
+`);
+
+const loaders = new LoadersRegistry();
+
+loaders.register(loader);
+
+const introspect = createCommand({
+  config: {
+    commands: [],
+    loaders: [],
+  },
+  loaders,
+});
+
+describe('introspect', () => {
+  let spyReporter: jest.SpyInstance;
+  let spyProcessCwd: jest.SpyInstance;
+
+  beforeEach(() => {
+    yargs.reset();
+
+    spyProcessCwd = jest
+      .spyOn(process, 'cwd')
+      .mockImplementation(() => __dirname);
+
+    spyReporter = jest.fn();
+    mockLogger(spyReporter as any);
+  });
+
+  afterEach(() => {
+    yargs.reset();
+    unmockLogger();
+    spyProcessCwd.mockRestore();
+    spyReporter.mockRestore();
+    try {
+      unlinkSync('graphql.schema.json');
+    } catch (e) {}
+  });
+
+  test('graphql api with port and ws in name using url-loader', async () => {
+    const done = mockGraphQLServer({
+      schema,
+      host: 'http://foo.ws:8020',
+      path: '/graphql',
+    });
+    await mockCommand(introspect, 'introspect http://foo.ws:8020/graphql');
+    await sleepFor(500);
+
+    done();
+    expect(existsSync('graphql.schema.json')).toBe(true);
+  });
+
+  test('saved to graphql files using url-loader', async () => {
+    const done = mockGraphQLServer({
+      schema,
+      host: 'https://example.com',
+      path: '/graphql',
+    });
+    await mockCommand(
+      introspect,
+      'introspect https://example.com/graphql -w schema.graphql',
+    );
+    await sleepFor(500);
+
+    done();
+    expect(existsSync('schema.graphql')).toBe(true);
+
+    const printed = readFileSync('schema.graphql', {
+      encoding: 'utf-8',
+    });
+    unlinkSync('schema.graphql');
+
+    const builtSchema = buildSchema(printed);
+
+    expect(builtSchema.getQueryType().getFields()).toHaveProperty('post');
+  });
+
+  test('saved to graphql files using url-loader by GET method', async () => {
+    const done = mockGraphQLServer({
+      schema,
+      host: 'https://example.com',
+      path: '/graphql',
+      method: 'GET',
+    });
+    await mockCommand(
+      introspect,
+      'introspect https://example.com/graphql -w schema.graphql --method GET',
+    );
+    await sleepFor(500);
+
+    done();
+    expect(existsSync('schema.graphql')).toBe(true);
+
+    const printed = readFileSync('schema.graphql', {
+      encoding: 'utf-8',
+    });
+    unlinkSync('schema.graphql');
+
+    const builtSchema = buildSchema(printed);
+
+    expect(builtSchema.getQueryType().getFields()).toHaveProperty('post');
+  });
+});

package/dist/package.json

@@ -0,0 +1,48 @@
+{
+  "name": "@graphql-inspector/introspect-command",
+  "version": "3.1.3",
+  "description": "Introspects GraphQL Schema",
+  "sideEffects": false,
+  "peerDependencies": {
+    "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
+  },
+  "dependencies": {
+    "@graphql-inspector/commands": "3.1.3",
+    "@graphql-inspector/core": "3.1.3",
+    "@graphql-inspector/logger": "3.1.3",
+    "tslib": "^2.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "kamilkisiela/graphql-inspector",
+    "directory": "packages/commands/introspect"
+  },
+  "keywords": [
+    "graphql",
+    "graphql-inspector",
+    "graphql-inspector-command",
+    "tools"
+  ],
+  "author": {
+    "name": "Kamil Kisiela",
+    "email": "kamil.kisiela@gmail.com",
+    "url": "https://github.com/kamilkisiela"
+  },
+  "license": "MIT",
+  "main": "index.js",
+  "module": "index.mjs",
+  "typings": "index.d.ts",
+  "typescript": {
+    "definition": "index.d.ts"
+  },
+  "exports": {
+    ".": {
+      "require": "./index.js",
+      "import": "./index.mjs"
+    },
+    "./*": {
+      "require": "./*.js",
+      "import": "./*.mjs"
+    }
+  }
+}

package/package.json

@@ -1,48 +1,51 @@
 {
   "name": "@graphql-inspector/introspect-command",
-  "version": "3.1.0",
+  "version": "3.1.3",
   "description": "Introspects GraphQL Schema",
-  "sideEffects": false,
-  "peerDependencies": {
-    "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
-  },
-  "dependencies": {
-    "@graphql-inspector/commands": "3.1.0",
-    "@graphql-inspector/core": "3.1.0",
-    "@graphql-inspector/logger": "3.1.0",
-    "tslib": "^2.0.0"
-  },
-  "repository": {
-    "type": "git",
-    "url": "kamilkisiela/graphql-inspector",
-    "directory": "packages/commands/introspect"
-  },
   "keywords": [
     "graphql",
     "graphql-inspector",
     "graphql-inspector-command",
     "tools"
   ],
+  "sideEffects": false,
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "exports": {
+    ".": {
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    },
+    "./*": {
+      "require": "./dist/*.js",
+      "import": "./dist/*.mjs"
+    }
+  },
+  "typings": "dist/index.d.ts",
+  "typescript": {
+    "definition": "dist/index.d.ts"
+  },
   "author": {
     "name": "Kamil Kisiela",
     "email": "kamil.kisiela@gmail.com",
     "url": "https://github.com/kamilkisiela"
   },
   "license": "MIT",
-  "main": "index.js",
-  "module": "index.mjs",
-  "typings": "index.d.ts",
-  "typescript": {
-    "definition": "index.d.ts"
+  "repository": {
+    "type": "git",
+    "url": "kamilkisiela/graphql-inspector",
+    "directory": "packages/commands/introspect"
   },
-  "exports": {
-    ".": {
-      "require": "./index.js",
-      "import": "./index.mjs"
-    },
-    "./*": {
-      "require": "./*.js",
-      "import": "./*.mjs"
-    }
+  "peerDependencies": {
+    "graphql": "^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0"
+  },
+  "dependencies": {
+    "@graphql-inspector/commands": "3.1.3",
+    "@graphql-inspector/core": "3.1.3",
+    "@graphql-inspector/logger": "3.1.3",
+    "tslib": "^2.0.0"
+  },
+  "scripts": {
+    "prepack": "bob prepack"
   }
 }

package/src/index.ts

@@ -0,0 +1,111 @@
+import {
+  createCommand,
+  GlobalArgs,
+  CommandFactory,
+  parseGlobalArgs,
+} from '@graphql-inspector/commands';
+import { Logger } from '@graphql-inspector/logger';
+import { writeFileSync } from 'fs';
+import { resolve, extname } from 'path';
+import {
+  introspectionFromSchema,
+  lexicographicSortSchema,
+  printSchema,
+  GraphQLSchema,
+} from 'graphql';
+
+export { CommandFactory };
+
+export function handler({
+  schema: unsortedSchema,
+  output,
+  comments,
+}: {
+  schema: GraphQLSchema;
+  output: string;
+  comments: boolean;
+}) {
+  const schema = lexicographicSortSchema(unsortedSchema);
+  const introspection = introspectionFromSchema(schema);
+  const filepath = resolve(process.cwd(), output);
+  let content: string;
+
+  switch (extname(output.toLowerCase())) {
+    case '.graphql':
+    case '.gql':
+    case '.gqls':
+    case '.graphqls':
+      content = (printSchema as any)(schema, {
+        commentDescriptions: comments,
+      });
+      break;
+    case '.json':
+      content = JSON.stringify(introspection, null, 2);
+      break;
+    default:
+      throw new Error('Only .graphql, .gql and .json files are supported');
+  }
+
+  writeFileSync(output, content!, {
+    encoding: 'utf-8',
+  });
+
+  Logger.success(`Saved to ${filepath}`);
+}
+
+export default createCommand<
+  {},
+  {
+    schema: string;
+    write?: string;
+    comments?: boolean;
+  } & GlobalArgs
+>((api) => {
+  const { loaders } = api;
+
+  return {
+    command: 'introspect <schema>',
+    describe: 'Introspect a schema',
+    builder(yargs) {
+      return yargs
+        .positional('schema', {
+          describe: 'Point to a schema',
+          type: 'string',
+          demandOption: true,
+        })
+        .options({
+          w: {
+            alias: 'write',
+            describe: 'Write to a file',
+            type: 'string',
+          },
+          comments: {
+            describe: 'Use preceding comments as the description',
+            type: 'boolean',
+          },
+        })
+        .default('w', 'graphql.schema.json');
+    },
+    async handler(args) {
+      const { headers, token } = parseGlobalArgs(args);
+      const output = args.write!;
+      const comments = args.comments || false;
+      const apolloFederation = args.federation || false;
+      const aws = args.aws || false;
+      const method = args.method?.toUpperCase() || 'POST';
+
+      const schema = await loaders.loadSchema(
+        args.schema,
+        {
+          token,
+          headers,
+          method,
+        },
+        apolloFederation,
+        aws,
+      );
+
+      return handler({ schema, output, comments });
+    },
+  };
+});