@khanacademy/graphql-flow 3.4.2 → 4.0.1

package/.github/workflows/changeset-release.yml

@@ -36,7 +36,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - uses: Khan/actions@shared-node-cache-v2
+      - uses: Khan/actions@shared-node-cache-v3
         with:
           node-version: 20.x
 

package/.github/workflows/pr-checks.yml

@@ -17,7 +17,7 @@ jobs:
         node-version: [20.x]
     steps:
     - uses: actions/checkout@v4
-    - uses: Khan/actions@shared-node-cache-v2
+    - uses: Khan/actions@shared-node-cache-v3
       with:
         node-version: ${{ matrix.node-version }}
 
@@ -34,7 +34,7 @@ jobs:
 
     - name: Run TypeScript
       if: steps.ts-files.outputs.filtered != '[]'
-      run: yarn typecheck
+      run: pnpm typecheck
 
     - id: eslint-reset
       uses: Khan/actions@filter-files-v1
@@ -47,9 +47,9 @@ jobs:
       uses: Khan/actions@full-or-limited-v0
       with:
         full-trigger: ${{ steps.eslint-reset.outputs.filtered }}
-        full: yarn eslint src/**/*.ts
+        full: pnpm eslint src/**/*.ts
         limited-trigger: ${{ steps.ts-files.outputs.filtered }}
-        limited: yarn eslint {}
+        limited: pnpm eslint {}
 
     - id: jest-reset
       uses: Khan/actions@filter-files-v1
@@ -62,6 +62,6 @@ jobs:
       uses: Khan/actions@full-or-limited-v0
       with:
         full-trigger: ${{ steps.jest-reset.outputs.filtered }}
-        full: yarn jest
+        full: pnpm jest
         limited-trigger: ${{ steps.ts-files.outputs.filtered }}
-        limited: yarn jest --findRelatedTests {}
+        limited: pnpm jest --findRelatedTests {}

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @khanacademy/graphql-flow
 
+## 4.0.1
+
+### Patch Changes
+
+-   7fd8814: Improve unresolved import errors
+
+## 4.0.0
+
+### Major Changes
+
+-   9d96c11: Overhaul import resolution, relying on tsconfig for import aliases, and rspack-resolver for package imports. This removes the `alias` config option, instead requiring that aliases be defined in a `tsconfig.json`.
+
+### Minor Changes
+
+-   a27caca: Support "export \* from" for fragments
+
 ## 3.4.2
 
 ### Patch Changes

package/dist/cli/run.js

