@verii/endpoints-organizations-registrar 1.2.0 → 1.2.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verii/endpoints-organizations-registrar",
-  "version": "1.2.0",
+  "version": "1.2.1",
   "description": "Organization Registrar",
   "repository": "https://github.com/LFDT-Verii/core",
   "main": "src/index.js",
@@ -29,31 +29,31 @@
     "nanoid": "^5.1.16",
     "sprintf-js": "1.1.3",
     "uuid": "~14.0.1",
-    "@verii/blockchain-functions": "1.2.0",
-    "@verii/common-functions": "1.2.0",
-    "@verii/aws-clients": "1.2.0",
-    "@verii/base-contract-io": "1.2.0",
-    "@verii/auth": "1.2.0",
-    "@verii/config": "1.2.0",
-    "@verii/common-schemas": "1.2.0",
-    "@verii/contract-permissions": "1.2.0",
-    "@verii/country-data": "1.2.0",
-    "@verii/crypto": "1.2.0",
-    "@verii/db-kms": "1.2.0",
-    "@verii/csv-parser": "1.2.0",
-    "@verii/did-doc": "1.2.0",
-    "@verii/did-web": "1.2.0",
-    "@verii/endpoints-credential-types-registrar": "1.2.0",
-    "@verii/fastify-plugins": "1.2.0",
-    "@verii/fineract-client": "1.2.0",
-    "@verii/image-processing": "1.2.0",
-    "@verii/validation": "1.2.0",
-    "@verii/vc-checks": "1.2.0",
-    "@verii/spencer-mongo-extensions": "1.2.0",
-    "@verii/rest-queries": "1.2.0",
-    "@verii/jwt": "1.2.0",
-    "@verii/verii-verification": "1.2.0",
-    "@verii/organizations-registry": "1.2.0"
+    "@verii/aws-clients": "1.2.1",
+    "@verii/base-contract-io": "1.2.1",
+    "@verii/blockchain-functions": "1.2.1",
+    "@verii/common-functions": "1.2.1",
+    "@verii/common-schemas": "1.2.1",
+    "@verii/config": "1.2.1",
+    "@verii/auth": "1.2.1",
+    "@verii/country-data": "1.2.1",
+    "@verii/csv-parser": "1.2.1",
+    "@verii/crypto": "1.2.1",
+    "@verii/db-kms": "1.2.1",
+    "@verii/did-web": "1.2.1",
+    "@verii/did-doc": "1.2.1",
+    "@verii/endpoints-credential-types-registrar": "1.2.1",
+    "@verii/contract-permissions": "1.2.1",
+    "@verii/fastify-plugins": "1.2.1",
+    "@verii/fineract-client": "1.2.1",
+    "@verii/image-processing": "1.2.1",
+    "@verii/jwt": "1.2.1",
+    "@verii/spencer-mongo-extensions": "1.2.1",
+    "@verii/rest-queries": "1.2.1",
+    "@verii/organizations-registry": "1.2.1",
+    "@verii/validation": "1.2.1",
+    "@verii/vc-checks": "1.2.1",
+    "@verii/verii-verification": "1.2.1"
   },
   "peerDependencies": {
     "@spencejs/spence-mongo-repos": "^1.1.0",
@@ -76,12 +76,12 @@
     "mongodb": "^7.5.0",
     "nock": "15.0.0-beta.14",
     "prettier": "3.9.6",
-    "@verii/common-functions": "1.2.0",
-    "@verii/error-aggregation": "1.2.0",
-    "@verii/sample-data": "1.2.0",
-    "@verii/server-provider": "1.2.0",
-    "@verii/tests-helpers": "1.2.0",
-    "@verii/test-regexes": "1.2.0"
+    "@verii/error-aggregation": "1.2.1",
+    "@verii/server-provider": "1.2.1",
+    "@verii/test-regexes": "1.2.1",
+    "@verii/sample-data": "1.2.1",
+    "@verii/tests-helpers": "1.2.1",
+    "@verii/common-functions": "1.2.1"
   },
   "scripts": {
     "test": "cross-env NODE_ENV=test node --test --test-concurrency=1 --test-timeout=900000 --experimental-test-module-mocks --experimental-test-coverage --test-reporter=spec --test-reporter-destination=stdout 'test/**/*.test.js'",

package/src/controllers/organizations/_did/controller.js

@@ -33,6 +33,7 @@ const {
   initBuildOrganizationModificationsOnServiceChange,
   runAllOrgChecks,
   OrganizationErrorMessages,
+  softDeleteOrganization,
   OrganizationServiceErrorMessages,
   RegistrarScopes,
   initProvisionAuth0ClientGrants,
@@ -595,20 +596,7 @@ const organizationController = async (fastify) => {
           });
         }
 
-        const groupsToModify = await repos.groups.find({
-          filter: { dids: params.did },
-        });
-        const groupIds = map('_id', groupsToModify);
-        await repos.groups.collection().updateMany(
-          { _id: { $in: groupIds } },
-          {
-            $pull: { dids: orgToDelete.didDoc.id },
-            $set: { updatedAt: new Date() },
-          },
-        );
-
-        const modifiedProfile = { ...orgToDelete, deletedAt: new Date() };
-        await repos.organizations.update(orgToDelete._id, modifiedProfile);
+        await softDeleteOrganization(orgToDelete, req);
 
         return reply.status(204).send();
       },

package/src/entities/organization-services/orchestrators/init-add-service-to-organization.js

