Merge pull request #1803 from aeternity/feature/ts-strict

davidyuk · web-flow · commit 194588f8d328 · 2023-05-09T12:12:07.000+06:00
Enable strict mode except for `strictFunctionTypes`
diff --git a/src/AeSdkMethods.ts b/src/AeSdkMethods.ts
@@ -147,7 +147,7 @@ Object.assign(AeSdkMethods.prototype, mapObject<Function, Function>(
   methods,
   ([name, handler]) => [
     name,
-    function methodWrapper(...args: any[]) {
+    function methodWrapper(this: AeSdkMethods, ...args: any[]) {
       args.length = handler.length;
       const options = args[args.length - 1];
       args[args.length - 1] = {
diff --git a/src/AeSdkWallet.ts b/src/AeSdkWallet.ts
@@ -20,6 +20,7 @@ import {
 } from './aepp-wallet-communication/rpc/types';
 import { Encoded } from './utils/encoder';
 import jsonBig from './utils/json-big';
+import { ensureError } from './utils/other';
 
 type RpcClientWallet = RpcClient<AeppApi, WalletApi>;
 
@@ -259,6 +260,7 @@ export default class AeSdkWallet extends AeSdk {
             } catch (error) {
               const validation = await verifyTransaction(tx, this.api);
               if (validation.length > 0) throw new RpcInvalidTransactionError(validation);
+              ensureError(error);
               throw new RpcBroadcastError(error.message);
             }
           },
diff --git a/src/account/Base.ts b/src/account/Base.ts
@@ -63,5 +63,5 @@ export default abstract class AccountBase {
   /**
    * Account address
    */
-  readonly address: Encoded.AccountAddress;
+  readonly address!: Encoded.AccountAddress;
 }
diff --git a/src/aepp-wallet-communication/schema.ts b/src/aepp-wallet-communication/schema.ts
@@ -64,7 +64,7 @@ const rpcErrors: Array<(new (data?: any) => RpcError) & { code: number }> = [];
 export abstract class RpcError extends BaseError {
   static code: number;
 
-  code: number;
+  code!: number;
 
   data?: any;
 
diff --git a/src/chain.ts b/src/chain.ts
@@ -1,6 +1,6 @@
 import { AE_AMOUNT_FORMATS, formatAmount } from './utils/amount-formatter';
 import verifyTransaction, { ValidatorResult } from './tx/validator';
-import { isAccountNotFoundError, pause } from './utils/other';
+import { ensureError, isAccountNotFoundError, pause } from './utils/other';
 import { isNameValid, produceNameId } from './tx/builder/helpers';
 import { DRY_RUN_ACCOUNT } from './tx/builder/schema';
 import { AensName } from './tx/builder/constants';
@@ -208,6 +208,7 @@ export async function sendTransaction(
     }
     return { hash: txHash, rawTx: tx };
   } catch (error) {
+    ensureError(error);
     throw Object.assign(error, {
       rawTx: tx,
       verifyTx: async () => verifyTransaction(tx, onNode),
diff --git a/src/channel/Base.ts b/src/channel/Base.ts
@@ -55,7 +55,7 @@ function snakeToPascalObjKeys<Type>(obj: object): Type {
 export default class Channel {
   _eventEmitter = new EventEmitter();
 
-  _pingTimeoutId: NodeJS.Timeout;
+  _pingTimeoutId!: NodeJS.Timeout;
 
   _nextRpcMessageId = 0;
 
@@ -73,13 +73,13 @@ export default class Channel {
 
   _status: ChannelStatus = 'disconnected';
 
-  _fsm: ChannelFsm;
+  _fsm!: ChannelFsm;
 
-  _websocket: W3CWebSocket;
+  _websocket!: W3CWebSocket;
 
   _state: Encoded.Transaction | '' = '';
 
-  _options: ChannelOptions;
+  _options!: ChannelOptions;
 
   _channelId?: Encoded.Channel;
 
diff --git a/src/channel/internal.ts b/src/channel/internal.ts
@@ -15,6 +15,7 @@ import {
 } from '../utils/errors';
 import { encodeContractAddress } from '../utils/crypto';
 import { buildTx } from '../tx/builder';
+import { ensureError } from '../utils/other';
 
 export interface ChannelEvents {
   statusChanged: (status: ChannelStatus) => void;
@@ -240,6 +241,7 @@ async function dequeueMessage(channel: Channel): Promise<void> {
     try {
       await handleMessage(channel, message);
     } catch (error) {
+      ensureError(error);
       emit(channel, 'error', new ChannelIncomingMessageError(error, message));
     }
   }
diff --git a/src/contract/compiler/Cli.ts b/src/contract/compiler/Cli.ts
@@ -7,6 +7,7 @@ import CompilerBase, { Aci } from './Base';
 import { Encoded } from '../../utils/encoder';
 import { CompilerError, InternalError, UnsupportedVersionError } from '../../utils/errors';
 import semverSatisfies from '../../utils/semver-satisfies';
+import { ensureError } from '../../utils/other';
 
 const getPackagePath = (): string => {
   const path = dirname(fileURLToPath(import.meta.url));
@@ -22,7 +23,7 @@ const getPackagePath = (): string => {
 export default class CompilerCli extends CompilerBase {
   #path: string;
 
-  #ensureCompatibleVersion: Promise<void>;
+  #ensureCompatibleVersion = Promise.resolve();
 
   constructor(
     compilerPath = resolve(getPackagePath(), './bin/aesophia_cli'),
@@ -81,6 +82,7 @@ export default class CompilerCli extends CompilerBase {
         aci: aci as Aci,
       };
     } catch (error) {
+      ensureError(error);
       throw new CompilerError(error.message);
     }
   }
diff --git a/src/tx/builder/field-types/coin-amount.ts b/src/tx/builder/field-types/coin-amount.ts
@@ -5,7 +5,8 @@ import { AE_AMOUNT_FORMATS, formatAmount } from '../../../utils/amount-formatter
 export default {
   ...uInt,
 
-  serializeAettos(value: string | undefined): string {
+  // eslint-disable-next-line @typescript-eslint/no-unused-vars
+  serializeAettos(value: string | undefined, params: {}): string {
     return value ?? '0';
   },
 
diff --git a/src/tx/validator.ts b/src/tx/validator.ts
@@ -1,3 +1,4 @@
+import { RestError } from '@azure/core-rest-pipeline';
 import { hash, verify } from '../utils/crypto';
 import { TxUnpacked } from './builder/schema.generated';
 import { CtVersion, ProtocolToVmAbi } from './builder/field-types/ct-version';
@@ -183,9 +184,9 @@ validators.push(
         checkedKeys: ['contractId'],
       }];
     } catch (error) {
-      if (error.response?.parsedBody?.reason == null) throw error;
+      if (!(error instanceof RestError) || error.response?.bodyAsText == null) throw error;
       return [{
-        message: error.response.parsedBody.reason,
+        message: JSON.parse(error.response.bodyAsText).reason, // TODO: use parsedBody instead
         key: 'ContractNotFound',
         checkedKeys: ['contractId'],
       }];
diff --git a/src/utils/autorest.ts b/src/utils/autorest.ts
@@ -2,7 +2,7 @@ import { RestError, PipelineResponse, PipelinePolicy } from '@azure/core-rest-pi
 import { AdditionalPolicyConfig } from '@azure/core-client';
 import { pause } from './other';
 import semverSatisfies from './semver-satisfies';
-import { UnexpectedTsError, UnsupportedVersionError } from './errors';
+import { UnsupportedVersionError } from './errors';
 
 export const genRequestQueuesPolicy = (): AdditionalPolicyConfig => {
   const requestQueues = new Map<string, Promise<unknown>>();
@@ -126,22 +126,17 @@ export const genRetryOnFailurePolicy = (
       const intervalSum = intervals.reduce((a, b) => a + b);
       const intervalsInMs = intervals.map((el) => (el / intervalSum) * retryOverallDelay);
 
-      let error: Error | undefined;
+      let error = new RestError('Not expected to be thrown');
       for (let attempt = 0; attempt <= retryCount; attempt += 1) {
-        if (error != null) {
-          if (
-            !(error instanceof RestError)
-            || statusesToNotRetry.includes(error.response?.status ?? 0)
-          ) throw error;
-          await pause(intervalsInMs[attempt - 1]);
-        }
+        if (attempt !== 0) await pause(intervalsInMs[attempt - 1]);
         try {
           return await next(request);
         } catch (e) {
+          if (!(e instanceof RestError)) throw e;
+          if (statusesToNotRetry.includes(e.response?.status ?? 0)) throw e;
           error = e;
         }
       }
-      if (error == null) throw new UnexpectedTsError();
       throw error;
     },
   },
diff --git a/src/utils/errors.ts b/src/utils/errors.ts
@@ -401,11 +401,11 @@ export class UnexpectedChannelMessageError extends ChannelError {
  * @category exception
  */
 export class ChannelIncomingMessageError extends ChannelError {
-  handlerError: BaseError;
+  handlerError: Error;
 
   incomingMessage: { [key: string]: any };
 
-  constructor(handlerError: BaseError, incomingMessage: { [key: string]: any }) {
+  constructor(handlerError: Error, incomingMessage: { [key: string]: any }) {
     super(handlerError.message);
     this.handlerError = handlerError;
     this.incomingMessage = incomingMessage;
diff --git a/src/utils/other.ts b/src/utils/other.ts
@@ -57,3 +57,8 @@ export function isAccountNotFoundError(error: Error): boolean {
 export type UnionToIntersection<Union> =
   (Union extends any ? (k: Union) => void : never) extends ((k: infer Intersection) => void)
     ? Intersection : never;
+
+export function ensureError(error: unknown): asserts error is Error {
+  if (error instanceof Error) return;
+  throw error;
+}
diff --git a/test/integration/rpc.ts b/test/integration/rpc.ts
@@ -41,24 +41,27 @@ import { Accounts, Network } from '../../src/aepp-wallet-communication/rpc/types
 
 const WindowPostMessageFake = (
   name: string,
-): ImplPostMessage & { name: string; messages: any[] } => ({
-  name,
-  messages: [],
-  addEventListener(onEvent: string, listener: any) {
-    this.listener = listener;
-  },
-  removeEventListener() {
-    return () => null;
-  },
-  postMessage(source: any, msg: any) {
-    this.messages.push(msg);
-    setTimeout(() => {
-      if (typeof this.listener === 'function') {
-        this.listener({ data: msg, origin: 'http://origin.test', source });
-      }
-    });
-  },
-});
+): ImplPostMessage & { name: string; messages: any[] } => {
+  let listener: (event: any) => void;
+  return {
+    name,
+    messages: [],
+    addEventListener(onEvent: string, _listener: typeof listener) {
+      listener = _listener;
+    },
+    removeEventListener() {
+      return () => null;
+    },
+    postMessage(source: any, msg: any) {
+      this.messages.push(msg);
+      setTimeout(() => {
+        if (typeof listener === 'function') {
+          listener({ data: msg, origin: 'http://origin.test', source });
+        }
+      });
+    },
+  };
+};
 
 const getConnections = (): { walletWindow: ImplPostMessage; aeppWindow: ImplPostMessage } => {
   // @ts-expect-error workaround for tests
diff --git a/tsconfig.json b/tsconfig.json
@@ -9,7 +9,6 @@
     "emitDeclarationOnly": true,
     "isolatedModules": true,
     "outDir": "./es",
-    "noImplicitAny": true,
     "noImplicitOverride": true,
     "module": "es2020",
     "target": "es2020",
@@ -18,12 +17,13 @@
     "preserveConstEnums": true,
     "declaration": true,
     "downlevelIteration": true,
-    "strictNullChecks": true,
     "allowSyntheticDefaultImports": true,
     "typeRoots": [
       "./node_modules/@types",
       "./src/typings"
-    ]
+    ],
+    "strict": true,
+    "strictFunctionTypes": false, // see https://github.com/aeternity/aepp-sdk-js/issues/1793
   },
   "include": [
     "src/**/*"

Original file line number	Diff line number	Diff line change
`@@ -63,5 +63,5 @@ export default abstract class AccountBase {`
`63`	`63`	`/**`
`64`	`64`	`* Account address`
`65`	`65`	`*/`
`66`		`- readonly address: Encoded.AccountAddress;`
	`66`	`+ readonly address!: Encoded.AccountAddress;`
`67`	`67`	`}`
Original file line number	Diff line number	Diff line change
`@@ -15,6 +15,7 @@ import {`
`15`	`15`	`} from '../utils/errors';`
`16`	`16`	`import { encodeContractAddress } from '../utils/crypto';`
`17`	`17`	`import { buildTx } from '../tx/builder';`
	`18`	`+import { ensureError } from '../utils/other';`
`18`	`19`
`19`	`20`	`export interface ChannelEvents {`
`20`	`21`	`statusChanged: (status: ChannelStatus) => void;`
`@@ -240,6 +241,7 @@ async function dequeueMessage(channel: Channel): Promise<void> {`
`240`	`241`	`try {`
`241`	`242`	`await handleMessage(channel, message);`
`242`	`243`	`} catch (error) {`
	`244`	`+ ensureError(error);`
`243`	`245`	`emit(channel, 'error', new ChannelIncomingMessageError(error, message));`
`244`	`246`	`}`
`245`	`247`	`}`