From 9bbf0bdecc5549b8d3a7f14747a5b83c04171910 Mon Sep 17 00:00:00 2001
From: doprz <52579214+doprz@users.noreply.github.com>
Date: Tue, 5 Nov 2024 19:26:34 -0600
Subject: [PATCH] chore: refactor any with unknown and add jsdocs

---
 src/shared/storage/CacheStore.ts |  7 ++-----
 src/shared/types/CachedData.ts   |  6 +++++-
 src/views/lib/getGitHubStats.ts  | 23 +++++++++++++++--------
 3 files changed, 22 insertions(+), 14 deletions(-)

diff --git a/src/shared/storage/CacheStore.ts b/src/shared/storage/CacheStore.ts
index 804001f7..455dd7c5 100644
--- a/src/shared/storage/CacheStore.ts
+++ b/src/shared/storage/CacheStore.ts
@@ -1,18 +1,15 @@
 import type { CachedData } from '@shared/types/CachedData';
 import { createLocalStore, debugStore } from 'chrome-extension-toolkit';
 
-import { generateRandomId } from '../util/random';
-
 interface ICacheStore {
-    // eslint-disable-next-line @typescript-eslint/no-explicit-any
-    github: Record<string, CachedData<any>>;
+    github: Record<string, CachedData<unknown>>;
 }
 
 /**
  * A store that is used for storing cached data such as GitHub contributors
  */
 export const CacheStore = createLocalStore<ICacheStore>({
-    github: {}
+    github: {},
 });
 
 debugStore({ cacheStore: CacheStore });
diff --git a/src/shared/types/CachedData.ts b/src/shared/types/CachedData.ts
index 43ca8e57..03c8fc53 100644
--- a/src/shared/types/CachedData.ts
+++ b/src/shared/types/CachedData.ts
@@ -1,4 +1,8 @@
+/**
+ * Represents cached data with its fetch timestamp
+ * @template T The type of the cached data
+ */
 export type CachedData<T> = {
     data: T;
     dataFetched: number;
-};
\ No newline at end of file
+};
diff --git a/src/views/lib/getGitHubStats.ts b/src/views/lib/getGitHubStats.ts
index 62586ac7..501f8b9e 100644
--- a/src/views/lib/getGitHubStats.ts
+++ b/src/views/lib/getGitHubStats.ts
@@ -1,7 +1,6 @@
 import { Octokit } from '@octokit/rest';
 import { CacheStore } from '@shared/storage/CacheStore';
 import type { CachedData } from '@shared/types/CachedData';
-import { serialize } from 'chrome-extension-toolkit';
 
 // Types
 type TeamMember = {
@@ -66,7 +65,7 @@ export type LD_ADMIN_GITHUB_USERNAMES = (typeof LONGHORN_DEVELOPERS_ADMINS)[numb
  */
 export class GitHubStatsService {
     private octokit: Octokit;
-    private cache: Record<string, CachedData<any>>;
+    private cache: Record<string, CachedData<unknown>>;
 
     constructor(githubToken?: string) {
         this.octokit = githubToken ? new Octokit({ auth: githubToken }) : new Octokit();
@@ -75,10 +74,14 @@ export class GitHubStatsService {
 
     private async getCachedData<T>(key: string): Promise<CachedData<T> | null> {
         if (Object.keys(this.cache).length === 0) {
-            this.cache = await CacheStore.get('github') as Record<string, CachedData<any>>;
+            const githubCache = await CacheStore.get('github');
+            if (githubCache && typeof githubCache === 'object') {
+                this.cache = githubCache as Record<string, CachedData<unknown>>;
+            }
         }
-        const cachedItem = this.cache[key];
-        if (cachedItem && Date.now() - new Date(cachedItem.dataFetched).getTime() < CACHE_TTL) {
+
+        const cachedItem = this.cache[key] as CachedData<T> | undefined;
+        if (cachedItem && Date.now() - cachedItem.dataFetched < CACHE_TTL) {
             return cachedItem;
         }
         return null;
@@ -86,9 +89,13 @@ export class GitHubStatsService {
 
     private async setCachedData<T>(key: string, data: T): Promise<void> {
         if (Object.keys(this.cache).length === 0) {
-            this.cache = await CacheStore.get('github') as Record<string, CachedData<any>>;
+            const githubCache = await CacheStore.get('github');
+            if (githubCache && typeof githubCache === 'object') {
+                this.cache = githubCache as Record<string, CachedData<unknown>>;
+            }
         }
-        this.cache[key] = { data, dataFetched: (new Date()).getTime() };
+
+        this.cache[key] = { data, dataFetched: Date.now() };
         await CacheStore.set('github', this.cache);
     }
 
@@ -142,7 +149,7 @@ export class GitHubStatsService {
     private async fetchContributorNames(contributors: string[]): Promise<Record<string, string>> {
         const names: Record<string, string> = {};
         await Promise.all(
-            contributors.map(async (contributor) => {
+            contributors.map(async contributor => {
                 const cacheKey = `contributor_name_${contributor}`;
                 const cachedName = await this.getCachedData<string>(cacheKey);
                 let name = `@${contributor}`;