feat: list object functions support return restore info (#1339)

* feat: list object functions support return restore info * chore: lock nise version --------- Co-authored-by: zhengzuoyu.zzy <[email protected]>
ali-sdk · Nov 19, 2024 · 986b743 · 986b743
1 parent 439ffde
commit 986b743
Show file tree

Hide file tree

Showing 12 changed files with 201 additions and 23 deletions.
diff --git a/README.md b/README.md
@@ -2449,6 +2449,9 @@ Success will return objects list on `objects` properties.
   - size {Number} object size, e.g.: `344606`
   - storageClass {String} storage class type, e.g.: `Standard`
   - owner {Object} object owner, including `id` and `displayName`
+  - restoreInfo {Object|undefined} The restoration status of the object
+    - ongoingRequest {Boolean} Whether the restoration is complete
+    - expireDate {Date|undefined} The time before which the restored object can be read
 - prefixes {Array<String>} prefix list
 - isTruncated {Boolean} truncate or not
 - nextMarker {String} next marker string
@@ -2515,6 +2518,9 @@ Success will return objects list on `objects` properties.
   - size {Number} object size, e.g.: `344606`
   - storageClass {String} storage class type, e.g.: `Standard`
   - owner {Object|null} object owner, including `id` and `displayName`
+  - restoreInfo {Object|undefined} The restoration status of the object
+    - ongoingRequest {Boolean} Whether the restoration is complete
+    - expireDate {Date|undefined} The time before which the restored object can be read
 - prefixes {Array<String>} prefix list
 - isTruncated {Boolean} truncate or not
 - nextContinuationToken {String} next continuation-token string
@@ -2595,6 +2601,9 @@ Success will return objects list on `objects` properties.
   - versionId {String} object versionId
   - storageClass {String} storage class type, e.g.: `Standard`
   - owner {Object} object owner, including `id` and `displayName`
+  - restoreInfo {Object|undefined} The restoration status of the object
+    - ongoingRequest {Boolean} Whether the restoration is complete
+    - expireDate {Date|undefined} The time before which the restored object can be read
 - deleteMarker {Array<ObjectDeleteMarker>} object delete marker info list
   Each `ObjectDeleteMarker`
   - name {String} object name on oss

diff --git a/lib/browser/object.js b/lib/browser/object.js
@@ -9,6 +9,7 @@ const { isBlob } = require('../common/utils/isBlob');
 const { isFile } = require('../common/utils/isFile');
 const { isBuffer } = require('../common/utils/isBuffer');
 const { obj2xml } = require('../common/utils/obj2xml');
+const { parseRestoreInfo } = require('../common/utils/parseRestoreInfo');
 
 // var assert = require('assert');
 
@@ -191,6 +192,7 @@ proto.list = async function list(query, options) {
     if (!Array.isArray(objects)) {
       objects = [objects];
     }
+
     objects = objects.map(obj => ({
       name: obj.Key,
       url: that._objectUrl(obj.Key),
@@ -202,7 +204,8 @@ proto.list = async function list(query, options) {
       owner: {
         id: obj.Owner.ID,
         displayName: obj.Owner.DisplayName
-      }
+      },
+      restoreInfo: parseRestoreInfo(obj.RestoreInfo)
     }));
   }
   let prefixes = result.data.CommonPrefixes || null;
@@ -245,6 +248,7 @@ proto.listV2 = async function listV2(query, options = {}) {
     if (!Array.isArray(objects)) {
       objects = [objects];
     }
+
     objects = objects.map(obj => {
       let owner = null;
       if (obj.Owner) {
@@ -261,7 +265,8 @@ proto.listV2 = async function listV2(query, options = {}) {
         type: obj.Type,
         size: Number(obj.Size),
         storageClass: obj.StorageClass,
-        owner
+        owner,
+        restoreInfo: parseRestoreInfo(obj.RestoreInfo)
       };
     });
   }

diff --git a/lib/common/object/getBucketVersions.js b/lib/common/object/getBucketVersions.js
@@ -2,6 +2,7 @@
 const proto = exports;
 const { isObject } = require('../utils/isObject');
 const { isArray } = require('../utils/isArray');
+const { parseRestoreInfo } = require('../utils/parseRestoreInfo');
 
 proto.getBucketVersions = getBucketVersions;
 proto.listObjectVersions = getBucketVersions;
@@ -43,7 +44,8 @@ async function getBucketVersions(query = {}, options = {}) {
       owner: {
         id: obj.Owner.ID,
         displayName: obj.Owner.DisplayName
-      }
+      },
+      restoreInfo: parseRestoreInfo(obj.RestoreInfo)
     }));
   }
   if (deleteMarker) {

diff --git a/lib/common/utils/parseRestoreInfo.d.ts b/lib/common/utils/parseRestoreInfo.d.ts
@@ -0,0 +1,6 @@
+interface IRestoreInfo {
+  ongoingRequest: boolean;
+  expiryDate?: Date;
+}
+export declare const parseRestoreInfo: (originalRestoreInfo?: string | undefined) => IRestoreInfo | undefined;
+export {};
diff --git a/lib/common/utils/parseRestoreInfo.js b/lib/common/utils/parseRestoreInfo.js
@@ -0,0 +1,18 @@
+'use strict';
+Object.defineProperty(exports, '__esModule', { value: true });
+exports.parseRestoreInfo = void 0;
+exports.parseRestoreInfo = originalRestoreInfo => {
+  let tempRestoreInfo;
+  if (originalRestoreInfo) {
+    tempRestoreInfo = {
+      ongoingRequest: originalRestoreInfo.includes('true')
+    };
+    if (!tempRestoreInfo.ongoingRequest) {
+      const matchArray = originalRestoreInfo.match(/expiry-date="(.*)"/);
+      if (matchArray && matchArray[1]) {
+        tempRestoreInfo.expiryDate = new Date(matchArray[1]);
+      }
+    }
+  }
+  return tempRestoreInfo;
+};
diff --git a/lib/common/utils/parseRestoreInfo.ts b/lib/common/utils/parseRestoreInfo.ts
@@ -0,0 +1,24 @@
+interface IRestoreInfo {
+  ongoingRequest: boolean;
+  expiryDate?: Date;
+}
+
+export const parseRestoreInfo = (originalRestoreInfo?: string): IRestoreInfo | undefined => {
+  let tempRestoreInfo: IRestoreInfo | undefined;
+
+  if (originalRestoreInfo) {
+    tempRestoreInfo = {
+      ongoingRequest: originalRestoreInfo.includes('true')
+    };
+
+    if (!tempRestoreInfo.ongoingRequest) {
+      const matchArray = originalRestoreInfo.match(/expiry-date="(.*)"/);
+
+      if (matchArray && matchArray[1]) {
+        tempRestoreInfo.expiryDate = new Date(matchArray[1]);
+      }
+    }
+  }
+
+  return tempRestoreInfo;
+};
diff --git a/lib/object.js b/lib/object.js
@@ -10,6 +10,7 @@ const pump = require('pump');
 const { isBuffer } = require('./common/utils/isBuffer');
 const { retry } = require('./common/utils/retry');
 const { obj2xml } = require('./common/utils/obj2xml');
+const { parseRestoreInfo } = require('./common/utils/parseRestoreInfo');
 
 const proto = exports;
 
@@ -211,6 +212,7 @@ proto.list = async function list(query, options) {
     if (!Array.isArray(objects)) {
       objects = [objects];
     }
+
     objects = objects.map(obj => ({
       name: obj.Key,
       url: that._objectUrl(obj.Key),
@@ -222,7 +224,8 @@ proto.list = async function list(query, options) {
       owner: {
         id: obj.Owner.ID,
         displayName: obj.Owner.DisplayName
-      }
+      },
+      restoreInfo: parseRestoreInfo(obj.RestoreInfo)
     }));
   }
   let prefixes = result.data.CommonPrefixes || null;
@@ -276,6 +279,7 @@ proto.listV2 = async function listV2(query = {}, options = {}) {
           displayName: obj.Owner.DisplayName
         };
       }
