Remove userinfo to support SNAP installs (#332)

Author: satyakigh

eslint.config.mjs

@@ -161,13 +161,27 @@ export default tseslint.config([
                     message:
                         'Usage of raw ResourceAttribute strings is restricted in src code. Use ResourceAttribute enum instead',
                 },
+            ],
+            'no-restricted-imports': [
+                'error',
                 {
-                    selector: "ImportSpecifier[imported.name='readFileSync']",
-                    message: 'Use methods in File.ts',
-                },
-                {
-                    selector: "ImportSpecifier[imported.name='readFile']",
-                    message: 'Use methods in File.ts',
+                    paths: [
+                        {
+                            name: 'os',
+                            importNames: ['userInfo'],
+                            message: 'userInfo is not supported in sandbox Linux environments',
+                        },
+                        {
+                            name: 'fs',
+                            importNames: ['readFileSync', 'readFile'],
+                            message: 'Use methods in File.ts',
+                        },
+                        {
+                            name: 'fs/promises',
+                            importNames: ['readFile'],
+                            message: 'Use methods in File.ts',
+                        },
+                    ],
                 },
             ],
         },

src/datastore/FileStore.ts

@@ -1,4 +1,4 @@
-import { existsSync, mkdirSync } from 'fs';
+import { existsSync, mkdirSync, readdirSync, rmSync } from 'fs';
 import { join } from 'path';
 import { Logger } from 'pino';
 import { LoggerFactory } from '../telemetry/LoggerFactory';
@@ -13,27 +13,40 @@ export class FileStoreFactory implements DataStoreFactory {
     @Telemetry({ scope: 'FileStore.Global' }) private readonly telemetry!: ScopedTelemetry;
 
     private readonly stores = new Map<StoreName, EncryptedFileStore>();
+    private readonly fileDbRoot: string;
     private readonly fileDbDir: string;
+
     private readonly metricsInterval: NodeJS.Timeout;
+    private readonly timeout: NodeJS.Timeout;
 
     constructor(rootDir: string) {
         this.log = LoggerFactory.getLogger('FileStore.Global');
 
-        this.fileDbDir = join(rootDir, 'filedb', `${Version}`);
+        this.fileDbRoot = join(rootDir, 'filedb');
+        this.fileDbDir = join(this.fileDbRoot, Version);
+
         if (!existsSync(this.fileDbDir)) {
             mkdirSync(this.fileDbDir, { recursive: true });
         }
 
         this.metricsInterval = setInterval(() => {
             this.emitMetrics();
         }, 60 * 1000);
-        this.log.info(`Initialized FileStore v${Version}`);
+
+        this.timeout = setTimeout(
+            () => {
+                this.cleanupOldVersions();
+            },
+            2 * 60 * 1000,
+        );
+
+        this.log.info(`Initialized FileDB ${Version}`);
     }
 
     get(store: StoreName): DataStore {
         let val = this.stores.get(store);
         if (!val) {
-            val = new EncryptedFileStore(encryptionKey(Version), store, this.fileDbDir);
+            val = new EncryptedFileStore(encryptionKey(VersionNumber), store, this.fileDbDir);
             this.stores.set(store, val);
         }
         return val;
@@ -44,12 +57,13 @@ export class FileStoreFactory implements DataStoreFactory {
     }
 
     close(): Promise<void> {
+        clearTimeout(this.timeout);
         clearInterval(this.metricsInterval);
         return Promise.resolve();
     }
 
     private emitMetrics(): void {
-        this.telemetry.histogram('version', Version);
+        this.telemetry.histogram('version', VersionNumber);
         this.telemetry.histogram('env.entries', this.stores.size);
 
         let totalBytes = 0;
@@ -67,6 +81,22 @@ export class FileStoreFactory implements DataStoreFactory {
             unit: 'By',
         });
     }
+
+    private cleanupOldVersions(): void {
+        const entries = readdirSync(this.fileDbRoot, { withFileTypes: true });
+        for (const entry of entries) {
+            try {
+                if (entry.name !== Version) {
+                    this.telemetry.count('oldVersion.cleanup.count', 1);
+                    rmSync(join(this.fileDbRoot, entry.name), { recursive: true, force: true });
+                }
+            } catch (error) {
+                this.log.error(error, 'Failed to cleanup old FileDB versions');
+                this.telemetry.count('oldVersion.cleanup.error', 1);
+            }
+        }
+    }
 }
 
