First commit

.gitignore

@@ -0,0 +1,3 @@
+dist/
+output/*.ts
+node_modules/

jest.tsc.config.js

@@ -0,0 +1,6 @@
+module.exports = {
+ runner: "jest-runner-tsc",
+ displayName: "tsc",
+ moduleFileExtensions: ["js", "ts", "tsx"],
+ testMatch: ["<rootDir>/test/*.ts", "<rootDir>/output/*.ts"]
+};

package.json

@@ -0,0 +1,27 @@
+{
+ "name": "graphql-codegen-fast-check",
+ "version": "1.0.0",
+ "main": "index.js",
+ "license": "MIT",
+ "dependencies": {
+ "@types/prettier": "^1.19.1",
+ "fast-check": "^1.23.0",
+ "jest-runner-tsc": "^1.6.0",
+ "prettier": "^2.0.2",
+ "tsutils": "^3.17.1",
+ "typescript": "^3.8.3"
+ },
+ "scripts": {
+ "build": "tsc",
+ "codegen": "graphql-codegen",
+ "typescript:watch": "tsc --noEmit --watch",
+ "test": "./test.sh"
+ },
+ "devDependencies": {
+ "@types/graphql": "^14.5.0",
+ "@types/jest": "^25.1.4",
+ "@types/node": "^13.9.8",
+ "graphql": "^14.6.0",
+ "jest": "^25.2.4"
+ }
+}

src/index.ts

@@ -0,0 +1,166 @@
+import {
+ GraphQLSchema,
+ NamedTypeNode,
+ TypeDefinitionNode,
+ GraphQLNamedType,
+ FieldDefinitionNode,
+ TypeNode
+} from "graphql";
+import { format } from "prettier";
+import * as fc from "fast-check";
+
+type Maybe<T> = null | undefined | T;
+
+type Nominal<A> = {
+ readonly symbol: A;
+};
+
+type Newtype<Tag extends string, A> = Nominal<Tag> & A;
+
+type TypeName = Newtype<"Typename", string>;
+
+const nodeName = (node: TypeDefinitionNode): TypeName =>
+ node ? (node.name.value as TypeName) : ("no node" as TypeName);
+
+const withNamedFieldType = (namedTypeNode: NamedTypeNode): string => {
+ return getArbitraryName(namedTypeNode.name.value as TypeName);
+};
+
+const withFieldType = (typeNode: TypeNode): string => {
+ if (typeNode.kind === "NamedType") {
+ return withNamedFieldType(typeNode);
+ } else if (typeNode.kind === "ListType") {
+ const internalType = withFieldType(typeNode.type);
+ return `fc.array(${internalType})`;
+ } else {
+ // therefore typeNode.kind === 'NonNullType'
+ // probably need to make a custom Arbitrary for filtering out null values (and add them to all the primitive values by default, ffs)
+ return withFieldType(typeNode.type);
+ }
+};
+
+const withField = (field: FieldDefinitionNode): string => {
+ const fieldName = field.name.value;
+ const fieldType = withFieldType(field.type);
+ return `${fieldName}: ${fieldType}`;
+};
+
+const withAstNode = (node: TypeDefinitionNode): [Kind, string] => {
+ switch (node.kind) {
+ case "ScalarTypeDefinition":
+ return ["Scalar", `fc.anything()`];
+ case "EnumTypeDefinition":
+ throw "Haven't implemented Enums yet";
+ case "InputObjectTypeDefinition":
+ throw "Haven't implemented InputObject yet";
+ case "InterfaceTypeDefinition":
+ throw "Haven't implemented Interface yet";
+ case "ObjectTypeDefinition":
+ const fields = (node.fields || []).map(withField);
+ return ["Object", `fc.record({${fields.join(",")}})`];
+ case "UnionTypeDefinition":
+ throw "Haven't implemented Union yet";
+ }
+};
+
+const withPrimitive = (node: GraphQLNamedType): string | null => {
+ switch (node.name) {
+ case "Int":
+ return `fc.integer()`;
+ case "Boolean":
+ return `fc.boolean()`;
+ case "String":
+ return "fc.string()";
+ case "ID":
+ return `fc.string()`;
+ }
+ // console.log(`Primitive ${node.name} not found`);
+
+ return null;
+};
+
+const getArbitraryName = (typeName: TypeName): string => `arbitrary${typeName}`;
+
+type Kind = "Object" | "Scalar" | "Primitive";
+type NamedType = [Kind, TypeName, string];
+
+const getNamedTypes = (schema: GraphQLSchema): GraphQLNamedType[] => {
+ const typesMap = schema.getTypeMap();
+ const namedTypes: Maybe<GraphQLNamedType>[] = Object.keys(typesMap).map(
+ key => {
+ const item = schema.getType(key);
+ return item || null;
+ }
+ );
+ return namedTypes.filter(
+ (a: Maybe<GraphQLNamedType>) => a !== null && a !== undefined
+ ) as GraphQLNamedType[];
+};
+
+const withNamedType = (item: GraphQLNamedType): NamedType | null => {
+ if (item.astNode) {
+ const [nodeKind, str] = withAstNode(item.astNode);
+ return [nodeKind, nodeName(item.astNode), str];
+ } else {
+ const prim = withPrimitive(item);
+ if (prim) {
+ return ["Primitive", item.name as TypeName, prim];
+ } else {
+ return null;
+ }
+ }
+};
+
+const notNull = <A>(a: A | null): a is A => a !== null;
+
+const byKind = (k: Kind) => (a: NamedType) => a[0] === k;
+
+const render = (val: NamedType) => {
+ const [_, variable, definition] = val;
+ return `export const ${getArbitraryName(variable)} = ${definition}`;
+};
+
+const getSchemaDeclarations = (schema: GraphQLSchema): string => {
+ const namedTypes = getNamedTypes(schema);
+ const primitives = namedTypes
+ .map(withNamedType)
+ .filter(notNull)
+ .filter(byKind("Primitive"))
+ .map(render)
+ .join("\n");
+
+ const scalars = namedTypes
+ .map(withNamedType)
+ .filter(notNull)
+ .filter(byKind("Scalar"))
+ .map(render)
+ .join("\n");
+
+ const objects = sortASTs(
+ namedTypes.map(withNamedType).filter(notNull).filter(byKind("Object"))
+ )
+ .map(render)
+ .join("\n");
+
+ return `${primitives}\n${scalars}\n${objects}`;
+};
+
+// if one object mentions another definition, put it after that definition
+const sortASTs = (as: NamedType[]): NamedType[] =>
+ [...as].sort(([_a, key, val], [_b, newKey, newVal]) => {
+ if (val.includes(newKey)) {
+ return 1;
+ } else if (newVal.includes(key)) {
+ return -1;
+ }
+ return 1;
+ });
+
+module.exports = {
+ plugin: (schema: GraphQLSchema, documents: any, config: any) => {
+ const declarations = getSchemaDeclarations(schema);
+ return format(`import * as fc from 'fast-check'\n${declarations}`, {
+ parser: "typescript"
+ });
+ }
+};

test.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+# lets set up a test environment
+
+yarn build
+
+graphql-codegen --config ./test/codegen.yml
+
+yarn jest -c jest.tsc.config.js

test/codegen.yml

@@ -0,0 +1,5 @@
+schema: ./test/twitter-schema.graphql
+# documents: './src/**/*.graphql'
+generates:
+ ./dist/index.js:
+ - ./output/output.ts:

