Fix fetchRepo test case error (#29)

daeisbae · daeisbae · commit f3f1812fd098 · 2024-12-28T01:53:02.000-08:00
Signed-off-by: Dae❤️ &lt;74119677+daeisbae@users.noreply.github.com&gt;
diff --git a/src/github/fetchrepo.ts b/src/github/fetchrepo.ts
@@ -1,92 +1,104 @@
-import axios from "axios";
-import { GithubAuthConfig } from "@/github/config";
+import axios from 'axios'
+import { GithubAuthConfig } from '@/github/config'
 
 interface RepoResponse {
-  owner: {
-    login: string;
-  };
-  name: string;
-  html_url: string;
-  topics: string[];
-  language: string;
-  description: string;
-  stargazers_count: number;
-  forks_count: number;
-  default_branch: string;
-  pushed_at: Date;
+    owner: {
+        login: string
+    }
+    name: string
+    html_url: string
+    topics: string[]
+    language: string
+    description: string
+    stargazers_count: number
+    forks_count: number
+    default_branch: string
+    pushed_at: Date
 }
 
 interface TreeResponse {
-  sha: string;
-  tree: TreeItem[];
+    sha: string
+    tree: TreeItem[]
 }
 
 interface TreeItem {
-  path: string;
-  type: 'file' | 'dir';
-  sha: string;
-  url: string;
+    path: string
+    type: 'file' | 'dir'
+    sha: string
+    url: string
 }
 
 interface RepoDetails {
-  repoOwner: string;
-  repoName: string;
-  url: string;
-  topics: string[];
-  language: string;
-  description: string;
-  stars: number;
-  forks: number;
-  defaultBranch: string;
-  sha: string;
-  commitAt: Date;
+    repoOwner: string
+    repoName: string
+    url: string
+    topics: string[]
+    language: string
+    description: string
+    stars: number
+    forks: number
+    defaultBranch: string
+    sha: string
+    commitAt: Date
 }
 
 export interface RepoTreeResult {
-  path: string;
-  files: string[];
-  subdirectories: RepoTreeResult[];
+    path: string
+    files: string[]
+    subdirectories: RepoTreeResult[]
 }
 
 /**
  * Fetches details about a GitHub repository
  * @param {string} owner - The repository owner
  * @param {string} repo - The repository name
+ * @param {boolean} [useAuth=false] - Whether to use authentication for the request (for github rate limiting)
  * @returns {Promise<{language: string, description: string, stars: number, forks: number, url: string, topics: string[], repo_owner: string, repo_name: string, default_branch: string, sha: string}>}
  */
 export async function fetchGithubRepoDetails(
-  owner: string, 
-  repo: string
+    owner: string,
+    repo: string,
+    useAuth: boolean = false
 ): Promise<RepoDetails> {
-  const repoUrl = `https://api.github.com/repos/${owner}/${repo}`;
-
-  try {
-    const repoResp = await axios.get<RepoResponse>(repoUrl, GithubAuthConfig);
-    const repoData = repoResp.data;
-
-    const treeUrl = `https://api.github.com/repos/${owner}/${repo}/git/trees/${repoData.default_branch}`;
-    const treeResp = await axios.get<TreeResponse>(treeUrl, GithubAuthConfig);
-    const treeData = treeResp.data;
-
-    return {
-      repoOwner: repoData.owner.login,
-      repoName: repoData.name,
-      url: repoData.html_url,
-      topics: repoData.topics,
-      language: repoData.language,
-      description: repoData.description,
-      stars: repoData.stargazers_count,
-      forks: repoData.forks_count,
-      defaultBranch: repoData.default_branch,
-      sha: treeData.sha,
-      commitAt: repoData.pushed_at
-    };
-  } catch (error) {
-    if (axios.isAxiosError(error)) {
-      throw new Error(`GitHub API Error: ${error.response?.data?.message || error.message}`);
+    const repoUrl = `https://api.github.com/repos/${owner}/${repo}`
+
+    try {
+        const repoResp = await axios.get<RepoResponse>(
+            repoUrl,
+            useAuth ? GithubAuthConfig : undefined
+        )
+        const repoData = repoResp.data
+
+        const treeUrl = `https://api.github.com/repos/${owner}/${repo}/git/trees/${repoData.default_branch}`
+        const treeResp = await axios.get<TreeResponse>(
+            treeUrl,
+            useAuth ? GithubAuthConfig : undefined
+        )
+        const treeData = treeResp.data
+
+        return {
+            repoOwner: repoData.owner.login,
+            repoName: repoData.name,
+            url: repoData.html_url,
+            topics: repoData.topics,
+            language: repoData.language,
+            description: repoData.description,
+            stars: repoData.stargazers_count,
+            forks: repoData.forks_count,
+            defaultBranch: repoData.default_branch,
+            sha: treeData.sha,
+            commitAt: repoData.pushed_at,
+        }
+    } catch (error) {
+        if (axios.isAxiosError(error)) {
+            throw new Error(
+                `GitHub API Error: ${
+                    error.response?.data?.message || error.message
+                }`
+            )
+        }
+        throw error
     }
-    throw error;
-  }
 }
 
 /**
@@ -95,40 +107,54 @@ export async function fetchGithubRepoDetails(
  * @param {string} repo - The repository name
  * @param {string} sha - The commit sha of the repository
  * @param {string} [path=''] - Optional path within repository
+ * @param {boolean} [useAuth=false] - Whether to use authentication for the request (for github rate limiting)
  * @returns {Promise<{path: string, files: Array<string>, subdirectories: Array}>}
  */
 export async function fetchGithubRepoTree(
-  owner: string,
-  repo: string,
-  sha: string,
-  path: string = ''
+    owner: string,
+    repo: string,
+    sha: string,
+    path: string = '',
+    useAuth: boolean = false
 ): Promise<RepoTreeResult> {
-  const contentsUrl = `https://api.github.com/repos/${owner}/${repo}/contents/${path}?ref=${sha}`;
-
-  try {
-    const { data } = await axios.get<TreeItem[]>(contentsUrl, GithubAuthConfig);
-    const result: RepoTreeResult = {
-      path,
-      files: [],
-      subdirectories: []
-    };
-
-    for (const item of data) {
-      if (item.type === 'file') {
-        result.files.push(item.path);
-      } else if (item.type === 'dir') {
-        const subDir = await fetchGithubRepoTree(owner, repo, sha, item.path);
-        result.subdirectories.push(subDir);
-      }
-    }
-
-    return result;
-  } catch (error) {
-    if (axios.isAxiosError(error)) {
-      throw new Error(`Failed to fetch repo contents: ${error.response?.data?.message || error.message}`);
+    const contentsUrl = `https://api.github.com/repos/${owner}/${repo}/contents/${path}?ref=${sha}`
+
+    try {
+        const { data } = await axios.get<TreeItem[]>(
+            contentsUrl,
+            useAuth ? GithubAuthConfig : undefined
+        )
+        const result: RepoTreeResult = {
+            path,
+            files: [],
+            subdirectories: [],
+        }
+
+        for (const item of data) {
+            if (item.type === 'file') {
+                result.files.push(item.path)
+            } else if (item.type === 'dir') {
+                const subDir = await fetchGithubRepoTree(
+                    owner,
+                    repo,
+                    sha,
+                    item.path
+                )
+                result.subdirectories.push(subDir)
+            }
+        }
+
+        return result
+    } catch (error) {
+        if (axios.isAxiosError(error)) {
+            throw new Error(
+                `Failed to fetch repo contents: ${
+                    error.response?.data?.message || error.message
+                }`
+            )
+        }
+        throw error
     }
-    throw error;
-  }
 }
 
 /**
@@ -137,24 +163,32 @@ export async function fetchGithubRepoTree(
  * @param {string} repo - The repository name
  * @param {string} sha - The commit sha of the file to fetch
  * @param {string} path - The path of the file to fetch
+ * @param {boolean} [useAuth=false] - Whether to use authentication for the request (for github rate limiting)
  * @returns {Promise<String>}
  */
 export async function fetchGithubRepoFile(
-  owner: string,
-  repo: string,
-  sha: string,
-  path: string
+    owner: string,
+    repo: string,
+    sha: string,
+    path: string,
+    useAuth: boolean = false
 ): Promise<string> {
-  const codeUrl = `https://raw.githubusercontent.com/${owner}/${repo}/${sha}/${path}`;
-
-  try {
-    const response = await axios.get<string>(codeUrl, GithubAuthConfig);
-    return response.data;
-  } catch (error) {
-    if (axios.isAxiosError(error)) {
-      throw new Error(`Failed to fetch file: ${error.response?.data?.message || error.message}`);
+    const codeUrl = `https://raw.githubusercontent.com/${owner}/${repo}/${sha}/${path}`
+
+    try {
+        const response = await axios.get<string>(
+            codeUrl,
+            useAuth ? GithubAuthConfig : undefined
+        )
+        return response.data
+    } catch (error) {
+        if (axios.isAxiosError(error)) {
+            throw new Error(
+                `Failed to fetch file: ${
+                    error.response?.data?.message || error.message
+                }`
+            )
+        }
+        throw error
     }
-    throw error;
-  }
 }
-
diff --git a/src/service/insert-db.ts b/src/service/insert-db.ts
@@ -22,7 +22,7 @@ export class InsertRepoService {
         owner: string,
         repo: string,
     ): Promise<RepositoryData | null> {
-        const repoDetails = await fetchGithubRepoDetails(owner, repo)
+        const repoDetails = await fetchGithubRepoDetails(owner, repo, true)
         const repositoryData = await this.repository.insert(repoDetails.url, repoDetails.repoOwner, repoDetails.repoName, repoDetails.language, repoDetails.description, repoDetails.defaultBranch, repoDetails.topics, repoDetails.stars, repoDetails.forks)
 
         if(!repositoryData) {
@@ -35,7 +35,7 @@ export class InsertRepoService {
 
         const branchId = branchCommit.branch_id
 
-        const tree = await fetchGithubRepoTree(owner, repo, repoDetails.sha)
+        const tree = await fetchGithubRepoTree(owner, repo, repoDetails.sha, '', true)
         
         await this.recursiveInsertFolder(owner, repo, sha, tree, branchId, null)
 
@@ -61,7 +61,7 @@ export class InsertRepoService {
 
         for(const file of allowedFiles) {
             console.log(`Inserting file ${file}`)
-            await this.insertFile(file, folderData.folder_id, await fetchGithubRepoFile(owner, repo, sha, file))
+            await this.insertFile(file, folderData.folder_id, await fetchGithubRepoFile(owner, repo, sha, file, true))
         }
         for(const subfolder of allowedFolders) {
             console.log(`Traversing and Inserting folder ${subfolder.path}`)
diff --git a/src/test/github/filterfile.test.js b/src/test/github/filterfile.test.js
@@ -1,10 +1,10 @@
 import { whitelistedFile } from '@/github/filterfile'
 
-describe('filterFile', () => {
+describe('whitelistedFile', () => {
     it('should allow files that match a simple pattern', () => {
         const files = ['index.js', 'README.md', 'node_modules/library.js']
         const regexFilter = ['node_modules']
-        const result = filterFile(files, regexFilter)
+        const result = whitelistedFile(files, regexFilter)
         expect(result).toEqual(['node_modules/library.js'])
     })
 
@@ -24,7 +24,10 @@ describe('filterFile', () => {
         ]
         const regexFilter = ['node_modules', '\\.github']
         const result = whitelistedFile(files, regexFilter)
-        expect(result).toEqual(['index.js', 'README.md'])
+        expect(result).toEqual([
+            '.github/config.yml',
+            'node_modules/library.js',
+        ])
     })
 
     it('should remove all files if regex patterns do not match any file', () => {