-const Version = 1;
+const VersionNumber = 2;
+const Version = `v${VersionNumber}`;

src/datastore/LMDB.ts

@@ -69,7 +69,7 @@ export class LMDBStoreFactory implements DataStoreFactory {
                 noSubdir: config.noSubdir,
                 overlappingSync: config.overlappingSync,
             },
-            `Initialized LMDB v${VersionNumber} with stores: ${toString(storeNames)}`,
+            `Initialized LMDB ${Version} with stores: ${toString(storeNames)}`,
         );
     }
 
@@ -139,7 +139,7 @@ export class LMDBStoreFactory implements DataStoreFactory {
     }
 }
 
-const VersionNumber = 4;
+const VersionNumber = 5;
 const Version = `v${VersionNumber}`;
 const Encoding: 'msgpack' | 'json' | 'string' | 'binary' | 'ordered-binary' = 'msgpack';
 const TotalMaxDbSize = 250 * 1024 * 1024; // 250MB max size

src/datastore/file/EncryptedFileStore.ts

@@ -1,4 +1,4 @@
-import { existsSync, readFileSync, statSync, unlinkSync } from 'fs'; // eslint-disable-line no-restricted-syntax -- files being checked
+import { existsSync, readFileSync, statSync, unlinkSync } from 'fs'; // eslint-disable-line no-restricted-imports -- files being checked
 import { writeFile } from 'fs/promises';
 import { join } from 'path';
 import { Mutex } from 'async-mutex';

src/datastore/file/Encryption.ts

@@ -3,6 +3,7 @@ import { stableMachineSpecificKey } from '../../utils/MachineKey';
 
 export function encryptionKey(version: number): Buffer {
     switch (version) {
+        case 2:
         case 1: {
             return stableMachineSpecificKey('filedb-static-salt', 'filedb-encryption-key-derivation', 32);
         }

src/datastore/lmdb/Utils.ts

@@ -2,6 +2,7 @@ import { stableMachineSpecificKey } from '../../utils/MachineKey';
 
 export function encryptionStrategy(version: number): string | Buffer | undefined {
     switch (version) {
+        case 5:
         case 4: {
             return stableMachineSpecificKey('lmdb-static-salt', 'lmdb-encryption-key-derivation', 16).toString('hex');
         }

src/services/S3Service.ts

@@ -1,4 +1,4 @@
-import { readFileSync } from 'fs'; // eslint-disable-line no-restricted-syntax -- Needs to be fixed
+import { readFileSync } from 'fs'; // eslint-disable-line no-restricted-imports -- TODO: Needs to be fixed
 import { fileURLToPath } from 'url';
 import { S3Client, PutObjectCommand, ListBucketsCommand, HeadObjectCommand } from '@aws-sdk/client-s3';
 import { Measure } from '../telemetry/TelemetryDecorator';

src/telemetry/LoggerFactory.ts

@@ -1,6 +1,6 @@
 /* eslint-disable @typescript-eslint/no-unsafe-function-type */
 import { existsSync } from 'fs';
-import { readdir, stat, unlink, writeFile, readFile } from 'fs/promises'; // eslint-disable-line no-restricted-syntax -- circular dependency
+import { readdir, stat, unlink, writeFile, readFile } from 'fs/promises'; // eslint-disable-line no-restricted-imports -- circular dependency
 import { join } from 'path';
 import { DateTime } from 'luxon';
 import pino, { LevelWithSilent, Logger } from 'pino';

src/utils/ClientUtil.ts

@@ -1,5 +1,5 @@
-import { readFileSync, existsSync, PathLike } from 'fs'; // eslint-disable-line no-restricted-syntax
-import { readFile } from 'fs/promises'; // eslint-disable-line no-restricted-syntax
+import { readFileSync, existsSync, PathLike } from 'fs'; // eslint-disable-line no-restricted-imports
+import { readFile } from 'fs/promises'; // eslint-disable-line no-restricted-imports
 import { LoggerFactory } from '../telemetry/LoggerFactory';
 import { toString } from './String';