test/index.ts

@@ -0,0 +1,7 @@
+import { arbitraryQuery } from "../output/output";
+
+describe("Test fast-check generation", () => {
+ it("Runs the tests at all", () => {
+ expect(true).toBeTruthy();
+ });
+});

test/twitter-schema.graphql

@@ -0,0 +1,58 @@
+type Tweet {
+ id: ID!
+ # The tweet text. No more than 140 characters!
+ body: String
+ # When the tweet was published
+ date: Date
+ # Who published the tweet
+ Author: User
+ # Views, retweets, likes, etc
+ Stats: Stat
+}
+
+type User {
+ id: ID!
+ username: String
+ first_name: String
+ last_name: String
+ full_name: String
+ name: String @deprecated
+ avatar_url: Url
+}
+
+type Stat {
+ views: Int
+ likes: Int
+ retweets: Int
+ responses: Int
+}
+
+type Notification {
+ id: ID
+ date: Date
+ type: String
+}
+
+type Meta {
+ count: Int
+}
+
+scalar Url
+scalar Date
+
+type Query {
+ Tweet(id: ID!): Tweet
+ Tweets(limit: Int, skip: Int, sort_field: String, sort_order: String): [Tweet]
+ TweetsMeta: Meta
+ User(id: ID!): User
+ Notifications(limit: Int): [Notification]
+ NotificationsMeta: Meta
+}
+
+type Mutation {
+ createTweet (
+ body: String
+ ): Tweet
+ deleteTweet(id: ID!): Tweet
+ markTweetRead(id: ID!): Boolean
+}

