@velocitycareerlabs/server-webwallet 1.27.0-dev-build.15bd823d3 → 1.27.0-dev-build.142d72c39

package/README.md

@@ -6,6 +6,20 @@
 
 Run docker containers to develop Back-end locally and run tests.
 
-### `cd ./servers/webwallet && yarn start:debug`
+### `cd ./servers/webwallet && yarn start:dev`
 
-Run WebWallet backend in debug mode locally on the host http://localhost:3010/
+Run WebWallet backend locally on http://localhost:3010/.
+
+## Data Migrations
+
+From `servers/webwallet`:
+- `yarn migrate:create migration-name-kebab-case-format`: create a migration in `migrations/`
+- `yarn migrate:up`: run all pending migrations
+- `yarn migrate:down`: revert the last executed migration
+- `yarn migrate:status`: show migration status
+
+### Notes for webwallet migrations
+- Use `MIGRATION_ENV=[localdev|test|qa|staging|prod]` to load a local migration secrets file.
+- Create `servers/webwallet/migrations/environments/<migration-env>.secrets.env` locally with `MONGO_URI=...`.
+- `*.secrets.env` files are intentionally not checked in.
+- If you prefer, skip `MIGRATION_ENV` and pass `MONGO_URI` directly when running migration commands.

package/migrate-mongo.config.js

@@ -1,8 +1,10 @@
 const env = require('env-var');
 const { injectEnv } = require('@velocitycareerlabs/migrations');
 
