🏆 Performance tests with K6 (#303)

tdrive/backend/node/src/services/documents/web/controllers/documents.ts

@@ -32,7 +32,9 @@ export class DocumentsController {
   private rootAdmins: string[] = config.has("drive.rootAdmins")
     ? config.get("drive.rootAdmins")
     : [];
-
+  public profilingEnabled: boolean = config.has("drive.profilingEnabled")
+    ? config.get("drive.profilingEnabled")
+    : false;
   /**
    * Creates a DriveFile item
    *

tdrive/backend/node/src/services/documents/web/routes.ts

@@ -1,6 +1,7 @@
 import { FastifyInstance, FastifyPluginCallback } from "fastify";
 import { DocumentsController } from "./controllers";
 import { createDocumentSchema, createVersionSchema } from "./schemas";
+import profilerPlugin from "../../../utils/profiler";
 
 const baseUrl = "/companies/:company_id";
 const serviceUrl = `${baseUrl}/item`;
@@ -8,6 +9,11 @@ const serviceUrl = `${baseUrl}/item`;
 const routes: FastifyPluginCallback = (fastify: FastifyInstance, _options, next) => {
   const documentsController = new DocumentsController();
 
+  fastify.register(profilerPlugin, {
+    active: documentsController.profilingEnabled,
+    outputDir: "profiles",
+  });
+
   fastify.route({
     method: "GET",
     url: `${serviceUrl}`,

tdrive/backend/node/src/utils/profiler.ts

@@ -0,0 +1,61 @@
+import fs from "fs";
+import fp from "fastify-plugin";
+import v8profiler from "v8-profiler-next";
+
+export class Profiler {
+  title: string;
+  active: boolean;
+  outputDir: string;
+  constructor(options) {
+    const { title, active, outputDir } = options;
+    this.title = title;
+    this.active = active;
+    this.outputDir = outputDir;
+  }
+
+  start() {
+    if (this.active) {
+      v8profiler.startProfiling(this.title, true);
+    }
+  }
+
+  finish() {
+    if (this.active) {
+      const profile = v8profiler.stopProfiling(this.title);
+      if (profile === undefined) {
+        console.log("profile is undefined: ", this.title);
+        return;
+      }
+      profile.export((error, result) => {
+        if (error) {
+          console.log("Profiling error: ", error);
+        } else {
+          fs.writeFileSync(`${process.cwd()}/${this.outputDir}/${this.title}.cpuprofile`, result);
+        }
+      });
+    }
+  }
+}
+
+async function profilerPlugin(fastify, options) {
+  fastify.addHook("onRequest", async request => {
+    const profiler = new Profiler({
+      title: `${request.method}-${request.url}`,
+      active: options.active,
+      outputDir: options.outputDir || "profiles",
+    });
+
+    profiler.start();
+
+    // Attach profiler to request for access in routes or other hooks
+    request.profiler = profiler;
+  });
+
+  fastify.addHook("onResponse", async request => {
+    if (request.profiler) {
+      request.profiler.finish();
+    }
+  });
+}
+
+export default fp(profilerPlugin);