@did-space/s3-driver 0.2.172 → 0.3.0

package/dist/operator/index.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { ReadOptions, WriteOptions, SpaceOperatorProtocol, SpaceConfig, AppSpaceOptions, DeleteOptions, ListOptions, Object, Data, ListsOptions, GetHashOptions } from '@did-space/core';
+import { ReadOptions, WriteOptions, SpaceOperatorProtocol, SpaceConfig, AppSpaceOptions, DeleteOptions, ListOptions, Object, Data, ListsOptions, GetHashOptions, WriteAsOwnerOptions, ReadAsOwnerOptions, DeleteAsOwnerOptions, ExistsAsOwnerOptions } from '@did-space/core';
 import { S3Client } from '@aws-sdk/client-s3';
 import { Stream } from 'stream';
 import { S3DriverOptions } from '../s3/options';
@@ -76,7 +76,7 @@ export declare class S3SpaceOperator implements SpaceOperatorProtocol {
      */
     lists(options: ListsOptions): Promise<Object[]>;
     list(options: ListOptions): Promise<Object>;
-    writeAsOwner(key: string, data: Data): Promise<void>;
+    writeAsOwner(key: string, data: Data, options?: WriteAsOwnerOptions): Promise<void>;
     /**
      *
      * FIXME: @yejianchao 需要支持一下删除一个文件夹（非空）的操作
@@ -84,8 +84,8 @@ export declare class S3SpaceOperator implements SpaceOperatorProtocol {
      * @return {*}  {Promise<void>}
      * @memberof S3SpaceOperator
      */
-    deleteAsOwner(key: string): Promise<void>;
-    readAsOwner(key: string): Promise<Stream>;
-    existsAsOwner(key: string): Promise<boolean>;
+    deleteAsOwner(key: string, options?: DeleteAsOwnerOptions): Promise<void>;
+    readAsOwner(key: string, options?: ReadAsOwnerOptions): Promise<Stream>;
+    existsAsOwner(key: string, options?: ExistsAsOwnerOptions): Promise<boolean>;
 }
 export {};

package/dist/operator/index.js

@@ -28,6 +28,7 @@ const mime_types_1 = __importDefault(require("mime-types"));
 const isEmpty_1 = __importDefault(require("lodash/isEmpty"));
 const debug_1 = __importDefault(require("debug"));
 const p_all_1 = __importDefault(require("p-all"));
+const common_1 = require("../utils/common");
 const { version: s3ClientVersion } = require('@aws-sdk/client-s3/package.json');
 const { version: libStorageVersion } = require('@aws-sdk/lib-storage/package.json');
 const debug = (0, debug_1.default)('@did-space/s3-driver:S3SpaceOperator');
