caching layer persistent

Author: onlyjackfrost

packages/core/src/containers/modules/dataSource.ts

@@ -8,7 +8,11 @@ import {
 import { Profile } from '../../models/profile';
 import { ClassType } from '../../lib/utils/module';
 import { ConfigurationError } from '@vulcan-sql/core/utils';
-import { ICacheLayerOptions, cacheProfileName } from '@vulcan-sql/core/models';
+import {
+  ICacheLayerOptions,
+  cacheLayerPersistentFileName,
+  cacheProfileName,
+} from '@vulcan-sql/core/models';
 import 'reflect-metadata';
 
 export const dataSourceModule = (
@@ -26,6 +30,7 @@ export const dataSourceModule = (
         type: options.loader!.toLocaleLowerCase(),
         // allow '*' to make every user request could use the cache-layer data source.
         allow: '*',
+        connection: { ['persistent-path']: cacheLayerPersistentFileName },
       } as Profile);
     }
 

packages/core/src/models/cacheLayerOptions.ts

@@ -19,6 +19,11 @@ export interface ICacheLayerOptions {
 // The cache layer profile name is used to load the cache data to table name from cache files
 export const cacheProfileName = 'vulcan.cache';
 
+// The cache layer persistent file name, if the file name is set to ":memory:", it will use in-memory database
+export const cacheLayerPersistentFileName =
+  process.env['VULCAN_CACHE_LAYER_PERSISTENT_FILE_NAME'] ||
+  'vulcan_caching_layer.db';
+
 // The schema name for vulcan used to create table when loading cache files to cache data source
 export const vulcanCacheSchemaName = 'vulcan';
 

packages/core/test/containers/cacheLayer.spec.ts

@@ -1,6 +1,7 @@
 import {
   CacheLayerLoader,
   cacheLayerModule,
+  cacheLayerPersistentFileName,
   CacheLayerStoreFormatType,
   cacheProfileName,
   DataResult,
@@ -89,11 +90,21 @@ it('Cache layer module should add "vulcan.cache" profile and bind "duckdb" type
 
   expect(dsFromTestDuck.injectedProfiles).toEqual([
     { name: 'test-duck', type: 'duckdb', allow: '*' },
-    { name: cacheProfileName, type: 'duckdb', allow: '*' },
+    {
+      name: cacheProfileName,
+      type: 'duckdb',
+      allow: '*',
+      connection: { ['persistent-path']: cacheLayerPersistentFileName },
+    },
   ]);
   expect(dsFromCacheLayer.injectedProfiles).toEqual([
     { name: 'test-duck', type: 'duckdb', allow: '*' },
-    { name: cacheProfileName, type: 'duckdb', allow: '*' },
+    {
+      name: cacheProfileName,
+      type: 'duckdb',
+      allow: '*',
+      connection: { ['persistent-path']: cacheLayerPersistentFileName },
+    },
   ]);
 });