feat: unify file type (#1840)

* feat: unify file type

* refactor: fix tests

* refactor: fix arg

* refactor: change test env

* refactor: fix deploy env, fix migration, fix test fixtures

Author: pyphilia

.github/workflows/deploy-prod.yml

@@ -144,7 +144,7 @@ jobs:
             REFRESH_TOKEN_JWT_SECRET=${{ secrets.REFRESH_TOKEN_JWT_SECRET }}
             S3_FILE_ITEM_ACCESS_KEY_ID=${{ secrets.S3_FILE_ITEM_ACCESS_KEY_ID }}
             S3_FILE_ITEM_BUCKET=${{ vars.S3_FILE_ITEM_BUCKET }}
-            S3_FILE_ITEM_PLUGIN=${{ vars.S3_FILE_ITEM_PLUGIN }}
+            FILE_STORAGE_TYPE=${{ vars.FILE_STORAGE_TYPE }}
             S3_FILE_ITEM_REGION=${{ vars.S3_FILE_ITEM_REGION }}
             S3_FILE_ITEM_SECRET_ACCESS_KEY=${{ secrets.S3_FILE_ITEM_SECRET_ACCESS_KEY }}
             SECURE_SESSION_SECRET_KEY=${{ secrets.SECURE_SESSION_SECRET_KEY }}

.github/workflows/deploy-stage.yml

@@ -145,7 +145,7 @@ jobs:
             REFRESH_TOKEN_JWT_SECRET=${{ secrets.REFRESH_TOKEN_JWT_SECRET }}
             S3_FILE_ITEM_ACCESS_KEY_ID=${{ secrets.S3_FILE_ITEM_ACCESS_KEY_ID }}
             S3_FILE_ITEM_BUCKET=${{ vars.S3_FILE_ITEM_BUCKET }}
-            S3_FILE_ITEM_PLUGIN=${{ vars.S3_FILE_ITEM_PLUGIN }}
+            FILE_STORAGE_TYPE=${{ vars.FILE_STORAGE_TYPE }}
             S3_FILE_ITEM_REGION=${{ vars.S3_FILE_ITEM_REGION }}
             S3_FILE_ITEM_SECRET_ACCESS_KEY=${{ secrets.S3_FILE_ITEM_SECRET_ACCESS_KEY }}
             SECURE_SESSION_SECRET_KEY=${{ secrets.SECURE_SESSION_SECRET_KEY }}

.github/workflows/test.yml

@@ -31,7 +31,7 @@ env:
   ETHERPAD_URL: 'http://etherpad:9001'
   LIBRARY_CLIENT_HOST: 'http://localhost:3113'
   FILE_STORAGE_ROOT_PATH: /
-  H5P_FILE_STORAGE_TYPE: file
+  H5P_FILE_STORAGE_TYPE: local
   H5P_PATH_PREFIX: h5p-content/
   H5P_STORAGE_ROOT_PATH: /tmp/h5p
   H5P_FILE_STORAGE_HOST: http://localhost:1081
@@ -47,7 +47,7 @@ env:
   REFRESH_TOKEN_JWT_SECRET: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef
   S3_FILE_ITEM_ACCESS_KEY_ID: graasp-user
   S3_FILE_ITEM_BUCKET: graasp
-  S3_FILE_ITEM_PLUGIN: true
+  FILE_STORAGE_TYPE: s3
   S3_FILE_ITEM_REGION: us-east-1
   S3_FILE_ITEM_SECRET_ACCESS_KEY: graasp-pwd
   SECURE_SESSION_SECRET_KEY: 0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef

README.md

@@ -1,6 +1,9 @@
 # Graasp Backend
+
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
+
 [![All Contributors](https://img.shields.io/badge/all_contributors-3-orange.svg?style=flat-square)](#contributors-)
+
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 [![GitHub Release](https://img.shields.io/github/release/graasp/graasp)]()
@@ -162,14 +165,14 @@ EMAIL_CHANGE_JWT_EXPIRATION_IN_MINUTES=1440
 # FILE_STORAGE_HOST=http://localhost:1081
 
 # Graasp s3 file item
-S3_FILE_ITEM_PLUGIN=false
+FILE_STORAGE_TYPE=s3
 S3_FILE_ITEM_REGION=us-east-1
 S3_FILE_ITEM_BUCKET=graasp
 S3_FILE_ITEM_ACCESS_KEY_ID=graasp-user
 S3_FILE_ITEM_SECRET_ACCESS_KEY=graasp-pwd
 
 # Graasp H5P
-H5P_FILE_STORAGE_TYPE=file
+H5P_FILE_STORAGE_TYPE=local
 H5P_STORAGE_ROOT_PATH=/tmp/graasp-h5p/
 H5P_PATH_PREFIX=h5p-content/
 H5P_FILE_STORAGE_HOST=http://localhost:1081

docker/compose.yml

@@ -60,7 +60,7 @@ services:
       MAILER_CONFIG_PASSWORD: docker
 
       # H5P configuration
-      H5P_FILE_STORAGE_TYPE: file
+      H5P_FILE_STORAGE_TYPE: local
       H5P_STORAGE_ROOT_PATH: /tmp/graasp-h5p/
       H5P_PATH_PREFIX: h5p-content/
       H5P_FILE_STORAGE_HOST: http://localhost:1081

package.json

@@ -62,7 +62,7 @@
     "@fastify/type-provider-typebox": "5.1.0",
     "@fastify/websocket": "11.0.2",
     "@graasp/etherpad-api": "2.1.1",
-    "@graasp/sdk": "5.12.0",
+    "@graasp/sdk": "5.13.0",
     "@graasp/translations": "1.44.0",
     "@rapideditor/country-coder": "5.4.0",
     "@sentry/node": "7.119.2",

src/di/constants.ts

@@ -1,5 +1,5 @@
 export const FASTIFY_LOGGER_DI_KEY = 'FastifyBaseLogger';
-export const FILE_ITEM_TYPE_DI_KEY = 'FileItemType';
+export const FILE_STORAGE_TYPE_DI_KEY = 'FileStorageType';
 export const IMAGE_CLASSIFIER_API_DI_KEY = 'ImageClassifierAPI';
 export const GEOLOCATION_API_KEY_DI_KEY = 'GeolocationAPIKey';
 export const IFRAMELY_API_DI_KEY = 'IframelyAPI';

src/di/container.ts

@@ -18,7 +18,7 @@ import { SearchService } from '../services/item/plugins/publication/published/pl
 import {
   EMBEDDED_LINK_ITEM_IFRAMELY_HREF_ORIGIN,
   FILE_ITEM_PLUGIN_OPTIONS,
-  FILE_ITEM_TYPE,
+  FILE_STORAGE_TYPE,
   GEOLOCATION_API_KEY,
   IMAGE_CLASSIFIER_API,
   MAILER_CONFIG_FROM_EMAIL,
@@ -38,8 +38,8 @@ import {
 import {
   ETHERPAD_NAME_FACTORY_DI_KEY,
   FASTIFY_LOGGER_DI_KEY,
-  FILE_ITEM_TYPE_DI_KEY,
   FILE_SERVICE_URLS_CACHING_DI_KEY,
+  FILE_STORAGE_TYPE_DI_KEY,
   GEOLOCATION_API_KEY_DI_KEY,
   IFRAMELY_API_DI_KEY,
   IMAGE_CLASSIFIER_API_DI_KEY,
@@ -52,8 +52,8 @@ export const registerDependencies = (instance: FastifyInstance) => {
   // register FastifyBasLogger as a value to allow BaseLogger to be injected automatically.
   registerValue(FASTIFY_LOGGER_DI_KEY, log);
 
-  // register file type for the StorageService.
-  registerValue(FILE_ITEM_TYPE_DI_KEY, FILE_ITEM_TYPE);
+  // register file storage type for the StorageService.
+  registerValue(FILE_STORAGE_TYPE_DI_KEY, FILE_STORAGE_TYPE);
 
   // register classifier key for the ValidationService.
   registerValue(IMAGE_CLASSIFIER_API_DI_KEY, IMAGE_CLASSIFIER_API);
@@ -80,7 +80,7 @@ export const registerDependencies = (instance: FastifyInstance) => {
     new CachingService(resolveDependency(Redis), 'file_service_url_caching'),
   );
   // Register the FileService to inject the CacheService.
-  const fileRepository = fileRepositoryFactory(FILE_ITEM_TYPE, {
+  const fileRepository = fileRepositoryFactory(FILE_STORAGE_TYPE, {
     s3: S3_FILE_ITEM_PLUGIN_OPTIONS,
     local: FILE_ITEM_PLUGIN_OPTIONS,
   });

src/drizzle/0005_unify-file-type.sql

@@ -0,0 +1,5 @@
+UPDATE item SET type = 'file', extra = CONCAT('{"file":', extra->>'s3File', '}')::jsonb  WHERE type = 's3File' AND extra->>'s3File' IS NOT NULL;--> statement-breakpoint
+
+UPDATE app_data SET data = CONCAT('{"file":', data->>'s3File', '}')::jsonb WHERE type = 'file' AND data->>'s3File' IS NOT NULL;--> statement-breakpoint
+
+UPDATE app_setting SET data = CONCAT('{"file":', data->>'s3File', '}')::jsonb  WHERE data->>'s3File' IS NOT NULL;--> statement-breakpoint

src/drizzle/meta/_journal.json

@@ -36,6 +36,13 @@
       "when": 1745928219011,
       "tag": "0004_maintenance",
       "breakpoints": true
+    },
+    {
+      "idx": 5,
+      "version": "7",
+      "when": 1745928229011,
+      "tag": "0005_unify-file-type",
+      "breakpoints": true
     }
   ]
 }