feat: new error handling

.github/workflows/ci.yml

@@ -26,9 +26,9 @@ jobs:
       init-commands: |
         pnpm nx-cloud start-ci-run --stop-agents-after="build" --agent-count=3
       parallel-commands-on-agents: |
-        pnpm nx affected --target=lint --parallel=3
-        pnpm nx affected --target=test:ci --parallel=3
-        pnpm nx affected --target=build --parallel=3
+        pnpm nx affected --target=lint --exclude @blockchain-lab-um/website --parallel=3
+        pnpm nx affected --target=test:ci --exclude @blockchain-lab-um/website --parallel=3
+        pnpm nx affected --target=build --exclude @blockchain-lab-um/website --parallel=3
 
   agents:
     name: Nx Cloud - Agents

libs/utils/.eslintrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  root: true,
+  extends: ['../../.eslintrc.js'],
+  parserOptions: {
+    project: './tsconfig.eslint.json',
+    sourceType: 'module',
+    tsconfigRootDir: __dirname,
+  },
+  rules: {},
+};

libs/utils/.lintstagedrc.js

@@ -0,0 +1,4 @@
+module.exports = {
+  '*.{js,ts}': ['eslint --fix'],
+  '*.{md,json,yml,yaml}': ['prettier --write'],
+};

libs/utils/.prettierignore

@@ -0,0 +1,4 @@
+dist
+node_modules
+coverage
+CHANGELOG.md

libs/utils/README.md

@@ -0,0 +1,10 @@
+# Utils
+
+Library containing utility functions used thought the monorepo.
+
+## License
+
+This project is dual-licensed under Apache 2.0 and MIT terms:
+
+- Apache License, Version 2.0, ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
+- MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)

libs/utils/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@blockchain-lab-um/utils",
+  "version": "1.0.0",
+  "private": "true",
+  "description": "Helper utilities for SSI Snap monorepo",
+  "keywords": [],
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/blockchain-lab-um/ssi-snap.git"
+  },
+  "license": "(Apache-2.0 AND MIT)",
+  "author": {
+    "name": "Blockchain Lab:UM",
+    "email": "blockchain-lab@um.si",
+    "url": "https://blockchain-lab.um.si"
+  },
+  "main": "dist/index.js",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist/",
+    "package.json",
+    "README.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "build": "pnpm clean && pnpm compile",
+    "clean": "rimraf dist",
+    "compile": "tsc --build tsconfig.build.json",
+    "lint": "pnpm lint:eslint && pnpm lint:prettier",
+    "lint:eslint": "eslint .",
+    "lint:prettier": "prettier . --check"
+  },
+  "devDependencies": {
+    "rimraf": "^3.0.2",
+    "typescript": "^4.9.5"
+  }
+}

libs/utils/src/index.ts

@@ -0,0 +1 @@
+export * from './result';

libs/utils/src/result.ts

@@ -0,0 +1,30 @@
+export type Result<T> = {
+  success: boolean;
+} & (
+  | {
+      success: true;
+      data: T;
+    }
+  | {
+      success: false;
+      error: Error;
+    }
+);
+
+export const isError = <T>(
+  result: Result<T>
+): result is { success: false; error: Error } => !result.success;
+
+export const isSuccess = <T>(
+  result: Result<T>
+): result is { success: true; data: T } => result.success;
+
+export class ResultObject {
+  static success<T>(data: T): Result<T> {
+    return { success: true, data };
+  }
+
+  static error<T>(error: Error): Result<T> {
+    return { success: false, error };
+  }
+}

libs/utils/tsconfig.build.json

@@ -0,0 +1,8 @@
+{
+  "extends": "./tsconfig.json",
+  "exclude": [
+    // Exclude all test files
+    "tests/**/*",
+    "*.spec.ts"
+  ]
+}

libs/utils/tsconfig.eslint.json

@@ -0,0 +1,4 @@
+{
+  "extends": "./tsconfig.json",
+  "include": ["**/*", ".eslintrc.js"]
+}

