Merge pull request #317 from apollographql/main

GulajavaMinistudio · web-flow · commit 330581e81f8b · 2023-01-21T06:55:57.000+07:00
Create a new pull request by comparing changes across two branches
diff --git a/.changeset/rotten-pears-draw.md b/.changeset/rotten-pears-draw.md
@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Refetch should not return partial data with `errorPolicy: none` and `notifyOnNetworkStatusChange: true`.
diff --git a/.changeset/spotty-kings-unite.md b/.changeset/spotty-kings-unite.md
@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+Improve context types
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -3,7 +3,7 @@ version: 2
 jobs:
   Filesize:
     docker:
-      - image: cimg/node:18.12.0
+      - image: cimg/node:19.4.0
     steps:
       - checkout
       - run: npm version
@@ -12,7 +12,7 @@ jobs:
 
   Lint:
     docker:
-      - image: cimg/node:18.12.0
+      - image: cimg/node:19.4.0
     steps:
       - checkout
       - run: npm version
@@ -21,7 +21,7 @@ jobs:
 
   Tests:
     docker:
-      - image: cimg/node:18.12.0
+      - image: cimg/node:19.4.0
     steps:
       - checkout
       - run: npm run ci:precheck
diff --git a/.eslintrc b/.eslintrc
@@ -1,8 +1,16 @@
 {
+  "parser": "@typescript-eslint/parser",
+  "plugins": ["@typescript-eslint"],
+  "env": {
+    "browser": true,
+    "node": true,
+    "es2021": true
+  },
+  "parserOptions": {
+    "ecmaVersion": "latest"
+  },
   "overrides": [
     {
-      "parser": "@typescript-eslint/parser",
-      "plugins": ["@typescript-eslint"],
       "files": ["**/__tests__/**/*.[jt]sx", "**/?(*.)+(test).[jt]sx"],
       "extends": ["plugin:testing-library/react"],
       "rules": {
diff --git a/.github/workflows/close-stale-issues.yml b/.github/workflows/close-stale-issues.yml
@@ -111,7 +111,7 @@ jobs:
         # only-pr-labels: # optional, default is 
 
         # The maximum number of operations per run, used to control rate limiting (GitHub API CRUD related).
-        operations-per-run: 100 # optional, default is 30
+        operations-per-run: 500 # optional, default is 30
 
         # Remove stale labels from issues and pull requests when they are updated or commented on.
         remove-stale-when-updated: false
@@ -123,7 +123,7 @@ jobs:
         remove-pr-stale-when-updated: false
 
         # Run the processor in debug mode without actually performing any operations on live issues.
-        debug-only: true
+        debug-only: false
 
         # # The order to get issues or pull requests. Defaults to false, which is descending.
         # ascending: # optional, default is false
diff --git a/docs/shared/subscription-options.mdx b/docs/shared/subscription-options.mdx
@@ -2,12 +2,13 @@
 | - | - | - |
 | `subscription` | DocumentNode | A GraphQL subscription document parsed into an AST by `graphql-tag`. **Optional** for the `useSubscription` Hook since the subscription can be passed in as the first parameter to the Hook. **Required** for the `Subscription` component. |
 | `variables` | { [key: string]: any } | An object containing all of the variables your subscription needs to execute |
-| `shouldResubscribe` | boolean | Determines if your subscription should be unsubscribed and subscribed again |
+| `shouldResubscribe` | boolean | Determines if your subscription should be unsubscribed and subscribed again when an input to the hook (such as `subscription` or `variables`) changes. |
 | `skip` | boolean | Determines if the current subscription should be skipped. Useful if, for example, variables depend on previous queries and are not ready yet. |
-| `onSubscriptionData` | **Deprecated.** (options: OnSubscriptionDataOptions&lt;TData&gt;) => any | Allows the registration of a callback function, that will be triggered each time the `useSubscription` Hook / `Subscription` component receives data. The callback `options` object param consists of the current Apollo Client instance in `client`, and the received subscription data in `subscriptionData`. |
-| `onData` | (options: OnDataOptions&lt;TData&gt;) => any | Allows the registration of a callback function, that will be triggered each time the `useSubscription` Hook / `Subscription` component receives data. The callback `options` object param consists of the current Apollo Client instance in `client`, and the received subscription data in `data`. |
-| `onSubscriptionComplete` | **Deprecated.** () => void | Allows the registration of a callback function, that will be triggered when the `useSubscription` Hook / `Subscription` component completes the subscription. |
-| `onComplete` | () => void | Allows the registration of a callback function, that will be triggered each time the `useSubscription` Hook / `Subscription` component completes the subscription. |
+| `onSubscriptionData` | **Deprecated.** (options: OnSubscriptionDataOptions&lt;TData&gt;) => any | Allows the registration of a callback function that will be triggered each time the `useSubscription` Hook / `Subscription` component receives data. The callback `options` object param consists of the current Apollo Client instance in `client`, and the received subscription data in `subscriptionData`. |
+| `onData` | (options: OnDataOptions&lt;TData&gt;) => any | Allows the registration of a callback function that will be triggered each time the `useSubscription` Hook / `Subscription` component receives data. The callback `options` object param consists of the current Apollo Client instance in `client`, and the received subscription data in `data`. |
+| `onError` | (error: ApolloError) => void | Allows the registration of a callback function that will be triggered each time the `useSubscription` Hook / `Subscription` component receives an error. |
+| `onSubscriptionComplete` | **Deprecated.** () => void | Allows the registration of a callback function that will be triggered when the `useSubscription` Hook / `Subscription` component completes the subscription. |
+| `onComplete` | () => void | Allows the registration of a callback function that will be triggered each time the `useSubscription` Hook / `Subscription` component completes the subscription. |
 | `fetchPolicy` | FetchPolicy | How you want your component to interact with the Apollo cache. For details, see [Setting a fetch policy](/react/data/queries/#setting-a-fetch-policy). |
 | `context` | Record&lt;string, any&gt; | Shared context between your component and your network interface (Apollo Link). |
 | `client` | ApolloClient | An `ApolloClient` instance. By default `useSubscription` / `Subscription` uses the client passed down via context, but a different client can be passed in. |
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -42,14 +42,14 @@
     "prepdist": "node ./config/prepareDist.js",
     "prepdist:changesets": "ts-node-script config/prepareChangesetsRelease.ts",
     "postprocess-dist": "ts-node-script config/postprocessDist.ts",
-    "clean": "rimraf -r dist coverage lib temp",
+    "clean": "rimraf dist coverage lib temp",
     "ci:precheck": "node config/precheck.js",
     "lint": "eslint '**/__tests__/**/*.[jt]sx'",
     "test": "jest --config ./config/jest.config.js",
     "test:debug": "node --inspect-brk node_modules/.bin/jest --config ./config/jest.config.js --runInBand --testTimeout 99999 --logHeapUsage",
     "test:ci": "TEST_ENV=ci npm run test:coverage -- --logHeapUsage && npm run test:memory",
     "test:watch": "jest --config ./config/jest.config.js --watch",
-    "test:memory": "cd scripts/memory && npm i && npm test",
+    "test:memory": "npm i && npm run build && cd scripts/memory && npm i && npm test",
     "test:coverage": "npm run coverage -- --ci --runInBand --reporters=default --reporters=jest-junit",
     "coverage": "node --no-compilation-cache --expose-gc --max_old_space_size=4096 node_modules/.bin/jest --config ./config/jest.config.js --logHeapUsage --coverage --watchAll=false",
     "bundlesize": "npm run build && ts-node-script ./config/bundlesize.ts",
@@ -143,7 +143,7 @@
     "react-dom-17": "npm:react-dom@^17",
     "recast": "0.22.0",
     "resolve": "1.22.1",
-    "rimraf": "3.0.2",
+    "rimraf": "4.0.7",
     "rollup": "2.79.1",
     "rollup-plugin-terser": "7.0.2",
     "rxjs": "7.8.0",
diff --git a/scripts/memory/package.json b/scripts/memory/package.json
@@ -2,7 +2,6 @@
   "name": "apollo-client-memory-tests",
   "private": true,
   "scripts": {
-    "preinstall": "cd ../.. && npm i && npm run build",
     "test": "mocha --exit -n expose-gc tests.js"
   },
   "dependencies": {
diff --git a/src/__tests__/ApolloClient.ts b/src/__tests__/ApolloClient.ts
@@ -2245,7 +2245,7 @@ describe('ApolloClient', () => {
             query: {kind: Kind.DOCUMENT, definitions: []},
             variables: {foo: 'bar'},
             errorPolicy: 'none',
-            context: null,
+            context: undefined,
             fetchPolicy: 'cache-first',
             pollInterval: 100,
             notifyOnNetworkStatusChange: true,
diff --git a/src/cache/inmemory/__tests__/__snapshots__/writeToStore.ts.snap b/src/cache/inmemory/__tests__/__snapshots__/writeToStore.ts.snap
@@ -5,7 +5,7 @@ Object {
   "ROOT_QUERY": Object {
     "__typename": "Query",
     "currentTime({\\"tz\\":\\"UTC-5\\"})": Object {
-      "localeString": "9/25/2020, 1:08:33 PM",
+      "localeString": "9/25/2020, 1:08:33 PM",
     },
     "someJSON": Object {
       "foos": Array [
diff --git a/src/core/QueryManager.ts b/src/core/QueryManager.ts
@@ -1453,6 +1453,18 @@ export class QueryManager<TStore> {
         }).then(resolved => fromData(resolved.data || void 0));
       }
 
+      // Resolves https://github.com/apollographql/apollo-client/issues/10317.
+      // If errorPolicy is 'none' and notifyOnNetworkStatusChange is true,
+      // data was incorrectly returned from the cache on refetch:
+      // if diff.missing exists, we should not return cache data.
+      if (
+        errorPolicy === 'none' &&
+        networkStatus === NetworkStatus.refetch &&
+        Array.isArray(diff.missing)
+      ) {
+        return fromData(void 0);
+      }
+
       return fromData(data);
     };
 
diff --git a/src/core/types.ts b/src/core/types.ts
@@ -13,7 +13,7 @@ import { IsStrictlyAny } from '../utilities';
 
 export { TypedDocumentNode } from '@graphql-typed-document-node/core';
 
-export type DefaultContext = Record<string, any>;
+export interface DefaultContext extends Record<string, any> {};
 
 export type QueryListener = (queryInfo: QueryInfo) => void;
 
@@ -140,7 +140,7 @@ export type ApolloQueryResult<T> = {
   */
   errors?: ReadonlyArray<GraphQLError>;
   /**
-  * The single Error object that is passed to onError and useQuery hooks, and is often thrown during manual `client.query` calls. 
+  * The single Error object that is passed to onError and useQuery hooks, and is often thrown during manual `client.query` calls.
   * This will contain both a NetworkError field and any GraphQLErrors.
   * See https://www.apollographql.com/docs/react/data/error-handling/ for more information.
   */
diff --git a/src/core/watchQueryOptions.ts b/src/core/watchQueryOptions.ts
@@ -73,7 +73,7 @@ export interface QueryOptions<TVariables = OperationVariables, TData = any> {
   /**
    * Context to be passed to link execution chain
    */
-  context?: any;
+  context?: DefaultContext;
 
   /**
    * Specifies the {@link FetchPolicy} to be used for this query
@@ -159,7 +159,7 @@ export interface NextFetchPolicyContext<TData, TVariables> {
 export interface FetchMoreQueryOptions<TVariables, TData = any> {
   query?: DocumentNode | TypedDocumentNode<TData, TVariables>;
   variables?: Partial<TVariables>;
-  context?: any;
+  context?: DefaultContext;
 }
 
 export type UpdateQueryFn<
diff --git a/src/link/context/index.ts b/src/link/context/index.ts
@@ -1,10 +1,11 @@
 import { ApolloLink, Operation, GraphQLRequest, NextLink } from '../core';
 import { Observable, ObservableSubscription } from '../../utilities';
+import { DefaultContext } from '../../core';
 
 export type ContextSetter = (
   operation: GraphQLRequest,
-  prevContext: any,
-) => Promise<any> | any;
+  prevContext: DefaultContext,
+) => Promise<DefaultContext> | DefaultContext;
 
 export function setContext(setter: ContextSetter): ApolloLink {
   return new ApolloLink((operation: Operation, forward: NextLink) => {
diff --git a/src/link/core/types.ts b/src/link/core/types.ts
diff --git a/src/react/hooks/__tests__/useQuery.test.tsx b/src/react/hooks/__tests__/useQuery.test.tsx

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@apollo/client": patch
 +---
++
 +Refetch should not return partial data with `errorPolicy: none` and `notifyOnNetworkStatusChange: true`.