@@ -40,7 +40,7 @@ const inputFiles = (0, _config.getInputFiles)(options, config);
 /** Step (2) */
 
 const files = (0, _parse.processFiles)(inputFiles, config, f => {
-  const resolvedPath = (0, _utils.getPathWithExtension)(f, config);
+  const resolvedPath = (0, _utils.getPathWithExtension)(f);
   if (!resolvedPath) {
     throw new Error(`Unable to find ${f}`);
   }

package/dist/parser/parse.js

@@ -8,6 +8,7 @@ var _wonderStuffCore = require("@khanacademy/wonder-stuff-core");
 var _parser = require("@babel/parser");
 var _traverse = _interopRequireDefault(require("@babel/traverse"));
 var _path = _interopRequireDefault(require("path"));
+var _resolveImport = require("./resolveImport");
 var _utils = require("./utils");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 /**
@@ -47,12 +48,12 @@ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e
  * potentially relevant, and of course any values referenced
  * from a graphql template are treated as relevant.
  */
-const listExternalReferences = (file, config) => {
+const listExternalReferences = file => {
   const paths = {};
   const add = (v, followImports) => {
     if (v.type === "import") {
       if (followImports) {
-        const absPath = (0, _utils.getPathWithExtension)(v.path, config);
+        const absPath = (0, _utils.getPathWithExtension)(v.path);
         if (absPath) {
           paths[absPath] = true;
         }
@@ -71,16 +72,18 @@ const listExternalReferences = (file, config) => {
   file.operations.forEach(op => op.source.expressions.forEach(expr => add(expr,
   // Imports that are used in graphql expressions definitely need to be followed.
   true)));
+  file.exportAlls.forEach(expr => add(expr, true));
   return Object.keys(paths);
 };
 const processFile = (filePath, contents, config) => {
-  const dir = _path.default.dirname(filePath);
   const result = {
     path: filePath,
     operations: [],
     exports: {},
+    exportAlls: [],
     locals: {},
-    errors: []
+    errors: [],
+    unresolvedImports: {}
   };
   const text = typeof contents === "string" ? contents : contents.text;
   const plugins = filePath.endsWith("x") ? ["typescript", "jsx"] : ["typescript"];
@@ -94,14 +97,33 @@ const processFile = (filePath, contents, config) => {
   ast.program.body.forEach(toplevel => {
     var _toplevel$declaration;
     if (toplevel.type === "ImportDeclaration") {
-      const newLocals = getLocals(dir, toplevel, filePath, config);
+      const isUnresolvedModule = !toplevel.source.value.startsWith(".") && !_path.default.isAbsolute(toplevel.source.value) && toplevel.source.value !== "graphql-tag";
+      if (isUnresolvedModule) {
+        toplevel.specifiers.forEach(spec => {
+          if (spec.type === "ImportSpecifier" || spec.type === "ImportDefaultSpecifier") {
+            var _spec$start, _spec$end, _spec$loc$start$line, _spec$loc;
+            result.unresolvedImports[spec.local.name] = {
+              source: toplevel.source.value,
+              loc: {
+                start: (_spec$start = spec.start) !== null && _spec$start !== void 0 ? _spec$start : -1,
+                end: (_spec$end = spec.end) !== null && _spec$end !== void 0 ? _spec$end : -1,
+                line: (_spec$loc$start$line = (_spec$loc = spec.loc) === null || _spec$loc === void 0 ? void 0 : _spec$loc.start.line) !== null && _spec$loc$start$line !== void 0 ? _spec$loc$start$line : -1,
+                path: filePath
+              }
+            };
+          }
+        });
+      }
+      const newLocals = getLocals(toplevel, filePath);
       if (newLocals) {
         Object.keys(newLocals).forEach(k => {
+          var _local$resolvedPath$i, _local$resolvedPath;
           const local = newLocals[k];
-          if (local.path.startsWith("/")) {
+          const isGraphqlTagImport = local.rawPath === "graphql-tag" || ((_local$resolvedPath$i = (_local$resolvedPath = local.resolvedPath) === null || _local$resolvedPath === void 0 ? void 0 : _local$resolvedPath.includes(`${_path.default.sep}node_modules${_path.default.sep}graphql-tag`)) !== null && _local$resolvedPath$i !== void 0 ? _local$resolvedPath$i : false);
+          if (_path.default.isAbsolute(local.path)) {
             result.locals[k] = local;
           }
-          if (local.path === "graphql-tag" && local.name === "default") {
+          if (isGraphqlTagImport && local.name === "default") {
             gqlTagNames.push(k);
           }
         });
@@ -111,18 +133,19 @@ const processFile = (filePath, contents, config) => {
       if (toplevel.source) {
         var _toplevel$specifiers;
         const source = toplevel.source;
-        const importPath = source.value.startsWith(".") ? _path.default.resolve(_path.default.join(dir, source.value)) : source.value;
+        const resolvedPath = (0, _resolveImport.resolveImportPath)(filePath, source.value);
+        const importPath = resolvedPath !== null && resolvedPath !== void 0 ? resolvedPath : source.value;
         (_toplevel$specifiers = toplevel.specifiers) === null || _toplevel$specifiers === void 0 || _toplevel$specifiers.forEach(spec => {
           if (spec.type === "ExportSpecifier" && spec.exported.type === "Identifier") {
-            var _spec$start, _spec$end, _spec$loc$start$line, _spec$loc;
+            var _spec$start2, _spec$end2, _spec$loc$start$line2, _spec$loc2;
             result.exports[spec.exported.name] = {
               type: "import",
               name: spec.local.name,
               path: importPath,
               loc: {
-                start: (_spec$start = spec.start) !== null && _spec$start !== void 0 ? _spec$start : -1,
-                end: (_spec$end = spec.end) !== null && _spec$end !== void 0 ? _spec$end : -1,
-                line: (_spec$loc$start$line = (_spec$loc = spec.loc) === null || _spec$loc === void 0 ? void 0 : _spec$loc.start.line) !== null && _spec$loc$start$line !== void 0 ? _spec$loc$start$line : -1,
+                start: (_spec$start2 = spec.start) !== null && _spec$start2 !== void 0 ? _spec$start2 : -1,
+                end: (_spec$end2 = spec.end) !== null && _spec$end2 !== void 0 ? _spec$end2 : -1,
+                line: (_spec$loc$start$line2 = (_spec$loc2 = spec.loc) === null || _spec$loc2 === void 0 ? void 0 : _spec$loc2.start.line) !== null && _spec$loc$start$line2 !== void 0 ? _spec$loc$start$line2 : -1,
                 path: filePath
               }
             };
@@ -140,6 +163,22 @@ const processFile = (filePath, contents, config) => {
         });
       }
     }
+    if (toplevel.type === "ExportAllDeclaration" && toplevel.source) {
+      var _toplevel$start, _toplevel$end, _toplevel$loc$start$l, _toplevel$loc;
+      const source = toplevel.source;
+      const importPath = source.value.startsWith(".") ? _path.default.resolve(_path.default.join(_path.default.dirname(filePath), source.value)) : source.value;
+      result.exportAlls.push({
+        type: "import",
+        name: "*",
+        path: importPath,
+        loc: {
+          start: (_toplevel$start = toplevel.start) !== null && _toplevel$start !== void 0 ? _toplevel$start : -1,
+          end: (_toplevel$end = toplevel.end) !== null && _toplevel$end !== void 0 ? _toplevel$end : -1,
+          line: (_toplevel$loc$start$l = (_toplevel$loc = toplevel.loc) === null || _toplevel$loc === void 0 ? void 0 : _toplevel$loc.start.line) !== null && _toplevel$loc$start$l !== void 0 ? _toplevel$loc$start$l : -1,
+          path: filePath
+        }
+      });
+    }
     const processDeclarator = (decl, isExported) => {
       if (decl.id.type !== "Identifier" || !decl.init) {
         return;
@@ -210,7 +249,8 @@ const processFile = (filePath, contents, config) => {
   };
   (0, _traverse.default)(ast, {
     TaggedTemplateExpression(path) {
-      visitTpl(path.node, name => {
+      const node = path.node;
+      visitTpl(node, name => {
         const binding = path.scope.getBinding(name);
         if (!binding) {
           return null;
@@ -246,14 +286,23 @@ const processTemplate = (tpl, result, getTemplate) => {
       return null;
     }
     if (!result.locals[expr.name]) {
+      var _result$unresolvedImp;
       if (getTemplate) {
         const found = getTemplate(expr.name);
         return found;
       }
-      result.errors.push({
-        loc,
-        message: `Unable to resolve ${expr.name}`
-      });
+      const unresolved = (_result$unresolvedImp = result.unresolvedImports) === null || _result$unresolvedImp === void 0 ? void 0 : _result$unresolvedImp[expr.name];
+      if (unresolved) {
+        result.errors.push({
+          loc: unresolved.loc,
+          message: `Unable to resolve import ${expr.name} from "${unresolved.source}" at ${unresolved.loc.path}:${unresolved.loc.line}.`
+        });
+      } else {
+        result.errors.push({
+          loc,
+          message: `Unable to resolve ${expr.name}`
+        });
+      }
       return null;
     }
     return result.locals[expr.name];
@@ -273,12 +322,12 @@ const processTemplate = (tpl, result, getTemplate) => {
     }
   };
 };
-const getLocals = (dir, toplevel, myPath, config) => {
+const getLocals = (toplevel, myPath) => {
   if (toplevel.importKind === "type") {
     return null;
   }
-  const fixedPath = (0, _utils.fixPathResolution)(toplevel.source.value, config);
-  const importPath = fixedPath.startsWith(".") ? _path.default.resolve(_path.default.join(dir, fixedPath)) : fixedPath;
+  const resolvedPath = (0, _resolveImport.resolveImportPath)(myPath, toplevel.source.value);
+  const importPath = resolvedPath !== null && resolvedPath !== void 0 ? resolvedPath : toplevel.source.value;
   const locals = {};
   toplevel.specifiers.forEach(spec => {
     if (spec.type === "ImportDefaultSpecifier") {
@@ -286,6 +335,8 @@ const getLocals = (dir, toplevel, myPath, config) => {
         type: "import",
         name: "default",
         path: importPath,
+        rawPath: toplevel.source.value,
+        resolvedPath,
         loc: {
           start: spec.start,
           end: spec.end,
@@ -297,6 +348,8 @@ const getLocals = (dir, toplevel, myPath, config) => {
         type: "import",
         name: spec.imported.type === "Identifier" ? spec.imported.name : spec.imported.value,
         path: importPath,
+        rawPath: toplevel.source.value,
+        resolvedPath,
         loc: {
           start: spec.start,
           end: spec.end,
@@ -321,7 +374,7 @@ const processFiles = (filePaths, config, getFileSource) => {
     }
     const result = processFile(next, source, config);
     files[next] = result;
-    listExternalReferences(result, config).forEach(path => {
+    listExternalReferences(result).forEach(path => {
       if (!files[path] && !toProcess.includes(path)) {
         toProcess.push(path);
       }

package/dist/parser/resolve.js

@@ -29,7 +29,7 @@ const resolveDocuments = (files, config) => {
 };
 exports.resolveDocuments = resolveDocuments;
 const resolveImport = (expr, files, errors, seen, config) => {
-  const absPath = (0, _utils.getPathWithExtension)(expr.path, config);
+  const absPath = (0, _utils.getPathWithExtension)(expr.path);
   if (!absPath) {
     return null;
   }
@@ -50,6 +50,19 @@ const resolveImport = (expr, files, errors, seen, config) => {
     return null;
   }
   if (!res.exports[expr.name]) {
+    if (expr.name !== "*" && res.exportAlls.length) {
+      for (const exportAll of res.exportAlls) {
+        const value = resolveImport({
+          ...exportAll,
+          name: expr.name
+        }, files, errors, {
+          ...seen
+        }, config);
+        if (value) {
+          return value;
+        }
+      }
+    }
     errors.push({
       loc: expr.loc,
       message: `${absPath} has no valid gql export ${expr.name}`

package/dist/parser/resolveImport.js

@@ -0,0 +1,58 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.resetImportCache = resetImportCache;
+exports.resolveImportPath = resolveImportPath;
+var _nodePath = _interopRequireDefault(require("node:path"));
+var _rspackResolver = require("rspack-resolver");
+var _tsconfigPaths = require("tsconfig-paths");
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+// Copied from https://github.com/Khan/frontend/blob/main/libs/node/resolve-import/src/resolve-import.ts
+// In future it would be cool to publish @khan/node-resolve-import as a public library so we
+// could consume it here.
+
+const CONDITION_NAMES = ["import"];
+const matchPathCache = new Map();
+let esmResolver = getEsmResolver();
+function getEsmResolver() {
+  return new _rspackResolver.ResolverFactory({
+    conditionNames: CONDITION_NAMES,
+    mainFields: ["module", "main"],
+    extensions: [".mjs", ".js", ".jsx", ".ts", ".tsx"]
+  });
+}
+function resetImportCache() {
+  matchPathCache.clear();
+  esmResolver = getEsmResolver();
+}
+
+/**
+ * Resolves an import path using tsconfig and the rspack resolver.
+ *
+ * @param sourceFile - The file that is importing the path.
+ * @param importPath - The path to resolve.
+ * @returns The fully resolved path.
+ */
+function resolveImportPath(sourceFile, importPath) {
+  const dir = _nodePath.default.dirname(sourceFile);
+  let matchPath = matchPathCache.get(dir);
+  if (!matchPath) {
+    const foundConfig = (0, _tsconfigPaths.loadConfig)(dir);
+    if (foundConfig.resultType !== "success") {
+      throw new Error("Failed to load tsconfig");
+    }
+    matchPath = (0, _tsconfigPaths.createMatchPath)(foundConfig.absoluteBaseUrl, foundConfig.paths, CONDITION_NAMES);
+    matchPathCache.set(dir, matchPath);
+  }
+
+  // See if we can resolve the import path using the tsconfig.
+  const resolvedPath = matchPath(importPath);
+
+  // Get the directory of the source file to resolve against.
+  const sourceFileDir = _nodePath.default.dirname(sourceFile);
+
+  // Get the fully resolved path.
+  return esmResolver.sync(sourceFileDir, resolvedPath !== null && resolvedPath !== void 0 ? resolvedPath : importPath).path;
+}

package/dist/parser/utils.js

@@ -3,23 +3,10 @@
 Object.defineProperty(exports, "__esModule", {
   value: true
 });
-exports.getPathWithExtension = exports.fixPathResolution = void 0;
+exports.getPathWithExtension = void 0;
 var _fs = _interopRequireDefault(require("fs"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-const fixPathResolution = (path, config) => {
-  if (config.alias) {
-    for (const {
-      find,
-      replacement
-    } of config.alias) {
-      path = path.replace(find, replacement);
-    }
-  }
-  return path;
-};
-exports.fixPathResolution = fixPathResolution;
-const getPathWithExtension = (pathWithoutExtension, config) => {
-  pathWithoutExtension = fixPathResolution(pathWithoutExtension, config);
+const getPathWithExtension = pathWithoutExtension => {
   if (/\.(less|css|png|gif|jpg|jpeg|js|jsx|ts|tsx|mjs)$/.test(pathWithoutExtension)) {
     return pathWithoutExtension;
   }

package/package.json

@@ -1,66 +1,72 @@
 {
-    "name": "@khanacademy/graphql-flow",
-    "version": "3.4.2",
-    "repository": {
-        "type": "git",
-        "url": "https://github.com/Khan/graphql-flow.git"
-    },
-    "bugs": {
-        "url": "https://github.com/Khan/graphql-flow/issues"
-    },
-    "publishConfig": {
-        "access": "public",
-        "provenance": true
-    },
-    "bin": {
-        "graphql-flow": "dist/cli/run.js"
-    },
-    "jest": {
-        "testPathIgnorePatterns": [
-            "dist"
-        ]
-    },
-    "scripts": {
-        "test": "jest",
-        "typecheck": "tsc --noEmit",
-        "publish:ci": "yarn run build && changeset publish",
-        "build": "babel src --extensions '.ts, .tsx' --out-dir dist --ignore 'src/**/*.spec.ts','src/**/*.test.ts' && chmod 755 dist/cli/run.js"
-    },
-    "main": "dist/index.js",
-    "devDependencies": {
-        "@babel/cli": "^7.17.6",
-        "@babel/eslint-parser": "^7.17.0",
-        "@babel/polyfill": "^7.0.0",
-        "@babel/preset-env": "^7.24.5",
-        "@babel/preset-typescript": "^7.24.1",
-        "@changesets/cli": "^2.21.1",
-        "@khanacademy/eslint-config": "^4.0.0",
-        "@types/jest": "^29.5.3",
-        "@types/prop-types": "^15.7.12",
-        "@types/react": "^18.3.3",
-        "@typescript-eslint/eslint-plugin": "^7.17.0",
-        "@typescript-eslint/parser": "^7.17.0",
-        "babel-jest": "23.4.2",
-        "eslint": "^8.57.0",
-        "eslint-config-prettier": "7.0.0",
-        "eslint-plugin-jest": "^28.6.0",
-        "eslint-plugin-prettier": "^4.0.0",
-        "graphql-tag": "2.10.1",
-        "jest": "^27.5.1",
-        "prettier": "^2.5.1",
-        "prettier-eslint": "^13.0.0",
-        "typescript": "^5.1.6"
-    },
-    "dependencies": {
-        "@babel/core": "^7.24.5",
-        "@babel/generator": "^7.24.5",
-        "@babel/parser": "^7.24.5",
-        "@babel/traverse": "^7.24.5",
-        "@babel/types": "^7.24.5",
-        "@khanacademy/wonder-stuff-core": "^1.5.1",
-        "apollo-utilities": "^1.3.4",
-        "graphql": "^16.9.0",
-        "jsonschema": "^1.4.1",
-        "minimist": "^1.2.8"
-    }
-}
+  "name": "@khanacademy/graphql-flow",
+  "version": "4.0.1",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Khan/graphql-flow.git"
+  },
+  "bugs": {
+    "url": "https://github.com/Khan/graphql-flow/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "bin": {
+    "graphql-flow": "dist/cli/run.js"
+  },
+  "jest": {
+    "testPathIgnorePatterns": [
+      "dist"
+    ]
+  },
+  "main": "dist/index.js",
+  "devDependencies": {
+    "@babel/cli": "^7.17.6",
+    "@babel/eslint-parser": "^7.17.0",
+    "@babel/polyfill": "^7.0.0",
+    "@babel/preset-env": "^7.24.5",
+    "@babel/preset-typescript": "^7.24.1",
+    "@changesets/cli": "^2.21.1",
+    "@jest/globals": "^30.2.0",
+    "@khanacademy/eslint-config": "^4.0.0",
+    "@types/babel__generator": "^7.27.0",
+    "@types/babel__traverse": "^7.28.0",
+    "@types/jest": "^29.5.3",
+    "@types/minimist": "^1.2.5",
+    "@types/prop-types": "^15.7.12",
+    "@types/react": "^18.3.3",
+    "@typescript-eslint/eslint-plugin": "^7.17.0",
+    "@typescript-eslint/parser": "^7.17.0",
+    "babel-jest": "23.4.2",
+    "eslint": "^8.57.0",
+    "eslint-config-prettier": "7.0.0",
+    "eslint-plugin-jest": "^28.6.0",
+    "eslint-plugin-prettier": "^4.0.0",
+    "graphql-tag": "2.10.1",
+    "jest": "^27.5.1",
+    "prettier": "^2.5.1",
+    "prettier-eslint": "^13.0.0",
+    "typescript": "^5.1.6"
+  },
+  "dependencies": {
+    "@babel/core": "^7.24.5",
+    "@babel/generator": "^7.24.5",
+    "@babel/parser": "^7.24.5",
+    "@babel/traverse": "^7.24.5",
+    "@babel/types": "^7.24.5",
+    "@khanacademy/wonder-stuff-core": "^1.5.1",
+    "apollo-utilities": "^1.3.4",
+    "graphql": "^16.9.0",
+    "jsonschema": "^1.4.1",
+    "minimist": "^1.2.8",
+    "rspack-resolver": "^1.3.0",
+    "tsconfig-paths": "^4.2.0"
+  },
+  "scripts": {
+    "test": "jest",
+    "typecheck": "tsc --noEmit",
+    "publish:ci": "pnpm build && changeset publish",
+    "build": "babel src --extensions '.ts, .tsx' --out-dir dist --ignore 'src/**/*.spec.ts','src/**/*.test.ts' && chmod 755 dist/cli/run.js"
+  }
+}

package/schema.json

@@ -94,23 +94,7 @@
         "generate": {"oneOf": [
             {"$ref": "#/definitions/GenerateConfig"},
             {"type": "array", "items": {"$ref": "#/definitions/GenerateConfig"}}
-        ]},
-        "alias": {
-            "type": "array",
-            "items": {
-                "type": "object",
-                "additionalProperties": false,
-                "properties": {
-                    "find": {
-                        "type": ["string", "object"]
-                    },
-                    "replacement": {
-                        "type": "string"
-                    }
-                },
-                "required": [ "find", "replacement" ]
-            }
-        }
+        ]}
     },
     "required": [ "crawl", "generate" ]
 }

package/src/cli/run.ts

@@ -56,7 +56,7 @@ const inputFiles = getInputFiles(options, config);
 /** Step (2) */
 
 const files = processFiles(inputFiles, config, (f) => {
-    const resolvedPath = getPathWithExtension(f, config);
+    const resolvedPath = getPathWithExtension(f);
     if (!resolvedPath) {
         throw new Error(`Unable to find ${f}`);
     }