fix/ignore type errors from graphiql-toolkit's tests (#3749)

* aa

* fix type errors from graphiql-toolkit's tests

Author: dimaMachina

packages/graphiql-toolkit/src/create-fetcher/__tests__/buildFetcher.spec.ts

@@ -1,4 +1,4 @@
-import { vi } from 'vitest';
+import { Mock } from 'vitest';
 import { parse, getIntrospectionQuery } from 'graphql';
 import { createGraphiQLFetcher } from '../createFetcher';
 
@@ -11,25 +11,44 @@ vi.mock('graphql-ws');
 vi.mock('subscriptions-transport-ws');
 
 import {
-  createWebsocketsFetcherFromUrl,
-  createMultipartFetcher,
-  createSimpleFetcher,
-  createWebsocketsFetcherFromClient,
-  createLegacyWebsocketsFetcher,
+  createWebsocketsFetcherFromUrl as _createWebsocketsFetcherFromUrl,
+  createMultipartFetcher as _createMultipartFetcher,
+  createSimpleFetcher as _createSimpleFetcher,
+  createWebsocketsFetcherFromClient as _createWebsocketsFetcherFromClient,
+  createLegacyWebsocketsFetcher as _createLegacyWebsocketsFetcher,
 } from '../lib';
-import { createClient } from 'graphql-ws';
+import { createClient as _createClient } from 'graphql-ws';
 import { SubscriptionClient } from 'subscriptions-transport-ws';
 
 const serverURL = 'http://localhost:3000/graphql';
 const wssURL = 'ws://localhost:3000/graphql';
 
 const exampleIntrospectionDocument = parse(getIntrospectionQuery());
 
