Merge pull request #18 from bcgov/fix/filehandleLeak

feat: improve memory usage and fix filehandle leak

Author: mbystedt

Dockerfile

@@ -1,5 +1,5 @@
 ARG REPO_LOCATION=
-FROM ${REPO_LOCATION}node:20 as builder
+FROM ${REPO_LOCATION}node:20-alpine as builder
 
 ### --------------------------------- Build
 # Install packages and build
@@ -10,7 +10,7 @@ RUN npm ci --no-audit && \
     npm ci --omit=dev --no-audit
 
 # Deployment container
-FROM ${REPO_LOCATION}node:20
+FROM ${REPO_LOCATION}node:20-alpine
 
 # LABEL org.opencontainers.image.description="NR Broker handles the business logic of authenticating and validating requests for automated processes to access secrets"
 # LABEL org.opencontainers.image.licenses=Apache-2.0
@@ -21,4 +21,4 @@ COPY --from=builder /app/node_modules ./node_modules
 COPY --from=builder /app/dist ./dist
 
 # Start up command
-ENTRYPOINT ["node", "dist/index"]
+ENTRYPOINT ["node", "--expose-gc", "dist/index"]

src/cron/janitor.ts

@@ -19,7 +19,8 @@ export async function syncLogsDb(db: DatabaseService) {
   );
   for (const row of result.rows) {
     try {
-      fs.openSync(`${row.path}`, 'r');
+      const filehandle = fs.openSync(`${row.path}`, 'r');
+      fs.closeSync(filehandle);
     } catch (err) {
       console.log(
         `janitor: delete database row ${row.id}; file missing: ${row.path}`,

src/cron/rotate.ts

@@ -34,25 +34,27 @@ export async function rotateLogs(db: DatabaseService) {
       await rotateLog(db, file);
     }
     if (LOGROTATE_POSTROTATE_COMMAND) {
-      console.log('rotate: run post-rotate');
+      console.log('rotate: post-rotate command [start]');
       await new Promise<void>((resolve, reject) => {
         exec(LOGROTATE_POSTROTATE_COMMAND, (error, stdout, stderr) => {
           if (error) {
             // node couldn't run the command
+            console.log('rotate: command error');
             reject(error);
             return;
           }
           // Using process.stdout.write to prevent double new lines.
           if (stdout) {
-            process.stdout.write(`stdout: ${stdout}`);
+            process.stdout.write(`rotate: [stdout] ${stdout}`);
           }
           if (stderr) {
-            process.stdout.write(`stderr: ${stderr}`);
+            process.stdout.write(`rotate: [stderr] ${stderr}`);
           }
           resolve();
         });
       });
     }
+    console.log('rotate: post-rotate command [end]');
   } else {
     console.log('rotate: no files to rotate');
   }

src/index.ts

@@ -13,23 +13,40 @@ import { compress } from './cron/compress';
 
 console.log('Starting...');
 
+function runGarbageCollection() {
+  if (global.gc) {
+    global.gc();
+  }
+}
+
 async function main() {
   const db = await DatabaseService.create();
 
+  if (!global.gc) {
+    console.log(
+      'Garbage collection unavailable. Pass --expose-gc ' +
+        'when launching node to enable forced garbage collection.',
+    );
+  }
+
   const rotateJob = Cron(CRON_ROTATE, async () => {
     await rotateLogs(db);
+    runGarbageCollection();
   });
   const compressJob = Cron(CRON_COMPRESS, async () => {
     await syncLogsDb(db);
     await compress(db);
+    runGarbageCollection();
   });
   const backupJob = Cron(CRON_BACKUP, async () => {
     await syncLogsDb(db);
     await backup(db);
+    runGarbageCollection();
   });
   const janitorJob = Cron(CRON_JANITOR, async () => {
     await syncLogsDb(db);
     await removeOldLogs(db);
+    runGarbageCollection();
   });
   console.log(`Rotate job next run: ${rotateJob.nextRun()}`);
   console.log(`Compress job next run: ${compressJob.nextRun()}`);