Merge branch 'release-4.0' into jerel/deprecate-ws-link

Author: jerelmiller

.api-reports/api-report-link_http.api.md

@@ -89,9 +89,9 @@ export namespace HttpLink {
         preserveHeaderCase?: boolean;
     }
     export interface Options {
-        credentials?: string;
+        credentials?: RequestCredentials;
         fetch?: typeof fetch;
-        fetchOptions?: any;
+        fetchOptions?: RequestInit;
         headers?: Record<string, string>;
         includeExtensions?: boolean;
         includeUnusedVariables?: boolean;

.api-reports/api-report.api.md

@@ -1370,9 +1370,9 @@ export namespace HttpLink {
         preserveHeaderCase?: boolean;
     }
     export interface Options {
-        credentials?: string;
+        credentials?: RequestCredentials;
         fetch?: typeof fetch;
-        fetchOptions?: any;
+        fetchOptions?: RequestInit;
         headers?: Record<string, string>;
         includeExtensions?: boolean;
         includeUnusedVariables?: boolean;

.changeset/purple-eyes-divide.md

@@ -0,0 +1,5 @@
+---
+"@apollo/client": patch
+---
+
+The `fetchOptions` option provided to `HttpLink` and `BatchHttpLink` is now `RequestInit` instead of `any`. The `credentials` option is now a `RequestCredentials` type instead of a `string`.

src/link/batch-http/__tests__/batchHttpLink.ts

@@ -719,7 +719,7 @@ describe("SharedHttpTest", () => {
     const variables = { params: "stub" };
     const link = new BatchHttpLink({
       uri: "/data",
-      credentials: "same-team-yo",
+      credentials: "include",
     });
 
     const stream = new ObservableStream(
@@ -730,19 +730,19 @@ describe("SharedHttpTest", () => {
     await expect(stream).toComplete();
 
     const creds = fetchMock.lastCall()![1]!.credentials;
-    expect(creds).toBe("same-team-yo");
+    expect(creds).toBe("include");
   });
 
   it("prioritizes creds from the context over the setup", async () => {
     const variables = { params: "stub" };
     const middleware = new ApolloLink((operation, forward) => {
       operation.setContext({
-        credentials: "same-team-yo",
+        credentials: "omit",
       });
       return forward(operation);
     });
     const link = middleware.concat(
-      new BatchHttpLink({ uri: "/data", credentials: "error" })
+      new BatchHttpLink({ uri: "/data", credentials: "include" })
     );
 
     const stream = new ObservableStream(
@@ -753,7 +753,7 @@ describe("SharedHttpTest", () => {
     await expect(stream).toComplete();
 
     const creds = fetchMock.lastCall()![1]!.credentials;
-    expect(creds).toBe("same-team-yo");
+    expect(creds).toBe("omit");
   });
 
   it("adds uri to the request from the context", async () => {
@@ -801,7 +801,7 @@ describe("SharedHttpTest", () => {
       return forward(operation);
     });
     const link = middleware.concat(
-      new BatchHttpLink({ uri: "/data", credentials: "error" })
+      new BatchHttpLink({ uri: "/data", credentials: "include" })
     );
 
     const stream = new ObservableStream(
@@ -839,7 +839,7 @@ describe("SharedHttpTest", () => {
     const variables = { params: "stub" };
     const link = new BatchHttpLink({
       uri: "/data",
-      fetchOptions: { someOption: "foo", mode: "no-cors" },
+      fetchOptions: { mode: "no-cors" },
     });
 
     const stream = new ObservableStream(
@@ -849,8 +849,7 @@ describe("SharedHttpTest", () => {
     await expect(stream).toEmitTypedValue(data);
     await expect(stream).toComplete();
 
-    const { someOption, mode, headers } = fetchMock.lastCall()![1]! as any;
-    expect(someOption).toBe("foo");
+    const { mode, headers } = fetchMock.lastCall()![1]! as any;
     expect(mode).toBe("no-cors");
     expect(headers["content-type"]).toBe("application/json");
   });
@@ -902,13 +901,13 @@ describe("SharedHttpTest", () => {
     const middleware = new ApolloLink((operation, forward) => {
       operation.setContext({
         fetchOptions: {
-          someOption: "foo",
+          mode: "cors",
         },
       });
       return forward(operation);
     });
     const link = middleware.concat(
-      new BatchHttpLink({ uri: "/data", fetchOptions: { someOption: "bar" } })
+      new BatchHttpLink({ uri: "/data", fetchOptions: { mode: "no-cors" } })
     );
 
     const stream = new ObservableStream(
@@ -918,8 +917,8 @@ describe("SharedHttpTest", () => {
     await expect(stream).toEmitTypedValue(data);
     await expect(stream).toComplete();
 
-    const { someOption } = fetchMock.lastCall()![1]! as any;
-    expect(someOption).toBe("foo");
+    const { mode } = fetchMock.lastCall()![1]! as any;
+    expect(mode).toBe("cors");
   });
 
   it("allows for not sending the query with the request", async () => {

src/link/http/HttpLink.ts

@@ -129,12 +129,12 @@ export declare namespace HttpLink {
     /**
      * The credentials policy you want to use for the fetch call.
      */
-    credentials?: string;
+    credentials?: RequestCredentials;
 
     /**
      * Any overrides of the fetch options argument to pass to the fetch call.
      */
-    fetchOptions?: any;
+    fetchOptions?: RequestInit;
 
     /**
      * If set to true, use the HTTP GET method for query operations. Mutations

src/link/http/__tests__/HttpLink.ts

@@ -709,27 +709,27 @@ describe("HttpLink", () => {
 
     it("adds creds to the request from the setup", async () => {
       const variables = { params: "stub" };
-      const link = createHttpLink({ uri: "data", credentials: "same-team-yo" });
+      const link = createHttpLink({ uri: "data", credentials: "include" });
 
       const observable = execute(link, { query: sampleQuery, variables });
       const stream = new ObservableStream(observable);
 
       await expect(stream).toEmitTypedValue(data);
 
       const creds = fetchMock.lastCall()![1]!.credentials;
-      expect(creds).toBe("same-team-yo");
+      expect(creds).toBe("include");
     });
 
     it("prioritizes creds from the context over the setup", async () => {
       const variables = { params: "stub" };
       const middleware = new ApolloLink((operation, forward) => {
         operation.setContext({
-          credentials: "same-team-yo",
+          credentials: "omit",
         });
         return forward(operation);
       });
       const link = middleware.concat(
-        createHttpLink({ uri: "data", credentials: "error" })
+        createHttpLink({ uri: "data", credentials: "include" })
       );
 
       const observable = execute(link, { query: sampleQuery, variables });
@@ -738,7 +738,7 @@ describe("HttpLink", () => {
       await expect(stream).toEmitTypedValue(data);
 
       const creds = fetchMock.lastCall()![1]!.credentials;
-      expect(creds).toBe("same-team-yo");
+      expect(creds).toBe("omit");
     });
 
     it("adds uri to the request from the context", async () => {
@@ -782,7 +782,7 @@ describe("HttpLink", () => {
         return forward(operation);
       });
       const link = middleware.concat(
-        createHttpLink({ uri: "data", credentials: "error" })
+        createHttpLink({ uri: "data", credentials: "include" })
       );
 
       const observable = execute(link, { query: sampleQuery, variables });
@@ -817,16 +817,15 @@ describe("HttpLink", () => {
       const variables = { params: "stub" };
       const link = createHttpLink({
         uri: "data",
-        fetchOptions: { someOption: "foo", mode: "no-cors" },
+        fetchOptions: { mode: "no-cors" },
       });
 
       const observable = execute(link, { query: sampleQuery, variables });
       const stream = new ObservableStream(observable);
 
       await expect(stream).toEmitTypedValue(data);
 
-      const { someOption, mode, headers } = fetchMock.lastCall()![1] as any;
-      expect(someOption).toBe("foo");
+      const { mode, headers } = fetchMock.lastCall()![1] as any;
       expect(mode).toBe("no-cors");
       expect(headers["content-type"]).toBe("application/json");
     });
@@ -914,22 +913,22 @@ describe("HttpLink", () => {
       const middleware = new ApolloLink((operation, forward) => {
         operation.setContext({
           fetchOptions: {
-            someOption: "foo",
+            mode: "cors",
           },
         });
         return forward(operation);
       });
       const link = middleware.concat(
-        createHttpLink({ uri: "data", fetchOptions: { someOption: "bar" } })
+        createHttpLink({ uri: "data", fetchOptions: { mode: "no-cors" } })
       );
 
       const observable = execute(link, { query: sampleQuery, variables });
       const stream = new ObservableStream(observable);
 
       await expect(stream).toEmitTypedValue(data);
 
-      const { someOption } = fetchMock.lastCall()![1] as any;
-      expect(someOption).toBe("foo");
+      const { mode } = fetchMock.lastCall()![1] as any;
+      expect(mode).toBe("cors");
     });
 
     it("allows for not sending the query with the request", async () => {