Implement File based datastore for windows (#281)

Author: satyakigh

THIRD-PARTY-LICENSES.txt

@@ -39172,6 +39172,33 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
 
 
+******************************
+
+async-mutex
+0.5.0 <https://github.com/DirtyHairy/async-mutex>
+The MIT License (MIT)
+
+Copyright (c) 2016 Christian Speckner <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+
 ******************************
 
 asynckit
@@ -39984,6 +40011,13 @@ The above copyright notice and this permission notice shall be included in all c
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 
 
+******************************
+
+cfn-guard
+3.1.1 <https://github.com/aws-cloudformation/cloudformation-guard>
+license: Apache-2.0
+authors: undefined
+
 ******************************
 
 chalk

package-lock.json

@@ -72,6 +72,7 @@
     "@opentelemetry/sdk-trace-node": "2.0.1",
     "@tree-sitter-grammars/tree-sitter-yaml": "0.7.1",
     "archiver": "7.0.1",
+    "async-mutex": "0.5.0",
     "axios": "1.11.0",
     "cfn-guard": "https://gitpkg.now.sh/aws-cloudformation/cloudformation-guard/guard/ts-lib?33d9931",
     "deep-object-diff": "1.1.9",

package.json

@@ -238,6 +238,7 @@ Name,SPDXID,Version,DownloadLocation,License
 "archiver","SPDXRef-Package-archiver-7.0.1","7.0.1","https://registry.npmjs.org/archiver/-/archiver-7.0.1.tgz","MIT"
 "archiver-utils","SPDXRef-Package-archiver-utils-5.0.2","5.0.2","https://registry.npmjs.org/archiver-utils/-/archiver-utils-5.0.2.tgz","MIT"
 "async","SPDXRef-Package-async-3.2.6","3.2.6","https://registry.npmjs.org/async/-/async-3.2.6.tgz","MIT"
+"async-mutex","SPDXRef-Package-async-mutex-0.5.0","0.5.0","https://registry.npmjs.org/async-mutex/-/async-mutex-0.5.0.tgz","MIT"
 "asynckit","SPDXRef-Package-asynckit-0.4.0","0.4.0","https://registry.npmjs.org/asynckit/-/asynckit-0.4.0.tgz","MIT"
 "atomic-sleep","SPDXRef-Package-atomic-sleep-1.0.0","1.0.0","https://registry.npmjs.org/atomic-sleep/-/atomic-sleep-1.0.0.tgz","MIT"
 "axios","SPDXRef-Package-axios-1.11.0","1.11.0","https://registry.npmjs.org/axios/-/axios-1.11.0.tgz","MIT"
@@ -253,6 +254,7 @@ Name,SPDXID,Version,DownloadLocation,License
 "buffer-crc32","SPDXRef-Package-buffer-crc32-0.2.13","0.2.13","https://registry.npmjs.org/buffer-crc32/-/buffer-crc32-0.2.13.tgz","MIT"
 "buffer-equal-constant-time","SPDXRef-Package-buffer-equal-constant-time-1.0.1","1.0.1","https://registry.npmjs.org/buffer-equal-constant-time/-/buffer-equal-constant-time-1.0.1.tgz","BSD-3-Clause"
 "camelcase","SPDXRef-Package-camelcase-6.3.0","6.3.0","https://registry.npmjs.org/camelcase/-/camelcase-6.3.0.tgz","MIT"
+"cfn-guard","SPDXRef-Package-cfn-guard-3.1.1","3.1.1","https://gitpkg.now.sh/aws-cloudformation/cloudformation-guard/guard/ts-lib?33d9931","Apache-2.0"
 "cjs-module-lexer","SPDXRef-Package-cjs-module-lexer-1.4.3","1.4.3","https://registry.npmjs.org/cjs-module-lexer/-/cjs-module-lexer-1.4.3.tgz","MIT"
 "cliui","SPDXRef-Package-cliui-8.0.1","8.0.1","https://registry.npmjs.org/cliui/-/cliui-8.0.1.tgz","ISC"
 "cohere-ai","SPDXRef-Package-cohere-ai-7.18.1","7.18.1","https://registry.npmjs.org/cohere-ai/-/cohere-ai-7.18.1.tgz","NOASSERTION"

sbom/sbom.csv

@@ -3,9 +3,9 @@
   "dataLicense": "CC0-1.0",
   "SPDXID": "SPDXRef-DOCUMENT",
   "name": "@aws/[email protected]",
-  "documentNamespace": "http://spdx.org/spdxdocs/@aws%2fcloudformation-languageserver-0.0.5-10917d5e-8766-4203-8433-0b4cdad240a9",
+  "documentNamespace": "http://spdx.org/spdxdocs/@aws%2fcloudformation-languageserver-0.0.5-20c6d2ff-852b-42ee-ae45-8990f987420e",
   "creationInfo": {
-    "created": "2025-11-07T17:17:43.925Z",
+    "created": "2025-11-18T08:08:30.548Z",
     "creators": [
       "Tool: npm/cli-10.9.2"
     ]
@@ -6499,6 +6499,30 @@
         }
       ]
     },