-const migrationEnv = env.get('MIGRATION_ENV').required(true).asString();
-injectEnv({ migrationEnv, envDirPath: './migrations/environments' });
+const migrationEnv = env.get('MIGRATION_ENV').required(false).asString();
+if (migrationEnv) {
+  injectEnv({ migrationEnv, envDirPath: './migrations/environments' });
+}
 const config = {
   mongodb: {
     url: env.get('MONGO_URI').required(true).asString(),

package/migrations/20260224143000-normalize-did-key-metadatum-shape.js

@@ -0,0 +1,127 @@
+const { isDeepStrictEqual } = require('node:util');
+
+const hasOwn = (obj, key) => Object.prototype.hasOwnProperty.call(obj, key);
+
+const isPlainObject = (value) =>
+  value != null && typeof value === 'object' && !Array.isArray(value);
+
+const getFirstDefined = (...values) =>
+  values.find((value) => value !== undefined && value !== null);
+
+const isPlainJwk = (value) =>
+  isPlainObject(value) &&
+  ['kty', 'crv', 'x', 'y', 'n', 'e', 'd', 'p', 'q', 'dp', 'dq', 'qi'].some(
+    (key) => hasOwn(value, key),
+  );
+
+const LEGACY_ENTRY_KEYS = new Set([
+  'did',
+  'kid',
+  'keyId',
+  'publicJwk',
+  'payload',
+]);
+
+const pickDefined = (fields) =>
+  Object.fromEntries(
+    Object.entries(fields).filter(
+      ([, value]) => value !== undefined && value !== null,
+    ),
+  );
+
+const getNormalizedPublicJwk = (entry, payload) => {
+  const publicJwk = getFirstDefined(entry.publicJwk, payload.publicJwk);
+  if (!isPlainObject(publicJwk)) {
+    return undefined;
+  }
+  if (isPlainObject(publicJwk.valueJson)) {
+    return publicJwk.valueJson;
+  }
+  if (isPlainJwk(publicJwk)) {
+    return publicJwk;
+  }
+  return undefined;
+};
+
+const getAdditionalEntryFields = (entry, normalized) =>
+  Object.fromEntries(
+    Object.entries(entry).filter(
+      ([key]) => !LEGACY_ENTRY_KEYS.has(key) && !hasOwn(normalized, key),
+    ),
+  );
+
+const normalizeDidKeyMetadatumEntry = (entry) => {
+  if (!isPlainObject(entry)) {
+    return entry;
+  }
+
+  const payload = isPlainObject(entry.payload) ? entry.payload : {};
+  const normalized = pickDefined({
+    did: getFirstDefined(entry.did, payload.did),
+    kid: getFirstDefined(entry.kid, payload.kid),
+    keyId: getFirstDefined(entry.keyId, payload.keyId),
+    publicJwk: getNormalizedPublicJwk(entry, payload),
+  });
+
+  return {
+    ...normalized,
+    ...getAdditionalEntryFields(entry, normalized),
+  };
+};
+
+const buildDidKeyMetadatumWrite = (account) => {
+  if (!Array.isArray(account.didKeyMetadatum)) {
+    return undefined;
+  }
+
+  const normalizedDidKeyMetadatum = account.didKeyMetadatum.map(
+    normalizeDidKeyMetadatumEntry,
+  );
+
+  if (isDeepStrictEqual(normalizedDidKeyMetadatum, account.didKeyMetadatum)) {
+    return undefined;
+  }
+
+  return {
+    updateOne: {
+      filter: { _id: account._id },
+      update: {
+        $set: {
+          didKeyMetadatum: normalizedDidKeyMetadatum,
+          updatedAt: new Date(),
+        },
+      },
+    },
+  };
+};
+
+module.exports = {
+  up: async (db) => {
+    const accountsCollection = db.collection('accounts');
+    const cursor = accountsCollection.find(
+      {
+        didKeyMetadatum: { $type: 'array', $ne: [] },
+      },
+      {
+        projection: {
+          _id: 1,
+          didKeyMetadatum: 1,
+        },
+      },
+    );
+
+    const writes = [];
+    for await (const account of cursor) {
+      const write = buildDidKeyMetadatumWrite(account);
+      if (write != null) {
+        writes.push(write);
+      }
+    }
+
+    if (writes.length > 0) {
+      await accountsCollection.bulkWrite(writes);
+    }
+  },
+
+  down: async () => {},
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@velocitycareerlabs/server-webwallet",
-  "version": "1.27.0-dev-build.15bd823d3",
+  "version": "1.27.0-dev-build.142d72c39",
   "description": "Web Wallet application",
   "repository": "https://github.com/velocitycareerlabs/packages",
   "engines": {
@@ -10,10 +10,8 @@
   "scripts": {
     "test": "cross-env NODE_ENV=test node --test --test-concurrency=1 --experimental-test-module-mocks --experimental-test-coverage --test-reporter=spec --test-reporter-destination=stdout 'test/**/*.test.js'",
     "test:ci": "NODE_ENV=test node --test --test-concurrency=1 --experimental-test-module-mocks --experimental-test-coverage --test-coverage-include='src/**' --test-reporter=spec --test-reporter=junit --test-reporter-destination=stdout --test-reporter-destination=test-results.junit.xml --test-reporter=lcov --test-reporter-destination=lcov.info 'test/**/*.test.js'",
-    "up": "npm run start:debug",
     "start": "node src/index.js",
     "start:dev": "nodemon src/standalone.js",
-    "start:debug": "nodemon --inspect src/standalone.js",
     "lint": "eslint . --format json >> eslint.json",
     "lint:fix": "eslint --fix.",
     "migrate:status": "./node_modules/.bin/migrate-mongo status --file migrate-mongo.config.js",
@@ -34,7 +32,7 @@
     "@fastify/swagger": "^9.0.0",
     "@fastify/swagger-ui": "^5.0.0",
     "@spencejs/spence-mongo-repos": "^0.10.2",
-    "@velocitycareerlabs/migrations": "1.27.0-dev-build.15bd823d3",
+    "@velocitycareerlabs/migrations": "1.27.0-dev-build.142d72c39",
     "@verii/auth": "1.1.0-pre.1771382986",
     "@verii/common-functions": "1.1.0-pre.1771382986",
     "@verii/common-schemas": "1.1.0-pre.1771382986",
@@ -74,5 +72,5 @@
     "nodemon": "3.1.13",
     "prettier": "3.8.1"
   },
-  "gitHead": "24e710d3bdf255b053a2c85eae8fe07896dfb284"
+  "gitHead": "cd324e82e914e237970bc639ef61dd210750c262"
 }

package/src/controllers/accounts/controller.js

@@ -168,7 +168,14 @@ const buildDidData = async (didKeyMetadatum, accessToken, context) => {
 
   return {
     did: newDidKeyMetadatum.did,
-    didKeyMetadatum: [newDidKeyMetadatum],
+    didKeyMetadatum: [
+      {
+        did: newDidKeyMetadatum.did,
+        kid: newDidKeyMetadatum.kid,
+        keyId: newDidKeyMetadatum.keyId,
+        publicJwk: newDidKeyMetadatum.publicJwk.valueJson,
+      },
+    ],
   };
 };
 

package/src/plugins/crypto-services/jwt-sign-service-impl.js

@@ -32,7 +32,6 @@ const JwtSignServiceImpl = (context) => {
 };
 
 const KeyKeyId = 'keyId';
-const KeyJwk = 'jwk';
 const KeyKid = 'kid';
 const KeyIss = 'iss';
 const KeyAud = 'aud';
@@ -46,7 +45,6 @@ const KeyPayload = 'payload';
 const generateJwtPayloadToSign = (jwtDescriptor, nonce, didJwk) => {
   const header = didJwk
     ? {
-        [KeyJwk]: didJwk.publicJwk.valueJson,
         [KeyKid]: didJwk.kid,
       }
     : {};

package/test/accounts-controller.test.js

@@ -8,15 +8,22 @@ const {
   mock,
 } = require('node:test');
 const { expect } = require('expect');
+const { VCLDidJwk } = require('@verii/vnf-nodejs-wallet-sdk');
 
 const usersDid = 'did:example:123';
+const didJwkJson = {
+  did: usersDid,
+  kid: `${usersDid}#0`,
+  keyId: '6630f0a67b097c289711f583',
+  publicJwk: {
+    kty: 'EC',
+    crv: 'P-256',
+    y: 'pQTRa7Gkqc5kj6odeMqpgV5T4LjbZa4F5KTu2JDrWnc',
+    x: 'r9fya52IlmTo3ybS0w_GefeQ_RX2EH_HJmSWqYYO2JY',
+  },
+};
 const mockGenerateDidJwk = mock.fn(() =>
-  Promise.resolve({
-    did: usersDid,
-    publicJwk: {},
-    kid: '',
-    keyId: '',
-  }),
+  Promise.resolve(VCLDidJwk.fromJSON(didJwkJson)),
 );
 
 mock.module('@verii/vnf-nodejs-wallet-sdk', {
@@ -114,6 +121,23 @@ describe('Test accounts controller', () => {
           remoteCryptoServicesToken: 'fooAccessToken',
         },
       ]);
+      const [dbAccount] = await mongoDb()
+        .collection('accounts')
+        .find({ userId: auth0userId })
+        .toArray();
+      expect(dbAccount).toEqual({
+        _id: expect.any(ObjectId),
+        accountType: 'temp',
+        careerWalletAccountId: 'careerwallet-account-id',
+        userId: auth0userId,
+        did: usersDid,
+        createdAt: expect.any(Date),
+        updatedAt: expect.any(Date),
+        verificationInfo: {
+          createAccountMessageDisplayed: false,
+        },
+        didKeyMetadatum: [didJwkJson],
+      });
       const dbCredentials = await mongoDb()
         .collection('credentials')
         .find()
@@ -155,6 +179,23 @@ describe('Test accounts controller', () => {
           remoteCryptoServicesToken: 'fooAccessToken',
         },
       ]);
+      const [dbAccount] = await mongoDb()
+        .collection('accounts')
+        .find({ userId: auth0userId })
+        .toArray();
+      expect(dbAccount).toEqual({
+        _id: expect.any(ObjectId),
+        accountType: 'temp',
+        careerWalletAccountId: 'careerwallet-account-id',
+        userId: auth0userId,
+        did: usersDid,
+        createdAt: expect.any(Date),
+        updatedAt: expect.any(Date),
+        verificationInfo: {
+          createAccountMessageDisplayed: false,
+        },
+        didKeyMetadatum: [didJwkJson],
+      });
     });
 
     it('should return an existing account and not call generateDidJwk if did key exists', async () => {
@@ -191,6 +232,23 @@ describe('Test accounts controller', () => {
           remoteCryptoServicesToken: 'fooAccessToken',
         },
       ]);
+      const [dbAccount] = await mongoDb()
+        .collection('accounts')
+        .find({ userId: auth0userId })
+        .toArray();
+      expect(dbAccount).toEqual({
+        _id: expect.any(ObjectId),
+        accountType: 'temp',
+        careerWalletAccountId: 'careerwallet-account-id',
+        userId: auth0userId,
+        did: usersDid,
+        createdAt: expect.any(Date),
+        updatedAt: expect.any(Date),
+        verificationInfo: {
+          createAccountMessageDisplayed: false,
+        },
+        didKeyMetadatum: [didJwkJson],
+      });
     });
 
     it("should 502 fail to create account if personaEmail is specified and personas can't be loaded", async () => {
@@ -332,6 +390,24 @@ describe('Test accounts controller', () => {
       expect(personasNock.isDone()).toBe(true);
       expect(mockGenerateDidJwk.mock.calls).toEqual([]);
 
+      const [dbAccount] = await mongoDb()
+        .collection('accounts')
+        .find({ userId: auth0userId })
+        .toArray();
+      expect(dbAccount).toEqual({
+        _id: expect.any(ObjectId),
+        accountType: 'temp',
+        careerWalletAccountId: 'careerwallet-account-id',
+        userId: auth0userId,
+        did: usersDid,
+        createdAt: expect.any(Date),
+        updatedAt: expect.any(Date),
+        verificationInfo: {
+          createAccountMessageDisplayed: false,
+        },
+        didKeyMetadatum: [{ did: usersDid }],
+      });
+
       const [credential] = await mongoDb()
         .collection('credentials')
         .find()

package/test/crypro-services/jwt-sign-service-impl.test.js

@@ -38,7 +38,24 @@ describe('sign service implementation test', () => {
 
   it('should sign payload successfully', async () => {
     const nockedRequest = nock(fastify.config.careerWalletUrl)
-      .post('/api/v0.6/jwt/sign')
+      .post('/api/v0.6/jwt/sign', (body) => {
+        expect(body).toEqual({
+          header: {
+            kid: DidJwkMocks.DidJwk.kid,
+          },
+          payload: {
+            ...OriginalPayload,
+            nonce: 'nonce123',
+            aud: 'aud123',
+            jti: 'jti123',
+            iss: 'iss123',
+          },
+          options: {
+            keyId: DidJwkMocks.DidJwk.keyId,
+          },
+        });
+        return true;
+      })
       .reply(200, JwtResponseMock);
 
     const jwt = await subject.sign(