Improve types of the loadingService

owncloud · Mar 17, 2023 · 65c8e76 · 65c8e76
1 parent 06c8707
commit 65c8e76
Show file tree

Hide file tree

Showing 5 changed files with 19 additions and 17 deletions.
diff --git a/packages/web-app-files/src/helpers/resource/actions/transfer.ts b/packages/web-app-files/src/helpers/resource/actions/transfer.ts
@@ -1,7 +1,7 @@
 import { Resource } from 'web-client'
 import { join } from 'path'
 import { SpaceResource } from 'web-client/src/helpers'
-import { ClientService, LoadingService, LoadingTaskState } from 'web-pkg/src/services'
+import { ClientService, LoadingService, LoadingTaskCallbackArguments } from 'web-pkg/src/services'
 import {
   ConflictDialog,
   ResolveStrategy,
@@ -120,12 +120,9 @@ export class ResourceTransfer extends ConflictDialog {
 
     return this.loadingService.addTask(
       ({ setProgress }) => {
-        return this.moveResources(
-          resolvedConflicts,
-          targetFolderResources,
-          transferType,
+        return this.moveResources(resolvedConflicts, targetFolderResources, transferType, {
           setProgress
-        )
+        })
       },
       { indeterminate: transferType === TransferType.COPY }
     )
@@ -135,7 +132,7 @@ export class ResourceTransfer extends ConflictDialog {
     resolvedConflicts: FileConflict[],
     targetFolderResources: Resource[],
     transferType: TransferType,
-    setProgress: (args: LoadingTaskState) => void
+    { setProgress }: LoadingTaskCallbackArguments
   ) {
     const movedResources: Resource[] = []
     const errors = []

diff --git a/packages/web-app-files/src/store/actions.ts b/packages/web-app-files/src/store/actions.ts
@@ -17,7 +17,7 @@ import {
   SpaceResource
 } from 'web-client/src/helpers'
 import { WebDAV } from 'web-client/src/webdav'
-import { ClientService, LoadingTaskState } from 'web-pkg/src/services'
+import { ClientService, LoadingTaskCallbackArguments } from 'web-pkg/src/services'
 import { Language } from 'vue3-gettext'
 import { DavProperty } from 'web-client/src/webdav/constants'
 import { AncestorMetaData } from 'web-app-files/src/helpers/resource/ancestorMetaData'
@@ -160,7 +160,7 @@ export default {
       space: SpaceResource
       files: Resource[]
       clientService: ClientService
-      setProgress: (args: LoadingTaskState) => void
+      loadingCallbackArgs: LoadingTaskCallbackArguments
       firstRun: boolean
     } & Language
   ) {
@@ -170,9 +170,10 @@ export default {
       space,
       files,
       clientService,
-      setProgress,
+      loadingCallbackArgs,
       firstRun = true
     } = options
+    const { setProgress } = loadingCallbackArgs
     const promises = []
     const removedFiles = []
     for (const file of files) {

diff --git a/packages/web-app-files/tests/unit/helpers/resource/resourcesTransfer.spec.ts b/packages/web-app-files/tests/unit/helpers/resource/resourcesTransfer.spec.ts
@@ -1,4 +1,4 @@
-import { ClientService, LoadingService } from 'web-pkg/src/services'
+import { ClientService, LoadingService, LoadingTaskCallbackArguments } from 'web-pkg/src/services'
 import {
   ResolveConflict,
   ResourceTransfer,
@@ -12,7 +12,7 @@ import { ListFilesResult } from 'web-client/src/webdav/listFiles'
 const clientServiceMock = mockDeep<ClientService>()
 const loadingServiceMock = mock<LoadingService>({
   addTask: (callback) => {
-    return callback({ setProgress: jest.fn() })
+    return callback(mock<LoadingTaskCallbackArguments>())
   }
 })
 let resourcesToMove

diff --git a/packages/web-pkg/src/services/loadingService.ts b/packages/web-pkg/src/services/loadingService.ts
@@ -19,6 +19,10 @@ export interface LoadingTask {
   state?: LoadingTaskState
 }
 
+export interface LoadingTaskCallbackArguments {
+  setProgress: (args: LoadingTaskState) => void
+}
+
 // time until a loading task is being set active
 const DEFAULT_DEBOUNCE_TIME = 200
 
@@ -51,13 +55,13 @@ export class LoadingService {
     return Math.round((progress / tasks.length) * 100)
   }
 
-  public addTask(
-    callback: ({ setProgress }: { setProgress: (args: LoadingTaskState) => void }) => Promise<any>,
+  public addTask<T>(
+    callback: ({ setProgress }: LoadingTaskCallbackArguments) => Promise<T>,
     {
       debounceTime = DEFAULT_DEBOUNCE_TIME,
       indeterminate = true
     }: { debounceTime?: number; indeterminate?: boolean } = {}
-  ): Promise<any> {
+  ): Promise<T> {
     const task = {
       id: uuid.v4(),
       active: false,

diff --git a/packages/web-test-helpers/src/mocks/defaultComponentMocks.ts b/packages/web-test-helpers/src/mocks/defaultComponentMocks.ts
@@ -1,5 +1,5 @@
 import { mock, mockDeep } from 'jest-mock-extended'
-import { ClientService, LoadingService } from 'web-pkg/src/services'
+import { ClientService, LoadingService, LoadingTaskCallbackArguments } from 'web-pkg/src/services'
 import { Router, RouteLocationNormalizedLoaded, RouteLocationRaw, RouteLocation } from 'vue-router'
 import { UppyService } from 'web-runtime/src/services/uppyService'
 import { OwnCloudSdk } from 'web-client/src/types'
@@ -25,7 +25,7 @@ export const defaultComponentMocks = ({ currentRoute = undefined }: ComponentMoc
     $uppyService: mockDeep<UppyService>(),
     $loadingService: mock<LoadingService>({
       addTask: (callback) => {
-        return callback({ setProgress: jest.fn() })
+        return callback(mock<LoadingTaskCallbackArguments>())
       }
     })
   }