@khanacademy/graphql-flow 0.2.5 → 0.3.0

package/src/generateTypeFiles.js

@@ -21,6 +21,7 @@ export type ExternalOptions = {
     generatedDirectory?: string,
     exportAllObjectTypes?: boolean,
     typeFileName?: string,
+    experimentalEnums?: boolean,
 };
 
 export const indexPrelude = (regenerateCommand?: string): string => `// @flow
@@ -62,40 +63,54 @@ export const generateTypeFileContents = (
     };
 
     const generated = documentToFlowTypes(document, schema, options);
-    generated.forEach(({name, typeName, code, isFragment, extraTypes}) => {
-        // We write all generated files to a `__generated__` subdir to keep
-        // things tidy.
-        const targetFileName = options.typeFileName
-            ? options.typeFileName.replace('[operationName]', name)
-            : `${name}.js`;
-        const targetPath = path.join(generatedDir, targetFileName);
-
-        let fileContents =
-            '// @' +
-            `flow\n// AUTOGENERATED -- DO NOT EDIT\n` +
-            `// Generated for operation '${name}' in file '../${path.basename(
-                fileName,
-            )}'\n` +
-            (options.regenerateCommand
-                ? `// To regenerate, run '${options.regenerateCommand}'.\n`
-                : '') +
-            code;
-        if (options.splitTypes && !isFragment) {
-            fileContents +=
-                `\nexport type ${name} = ${typeName}['response'];\n` +
-                `export type ${name}Variables = ${typeName}['variables'];\n`;
-        }
-        Object.keys(extraTypes).forEach((name) => {
-            fileContents += `\n\nexport type ${name} = ${extraTypes[name]};`;
-        });
-
-        addToIndex(targetPath, typeName);
-        files[targetPath] =
-            fileContents
-                // Remove whitespace from the ends of lines; babel's generate sometimes
-                // leaves them hanging around.
-                .replace(/\s+$/gm, '') + '\n';
-    });
+    generated.forEach(
+        ({name, typeName, code, isFragment, extraTypes, experimentalEnums}) => {
+            // We write all generated files to a `__generated__` subdir to keep
+            // things tidy.
+            const targetFileName = options.typeFileName
+                ? options.typeFileName.replace('[operationName]', name)
+                : `${name}.js`;
+            const targetPath = path.join(generatedDir, targetFileName);
+
+            let fileContents =
+                '// @' +
+                `flow\n// AUTOGENERATED -- DO NOT EDIT\n` +
+                `// Generated for operation '${name}' in file '../${path.basename(
+                    fileName,
+                )}'\n` +
+                (options.regenerateCommand
+                    ? `// To regenerate, run '${options.regenerateCommand}'.\n`
+                    : '') +
+                code;
+            if (options.splitTypes && !isFragment) {
+                fileContents +=
+                    `\nexport type ${name} = ${typeName}['response'];\n` +
+                    `export type ${name}Variables = ${typeName}['variables'];\n`;
+            }
+            Object.keys(extraTypes).forEach(
+                (name) =>
+                    (fileContents += `\n\nexport type ${name} = ${extraTypes[name]};`),
+            );
+            const enumNames = Object.keys(experimentalEnums);
+            if (options.experimentalEnums && enumNames.length) {
+                // TODO(somewhatabstract, FEI-4172): Update to fixed eslint-plugin-flowtype
+                // and remove this disable.
+                fileContents += `\n\n/* eslint-disable no-undef */`;
+                enumNames.forEach(
+                    (name) =>
+                        (fileContents += `\nexport ${experimentalEnums[name]};\n`),
+                );
+                fileContents += `/* eslint-enable no-undef */`;
+            }
+
+            addToIndex(targetPath, typeName);
+            files[targetPath] =
+                fileContents
+                    // Remove whitespace from the ends of lines; babel's generate sometimes
+                    // leaves them hanging around.
+                    .replace(/\s+$/gm, '') + '\n';
+        },
+    );
 
     return {files, indexContents};
 };
