Merge branch 'develop' into server-4710-spaceAuth

alkemio.yml

@@ -277,6 +277,9 @@ communications:
 ## storage ##
 # Alkemio uses multiple types of persistent storage, including SQL database, postgres database, file storage, redis.
 storage:
+  #
+  enabled: ${STORAGE_ENABLED}:true
+  #
   file:
     # 20MB
     max_file_size: ${STORAGE_MAX_FILE_SIZE}:20971520

package.json

@@ -1,6 +1,6 @@
 {
   "name": "alkemio-server",
-  "version": "0.96.2",
+  "version": "0.97.0",
   "description": "Alkemio server, responsible for managing the shared Alkemio platform",
   "author": "Alkemio Foundation",
   "private": false,

src/common/enums/alkemio.error.status.ts

@@ -64,6 +64,7 @@ export enum AlkemioErrorStatus {
   EXCALIDRAW_REDIS_ADAPTER_INIT = 'EXCALIDRAW_REDIS_INIT',
   EXCALIDRAW_SERVER_INIT = 'EXCALIDRAW_SERVER_INIT',
   UNSPECIFIED = 'UNSPECIFIED',
+  STORAGE_DISABLED = 'STORAGE_DISABLED',
   LOCAL_STORAGE_SAVE_FAILED = 'LOCAL_STORAGE_SAVE_FAILED',
   LOCAL_STORAGE_READ_FAILED = 'LOCAL_STORAGE_READ_FAILED',
   LOCAL_STORAGE_DELETE_FAILED = 'LOCAL_STORAGE_DELETE_FAILED',

src/common/exceptions/storage/index.ts

@@ -1,3 +1,5 @@
 export * from './local-storage/local.storage.delete.failed.exception';
 export * from './local-storage/local.storage.save.failed.exception';
 export * from './local-storage/local.storage.read.failed.exception';
+
+export * from './storage.disabled.exception';

src/common/exceptions/storage/storage.disabled.exception.ts

@@ -0,0 +1,9 @@
+import { AlkemioErrorStatus, LogContext } from '@common/enums';
+import { BaseException } from '../../exceptions/base.exception';
+import { ExceptionDetails } from '../../exceptions/exception.details';
+
+export class StorageDisabledException extends BaseException {
+  constructor(error: string, context: LogContext, details?: ExceptionDetails) {
+    super(error, context, AlkemioErrorStatus.STORAGE_DISABLED, details);
+  }
+}

src/services/adapters/storage/local-storage/local.storage.adapter.ts

@@ -13,16 +13,19 @@ import {
 import { StorageService } from '../storage.service.interface';
 import { StorageServiceType } from '../storage.service.type';
 import { AlkemioConfig } from '@src/types';
+import { StorageDisabledException } from '@common/exceptions/storage/storage.disabled.exception';
 
 const writeFileAsync = promisify(writeFile);
 const readFileAsync = promisify(readFile);
 const unlinkAsync = promisify(unlink);
 
 @Injectable()
 export class LocalStorageAdapter implements StorageService {
+  private readonly enabled: boolean;
   private readonly storagePath: string;
 
   constructor(private configService: ConfigService<AlkemioConfig, true>) {
+    this.enabled = this.configService.get('storage.enabled', { infer: true });
     const pathFromConfig = this.configService.get(
       'storage.local_storage.path',
       { infer: true }
@@ -36,10 +39,24 @@ export class LocalStorageAdapter implements StorageService {
   }
 
   public save(data: Buffer) {
+    if (!this.enabled) {
+      throw new StorageDisabledException(
+        'Storage is currently disabled',
+        LogContext.LOCAL_STORAGE
+      );
+    }
+
     return this.saveFromBuffer(data);
   }
 
   public async read(fileName: string): Promise<Buffer> | never {
+    if (!this.enabled) {
+      throw new StorageDisabledException(
+        'Storage is currently disabled',
+        LogContext.LOCAL_STORAGE
+      );
+    }
+
     const filePath = this.getFilePath(fileName);
     try {
       return await readFileAsync(filePath);
@@ -58,6 +75,13 @@ export class LocalStorageAdapter implements StorageService {
   }
 
   public async delete(fileName: string): Promise<void> | never {
+    if (!this.enabled) {
+      throw new StorageDisabledException(
+        'Storage is currently disabled',
+        LogContext.LOCAL_STORAGE
+      );
+    }
+
     const filePath = this.getFilePath(fileName);
 
     try {
@@ -77,6 +101,13 @@ export class LocalStorageAdapter implements StorageService {
   }
 
   public exists(fileName: string): boolean {
+    if (!this.enabled) {
+      throw new StorageDisabledException(
+        'Storage is currently disabled',
+        LogContext.LOCAL_STORAGE
+      );
+    }
+
     const filePath = this.getFilePath(fileName);
     return existsSync(filePath);
   }

src/types/alkemio.config.ts

@@ -96,6 +96,7 @@ export type AlkemioConfig = {
     };
   };
   storage: {
+    enabled: boolean;
     file: {
       max_file_size: number;
     };