Ensure that the detected browser config gets updated intermittently

Author: pimterry

custom-typings/@james-proxy/index.d.ts

@@ -31,6 +31,9 @@ declare module '@james-proxy/james-browser-launcher' {
             export const browsers: Launcher.Browser[];
         }
 
+        export function update(callback: (error: Error | null, config: object) => void): void;
+        export function update(configFile: string, callback: (error: Error | null, config: object) => void): void;
+
         export interface Browser {
             name: string;
             version: string;

src/browsers.ts

@@ -1,12 +1,14 @@
 import * as fs from 'fs';
 import * as path from 'path';
 import { promisify } from 'util';
-
 import { Mutex } from 'async-mutex';
 
 import * as getBrowserLauncherCb from '@james-proxy/james-browser-launcher';
 import { LaunchOptions, BrowserInstance } from '@james-proxy/james-browser-launcher';
 
+import { reportError } from './error-tracking';
+
+const statFile = promisify(fs.stat);
 const readFile = promisify(fs.readFile);
 const deleteFile = promisify(fs.unlink);
 const getBrowserLauncher = promisify(getBrowserLauncherCb);
@@ -15,21 +17,38 @@ const browserConfigPath = (configPath: string) => path.join(configPath, 'browser
 
 export { BrowserInstance };
 
+const updateBrowserConfig = promisify(getBrowserLauncherCb.update);
+
 export async function checkBrowserConfig(configPath: string) {
     // It's not clear why, but sometimes the browser config can become corrupted, so it's not valid JSON
     // If that happens JBL doesn't catch it, so we crash. To avoid that, we check it here on startup.
 
     const browserConfig = browserConfigPath(configPath);
-    return readFile(browserConfig, 'utf8')
-    .then((contents) => JSON.parse(contents))
+    return Promise.all([
+        // Check the file is readable and parseable
+        readFile(browserConfig, 'utf8')
+            .then((contents) => JSON.parse(contents)),
+
+        // Check the file is relatively recent
+        statFile(browserConfig)
+            .then((stats) => {
+                if (Date.now() - stats.mtime.valueOf() > 1000 * 60 * 60 * 24) {
+                    return deleteFile(browserConfig).catch((err) => {
+                        console.error('Failed to clear outdated config file');
+                        reportError(err);
+                    });
+                };
+            })
+    ])
     .catch((error) => {
         if (error.code === 'ENOENT') return;
 
         console.warn('Failed to read browser config on startup', error);
         return deleteFile(browserConfig).catch((err) => {
             console.error('Failed to clear broken config file:', err);
+            reportError(err);
         });
-    });
+    })
 }
 
 // It's not safe to call getBrowserLauncher in parallel, as config files can

src/error-tracking.ts

@@ -4,7 +4,7 @@ let sentryInitialized = false;
 
 export function initErrorTracking() {
     const packageJson = require('../package.json');
-    
+
     let { SENTRY_DSN } = process.env;
     if (!SENTRY_DSN && process.env.HTTPTOOLKIT_SERVER_BINPATH) {
         // If we're a built binary, use the standard DSN automatically