@nocobase/plugin-file-manager 0.11.1-alpha.5 → 0.12.0-alpha.2

package/src/server/__tests__/action.test.ts

@@ -1,332 +0,0 @@
-import { promises as fs } from 'fs';
-import path from 'path';
-import { getApp } from '.';
-import { FILE_FIELD_NAME, STORAGE_TYPE_LOCAL } from '../constants';
-
-const { LOCAL_STORAGE_BASE_URL, LOCAL_STORAGE_DEST = 'storage/uploads', APP_PORT = '13000' } = process.env;
-
-const DEFAULT_LOCAL_BASE_URL = LOCAL_STORAGE_BASE_URL || `http://localhost:${APP_PORT}/storage/uploads`;
-
-describe('action', () => {
-  let app;
-  let agent;
-  let db;
-  let StorageRepo;
-  let AttachmentRepo;
-
-  beforeEach(async () => {
-    app = await getApp({
-      database: {},
-    });
-    agent = app.agent();
-    db = app.db;
-
-    AttachmentRepo = db.getCollection('attachments').repository;
-    StorageRepo = db.getCollection('storages').repository;
-    await StorageRepo.create({
-      values: {
-        name: 'local1',
-        type: STORAGE_TYPE_LOCAL,
-        baseUrl: DEFAULT_LOCAL_BASE_URL,
-        rules: {
-          size: 1024,
-        },
-        paranoid: true,
-      },
-    });
-  });
-
-  afterEach(async () => {
-    await db.close();
-  });
-
-  describe('create / upload', () => {
-    describe('default storage', () => {
-      it('upload file should be ok', async () => {
-        const { body } = await agent.resource('attachments').create({
-          [FILE_FIELD_NAME]: path.resolve(__dirname, './files/text.txt'),
-        });
-
-        const matcher = {
-          title: 'text',
-          extname: '.txt',
-          path: '',
-          size: 13,
-          mimetype: 'text/plain',
-          meta: {},
-          storageId: 1,
-        };
-
-        // 文件上传和解析是否正常
-        expect(body.data).toMatchObject(matcher);
-        // 文件的 url 是否正常生成
-        expect(body.data.url).toBe(`${DEFAULT_LOCAL_BASE_URL}${body.data.path}/${body.data.filename}`);
-
-        const Attachment = db.getModel('attachments');
-        const attachment = await Attachment.findOne({
-          where: { id: body.data.id },
-          include: ['storage'],
-        });
-        // 文件的数据是否正常保存
-        expect(attachment).toMatchObject(matcher);
-
-        // 关联的存储引擎是否正确
-        const storage = await attachment.getStorage();
-        expect(storage).toMatchObject({
-          type: 'local',
-          options: { documentRoot: LOCAL_STORAGE_DEST },
-          rules: {},
-          path: '',
-          baseUrl: DEFAULT_LOCAL_BASE_URL,
-          default: true,
-        });
-
-        const { documentRoot = 'storage/uploads' } = storage.options || {};
-        const destPath = path.resolve(
-          path.isAbsolute(documentRoot) ? documentRoot : path.join(process.cwd(), documentRoot),
-          storage.path,
-        );
-        const file = await fs.readFile(`${destPath}/${attachment.filename}`);
-        // 文件是否保存到指定路径
-        expect(file.toString()).toBe('Hello world!\n');
-
-        // 通过 url 是否能正确访问
-        const url = attachment.url.replace(`http://localhost:${APP_PORT}`, '');
-        const content = await agent.get(url);
-        expect(content.text).toBe('Hello world!\n');
-      });
-    });
-
-    describe('specific storage', () => {
-      it('fail as 400 because file size greater than rules', async () => {
-        db.collection({
-          name: 'customers',
-          fields: [
-            {
-              name: 'avatar',
-              type: 'belongsTo',
-              target: 'attachments',
-              storage: 'local1',
-            },
-          ],
-        });
-
-        const response = await agent.resource('attachments').create({
-          attachmentField: 'customers.avatar',
-          file: path.resolve(__dirname, './files/image.jpg'),
-        });
-        expect(response.status).toBe(400);
-      });
-
-      it('fail as 400 because file mimetype does not match', async () => {
-        const textStorage = await StorageRepo.create({
-          values: {
-            name: 'local2',
-            type: STORAGE_TYPE_LOCAL,
-            baseUrl: DEFAULT_LOCAL_BASE_URL,
-            rules: {
-              mimetype: ['text/*'],
-            },
-          },
-        });
-
-        db.collection({
-          name: 'customers',
-          fields: [
-            {
-              name: 'avatar',
-              type: 'belongsTo',
-              target: 'attachments',
-              storage: textStorage.name,
-            },
-          ],
-        });
-
-        // await db.sync();
-
-        const response = await agent.resource('attachments').create({
-          attachmentField: 'customers.avatar',
-          file: path.resolve(__dirname, './files/image.jpg'),
-        });
-
-        expect(response.status).toBe(400);
-      });
-
-      it('upload to storage which is not default', async () => {
-        const BASE_URL = `http://localhost:${APP_PORT}/another-uploads`;
-        const urlPath = 'test/path';
-
-        // 动态添加 storage
-        const storage = await StorageRepo.create({
-          values: {
-            name: 'local_private',
-            type: STORAGE_TYPE_LOCAL,
-            rules: {
-              mimetype: ['text/*'],
-            },
-            path: urlPath,
-            baseUrl: BASE_URL,
-            options: {
-              documentRoot: 'uploads/another',
-            },
-          },
-        });
-
-        db.collection({
-          name: 'customers',
-          fields: [
-            {
-              name: 'file',
-              type: 'belongsTo',
-              target: 'attachments',
-              storage: storage.name,
-            },
-          ],
-        });
-
-        const { body } = await agent.resource('attachments').create({
-          attachmentField: 'customers.file',
-          file: path.resolve(__dirname, './files/text.txt'),
-        });
-
-        // 文件的 url 是否正常生成
-        expect(body.data.url).toBe(`${BASE_URL}/${urlPath}/${body.data.filename}`);
-        console.log(body.data.url);
-        const url = body.data.url.replace(`http://localhost:${APP_PORT}`, '');
-        const content = await agent.get(url);
-        expect(content.text).toBe('Hello world!\n');
-      });
-    });
-  });
-
-  describe('destroy', () => {
-    it('destroy one existing file with `paranoid`', async () => {
-      db.collection({
-        name: 'customers',
-        fields: [
-          {
-            name: 'file',
-            type: 'belongsTo',
-            target: 'attachments',
-            storage: 'local1',
-          },
-        ],
-      });
-
-      await db.sync();
-
-      const { body } = await agent.resource('attachments').create({
-        [FILE_FIELD_NAME]: path.resolve(__dirname, './files/text.txt'),
-        attachmentField: 'customers.file',
-      });
-
-      const { data: attachment } = body;
-
-      // 关联的存储引擎是否正确
-      const storage = await StorageRepo.findById(attachment.storageId);
-
-      const { documentRoot = 'storage/uploads' } = storage.options || {};
-      const destPath = path.resolve(
-        path.isAbsolute(documentRoot) ? documentRoot : path.join(process.cwd(), documentRoot),
-        storage.path,
-      );
-      const file = await fs.stat(path.join(destPath, attachment.filename));
-      expect(file).toBeTruthy();
-
-      const res2 = await agent.resource('attachments').destroy({ filterByTk: attachment.id });
-
-      const attachmentExists = await AttachmentRepo.findById(attachment.id);
-      expect(attachmentExists).toBeNull();
-
-      const fileExists = await fs.stat(path.join(destPath, attachment.filename)).catch(() => false);
-      expect(fileExists).toBeTruthy();
-    });
-
-    it('destroy one existing file', async () => {
-      const { body } = await agent.resource('attachments').create({
-        [FILE_FIELD_NAME]: path.resolve(__dirname, './files/text.txt'),
-      });
-
-      const { data: attachment } = body;
-
-      const storage = await StorageRepo.findById(attachment.storageId);
-
-      const { documentRoot = path.join('storage', 'uploads') } = storage.options || {};
-      const destPath = path.resolve(
-        path.isAbsolute(documentRoot) ? documentRoot : path.join(process.cwd(), documentRoot),
-        storage.path,
-      );
-      const file = await fs.stat(path.join(destPath, attachment.filename));
-      expect(file).toBeTruthy();
-
-      const res2 = await agent.resource('attachments').destroy({ filterByTk: attachment.id });
-
-      const attachmentExists = await AttachmentRepo.findById(attachment.id);
-      expect(attachmentExists).toBeNull();
-
-      const fileExists = await fs.stat(path.join(destPath, attachment.filename)).catch(() => false);
-      expect(fileExists).toBeFalsy();
-    });
-
-    it('destroy multiple existing files', async () => {
-      const { body: f1 } = await agent.resource('attachments').create({
-        [FILE_FIELD_NAME]: path.resolve(__dirname, './files/text.txt'),
-      });
-
-      const { body: f2 } = await agent.resource('attachments').create({
-        [FILE_FIELD_NAME]: path.resolve(__dirname, './files/text.txt'),
-      });
-
-      const storage = await StorageRepo.findOne({
-        filter: {
-          name: 'local1',
-        },
-      });
-
-      const { documentRoot = path.join('storage', 'uploads') } = storage.options || {};
-      const destPath = path.resolve(
-        path.isAbsolute(documentRoot) ? documentRoot : path.join(process.cwd(), documentRoot),
-        storage.path,
-      );
-      const file1 = await fs.stat(path.join(destPath, f1.data.filename));
-      expect(file1).toBeTruthy();
-
-      const res2 = await agent.resource('attachments').destroy({ filter: { id: [f1.data.id, f2.data.id] } });
-
-      const attachmentExists = await AttachmentRepo.count();
-      expect(attachmentExists).toBe(0);
-
-      const file1Exists = await fs.stat(path.join(destPath, f1.data.filename)).catch(() => false);
-      expect(file1Exists).toBeFalsy();
-
-      const file2Exists = await fs.stat(path.join(destPath, f2.data.filename)).catch(() => false);
-      expect(file2Exists).toBeFalsy();
-    });
-
-    it('destroy record without file exists should be ok', async () => {
-      const { body } = await agent.resource('attachments').create({
-        [FILE_FIELD_NAME]: path.resolve(__dirname, './files/text.txt'),
-      });
-
-      const { data: attachment } = body;
-
-      const storage = await StorageRepo.findById(attachment.storageId);
-
-      const { documentRoot = path.join('storage', 'uploads') } = storage.options || {};
-      const destPath = path.resolve(
-        path.isAbsolute(documentRoot) ? documentRoot : path.join(process.cwd(), documentRoot),
-        storage.path,
-      );
-      const filePath = path.join(destPath, attachment.filename);
-      const file = await fs.stat(filePath);
-      expect(file).toBeTruthy();
-      await fs.unlink(filePath);
-
-      const res2 = await agent.resource('attachments').destroy({ filterByTk: attachment.id });
-      expect(res2.status).toBe(200);
-
-      const attachmentExists = await AttachmentRepo.findById(attachment.id);
-      expect(attachmentExists).toBeNull();
-    });
-  });
-});

