th-89: Implement file upload flow (#187)

* th-81: + frontend part of file service

* th-81: + backend part of file service (only schema, repository and service, no aws yet)

* th-89: + env variables for S3

* th-89: + S3 Client service

* th-89: + Files backend CRUD

* th-89: + Files backend validation and multipart data parsing

* th-89: + Files upload form

* th-89: + Files shared libs

* th-89: + Files API Swagger

* th-89: + FastifyFileValidationFunction type

* th-89: * fixed not displaying error in case of choosing valid and invalid files together

* th-89: * Fixed file validation schemas

* th-89: * prepared local migrations for being merged into local development

* th-89: * Fixed comments

* th-89: + Create `files` table migration

* th-89: * resolved issues

* th-89: * Removed conflicting local migrations for merging remote ones

* th-89: * Prettified migration files

* th-89: * Fixed comments, remade file-input component to be part of a form, changed form component to support file-input component

* th-89: * Fixed package.json

* th-89: * Deleted conflicting local migrations

* th-89: * Fixed comments

* th-89: * Fixed comments

* th-281: * Fixed warning

Author: mV22110702

backend/.env.example

@@ -11,6 +11,14 @@ JWT_SECRET=very_secret_secret
 JWT_ISSUER=jwt_issuer
 JWT_ACCESS_LIFETIME=24h
 
+#
+# S3
+#
+AWS_ACCESS_KEY_ID=YOUR_KEY
+AWS_SECRET_ACCESS_KEY=YOUR_SECRET_KEY
+S3_REGION=REGION
+BUCKET_NAME=BUCKET
+
 #
 # SENDGRID
 #

backend/package.json

@@ -21,14 +21,19 @@
     "start": "node index.js"
   },
   "devDependencies": {
+    "@types/mime-types": "2.1.1",
+    "@types/uuid": "9.0.4",
     "nodemon": "3.0.1",
     "ts-node": "10.9.1",
     "ts-paths-esm-loader": "1.4.3",
     "tsconfig-paths": "4.2.0"
   },
   "dependencies": {
+    "@aws-sdk/client-s3": "3.400.0",
+    "@aws-sdk/s3-request-presigner": "3.400.0",
     "@fastify/auth": "4.3.0",
     "@fastify/cors": "8.3.0",
+    "@fastify/multipart": "7.7.3",
     "@fastify/static": "6.10.2",
     "@fastify/swagger": "8.9.0",
     "@fastify/swagger-ui": "1.9.3",
@@ -52,6 +57,7 @@
     "pino-pretty": "10.2.0",
     "postgres": "3.3.5",
     "socket.io": "4.7.2",
-    "swagger-jsdoc": "6.2.8"
+    "swagger-jsdoc": "6.2.8",
+    "mime-types": "2.1.35"
   }
 }

backend/src/index.d.ts

@@ -1,4 +1,7 @@
 import { type AuthStrategy } from './packages/auth/auth.js';
+import { type FastifyFileValidationFunction } from './packages/files/files.js';
+import { type FilesValidationStrategy } from './packages/files/libs/enums/enums.js';
+import { type MultipartParsedFile } from './packages/files/libs/types/types.js';
 import { type UserEntityObjectWithGroupT } from './packages/users/users.js';
 
 declare module 'fastify' {
@@ -7,9 +10,11 @@ declare module 'fastify' {
     [AuthStrategy.VERIFY_JWT]: FastifyAuthFunction;
     [AuthStrategy.VERIFY_BUSINESS_GROUP]: FastifyAuthFunction;
     [AuthStrategy.VERIFY_DRIVER_GROUP]: FastifyAuthFunction;
+    [FilesValidationStrategy.BASIC]: FastifyFileValidationFunction;
   }
 
   interface FastifyRequest {
     user: UserEntityObjectWithGroupT;
+    parsedFiles: MultipartParsedFile[];
   }
 }

backend/src/libs/exceptions/exceptions.ts

@@ -1,4 +1,9 @@
 export { DatabaseConnectionError } from './database/database.js';