+    {
+      "name": "async-mutex",
+      "SPDXID": "SPDXRef-Package-async-mutex-0.5.0",
+      "versionInfo": "0.5.0",
+      "packageFileName": "node_modules/async-mutex",
+      "description": "A mutex for guarding async workflows",
+      "downloadLocation": "https://registry.npmjs.org/async-mutex/-/async-mutex-0.5.0.tgz",
+      "filesAnalyzed": false,
+      "homepage": "https://github.com/DirtyHairy/async-mutex#readme",
+      "licenseDeclared": "MIT",
+      "externalRefs": [
+        {
+          "referenceCategory": "PACKAGE-MANAGER",
+          "referenceType": "purl",
+          "referenceLocator": "pkg:npm/[email protected]"
+        }
+      ],
+      "checksums": [
+        {
+          "algorithm": "SHA512",
+          "checksumValue": "d40f78075f23909dc362adbce2884fc685db7d30391ec43bfcc7f80c485cc8bc77073dbb461e7d89271b07a10f88ff81fa3a2e7ba602c5c31749b142d6d64ac0"
+        }
+      ]
+    },
     {
       "name": "asynckit",
       "SPDXID": "SPDXRef-Package-asynckit-0.4.0",
@@ -6811,6 +6835,30 @@
         }
       ]
     },
+    {
+      "name": "cfn-guard",
+      "SPDXID": "SPDXRef-Package-cfn-guard-3.1.1",
+      "versionInfo": "3.1.1",
+      "packageFileName": "node_modules/cfn-guard",
+      "description": "AWS CloudFormation Guard is an open-source general-purpose policy-as-code evaluation tool. It provides developers with a simple-to-use, yet powerful and expressive domain-specific language (DSL) to define policies and enables developers to validate JSON- or YAML- formatted structured data with those policies.",
+      "downloadLocation": "https://gitpkg.now.sh/aws-cloudformation/cloudformation-guard/guard/ts-lib?33d9931",
+      "filesAnalyzed": false,
+      "homepage": "https://github.com/aws-cloudformation/cloudformation-guard#readme",
+      "licenseDeclared": "Apache-2.0",
+      "externalRefs": [
+        {
+          "referenceCategory": "PACKAGE-MANAGER",
+          "referenceType": "purl",
+          "referenceLocator": "pkg:npm/[email protected]"
+        }
+      ],
+      "checksums": [
+        {
+          "algorithm": "SHA512",
+          "checksumValue": "8a14a9a96126ad074c8947b0658a1615cf4919774a26387adb4fca48315491aaed5f1ffa99e0116873bea5166fc588249f4845438fc8299db6b41e81edba4dde"
+        }
+      ]
+    },
     {
       "name": "cjs-module-lexer",
       "SPDXID": "SPDXRef-Package-cjs-module-lexer-1.4.3",
@@ -11632,11 +11680,21 @@
       "relatedSpdxElement": "SPDXRef-Package-aws.cloudformation-languageserver-0.0.5",
       "relationshipType": "DEPENDENCY_OF"
     },
+    {
+      "spdxElementId": "SPDXRef-Package-async-mutex-0.5.0",
+      "relatedSpdxElement": "SPDXRef-Package-aws.cloudformation-languageserver-0.0.5",
+      "relationshipType": "DEPENDENCY_OF"
+    },
     {
       "spdxElementId": "SPDXRef-Package-axios-1.11.0",
       "relatedSpdxElement": "SPDXRef-Package-aws.cloudformation-languageserver-0.0.5",
       "relationshipType": "DEPENDENCY_OF"
     },