package/src/server/__tests__/attachment.test.ts

@@ -1,50 +0,0 @@
-import { getApp } from '.';
-
-describe('attachment', () => {
-  let db;
-  let app;
-
-  beforeEach(async () => {
-    app = await getApp();
-    db = app.db;
-  });
-
-  afterEach(async () => {
-    await app.destroy();
-  });
-
-  it('should linked to a instance', async () => {
-    const testCollection = db.collection({
-      name: 'test',
-      fields: [
-        {
-          name: 'name',
-          type: 'string',
-        },
-        {
-          type: 'belongsTo',
-          name: 'logo',
-          target: 'attachments',
-        },
-      ],
-    });
-
-    await db.sync();
-
-    await testCollection.repository.create({
-      values: {
-        name: 'test',
-        logo: {
-          title: 'nocobase-logo',
-          filename: '682e5ad037dd02a0fe4800a3e91c283b.png',
-          extname: '.png',
-          mimetype: 'image/png',
-          url: 'https://nocobase.oss-cn-beijing.aliyuncs.com/682e5ad037dd02a0fe4800a3e91c283b.png',
-        },
-      },
-    });
-
-    const item = await testCollection.repository.findOne({});
-    expect(item.get('logoId')).toBeDefined();
-  });
-});

package/src/server/__tests__/files/text.txt

