Import @apollo/client/utilities/globals wherever __DEV__ is used (#…

…8720)

CHANGELOG.md

@@ -7,12 +7,14 @@
 
 ### Bug Fixes
 
-- Fix ObservableQuery.getCurrentResult() returning cached data with certain fetch policies. <br/>
+- Fix `ObservableQuery.getCurrentResult()` returning cached `data` with certain fetch policies. <br/>
   [@brainkim](https://github.com/brainkim) in [#8718](https://github.com/apollographql/apollo-client/pull/8718)
 
 - Prevent `ssrMode`/`ssrForceFetchDelay` from causing queries to hang. <br/>
   [@brainkim](https://github.com/brainkim) in [#8709](https://github.com/apollographql/apollo-client/pull/8709)
 
+- Import `@apollo/client/utilities/globals` internally wherever `__DEV__` is used, not just in `@apollo/client/**/index.js` entry points. <br/>
+  [@benjamn](https://github.com/benjamn) in [#8720](https://github.com/apollographql/apollo-client/pull/8720)
 
 ## Apollo Client 3.4.9
 

config/entryPoints.js

@@ -22,10 +22,8 @@ const entryPoints = [
   { dirs: ['react', 'hooks'] },
   { dirs: ['react', 'parser'] },
   { dirs: ['react', 'ssr'] },
-  { dirs: ['utilities'],
-    sideEffects: [
-      "./globals/**"
-    ]},
+  { dirs: ['utilities'] },
+  { dirs: ['utilities', 'globals'], sideEffects: true },
   { dirs: ['testing'], extensions: [".js", ".jsx"] },
 ];
 

config/resolveModuleIds.ts

@@ -6,7 +6,32 @@ import { distDir, eachFile, reparse, reprint } from './helpers';
 eachFile(distDir, (file, relPath) => new Promise((resolve, reject) => {
   fs.readFile(file, "utf8", (error, source) => {
     if (error) return reject(error);
-    const output = transform(source, file);
+
+    const tr = new Transformer;
+    const output = tr.transform(source, file);
+
+    if (
+      /\b__DEV__\b/.test(source) &&
+      // Ignore modules that reside within @apollo/client/utilities/globals.
+      !relPath.startsWith("utilities/globals/")
+    ) {
+      let importsUtilitiesGlobals = false;
+
+      tr.absolutePaths.forEach(absPath => {
+        const distRelativePath =
+          path.relative(distDir, absPath).split(path.sep).join("/");
+        if (distRelativePath === "utilities/globals/index.js") {
+          importsUtilitiesGlobals = true;
+        }
+      });
+
+      if (!importsUtilitiesGlobals) {
+        reject(new Error(`Module ${
+          relPath
+        } uses __DEV__ but does not import @apollo/client/utilities/globals`));
+      }
+    }
+
     if (source === output) {
       resolve(file);
     } else {
@@ -21,61 +46,67 @@ import * as recast from "recast";
 const n = recast.types.namedTypes;
 type Node = recast.types.namedTypes.Node;
 
-function transform(code: string, file: string) {
-  const ast = reparse(code);
-
-  recast.visit(ast, {
-    visitImportDeclaration(path) {
-      this.traverse(path);
-      normalizeSourceString(file, path.node.source);
-    },
-
-    visitImportExpression(path) {
-      this.traverse(path);
-      normalizeSourceString(file, path.node.source);
-    },
-
-    visitExportAllDeclaration(path) {
-      this.traverse(path);
-      normalizeSourceString(file, path.node.source);
-    },
-
-    visitExportNamedDeclaration(path) {
-      this.traverse(path);
-      normalizeSourceString(file, path.node.source);
-    },
-  });
+class Transformer {
+  absolutePaths = new Set<string>();
 
-  return reprint(ast);
-}
+  transform(code: string, file: string) {
+    const ast = reparse(code);
+    const transformer = this;
 
-function isRelative(id: string) {
-  return id.startsWith("./") || id.startsWith("../");
-}
+    recast.visit(ast, {
+      visitImportDeclaration(path) {
+        this.traverse(path);
+        transformer.normalizeSourceString(file, path.node.source);
+      },
 
-function normalizeSourceString(file: string, source?: Node | null) {
-  if (source && n.StringLiteral.check(source) && isRelative(source.value)) {
-    try {
-      source.value = normalizeId(source.value, file);
-    } catch (error) {
-      console.error(`Failed to resolve ${source.value} in ${file}`);
-      process.exit(1);
+      visitImportExpression(path) {
+        this.traverse(path);
+        transformer.normalizeSourceString(file, path.node.source);
+      },
+
+      visitExportAllDeclaration(path) {
+        this.traverse(path);
+        transformer.normalizeSourceString(file, path.node.source);
+      },
+
+      visitExportNamedDeclaration(path) {
+        this.traverse(path);
+        transformer.normalizeSourceString(file, path.node.source);
+      },
+    });
+
+    return reprint(ast);
+  }
+
+  isRelative(id: string) {
+    return id.startsWith("./") || id.startsWith("../");
+  }
+
+  normalizeSourceString(file: string, source: Node | null | undefined) {
+    if (source && n.StringLiteral.check(source) && this.isRelative(source.value)) {
+      try {
+        source.value = this.normalizeId(source.value, file);
+      } catch (error) {
+        console.error(`Failed to resolve ${source.value} in ${file}`);
+        process.exit(1);
+      }
     }
   }
-}
 
-function normalizeId(id: string, file: string) {
-  const basedir = path.dirname(file);
-  const absPath = resolve.sync(id, {
-    basedir,
-    packageFilter(pkg) {
-      return pkg.module ? {
-        ...pkg,
-        main: pkg.module,
-      } : pkg;
-    },
-  });
-  const relPath = path.relative(basedir, absPath);
-  const relId = relPath.split(path.sep).join('/');
-  return isRelative(relId) ? relId : "./" + relId;
+  normalizeId(id: string, file: string) {
+    const basedir = path.dirname(file);
+    const absPath = resolve.sync(id, {
+      basedir,
+      packageFilter(pkg) {
+        return pkg.module ? {
+          ...pkg,
+          main: pkg.module,
+        } : pkg;
+      },
+    });
+    this.absolutePaths.add(absPath);
+    const relPath = path.relative(basedir, absPath);
+    const relId = relPath.split(path.sep).join('/');
+    return this.isRelative(relId) ? relId : "./" + relId;
+  }
 }

package.json

@@ -31,15 +31,14 @@
   "scripts": {
     "prebuild": "npm run clean",
     "build": "tsc",
-    "postbuild": "npm run update-version && npm run invariants && npm run sourcemaps && npm run rollup && npm run prepdist && npm run resolve && npm run check-DEV && npm run verify-version",
+    "postbuild": "npm run update-version && npm run invariants && npm run sourcemaps && npm run rollup && npm run prepdist && npm run resolve && npm run verify-version",
     "update-version": "node config/version.js update",
     "verify-version": "node config/version.js verify",
     "invariants": "ts-node-script config/processInvariants.ts",
     "sourcemaps": "ts-node-script config/rewriteSourceMaps.ts",
     "rollup": "rollup -c ./config/rollup.config.js",
     "prepdist": "node ./config/prepareDist.js",
     "resolve": "ts-node-script config/resolveModuleIds.ts",
-    "check-DEV": "ts-node-script config/checkDEV.ts",
     "clean": "rimraf -r dist coverage lib",
     "test": "jest --config ./config/jest.config.js",
     "test:debug": "BABEL_ENV=server node --inspect-brk node_modules/.bin/jest --config ./config/jest.config.js --runInBand",

src/__tests__/__snapshots__/exports.ts.snap

@@ -331,7 +331,6 @@ Array [
   "buildQueryFromSelectionSet",
   "canUseWeakMap",
   "canUseWeakSet",
-  "checkDEV",
   "checkDocument",
   "cloneDeep",
   "compact",
@@ -381,3 +380,14 @@ Array [
   "valueToObjectRepresentation",
 ]
 `;
+
+exports[`exports of public entry points @apollo/client/utilities/globals 1`] = `
+Array [
+  "DEV",
+  "InvariantError",
+  "checkDEV",
+  "global",
+  "invariant",
+  "maybe",
+]
+`;

src/__tests__/exports.ts

@@ -23,6 +23,7 @@ import * as reactParser from "../react/parser";
 import * as reactSSR from "../react/ssr";
 import * as testing from "../testing";
 import * as utilities from "../utilities";
+import * as utilitiesGlobals from "../utilities/globals";
 
 const entryPoints = require("../../config/entryPoints.js");
 
@@ -63,6 +64,7 @@ describe('exports of public entry points', () => {
   check("@apollo/client/react/ssr", reactSSR);
   check("@apollo/client/testing", testing);
   check("@apollo/client/utilities", utilities);
+  check("@apollo/client/utilities/globals", utilitiesGlobals);
 
   it("completeness", () => {
     const { join } = require("path").posix;

src/cache/index.ts

@@ -1,5 +1,4 @@
-import { checkDEV } from "../utilities";
-checkDEV();
+import '../utilities/globals';
 
 export { Transaction, ApolloCache } from './core/cache';
 export { Cache } from './core/types/Cache';

src/cache/inmemory/entityStore.ts

@@ -1,5 +1,5 @@
+import { invariant } from '../../utilities/globals';
 import { dep, OptimisticDependencyFunction } from 'optimism';
-import { invariant } from 'ts-invariant';
 import { equal } from '@wry/equality';
 import { Trie } from '@wry/trie';
 

src/cache/inmemory/object-canon.ts

@@ -1,3 +1,5 @@
+import "../../utilities/globals";
+
 import { Trie } from "@wry/trie";
 import {
   canUseWeakMap,

src/cache/inmemory/policies.ts

@@ -1,3 +1,5 @@
+import { invariant, InvariantError } from '../../utilities/globals';
+
 import {
   InlineFragmentNode,
   FragmentDefinitionNode,
@@ -6,7 +8,6 @@ import {
 } from 'graphql';
 
 import { Trie } from '@wry/trie';
-import { invariant, InvariantError } from 'ts-invariant';
 
 import {
   FragmentMap,

src/cache/inmemory/readFromStore.ts

@@ -1,10 +1,11 @@
+import { invariant, InvariantError } from '../../utilities/globals';
+
 import {
   DocumentNode,
   FieldNode,
   SelectionSetNode,
 } from 'graphql';
 import { wrap, OptimisticWrapperFunction } from 'optimism';
-import { invariant, InvariantError } from 'ts-invariant';
 
 import {
   isField,

src/cache/inmemory/writeToStore.ts

@@ -1,5 +1,6 @@
+import { invariant, InvariantError } from '../../utilities/globals';
+
 import { SelectionSetNode, FieldNode, SelectionNode } from 'graphql';
-import { invariant, InvariantError } from 'ts-invariant';
 import { equal } from '@wry/equality';
 
 import {

src/core/ApolloClient.ts

@@ -1,5 +1,6 @@
+import { invariant, InvariantError } from '../utilities/globals';
+
 import { ExecutionResult, DocumentNode } from 'graphql';
-import { invariant, InvariantError } from 'ts-invariant';
 
 import { ApolloLink, FetchResult, GraphQLRequest, execute } from '../link/core';
 import { ApolloCache, DataProxy } from '../cache';

src/core/LocalState.ts

@@ -1,3 +1,5 @@
+import { invariant } from '../utilities/globals';
+
 import {
   DocumentNode,
   OperationDefinitionNode,
@@ -10,7 +12,6 @@ import {
   visit,
   BREAK,
 } from 'graphql';
-import { invariant } from 'ts-invariant';
 
 import { ApolloCache } from '../cache';
 import {

src/core/ObservableQuery.ts

@@ -1,4 +1,5 @@
-import { invariant } from 'ts-invariant';
+import { invariant } from '../utilities/globals';
+
 import { equal } from '@wry/equality';
 
 import { NetworkStatus, isNetworkRequestInFlight } from './networkStatus';

src/core/QueryManager.ts

@@ -1,5 +1,6 @@
+import { invariant, InvariantError } from '../utilities/globals';
+
 import { DocumentNode } from 'graphql';
-import { invariant, InvariantError } from 'ts-invariant';
 import { equal } from '@wry/equality';
 
 import { ApolloLink, execute, FetchResult } from '../link/core';

src/core/index.ts

@@ -1,7 +1,6 @@
 /* Core */
 
-import { DEV, checkDEV } from "../utilities";
-checkDEV();
+import { DEV } from '../utilities/globals';
 
 export {
   ApolloClient,