Sync: delete coms-id tags on soft-deleted objects if conflict with COMS

#289 only covered non-deleted objects - this commit expands that to also include soft-deleted objects

Author: norrisng-bc

app/src/services/sync.js

@@ -63,15 +63,34 @@ const service = {
       const { Versions } = await storageService.listAllObjectVersions({ filePath: path, bucketId: bucketId });
 
       for (const versionId of Versions.map(version => version.VersionId)) {
-        const TagSet = await storageService.getObjectTagging({
+        let TagSet = await storageService.getObjectTagging({
           filePath: path,
           s3VersionId: versionId,
           bucketId: bucketId
         }).then(result => result.TagSet ?? []);
         const oldObjId = TagSet.find(obj => obj.Key === 'coms-id')?.Value;
 
         if (oldObjId && uuidValidate(oldObjId)) {
-          objId = oldObjId;
+
+          if (!(await objectService.exists(oldObjId))) {
+            // re-use existing coms-id (if no conflict)
+            objId = oldObjId;
+          } else {
+            // remove `coms-id` tag since it conflicts with an existing COMS object
+            TagSet = TagSet.filter(x => x.Key != 'coms-id');
+
+            // Update S3 Object if there is still remaining space in the TagSet
+            if (TagSet.length < 10) {
+              // putObjectTagging replaces S3 tags so new TagSet must contain existing values
+              await storageService.putObjectTagging({
+                filePath: path,
+                bucketId: bucketId,
+                tags: TagSet.concat([{ Key: 'coms-id', Value: objId }])
+              }).catch((err) => {
+                log.warn(`Unable to add coms-id tag: ${err.message}`, { function: '_deriveObjectId' });
+              });
+            }
+          }
           break; // Stop iterating if a valid uuid was found
         }
       }

app/tests/unit/services/sync.spec.js

@@ -205,19 +205,20 @@ describe('_deriveObjectId', () => {
   });
 
   describe('Soft-Deleted S3 Object', () => {
-    it('Returns a new uuid if valid found', async () => {
+    it('Returns an existing uuid from "coms-id" S3 tag if no conflict with existing COMS object', async () => {
       listAllObjectVersionsSpy.mockResolvedValue({ Versions: [{ VersionId: '2' }, { VersionId: '1' }] });
-      getObjectTaggingSpy.mockResolvedValueOnce({ TagSet: [] });
       getObjectTaggingSpy.mockResolvedValueOnce({
         TagSet: [{ Key: 'coms-id', Value: validUuidv4 }]
       });
+      existsSpy.mockResolvedValueOnce(false);
+      putObjectTaggingSpy.mockResolvedValue({});
 
       const result = await service._deriveObjectId(true, path, bucketId);
 
       expect(result).toBeTruthy();
       expect(typeof result).toBe('string');
-      expect(result).toMatch(validUuidv4);
-      expect(getObjectTaggingSpy).toHaveBeenCalledTimes(2);
+      expect(result).toEqual(validUuidv4);
+      expect(getObjectTaggingSpy).toHaveBeenCalledTimes(1);
       expect(listAllObjectVersionsSpy).toHaveBeenCalledTimes(1);
       expect(listAllObjectVersionsSpy).toHaveBeenCalledWith(expect.objectContaining({
         filePath: path,
@@ -226,6 +227,28 @@ describe('_deriveObjectId', () => {
       expect(putObjectTaggingSpy).toHaveBeenCalledTimes(0);
     });
 
+    it('Returns a new uuid if "coms-id" S3 tag conflicts with existing COMS object', async () => {
+      listAllObjectVersionsSpy.mockResolvedValue({ Versions: [{ VersionId: '2' }, { VersionId: '1' }] });
+      getObjectTaggingSpy.mockResolvedValueOnce({
+        TagSet: [{ Key: 'coms-id', Value: validUuidv4 }]
+      });
+      existsSpy.mockResolvedValueOnce(true);
+      putObjectTaggingSpy.mockResolvedValueOnce({});
+
+      const result = await service._deriveObjectId(true, path, bucketId);
+
+      expect(result).toBeTruthy();
+      expect(typeof result).toBe('string');
+      expect(result).not.toEqual(validUuidv4);
+      expect(getObjectTaggingSpy).toHaveBeenCalledTimes(1);
+      expect(listAllObjectVersionsSpy).toHaveBeenCalledTimes(1);
+      expect(listAllObjectVersionsSpy).toHaveBeenCalledWith(expect.objectContaining({
+        filePath: path,
+        bucketId: bucketId
+      }));
+      expect(putObjectTaggingSpy).toHaveBeenCalledTimes(1);
+    });
+
     it('Returns a new uuid if valid not found', async () => {
       listAllObjectVersionsSpy.mockResolvedValue({ Versions: [{ VersionId: '1' }] });
       getObjectTaggingSpy.mockResolvedValueOnce({ TagSet: [] });