@@ -1 +0,0 @@
-Hello world!

package/src/server/__tests__/index.ts

@@ -1,34 +0,0 @@
-import { MockServer, mockServer } from '@nocobase/test';
-import path from 'path';
-import supertest from 'supertest';
-
-import plugin from '../';
-
-export async function getApp(options = {}): Promise<MockServer> {
-  const app = mockServer({
-    ...options,
-    cors: {
-      origin: '*',
-    },
-    acl: false,
-  });
-
-  await app.cleanDb();
-
-  app.plugin(plugin);
-
-  app.db.import({
-    directory: path.resolve(__dirname, './tables'),
-  });
-
-  await app.loadAndInstall();
-
-  return app;
-}
-
-// because the app in supertest will use a random port
-export function requestFile(url, agent) {
-  // url starts with double slash "//" will be considered as http or https
-  // url starts with single slash "/" will be considered from local server
-  return url[0] === '/' && url[1] !== '/' ? agent.get(url) : supertest.agent(url).get('');
-}

package/src/server/__tests__/storages/ali-oss.test.ts

@@ -1,127 +0,0 @@
-import path from 'path';
-import { MockServer } from '@nocobase/test';
-import aliossStorage from '../../storages/ali-oss';
-import { FILE_FIELD_NAME } from '../../constants';
-import { getApp, requestFile } from '..';
-import { Database } from '@nocobase/database';
-
-const itif = process.env.ALI_OSS_ACCESS_KEY_SECRET ? it : it.skip;
-
-describe('storage:ali-oss', () => {
-  let app: MockServer;
-  let agent;
-  let db: Database;
-  let AttachmentRepo;
-  let StorageRepo;
-  let storage;
-
-  beforeEach(async () => {
-    app = await getApp();
-    agent = app.agent();
-    db = app.db;
-
-    AttachmentRepo = db.getCollection('attachments').repository;
-    StorageRepo = db.getCollection('storages').repository;
-
-    storage = await StorageRepo.create({
-      values: {
-        ...aliossStorage.defaults(),
-        name: 'ali-oss',
-        default: true,
-        path: 'test/path',
-      },
-    });
-  });
-
-  afterEach(async () => {
-    await db.close();
-  });
-
-  describe('upload', () => {
-    itif('upload file should be ok', async () => {
-      const { body } = await agent.resource('attachments').create({
-        [FILE_FIELD_NAME]: path.resolve(__dirname, '../files/text.txt'),
-      });
-
-      const Attachment = db.getCollection('attachments').model;
-      const attachment = await Attachment.findOne<any>({
-        where: { id: body.data.id },
-        include: ['storage'],
-      });
-
-      const matcher = {
-        title: 'text',
-        extname: '.txt',
-        path: 'test/path',
-        size: 13,
-        mimetype: 'text/plain',
-        meta: {},
-        storageId: storage.id,
-      };
-
-      // 文件上传和解析是否正常
-      expect(body.data).toMatchObject(matcher);
-      // 文件的 url 是否正常生成
-      expect(body.data.url).toBe(`${attachment.storage.baseUrl}/${body.data.path}/${body.data.filename}`);
-      // 文件的数据是否正常保存
-      expect(attachment).toMatchObject(matcher);
-
-      // 通过 url 是否能正确访问
-      const content = await requestFile(attachment.url, agent);
-
-      expect(content.text).toBe('Hello world!\n');
-    });
-  });
-
-  describe('destroy', () => {
-    itif('destroy record should also delete file', async () => {
-      const { body } = await agent.resource('attachments').create({
-        [FILE_FIELD_NAME]: path.resolve(__dirname, '../files/text.txt'),
-      });
-      // 通过 url 是否能正确访问
-      const content1 = await requestFile(body.data.url, agent);
-      expect(content1.text).toBe('Hello world!\n');
-
-      const res = await agent.resource('attachments').destroy({
-        filterByTk: body.data.id,
-      });
-
-      expect(res.statusCode).toBe(200);
-      const count = await AttachmentRepo.count();
-      expect(count).toBe(0);
-
-      const content2 = await requestFile(body.data.url, agent);
-      expect(content2.status).toBe(404);
-    });
-
-    itif('destroy record should not delete file when paranoid', async () => {
-      const paranoidStorage = await StorageRepo.create({
-        values: {
-          ...aliossStorage.defaults(),
-          name: 'ali-oss-2',
-          path: 'test/nocobase',
-          paranoid: true,
-          default: true,
-        },
-      });
-
-      const { body } = await agent.resource('attachments').create({
-        [FILE_FIELD_NAME]: path.resolve(__dirname, '../files/text.txt'),
-      });
-      // 通过 url 是否能正确访问
-      const content1 = await requestFile(body.data.url, agent);
-      expect(content1.text).toBe('Hello world!\n');
-
-      const res = await agent.resource('attachments').destroy({
-        filterByTk: body.data.id,
-      });
-
-      expect(res.statusCode).toBe(200);
-      const count = await AttachmentRepo.count();
-      expect(count).toBe(0);
-
-      const content2 = await requestFile(body.data.url, agent);
-      expect(content2.status).toBe(200);
-    });
-  });
-});