tsconfig.json

@@ -0,0 +1,69 @@
+{
+ "compilerOptions": {
+ /* Basic Options */
+ // "incremental": true, /* Enable incremental compilation */
+ "target": "es5", /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019', 'ES2020', or 'ESNEXT'. */
+ "module": "commonjs", /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', 'es2020', or 'ESNext'. */
+ // "lib": [], /* Specify library files to be included in the compilation. */
+ // "allowJs": true, /* Allow javascript files to be compiled. */
+ // "checkJs": true, /* Report errors in .js files. */
+ // "jsx": "preserve", /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+ // "declaration": true, /* Generates corresponding '.d.ts' file. */
+ // "declarationMap": true, /* Generates a sourcemap for each corresponding '.d.ts' file. */
+ // "sourceMap": true, /* Generates corresponding '.map' file. */
+ // "outFile": "./", /* Concatenate and emit output to single file. */
+ "outDir": "./dist/", /* Redirect output structure to the directory. */
+ // "rootDir": "./", /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+ // "composite": true, /* Enable project compilation */
+ // "tsBuildInfoFile": "./", /* Specify file to store incremental compilation information */
+ // "removeComments": true, /* Do not emit comments to output. */
+ // "noEmit": true, /* Do not emit outputs. */
+ // "importHelpers": true, /* Import emit helpers from 'tslib'. */
+ // "downlevelIteration": true, /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+ // "isolatedModules": true, /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+ /* Strict Type-Checking Options */
+ "strict": true, /* Enable all strict type-checking options. */
+ // "noImplicitAny": true, /* Raise error on expressions and declarations with an implied 'any' type. */
+ // "strictNullChecks": true, /* Enable strict null checks. */
+ // "strictFunctionTypes": true, /* Enable strict checking of function types. */
+ // "strictBindCallApply": true, /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+ // "strictPropertyInitialization": true, /* Enable strict checking of property initialization in classes. */
+ // "noImplicitThis": true, /* Raise error on 'this' expressions with an implied 'any' type. */
+ // "alwaysStrict": true, /* Parse in strict mode and emit "use strict" for each source file. */
+
+ /* Additional Checks */
+ // "noUnusedLocals": true, /* Report errors on unused locals. */
+ // "noUnusedParameters": true, /* Report errors on unused parameters. */
+ // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
+ // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
+
+ /* Module Resolution Options */
+ // "moduleResolution": "node", /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+ // "baseUrl": "./", /* Base directory to resolve non-absolute module names. */
+ // "paths": {}, /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+ // "rootDirs": [], /* List of root folders whose combined content represents the structure of the project at runtime. */
+ // "typeRoots": [], /* List of folders to include type definitions from. */
+ // "types": [], /* Type declaration files to be included in compilation. */
+ // "allowSyntheticDefaultImports": true, /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+ "esModuleInterop": true, /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
+ // "preserveSymlinks": true, /* Do not resolve the real path of symlinks. */
+ // "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
+
+ /* Source Map Options */
+ // "sourceRoot": "", /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+ // "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
+ // "inlineSourceMap": true, /* Emit a single file with source maps instead of having a separate file. */
+ // "inlineSources": true, /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+ /* Experimental Options */
+ // "experimentalDecorators": true, /* Enables experimental support for ES7 decorators. */
+ // "emitDecoratorMetadata": true, /* Enables experimental support for emitting type metadata for decorators. */
+
+ /* Advanced Options */
+ "forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
+ },
+ "include": [
+ "./src"
+ ]
+}