Add the ability to preload a query outside of React (#11412)

Co-authored-by: Lenz Weber-Tronic <[email protected]>
Co-authored-by: jerelmiller <[email protected]>

Author: jerelmiller

src/testing/internal/index.ts

@@ -1,3 +1,22 @@
 export * from "./profile/index.js";
 export * from "./disposables/index.js";
 export { ObservableStream } from "./ObservableStream.js";
+
+export type {
+  SimpleCaseData,
+  PaginatedCaseData,
+  PaginatedCaseVariables,
+  VariablesCaseData,
+  VariablesCaseVariables,
+} from "./scenarios/index.js";
+export {
+  setupSimpleCase,
+  setupVariablesCase,
+  setupPaginatedCase,
+} from "./scenarios/index.js";
+
+export type {
+  RenderWithClientOptions,
+  RenderWithMocksOptions,
+} from "./renderHelpers.js";
+export { renderWithClient, renderWithMocks } from "./renderHelpers.js";

src/testing/matchers/index.d.ts

@@ -3,6 +3,7 @@ import type {
   DocumentNode,
   OperationVariables,
 } from "../../core/index.js";
+import type { QueryReference } from "../../react/index.js";
 import {
   NextRenderOptions,
   Profiler,
@@ -11,6 +12,11 @@ import {
 } from "../internal/index.js";
 
 interface ApolloCustomMatchers<R = void, T = {}> {
+  /**
+   * Used to determine if a queryRef has been disposed.
+   */
+  toBeDisposed: T extends QueryReference<any, any> ? () => R
+  : { error: "matcher needs to be called on a QueryReference" };
   /**
    * Used to determine if two GraphQL query documents are equal to each other by
    * comparing their printed values. The document must be parsed by `gql`.

src/testing/matchers/index.ts

@@ -3,8 +3,10 @@ import { toMatchDocument } from "./toMatchDocument.js";
 import { toHaveSuspenseCacheEntryUsing } from "./toHaveSuspenseCacheEntryUsing.js";
 import { toRerender, toRenderExactlyTimes } from "./ProfiledComponent.js";
 import { toBeGarbageCollected } from "./toBeGarbageCollected.js";
+import { toBeDisposed } from "./toBeDisposed.js";
 
 expect.extend({
+  toBeDisposed,
   toHaveSuspenseCacheEntryUsing,
   toMatchDocument,
   toRerender,

src/testing/matchers/toBeDisposed.ts

@@ -0,0 +1,35 @@
+import type { MatcherFunction } from "expect";
+import type { QueryReference } from "../../react/cache/QueryReference.js";
+import {
+  InternalQueryReference,
+  unwrapQueryRef,
+} from "../../react/cache/QueryReference.js";
+
+function isQueryRef(queryRef: unknown): queryRef is QueryReference {
+  try {
+    return unwrapQueryRef(queryRef as any) instanceof InternalQueryReference;
+  } catch (e) {
+    return false;
+  }
+}
+
+export const toBeDisposed: MatcherFunction<[]> = function (queryRef) {
+  const hint = this.utils.matcherHint("toBeDisposed", "queryRef", "", {
+    isNot: this.isNot,
+  });
+
+  if (!isQueryRef(queryRef)) {
+    throw new Error(`\n${hint}\n\nmust be called with a valid QueryReference`);
+  }
+
+  const pass = unwrapQueryRef(queryRef).disposed;
+
+  return {
+    pass,
+    message: () => {
+      return `${hint}\n\nExpected queryRef ${
+        this.isNot ? "not " : ""
+      }to be disposed, but it was${this.isNot ? "" : " not"}.`;
+    },
+  };
+};