refactor: use helpers for making cache keys

Author: meness

src/configs/cache.config.ts

@@ -2,8 +2,8 @@ export const cacheConfig = {
   // TODO TTL should be variable based on the repo activity
   ttl: 60 * 60 * 24, // Cache for 24 hours
   key: {
-    githubUserContributors: `github/${String}:contributors`,
-    githubUserConfig: `github/${String}:config`,
-    githubUserApiKey: `github/${String}/${String}:key`
+    userContributors: `user/${String}:contributors`,
+    userConfig: `user/${String}:config`,
+    userApiKey: `user/${String}/${String}:key`
   }
 } as const;

src/handlers/app.handler.ts

@@ -43,10 +43,10 @@ export class AppHandler {
     // Service initialization
     this.services = {
       appService: AppService.getInstance(),
-      configService: ConfigService.getInstance(),
       openAiService: OpenAiService.getInstance(),
       queueService: QueueService.getInstance(),
-      cacheService: CacheService.getInstance()
+      cacheService: CacheService.getInstance(),
+      configService: new ConfigService(CacheService.getInstance(), QueueService.getInstance())
     };
 
     // Handler initialization

src/handlers/contributor.handler.ts

@@ -4,6 +4,7 @@ import { Handler } from '~common/interfaces';
 import { CacheKey } from '~common/types';
 import { cacheConfig } from '~configs';
 import { SystemError } from '~errors';
+import { getUserContributorsCacheKey } from '~helpers';
 import { CacheService, GitHubService, QueueService } from '~services';
 
 export class ContributorHandler implements Handler<'member'> {
@@ -14,7 +15,7 @@ export class ContributorHandler implements Handler<'member'> {
 
   async handle(context: Context<'member'>, apiKey: string): Promise<void> {
     const { action, member } = context.payload;
-    const contributorsCacheKey: CacheKey = `github/${apiKey}:contributors`;
+    const contributorsCacheKey = getUserContributorsCacheKey(apiKey);
 
     const cachedContributors = await this.cacheService.get<User[]>(contributorsCacheKey);
 
@@ -28,7 +29,7 @@ export class ContributorHandler implements Handler<'member'> {
   }
 
   async safeCacheContributors(context: Context, apiKey: string): Promise<void> {
-    const contributorsCacheKey: CacheKey = `github/${apiKey}:contributors`;
+    const contributorsCacheKey = getUserContributorsCacheKey(apiKey);
     const cachedContributors = await this.cacheService.get<User[]>(contributorsCacheKey);
 
     if (!cachedContributors) {

src/handlers/installation.handler.ts

@@ -1,6 +1,7 @@
 import { Context } from 'probot';
 import { envs } from '~common/consts';
 import { Handler } from '~common/interfaces';
+import { getUserApiKeyCacheKey, getUserConfigCacheKey, getUserContributorsCacheKey } from '~helpers';
 import { CacheService } from '~services';
 
 export class installationHandler implements Handler<'installation'> {
@@ -13,9 +14,9 @@ export class installationHandler implements Handler<'installation'> {
 
     const { owner, repo } = context.repo();
 
-    await this.cacheService.delete(`github/${apiKey}:contributors`);
-    await this.cacheService.delete(`github/${apiKey}:config`);
-    await this.cacheService.delete(`github/${owner}/${repo}:key`);
+    await this.cacheService.delete(getUserContributorsCacheKey(apiKey));
+    await this.cacheService.delete(getUserConfigCacheKey(apiKey));
+    await this.cacheService.delete(getUserApiKeyCacheKey(owner, repo));
     // Delete all user specific keys here
   }
 }

src/handlers/push.handler.ts

@@ -1,6 +1,7 @@
 import { Context } from 'probot';
 import { Handler } from '~common/interfaces';
 import { appConfig } from '~configs';
+import { getUserConfigCacheKey } from '~helpers';
 import { CacheService, ConfigService } from '~services';
 
 export class PushHandler implements Handler<'push'> {
@@ -18,7 +19,7 @@ export class PushHandler implements Handler<'push'> {
       return;
     }
 
-    await this.cacheService.delete(`github/${apiKey}:config`);
+    await this.cacheService.delete(getUserConfigCacheKey(apiKey));
     await this.configService.getConfig(context, apiKey);
   }
 }

src/helpers/cache.helper.ts

@@ -0,0 +1,7 @@
+import { CacheKey } from '~common/types';
+
+export const getUserContributorsCacheKey = (apiKey: string): CacheKey => `user/${apiKey}:contributors`;
+
+export const getUserConfigCacheKey = (apiKey: string): CacheKey => `user/${apiKey}:config`;
+
+export const getUserApiKeyCacheKey = (owner: string, repo: string): CacheKey => `user/${owner}/${repo}:key`;

src/helpers/index.ts

@@ -1,4 +1,5 @@
 export * from './ai.helper';
+export * from './cache.helper';
 export * from './guard.helper';
 export * from './hash.helper';
 export * from './object.helper';

src/services/config.service.ts

@@ -1,35 +1,25 @@
 import { Context } from 'probot';
 import { defaultConfig } from '~common/consts';
 import { Severity } from '~common/enums';
-import { CacheKey, Config } from '~common/types';
+import { Config } from '~common/types';
 import { appConfig, cacheConfig } from '~configs';
 import { UserError } from '~errors';
-import { decodeBase64ToText, merge, parseYaml } from '~helpers';
+import { decodeBase64ToText, getUserApiKeyCacheKey, getUserConfigCacheKey, merge, parseYaml } from '~helpers';
 import { configSchema } from '~schemas';
 import { CacheService } from './cache.service';
 import { GitHubService } from './github.service';
 import { QueueService } from './queue.service';
 
 export class ConfigService {
-  private static instance: ConfigService;
-
-  private constructor(
+  constructor(
     private readonly cacheService: CacheService,
     private readonly queueService: QueueService
   ) {}
 
-  public static getInstance(): ConfigService {
-    if (!ConfigService.instance) {
-      ConfigService.instance = new ConfigService(CacheService.getInstance(), QueueService.getInstance());
-    }
-
-    return ConfigService.instance;
-  }
-
   async getApiKey(context: Context): Promise<string> {
     try {
       const { owner, repo } = context.repo();
-      const apiKeyCacheKey: CacheKey = `github/${owner}/${repo}:key`;
+      const apiKeyCacheKey = getUserApiKeyCacheKey(owner, repo);
       const cachedApiKey = await this.cacheService.get<string>(apiKeyCacheKey);
 
       if (cachedApiKey) {
@@ -61,7 +51,7 @@ export class ConfigService {
   }
 
   async getConfig(context: Context<'pull_request'>, apiKey: string): Promise<Config> {
-    const configCacheKey: CacheKey = `github/${apiKey}:config`;
+    const configCacheKey = getUserConfigCacheKey(apiKey);
     const cachedConfig = await this.cacheService.get<Config>(configCacheKey);
 
     if (cachedConfig) {

src/utils/chat-skip-conditions.util.ts

@@ -4,6 +4,7 @@ import { Context } from 'probot';
 import { Config } from '~common/types';
 import { SystemError } from '~errors';
 import {
+  getUserContributorsCacheKey,
   isDiscussion,
   isDiscussionComment,
   isInlineComment,
@@ -53,7 +54,7 @@ export class ChatSkipConditions {
     if (contributorsOnly) {
       const contributors = await this.cacheService.get<
         RestEndpointMethodTypes['repos']['listContributors']['response']['data']
-      >(`github/${this.apiKey}:contributors`);
+      >(getUserContributorsCacheKey(this.apiKey));
 
       if (!contributors) {
         return true;

src/utils/diagram-skip-conditions.util.ts

@@ -1,6 +1,7 @@
 import { RestEndpointMethodTypes } from '@octokit/plugin-rest-endpoint-methods';
 import { Context } from 'probot';
 import { Config } from '~common/types';
+import { getUserContributorsCacheKey } from '~helpers';
 import { CacheService } from '~services';
 
 export class DiagramSkipConditions {
@@ -35,7 +36,7 @@ export class DiagramSkipConditions {
     if (contributorsOnly) {
       const contributors = await this.cacheService.get<
         RestEndpointMethodTypes['repos']['listContributors']['response']['data']
-      >(`github/${this.apiKey}:contributors`);
+      >(getUserContributorsCacheKey(this.apiKey));
 
       if (!contributors) {
         return true;