+const createWebsocketsFetcherFromUrl = _createWebsocketsFetcherFromUrl as Mock<
+  typeof _createWebsocketsFetcherFromUrl
+>;
+const createMultipartFetcher = _createMultipartFetcher as Mock<
+  typeof _createMultipartFetcher
+>;
+const createSimpleFetcher = _createSimpleFetcher as Mock<
+  typeof _createSimpleFetcher
+>;
+const createClient = _createClient as Mock<typeof _createClient>;
+const createWebsocketsFetcherFromClient =
+  _createWebsocketsFetcherFromClient as Mock<
+    typeof _createWebsocketsFetcherFromClient
+  >;
+const createLegacyWebsocketsFetcher = _createLegacyWebsocketsFetcher as Mock<
+  typeof _createLegacyWebsocketsFetcher
+>;
+
 describe('createGraphiQLFetcher', () => {
   afterEach(() => {
     vi.resetAllMocks();
   });
   it('returns fetcher without websocket client by default', () => {
+    // @ts-expect-error
     createWebsocketsFetcherFromUrl.mockReturnValue(true);
     createGraphiQLFetcher({ url: serverURL });
     expect(createWebsocketsFetcherFromUrl.mock.calls).toEqual([]);
@@ -39,6 +58,7 @@ describe('createGraphiQLFetcher', () => {
   });
 
   it('returns simple fetcher for introspection', async () => {
+    // @ts-expect-error
     createSimpleFetcher.mockReturnValue(async () => 'hey!');
     const fetcher = createGraphiQLFetcher({ url: serverURL });
     expect(createWebsocketsFetcherFromUrl.mock.calls).toEqual([]);
@@ -55,6 +75,7 @@ describe('createGraphiQLFetcher', () => {
     expect(res).toEqual('hey!');
   });
   it('returns fetcher without websocket client or multipart', () => {
+    // @ts-expect-error
     createWebsocketsFetcherFromUrl.mockReturnValue(true);
     createGraphiQLFetcher({ url: serverURL, enableIncrementalDelivery: false });
     expect(createWebsocketsFetcherFromUrl.mock.calls).toEqual([]);
@@ -64,6 +85,7 @@ describe('createGraphiQLFetcher', () => {
     ]);
   });
   it('returns fetcher with websocket client', () => {
+    // @ts-expect-error
     createWebsocketsFetcherFromUrl.mockReturnValue('Client1');
 
     const args = {
@@ -78,7 +100,9 @@ describe('createGraphiQLFetcher', () => {
   });
 
   it('returns fetcher with custom wsClient', () => {
+    // @ts-expect-error
     createClient.mockReturnValue('WSClient');
+    // @ts-expect-error
     createWebsocketsFetcherFromUrl.mockReturnValue('CustomWSSFetcher');
 
     const wsClient = createClient({ url: wssURL });
@@ -95,7 +119,9 @@ describe('createGraphiQLFetcher', () => {
   });
 
   it('returns fetcher with custom legacyClient', () => {
+    // @ts-expect-error
     createClient.mockReturnValue('WSClient');
+    // @ts-expect-error
     createLegacyWebsocketsFetcher.mockReturnValue('CustomWSSFetcher');
 
     const legacyClient = new SubscriptionClient(wssURL);

packages/graphiql-toolkit/src/create-fetcher/__tests__/lib.spec.ts

@@ -1,4 +1,4 @@
-import { vi } from 'vitest';
+import { Mock } from 'vitest';
 import { parse } from 'graphql';
 import {
   isSubscriptionWithName,
@@ -12,9 +12,12 @@ vi.mock('graphql-ws');
 
 vi.mock('subscriptions-transport-ws');
 
-import { createClient } from 'graphql-ws';
+import { createClient as _createClient } from 'graphql-ws';
 
-import { SubscriptionClient } from 'subscriptions-transport-ws';
+import { SubscriptionClient as _SubscriptionClient } from 'subscriptions-transport-ws';
+
+const createClient = _createClient as Mock<typeof _createClient>;
+const SubscriptionClient = _SubscriptionClient as Mock;
 
 const exampleWithSubscription = parse(/* GraphQL */ `
   subscription Example {
@@ -49,16 +52,16 @@ describe('createWebsocketsFetcherFromUrl', () => {
   });
 
   it('creates a websockets client using provided url', async () => {
+    // @ts-expect-error
     createClient.mockReturnValue(true);
     await createWebsocketsFetcherFromUrl('wss://example.com');
-    // @ts-ignore
     expect(createClient.mock.calls[0][0]).toEqual({ url: 'wss://example.com' });
   });
 
   it('creates a websockets client using provided url that fails', async () => {
+    // @ts-expect-error
     createClient.mockReturnValue(false);
     expect(await createWebsocketsFetcherFromUrl('wss://example.com')).toThrow();
-    // @ts-ignore
     expect(createClient.mock.calls[0][0]).toEqual({ url: 'wss://example.com' });
   });
 });
@@ -68,20 +71,22 @@ describe('getWsFetcher', () => {
     vi.resetAllMocks();
   });
   it('provides an observable wsClient when custom wsClient option is provided', async () => {
+    // @ts-expect-error
     createClient.mockReturnValue(true);
+    // @ts-expect-error
     await getWsFetcher({ url: '', wsClient: true });
-    // @ts-ignore
     expect(createClient.mock.calls).toHaveLength(0);
   });
   it('creates a subscriptions-transports-ws observable when custom legacyClient option is provided', async () => {
+    // @ts-expect-error
     createClient.mockReturnValue(true);
     await getWsFetcher({ url: '', legacyClient: true });
-    // @ts-ignore
     expect(createClient.mock.calls).toHaveLength(0);
     expect(SubscriptionClient.mock.calls).toHaveLength(0);
   });
 
   it('if subscriptionsUrl is provided, create a client on the fly', async () => {
+    // @ts-expect-error
     createClient.mockReturnValue(true);
     await getWsFetcher({ url: '', subscriptionUrl: 'wss://example' });
     expect(createClient.mock.calls[0]).toEqual([

packages/graphiql-toolkit/src/storage/__tests__/base.spec.ts

@@ -70,7 +70,7 @@ describe('StorageAPI', () => {
   });
 
   it('returns any error while setting a value', () => {
-    // @ts-ignore
+    // @ts-expect-error
     const throwingStorage = new StorageAPI({
       setItem() {
         throw new DOMException('Terrible Error');
@@ -84,7 +84,7 @@ describe('StorageAPI', () => {
   });
 
   it('returns isQuotaError to true if isQuotaError is thrown', () => {
-    // @ts-ignore
+    // @ts-expect-error
     const throwingStorage = new StorageAPI({
       setItem() {
         throw new DOMException('Terrible Error', 'QuotaExceededError');

packages/graphiql-toolkit/src/storage/__tests__/query.spec.ts

@@ -3,9 +3,12 @@ import { QueryStore } from '../query';
 
 class StorageMock {
   shouldThrow: () => boolean;
+  // @ts-expect-error
   count: number;
   map = {};
+  // @ts-expect-error
   storage: Storage;
+
   constructor(shouldThrow: () => boolean) {
     this.shouldThrow = shouldThrow;
   }
@@ -19,7 +22,7 @@ class StorageMock {
         isQuotaError: true,
       };
     }
-
+    // @ts-expect-error
     this.map[key] = value;
 
     return {
@@ -29,6 +32,7 @@ class StorageMock {
   }
 
   get(key: string) {
+    // @ts-expect-error
     return this.map[key] || null;
   }
 }
@@ -47,6 +51,7 @@ describe('QueryStore', () => {
 
     it('will fail silently on quota error', () => {
       let i = 0;
+      // @ts-expect-error
       const store = new QueryStore('normal', new StorageMock(() => i > 4));
 
       for (; i < 10; i++) {
@@ -78,6 +83,7 @@ describe('QueryStore', () => {
       let retryCounter = 0;
       const store = new QueryStore(
         'normal',
+        // @ts-expect-error
         new StorageMock(() => {
           retryCounter++;
           return shouldThrow();
@@ -110,6 +116,7 @@ describe('QueryStore', () => {
       let retryCounter = 0;
       const store = new QueryStore(
         'normal',
+        // @ts-expect-error
         new StorageMock(() => {
           retryCounter++;
           return shouldThrow();

packages/graphiql-toolkit/tsconfig.json

@@ -12,6 +12,5 @@
     "moduleResolution": "node",
     "types": ["vitest/globals"]
   },
-  "include": ["src", "tsup.config.ts"],
-  "exclude": ["**/*.spec.ts"]
+  "include": ["src", "tsup.config.ts", "vitest.config.mts"]
 }