Apply ts-expect-error to flaky immer type errors

MetaMask · Aug 2, 2024 · f8b78d5 · f8b78d5
1 parent c19b225
commit f8b78d5
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/packages/accounts-controller/src/AccountsController.ts b/packages/accounts-controller/src/AccountsController.ts
@@ -444,8 +444,7 @@ export class AccountsController extends BaseController<
         metadata: { ...account.metadata, ...metadata },
       };
       // Do not remove this comment - This error is flaky: Comment out or restore the `ts-expect-error` directive below as needed.
-      // See: https://github.com/MetaMask/utils/issues/168
-      // // @ts-expect-error Known issue - `Json` causes recursive error in immer `Draft`/`WritableDraft` types
+      // // @ts-expect-error - Known issue: `Json` causes recursive error in immer `Draft`/`WritableDraft` types (See: https://github.com/MetaMask/utils/issues/168)
       currentState.internalAccounts.accounts[accountId] = internalAccount;
     });
   }

diff --git a/packages/permission-controller/src/PermissionController.ts b/packages/permission-controller/src/PermissionController.ts
@@ -1369,6 +1369,8 @@ export class PermissionController<
         );
 
         if (caveatIndex === -1) {
+          // Do not remove this comment - This error is flaky: Comment out or restore the `ts-expect-error` directive below as needed.
+          // // @ts-expect-error - Known issue: `Json` causes recursive error in immer `Draft`/`WritableDraft` types (See: https://github.com/MetaMask/utils/issues/168)
           permission.caveats.push(caveat);
         } else {
           permission.caveats.splice(caveatIndex, 1, caveat);

diff --git a/packages/permission-controller/src/SubjectMetadataController.ts b/packages/permission-controller/src/SubjectMetadataController.ts
@@ -235,7 +235,8 @@ export class SubjectMetadataController extends BaseController<
    */
   trimMetadataState(): void {
     this.update((draftState) => {
-      // @ts-expect-error ts(2589)
+      // Do not remove this comment - This error is flaky: Comment out or restore the `ts-expect-error` directive below as needed.
+      // @ts-expect-error - Known issue: `Json` causes recursive error in immer `Draft`/`WritableDraft` types (See: https://github.com/MetaMask/utils/issues/168)
       return SubjectMetadataController.getTrimmedState(
         draftState,
         this.subjectHasPermissions,