Merge pull request #8554 from apollographql/release-3.5

Release 3.5.0

Author: hwillson

.gitignore

@@ -38,6 +38,9 @@ dist
 npm
 !flow-typed/npm
 
+# Unpublished output from @apollo/client build, like bundlesize artifacts
+temp/
+
 # webstorm
 .idea/
 

CHANGELOG.md

@@ -1,3 +1,73 @@
+## Apollo Client 3.5.0 (2021-11-08)
+
+### Improvements
+
+- Add `updateQuery` and `updateFragment` methods to `ApolloCache`, simplifying common `readQuery`/`writeQuery` cache update patterns. <br/>
+  [@wassim-k](https://github.com/wassim-k) in [#8382](https://github.com/apollographql/apollo-client/pull/8382)
+
+- Field directives and their arguments can now be included along with field argument names when using [field policy `keyArgs: [...]` notation](https://www.apollographql.com/docs/react/pagination/key-args/). For example, if you have a `Query.feed` field that takes an argument called `type` and uses a `@connection(key:...)` directive to keep `feed` data from different queries separate within the cache, you might configure both using the following `InMemoryCache` field policy:
+  ```ts
+  new InMemoryCache({
+    typePolicies: {
+      Query: {
+        fields: {
+          feed: {
+            keyArgs: ["type", "@connection", ["key"]],
+          },
+        },
+      },
+    },
+  })
+  ```
+  [@benjamn](https://github.com/benjamn) in [#8678](https://github.com/apollographql/apollo-client/pull/8678)
+
+- Report single `MissingFieldError` instead of a potentially very large `MissingFieldError[]` array for incomplete cache reads, improving performance and memory usage. <br/>
+  [@benjamn](https://github.com/benjamn) in [#8734](https://github.com/apollographql/apollo-client/pull/8734)
+
+- When writing results into `InMemoryCache`, each written object is now identified using `policies.identify` _after_ traversing the fields of the object (rather than before), simplifying identification and reducing duplicate work. If you have custom `keyFields` functions, they still receive the raw result object as their first parameter, but the `KeyFieldsContext` parameter now provides `context.storeObject` (the `StoreObject` just processed by `processSelectionSet`) and `context.readField` (a helper function for reading fields from `context.storeObject` and any `Reference`s it might contain, similar to `readField` for `read`, `merge`, and `cache.modify` functions). <br/>
+  [@benjamn](https://github.com/benjamn) in [#8996](https://github.com/apollographql/apollo-client/pull/8996)
+
+- Ensure `cache.identify` never throws when primary key fields are missing, and include the source object in the error message when `keyFields` processing fails. <br/>
+  [@benjamn](https://github.com/benjamn) in [#8679](https://github.com/apollographql/apollo-client/pull/8679)
+
+- The `HttpLink` constructor now accepts an optional `print` function that can be used to customize how GraphQL `DocumentNode` objects are transformed back into strings before they are sent over the network. <br/>
+  [@sarahgp](https://github.com/sarahgp) in [#8699](https://github.com/apollographql/apollo-client/pull/8699)
+
+- Make `@apollo/client/testing` a fully-fledged, independent entry point, instead of re-exporting `@apollo/client/utilities/testing` (which was never an entry point and no longer exists). <br/>
+  [@benjamn](https://github.com/benjamn) in [#8769](https://github.com/apollographql/apollo-client/pull/8769)
+
+- A new nested entry point called `@apollo/client/testing/core` has been created. Importing from this entry point instead of `@apollo/client/testing` excludes any React-related dependencies. <br/>
+  [@wassim-k](https://github.com/wassim-k) in [#8687](https://github.com/apollographql/apollo-client/pull/8687)
+
+- Make `cache.batch` return the result of calling the `options.update` function. <br/>
+  [@benjamn](https://github.com/benjamn) in [#8696](https://github.com/apollographql/apollo-client/pull/8696)
+
+- The `NetworkError` and `ErrorResponse` types have been changed to align more closely. <br/>
+  [@korywka](https://github.com/korywka) in [#8424](https://github.com/apollographql/apollo-client/pull/8424)
+
+- Include `graphql@16` in peer deps. <br/>
+  [@brainkim](https://github.com/brainkim) in [#8997](https://github.com/apollographql/apollo-client/pull/8997)
+
+### React Refactoring
+
+#### Improvements (due to [@brainkim](https://github.com/brainkim) in [#8875](https://github.com/apollographql/apollo-client/pull/8875)):
+- The `useLazyQuery` function now returns a promise with the result.
+- The `useMutation` result now exposes a method which can be reset.
+
+#### Bug Fixes (due to [@brainkim](https://github.com/brainkim) in [#8596](https://github.com/apollographql/apollo-client/pull/8596)):
+
+- The `useQuery` and `useLazyQuery` hooks will now have `ObservableQuery` methods defined consistently.
+- Calling `useLazyQuery` methods like `startPolling` will start the query.
+- Calling the `useLazyQuery` execution function will now behave more like `refetch`. `previousData` will be preserved.
+- `standby` fetchPolicies will now act like `skip: true` more consistently.
+- Calling `refetch` on a skipped query will have no effect (issue [#8270](https://github.com/apollographql/apollo-client/issues/8270)).
+- Prevent `onError` and `onCompleted` functions from firing continuously, and improving their polling behavior.
+
+### Other Bugs Fixed
+
+- Update `zen-observable-ts` to eliminate transitive dependency on `@types/zen-observable`. <br/>
+  [@benjamn](https://github.com/benjamn) in [#8695](https://github.com/apollographql/apollo-client/pull/8695)
+
 ## Apollo Client 3.4.17 (2021-11-08)
 
 ### Improvements

config/entryPoints.js

@@ -17,14 +17,14 @@ const entryPoints = [
   { dirs: ['react'] },
   { dirs: ['react', 'components'] },
   { dirs: ['react', 'context'] },
-  { dirs: ['react', 'data'] },
   { dirs: ['react', 'hoc'] },
   { dirs: ['react', 'hooks'] },
   { dirs: ['react', 'parser'] },
   { dirs: ['react', 'ssr'] },
+  { dirs: ['testing'], extensions: [".js", ".jsx"] },
+  { dirs: ['testing', 'core'] },
   { dirs: ['utilities'] },
   { dirs: ['utilities', 'globals'], sideEffects: true },
-  { dirs: ['testing'], extensions: [".js", ".jsx"] },
 ];
 
 const lookupTrie = Object.create(null);

config/helpers.ts

@@ -23,6 +23,7 @@ export function eachFile(dir: string, callback: (
 
         // Avoid re-transforming CommonJS bundle files.
         if (relPath.endsWith(".cjs.js")) return;
+        if (relPath.endsWith(".cjs")) return;
 
         // Avoid re-transforming CommonJS bundle files.
         if (relPath.endsWith(".min.js")) return;

config/jest.config.js

@@ -17,4 +17,5 @@ module.exports = {
   moduleFileExtensions: ['ts', 'tsx', 'js', 'json'],
   testURL: 'http://localhost',
   setupFiles: ['<rootDir>/config/jest/setup.ts'],
+  testEnvironment: 'jsdom',
 };

config/prepareDist.js

@@ -23,6 +23,12 @@ const distRoot = `${__dirname}/../dist`;
 const packageJson = require('../package.json');
 const entryPoints = require('./entryPoints.js');
 
+// Enable default interpretation of .js files as ECMAScript modules. We don't
+// put this in the source ../package.json file because it interferes with tools
+// like ts-node, which we use to run various ../config/*.ts scripts.
+// TODO(benjamn) Fully diagnose that interference.
+packageJson.type = 'module';
+
 // The root package.json is marked as private to prevent publishing
 // from happening in the root of the project. This sets the package back to
 // public so it can be published from the "dist" directory.
@@ -70,7 +76,8 @@ entryPoints.forEach(function buildPackageJson({
     path.join(distRoot, ...dirs, 'package.json'),
     JSON.stringify({
       name: path.posix.join('@apollo', 'client', ...dirs),
-      main: `${bundleName}.cjs.js`,
+      type: "module",
+      main: `${bundleName}.cjs`,
       module: 'index.js',
       types: 'index.d.ts',
       sideEffects,

config/resolveModuleIds.ts

@@ -82,21 +82,45 @@ class Transformer {
     return id.startsWith("./") || id.startsWith("../");
   }
 
-  normalizeSourceString(file: string, source: Node | null | undefined) {
-    if (source && n.StringLiteral.check(source) && this.isRelative(source.value)) {
+  normalizeSourceString(file: string, source?: Node | null) {
+    if (source && n.StringLiteral.check(source)) {
       try {
-        source.value = this.normalizeId(source.value, file);
+        source.value = this.isRelative(source.value)
+          ? this.normalizeId(source.value, file)
+          : this.normalizeNonRelativeId(source.value, file);
       } catch (error) {
-        console.error(`Failed to resolve ${source.value} in ${file}`);
+        console.error(`Failed to resolve ${source.value} in ${file} with error ${error}`);
         process.exit(1);
       }
     }
   }
 
+  normalizeNonRelativeId(id: string, file: string) {
+    const normal = this.normalizeId(id, file);
+    const normalParts = normal.split("/");
+    const sourceParts = id.split("/");
+    const nodeModulesIndex = normalParts.lastIndexOf("node_modules");
+    if (
+      nodeModulesIndex >= 0 &&
+      normalParts[nodeModulesIndex + 1] === sourceParts[0]
+    ) {
+      const bareModuleIdentifier =
+        normalParts.slice(nodeModulesIndex + 1).join("/");
+      if (normal === this.normalizeId(bareModuleIdentifier, file)) {
+        return bareModuleIdentifier;
+      }
+      console.error(`Leaving ${id} import in ${file} unchanged because ${
+        bareModuleIdentifier
+      } does not resolve to the same module`);
+    }
+    return id;
+  }
+
   normalizeId(id: string, file: string) {
     const basedir = path.dirname(file);
     const absPath = resolve.sync(id, {
       basedir,
+      extensions: [".mjs", ".js"],
       packageFilter(pkg) {
         return pkg.module ? {
           ...pkg,

config/rollup.config.js

@@ -77,7 +77,7 @@ function prepareCJSMinified(input) {
   return {
     input,
     output: {
-      file: input.replace('.js', '.min.js'),
+      file: input.replace('.cjs', '.min.cjs'),
       format: 'cjs',
     },
     plugins: [
@@ -108,7 +108,7 @@ function prepareBundle({
       return isExternal(id, parentId, true);
     },
     output: {
-      file: `${dir}/${bundleName}.cjs.js`,
+      file: `${dir}/${bundleName}.cjs`,
       format: 'cjs',
       sourcemap: true,
       exports: 'named',
@@ -125,9 +125,9 @@ export default [
   // Convert the ESM entry point to a single CJS bundle.
   prepareCJS(
     './dist/index.js',
-    './dist/apollo-client.cjs.js',
+    './dist/apollo-client.cjs',
   ),
   prepareCJSMinified(
-    './dist/apollo-client.cjs.js',
+    './dist/apollo-client.cjs',
   ),
 ];

config/version.js

@@ -31,7 +31,7 @@ switch (process.argv[2]) {
     const {
       ApolloClient,
       InMemoryCache,
-    } = require(path.join(distRoot, "core", "core.cjs.js"));
+    } = require(path.join(distRoot, "core", "core.cjs"));
 
     // Though this may seem like overkill, verifying that ApolloClient is
     // constructible in Node.js is actually pretty useful, too!
@@ -43,15 +43,15 @@ switch (process.argv[2]) {
     // the client might have acquired during its construction.
     client.stop();
 
-    // The CommonJS dist/core/core.cjs.js file is generated from ESM modules
-    // generated by tsc, including dist/version.js, so verifying core.cjs.js
-    // exports an ApolloClient class that defines client.version also serves
-    // to verify that dist/version.js must have been correctly updated,
-    // which is convenient because dist/version.js uses ECMAScript module
-    // syntax, and is thus not importable in all versions of Node.js.
+    // The CommonJS dist/core/core.cjs file is generated from ESM modules
+    // generated by tsc, including dist/version.js, so verifying core.cjs
+    // exports an ApolloClient class that defines client.version also serves to
+    // verify that dist/version.js must have been correctly updated, which is
+    // convenient because dist/version.js uses ECMAScript module syntax, and is
+    // thus not importable in all versions of Node.js.
     assert.strictEqual(
       client.version, version,
-      "Failed to update dist/version.js and dist/core/core.cjs.js",
+      "Failed to update dist/version.js and dist/core/core.cjs",
     );
 
     break;