build: convert veramo modules to ESM instead of CommonJS (#1103)

BREAKING CHANGE: this is a breaking change as modules will have to be imported differently: * https://www.typescriptlang.org/docs/handbook/esm-node.html * https://nodejs.org/api/esm.html * https://caniuse.com/?search=modules test(did-provider-ion): skip a couple of tests that fail with unreasonable errors chore: use ubuntu-latest on CI fix: temporarily remove puppeteer tests fix: use craco for test-react-app to enable babel config test: fix unit and integration tests (browser tests still broken) fix: fix some build issues that prevented tests from working fix: missing deps flagged by pnpm build: migrate esm branch from yarn to pnpm (#1099) fix: remove schemas fix: use requireCjs for importing JSON files build: use local veramo cli in CI scripts build: fix api-extractor and schema generation scripts fix(cli): esm objectCreator fix(cli): ignore types in schema generation fix: requireCjs refactor: convert all modules to ESM Co-authored-by: nickreynolds <nicholas.s.reynolds@gmail.com>
decentralized-identity · Jan 30, 2023 · b5cea3c · b5cea3c
1 parent 17a7c51
commit b5cea3c
Show file tree

Hide file tree

Showing 216 changed files with 2,438 additions and 1,540 deletions.
diff --git a/.github/workflows/build-and-test-on-pr.yml b/.github/workflows/build-and-test-on-pr.yml
@@ -2,7 +2,7 @@ name: Build and Test PR
 on: [pull_request, workflow_dispatch]
 jobs:
   build-test:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     services:
       postgres:
         image: postgres:15.1
@@ -23,7 +23,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 18
           cache: 'pnpm'
 
       - run: pnpm install

diff --git a/.github/workflows/build-test-publish-on-push.yml b/.github/workflows/build-test-publish-on-push.yml
@@ -15,7 +15,7 @@ jobs:
       GH_TOKEN: ${{secrets.GH_TOKEN}}
       GH_USER: ${{secrets.GH_USER}}
       GH_EMAIL: ${{secrets.GH_EMAIL}}
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     services:
       postgres:
         image: postgres:15.1
@@ -36,7 +36,7 @@ jobs:
       - name: Use Node.js
         uses: actions/setup-node@v3
         with:
-          node-version: 14
+          node-version: 18
           cache: 'pnpm'
 
       - run: pnpm install
@@ -54,6 +54,8 @@ jobs:
       - name: run browser tests
         run: pnpm test:browser
 
+      - run: pnpm run docs
+
       - name: setup git coordinates
         run: |
           git remote set-url origin https://uport-project:$GH_TOKEN@github.com/uport-project/veramo.git

diff --git a/.github/workflows/sync-next-with-latest.yml b/.github/workflows/sync-next-with-latest.yml
@@ -6,7 +6,7 @@ on:
       - 'main'
 jobs:
   merge-branch:
-    runs-on: ubuntu-18.04
+    runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
       - uses: everlytic/branch-merge@1.1.5

diff --git a/README.md b/README.md
@@ -66,6 +66,7 @@ This monorepo uses [pnpm](https://pnpm.io/) and [lerna](https://lerna.js.org/)
 Install dependencies
 
 ```bash
+npm -g i pnpm
 pnpm install
 ```
 

diff --git a/__tests__/initial.migration.test.ts b/__tests__/initial.migration.test.ts
@@ -40,6 +40,13 @@ import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
 import * as fs from 'fs'
 
+import { jest } from '@jest/globals'
+import { fileURLToPath } from 'url';
+import { dirname } from 'path';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
 jest.setTimeout(60000)
 
 const infuraProjectId = '3586660d179141e3801c3895de1c2eba'

diff --git a/__tests__/localAgent.test.ts b/__tests__/localAgent.test.ts
@@ -66,6 +66,8 @@ import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
 import { contexts as credential_contexts } from '@transmute/credentials-context'
 import * as fs from 'fs'
+import { jest } from '@jest/globals'
+
 // Shared tests
 import verifiableDataJWT from './shared/verifiableDataJWT'
 import verifiableDataLD from './shared/verifiableDataLD'

diff --git a/__tests__/localJsonStoreAgent.test.ts b/__tests__/localJsonStoreAgent.test.ts
@@ -56,6 +56,7 @@ import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
 import { contexts as credential_contexts } from '@transmute/credentials-context'
 import * as fs from 'fs'
+import { jest } from '@jest/globals'
 
 // Shared tests
 import verifiableDataJWT from './shared/verifiableDataJWT'

diff --git a/__tests__/localMemoryStoreAgent.test.ts b/__tests__/localMemoryStoreAgent.test.ts
@@ -52,6 +52,8 @@ import { getResolver as ethrDidResolver } from 'ethr-did-resolver'
 import { getResolver as webDidResolver } from 'web-did-resolver'
 import { contexts as credential_contexts } from '@transmute/credentials-context'
 import * as fs from 'fs'
+import { jest } from '@jest/globals'
+
 // Shared tests
 import verifiableDataJWT from './shared/verifiableDataJWT'
 import verifiableDataLD from './shared/verifiableDataLD'

diff --git a/__tests__/restAgent.test.ts b/__tests__/restAgent.test.ts
@@ -8,7 +8,6 @@
  * This suite also runs a messaging server to run through some examples of DIDComm using did:fake identifiers.
  * See didWithFakeDidFlow() for more details.
  */
-import 'cross-fetch/polyfill'
 import {
   Agent,
   createAgent,
@@ -77,6 +76,8 @@ import express from 'express'
 import { Server } from 'http'
 import { contexts as credential_contexts } from '@transmute/credentials-context'
 import * as fs from 'fs'
+import { jest } from '@jest/globals'
+
 // Shared tests
 import verifiableDataJWT from './shared/verifiableDataJWT'
 import verifiableDataLD from './shared/verifiableDataLD'

diff --git a/__tests__/shared/credentialStatus.ts b/__tests__/shared/credentialStatus.ts
@@ -12,6 +12,7 @@ import {
   TAgent,
 } from '../../packages/core/src'
 import { CredentialStatusPlugin } from '../../packages/credential-status/src'
+import { jest } from '@jest/globals'
 
 type ConfiguredAgent = TAgent<IDIDManager & ICredentialPlugin & IDataStore & IDataStoreORM>
 

diff --git a/__tests__/shared/didCommAndDataStoreWithCredentials.ts b/__tests__/shared/didCommAndDataStoreWithCredentials.ts
@@ -10,14 +10,15 @@ import {
   TAgent,
 } from '../../packages/core/src'
 import { IDIDComm, IPackedDIDCommMessage } from '../../packages/did-comm/src'
-import { v4 } from "uuid"
+import { v4 } from 'uuid'
 import { VerifiableCredential } from '../../packages/core/src'
+import { jest } from '@jest/globals'
 
 type ConfiguredAgent = TAgent<IDIDManager & IKeyManager & IResolver & IDIDComm>
 
 const DIDCommEventSniffer: IEventListener = {
   eventTypes: ['DIDCommV2Message-sent', 'DIDCommV2Message-received'],
-  onEvent: jest.fn(),
+  onEvent: jest.fn(() => Promise.resolve()),
 }
 
 export default (testContext: {
@@ -129,18 +130,21 @@ export default (testContext: {
     }
 
     const packed = (vc: VerifiableCredential): Promise<IPackedDIDCommMessage> => {
-      return agent.packDIDCommMessage({ packing: 'none', message: {
-        id: v4(),
-        type: 'w3c.vc',
-        from: sender.did,
-        to: receiver.did,
-        body: vc
-      }})
+      return agent.packDIDCommMessage({
+        packing: 'none',
+        message: {
+          id: v4(),
+          type: 'w3c.vc',
+          from: sender.did,
+          to: receiver.did,
+          body: vc,
+        },
+      })
     }
 
     it('should save LDS credential found inside DIDCommMessage', async () => {
       expect.assertions(2)
-      const creator = await agent.didManagerGetOrCreate({ alias: 'messageCreator1', provider: 'did:ethr'})
+      const creator = await agent.didManagerGetOrCreate({ alias: 'messageCreator1', provider: 'did:ethr' })
 
       const numMessagesBefore = await agent.dataStoreORMGetMessagesCount({})
       const numVCsBefore = await agent.dataStoreORMGetVerifiableCredentialsCount({})
@@ -161,8 +165,7 @@ export default (testContext: {
 
     it('should save JWT credential found inside DIDCommMessage', async () => {
       expect.assertions(2)
-      const creator = await agent.didManagerGetOrCreate({ alias: 'messageCreator1', provider: 'did:ethr'})
-
+      const creator = await agent.didManagerGetOrCreate({ alias: 'messageCreator1', provider: 'did:ethr' })
       const numMessagesBefore = await agent.dataStoreORMGetMessagesCount({})
       const numVCsBefore = await agent.dataStoreORMGetVerifiableCredentialsCount({})
 
@@ -180,11 +183,9 @@ export default (testContext: {
       expect(vcs).toEqual(numVCsBefore + 1)
     })
 
-
     it('should save JWT credential found inside DIDCommMessage', async () => {
       expect.assertions(2)
-      const creator = await agent.didManagerGetOrCreate({ alias: 'messageCreator1', provider: 'did:ethr'})
-
+      const creator = await agent.didManagerGetOrCreate({ alias: 'messageCreator1', provider: 'did:ethr' })
       const numMessagesBefore = await agent.dataStoreORMGetMessagesCount({})
       const numVCsBefore = await agent.dataStoreORMGetVerifiableCredentialsCount({})
 

diff --git a/__tests__/shared/didCommWithEthrDidFlow.ts b/__tests__/shared/didCommWithEthrDidFlow.ts
@@ -13,16 +13,17 @@ import {
 } from '../../packages/core/src'
 import { IDIDComm } from '../../packages/did-comm/src'
 import { MessagingRouter, RequestWithAgentRouter } from '../../packages/remote-server/src'
-import * as u8a from 'uint8arrays'
 // @ts-ignore
 import express from 'express'
 import { Server } from 'http'
+import { jest } from '@jest/globals'
+import { bytesToBase58, hexToBytes } from '../../packages/utils/src'
 
 type ConfiguredAgent = TAgent<IDIDManager & IKeyManager & IResolver & IDIDComm & IMessageHandler>
 
 const DIDCommEventSniffer: IEventListener = {
   eventTypes: ['DIDCommV2Message-sent', 'DIDCommV2Message-received'],
-  onEvent: jest.fn(),
+  onEvent: jest.fn(() => Promise.resolve()),
 }
 
 export default (testContext: {
@@ -585,9 +586,9 @@ export default (testContext: {
         key: newKey,
       })
 
-      expect(result.substr(0, 2)).toEqual('0x')
+      expect(result.substring(0, 2)).toEqual('0x')
       const resolution = await agent.resolveDid({ didUrl: alice.did })
-      const expectedBase58Key = u8a.toString(u8a.fromString(newKey.publicKeyHex, 'base16'), 'base58btc')
+      const expectedBase58Key = bytesToBase58(hexToBytes(newKey.publicKeyHex))
       expect(resolution?.didDocument?.verificationMethod?.[2].publicKeyBase58).toEqual(expectedBase58Key)
       expect(resolution?.didDocument?.keyAgreement?.[0]).toEqual(
         resolution?.didDocument?.verificationMethod?.[2].id,
@@ -692,7 +693,7 @@ export default (testContext: {
 
       expect(result.substr(0, 2)).toEqual('0x')
       const resolution = await agent.resolveDid({ didUrl: bob.did })
-      const expectedBase58Key = u8a.toString(u8a.fromString(newKey.publicKeyHex, 'base16'), 'base58btc')
+      const expectedBase58Key = bytesToBase58(hexToBytes(newKey.publicKeyHex))
       expect(resolution?.didDocument?.verificationMethod?.[2].publicKeyBase58).toEqual(expectedBase58Key)
       expect(resolution?.didDocument?.keyAgreement?.[0]).toEqual(
         resolution?.didDocument?.verificationMethod?.[2].id,

diff --git a/__tests__/shared/didCommWithFakeDidFlow.ts b/__tests__/shared/didCommWithFakeDidFlow.ts
@@ -10,12 +10,13 @@ import {
   TAgent,
 } from '../../packages/core/src'
 import { IDIDComm } from '../../packages/did-comm/src'
+import { jest } from '@jest/globals'
 
 type ConfiguredAgent = TAgent<IDIDManager & IKeyManager & IResolver & IDIDComm>
 
 const DIDCommEventSniffer: IEventListener = {
   eventTypes: ['DIDCommV2Message-sent', 'DIDCommV2Message-received'],
-  onEvent: jest.fn(),
+  onEvent: jest.fn(() => Promise.resolve()),
 }
 
 export default (testContext: {

diff --git a/__tests__/utils/ganache-provider.ts b/__tests__/utils/ganache-provider.ts
@@ -1,7 +1,6 @@
 import { Web3Provider } from '@ethersproject/providers'
 import { Contract, ContractFactory } from '@ethersproject/contracts'
-// @ts-ignore
-import DidRegistryContract from 'ethr-did-registry'
+import { EthereumDIDRegistry } from 'ethr-did-resolver'
 import ganache from 'ganache'
 
 /**
@@ -58,7 +57,7 @@ export async function createGanacheProvider(): Promise<{ provider: Web3Provider;
     }) as any
   )
   await provider.ready
-  const factory = ContractFactory.fromSolidity(DidRegistryContract).connect(provider.getSigner(0))
+  const factory = ContractFactory.fromSolidity(EthereumDIDRegistry).connect(provider.getSigner(0))
 
   let registryContract: Contract = await factory.deploy()
   registryContract = await registryContract.deployed()

diff --git a/jest.config.json b/jest.config.json
@@ -1,5 +1,12 @@
 {
-  "moduleFileExtensions": ["ts", "tsx", "js", "jsx", "json", "jsonld"],
+  "moduleFileExtensions": [
+    "ts",
+    "tsx",
+    "js",
+    "jsx",
+    "json",
+    "jsonld"
+  ],
   "collectCoverage": false,
   "collectCoverageFrom": [
     "packages/**/src/**/*.ts",
@@ -9,19 +16,32 @@
     "!**/build/**",
     "!**/node_modules/**"
   ],
-  "coverageReporters": ["text", "lcov", "json"],
+  "coverageReporters": [
+    "text",
+    "lcov",
+    "json"
+  ],
+  "coverageProvider": "v8",
   "coverageDirectory": "./coverage",
-  "transform": {
-    "\\.jsx?$": "babel-jest",
-    "\\.tsx?$": "ts-jest"
-  },
-  "testMatch": ["**/__tests__/**/*.test.*"],
-  "globals": {
-    "ts-jest": {
-      "tsconfig": "./packages/tsconfig.settings.json"
-    }
-  },
+  "extensionsToTreatAsEsm": [".ts"],
+  "testMatch": [
+    "**/__tests__/**/*.test.*"
+  ],
   "testEnvironment": "node",
   "automock": false,
-  "setupFiles": ["./setupJest.js"]
+  "setupFiles": [
+    "./setupJest.js"
+  ],
+  "moduleNameMapper": {
+    "^(\\.{1,2}/.*)\\.js$": "$1"
+  },
+  "transform": {
+    "^.+\\.m?tsx?$": [
+      "ts-jest",
+      {
+        "useESM": true,
+        "tsconfig": "./packages/tsconfig.settings.json"
+      }
+    ]
+  }
 }
diff --git a/lerna.json b/lerna.json
@@ -1,8 +1,5 @@
 {
   "version": "4.3.0",
-  "packages": [
-    "packages/*"
-  ],
   "npmClient": "pnpm",
   "changelog": {
     "repo": "uport-project/veramo",
@@ -13,7 +10,8 @@
       "allowBranch": [
         "main",
         "next",
-        "master"
+        "master",
+        "unstable"
       ],
       "conventionalCommits": true,
       "gitRemote": "origin",
-Original file line number
+Diff line change
@@ Expand Up @@
     Install dependencies
     ```bash
+    npm -g i pnpm
     pnpm install
     ```
@@ Expand Down @@