Merge pull request #1618 from merico-dev/cache-clear

feat(cache): implement content-specific file system caching
merico-dev · Feb 18, 2025 · 178165b · 178165b
2 parents f1968c7 + d8e64ed
commit 178165b
Show file tree

Hide file tree

Showing 6 changed files with 77 additions and 8 deletions.
diff --git a/api/src/api_models/cache.ts b/api/src/api_models/cache.ts
@@ -0,0 +1,13 @@
+import { ApiModel, ApiModelProperty } from 'swagger-express-ts';
+
+@ApiModel({
+  description: 'Cache clear request object',
+  name: 'CacheClearRequest',
+})
+export class CacheClearRequest {
+  @ApiModelProperty({
+    description: 'Content id',
+    required: true,
+  })
+  content_id: string;
+}
diff --git a/api/src/api_models/index.ts b/api/src/api_models/index.ts
@@ -105,6 +105,7 @@ import {
   SqlSnippetSortObject,
 } from './sql_snippet';
 import { ApiError, Authentication, FilterObject } from './base';
+import { CacheClearRequest } from './cache';
 
 export default {
   ApiError,
@@ -224,4 +225,6 @@ export default {
   SqlSnippetListRequest,
   SqlSnippetPaginationResponse,
   SqlSnippetSortObject,
+
+  CacheClearRequest,
 };
diff --git a/api/src/controller/cache.controller.ts b/api/src/controller/cache.controller.ts
@@ -0,0 +1,43 @@
+import { controller, httpPost, interfaces } from 'inversify-express-utils';
+import { ApiOperationPost, ApiPath } from 'swagger-express-ts';
+import { clearFsCache, clearFsCacheByContentId } from '../utils/fs_cache';
+import { CacheClearRequest } from '../api_models/cache';
+import express from 'express';
+import { validate } from '../middleware/validation';
+@ApiPath({
+  path: '/cache',
+  name: 'Cache',
+})
+@controller('/cache')
+export class CacheController implements interfaces.Controller {
+  public static TARGET_NAME = 'Cache';
+
+  @ApiOperationPost({
+    path: '/clear',
+    description: 'Clear cache',
+    parameters: {},
+    responses: {
+      200: { description: 'SUCCESS' },
+    },
+  })
+  @httpPost('/clear')
+  public async clear(): Promise<void> {
+    clearFsCache();
+  }
+
+  @ApiOperationPost({
+    path: '/clear/dashboard',
+    description: 'Clear cache by content id',
+    parameters: {
+      body: { description: 'Cache clear request', required: true, model: 'CacheClearRequest' },
+    },
+    responses: {
+      200: { description: 'SUCCESS' },
+    },
+  })
+  @httpPost('/clear/dashboard', validate(CacheClearRequest))
+  public async clearByContentId(req: express.Request): Promise<void> {
+    const { content_id } = req.body as CacheClearRequest;
+    clearFsCacheByContentId(content_id);
+  }
+}
diff --git a/api/src/controller/index.ts b/api/src/controller/index.ts
@@ -14,6 +14,7 @@ import { DashboardContentController } from './dashboard_content.controller';
 import { DashboardContentChangelogController } from './dashboard_content_changelog.controller';
 import { CustomFunctionController } from './custom_function.controller';
 import { SqlSnippetController } from './sql_snippet.controller';
+import { CacheController } from './cache.controller';
 
 export function bindControllers(container: Container) {
   container
@@ -86,4 +87,9 @@ export function bindControllers(container: Container) {
     .to(SqlSnippetController)
     .inSingletonScope()
     .whenTargetNamed(SqlSnippetController.TARGET_NAME);
+  container
+    .bind<interfaces.Controller>(TYPE.Controller)
+    .to(CacheController)
+    .inSingletonScope()
+    .whenTargetNamed(CacheController.TARGET_NAME);
 }
diff --git a/api/src/services/query.service.ts b/api/src/services/query.service.ts
@@ -265,7 +265,7 @@ export class QueryService {
     const fsCacheEnabled = await isFsCacheEnabled();
     const cacheKey = getFsCacheKey(`${parsedType}:${parsedKey}:${q}`);
     if (fsCacheEnabled && !refresh_cache) {
-      const cached = await getFsCache(cacheKey);
+      const cached = await getFsCache(content_id, cacheKey);
       if (cached) {
         return cached;
       }
@@ -292,7 +292,7 @@ export class QueryService {
         return null;
     }
     if (fsCacheEnabled) {
-      await putFsCache(cacheKey, result);
+      await putFsCache(content_id, cacheKey, result);
     }
     return result;
   }

diff --git a/api/src/utils/fs_cache.ts b/api/src/utils/fs_cache.ts
@@ -26,23 +26,27 @@ export const clearFsCache = () => {
   fs.emptyDirSync(cacheDir);
 };
 
-export const putFsCache = async (key: string, data: any): Promise<void> => {
+export const clearFsCacheByContentId = (contentId: string) => {
+  fs.emptyDirSync(path.join(cacheDir, contentId));
+};
+
+export const putFsCache = async (contentId: string, key: string, data: any): Promise<void> => {
   fs.ensureDirSync(cacheDir);
   const filename = `${key}.json`;
-  await fs.writeJSON(path.join(cacheDir, filename), data);
+  await fs.writeJSON(path.join(cacheDir, contentId, filename), data);
 };
 
-export const getFsCache = async (key: string): Promise<any> => {
+export const getFsCache = async (contentId: string, key: string): Promise<any> => {
   fs.ensureDirSync(cacheDir);
   const ttl = await getTTL();
   const filename = `${key}.json`;
   try {
-    const fileInfo = await fs.stat(path.join(cacheDir, filename));
+    const fileInfo = await fs.stat(path.join(cacheDir, contentId, filename));
     if (fileInfo.mtimeMs + ttl * 1000 < Date.now()) {
-      await fs.remove(path.join(cacheDir, filename));
+      await fs.remove(path.join(cacheDir, contentId, filename));
       return null;
     }
-    return fs.readJSON(path.join(cacheDir, filename));
+    return fs.readJSON(path.join(cacheDir, contentId, filename));
   } catch (err) {
     return null;
   }