@@ -342,7 +343,7 @@ class S3SpaceOperator {
         var _a, e_3, _b, _c;
         var _d;
         return __awaiter(this, void 0, void 0, function* () {
-            debug('_listsRecursiveAsOwner.before', `Prefix=${prefix}`);
+            debug('listsRecursiveAsOwner.before', `Prefix=${prefix}`);
             const objects = [];
             try {
                 for (var _e = true, _f = __asyncValues((0, client_s3_1.paginateListObjectsV2)({ client: this.s3Client }, {
@@ -384,7 +385,7 @@ class S3SpaceOperator {
                 }
                 finally { if (e_3) throw e_3.error; }
             }
-            debug('_listsRecursiveAsOwner.after', `Prefix=${prefix}`);
+            debug('listsRecursiveAsOwner.after', `Prefix=${prefix}`);
             return objects;
         });
     }
@@ -399,9 +400,10 @@ class S3SpaceOperator {
      */
     lists(options) {
         return __awaiter(this, void 0, void 0, function* () {
-            const prefix = (0, path_1.join)(this.options.root, options.key);
+            const prefix = (0, common_1.getSafeKey)((options === null || options === void 0 ? void 0 : options.useGlobal) ? options.key : (0, path_1.join)(this.options.root, options.key));
             debug('lists.before', `Prefix=${prefix}`);
-            if (!(yield this.existsAsOwner(options.key))) {
+            if (!(yield this.existsAsOwner(options.key, options))) {
+                debug('lists.before.existsAsOwner()', `does not exist: ${options.key}`);
                 return [];
             }
             // 以 非递归的方式 && 显示文件夹 的方式列出当前文件
@@ -444,11 +446,15 @@ class S3SpaceOperator {
             };
         });
     }
-    writeAsOwner(key, data) {
+    writeAsOwner(key, data, options) {
         return __awaiter(this, void 0, void 0, function* () {
+            debug('writeAsOwner.before', JSON.stringify({ key, options }));
+            const $key = (0, common_1.getSafeKey)((options === null || options === void 0 ? void 0 : options.useGlobal) ? key : (0, path_1.join)(this.options.root, key));
+            debug('writeAsOwner.$$key', $key);
             yield this.s3Client.send(new client_s3_1.PutObjectCommand({
                 Bucket: this.options.bucket,
-                Key: (0, path_1.join)(this.options.root, key),
+                // @note: 注意 key 不能以 / 开头
+                Key: $key,
                 Body: data,
             }));
         });
@@ -460,10 +466,13 @@ class S3SpaceOperator {
      * @return {*}  {Promise<void>}
      * @memberof S3SpaceOperator
      */
-    deleteAsOwner(key) {
+    deleteAsOwner(key, options) {
         return __awaiter(this, void 0, void 0, function* () {
             debug('deleteAsOwner.before', `Bucket=${this.options.bucket} Key=${key}`);
+            const $key = (0, common_1.getSafeKey)((options === null || options === void 0 ? void 0 : options.useGlobal) ? key : (0, path_1.join)(this.options.root, key));
+            debug('deleteAsOwner.$key', $key);
             if (key.endsWith('/')) {
+                // FIXME: 这个 key 怎么取，后续处理一下，对于新的存储改进暂无影响，但是目前改动的话，会对旧的存储产生影响 @jianchao
                 const objects = yield this.listsRecursiveAsOwner(key);
                 const actions = objects.map((x) => {
                     return () => __awaiter(this, void 0, void 0, function* () {
@@ -479,7 +488,7 @@ class S3SpaceOperator {
                     yield this.s3Client.send(new client_s3_1.DeleteObjectCommand({
                         Bucket: this.options.bucket,
                         // @note: 注意 key 不能以 / 开头
-                        Key: key,
+                        Key: $key,
                     }));
                 }));
                 yield (0, p_all_1.default)(actions, { concurrency: process.env.DRIVER_CONCURRENCY ? +process.env.DRIVER_CONCURRENCY : 32 });
@@ -487,28 +496,37 @@ class S3SpaceOperator {
             else {
                 yield this.s3Client.send(new client_s3_1.DeleteObjectCommand({
                     Bucket: this.options.bucket,
-                    Key: (0, path_1.join)(this.options.root, key),
+                    Key: $key,
                 }));
             }
             debug('deleteAsOwner.after', `Key=${key}`);
         });
     }
-    readAsOwner(key) {
+    readAsOwner(key, options) {
         return __awaiter(this, void 0, void 0, function* () {
+            debug('readAsOwner.before', JSON.stringify({ key, options }));
+            const $key = (0, common_1.getSafeKey)((options === null || options === void 0 ? void 0 : options.useGlobal) ? key : (0, path_1.join)(this.options.root, key));
+            debug('readAsOwner.$key', $key);
             const output = yield this.s3Client.send(new client_s3_1.GetObjectCommand({
                 Bucket: this.options.bucket,
-                Key: (0, path_1.join)(this.options.root, key),
+                Key: $key,
                 ResponseContentType: 'application/octet-stream',
             }));
             return output.Body;
         });
     }
-    existsAsOwner(key) {
+    existsAsOwner(key, options) {
         var _a;
         return __awaiter(this, void 0, void 0, function* () {
-            const $key = (0, path_1.join)(this.options.root, key);
-            const isDir = $key.endsWith('/');
+            debug('existsAsOwner.before', JSON.stringify(Object.assign(Object.assign({}, options), { key })));
             try {
+                const $key = (0, common_1.getSafeKey)((options === null || options === void 0 ? void 0 : options.useGlobal) ? key : (0, path_1.join)(this.options.root, key));
+                if ($key === '') {
+                    // 表示根目录，根目录始终存在的
+                    return true;
+                }
+                const isDir = $key.endsWith('/');
+                debug('existsAsOwner.before.$$key', $key);
                 // 特别地，如果这是一个 folder 的话，那么需要使用 ListObjectsCommand 做特殊判断
                 if (isDir) {
                     const output = yield this.s3Client.send(new client_s3_1.ListObjectsCommand({

package/dist/utils/common.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @description s3 的 key 不能以 / 开头
+ * @export
+ * @param {string} key
+ * @return {string}
+ */
+export declare function getSafeKey(key: string): string;

package/dist/utils/common.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSafeKey = void 0;
+/**
+ * @description s3 的 key 不能以 / 开头
+ * @export
+ * @param {string} key
+ * @return {string}
+ */
+function getSafeKey(key) {
+    return key.replace(/^\/*/, '');
+}
+exports.getSafeKey = getSafeKey;

package/dist/utils/index.d.ts

@@ -1,2 +1,3 @@
 export * from './stream-to-string';
 export * from './timeout';
+export * from './common';

package/dist/utils/index.js

@@ -16,3 +16,4 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
 Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./stream-to-string"), exports);
 __exportStar(require("./timeout"), exports);
+__exportStar(require("./common"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@did-space/s3-driver",
-  "version": "0.2.172",
+  "version": "0.3.0",
   "publishConfig": {
     "access": "public"
   },
@@ -34,7 +34,7 @@
   "dependencies": {
     "@aws-sdk/client-s3": "3.370.0",
     "@aws-sdk/lib-storage": "3.370.0",
-    "@did-space/core": "0.2.172",
+    "@did-space/core": "0.3.0",
     "debug": "^4.3.4",
     "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
@@ -57,5 +57,5 @@
     "ts-jest": "^28.0.6",
     "typescript": "^4.9.5"
   },
-  "gitHead": "0f221e8d8ec17645130499297d7a4a4ae0ef0efb"
+  "gitHead": "a883d2a4ab600138c8a23093ace6b94d9107e43e"
 }