node-server-engine 1.4.8 → 1.5.0

package/src/middleware/fileUploader/fileUploader.ts

@@ -1,154 +0,0 @@
-import { Request, Response, NextFunction } from 'express';
-import { Schema } from 'express-validator';
-import { WebError } from 'entities/WebError';
-import { reportDebug } from 'utils/report';
-import multer from 'multer';
-import { FileUploaderConfig } from './fileUploader.types';
-import { validate } from './validate';
-import path from 'path';
-import bytes from 'bytes';
-
-const namespace = 'engine:middleware:fileUploader';
-
-/**
- * Middleware for handling file uploads.
- * @param filesOptions Configuration options for expected files.
- * @param validator Validation schema for request fields.
- */
-export function fileUploader(
-  filesOptions: Array<FileUploaderConfig>,
-  validator: Schema
-) {
-  return async (
-    request: Request,
-    response: Response,
-    next: NextFunction
-  ): Promise<void> => {
-    reportDebug({
-      namespace,
-      message: 'Received request to upload file',
-      data: { filesOptions, validator }
-    });
-
-    // Setup multer with memory storage
-    const storage = multer.memoryStorage();
-    const upload = multer({
-      storage,
-      limits: { fileSize: 32 * 1024 * 1024 } // Default global limit (10MB)
-    }).any();
-
-    upload(request, response, async (err) => {
-      if (err) {
-        reportDebug({
-          namespace,
-          message: 'Multer upload error',
-          data: { error: err.message }
-        });
-        return next(err);
-      }
-
-      // Ensure `request.files` is properly typed
-      let uploadedFiles: Express.Multer.File[] = [];
-      if (Array.isArray(request.files)) {
-        uploadedFiles = request.files;
-      } else if (typeof request.files === 'object') {
-        uploadedFiles = Object.values(request.files).flat();
-      }
-
-      // Log uploaded files
-      reportDebug({
-        namespace,
-        message: 'Files Received',
-        data: { uploadedFiles: uploadedFiles.map((file) => file.originalname) }
-      });
-
-      // Validate request body fields
-      try {
-        await validate(request, validator);
-      } catch (error) {
-        reportDebug({
-          namespace,
-          message: 'Validation failed',
-          data: { error }
-        });
-        return next(error);
-      }
-
-      // Extract uploaded field names
-      const uploadedFileKeys = uploadedFiles.map((file) => file.fieldname);
-
-      // Check for missing required files
-      const missingFiles = filesOptions.filter(
-        (option) => option.required && !uploadedFileKeys.includes(option.key)
-      );
-
-      if (missingFiles.length > 0) {
-        reportDebug({
-          namespace,
-          message: 'Missing required files',
-          data: { missingFiles, uploadedFileKeys }
-        });
-
-        return next(
-          new WebError({
-            statusCode: 400,
-            errorCode: 'missing-field',
-            message: 'Some required files have not been uploaded',
-            data: { missingFiles, uploadedFileKeys }
-          })
-        );
-      }
-
-      // Validate each uploaded file
-      for (const file of uploadedFiles) {
-        const fileOption = filesOptions.find(
-          (option) => option.key === file.fieldname
-        );
-
-        if (!fileOption) continue;
-
-        // MIME Type Validation
-        if (
-          fileOption.mimeTypes &&
-          !fileOption.mimeTypes.includes(file.mimetype)
-        ) {
-          return next(
-            new WebError({
-              statusCode: 400,
-              errorCode: 'invalid-mime-type',
-              message: `Invalid file type for ${file.fieldname}`,
-              data: { expected: fileOption.mimeTypes, received: file.mimetype }
-            })
-          );
-        }
-
-        // Max File Size Validation
-        if (fileOption.maxSize) {
-          const maxSizeInBytes = bytes(fileOption.maxSize);
-          if (maxSizeInBytes && file.size > maxSizeInBytes) {
-            return next(
-              new WebError({
-                statusCode: 400,
-                errorCode: 'file-too-large',
-                message: `File ${file.originalname} exceeds the allowed size`,
-                data: { maxSize: fileOption.maxSize, receivedSize: file.size }
-              })
-            );
-          }
-        }
-
-        // No Extension Handling
-        if (fileOption.noExtension) {
-          file.originalname = path.basename(
-            file.originalname,
-            path.extname(file.originalname)
-          );
-        }
-      }
-
-      request.files = uploadedFiles;
-
-      next();
-    });
-  };
-}

package/src/middleware/fileUploader/fileUploader.types.ts