+
       return {
         name: obj.Key,
         url: that._objectUrl(obj.Key),
@@ -284,7 +288,8 @@ proto.listV2 = async function listV2(query = {}, options = {}) {
         type: obj.Type,
         size: Number(obj.Size),
         storageClass: obj.StorageClass,
-        owner
+        owner,
+        restoreInfo: parseRestoreInfo(obj.RestoreInfo)
       };
     });
   }

diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -119,6 +119,7 @@
     "lint-staged": "^12.4.1",
     "mm": "^2.0.0",
     "mocha": "^9.1.2",
+    "nise": "5.1.4",
     "nyc": "^15.1.0",
     "prettier": "^3.0.0",
     "promise-polyfill": "^6.0.2",

diff --git a/test/browser/browser.test.js b/test/browser/browser.test.js
@@ -508,6 +508,26 @@ describe('browser', () => {
           assert(!result.isTruncated);
           assert.equal(result.prefixes, null);
         });
+
+        it('should list files with restore info', async () => {
+          const testFile = `${listPrefix}restoreInfoTest.txt`;
+          await client.put(testFile, Buffer.from('test'), {
+            headers: {
+              'x-oss-storage-class': 'Archive'
+            }
+          });
+          await client.restore(testFile);
+
+          const listResult = await client.list({
+            prefix: testFile
+          });
+          assert.strictEqual(listResult.res.status, 200);
+          assert.strictEqual(listResult.objects.length, 1);
+          assert.strictEqual(listResult.objects[0].restoreInfo.ongoingRequest, true);
+          assert.strictEqual(listResult.objects[0].restoreInfo.expiryDate, undefined);
+
+          await client.delete(testFile);
+        });
       });
 
       describe('listV2()', () => {
@@ -673,6 +693,26 @@ describe('browser', () => {
           } while (nextContinuationToken);
           assert.strictEqual(keyCount, 6);
         });
+
+        it('should list files with restore info', async () => {
+          const testFile = `${listPrefix}restoreInfoTest.txt`;
+          await store.put(testFile, Buffer.from('test'), {
+            headers: {
+              'x-oss-storage-class': 'Archive'
+            }
+          });
+          await store.restore(testFile);
+
+          const listResult = await store.listV2({
+            prefix: testFile
+          });
+          assert.strictEqual(listResult.res.status, 200);
+          assert.strictEqual(listResult.objects.length, 1);
+          assert.strictEqual(listResult.objects[0].restoreInfo.ongoingRequest, true);
+          assert.strictEqual(listResult.objects[0].restoreInfo.expiryDate, undefined);
+
+          await store.delete(testFile);
+        });
       });
 
       describe('get()', () => {

diff --git a/test/node/multiversion.test.js b/test/node/multiversion.test.js
@@ -145,6 +145,24 @@ describe('test/multiversion.test.js', () => {
             assert(false, err.message);
           }
         });
+
+        it('should list files with restore info', async () => {
+          const testFile = 'restoreInfoTest.txt';
+          await store.put(testFile, Buffer.from('test'), {
+            headers: {
+              'x-oss-storage-class': 'Archive'
+            }
+          });
+          await store.restore(testFile);
+
+          const listResult = await store.getBucketVersions({
+            prefix: testFile
+          });
+          assert.strictEqual(listResult.res.status, 200);
+          assert.strictEqual(listResult.objects.length, 1);
+          assert.strictEqual(listResult.objects[0].restoreInfo.ongoingRequest, true);
+          assert.strictEqual(listResult.objects[0].restoreInfo.expiryDate, undefined);
+        });
       });
 
       describe('putBucketLifecycle() getBucketLifecycle()', async () => {