package/src/server/__tests__/storages/s3.test.ts

@@ -1,126 +0,0 @@
-import path from 'path';
-import { MockServer } from '@nocobase/test';
-import s3Storage from '../../storages/s3';
-import { FILE_FIELD_NAME } from '../../constants';
-import { getApp, requestFile } from '..';
-import Database from '@nocobase/database';
-
-const itif = process.env.AWS_SECRET_ACCESS_KEY ? it : it.skip;
-
-describe('storage:s3', () => {
-  let app: MockServer;
-  let agent;
-  let db: Database;
-  let AttachmentRepo;
-  let StorageRepo;
-  let storage;
-
-  beforeEach(async () => {
-    app = await getApp();
-    agent = app.agent();
-    db = app.db;
-
-    AttachmentRepo = db.getCollection('attachments').repository;
-    StorageRepo = db.getCollection('storages').repository;
-
-    storage = await StorageRepo.create({
-      values: {
-        ...s3Storage.defaults(),
-        name: 's3',
-        default: true,
-        path: 'test/path',
-      },
-    });
-  });
-
-  afterEach(async () => {
-    await db.close();
-  });
-
-  describe('direct attachment', () => {
-    itif('upload file should be ok', async () => {
-      const { body } = await agent.resource('attachments').create({
-        [FILE_FIELD_NAME]: path.resolve(__dirname, '../files/text.txt'),
-      });
-
-      const attachment = await AttachmentRepo.findOne({
-        filterByTk: body.data.id,
-        appends: ['storage'],
-      });
-
-      const matcher = {
-        title: 'text',
-        extname: '.txt',
-        path: 'test/path',
-        size: 13,
-        mimetype: 'text/plain',
-        meta: {},
-        storageId: storage.id,
-      };
-
-      // 文件上传和解析是否正常
-      expect(body.data).toMatchObject(matcher);
-      // 文件的 url 是否正常生成
-      expect(body.data.url).toBe(`${attachment.storage.baseUrl}/${body.data.path}/${body.data.filename}`);
-      // 文件的数据是否正常保存
-      expect(attachment).toMatchObject(matcher);
-
-      // 通过 url 是否能正确访问
-      const content = await requestFile(attachment.url, agent);
-      expect(content.text).toBe('Hello world!\n');
-    });
-  });
-
-  describe('destroy', () => {
-    itif('destroy record should also delete file', async () => {
-      const { body } = await agent.resource('attachments').create({
-        [FILE_FIELD_NAME]: path.resolve(__dirname, '../files/text.txt'),
-      });
-      // 通过 url 是否能正确访问
-      const content1 = await requestFile(body.data.url, agent);
-      expect(content1.text).toBe('Hello world!\n');
-
-      const res = await agent.resource('attachments').destroy({
-        filterByTk: body.data.id,
-      });
-
-      expect(res.statusCode).toBe(200);
-      const count = await AttachmentRepo.count();
-      expect(count).toBe(0);
-
-      const content2 = await requestFile(body.data.url, agent);
-      console.log(content2.status, body.data.url);
-      expect(content2.status).toBe(403);
-    });
-
-    itif('destroy record should not delete file when paranoid', async () => {
-      const paranoidStorage = await StorageRepo.create({
-        values: {
-          ...s3Storage.defaults(),
-          name: 's3-2',
-          path: 'test/nocobase',
-          paranoid: true,
-          default: true,
-        },
-      });
-
-      const { body } = await agent.resource('attachments').create({
-        [FILE_FIELD_NAME]: path.resolve(__dirname, '../files/text.txt'),
-      });
-      // 通过 url 是否能正确访问
-      const content1 = await requestFile(body.data.url, agent);
-      expect(content1.text).toBe('Hello world!\n');
-
-      const res = await agent.resource('attachments').destroy({
-        filterByTk: body.data.id,
-      });
-
-      expect(res.statusCode).toBe(200);
-      const count = await AttachmentRepo.count();
-      expect(count).toBe(0);
-
-      const content2 = await requestFile(body.data.url, agent);
-      expect(content2.status).toBe(200);
-    });
-  });
-});