[Refactor] Rework userFileStore to match existing API on ComfyWorkflow (#1394)

* nit

* Move load

* nit

* nit

* Update store API

* nit

* nit

* Move api

* nit

* Update tests

* Add docs

* Add temp user file

* Implement save as

* Test saveAs

tests-ui/tests/store/userFileStore.test.ts

@@ -1,5 +1,9 @@
 import { setActivePinia, createPinia } from 'pinia'
-import { UserFile, useUserFileStore } from '@/stores/userFileStore'
+import {
+  TempUserFile,
+  UserFile,
+  useUserFileStore
+} from '@/stores/userFileStore'
 import { api } from '@/scripts/api'
 
 // Mock the api
@@ -30,26 +34,26 @@ describe('useUserFileStore', () => {
   describe('syncFiles', () => {
     it('should add new files', async () => {
       const mockFiles = [
-        { path: 'file1.txt', modified: 123, size: 100 },
-        { path: 'file2.txt', modified: 456, size: 200 }
+        { path: 'dir/file1.txt', modified: 123, size: 100 },
+        { path: 'dir/file2.txt', modified: 456, size: 200 }
       ]
       ;(api.listUserDataFullInfo as jest.Mock).mockResolvedValue(mockFiles)
 
-      await store.syncFiles()
+      await store.syncFiles('dir')
 
       expect(store.userFiles).toHaveLength(2)
-      expect(store.userFiles[0].path).toBe('file1.txt')
-      expect(store.userFiles[1].path).toBe('file2.txt')
+      expect(store.userFiles[0].path).toBe('dir/file1.txt')
+      expect(store.userFiles[1].path).toBe('dir/file2.txt')
     })
 
     it('should update existing files', async () => {
-      const initialFile = { path: 'file1.txt', modified: 123, size: 100 }
+      const initialFile = { path: 'dir/file1.txt', modified: 123, size: 100 }
       ;(api.listUserDataFullInfo as jest.Mock).mockResolvedValue([initialFile])
-      await store.syncFiles()
+      await store.syncFiles('dir')
 
-      const updatedFile = { path: 'file1.txt', modified: 456, size: 200 }
+      const updatedFile = { path: 'dir/file1.txt', modified: 456, size: 200 }
       ;(api.listUserDataFullInfo as jest.Mock).mockResolvedValue([updatedFile])
-      await store.syncFiles()
+      await store.syncFiles('dir')
 
       expect(store.userFiles).toHaveLength(1)
       expect(store.userFiles[0].lastModified).toBe(456)
@@ -58,99 +62,146 @@ describe('useUserFileStore', () => {
 
     it('should remove non-existent files', async () => {
       const initialFiles = [
-        { path: 'file1.txt', modified: 123, size: 100 },
-        { path: 'file2.txt', modified: 456, size: 200 }
+        { path: 'dir/file1.txt', modified: 123, size: 100 },
+        { path: 'dir/file2.txt', modified: 456, size: 200 }
       ]
       ;(api.listUserDataFullInfo as jest.Mock).mockResolvedValue(initialFiles)
-      await store.syncFiles()
+      await store.syncFiles('dir')
 
-      const updatedFiles = [{ path: 'file1.txt', modified: 123, size: 100 }]
+      const updatedFiles = [{ path: 'dir/file1.txt', modified: 123, size: 100 }]
       ;(api.listUserDataFullInfo as jest.Mock).mockResolvedValue(updatedFiles)
+      await store.syncFiles('dir')
+
+      expect(store.userFiles).toHaveLength(1)
+      expect(store.userFiles[0].path).toBe('dir/file1.txt')
+    })
+
+    it('should sync root directory when no directory is specified', async () => {
+      const mockFiles = [{ path: 'file1.txt', modified: 123, size: 100 }]
+      ;(api.listUserDataFullInfo as jest.Mock).mockResolvedValue(mockFiles)
+
       await store.syncFiles()
 
+      expect(api.listUserDataFullInfo).toHaveBeenCalledWith('')
       expect(store.userFiles).toHaveLength(1)
       expect(store.userFiles[0].path).toBe('file1.txt')
     })
   })
 
-  describe('loadFile', () => {
-    it('should load file content', async () => {
-      const file = new UserFile('file1.txt', 123, 100)
-      ;(api.getUserData as jest.Mock).mockResolvedValue({
-        status: 200,
-        text: () => Promise.resolve('file content')
+  describe('UserFile', () => {
+    describe('load', () => {
+      it('should load file content', async () => {
+        const file = new UserFile('file1.txt', 123, 100)
+        ;(api.getUserData as jest.Mock).mockResolvedValue({
+          status: 200,
+          text: () => Promise.resolve('file content')
+        })
+
+        await file.load()
+
+        expect(file.content).toBe('file content')
+        expect(file.originalContent).toBe('file content')
+        expect(file.isLoading).toBe(false)
       })
 
-      await store.loadFile(file)
+      it('should throw error on failed load', async () => {
+        const file = new UserFile('file1.txt', 123, 100)
+        ;(api.getUserData as jest.Mock).mockResolvedValue({
+          status: 404,
+          statusText: 'Not Found'
+        })
 
-      expect(file.content).toBe('file content')
-      expect(file.originalContent).toBe('file content')
-      expect(file.isLoading).toBe(false)
+        await expect(file.load()).rejects.toThrow(
+          "Failed to load file 'file1.txt': 404 Not Found"
+        )
+      })
     })
 
-    it('should throw error on failed load', async () => {
-      const file = new UserFile('file1.txt', 123, 100)
-      ;(api.getUserData as jest.Mock).mockResolvedValue({
-        status: 404,
-        statusText: 'Not Found'
+    describe('save', () => {
+      it('should save modified file', async () => {
+        const file = new UserFile('file1.txt', 123, 100)
+        file.content = 'modified content'
+        file.originalContent = 'original content'
+        ;(api.storeUserData as jest.Mock).mockResolvedValue({
+          status: 200,
+          json: () => Promise.resolve({ modified: 456, size: 200 })
+        })
+
+        await file.save()
+
+        expect(api.storeUserData).toHaveBeenCalledWith(
+          'file1.txt',
+          'modified content',
+          { throwOnError: true, full_info: true }
+        )
+        expect(file.lastModified).toBe(456)
+        expect(file.size).toBe(200)
       })
 
-      await expect(store.loadFile(file)).rejects.toThrow(
-        "Failed to load file 'file1.txt': 404 Not Found"
-      )
-    })
-  })
+      it('should not save unmodified file', async () => {
+        const file = new UserFile('file1.txt', 123, 100)
+        file.content = 'content'
+        file.originalContent = 'content'
 
-  describe('saveFile', () => {
-    it('should save modified file', async () => {
-      const file = new UserFile('file1.txt', 123, 100)
-      file.content = 'modified content'
-      file.originalContent = 'original content'
-      ;(api.storeUserData as jest.Mock).mockResolvedValue({ status: 200 })
-      ;(api.listUserDataFullInfo as jest.Mock).mockResolvedValue([])
+        await file.save()
 
-      await store.saveFile(file)
-
-      expect(api.storeUserData).toHaveBeenCalledWith(
-        'file1.txt',
-        'modified content'
-      )
+        expect(api.storeUserData).not.toHaveBeenCalled()
+      })
     })
 
-    it('should not save unmodified file', async () => {
-      const file = new UserFile('file1.txt', 123, 100)
-      file.content = 'content'
-      file.originalContent = 'content'
-      ;(api.listUserDataFullInfo as jest.Mock).mockResolvedValue([])
+    describe('delete', () => {
+      it('should delete file', async () => {
+        const file = new UserFile('file1.txt', 123, 100)
+        ;(api.deleteUserData as jest.Mock).mockResolvedValue({ status: 204 })
 
-      await store.saveFile(file)
+        await file.delete()
 
-      expect(api.storeUserData).not.toHaveBeenCalled()
+        expect(api.deleteUserData).toHaveBeenCalledWith('file1.txt')
+      })
     })
-  })
 
-  describe('deleteFile', () => {
-    it('should delete file', async () => {
-      const file = new UserFile('file1.txt', 123, 100)
-      ;(api.deleteUserData as jest.Mock).mockResolvedValue({ status: 204 })
-      ;(api.listUserDataFullInfo as jest.Mock).mockResolvedValue([])
+    describe('rename', () => {
+      it('should rename file', async () => {
+        const file = new UserFile('file1.txt', 123, 100)
+        ;(api.moveUserData as jest.Mock).mockResolvedValue({
+          status: 200,
+          json: () => Promise.resolve({ modified: 456, size: 200 })
+        })
 
-      await store.deleteFile(file)
+        await file.rename('newfile.txt')
 
-      expect(api.deleteUserData).toHaveBeenCalledWith('file1.txt')
+        expect(api.moveUserData).toHaveBeenCalledWith(
+          'file1.txt',
+          'newfile.txt'
+        )
+        expect(file.path).toBe('newfile.txt')
+        expect(file.lastModified).toBe(456)
+        expect(file.size).toBe(200)
+      })
     })
-  })
 
-  describe('renameFile', () => {
-    it('should rename file', async () => {
-      const file = new UserFile('file1.txt', 123, 100)
-      ;(api.moveUserData as jest.Mock).mockResolvedValue({ status: 200 })
-      ;(api.listUserDataFullInfo as jest.Mock).mockResolvedValue([])
+    describe('saveAs', () => {
+      it('should save file with new path', async () => {
+        const file = new UserFile('file1.txt', 123, 100)
+        file.content = 'file content'
+        ;(api.storeUserData as jest.Mock).mockResolvedValue({
+          status: 200,
+          json: () => Promise.resolve({ modified: 456, size: 200 })
+        })
 
-      await store.renameFile(file, 'newfile.txt')
+        const newFile = await file.saveAs('newfile.txt')
 
-      expect(api.moveUserData).toHaveBeenCalledWith('file1.txt', 'newfile.txt')
-      expect(file.path).toBe('newfile.txt')
+        expect(api.storeUserData).toHaveBeenCalledWith(
+          'newfile.txt',
+          'file content',
+          { throwOnError: true, full_info: true }
+        )
+        expect(newFile).toBeInstanceOf(TempUserFile)
+        expect(newFile.path).toBe('newfile.txt')
+        expect(newFile.lastModified).toBe(456)
+        expect(newFile.size).toBe(200)
+        expect(newFile.content).toBe('file content')
+      })
     })
   })
 })