+export {
+  FileTransactionError,
+  FileValidatorError,
+  InvalidFileError,
+} from './file/file.js';
 export { MailerConnectionError } from './mailer/mailer.js';
 export { NotFoundError } from './not-found-error/not-found-error.exception.js';
 export {

backend/src/libs/exceptions/file/file-transaction.exception.ts

@@ -0,0 +1,21 @@
+import { FILE_TRANSACTION_ERROR_MESSAGE } from '~/packages/files/libs/constants/constants.js';
+
+import { HttpCode } from '../../enums/enums.js';
+import { HttpError } from '../exceptions.js';
+
+type Constructor = {
+  message?: string;
+  cause?: unknown;
+};
+
+class FileTransactionError extends HttpError {
+  public constructor({ message, cause }: Constructor) {
+    super({
+      message: message ?? FILE_TRANSACTION_ERROR_MESSAGE,
+      status: HttpCode.BAD_REQUEST,
+      cause,
+    });
+  }
+}
+
+export { FileTransactionError };

backend/src/libs/exceptions/file/file-validator.exception.ts

@@ -0,0 +1,19 @@
+import { AppErrorMessage, HttpCode } from '../../enums/enums.js';
+import { HttpError } from '../exceptions.js';
+
+type Constructor = {
+  message?: string;
+  cause?: unknown;
+};
+
+class FileValidatorError extends HttpError {
+  public constructor({ message, cause }: Constructor) {
+    super({
+      message: message ?? AppErrorMessage.INVALID_FILE_INPUT_CONFIG,
+      status: HttpCode.BAD_REQUEST,
+      cause,
+    });
+  }
+}
+
+export { FileValidatorError };

backend/src/libs/exceptions/file/file.ts

@@ -0,0 +1,3 @@
+export { FileTransactionError } from './file-transaction.exception.js';
+export { FileValidatorError } from './file-validator.exception.js';
+export { InvalidFileError } from './invalid-file.exception.js';

backend/src/libs/exceptions/file/invalid-file.exception.ts

@@ -0,0 +1,19 @@
+import { HttpCode } from '../../enums/enums.js';
+import { HttpError } from '../exceptions.js';
+
+type Constructor = {
+  message: string;
+  cause?: unknown;
+};
+
+class InvalidFileError extends HttpError {
+  public constructor({ message, cause }: Constructor) {
+    super({
+      message,
+      status: HttpCode.BAD_REQUEST,
+      cause,
+    });
+  }
+}
+
+export { InvalidFileError };

backend/src/libs/packages/config/config.package.ts

@@ -67,6 +67,40 @@ class Config implements IConfig {
           default: null,
         },
       },
+      AWS: {
+        ACCESS_KEY_ID: {
+          doc: 'Access key id',
+          format: String,
+          env: 'AWS_ACCESS_KEY_ID',
+          default: null,
+        },
+        SECRET_ACCESS_KEY: {
+          doc: 'Secret access key',
+          format: String,
+          env: 'AWS_SECRET_ACCESS_KEY',
+          default: null,
+        },
+        S3: {
+          BUCKET_NAME: {
+            doc: 'Bucket name',
+            format: String,
+            env: 'BUCKET_NAME',
+            default: null,
+          },
+          REGION: {
+            doc: 'Service region',
+            format: String,
+            env: 'S3_REGION',
+            default: null,
+          },
+          SIGNED_URL_EXPIRES_IN: {
+            doc: 'Number of seconds a signed URL expires in',
+            format: String,
+            env: 'SIGNED_URL_EXPIRES_IN',
+            default: null,
+          },
+        },
+      },
       JWT: {
         SECRET: {
           doc: 'Secret key for token generation',

backend/src/libs/packages/config/libs/types/environment-schema.type.ts

@@ -6,6 +6,15 @@ type EnvironmentSchema = {
     PORT: number;
     ENVIRONMENT: ValueOf<typeof AppEnvironment>;
   };
+  AWS: {
+    SECRET_ACCESS_KEY: string;
+    ACCESS_KEY_ID: string;
+    S3: {
+      BUCKET_NAME: string;
+      REGION: string;
+      SIGNED_URL_EXPIRES_IN: number;
+    };
+  };
   JWT: {
     SECRET: string;
     ISSUER: string;