Refactor to merge ViewController and PayloadTransport classes (#203)

* (feat): Added 'web3-core' package v1.5.2 to import the new AbstractProvider Type * (feat): fix #83 * First step to refactoring 'PayloadTransport' into 'ViewController' * Fix remaining tests * Update 'peerDependencies' for @magic-sdk/commons * Fix clean script Co-authored-by: Adenekan Wonderful <[email protected]>
magiclabs · smithki · Sep 10, 2021 · Sep 1, 2021 · Sep 1, 2021 · Sep 1, 2021
commit d258eeb59fd11bcf91320d02c8f1cf9911fb200e
diff --git a/.eslintignore b/.eslintignore
@@ -1,4 +1,5 @@
 **/node_modules
+**/coverage
 **/dist
 **/.eslintrc.js
 **/jest.config.ts

diff --git a/.eslintrc → .eslintrc.js b/.eslintrc → .eslintrc.js
@@ -1,32 +1,38 @@
-{
- "root": true,
+module.exports = {
+ root: true,
 
- "extends": ["@ikscodes/eslint-config"],
+ extends: ["@ikscodes/eslint-config"],
 
- "rules": {
- "import/extensions": 0,
+ rules: {
+ // ESLint rules
  "no-alert": 0,
- "@typescript-eslint/await-thenable": 0,
+ "no-underscore-dangle": 0,
  "no-useless-constructor": 0,
- "@typescript-eslint/no-useless-constructor": 0,
- "@typescript-eslint/no-empty-function": 0,
+ "class-methods-use-this": 0,
+
+ // Import rules
+ "import/extensions": 0,
+ "import/no-extraneous-dependencies": 0,
+
+ // TypeScript rules
+ "@typescript-eslint/ban-types": 0,
+ "@typescript-eslint/no-unsafe-call": 0,
+ "@typescript-eslint/await-thenable": 0,
  "@typescript-eslint/no-unsafe-return": 0,
+ "@typescript-eslint/no-empty-function": 0,
+ "@typescript-eslint/no-floating-promises": 0,
  "@typescript-eslint/no-unsafe-assignment": 0,
+ "@typescript-eslint/no-useless-constructor": 0,
  "@typescript-eslint/no-unsafe-member-access": 0,
- "@typescript-eslint/no-floating-promises": 0,
- "@typescript-eslint/no-unsafe-call": 0,
- "@typescript-eslint/ban-types": 0,
  "@typescript-eslint/explicit-module-boundary-types": 0,
  "@typescript-eslint/restrict-template-expressions": 0,
- "class-methods-use-this": 0,
- "import/no-extraneous-dependencies": 0
  },
 
- "settings": {
+ settings: {
  "import/resolver": {
  "typescript": {
- "directory": ["**/tsconfig.json"]
- }
- }
- }
+ "directory": ["**/tsconfig.json"],
+ },
+ },
+ },
 }
diff --git a/packages/@magic-sdk/commons/.eslintignore b/packages/@magic-sdk/commons/.eslintignore
@@ -1,4 +1,5 @@
 /node_modules
+/coverage
 /dist
 /.eslintrc.js
 /jest.config.ts
diff --git a/packages/@magic-sdk/commons/.eslintrc.js b/packages/@magic-sdk/commons/.eslintrc.js
@@ -1,5 +1,5 @@
 module.exports = {
- extends: ['../../../.eslintrc'],
+ extends: ['../../../.eslintrc.js'],
  parserOptions: {
  project: ['./tsconfig.json'],
  tsconfigRootDir: __dirname,

diff --git a/packages/@magic-sdk/commons/package.json b/packages/@magic-sdk/commons/package.json
@@ -19,8 +19,8 @@
  "module": "dist/es/index.js",
  "types": "dist/es/index.d.ts",
  "peerDependencies": {
- "@magic-sdk/provider": "^4.3.0",
- "@magic-sdk/types": "^3.1.1",
+ "@magic-sdk/provider": ">=4.3.0",
+ "@magic-sdk/types": ">=3.1.1",
  "tslib": "^2.0.3"
  },
  "gitHead": "1ef062ea699d48d5e9a9375a93b7c147632b05ca"

diff --git a/packages/@magic-sdk/provider/.eslintignore b/packages/@magic-sdk/provider/.eslintignore
@@ -1,4 +1,5 @@
 /node_modules
+/coverage
 /dist
 /.eslintrc.js
 /jest.config.ts
diff --git a/packages/@magic-sdk/provider/.eslintrc.js b/packages/@magic-sdk/provider/.eslintrc.js
@@ -1,5 +1,5 @@
 module.exports = {
- extends: ['../../../.eslintrc'],
+ extends: ['../../../.eslintrc.js'],
  parserOptions: {
  project: ['./tsconfig.json', './test/tsconfig.json'],
  tsconfigRootDir: __dirname,

diff --git a/packages/@magic-sdk/provider/src/README.md b/packages/@magic-sdk/provider/src/README.md
@@ -16,7 +16,7 @@ There are numerous code paths that [`./modules`](./modules) can follow to intera
 // `magic.auth` and `magic.user` methods follow this pattern.
 magic.user.getMetadata();
 
-BaseModule.request -> PayloadTransport.post -> Window.postMessage -> iframe
+BaseModule.request -> ViewController.post -> Window.postMessage -> iframe
 ```
 
 ### Case #2: Web3 `>=1.0.0-beta.38` using `send`
@@ -26,7 +26,7 @@ This represents the most current behavior of Web3:
 ```ts
 web3.eth.sendTransaction(...);
 
-RPCProviderModule.send -> BaseModule.request -> PayloadTransport.post -> Window.postMessage -> iframe
+RPCProviderModule.send -> BaseModule.request -> ViewController.post -> Window.postMessage -> iframe
 ```
 
 ### Case #3: Web3 `<=1.0.0-beta.37` using `send`
@@ -36,7 +36,7 @@ This is an edge case affecting a small subset of Web3 pre-`1.x` beta versions:
 ```ts
 web3.eth.sendTransaction(...);
 
-RPCProviderModule.send -> RPCProviderModule.sendAsync -> PayloadTransport.post -> Window.postMessage -> iframe
+RPCProviderModule.send -> RPCProviderModule.sendAsync -> ViewController.post -> Window.postMessage -> iframe
 ```
 
 ### Case #4: Legacy Web3 using `sendAsync`
@@ -46,7 +46,7 @@ This is the legacy behavior of Web3 providers, though it is still widely support
 ```ts
 web3.eth.sendTransaction(...);
 
-RPCProviderModule.sendAsync -> PayloadTransport.post -> Window.postMessage -> iframe
+RPCProviderModule.sendAsync -> ViewController.post -> Window.postMessage -> iframe
 ```
 
 ## React Native

diff --git a/packages/@magic-sdk/provider/src/core/json-rpc.ts b/packages/@magic-sdk/provider/src/core/json-rpc.ts
@@ -1,4 +1,4 @@
-/* eslint-disable no-underscore-dangle, no-param-reassign */
+/* eslint-disable no-param-reassign */
 
 import { JsonRpcRequestPayload, JsonRpcResponsePayload, JsonRpcError } from '@magic-sdk/types';
 import { isJsonRpcResponsePayload } from '../util/type-guards';

diff --git a/packages/@magic-sdk/provider/src/core/payload-transport.ts b/packages/@magic-sdk/provider/src/core/payload-transport.ts
diff --git a/packages/@magic-sdk/provider/src/core/sdk-environment.ts b/packages/@magic-sdk/provider/src/core/sdk-environment.ts
@@ -1,6 +1,5 @@
 import localForage from 'localforage';
 import { ViewController } from './view-controller';
-import { PayloadTransport } from './payload-transport';
 import { SDKBase } from './sdk';
 import { WithExtensions } from '../modules/base-extension';
 
@@ -16,7 +15,6 @@ export interface SDKEnvironment {
  platform: 'web' | 'react-native';
  defaultEndpoint: string;
  ViewController: ConstructorOf<ViewController>;
- PayloadTransport: ConstructorOf<PayloadTransport>;
  configureStorage: () => Promise<typeof localForage>;
 }