@@ -1,35 +0,0 @@
-// Extend Express request object to include `files`
-declare global {
-  // eslint-disable-next-line @typescript-eslint/no-namespace
-  namespace Express {
-    interface Request {
-      /** Uploaded files mapped by field name */
-      files?:
-        | { [key: string]: Express.Multer.File[] }
-        | Express.Multer.File[]
-        | undefined;
-    }
-  }
-}
-
-/** Custom uploaded file metadata */
-export interface UploadedFile extends Express.Multer.File {
-  /** Original file name (use `originalname` from `Express.Multer.File`) */
-  originalFileName: string;
-  /** File data buffer (use `buffer` from `Express.Multer.File`) */
-  file: Buffer;
-}
-
-/** Configuration for file upload */
-export interface FileUploaderConfig {
-  /** Field name expected in the request */
-  key: string;
-  /** Allowed MIME types */
-  mimeTypes?: Array<string>;
-  /** Maximum file size (e.g., "2MB") */
-  maxSize?: string;
-  /** Whether the file is required */
-  required?: boolean;
-  /** Whether to store without an extension */
-  noExtension?: boolean;
-}

package/src/middleware/fileUploader/index.ts

@@ -1,2 +0,0 @@
-export * from './fileUploader';
-export * from './fileUploader.types';

package/src/middleware/fileUploader/isMultiPart/index.ts

@@ -1 +0,0 @@
-export * from './isMultipart';

package/src/middleware/fileUploader/isMultiPart/isMultipart.ts

@@ -1,9 +0,0 @@
-import { Request } from 'express';
-
-const multipartRegex = /^multipart\/form-data.+$/;
-
-/** Determines if the content type of a request is multipart/form-data */
-export function isMultipart(request: Request): boolean {
-  const type = request.get('Content-Type');
-  return !!type && multipartRegex.test(type.toLowerCase());
-}

package/src/middleware/fileUploader/validate/index.ts

@@ -1 +0,0 @@
-export * from './validate';

package/src/middleware/fileUploader/validate/validate.ts

@@ -1,27 +0,0 @@
-import { Request } from 'express';
-import { Schema } from 'express-validator';
-import { validate as validateMiddleware } from 'middleware/validate';
-
-/** Validate a schema against a request using our validation middleware */
-export async function validate(
-  request: Request,
-  schema: Schema
-): Promise<void> {
-  return new Promise((resolve, reject) => {
-    // Generate a validation chain using our middleware
-    const validationChain = validateMiddleware(schema).flat();
-    if (!validationChain.length) resolve();
-    // Recursively go through each middleware by imitating the next function from express
-    let position = -1;
-    const next = (error?: unknown): void => {
-      if (error) reject(error);
-      position++;
-      if (position === validationChain.length) {
-        resolve();
-        return;
-      }
-      validationChain[position](request, undefined, next);
-    };
-    next();
-  });
-}

package/src/middleware/fourOhFour/fourOhFour.test.ts

@@ -1,14 +0,0 @@
-import express from 'express';
-import supertest from 'supertest';
-import { fourOhFour } from './fourOhFour';
-
-describe('Middleware - fourOhFour', () => {
-  it('should 404 everything', async () => {
-    const app = express();
-    app.get('/example', (req: any, res: any) => res.sendStatus(200));
-    app.use(fourOhFour);
-
-    await supertest(app).get('/example').expect(200);
-    await supertest(app).get('/nope').expect(404);
-  });
-});

package/src/middleware/fourOhFour/fourOhFour.ts

@@ -1,13 +0,0 @@
-import { Request, Response } from 'express';
-import { reportDebug } from 'utils';
-
-const namespace = 'engine:middleware:fourOhFour';
-
-/** Unhandled path middleware */
-export function fourOhFour(request: Request, response: Response): void {
-  reportDebug({
-    namespace,
-    message: `No route found [${request.method} - ${request.path}]`
-  });
-  response.sendStatus(404);
-}

package/src/middleware/fourOhFour/index.ts

@@ -1 +0,0 @@
-export * from './fourOhFour';

package/src/middleware/geminiFileUploader/geminiFileUploader.ts

@@ -1,68 +0,0 @@
-import express from 'express';
-import multer from 'multer';
-import { reportError, geminiFileUpload, reportDebug } from 'utils';
-import { checkEnvironment } from 'utils/checkEnvironment';
-import { envAssert } from 'utils/envAssert';
-
-const namespace = 'engine:middleware:geminiFileUploader';
-const storage = multer.memoryStorage();
-
-export async function geminiFileUploader(
-  req: express.Request,
-  res: express.Response,
-  next: express.NextFunction
-): Promise<void> {
-  try {
-    checkEnvironment({
-      GOOGLE_AI_KEY: envAssert.isString()
-    });
-    // Use multer.single() inside the middleware
-    const uploadSingle = multer({ storage }).single('file');
-
-    uploadSingle(req, res, async (err) => {
-      if (err) {
-        reportError(`Error uploading file`);
-        next(err);
-        return;
-      }
-
-      const file = req.file;
-      if (!file) {
-        reportError(`No file uploaded`);
-        next(`No file uploaded`);
-        return;
-      }
-      const mimeType = file.mimetype;
-
-      reportDebug({
-        namespace,
-        message: 'Upload to Gemini AI',
-        data: {
-          hasBuffer: !!file.buffer,
-          mimeType,
-          originalFileName: file.originalname
-        }
-      });
-
-      const fileResponse = await geminiFileUpload(
-        file.buffer,
-        mimeType,
-        file.originalname
-      );
-
-      reportDebug({
-        namespace,
-        message: 'File Uploaded to Gemini AI',
-        data: fileResponse
-      });
-
-      req.body.file = fileResponse;
-
-      next();
-    });
-  } catch (error) {
-    console.error(error);
-    reportError(`Failed to upload or process file`);
-    next(error);
-  }
-}

