@midwayjs/upload 3.0.0-beta.13 → 3.0.0-beta.14

package/CHANGELOG.md

@@ -3,6 +3,18 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.0.0-beta.14](https://github.com/midwayjs/midway/compare/v3.0.0-beta.13...v3.0.0-beta.14) (2022-01-04)
+
+
+### Bug Fixes
+
+* cos config definition & 3.x doc update ([#1515](https://github.com/midwayjs/midway/issues/1515)) ([0ac7ac5](https://github.com/midwayjs/midway/commit/0ac7ac5805b7ab8873f8792fc1712a74e3223172))
+* upload support auto clean and whitelist ([#1484](https://github.com/midwayjs/midway/issues/1484)) ([7daa037](https://github.com/midwayjs/midway/commit/7daa0371f4a3e79cd4789959d8427fc5b6c91d08))
+
+
+
+
+
 # [3.0.0-beta.13](https://github.com/midwayjs/midway/compare/v3.0.0-beta.12...v3.0.0-beta.13) (2021-12-30)
 
 **Note:** Version bump only for package @midwayjs/upload

package/README.md

@@ -68,5 +68,7 @@ export const upload = {
   whitelist: null,
   // tmpdir: string，上传的文件临时存储路径
   tmpdir: join(tmpdir(), 'midway-upload-files'),
+  // cleanTimeout: number，上传的文件在临时目录中多久之后自动删除，默认为 5 分钟
+  cleanTimeout: 5 * 60 * 1000,
 }
 ```

package/dist/config/config.default.js

@@ -3,41 +3,12 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.upload = void 0;
 const path_1 = require("path");
 const os_1 = require("os");
+const constants_1 = require("../constants");
 exports.upload = {
     mode: 'file',
     fileSize: '10mb',
-    whitelist: [
-        // images
-        '.jpg',
-        '.jpeg',
-        '.png',
-        '.gif',
-        '.bmp',
-        '.wbmp',
-        '.webp',
-        '.tif',
-        '.psd',
-        // text
-        '.svg',
-        '.js',
-        '.jsx',
-        '.json',
-        '.css',
-        '.less',
-        '.html',
-        '.htm',
-        '.xml',
-        '.pdf',
-        // tar
-        '.zip',
-        '.gz',
-        '.tgz',
-        '.gzip',
-        // video
-        '.mp3',
-        '.mp4',
-        '.avi',
-    ],
+    whitelist: constants_1.uploadWhiteList,
     tmpdir: (0, path_1.join)((0, os_1.tmpdir)(), 'midway-upload-files'),
+    cleanTimeout: 5 * 60 * 1000,
 };
 //# sourceMappingURL=config.default.js.map

package/dist/configuration.d.ts

@@ -1,7 +1,9 @@
 import { MidwayApplicationManager } from '@midwayjs/core';
+import { UploadOptions } from './interface';
 export declare class UploadConfiguration {
     applicationManager: MidwayApplicationManager;
-    uploadConfig: any;
+    uploadConfig: UploadOptions;
     onReady(): Promise<void>;
+    onStop(): Promise<void>;
 }
 //# sourceMappingURL=configuration.d.ts.map

package/dist/configuration.js

@@ -14,12 +14,15 @@ const decorator_1 = require("@midwayjs/decorator");
 const DefaultConfig = require("./config/config.default");
 const core_1 = require("@midwayjs/core");
 const middleware_1 = require("./middleware");
-const fs_extra_1 = require("fs-extra");
+const utils_1 = require("./utils");
 let UploadConfiguration = class UploadConfiguration {
     async onReady() {
-        const { tmpdir } = this.uploadConfig;
+        const { tmpdir, cleanTimeout } = this.uploadConfig;
         if (tmpdir) {
-            await (0, fs_extra_1.ensureDir)(tmpdir);
+            await (0, utils_1.ensureDir)(tmpdir);
+            if (cleanTimeout) {
+                (0, utils_1.autoRemoveUploadTmpFile)(tmpdir, cleanTimeout);
+            }
         }
         this.applicationManager
             .getApplications(['koa', 'faas', 'express', 'egg'])
@@ -27,6 +30,9 @@ let UploadConfiguration = class UploadConfiguration {
             app.useMiddleware(middleware_1.UploadMiddleware);
         });
     }
+    async onStop() {
+        await (0, utils_1.stopAutoRemoveUploadTmpFile)();
+    }
 };
 __decorate([
     (0, decorator_1.Inject)(),

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const uploadWhiteList: string[];
+//# sourceMappingURL=constants.d.ts.map

package/dist/constants.js

@@ -0,0 +1,36 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.uploadWhiteList = void 0;
+exports.uploadWhiteList = [
+    // images
+    '.jpg',
+    '.jpeg',
+    '.png',
+    '.gif',
+    '.bmp',
+    '.wbmp',
+    '.webp',
+    '.tif',
+    '.psd',
+    // text
+    '.svg',
+    '.js',
+    '.jsx',
+    '.json',
+    '.css',
+    '.less',
+    '.html',
+    '.htm',
+    '.xml',
+    '.pdf',
+    // tar
+    '.zip',
+    '.gz',
+    '.tgz',
+    '.gzip',
+    // video
+    '.mp3',
+    '.mp4',
+    '.avi',
+];
+//# sourceMappingURL=constants.js.map

package/dist/index.d.ts

@@ -2,4 +2,5 @@ export { UploadConfiguration as Configuration } from './configuration';
 export * from './interface';
 export * from './middleware';
 export * from './error';
+export * from './constants';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -16,4 +16,5 @@ Object.defineProperty(exports, "Configuration", { enumerable: true, get: functio
 __exportStar(require("./interface"), exports);
 __exportStar(require("./middleware"), exports);
 __exportStar(require("./error"), exports);
+__exportStar(require("./constants"), exports);
 //# sourceMappingURL=index.js.map

package/dist/interface.d.ts

@@ -6,6 +6,7 @@ export interface UploadOptions {
     fileSize?: string;
     whitelist?: string[];
     tmpdir?: string;
+    cleanTimeout?: number;
 }
 export interface UploadFileInfo<T> {
     filename: string;

package/dist/middleware.js

@@ -15,8 +15,9 @@ const path_1 = require("path");
 const fs_1 = require("fs");
 const stream_1 = require("stream");
 const _1 = require(".");
-const upload_1 = require("./upload");
+const parse_1 = require("./parse");
 const getRawBody = require("raw-body");
+const { unlink, writeFile } = fs_1.promises;
 let UploadMiddleware = class UploadMiddleware {
     resolve(app) {
         if (app.getFrameworkType() === decorator_1.MidwayFrameworkType.WEB_EXPRESS) {
@@ -39,10 +40,29 @@ let UploadMiddleware = class UploadMiddleware {
             return next();
         }
         ctx.fields = {};
+        ctx.files = [];
+        ctx.cleanupRequestFiles = async () => {
+            var _a;
+            if (!((_a = ctx.files) === null || _a === void 0 ? void 0 : _a.length)) {
+                return [];
+            }
+            return Promise.all(ctx.files.map(async (fileInfo) => {
+                if (typeof fileInfo.data !== 'string') {
+                    return false;
+                }
+                try {
+                    await unlink(fileInfo.data);
+                    return true;
+                }
+                catch (_a) {
+                    return false;
+                }
+            }));
+        };
         let body;
         if (this.isReadableStream(req, isExpress)) {
             if (mode === 'stream') {
-                const { fields, fileInfo } = await (0, upload_1.parseFromReadableStream)(req, boundary);
+                const { fields, fileInfo } = await (0, parse_1.parseFromReadableStream)(req, boundary);
                 if (!this.checkExt(fileInfo.filename)) {
                     throw new _1.MultipartInvalidFilenameError(fileInfo.filename);
                 }
@@ -59,7 +79,7 @@ let UploadMiddleware = class UploadMiddleware {
         else {
             body = req.body;
         }
-        const data = await (0, upload_1.parseMultipart)(body, boundary);
+        const data = await (0, parse_1.parseMultipart)(body, boundary);
         if (!data) {
             return next();
         }
@@ -74,12 +94,12 @@ let UploadMiddleware = class UploadMiddleware {
         if (notCheckFile) {
             throw new _1.MultipartInvalidFilenameError(notCheckFile.filename);
         }
-        ctx.files = files.map((file, index) => {
+        ctx.files = await Promise.all(files.map(async (file, index) => {
             const { data, filename } = file;
             if (mode === 'file') {
                 const ext = (0, path_1.extname)(filename);
                 const tmpFileName = (0, path_1.resolve)(tmpdir, `${requireId}.${index}${ext}`);
-                (0, fs_1.writeFileSync)(tmpFileName, data, 'binary');
+                await writeFile(tmpFileName, data, 'binary');
                 file.data = tmpFileName;
             }
             else if (mode === 'stream') {
@@ -91,7 +111,7 @@ let UploadMiddleware = class UploadMiddleware {
                 });
             }
             return file;
-        });
+        }));
         return next();
     }
     getUploadBoundary(request) {

package/dist/{upload.d.ts → parse.d.ts}

@@ -12,4 +12,4 @@ export declare const parseFromReadableStream: (readStream: Readable, boundary: a
 export declare const bufferIndexOf: (buffer: Buffer, search: Buffer, offset?: number) => number;
 export declare const bufferSplit: (buffer: Buffer, separator: Buffer, limit?: number) => Buffer[];
 export declare const parseHead: (headBuf: Buffer) => {};
-//# sourceMappingURL=upload.d.ts.map
+//# sourceMappingURL=parse.d.ts.map

package/dist/{upload.js → parse.js}

@@ -186,4 +186,4 @@ const parseHead = (headBuf) => {
     return head;
 };
 exports.parseHead = parseHead;
-//# sourceMappingURL=upload.js.map
+//# sourceMappingURL=parse.js.map

package/dist/utils.d.ts

@@ -0,0 +1,5 @@
+export declare const autoRemoveUploadTmpFile: (tmpDir: string, cleanTimeout: number) => Promise<void>;
+export declare const stopAutoRemoveUploadTmpFile: () => Promise<void>;
+export declare const checkExists: (path: string) => Promise<boolean>;
+export declare const ensureDir: (dirPath: string) => Promise<boolean>;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.js

@@ -0,0 +1,71 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureDir = exports.checkExists = exports.stopAutoRemoveUploadTmpFile = exports.autoRemoveUploadTmpFile = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const { readdir, access, stat, unlink, mkdir } = fs_1.promises;
+let autoRemoveUploadTmpFileTimeoutHandler;
+let autoRemoveUploadTmpFilePromise;
+const autoRemoveUploadTmpFile = async (tmpDir, cleanTimeout) => {
+    clearTimeout(autoRemoveUploadTmpFileTimeoutHandler);
+    let waitTime = cleanTimeout / 3;
+    if (waitTime < 1000) {
+        waitTime = 1000;
+    }
+    if (autoRemoveUploadTmpFilePromise) {
+        const exists = await (0, exports.checkExists)(tmpDir);
+        if (exists) {
+            const paths = await readdir(tmpDir);
+            const now = Date.now();
+            await Promise.all(paths.map(async (path) => {
+                const filePath = (0, path_1.join)(tmpDir, path);
+                try {
+                    const statInfo = await stat(filePath);
+                    if (statInfo.isFile() && now - statInfo.ctimeMs > cleanTimeout) {
+                        await unlink(filePath);
+                    }
+                }
+                catch (_a) {
+                    return false;
+                }
+            }));
+        }
+    }
+    autoRemoveUploadTmpFileTimeoutHandler = setTimeout(() => {
+        autoRemoveUploadTmpFilePromise = (0, exports.autoRemoveUploadTmpFile)(tmpDir, cleanTimeout);
+    }, waitTime);
+};
+exports.autoRemoveUploadTmpFile = autoRemoveUploadTmpFile;
+const stopAutoRemoveUploadTmpFile = async () => {
+    if (autoRemoveUploadTmpFilePromise) {
+        await autoRemoveUploadTmpFilePromise;
+        autoRemoveUploadTmpFilePromise = null;
+    }
+    clearTimeout(autoRemoveUploadTmpFileTimeoutHandler);
+};
+exports.stopAutoRemoveUploadTmpFile = stopAutoRemoveUploadTmpFile;
+const checkExists = async (path) => {
+    try {
+        await access(path, fs_1.constants.W_OK | fs_1.constants.R_OK);
+        return true;
+    }
+    catch (_a) {
+        return false;
+    }
+};
+exports.checkExists = checkExists;
+const ensureDir = async (dirPath) => {
+    const isExists = await (0, exports.checkExists)(dirPath);
+    if (isExists) {
+        return true;
+    }
+    try {
+        await mkdir(dirPath, { recursive: true });
+        return true;
+    }
+    catch (_a) {
+        return false;
+    }
+};
+exports.ensureDir = ensureDir;
+//# sourceMappingURL=utils.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@midwayjs/upload",
-  "version": "3.0.0-beta.13",
+  "version": "3.0.0-beta.14",
   "description": "Midway Component for upload",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
@@ -21,18 +21,17 @@
   },
   "license": "MIT",
   "dependencies": {
-    "fs-extra": "^8.0.1",
-    "raw-body": "^2.4.1"
+    "raw-body": "2.4.2"
   },
   "devDependencies": {
-    "@midwayjs/core": "^3.0.0-beta.13",
-    "@midwayjs/decorator": "^3.0.0-beta.13",
-    "@midwayjs/express": "^3.0.0-beta.13",
-    "@midwayjs/faas": "^3.0.0-beta.13",
-    "@midwayjs/koa": "^3.0.0-beta.13",
-    "@midwayjs/mock": "^3.0.0-beta.13",
-    "@midwayjs/serverless-app": "^3.0.0-beta.13",
-    "@midwayjs/web": "^3.0.0-beta.13"
+    "@midwayjs/core": "^3.0.0-beta.14",
+    "@midwayjs/decorator": "^3.0.0-beta.14",
+    "@midwayjs/express": "^3.0.0-beta.14",
+    "@midwayjs/faas": "^3.0.0-beta.14",
+    "@midwayjs/koa": "^3.0.0-beta.14",
+    "@midwayjs/mock": "^3.0.0-beta.14",
+    "@midwayjs/serverless-app": "^3.0.0-beta.14",
+    "@midwayjs/web": "^3.0.0-beta.14"
   },
-  "gitHead": "d3c47770fee9dce33a8d148882173fd7782864ad"
+  "gitHead": "95695ada36190cf376e93a1a8866b3fb6dde06bc"
 }