@@ -178,6 +193,7 @@ export const processPragmas = (
             generatedDirectory: options.generatedDirectory,
             exportAllObjectTypes: options.exportAllObjectTypes,
             typeFileName: options.typeFileName,
+            experimentalEnums: options.experimentalEnums,
         };
     } else {
         return null;

package/src/index.js

@@ -15,6 +15,7 @@ import {
     generateResponseType,
 } from './generateResponseType';
 import {generateVariablesType} from './generateVariablesType';
+import type {BabelNode} from '@babel/types';
 export {spyOnGraphqlTagToCollectQueries} from './jest-mock-graphql-tag';
 
 import type {Config, Options, Schema} from './types';
@@ -42,6 +43,7 @@ const optionsToConfig = (
         errors,
         allObjectTypes: null,
         path: [],
+        experimentalEnumsMap: options?.experimentalEnums ? {} : undefined,
         ...internalOptions,
     };
 
@@ -66,6 +68,7 @@ export const documentToFlowTypes = (
     code: string,
     isFragment?: boolean,
     extraTypes: {[key: string]: string},
+    experimentalEnums: {[key: string]: string},
 }> => {
     const errors: Array<string> = [];
     const config = optionsToConfig(
@@ -90,17 +93,19 @@ export const documentToFlowTypes = (
                             : null,
                     },
                 )};`;
-                const extraTypes: {[key: string]: string} = {};
-                Object.keys(types).forEach((k) => {
-                    // eslint-disable-next-line flowtype-errors/uncovered
-                    extraTypes[k] = generate(types[k]).code;
-                });
+
+                const extraTypes = codegenExtraTypes(types);
+                const experimentalEnums = codegenExtraTypes(
+                    config.experimentalEnumsMap || {},
+                );
+
                 return {
                     name,
                     typeName: name,
                     code,
                     isFragment: true,
                     extraTypes,
+                    experimentalEnums,
                 };
             }
             if (
@@ -127,12 +132,12 @@ export const documentToFlowTypes = (
                 // We'll see what's required to get webapp on board.
                 const code = `export type ${typeName} = {|\n    variables: ${variables},\n    response: ${response}\n|};`;
 
-                const extraTypes: {[key: string]: string} = {};
-                Object.keys(types).forEach((k) => {
-                    // eslint-disable-next-line flowtype-errors/uncovered
-                    extraTypes[k] = generate(types[k]).code;
-                });
-                return {name, typeName, code, extraTypes};
+                const extraTypes = codegenExtraTypes(types);
+                const experimentalEnums = codegenExtraTypes(
+                    config.experimentalEnumsMap || {},
+                );
+
+                return {name, typeName, code, extraTypes, experimentalEnums};
             }
         })
         .filter(Boolean);
@@ -141,3 +146,14 @@ export const documentToFlowTypes = (
     }
     return result;
 };
+
+function codegenExtraTypes(types: {[key: string]: BabelNode}): {
+    [key: string]: string,
+} {
+    const extraTypes: {[key: string]: string} = {};
+    Object.keys(types).forEach((k: string) => {
+        // eslint-disable-next-line flowtype-errors/uncovered
+        extraTypes[k] = generate(types[k]).code;
+    });
+    return extraTypes;
+}

package/src/types.js

@@ -23,6 +23,7 @@ export type Options = {|
     generatedDirectory?: string,
     exportAllObjectTypes?: boolean,
     typeFileName?: string,
+    experimentalEnums?: boolean, // default false
 |};
 
 export type Schema = {
@@ -58,5 +59,7 @@ export type Config = {
     scalars: Scalars,
     errors: Array<string>,
     allObjectTypes: null | {[key: string]: BabelNode},
+
+    experimentalEnumsMap?: {[key: string]: BabelNode}, // index signature that is populated with declarations
 };
 export type Scalars = {[key: string]: 'string' | 'number' | 'boolean'};

package/.github/actions/filter-files/action.yml

@@ -1,37 +0,0 @@
-name: 'Filter files'
-description: 'Filter the list of changed files'
-inputs:
-  changed-files:
-    description: 'jsonified list of changed files from setup'
-    required: true
-  files:
-    description: 'comma-separated list of files to check for'
-    required: false
-  extensions:
-    description: 'comma-separated list of extensions to check for'
-    required: false
-outputs:
-  filtered:
-    description: 'The jsonified list of files that match'
-    value: ${{ steps.result.outputs.result }}
-runs:
-  using: "composite"
-  steps:
-    - uses: actions/github-script@v6
-      id: result
-      with:
-        script: |
-          const extensionsRaw = "${{ inputs.extensions }}";
-          const exactFilesRaw = "${{ inputs.files }}";
-          const inputFiles = JSON.parse(`${{ inputs.changed-files }}`);
-          const extensions = extensionsRaw.trim() ? extensionsRaw.split(',') : [];
-          const exactFiles = exactFilesRaw.trim() ? exactFilesRaw.split(',') : [];
-
-          const result = inputFiles.filter(name => {
-            return extensions.some(ext => name.endsWith(ext)) || (
-              exactFiles.includes(name)
-            )
-          })
-          console.log(`Filtered Files: ${JSON.stringify(result)}`)
-          return result;
-        result-encoding: json

package/.github/actions/full-or-limited/action.yml

@@ -1,27 +0,0 @@
-name: Full or Limited
-description:  Do a full run if certain files have changed, or a limited run of some others have changed
-inputs:
-  full-trigger:
-    description: A jsonified Array of string files that would trigger a full run
-    required: true
-  limited-trigger:
-    description: A jsonified Array of string files that should be passed to a limited run
-    required: true
-  full:
-    description: The command to run if a full run is triggered
-  limited:
-    description: The command to run, with {} replaced with the list of files to run on.
-runs:
-  using: "composite"
-  steps:
-    - name: Full run
-      if: inputs.full-trigger != '[]'
-      run: ${{ inputs.full }}
-      shell: bash
-
-    - name: Limited run
-      if: inputs.full-trigger == '[]' && inputs.limited-trigger != '[]'
-      uses: ./.github/actions/json-args
-      with:
-        list: ${{ inputs.limited-trigger }}
-        run: ${{ inputs.limited }}

package/.github/actions/json-args/action.yml

@@ -1,32 +0,0 @@
-name: 'Pass a jsonified-list of files as shell arguments'
-description: 'Because file names with spaces are the worst'
-inputs:
-  list:
-    description: A jsonified Array of string file names
-    required: true
-  run:
-    description: "a command to run, where the literal '{}' will be replaced with the files as individual arguments. If no '{}' is provided, the files will be appended."
-    required: true
-runs:
-  using: "composite"
-  steps:
-    - uses: actions/github-script@v6
-      with:
-        script: |
-          const listRaw = `${{ inputs.list }}`;
-          const files = JSON.parse(listRaw);
-          const {execSync} = require('child_process');
-          if (files.some(name => name.match(/['"]/))) {
-            throw new Error(`Not going to mess with file names that have quotes in them.`)
-          }
-          const filesList = files.map(name => `"${name}"`).join(' ')
-          let cmd = `${{ inputs.run }}`;
-          if (cmd.includes('{}')) {
-            cmd = cmd.replace('{}', filesList)
-          } else {
-            cmd += ' ' + filesList;
-          }
-          console.log(`Running: ${cmd}`);
-          execSync(cmd, {
-            stdio: 'inherit',
-          })

package/.github/actions/setup/action.yml

@@ -1,28 +0,0 @@
-name: 'Setup'
-description: 'Perform various shared setup tasks'
-inputs:
-  node-version:
-    description: 'Node version to use'
-    required: false
-    default: '16.x'
-outputs:
-  changed_files:
-    description: "List of files changed in this PR, in JSON format"
-    value: ${{ steps.changed.outputs.added_modified }}
-runs:
-  using: "composite"
-  steps:
-    - name: Use Node.js ${{ inputs.node-version }}
-      uses: actions/setup-node@v3
-      id: node
-      with:
-        node-version: ${{ inputs.node-version }}
-        cache: yarn
-    - name: Install dependencies
-      run: yarn install --frozen-lockfile
-      shell: bash
-    - name: Get All Changed Files
-      uses: jaredly/get-changed-files@absolute
-      id: changed
-      with:
-        format: json