Merge pull request #6022 from BitGo/CSI-419-2

feat: handle rejected promises in bulk wallet share updates

Author: aarvay

modules/bitgo/test/v2/unit/wallets.ts

@@ -2273,6 +2273,92 @@ describe('V2 Wallets:', function () {
         encryptStub.firstCall.args[0].should.have.property('password', 'newPassphrase');
         encryptStub.firstCall.args[0].should.have.property('input', originalPrivKey);
       });
+
+      it('should handle rejected promises and add them to walletShareUpdateErrors', async () => {
+        const walletPassphrase = 'bitgo1234';
+
+        // Mock listSharesV2 to return two shares
+        sinon.stub(Wallets.prototype, 'listSharesV2').resolves({
+          incoming: [
+            {
+              id: 'share1',
+              coin: 'tsol',
+              walletLabel: 'testing',
+              fromUser: 'dummyFromUser',
+              toUser: 'dummyToUser',
+              wallet: 'wallet1',
+              permissions: ['spend'],
+              state: 'active',
+            },
+            {
+              id: 'share2',
+              coin: 'tsol',
+              walletLabel: 'testing2',
+              fromUser: 'dummyFromUser',
+              toUser: 'dummyToUser',
+              wallet: 'wallet2',
+              permissions: ['spend'],
+              state: 'active',
+            },
+            {
+              id: 'share3',
+              coin: 'tsol',
+              walletLabel: 'testing3',
+              fromUser: 'dummyFromUser',
+              toUser: 'dummyToUser',
+              wallet: 'wallet3',
+              permissions: ['spend'],
+              state: 'active',
+            },
+          ],
+          outgoing: [],
+        });
+
+        // Stub processAcceptShare to throw an error for share2
+        // Using 'as any' to bypass TypeScript's private method restriction
+        const processAcceptShareStub = sinon.stub(Wallets.prototype as any, 'processAcceptShare');
+        processAcceptShareStub
+          .withArgs('share1', sinon.match.any, sinon.match.any, sinon.match.any, sinon.match.any)
+          .resolves([{ walletShareId: 'share1', status: 'accept' }]);
+        processAcceptShareStub
+          .withArgs('share2', sinon.match.any, sinon.match.any, sinon.match.any, sinon.match.any)
+          .rejects(new Error('Failed to process share2'));
+        processAcceptShareStub
+          .withArgs('share3', sinon.match.any, sinon.match.any, sinon.match.any, sinon.match.any)
+          .resolves([{ walletShareId: 'share3', status: 'accept' }]);
+
+        // Mock bulkUpdateWalletShareRequest to return a response
+        const bulkUpdateStub = sinon.stub(Wallets.prototype, 'bulkUpdateWalletShareRequest').resolves({
+          acceptedWalletShares: ['share1', 'share3'],
+          rejectedWalletShares: [],
+          walletShareUpdateErrors: [], // Empty array that should be populated
+        });
+
+        const result = await wallets.bulkUpdateWalletShare({
+          shares: [
+            { walletShareId: 'share1', status: 'accept' },
+            { walletShareId: 'share2', status: 'accept' },
+            { walletShareId: 'share3', status: 'accept' },
+          ],
+          userLoginPassword: walletPassphrase,
+        });
+
+        // Verify bulkUpdateWalletShareRequest was called with only the successful share
+        bulkUpdateStub.calledOnce.should.be.true();
+        const updateParams = bulkUpdateStub.firstCall.args[0];
+        updateParams.should.have.lengthOf(2);
+        updateParams[0].walletShareId.should.equal('share1');
+        updateParams[0].status.should.equal('accept');
+        updateParams[1].walletShareId.should.equal('share3');
+        updateParams[1].status.should.equal('accept');
+
+        // Verify the result contains the error information
+        result.should.have.property('walletShareUpdateErrors');
+        result.walletShareUpdateErrors.should.be.an.Array();
+        result.walletShareUpdateErrors.should.have.lengthOf(1);
+        result.walletShareUpdateErrors[0].should.have.property('walletShareId', 'share2');
+        result.walletShareUpdateErrors[0].should.have.property('reason', 'Failed to process share2');
+      });
     });
   });
 

modules/sdk-core/src/bitgo/wallet/wallets.ts

@@ -1030,14 +1030,24 @@ export class Wallets implements IWallets {
     );
 
     // Extract successful updates
-    const successfulUpdates = settledUpdates
-      .filter(
-        (result): result is PromiseFulfilledResult<BulkUpdateWalletShareOptionsRequest[]> =>
-          result.status === 'fulfilled'
-      )
-      .flatMap((result) => result.value);
-
-    // Send updates to the server
+    const successfulUpdates = settledUpdates.flatMap((result) => (result.status === 'fulfilled' ? result.value : []));
+
+    // Extract failed updates - only from rejected promises
+    const failedUpdates = settledUpdates.reduce<Array<{ walletShareId: string; reason: string }>>(
+      (acc, result, index) => {
+        if (result.status === 'rejected') {
+          const rejectedResult = result;
+          acc.push({
+            walletShareId: resolvedShares[index].walletShareId,
+            reason: rejectedResult.reason?.message || String(rejectedResult.reason),
+          });
+        }
+        return acc;
+      },
+      []
+    );
+
+    // Send successful updates to the server
     const response = await this.bulkUpdateWalletShareRequest(successfulUpdates);
 
     // Process accepted special override cases - reshare with spenders
@@ -1056,6 +1066,11 @@ export class Wallets implements IWallets {
       }
     }
 
+    // Add information about failed updates to the response
+    if (failedUpdates.length > 0) {
+      response.walletShareUpdateErrors.push(...failedUpdates);
+    }
+
     return response;
   }
 

yarn.lock

@@ -14084,6 +14084,11 @@ long@^5.0.0:
   resolved "https://registry.npmjs.org/long/-/long-5.3.1.tgz#9d4222d3213f38a5ec809674834e0f0ab21abe96"
   integrity sha512-ka87Jz3gcx/I7Hal94xaN2tZEOPoUOEVftkQqZx2EeQRN7LGdfLlI3FvZ+7WDplm+vK2Urx9ULrvSowtdCieng==
 
+long@^5.3.2:
+  version "5.3.2"
+  resolved "https://registry.npmjs.org/long/-/long-5.3.2.tgz#1d84463095999262d7d7b7f8bfd4a8cc55167f83"
+  integrity sha512-mNAgZ1GmyNhD7AuqnTG3/VQ26o760+ZYBPKjPvugO8+nLbYfX6TVpJPseBvopbdY+qpZ/lKUnmEc1LeZYS3QAA==
+
 long@~3:
   version "3.2.0"
   resolved "https://registry.npmjs.org/long/-/long-3.2.0.tgz#d821b7138ca1cb581c172990ef14db200b5c474b"