fix: convert date string in websocket data (#430)

fix: remove immutable matchers fix: use generics for mockedMutations and mockedHook fix: build and tsconfig for tests fix(refactor): useless casts
graasp · Sep 22, 2023 · c6517df · c6517df
1 parent 72953a3
commit c6517df
Show file tree

Hide file tree

Showing 52 changed files with 592 additions and 477 deletions.
diff --git a/.eslintrc b/.eslintrc
@@ -98,7 +98,7 @@
     "@typescript-eslint/no-shadow": "error",
     "no-unused-vars": "off",
     "@typescript-eslint/no-unused-vars": [
-      "warn",
+      "error",
       {
         "argsIgnorePattern": "^_",
         "varsIgnorePattern": "^_",

diff --git a/babel.config.js → babel.config.cjs b/babel.config.js → babel.config.cjs
diff --git a/commitlint.config.js → commitlint.config.cjs b/commitlint.config.js → commitlint.config.cjs
diff --git a/jest.config.ts b/jest.config.ts
@@ -68,7 +68,7 @@ export default {
   // ],
 
   // An array of file extensions your modules use
-  moduleFileExtensions: ['js', 'jsx', 'ts', 'tsx', 'json', 'node'],
+  moduleFileExtensions: ['cjs', 'js', 'jsx', 'ts', 'tsx', 'json', 'node'],
 
   // A map from regular expressions to module names or to arrays of module names that allow to stub out resources with a single module
   moduleNameMapper: {
@@ -102,7 +102,7 @@ export default {
   // resetModules: false,
 
   // A path to a custom resolver
-  resolver: `${__dirname}/test/resolver.js`,
+  resolver: `${__dirname}/test/resolver.cjs`,
 
   // Automatically restore mock state between every test
   // restoreMocks: false,
@@ -122,7 +122,7 @@ export default {
   setupFiles: ['<rootDir>/test/setupTests.ts'],
 
   // A list of paths to modules that run some code to configure or set up the testing framework before each test
-  setupFilesAfterEnv: ['<rootDir>/test/setupTestsAfterEnv.ts'],
+  // setupFilesAfterEnv: ['<rootDir>/test/setupTestsAfterEnv.ts'],
 
   // The number of seconds after which a test is considered as slow and reported as such in the results.
   // slowTestThreshold: 5,
@@ -167,7 +167,7 @@ export default {
     '^.+\\.(ts|tsx)?$': [
       'ts-jest',
       {
-        tsconfig: 'tsconfig.json',
+        tsconfig: 'tsconfig.test.json',
       },
     ],
   },

diff --git a/package.json b/package.json
@@ -1,14 +1,15 @@
 {
   "name": "@graasp/query-client",
   "version": "1.8.0",
+  "type": "module",
   "workspaces": [
     "example"
   ],
   "repository": "graasp/graasp-query-client",
-  "main": "dist/index.js",
-  "module": "dist/index.modern.js",
-  "source": "src/index.ts",
-  "types": "dist/index.d.ts",
+  "main": "./dist/index.js",
+  "module": "./dist/index.modern.js",
+  "source": "./src/index.ts",
+  "types": "./dist/index.d.ts",
   "author": "Graasp",
   "contributors": [
     "Kim Lan Phan Hoang",
@@ -65,7 +66,6 @@
     "husky": "8.0.3",
     "jest": "29.6.1",
     "jest-environment-jsdom": "29.6.1",
-    "jest-immutable-matchers": "3.0.0",
     "js-cookie": "3.0.5",
     "microbundle-crl": "0.13.11",
     "mock-socket": "9.2.1",

diff --git a/src/api/action.ts b/src/api/action.ts
@@ -24,7 +24,9 @@ export const getAggregateActions = async (
   { API_HOST }: QueryClientConfig,
 ) =>
   axios
-    .get(`${API_HOST}/${buildGetAggregateActions(args)}`)
+    .get<{ aggregateResult: number; createdDay: string }[]>(
+      `${API_HOST}/${buildGetAggregateActions(args)}`,
+    )
     .then(({ data }) => data);
 
 export const exportActions = async (

diff --git a/src/api/itemTag.ts b/src/api/itemTag.ts
@@ -40,7 +40,7 @@ export const postItemTag = async (
   );
 
 export const deleteItemTag = async (
-  { itemId, type }: { itemId: UUID; type: ItemTagType },
+  { itemId, type }: { itemId: UUID; type: `${ItemTagType}` | ItemTagType },
   { API_HOST }: QueryClientConfig,
 ) =>
   verifyAuthentication(() =>

diff --git a/src/hooks/action.test.ts b/src/hooks/action.test.ts
@@ -5,8 +5,8 @@ import {
   AggregateMetric,
   Context,
   CountGroupBy,
-  convertJs,
 } from '@graasp/sdk';
+import { ActionDataRecord, ImmutableCast } from '@graasp/sdk/frontend';
 
 import { StatusCodes } from 'http-status-codes';
 import Cookies from 'js-cookie';
@@ -22,6 +22,10 @@ import { mockHook, setUpTest } from '../../test/utils';
 import { buildGetActions, buildGetAggregateActions } from '../api/routes';
 import { buildActionsKey, buildAggregateActionsKey } from '../config/keys';
 
+type AggregateActionsResponse = ImmutableCast<
+  { aggregateResult: number; createdDay: string }[]
+>;
+
 const { hooks, wrapper, queryClient } = setUpTest();
 const itemId = ITEMS.first()!.id;
 
@@ -44,12 +48,14 @@ describe('Action Hooks', () => {
 
     it(`Receive actions for item id`, async () => {
       const hook = () => hooks.useActions(args);
-      const endpoints = [{ route, response: response.toJS() }];
+      const endpoints = [{ route, response }];
       const { data } = await mockHook({ endpoints, hook, wrapper });
-      expect(data).toEqualImmutable(response);
+      expect(data?.toJS()).toEqual(response);
 
       // verify cache keys
-      expect(queryClient.getQueryData(key)).toEqualImmutable(response);
+      expect(queryClient.getQueryData<ActionDataRecord>(key)?.toJS()).toEqual(
+        response,
+      );
     });
 
     it(`Sample size = 0 does not fetch`, async () => {
@@ -124,23 +130,23 @@ describe('Action Hooks', () => {
       const hook = () => hooks.useAggregateActions(args);
       const endpoints = [{ route, response }];
       const { data } = await mockHook({ endpoints, hook, wrapper });
-      expect(data).toEqualImmutable(convertJs(response));
+      expect(data?.toJS()).toEqual(response);
 
       // verify cache keys
-      expect(queryClient.getQueryData(key)).toEqualImmutable(
-        convertJs(response),
-      );
+      expect(
+        queryClient.getQueryData<AggregateActionsResponse>(key)?.toJS(),
+      ).toEqual(response);
     });
     it(`Receive aggregate actions for item id`, async () => {
       const hook = () => hooks.useAggregateActions(args);
       const endpoints = [{ route, response }];
       const { data } = await mockHook({ endpoints, hook, wrapper });
-      expect(data).toEqualImmutable(convertJs(response));
+      expect(data?.toJS()).toEqual(response);
 
       // verify cache keys
-      expect(queryClient.getQueryData(key)).toEqualImmutable(
-        convertJs(response),
-      );
+      expect(
+        queryClient.getQueryData<AggregateActionsResponse>(key)?.toJS(),
+      ).toEqual(response);
     });
 
     it(`Unauthorized`, async () => {

diff --git a/src/hooks/action.ts b/src/hooks/action.ts
@@ -1,5 +1,5 @@
 import { UUID, convertJs } from '@graasp/sdk';
-import { ActionDataRecord } from '@graasp/sdk/frontend';
+import { ActionDataRecord, ImmutableCast } from '@graasp/sdk/frontend';
 
 import { useQuery } from 'react-query';
 
@@ -26,7 +26,7 @@ export default (queryConfig: QueryClientConfig) => {
       Boolean(args.requestedSampleSize);
     return useQuery({
       queryKey: buildActionsKey(args),
-      queryFn: () => {
+      queryFn: (): Promise<ActionDataRecord> => {
         const { itemId } = args;
         if (!itemId) {
           throw new UndefinedArgument();
@@ -38,7 +38,7 @@ export default (queryConfig: QueryClientConfig) => {
             requestedSampleSize: args.requestedSampleSize,
           },
           queryConfig,
-        ).then((data) => convertJs(data) as ActionDataRecord);
+        ).then((data) => convertJs(data));
       },
       ...defaultQueryOptions,
       enabled: enabledValue,
@@ -56,7 +56,9 @@ export default (queryConfig: QueryClientConfig) => {
       Boolean(args.requestedSampleSize);
     return useQuery({
       queryKey: buildAggregateActionsKey(args),
-      queryFn: () => {
+      queryFn: (): Promise<
+        ImmutableCast<{ aggregateResult: number; createdDay: string }[]>
+      > => {
         const { itemId } = args;
         if (!itemId) {
           throw new UndefinedArgument();

diff --git a/src/hooks/apps.test.ts b/src/hooks/apps.test.ts
@@ -31,10 +31,12 @@ describe('Apps Hooks', () => {
       const endpoints = [{ route, response }];
       const { data } = await mockHook({ endpoints, hook, wrapper });
 
-      expect(data as List<AppRecord>).toEqualImmutable(response);
+      expect(data?.toJS()).toEqual(response);
 
       // verify cache keys
-      expect(queryClient.getQueryData(key)).toEqualImmutable(response);
+      expect(queryClient.getQueryData<List<AppRecord>>(key)?.toJS()).toEqual(
+        response,
+      );
     });
 
     it(`Unauthorized`, async () => {

diff --git a/src/hooks/category.test.ts b/src/hooks/category.test.ts
@@ -1,8 +1,6 @@
 /* eslint-disable import/no-extraneous-dependencies */
-import { CategoryRecord, ItemCategoryRecord } from '@graasp/sdk/frontend';
-
 import { StatusCodes } from 'http-status-codes';
-import { List, Record, RecordOf } from 'immutable';
+import Immutable, { List, Record, RecordOf } from 'immutable';
 import Cookies from 'js-cookie';
 import nock from 'nock';
 
@@ -52,7 +50,7 @@ describe('Category Hooks', () => {
   //     const endpoints = [{ route, response }];
   //     const { data } = await mockHook({ endpoints, hook, wrapper });
 
-  //     expect(data as List<CategoryTypeRecord>).toEqualImmutable(response);
+  //     expect(data).toEqualImmutable(response);
 
   //     // verify cache keys
   //     expect(queryClient.getQueryData(key)).toEqualImmutable(response);
@@ -90,10 +88,12 @@ describe('Category Hooks', () => {
       const endpoints = [{ route, response }];
       const { data } = await mockHook({ endpoints, hook, wrapper });
 
-      expect(data as List<CategoryRecord>).toEqualImmutable(response);
+      expect(Immutable.is(data, response)).toBeTruthy();
 
       // verify cache keys
-      expect(queryClient.getQueryData(key)).toEqualImmutable(response);
+      expect(
+        Immutable.is(queryClient.getQueryData(key), response),
+      ).toBeTruthy();
     });
     it(`Unauthorized`, async () => {
       const endpoints = [
@@ -128,10 +128,12 @@ describe('Category Hooks', () => {
       const endpoints = [{ route, response }];
       const { data } = await mockHook({ endpoints, hook, wrapper });
 
-      expect(data as CategoryRecord).toEqualImmutable(response);
+      expect(Immutable.is(data, response)).toBeTruthy();
 
       // verify cache keys
-      expect(queryClient.getQueryData(key)).toEqualImmutable(response);
+      expect(
+        Immutable.is(queryClient.getQueryData(key), response),
+      ).toBeTruthy();
     });
     it(`Unauthorized`, async () => {
       const endpoints = [
@@ -166,12 +168,12 @@ describe('Category Hooks', () => {
       const endpoints = [{ route, response }];
       const { data } = await mockHook({ endpoints, hook, wrapper });
 
-      expect(data as List<ItemCategoryRecord>).toEqualImmutable(response);
+      expect(Immutable.is(data, response)).toBeTruthy();
 
       // verify cache keys
       expect(
-        queryClient.getQueryData(key) as List<ItemCategoryRecord>,
-      ).toEqualImmutable(response);
+        Immutable.is(queryClient.getQueryData(key), response),
+      ).toBeTruthy();
     });
 
     it(`Unauthorized`, async () => {
@@ -212,12 +214,12 @@ describe('Category Hooks', () => {
       const endpoints = [{ route, response }];
       const { data } = await mockHook({ endpoints, hook, wrapper });
 
-      expect(data as List<ItemIdRecord>).toEqualImmutable(response);
+      expect(Immutable.is(data, response)).toBeTruthy();
 
       // verify cache keys
       expect(
-        queryClient.getQueryData(key) as List<ItemIdRecord>,
-      ).toEqualImmutable(response);
+        Immutable.is(queryClient.getQueryData(key), response),
+      ).toBeTruthy();
     });
     it(`Unauthorized`, async () => {
       const endpoints = [

diff --git a/src/hooks/chat.test.ts b/src/hooks/chat.test.ts
@@ -3,6 +3,7 @@ import { ChatMessage } from '@graasp/sdk';
 import { ExportedItemChatRecord, ItemChatRecord } from '@graasp/sdk/frontend';
 
 import { StatusCodes } from 'http-status-codes';
+import Immutable from 'immutable';
 import Cookies from 'js-cookie';
 import nock from 'nock';
 
@@ -57,10 +58,12 @@ describe('Chat Hooks', () => {
         wrapper,
       });
 
-      expect(data as ItemChatRecord).toEqualImmutable(response);
+      expect(Immutable.is(data, response)).toBeTruthy();
 
       // verify cache keys
-      expect(queryClient.getQueryData(key)).toEqualImmutable(response);
+      expect(
+        Immutable.is(queryClient.getQueryData(key), response),
+      ).toBeTruthy();
     });
 
     it(`Unauthorized`, async () => {
@@ -113,10 +116,12 @@ describe('Chat Hooks', () => {
         wrapper,
       });
 
-      expect(data).toEqualImmutable(response);
+      expect(Immutable.is(data, response)).toBeTruthy();
 
       // verify cache keys
-      expect(queryClient.getQueryData(key)).toEqualImmutable(response);
+      expect(
+        Immutable.is(queryClient.getQueryData(key), response),
+      ).toBeTruthy();
     });
 
     it(`getUpdates = false`, async () => {
@@ -134,10 +139,12 @@ describe('Chat Hooks', () => {
         wrapper,
       });
 
-      expect(data).toEqualImmutable(response);
+      expect(Immutable.is(data, response)).toBeTruthy();
 
       // verify cache keys
-      expect(queryClient.getQueryData(key)).toEqualImmutable(response);
+      expect(
+        Immutable.is(queryClient.getQueryData(key), response),
+      ).toBeTruthy();
     });
   });
 
@@ -175,10 +182,12 @@ describe('Chat Hooks', () => {
         wrapper,
       });
 
-      expect(data as ExportedItemChatRecord).toEqualImmutable(response);
+      expect(Immutable.is(data, response)).toBeTruthy();
 
       // verify cache keys
-      expect(queryClient.getQueryData(key)).toEqualImmutable(response);
+      expect(
+        Immutable.is(queryClient.getQueryData(key), response),
+      ).toBeTruthy();
     });
 
     it(`Unauthorized`, async () => {