+    {
+      "spdxElementId": "SPDXRef-Package-cfn-guard-3.1.1",
+      "relatedSpdxElement": "SPDXRef-Package-aws.cloudformation-languageserver-0.0.5",
+      "relationshipType": "DEPENDENCY_OF"
+    },
     {
       "spdxElementId": "SPDXRef-Package-deep-object-diff-1.1.9",
       "relatedSpdxElement": "SPDXRef-Package-aws.cloudformation-languageserver-0.0.5",

sbom/sbom.json

@@ -1,4 +1,7 @@
+import { pathToArtifact } from '../utils/ArtifactsDir';
 import { Closeable } from '../utils/Closeable';
+import { isWindows } from '../utils/Environment';
+import { FileStoreFactory } from './FileStore';
 import { LMDBStoreFactory } from './LMDB';
 import { MemoryStoreFactory } from './MemoryStore';
 
@@ -24,14 +27,14 @@ export interface DataStore {
     clear(): Promise<void>;
 
     keys(limit: number): ReadonlyArray<string>;
-
-    stats(): unknown;
 }
 
 export interface DataStoreFactory extends Closeable {
     get(store: StoreName): DataStore;
 
     storeNames(): ReadonlyArray<string>;
+
+    close(): Promise<void>;
 }
 
 export interface DataStoreFactoryProvider extends Closeable {
@@ -56,21 +59,26 @@ export class MemoryDataStoreFactoryProvider implements DataStoreFactoryProvider
 
 export class MultiDataStoreFactoryProvider implements DataStoreFactoryProvider {
     private readonly memoryStoreFactory: MemoryStoreFactory;
-    private readonly lmdbStoreFactory: LMDBStoreFactory;
+    private readonly persistedStore: DataStoreFactory;
+
+    constructor(rootDir: string = pathToArtifact()) {
+        if (isWindows) {
+            this.persistedStore = new FileStoreFactory(rootDir);
+        } else {
+            this.persistedStore = new LMDBStoreFactory(rootDir);
+        }
 
-    constructor(lmdbStore?: LMDBStoreFactory, memStore?: MemoryStoreFactory) {
-        this.lmdbStoreFactory = lmdbStore ?? new LMDBStoreFactory();
-        this.memoryStoreFactory = memStore ?? new MemoryStoreFactory();
+        this.memoryStoreFactory = new MemoryStoreFactory();
     }
 
     get(store: StoreName, persistence: Persistence): DataStore {
         if (persistence === Persistence.memory) {
             return this.memoryStoreFactory.get(store);
         }
-        return this.lmdbStoreFactory.get(store);
+        return this.persistedStore.get(store);
     }
 
     close(): Promise<void> {
-        return this.lmdbStoreFactory.close();
+        return this.persistedStore.close();
     }
 }

src/datastore/DataStore.ts

@@ -0,0 +1,72 @@
+import { existsSync, mkdirSync } from 'fs';
+import { join } from 'path';
+import { Logger } from 'pino';
+import { LoggerFactory } from '../telemetry/LoggerFactory';
+import { ScopedTelemetry } from '../telemetry/ScopedTelemetry';
+import { Telemetry } from '../telemetry/TelemetryDecorator';
+import { DataStore, DataStoreFactory, StoreName } from './DataStore';
+import { EncryptedFileStore } from './file/EncryptedFileStore';
+import { encryptionKey } from './file/Encryption';
+
+export class FileStoreFactory implements DataStoreFactory {
+    private readonly log: Logger;
+    @Telemetry({ scope: 'FileStore.Global' }) private readonly telemetry!: ScopedTelemetry;
+
+    private readonly stores = new Map<StoreName, EncryptedFileStore>();
+    private readonly fileDbDir: string;
+    private readonly metricsInterval: NodeJS.Timeout;
+
+    constructor(rootDir: string) {
+        this.log = LoggerFactory.getLogger('FileStore.Global');
+
+        this.fileDbDir = join(rootDir, 'filedb', `${Version}`);
+        if (!existsSync(this.fileDbDir)) {
+            mkdirSync(this.fileDbDir, { recursive: true });
+        }
+
+        this.metricsInterval = setInterval(() => {
+            this.emitMetrics();
+        }, 60 * 1000);
+        this.log.info(`Initialized FileStore v${Version}`);
+    }
+
+    get(store: StoreName): DataStore {
+        let val = this.stores.get(store);
+        if (!val) {
+            val = new EncryptedFileStore(encryptionKey(Version), store, this.fileDbDir);
+            this.stores.set(store, val);
+        }
+        return val;
+    }
+
+    storeNames(): ReadonlyArray<string> {
+        return [...this.stores.keys()];
+    }
+
+    close(): Promise<void> {
+        clearInterval(this.metricsInterval);
+        return Promise.resolve();
+    }
+
+    private emitMetrics(): void {
+        this.telemetry.histogram('version', Version);
+        this.telemetry.histogram('env.entries', this.stores.size);
+
+        let totalBytes = 0;
+        for (const [name, store] of this.stores.entries()) {
+            const stats = store.stats();
+
+            totalBytes += stats.totalSize;
+            this.telemetry.histogram(`store.${name}.entries`, stats.entries);
+            this.telemetry.histogram(`store.${name}.size.bytes`, stats.totalSize, {
+                unit: 'By',
+            });
+        }
+
+        this.telemetry.histogram('total.size.bytes', totalBytes, {
+            unit: 'By',
+        });
+    }
+}
+
+const Version = 1;