Abort when MinIO bucket does not have versioning enabled #545 (#546)

Co-authored-by: Florent FAYOLLE <florent.fayolle@beta.gouv.fr>

app/server/lib/FlexServer.ts

@@ -1124,7 +1124,6 @@ export class FlexServer implements GristServer {
     await this.loadConfig();
     this.addComm();
 
-    await this.create.configure?.();
     if (!isSingleUserMode()) {
       const externalStorage = appSettings.section('externalStorage');
       const haveExternalStorage = Object.values(externalStorage.nested)
@@ -1135,6 +1134,7 @@ export class FlexServer implements GristServer {
         this._disableExternalStorage = true;
         externalStorage.flag('active').set(false);
       }
+      await this.create.configure?.();
       const workers = this._docWorkerMap;
       const docWorkerId = await this._addSelfAsWorker(workers);
 

app/server/lib/ICreate.ts

@@ -50,6 +50,7 @@ export interface ICreateActiveDocOptions {
 export interface ICreateStorageOptions {
   name: string;
   check(): boolean;
+  checkBackend?(): Promise<void>;
   create(purpose: 'doc'|'meta', extraPrefix: string): ExternalStorage|undefined;
 }
 
@@ -119,7 +120,10 @@ export function makeSimpleCreator(opts: {
     },
     async configure() {
       for (const s of storage || []) {
-        if (s.check()) { break; }
+        if (s.check()) {
+          await s.checkBackend?.();
+          break;
+        }
       }
     },
     ...(opts.shell && {

app/server/lib/MinIOExternalStorage.ts

@@ -107,6 +107,11 @@ export class MinIOExternalStorage implements ExternalStorage {
     }
   }
 
+  public async hasVersioning(): Promise<Boolean> {
+    const versioning = await this._s3.getBucketVersioning(this.bucket);
+    return versioning && versioning.Status === 'Enabled';
+  }
+
   public async versions(key: string, options?: { includeDeleteMarkers?: boolean }) {
     const results: minio.BucketItem[] = [];
     await new Promise((resolve, reject) => {

app/server/lib/configureMinIOExternalStorage.ts

@@ -60,3 +60,16 @@ export function checkMinIOExternalStorage() {
     region
   };
 }
+
+export async function checkMinIOBucket() {
+  const options = checkMinIOExternalStorage();
+  if (!options) {
+    throw new Error('Configuration check failed for MinIO backend storage.');
+  }
+
+  const externalStorage = new MinIOExternalStorage(options.bucket, options);
+  if (!await externalStorage.hasVersioning()) {
+    await externalStorage.close();
+    throw new Error(`FATAL: the MinIO bucket "${options.bucket}" does not have versioning enabled`);
+  }
+}

app/server/mergedServerMain.ts

@@ -106,44 +106,49 @@ export async function main(port: number, serverTypes: ServerType[],
   server.addApiMiddleware();
   await server.addBillingMiddleware();
 
-  await server.start();
+  try {
+    await server.start();
 
-  if (includeHome) {
+    if (includeHome) {
-    server.addUsage();
+      server.addUsage();
-    if (!includeDocs) {
+      if (!includeDocs) {
-      server.addDocApiForwarder();
+        server.addDocApiForwarder();
+      }
+      server.addJsonSupport();
+      await server.addLandingPages();
+      // todo: add support for home api to standalone app
+      server.addHomeApi();
+      server.addBillingApi();
+      server.addNotifier();
+      server.addTelemetry();
+      await server.addHousekeeper();
+      await server.addLoginRoutes();
+      server.addAccountPage();
+      server.addBillingPages();
+      server.addWelcomePaths();
+      server.addLogEndpoint();
+      server.addGoogleAuthEndpoint();
     }
-    server.addJsonSupport();
+
-    await server.addLandingPages();
+    if (includeDocs) {
-    // todo: add support for home api to standalone app
+      server.addJsonSupport();
-    server.addHomeApi();
+      server.addTelemetry();
-    server.addBillingApi();
+      await server.addDoc();
-    server.addNotifier();
+    }
-    server.addTelemetry();
+
-    await server.addHousekeeper();
+    if (includeHome) {
-    await server.addLoginRoutes();
+      server.addClientSecrets();
-    server.addAccountPage();
+    }
-    server.addBillingPages();
+
-    server.addWelcomePaths();
+    server.finalize();
-    server.addLogEndpoint();
+
-    server.addGoogleAuthEndpoint();
+    server.checkOptionCombinations();
+    server.summary();
+    return server;
+  } catch(e) {
+    await server.close();
+    throw e;
   }
-
-  if (includeDocs) {
-    server.addJsonSupport();
-    server.addTelemetry();
-    await server.addDoc();
-  }
-
-  if (includeHome) {
-    server.addClientSecrets();
-  }
-
-  server.finalize();
-
-  server.checkOptionCombinations();
-  server.summary();
-  return server;
 }
 
 

stubs/app/server/lib/create.ts

@@ -1,4 +1,4 @@
-import { checkMinIOExternalStorage,
+import { checkMinIOBucket, checkMinIOExternalStorage,
          configureMinIOExternalStorage } from 'app/server/lib/configureMinIOExternalStorage';
 import { makeSimpleCreator } from 'app/server/lib/ICreate';
 import { Telemetry } from 'app/server/lib/Telemetry';
@@ -12,6 +12,7 @@ export const create = makeSimpleCreator({
     {
       name: 'minio',
       check: () => checkMinIOExternalStorage() !== undefined,
+      checkBackend: () => checkMinIOBucket(),
       create: configureMinIOExternalStorage,
     },
   ],

stubs/app/server/server.ts

@@ -117,5 +117,7 @@ export async function main() {
 }
 
 if (require.main === module) {
-  main().catch((err) => console.error(err));
+  main().catch((err) => {
+    console.error(err);
+  });
 }