refactor(studio): rename githubFile to remoteFile

Author: TotomInc

src/app/src/components/content/ContentCardReview.vue

@@ -90,7 +90,7 @@ async function initializeEditor() {
   isLoadingContent.value = true
 
   const localOriginal = props.draftItem.original ? await generateContentFromDocument(props.draftItem.original as DatabaseItem) : null
-  const gitHubOriginal = props.draftItem.githubFile?.content ? fromBase64ToUTF8(props.draftItem.githubFile.content) : null
+  const gitHubOriginal = props.draftItem.remoteFile?.content ? fromBase64ToUTF8(props.draftItem.remoteFile.content) : null
   const modified = props.draftItem.modified ? await generateContentFromDocument(props.draftItem.modified as DatabasePageItem) : null
 
   isAutomaticFormattingDetected.value = !isEqual(localOriginal, gitHubOriginal)

src/app/src/components/content/ContentEditorCode.vue

@@ -116,11 +116,11 @@ async function setContent(document: DatabasePageItem) {
   currentDocumentId.value = document.id
 
   isAutomaticFormattingDetected.value = false
-  if (props.draftItem.original && props.draftItem.githubFile?.content) {
+  if (props.draftItem.original && props.draftItem.remoteFile?.content) {
     const localOriginal = await generateContentFromDocument(props.draftItem.original as DatabaseItem)
-    const gitHubOriginal = fromBase64ToUTF8(props.draftItem.githubFile.content)
+    const remoteOriginal = props.draftItem.remoteFile.encoding === 'base64' ? fromBase64ToUTF8(props.draftItem.remoteFile.content!) : props.draftItem.remoteFile.content!
 
-    isAutomaticFormattingDetected.value = !isEqual(localOriginal, gitHubOriginal)
+    isAutomaticFormattingDetected.value = !isEqual(localOriginal, remoteOriginal)
   }
 }
 </script>

src/app/src/composables/useDraftBase.ts

@@ -34,12 +34,12 @@ export function useDraftBase<T extends DatabaseItem | MediaItem>(
     }
 
     const fsPath = hostDb.getFileSystemPath(item.id)
-    const githubFile = await git.fetchFile(joinURL(ghPathPrefix, fsPath), { cached: true }) as GithubFile
+    const remoteFile = await git.fetchFile(joinURL(ghPathPrefix, fsPath), { cached: true }) as GithubFile
 
     const draftItem: DraftItem<T> = {
       id: item.id,
       fsPath,
-      githubFile,
+      remoteFile,
       status: getDraftStatus(item, original),
       modified: item,
     }
@@ -86,22 +86,22 @@ export function useDraftBase<T extends DatabaseItem | MediaItem>(
             fsPath: existingDraftItem.fsPath,
             status: DraftStatus.Deleted,
             original: existingDraftItem.original,
-            githubFile: existingDraftItem.githubFile,
+            remoteFile: existingDraftItem.remoteFile,
           }
 
           list.value = list.value.map(item => item.id === id ? deleteDraftItem! : item) as DraftItem<T>[]
         }
       }
       else {
       // TODO: check if gh file has been updated
-        const githubFile = await git.fetchFile(joinURL('content', fsPath), { cached: true }) as GithubFile
+        const remoteFile = await git.fetchFile(joinURL('content', fsPath), { cached: true }) as GithubFile
 
         deleteDraftItem = {
           id,
           fsPath,
           status: DraftStatus.Deleted,
           original: originalDbItem,
-          githubFile,
+          remoteFile,
         }
 
         list.value.push(deleteDraftItem)

src/app/src/composables/useDraftMedias.ts

@@ -41,7 +41,7 @@ export const useDraftMedias = createSharedComposable((host: StudioHost, git: Ret
     return {
       id: joinURL(TreeRootId.Media, fsPath),
       fsPath,
-      githubFile: undefined,
+      remoteFile: undefined,
       status: DraftStatus.Created,
       modified: {
         id: joinURL(TreeRootId.Media, fsPath),

src/app/src/types/draft.ts

@@ -19,7 +19,7 @@ export interface DraftItem<T = DatabaseItem | MediaItem> {
   fsPath: string // file path in content directory
   status: DraftStatus // status
 
-  githubFile?: GithubFile // file fetched on gh
+  remoteFile?: GithubFile
   original?: T
   modified?: T
   /**

src/app/src/utils/draft.ts

@@ -14,20 +14,20 @@ export async function checkConflict(draftItem: DraftItem<DatabaseItem | MediaIte
     return
   }
 
-  if (draftItem.status === DraftStatus.Created && draftItem.githubFile) {
+  if (draftItem.status === DraftStatus.Created && draftItem.remoteFile) {
     return {
-      githubContent: fromBase64ToUTF8(draftItem.githubFile.content!),
+      githubContent: draftItem.remoteFile.encoding === 'base64' ? fromBase64ToUTF8(draftItem.remoteFile.content!) : draftItem.remoteFile.content!,
       localContent: await generateContentFromDocument(draftItem.modified as DatabaseItem) as string,
     }
   }
 
   // TODO: No GitHub file found (might have been deleted remotely)
-  if (!draftItem.githubFile || !draftItem.githubFile.content) {
+  if (!draftItem.remoteFile || !draftItem.remoteFile.content) {
     return
   }
 
   const localContent = await generateContentFromDocument(draftItem.original as DatabaseItem) as string
-  const githubContent = fromBase64ToUTF8(draftItem.githubFile.content)
+  const githubContent = draftItem.remoteFile.encoding === 'base64' ? fromBase64ToUTF8(draftItem.remoteFile.content!) : draftItem.remoteFile.content!
   const githubDocument = await generateDocumentFromContent(draftItem.id, githubContent) as DatabaseItem
 
   if (isEqual(draftItem.original as DatabasePageItem, githubDocument as DatabasePageItem)) {

src/app/test/mocks/git.ts

@@ -2,11 +2,12 @@ import { vi } from 'vitest'
 import type { GithubFile } from '../../src/types/git'
 import type { useGit } from '../../src/composables/useGit'
 
-export const createMockGit = (githubFile?: GithubFile): ReturnType<typeof useGit> => ({
-  fetchFile: vi.fn().mockResolvedValue(githubFile || createMockGithubFile()),
+export const createMockGit = (remoteFile?: GithubFile): ReturnType<typeof useGit> => ({
+  fetchFile: vi.fn().mockResolvedValue(remoteFile || createMockGithubFile()),
 } as never)
 
 export const createMockGithubFile = (overrides?: Partial<GithubFile>): GithubFile => ({
+  provider: 'github',
   path: 'content/document.md',
   name: 'document.md',
   content: 'Test content',