@did-space/core 0.4.18 → 0.4.20

package/dist/schemas/space-configuration.js

@@ -18,8 +18,8 @@ exports.SpaceConfigSchema = validator_1.Joi.object({
     name: validator_1.Joi.string().required(),
     // @see: https://github.com/sideway/joi/blob/master/API.md#string
     description: validator_1.Joi.string().required().allow('').default(''),
-    // 字节数,默认给个1GB, size 为 0 表示空间无限制
-    size: validator_1.Joi.number().required().default(xbytes_1.default.parseSize('1GB')),
+    // 字节数,默认给个1GiB, size 为 0 表示空间无限制
+    size: validator_1.Joi.number().required().default(xbytes_1.default.parseSize('1GiB')),
     assetDid: validator_1.Joi.DID(),
     createAt: validator_1.Joi.string().required(),
     updateAt: validator_1.Joi.string().required(),

package/dist/space/object-space.d.ts

@@ -11,14 +11,16 @@ export type ObjectSpaceOptions = {
     treeRepository: TreeRepository;
     objectRepository: ObjectRepository;
     objectCollectionRepository: ObjectCollectionRepository;
+    /**
+     * @description 忽略存储容量限制吗?
+     * @type {(false | true)}
+     */
+    ignoreStorageLimit?: false | true;
 };
 export declare class ObjectSpace implements SpaceProtocol {
-    readonly spaceDid: string;
-    readonly driver: DriverProtocol;
-    readonly objectRepository: ObjectRepository;
-    readonly treeRepository: TreeRepository;
-    readonly objectCollectionRepository: ObjectCollectionRepository;
+    readonly options: ObjectSpaceOptions;
     readonly globalSpace: GlobalSpace;
+    readonly driver: DriverProtocol;
     static readonly READONLY_OBJECT_KEYS: string[];
     constructor(options: ObjectSpaceOptions);
     createSpace(spaceConfig: SpaceConfig): Promise<void>;

package/dist/space/object-space.js

@@ -39,10 +39,7 @@ class ObjectSpace {
             throw error;
         }
         this.driver = options.driver;
-        this.spaceDid = options.spaceDid;
-        this.treeRepository = options.treeRepository;
-        this.objectRepository = options.objectRepository;
-        this.objectCollectionRepository = options.objectCollectionRepository;
+        this.options = options;
         this.globalSpace = new global_space_1.GlobalSpace({
             driver: options.driver,
             treeRepository: options.treeRepository,
@@ -61,11 +58,11 @@ class ObjectSpace {
     isSpaceCreated() {
         return __awaiter(this, void 0, void 0, function* () {
             const where = {
-                spaceDid: this.spaceDid,
+                spaceDid: this.options.spaceDid,
                 key: '/config.yml',
             };
             debug('isSpaceCreated.before', JSON.stringify(where));
-            const created = Boolean(yield this.treeRepository.count({
+            const created = Boolean(yield this.options.treeRepository.count({
                 where,
             }));
             debug('isSpaceCreated.after', JSON.stringify({ created }));
@@ -128,8 +125,12 @@ class ObjectSpace {
             if (!(yield this.isSpaceCreated())) {
                 return;
             }
+            // 如果忽略了存储限制，直接不用校验了
+            if (this.options.ignoreStorageLimit) {
+                return;
+            }
             const [did, capacity, usedCapacity] = yield Promise.all([
-                this.spaceDid,
+                this.options.spaceDid,
                 // @FIXME: 此处应该用 cache 层的数据,可以加速查询
                 this.get('size'),
                 this.getSpaceSize(),
@@ -140,7 +141,7 @@ class ObjectSpace {
                 .filter(Boolean);
             debug('verifySpace.before', { did, capacity, usedCapacity });
             if (capacity && usedCapacity + size >= capacity && !whiteList.includes(did)) {
-                throw new Error(`Insufficient free space, total capacity is ${(0, xbytes_1.default)(capacity)}, used capacity is ${(0, xbytes_1.default)(usedCapacity)}`);
+                throw new Error(`Insufficient free space, total capacity is ${(0, xbytes_1.default)(capacity, { iec: true })}, used capacity is ${(0, xbytes_1.default)(usedCapacity, { iec: true })}`);
             }
         });
     }
@@ -185,7 +186,7 @@ class ObjectSpace {
             debug('getHash.before', JSON.stringify({ options }));
             const key = (0, path_1.join)(yield this.getAppSpacePath(options), options.key);
             const where = {
-                spaceDid: this.spaceDid,
+                spaceDid: this.options.spaceDid,
                 key,
             };
             debug('getHash.$key', key);
@@ -193,7 +194,7 @@ class ObjectSpace {
             if (!(yield this.exists(options))) {
                 throw new Error(`Object(${key}) not exists`);
             }
-            const tree = yield this.treeRepository.findOne({ where });
+            const tree = yield this.options.treeRepository.findOne({ where });
             return tree.objectId;
         });
     }
@@ -207,21 +208,21 @@ class ObjectSpace {
     listsOneLevelAsOwner(options) {
         return __awaiter(this, void 0, void 0, function* () {
             const where = {
-                spaceDid: this.spaceDid,
+                spaceDid: this.options.spaceDid,
                 key: options.key,
             };
             debug('listsOneLevel.before', JSON.stringify(options));
-            const parentTree = yield this.treeRepository.findOne({
+            const parentTree = yield this.options.treeRepository.findOne({
                 where,
                 raw: true,
             });
             debug('listsOneLevel.$parentTree', JSON.stringify(parentTree, null, 2));
-            const trees = yield this.treeRepository.findAll({
+            const trees = yield this.options.treeRepository.findAll({
                 where: {
-                    spaceDid: this.spaceDid,
+                    spaceDid: this.options.spaceDid,
                     parentId: parentTree.id,
                 },
-                include: this.objectRepository,
+                include: this.options.objectRepository,
             });
             return Promise.all(trees.map((x) => __awaiter(this, void 0, void 0, function* () {
                 const absolutePath = (0, path_1.join)(x.spaceDid, x.key);
@@ -259,15 +260,15 @@ class ObjectSpace {
         return __awaiter(this, void 0, void 0, function* () {
             debug('listsRecursiveAsOwner.before', JSON.stringify(options));
             const where = {
-                spaceDid: this.spaceDid,
+                spaceDid: this.options.spaceDid,
                 key: {
                     [skypesky_sequelize_1.Op.like]: `${options.key}%`,
                 },
                 type: model_1.TreeModelType.FILE,
             };
-            const trees = yield this.treeRepository.findAll({
+            const trees = yield this.options.treeRepository.findAll({
                 where,
-                include: this.objectRepository,
+                include: this.options.objectRepository,
             });
             return trees.map((x) => {
                 return {
@@ -322,12 +323,12 @@ class ObjectSpace {
         return __awaiter(this, void 0, void 0, function* () {
             debug('list.before', JSON.stringify(options));
             const where = {
-                spaceDid: this.spaceDid,
+                spaceDid: this.options.spaceDid,
                 key: options.key,
             };
-            const x = yield this.treeRepository.findOne({
+            const x = yield this.options.treeRepository.findOne({
                 where,
-                include: this.objectRepository,
+                include: this.options.objectRepository,
             });
             return {
                 key: x.key,
@@ -395,13 +396,13 @@ class ObjectSpace {
                 return;
             }
             const where = {
-                spaceDid: this.spaceDid,
+                spaceDid: this.options.spaceDid,
                 key,
             };
             debug('updateAsOwner.before', JSON.stringify({ key, options: (0, omit_1.default)(options, 'data'), where }));
-            const oldTree = yield this.treeRepository.findOne({
+            const oldTree = yield this.options.treeRepository.findOne({
                 where,
-                include: this.objectRepository,
+                include: this.options.objectRepository,
             });
             debug('updateAsOwner.$oldTree', JSON.stringify(oldTree));
             const listObject = yield this.driver.list({
@@ -413,7 +414,7 @@ class ObjectSpace {
                 oldTree.Object.size === options.size &&
                 (listObject === null || listObject === void 0 ? void 0 : listObject.size) === options.size) {
                 // 内容不变，不需要再次存储对象，只需要更新对象的事件即可
-                yield this.treeRepository.update({
+                yield this.options.treeRepository.update({
                     updatedAt: new Date().toISOString(),
                 }, {
                     where: {
@@ -424,7 +425,7 @@ class ObjectSpace {
             }
             yield this.globalSpace.add(key, data, options);
             // 更新 tree 记录
-            yield this.treeRepository.update({
+            yield this.options.treeRepository.update({
                 updatedAt: new Date().toISOString(),
                 objectId: options.hash,
             }, {
@@ -442,8 +443,8 @@ class ObjectSpace {
             const isDir = key.endsWith('/');
             if (isDir) {
                 // 添加 tree 记录
-                yield this.treeRepository.deepCreate({
-                    spaceDid: this.spaceDid,
+                yield this.options.treeRepository.deepCreate({
+                    spaceDid: this.options.spaceDid,
                     objectId: null,
                     parentId: null,
                     key,
@@ -455,8 +456,8 @@ class ObjectSpace {
             // 存储新对象到全局存储区
             yield this.globalSpace.add(key, data, options);
             // 添加 tree 记录
-            yield this.treeRepository.deepCreate({
-                spaceDid: this.spaceDid,
+            yield this.options.treeRepository.deepCreate({
+                spaceDid: this.options.spaceDid,
                 objectId: options.hash,
                 parentId: null,
                 key,
@@ -469,12 +470,12 @@ class ObjectSpace {
         return __awaiter(this, void 0, void 0, function* () {
             debug('updateMetadata.before', { key, options: (0, omit_1.default)(options, 'data') });
             const where = {
-                spaceDid: this.spaceDid,
+                spaceDid: this.options.spaceDid,
                 key,
                 type: key.endsWith('/') ? model_1.TreeModelType.FOLDER : model_1.TreeModelType.FILE,
             };
             debug('updateMetadata.before', JSON.stringify({ key, options: (0, omit_1.default)(options, 'data'), where }));
-            const oldTree = yield this.treeRepository.findOne({
+            const oldTree = yield this.options.treeRepository.findOne({
                 where,
             });
             debug('updateMetadata.$oldTree', JSON.stringify(oldTree));
@@ -501,34 +502,34 @@ class ObjectSpace {
             if (isDir) {
                 // 删除文件夹
                 const whereForDeleteFolder = {
-                    spaceDid: this.spaceDid,
+                    spaceDid: this.options.spaceDid,
                     // 删除以 key 开头的记录
                     key: {
                         [skypesky_sequelize_1.Op.like]: `${key}%`,
                     },
                 };
                 debug('deleteAsOwner.$whereForDeleteFolder', JSON.stringify(whereForDeleteFolder));
-                const trees = yield this.treeRepository.findAll({
+                const trees = yield this.options.treeRepository.findAll({
                     where: whereForDeleteFolder,
                     attributes: ['objectId'],
                     raw: true,
                 });
-                yield this.treeRepository.destroy({
+                yield this.options.treeRepository.destroy({
                     where: whereForDeleteFolder,
                 });
                 yield this.globalSpace.mark(...trees.map((x) => x.objectId));
                 return;
             }
             const where = {
-                spaceDid: this.spaceDid,
+                spaceDid: this.options.spaceDid,
                 key,
             };
-            const tree = yield this.treeRepository.findOne({
+            const tree = yield this.options.treeRepository.findOne({
                 where,
                 attributes: ['objectId'],
                 raw: true,
             });
-            yield this.treeRepository.destroy({
+            yield this.options.treeRepository.destroy({
                 where,
             });
             yield this.globalSpace.mark(tree.objectId);
@@ -538,11 +539,11 @@ class ObjectSpace {
         return __awaiter(this, void 0, void 0, function* () {
             debug('readAsOwner.before', JSON.stringify({ key, options }));
             const where = {
-                spaceDid: this.spaceDid,
+                spaceDid: this.options.spaceDid,
                 key,
             };
             debug('readAsOwner.$where', JSON.stringify(where));
-            const tree = yield this.treeRepository.findOne({
+            const tree = yield this.options.treeRepository.findOne({
                 where,
             });
             if (!tree) {
@@ -554,11 +555,11 @@ class ObjectSpace {
     existsAsOwner(key) {
         return __awaiter(this, void 0, void 0, function* () {
             const where = {
-                spaceDid: this.spaceDid,
+                spaceDid: this.options.spaceDid,
                 key,
             };
             debug('existsAsOwner.before', JSON.stringify({ where }));
-            const exists = Boolean(yield this.treeRepository.count({
+            const exists = Boolean(yield this.options.treeRepository.count({
                 where,
             }));
             debug('existsAsOwner.after', JSON.stringify({ exists }));
@@ -568,7 +569,7 @@ class ObjectSpace {
     getStatusAsOwner(key) {
         return __awaiter(this, void 0, void 0, function* () {
             debug('getStatusAsOwner.before', JSON.stringify({
-                spaceDid: this.spaceDid,
+                spaceDid: this.options.spaceDid,
                 key,
             }));
             const { error } = schemas_1.OwnerOperatorKeySchema.validate(key);
@@ -576,22 +577,22 @@ class ObjectSpace {
                 throw error;
             }
             const where = {
-                spaceDid: this.spaceDid,
+                spaceDid: this.options.spaceDid,
                 key: {
                     [skypesky_sequelize_1.Op.like]: `${key}%`,
                 },
                 type: model_1.TreeModelType.FILE,
             };
-            const objects = yield this.treeRepository.count({ where });
-            const lastModified = yield this.treeRepository.max('updatedAt', {
+            const objects = yield this.options.treeRepository.count({ where });
+            const lastModified = yield this.options.treeRepository.max('updatedAt', {
                 where,
             });
             // @FIXME: 没有正确关联
-            const objectRecords = yield this.objectRepository.sequelize.query(`SELECT SUM(Object.size) as totalSize FROM Object JOIN Tree ON Object.id = Tree.objectId WHERE Tree.spaceDid = '${this.spaceDid}' AND Tree.key LIKE '${key}%'`, { type: skypesky_sequelize_1.QueryTypes.SELECT });
+            const objectRecords = yield this.options.objectRepository.sequelize.query(`SELECT SUM(Object.size) as totalSize FROM Object JOIN Tree ON Object.id = Tree.objectId WHERE Tree.spaceDid = '${this.options.spaceDid}' AND Tree.type = ${model_1.TreeModelType.FILE} AND Tree.key LIKE '${key}%'`, { type: skypesky_sequelize_1.QueryTypes.SELECT });
             // @ts-expect-error
             const size = objectRecords[0].totalSize;
             debug('getStatusAsOwner.after', JSON.stringify({
-                spaceDid: this.spaceDid,
+                spaceDid: this.options.spaceDid,
                 key,
                 objects,
                 size,

package/dist/space/space.js

@@ -131,7 +131,9 @@ class Space {
             }
             const spaceStatus = yield this.getSpaceStatus();
             if (spaceStatus.isFull) {
-                throw new Error(`Insufficient free space, total capacity is ${(0, xbytes_1.default)(spaceStatus.totalCapacity)}, used capacity is ${(0, xbytes_1.default)(spaceStatus.usedCapacity)}`);
+                throw new Error(`Insufficient free space, total capacity is ${(0, xbytes_1.default)(spaceStatus.totalCapacity, {
+                    iec: true,
+                })}, used capacity is ${(0, xbytes_1.default)(spaceStatus.usedCapacity, { iec: true })}`);
             }
             return this.driver.write(options);
         });
@@ -162,7 +164,9 @@ class Space {
             }
             const spaceStatus = yield this.getSpaceStatus();
             if (spaceStatus.isFull) {
-                throw new Error(`Insufficient free space, total capacity is ${(0, xbytes_1.default)(spaceStatus.totalCapacity)}, used capacity is ${(0, xbytes_1.default)(spaceStatus.usedCapacity)}`);
+                throw new Error(`Insufficient free space, total capacity is ${(0, xbytes_1.default)(spaceStatus.totalCapacity, {
+                    iec: true,
+                })}, used capacity is ${(0, xbytes_1.default)(spaceStatus.usedCapacity, { iec: true })}`);
             }
             return this.driver.writeAsOwner(key, data);
         });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@did-space/core",
-  "version": "0.4.18",
+  "version": "0.4.20",
   "publishConfig": {
     "access": "public"
   },
@@ -61,5 +61,5 @@
     "ts-jest": "^28.0.8",
     "typescript": "^4.9.5"
   },
-  "gitHead": "16f9562aa0bb6781919ee9cfad04dcaabfa74d6e"
+  "gitHead": "3791c92ff078f306d84a2c0fda775edf13ce6826"
 }