@@ -69,7 +69,7 @@ const initAddServiceToOrganization = async (fastify) => {
     if (isNewNodeOperatorService(organization, createdService)) {
       const stakesAccountId = await createStakesAccount(
         organization.ids.fineractClientId,
-        organization.didDoc.id,
+        organization._id,
         context,
       );
 

package/src/entities/organizations/domains/build-full-organization-response.js

@@ -6,6 +6,10 @@ const buildProfileResponse = (organization, includeTimestamps = false) => {
     ...organization.profile,
     description: organization.profile.description || '',
     id: organization.didDoc.id,
+    // Registrations interrupted before soft deletion of failed provisioning was
+    // introduced may still lack the derived profile fields
+    permittedVelocityServiceCategory:
+      organization.profile.permittedVelocityServiceCategory ?? [],
     verifiableCredentialJwt: organization.verifiableCredentialJwt,
   };
   if (includeTimestamps) {

package/src/entities/organizations/orchestrators/index.js

@@ -2,5 +2,6 @@ module.exports = {
   ...require('./init-create-organization'),
   ...require('./add-primary-permissions'),
   ...require('./init-provision-group'),
+  ...require('./soft-delete-organization'),
   ...require('./verify-profile-website-unique'),
 };

package/src/entities/organizations/orchestrators/init-create-organization.js

@@ -32,6 +32,7 @@ const {
 } = require('./build-non-custodied-organization');
 const { initProvisionGroup } = require('./init-provision-group');
 const { addPrimaryPermissions } = require('./add-primary-permissions');
+const { softDeleteOrganization } = require('./soft-delete-organization');
 const {
   getServiceConsentType,
 } = require('../../organization-services/domains/get-service-consent-type');
@@ -44,30 +45,12 @@ const initCreateOrganization = async (fastify) => {
   const auth0Provisioner = await initAuth0Provisioner(fastify.config);
   const provisionAuth0Clients = initProvisionAuth0Clients(auth0Provisioner);
 
-  return async (
-    { byoDid, byoKeys, serviceEndpoints, profile, invitationCode },
+  const provisionOrganization = async (
+    { organization, invitation, newKeys, newKeyPairs, caoServiceRefs },
     context,
   ) => {
     const { repos, kms, user } = context;
 
-    const invitation = await acceptInvitation(invitationCode, context);
-    const buildOrganization =
-      byoDid == null
-        ? buildCustodiedOrganization
-        : buildNonCustodiedOrganization;
-    const { newOrganization, newKeys, newKeyPairs, caoServiceRefs } =
-      await buildOrganization(
-        {
-          byoDid,
-          byoKeys,
-          serviceEndpoints,
-          profile,
-          invitation,
-        },
-        context,
-      );
-
-    const organization = await repos.organizations.insert(newOrganization);
     await provisionGroup(organization, context);
 
     const activatedServiceIds = activateServices(
@@ -216,6 +199,65 @@ const initCreateOrganization = async (fastify) => {
       authClients,
     };
   };
+
+  return async (
+    { byoDid, byoKeys, serviceEndpoints, profile, invitationCode },
+    context,
+  ) => {
+    const { repos } = context;
+
+    const invitation = await acceptInvitation(invitationCode, context);
+    const buildOrganization =
+      byoDid == null
+        ? buildCustodiedOrganization
+        : buildNonCustodiedOrganization;
+    const { newOrganization, newKeys, newKeyPairs, caoServiceRefs } =
+      await buildOrganization(
+        {
+          byoDid,
+          byoKeys,
+          serviceEndpoints,
+          profile,
+          invitation,
+        },
+        context,
+      );
+
+    const organization = await repos.organizations.insert(newOrganization);
+
+    // Provisioning talks to external systems (Auth0, Fineract, KMS, blockchain).
+    // If any of them fails, the organization must not linger as a partial record:
+    // soft delete it so it is hidden from every finder and the registration can be retried.
+    try {
+      return await provisionOrganization(
+        { organization, invitation, newKeys, newKeyPairs, caoServiceRefs },
+        context,
+      );
+    } catch (error) {
+      await softDeleteFailedOrganization(organization, error, context);
+      throw error;
+    }
+  };
+};
+
+const softDeleteFailedOrganization = async (organization, error, context) => {
+  const { log } = context;
+  const logContext = {
+    organizationId: organization._id,
+    did: organization.didDoc.id,
+  };
+  log.error(
+    { err: error, ...logContext },
+    'Organization provisioning failed. Soft deleting the organization',
+  );
+  try {
+    await softDeleteOrganization(organization, context);
+  } catch (softDeleteError) {
+    log.error(
+      { err: softDeleteError, ...logContext },
+      'Failed to soft delete the organization after provisioning failure',
+    );
+  }
 };
 
 module.exports = { initCreateOrganization };

package/src/entities/organizations/orchestrators/soft-delete-organization.js

@@ -0,0 +1,34 @@
+const softDeleteOrganization = async (organization, { repos }) => {
+  const did = organization.didDoc.id;
+  const now = new Date();
+
+  // hide the organization first: every organization finder excludes deleted
+  // records, so a failure in the group cleanup below leaves nothing visible
+  const deletedOrganization = await repos.organizations.update(
+    organization._id,
+    { deletedAt: now },
+  );
+
+  await repos.groups
+    .collection()
+    .updateMany(
+      { dids: did },
+      { $pull: { dids: did }, $set: { updatedAt: now } },
+    );
+
+  // the group provisioned for the organization itself is keyed by its did;
+  // once it holds no other dids and no client admins, remove it so a retried
+  // registration can create it again instead of inserting a duplicate
+  await repos.groups.collection().deleteMany({
+    groupId: did,
+    dids: { $size: 0 },
+    $or: [
+      { clientAdminIds: { $exists: false } },
+      { clientAdminIds: { $size: 0 } },
+    ],
+  });
+
+  return deletedOrganization;
+};
+
+module.exports = { softDeleteOrganization };