libs/utils/tsconfig.json

@@ -0,0 +1,13 @@
+{
+  "extends": "../../tsconfig.base.json",
+  "compilerOptions": {
+    "experimentalDecorators": true,
+    "outDir": "./dist",
+    "baseUrl": ".",
+    "typeRoots": ["./node_modules/@types", "../../node_modules/@types"],
+    "declaration": true,
+    "inlineSourceMap": true
+  },
+  "files": [],
+  "include": ["src/**/*", "tests/**/*"]
+}

package.json

@@ -28,15 +28,15 @@
     "packages/*"
   ],
   "scripts": {
-    "build": "pnpm nx affected --target=build",
+    "build": "pnpm nx affected --target=build --exclude @blockchain-lab-um/website",
     "build:all": "pnpm nx run-many --target=build --all",
     "build:connector": "pnpm nx build @blockchain-lab-um/ssi-snap-connector",
     "build:docker": "pnpm nx run-many --target=build --projects=@blockchain-lab-um/ssi-snap-docs,@blockchain-lab-um/website && pnpm nx run @blockchain-lab-um/dapp:build:docker",
     "build:docs": "pnpm nx build @blockchain-lab-um/ssi-snap-docs",
     "build:vcmanager": "pnpm nx build @blockchain-lab-um/veramo-vc-manager",
     "deploy:docs": "pnpm nx deploy @blockchain-lab-um/ssi-snap-docs",
     "docker:build": "docker build . -t blockchain-lab-um/ssi-snap",
-    "lint": "pnpm prettier && pnpm nx affected --target=lint",
+    "lint": "pnpm prettier && pnpm nx affected --target=lint --exclude @blockchain-lab-um/website",
     "lint:all": "pnpm prettier && pnpm nx run-many --target=lint --all",
     "prepare": "is-ci || husky install",
     "prettier": "prettier --write .",
@@ -45,9 +45,9 @@
     "start:dapp": "pnpm nx start @blockchain-lab-um/website",
     "start:docs": "pnpm nx start @blockchain-lab-um/ssi-snap-docs",
     "start:snap": "pnpm nx start @blockchain-lab-um/ssi-snap",
-    "test": "pnpm nx affected --target=test",
+    "test": "pnpm nx affected --target=test --exclude @blockchain-lab-um/website",
     "test:all": "pnpm nx run-many --target=test --all",
-    "test:ci": "pnpm nx affected --target=test:ci"
+    "test:ci": "pnpm nx affected --target=test:ci --exclude @blockchain-lab-um/website"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.4.4",

packages/connector/package.json

@@ -39,6 +39,8 @@
   },
   "dependencies": {
     "@blockchain-lab-um/ssi-snap-types": "*",
+    "@blockchain-lab-um/utils": "*",
+    "@metamask/detect-provider": "^2.0.0",
     "@veramo/core": "^5.0.0"
   },
   "devDependencies": {

packages/connector/src/index.ts

@@ -1,81 +1,106 @@
-import { AvailableMethods } from '@blockchain-lab-um/ssi-snap-types';
-
-import { MetaMaskSSISnap } from './snap';
 import {
-  hasMetaMask,
-  isMetamaskSnapsSupported,
-  isSnapInstalled,
-} from './utils';
+  AvailableMethods,
+  isAvailableMethods,
+} from '@blockchain-lab-um/ssi-snap-types';
+import { Result, ResultObject, isError } from '@blockchain-lab-um/utils';
+import detectEthereumProvider from '@metamask/detect-provider';
 
-const defaultSnapOrigin = 'npm:@blockchain-lab-um/ssi-snap';
+import { MetaMaskSSISnap } from './snap';
 
 export { MetaMaskSSISnap } from './snap';
-export {
-  hasMetaMask,
-  isMetamaskSnapsSupported,
-  isSnapInstalled,
-} from './utils';
+export { isSnapInstalled } from './utils';
 
 export type SnapInstallationParams = {
   snapId?: string;
   version?: string;
   supportedMethods?: Array<AvailableMethods>;
 };
 
