Merge pull request #185 from openscript-ch/23-implement-sql-dump-export-functionality

23 implement sql dump export functionality

Author: openscript

.changeset/late-ducks-repair.md

@@ -0,0 +1,6 @@
+---
+"@quassel/frontend": minor
+"@quassel/backend": minor
+---
+
+Add database dump export

apps/backend/src/main.ts

@@ -13,6 +13,7 @@ async function bootstrap() {
   app.enableCors({
     credentials: true,
     origin: configService.get("cors.origin"),
+    exposedHeaders: ["Content-Disposition"],
   });
   app.enableShutdownHooks();
   app.useGlobalPipes(new ValidationPipe());

apps/backend/src/system/export/export.controller.ts

@@ -0,0 +1,40 @@
+import { Controller, Get, Response } from "@nestjs/common";
+import { ApiOperation, ApiResponse } from "@nestjs/swagger";
+import { FastifyReply } from "fastify";
+import { ExportService } from "./export.service";
+
+@Controller("export")
+export class ExportController {
+  constructor(private readonly exportService: ExportService) {}
+
+  @Get()
+  @ApiOperation({ summary: "Offers the backends data for download" })
+  @ApiResponse({
+    status: 200,
+    description: "Database dump file",
+    content: {
+      "text/sql": {
+        schema: { type: "string", format: "binary" },
+      },
+    },
+    headers: {
+      "Content-Disposition": {
+        description: "Attachment dump.sql",
+        schema: { type: "string", example: 'attachment; filename="quassel-database-dump-01-01-01_15-12.sql"' },
+      },
+    },
+  })
+  async get(@Response() res: FastifyReply) {
+    try {
+      const data = await this.exportService.fullDatabaseDump();
+      const buffer = Buffer.from(data, "utf-8");
+      const dateTime = new Date().toISOString().replace(/:/g, "-").replace("T", "_").replace(/\..+/, "");
+      res.header("Content-Disposition", `attachment; filename="quassel-database-dump-${dateTime}.sql"`);
+      res.header("Content-Type", "text/sql");
+      res.header("Content-Length", buffer.byteLength.toString());
+      res.send(buffer);
+    } catch (error) {
+      res.status(500).send(error.message);
+    }
+  }
+}

apps/backend/src/system/export/export.service.ts

@@ -0,0 +1,31 @@
+import { Injectable } from "@nestjs/common";
+import { exec } from "node:child_process";
+import { promisify } from "node:util";
+import { ConfigService } from "../../config/config.service";
+
+const execPromise = promisify(exec);
+
+@Injectable()
+export class ExportService {
+  constructor(private readonly configService: ConfigService) {}
+
+  async fullDatabaseDump() {
+    try {
+      const user = this.configService.get("database.user");
+      const database = this.configService.get("database.name");
+      const password = this.configService.get("database.password");
+      const host = this.configService.get("database.host");
+      const port = this.configService.get("database.port");
+
+      const command = `PGPASSWORD=${password} pg_dump -U ${user} -h ${host} -p ${port} ${database}`;
+
+      const { stdout, stderr } = await execPromise(command);
+      if (stderr) {
+        throw new Error(stderr);
+      }
+      return stdout;
+    } catch (error) {
+      throw new Error(`Database dump failed: ${error.message}`);
+    }
+  }
+}

apps/backend/src/system/health/health.controller.ts

@@ -1,6 +1,7 @@
 import { Controller, Get } from "@nestjs/common";
 import { HealthCheck, HealthCheckService, MikroOrmHealthIndicator } from "@nestjs/terminus";
 import { Public } from "../session/public.decorator";
+import { ApiOperation } from "@nestjs/swagger";
 
 @Controller("health")
 export class HealthController {
@@ -10,6 +11,7 @@ export class HealthController {
   ) {}
 
   @Get()
+  @ApiOperation({ summary: "Returns the backends health information" })
   @HealthCheck()
   @Public()
   get() {

apps/backend/src/system/status/status.controller.ts

@@ -1,10 +1,12 @@
 import { Controller, Get } from "@nestjs/common";
 import { Public } from "../session/public.decorator";
 import { version } from "../../../package.json";
+import { ApiOperation } from "@nestjs/swagger";
 
 @Controller("status")
 export class StatusController {
   @Get()
+  @ApiOperation({ summary: "Returns the backends status information" })
   @Public()
   get() {
     return { version };

apps/backend/src/system/system.module.ts

@@ -11,10 +11,19 @@ import { RolesGuard } from "./users/roles.guard";
 import { HealthController } from "./health/health.controller";
 import { TerminusModule } from "@nestjs/terminus";
 import { StatusController } from "./status/status.controller";
+import { ExportController } from "./export/export.controller";
+import { ExportService } from "./export/export.service";
+import { ConfigModule } from "../config/config.module";
 
 @Module({
-  imports: [MikroOrmModule.forFeature([User]), TerminusModule],
-  controllers: [UsersController, SessionController, HealthController, StatusController],
-  providers: [UsersService, SessionService, { provide: APP_GUARD, useClass: SessionGuard }, { provide: APP_GUARD, useClass: RolesGuard }],
+  imports: [MikroOrmModule.forFeature([User]), TerminusModule, ConfigModule],
+  controllers: [UsersController, SessionController, HealthController, StatusController, ExportController],
+  providers: [
+    UsersService,
+    SessionService,
+    ExportService,
+    { provide: APP_GUARD, useClass: SessionGuard },
+    { provide: APP_GUARD, useClass: RolesGuard },
+  ],
 })
 export class SystemModule {}

apps/frontend/package.json

@@ -21,11 +21,11 @@
     "@nanostores/persistent": "^0.10.2",
     "@nanostores/react": "^0.8.2",
     "@quassel/ui": "workspace:*",
-    "@tanstack/react-query": "^5.62.2",
-    "@tanstack/react-router": "^1.85.4",
+    "@tanstack/react-query": "^5.62.3",
+    "@tanstack/react-router": "^1.87.0",
     "nanostores": "^0.11.3",
-    "openapi-fetch": "0.13.1",
-    "openapi-react-query": "0.2.6",
+    "openapi-fetch": "0.13.3",
+    "openapi-react-query": "0.2.8",
     "react": "^18.3.1",
     "react-dom": "^18.3.1"
   },
@@ -35,11 +35,12 @@
     "@testing-library/jest-dom": "^6.6.3",
     "@testing-library/react": "^16.0.1",
     "@types/react": "^18.3.12",
-    "@types/react-dom": "^18.3.1",
+    "@types/react-dom": "^19.0.1",
     "@vitejs/plugin-react": "^4.3.4",
     "@vitest/coverage-v8": "2.1.8",
     "jsdom": "^25.0.1",
     "openapi-typescript": "^7.4.4",
+    "openapi-typescript-helpers": "^0.0.15",
     "typescript": "^5.7.2",
     "vite": "^6.0.2",
     "vitest": "^2.1.8"

apps/frontend/src/api.gen.ts

@@ -67,6 +67,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
+        /** Returns the backends health information */
         get: operations["HealthController_get"];
         put?: never;
         post?: never;
@@ -83,6 +84,7 @@ export interface paths {
             path?: never;
             cookie?: never;
         };
+        /** Returns the backends status information */
         get: operations["StatusController_get"];
         put?: never;
         post?: never;
@@ -92,6 +94,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/export": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /** Offers the backends data for download */
+        get: operations["ExportController_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/carers": {
         parameters: {
             query?: never;
@@ -1272,6 +1291,28 @@ export interface operations {
             };
         };
     };
+    ExportController_get: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Database dump file */
+            200: {
+                headers: {
+                    /** @description Attachment dump.sql */
+                    "Content-Disposition"?: string;
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/sql": string;
+                };
+            };
+        };
+    };
     CarersController_index: {
         parameters: {
             query?: never;

apps/frontend/src/hooks/useDownload.ts

@@ -0,0 +1,104 @@
+import { useState } from "react";
+
+/**
+ * This hook is used to download a file from a given URL.
+ * It handles the download progress and errors.
+ *
+ * @params fileUrl: The URL of the file to download.
+ * @params fileName: The name of the file to download.
+ * @params response: A function that returns a promise that resolves to a Response object.
+ */
+export const useDownload = (fileUrl: string, fileName: string, response?: () => Promise<Response>) => {
+  const [error, setError] = useState<Error | unknown | null>(null);
+  const [isDownloading, setIsDownloading] = useState<boolean>(false);
+  const [progress, setProgress] = useState<number | null>(null);
+
+  const handleResponse = async (response: Response): Promise<string> => {
+    if (!response.ok) {
+      throw new Error("Could not download file");
+    }
+
+    const contentLength = response.headers.get("content-length");
+    const reader = response.body?.getReader();
+
+    if (!contentLength || !reader) {
+      const blob = await response.blob();
+
+      return createBlobURL(blob);
+    }
+
+    const stream = await getStream(contentLength, reader);
+    const newResponse = new Response(stream);
+    const blob = await newResponse.blob();
+
+    return createBlobURL(blob);
+  };
+
+  const getStream = async (contentLength: string, reader: ReadableStreamDefaultReader<Uint8Array>): Promise<ReadableStream<Uint8Array>> => {
+    let loaded = 0;
+    const total = parseInt(contentLength, 10);
+
+    return new ReadableStream<Uint8Array>({
+      async start(controller) {
+        try {
+          for (;;) {
+            const { done, value } = await reader.read();
+
+            if (done) break;
+
+            loaded += value.byteLength;
+            const percentage = Math.trunc((loaded / total) * 100);
+            setProgress(percentage);
+            controller.enqueue(value);
+          }
+        } catch (error) {
+          controller.error(error);
+          throw error;
+        } finally {
+          controller.close();
+        }
+      },
+    });
+  };
+
+  const createBlobURL = (blob: Blob): string => {
+    return window.URL.createObjectURL(blob);
+  };
+
+  const handleDownload = (fileName: string, url: string) => {
+    const link = document.createElement("a");
+
+    link.href = url;
+    link.setAttribute("download", fileName);
+    document.body.appendChild(link);
+    link.click();
+    document.body.removeChild(link);
+    window.URL.revokeObjectURL(url);
+  };
+
+  const downloadFile = async () => {
+    setIsDownloading(true);
+    setError(null);
+    setProgress(null);
+
+    try {
+      const res = response ? await response() : await fetch(fileUrl);
+      const url = await handleResponse(res);
+
+      const headerFileName = res.headers.get("content-disposition")?.match(/filename="(.+)"/)?.[1];
+
+      handleDownload(headerFileName || fileName, url);
+    } catch (error) {
+      setError(error);
+    } finally {
+      setIsDownloading(false);
+    }
+  };
+
+  return {
+    error,
+    isDownloading,
+    progress,
+    downloadFile,
+  };
+};