Merge pull request #41 from import-ai/fix/upload_encoding

fix(upload): Fix uploaded filename encoding

Author: hewenguang

.env.example

@@ -15,3 +15,6 @@ OBB_JWT_EXPIRE=2678400s
 
 OBB_MAIL_TRANSPORT=smtps://your-email@example.com:your-email-password@smtp.example.com:465
 OBB_MAIL_FROM="No Reply <no-reply@example.com>"
+
+OBB_MINIO_ENDPOINT=http://username:password@localhost:9000
+OBB_MINIO_BUCKET=omnibox-default

README.md

@@ -16,6 +16,25 @@
   docker compose -f compose.yaml -f build.yaml up -d --build
   ```
 
++ Run with persistence postgres and minio data
+
+  ```shell
+  docker compose ... -f persistence.yaml ...
+  ```
+
++ Run with pgadmin
+
+  ```shell
+  docker compose ... -f pgadmin.yaml ...
+  ```
+
+Then login with:
+
+| Name     | Value            |
+|----------|------------------|
+| Username | `omnibox@qq.com` |
+| Password | `Passw0rd`       |
+
 ### Locally
 
 ```bash

compose.yaml

@@ -6,6 +6,9 @@ services:
       - "${OBB_PORT:-8000}:${OBB_PORT:-8000}"
     env_file:
       - .env
+    environment:
+      OBB_DB_HOST: postgres
+      OBB_MINIO_ENDPOINT: http://username:password@minio:9000
     depends_on:
       postgres:
         condition: service_healthy
@@ -26,8 +29,6 @@ services:
       - POSTGRES_USER=${OBB_DB_USERNAME:-omnibox}
       - POSTGRES_PASSWORD=${OBB_DB_PASSWORD:-omnibox}
       - POSTGRES_PORT=${OBB_DB_PORT:-5432}
-    volumes:
-      - ${PWD}/.tmp/data/postgres:/var/lib/postgresql/data
     healthcheck:
       test: [ "CMD", "pg_isready", "-q", "-d", "${OBB_DB_DATABASE:-omnibox}", "-U", "${OBB_DB_USERNAME:-omnibox}", "-p", "${OBB_DB_PORT:-5432}" ]
       interval: 5s
@@ -46,8 +47,6 @@ services:
       interval: 5s
       timeout: 3s
       retries: 5
-    volumes:
-      - '${PWD}/.tmp/data/minio:/data'
     ports:
       - '9001:9001'
       - '9000:9000'

dev.yaml

@@ -12,13 +12,3 @@ services:
       timeout: 3s
       retries: 60
       start_period: 30s
-
-  pgadmin:
-    image: dpage/pgadmin4
-    ports:
-      - '8888:80'
-    environment:
-      PGADMIN_DEFAULT_EMAIL: user-name@domain-name.com
-      PGADMIN_DEFAULT_PASSWORD: strong-password
-    volumes:
-      - ${PWD}/.tmp/data/pgadmin:/var/lib/pgadmin

persistence.yaml

@@ -0,0 +1,8 @@
+services:
+  postgres:
+    volumes:
+      - "${PWD}/.tmp/data/postgres:/var/lib/postgresql/data"
+
+  minio:
+    volumes:
+      - "${PWD}/.tmp/data/minio:/data"

pgadmin.yaml

@@ -0,0 +1,10 @@
+services:
+  pgadmin:
+    image: dpage/pgadmin4
+    ports:
+      - '8888:80'
+    environment:
+      PGADMIN_DEFAULT_EMAIL: user-name@domain-name.com
+      PGADMIN_DEFAULT_PASSWORD: strong-password
+    volumes:
+      - ${PWD}/.tmp/data/pgadmin:/var/lib/pgadmin

src/resources/resources.controller.ts

@@ -26,9 +26,10 @@ export async function fileResponse(
 ) {
   const { fileStream, resource } =
     await resourcesService.downloadFile(resourceId);
+  const encodedName = encodeURIComponent(resource.name);
   response.setHeader(
     'Content-Disposition',
-    `attachment; filename="${resource.name}"`,
+    `attachment; filename="${encodedName}"`,
   );
   response.setHeader(
     'Content-Type',

src/resources/resources.service.ts

@@ -27,6 +27,13 @@ export interface IQuery {
   tags?: string;
 }
 
+function decode(text: string) {
+  if (!text) {
+    return text;
+  }
+  return decodeURIComponent(Buffer.from(text, 'binary').toString('utf-8'));
+}
+
 @Injectable()
 export class ResourcesService {
   constructor(
@@ -194,6 +201,10 @@ export class ResourcesService {
     parentId?: string,
     resourceId?: string,
   ) {
+    // TODO name received is not utf-8 string.
+    file.originalname = decode(file.originalname);
+    file.filename = decode(file.filename);
+
     let resource: Resource;
     if (resourceId) {
       resource = await this.get(resourceId);

test/resources.e2e-spec.ts

@@ -28,7 +28,7 @@ describe('ResourcesController (e2e)', () => {
     await app.close();
   });
 
-  it('/api/v1/resources/upload (POST) and /api/v1/resources/download (GET)', async () => {
+  it('files upload (POST) and files download (GET)', async () => {
     // Prepare a test file
     const testFilePath = path.join(__dirname, 'test-upload.txt');
     fs.writeFileSync(testFilePath, 'hello world');