+const defaultSnapOrigin = 'npm:@blockchain-lab-um/ssi-snap';
+
 /**
  * Install and enable SSI Snap
  *
- * Checks for existence of Metamask and version compatibility with snaps before installation.
- *
+ * Checks for existence of MetaMask Flask and installs SSI Snap if not installed
  *
  * @param snapInstallationParams - set snapID, version and a list of supported methods
  *
- *
  * @return MetaMaskSSISnap - adapter object that exposes snap API
  */
 export async function enableSSISnap(
   snapInstallationParams: SnapInstallationParams = {}
-): Promise<MetaMaskSSISnap> {
+): Promise<Result<MetaMaskSSISnap>> {
   const {
     snapId = defaultSnapOrigin,
-    version = 'latest',
+    version = '^1.4.0',
     supportedMethods = ['did:ethr'],
   } = snapInstallationParams;
 
-  // check all conditions
-  if (!hasMetaMask()) {
-    throw new Error('Metamask is not installed');
+  // This resolves to the value of window.ethereum or null
+  const provider = await detectEthereumProvider({ mustBeMetaMask: true });
+
+  if (!provider) {
+    return ResultObject.error(new Error('No provider found'));
   }
-  if (!(await isMetamaskSnapsSupported())) {
-    throw new Error("Current Metamask version doesn't support snaps");
+
+  // web3_clientVersion returns the installed MetaMask version as a string
+  const mmVersion: string = await window.ethereum.request({
+    method: 'web3_clientVersion',
+  });
+
+  if (!mmVersion.includes('flask')) {
+    return ResultObject.error(
+      new Error('MetaMask is not supported. Please install MetaMask Flask.')
+    );
   }
 
-  const isInstalled = await isSnapInstalled(snapId, version);
+  // FIXME (martin): I don't think we need this check anymore
+  // wallet_requestSnaps handles this and allows the use of semver ranges
+
+  // const isInstalled = await isSnapInstalled(snapId, version);
 
-  if (!isInstalled) {
+  // if (isError(isInstalled)) {
+  //   return ResultObject.error(isInstalled.error);
+  // }
+
+  try {
     await window.ethereum.request({
       method: 'wallet_requestSnaps',
       params: {
         [snapId]: { version },
       },
     });
-  }
 
-  // create snap describer
-  const snap = new MetaMaskSSISnap(snapId, supportedMethods);
-
-  // initialize snap
-  const snapApi = await snap.getSSISnapApi();
-  console.log('Getting DID method...');
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-assignment, @typescript-eslint/no-unsafe-call
-  const method = await snapApi.getSelectedMethod();
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-argument
-  if (!snap.supportedMethods.includes(method as AvailableMethods)) {
-    console.log('Switching method...', method, snap.supportedMethods[0]);
-    // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-    await snapApi.switchDIDMethod(snap.supportedMethods[0]);
-  }
+    const snap = new MetaMaskSSISnap(snapId, supportedMethods);
+
+    const snapApi = snap.getSSISnapApi();
+
+    const selectedMethodsResult = await snapApi.getSelectedMethod();
+
+    if (isError(selectedMethodsResult)) {
+      return ResultObject.error(selectedMethodsResult.error);
+    }
 
-  // return snap object
-  return snap;
+    const method = selectedMethodsResult.data;
+
+    if (!isAvailableMethods(method)) {
+      const switchResult = await snapApi.switchDIDMethod(
+        snap.supportedMethods[0]
+      );
+
+      if (isError(switchResult)) {
+        return ResultObject.error(switchResult.error);
+      }
+
+      if (!switchResult.data) {
+        return ResultObject.error(
+          new Error('Could not switch to supported DID method')
+        );
+      }
+    }
+
+    return ResultObject.success(snap);
+  } catch (err: unknown) {
+    return ResultObject.error(err as Error);
+  }
 }