package/src/middleware/geminiFileUploader/index.ts

@@ -1 +0,0 @@
-export * from './geminiFileUploader';

package/src/middleware/healthCheck/healthCheck.test.ts

@@ -1,12 +0,0 @@
-import express from 'express';
-import request from 'supertest';
-import { healthCheck } from './healthCheck';
-
-describe('Middleware - healthCheck', () => {
-  it('default healtcheck route', async () => {
-    const app = express();
-    app.use(healthCheck());
-    await request(app).get('/').expect(200);
-    await request(app).get('/heartbeat').expect(200);
-  });
-});

package/src/middleware/healthCheck/healthCheck.ts

@@ -1,14 +0,0 @@
-import { Router, Request, Response } from 'express';
-
-/**
- * respond to Kubernetes health-checks with 200
- */
-export function healthCheck(path = '/heartbeat'): Router {
-  return Router()
-    .get('/', (req: Request, res: Response) => {
-      res.sendStatus(200);
-    })
-    .get(path, (req: Request, res: Response) => {
-      res.sendStatus(200);
-    });
-}

package/src/middleware/healthCheck/index.ts

@@ -1 +0,0 @@
-export * from './healthCheck';

package/src/middleware/index.ts

@@ -1,17 +0,0 @@
-export * from './error';
-export * from './healthCheck';
-export * from './validate';
-export * from './fourOhFour';
-export * from './authJwt';
-export * from './authHmac';
-export * from './authStatic';
-export * from './swaggerDocs';
-export * from './authTls';
-export * from './userResolver';
-export * from './fileUploader';
-export * from './metrics';
-export * from './requestMetrics';
-export * from './version';
-export * from './geminiFileUploader';
-export * from './checkPermission';
-export * from './multiPartFileUploader';

package/src/middleware/metrics/index.ts

@@ -1 +0,0 @@
-export * from './metrics';

package/src/middleware/metrics/metrics.test.ts

@@ -1,46 +0,0 @@
-import { expect } from 'chai';
-import express from 'express';
-import { Counter } from 'prom-client';
-import request from 'supertest';
-import { metrics } from './metrics';
-import { serviceRegistry, instanceRegistry } from 'const/metrics';
-
-describe('Middleware - metrics', () => {
-  beforeEach(() => {
-    instanceRegistry.clear();
-    serviceRegistry.clear();
-  });
-
-  it('should export instance metrics', async () => {
-    new Counter({
-      name: 'instance_test',
-      help: 'instance_test',
-      registers: [instanceRegistry]
-    });
-
-    const app = express();
-    app.use(metrics());
-
-    const { text } = await request(app).get('/metrics/instance').expect(200);
-    expect(text).to.equal(
-      '# HELP instance_test instance_test\n# TYPE instance_test counter\ninstance_test 0\n'
-    );
-  });
-
-  it('should export service metrics', async () => {
-    new Counter({
-      name: 'service_test',
-      help: 'service_test',
-      registers: [serviceRegistry]
-    });
-
-    const app = express();
-    app.use(metrics());
-
-    const { text } = await request(app).get('/metrics/service').expect(200);
-
-    expect(text).to.equal(
-      '# HELP service_test service_test\n# TYPE service_test counter\nservice_test 0\n'
-    );
-  });
-});

package/src/middleware/metrics/metrics.ts

@@ -1,24 +0,0 @@
-import { Router, Request, Response } from 'express';
-import { instanceRegistry, serviceRegistry } from 'const/metrics';
-import { reportError } from 'utils/report';
-
-/** Middleware that calculates request time, and exposes metrics related to requests processed by this service */
-export function metrics(): Router {
-  return Router()
-    .use('/metrics/instance', (req: Request, res: Response) => {
-      (async (): Promise<void> => {
-        res.set('Content-Type', instanceRegistry.contentType);
-        res.end(await instanceRegistry.metrics());
-      })().catch((error: Error) => {
-        reportError(error);
-      });
-    })
-    .use('/metrics/service', (req: Request, res: Response) => {
-      (async (): Promise<void> => {
-        res.set('Content-Type', serviceRegistry.contentType);
-        res.end(await serviceRegistry.metrics());
-      })().catch((error: Error) => {
-        reportError(error);
-      });
-    });
-}

package/src/middleware/multiPartFileUploader/index.ts

@@ -1,2 +0,0 @@
-export * from './multiPartFileUploader';
-export * from './multiPartFileUploader.types';