refactor: update progress callback handling in download and upload services

Author: larryrider

src/services/network/download.service.ts

@@ -1,13 +1,13 @@
 import axios from 'axios';
+import { DownloadProgressCallback } from '../../types/network.types';
 
 export class DownloadService {
   static readonly instance = new DownloadService();
 
   async downloadFile(
     url: string,
-    size: number,
     options: {
-      progressCallback?: (progress: number) => void;
+      progressCallback?: DownloadProgressCallback;
       abortController?: AbortController;
       rangeHeader?: string;
     },
@@ -16,8 +16,7 @@ export class DownloadService {
       responseType: 'stream',
       onDownloadProgress(progressEvent) {
         if (options.progressCallback && progressEvent.loaded) {
-          const reportedProgress = Math.round((progressEvent.loaded / size) * 100);
-          options.progressCallback(reportedProgress);
+          options.progressCallback(progressEvent.loaded);
         }
       },
       headers: {

src/services/network/network-facade.service.ts

@@ -10,7 +10,7 @@ import {
 import { Environment } from '@internxt/inxt-js';
 import { randomBytes } from 'node:crypto';
 import { Readable, Transform } from 'node:stream';
-import { DownloadOptions, UploadOptions, UploadProgressCallback } from '../../types/network.types';
+import { DownloadOptions, UploadOptions, UploadProgressCallback, DownloadProgressCallback } from '../../types/network.types';
 import { CryptoService } from '../crypto.service';
 import { UploadService } from './upload.service';
 import { DownloadService } from './download.service';
@@ -62,9 +62,10 @@ export class NetworkFacade {
     let fileStream: ReadableStream<Uint8Array>;
     const abortable = options?.abortController ?? new AbortController();
 
-    const onProgress: UploadProgressCallback = (progress: number) => {
+    const onProgress: DownloadProgressCallback = (loadedBytes: number) => {
       if (!options?.progressCallback) return;
-      options.progressCallback(progress);
+      const reportedProgress = Math.round((loadedBytes / size) * 100);
+      options.progressCallback(reportedProgress);
     };
 
     const decryptFile: DecryptFileFunction = async (_, key, iv) => {
@@ -92,7 +93,7 @@ export class NetworkFacade {
           throw new Error('Download aborted');
         }
 
-        const encryptedContentStream = await this.downloadService.downloadFile(downloadable.url, size, {
+        const encryptedContentStream = await this.downloadService.downloadFile(downloadable.url, {
           progressCallback: onProgress,
           abortController: options?.abortController,
           rangeHeader: rangeOptions?.range,
@@ -140,9 +141,10 @@ export class NetworkFacade {
     let encryptionTransform: Transform;
     let hash: Buffer;
 
-    const onProgress: UploadProgressCallback = (progress: number) => {
+    const onProgress: UploadProgressCallback = (loadedBytes: number) => {
       if (!options?.progressCallback) return;
-      options.progressCallback(progress);
+      const reportedProgress = Math.round((loadedBytes / size) * 100);
+      options.progressCallback(reportedProgress);
     };
 
     const encryptFile: EncryptFileFunction = async (_, key, iv) => {
@@ -157,7 +159,7 @@ export class NetworkFacade {
     };
 
     const uploadFile: UploadFileFunction = async (url) => {
-      await this.uploadService.uploadFile(url, size, encryptionTransform, {
+      await this.uploadService.uploadFile(url, encryptionTransform, {
         abortController: abortable,
         progressCallback: onProgress,
       });

src/services/network/upload.service.ts

@@ -5,13 +5,12 @@ import { UploadOptions } from '../../types/network.types';
 export class UploadService {
   public static readonly instance: UploadService = new UploadService();
 
-  async uploadFile(url: string, size: number, from: Readable, options: UploadOptions): Promise<{ etag: string }> {
+  async uploadFile(url: string, from: Readable, options: UploadOptions): Promise<{ etag: string }> {
     const response = await axios.put(url, from, {
       signal: options.abortController?.signal,
       onUploadProgress: (progressEvent) => {
         if (options.progressCallback && progressEvent.loaded) {
-          const reportedProgress = Math.round((progressEvent.loaded / size) * 100);
-          options.progressCallback(reportedProgress);
+          options.progressCallback(progressEvent.loaded);
         }
       },
     });

src/types/network.types.ts

@@ -3,7 +3,8 @@ export interface NetworkCredentials {
   pass: string;
 }
 
-export type UploadProgressCallback = (progress: number) => void;
+export type DownloadProgressCallback = (downloadedBytes: number) => void;
+export type UploadProgressCallback = (uploadedBytes: number) => void;
 export interface NetworkOperationBaseOptions {
   progressCallback: UploadProgressCallback;
   abortController?: AbortController;

test/services/network/download.service.test.ts

@@ -48,6 +48,6 @@ describe('Download Service', () => {
 
     await sut.downloadFile('https://example.com/file', options);
 
-    expect(options.progressCallback).toHaveBeenCalledWith(1);
+    expect(options.progressCallback).toHaveBeenCalledWith(100);
   });
 });

test/services/network/network-facade.service.test.ts

@@ -120,6 +120,7 @@ describe('Network Facade Service', () => {
       // eslint-disable-next-line max-len
       'index course habit soon assist dragon tragic helmet salute stuff later twice consider grit pulse cement obvious trick sponsor stereo hello win royal more',
       'f1858bc9675f9e4f7ab29429',
+      encryptedContent.length,
       writable,
     );
 
@@ -166,6 +167,7 @@ describe('Network Facade Service', () => {
       // eslint-disable-next-line max-len
       'index course habit soon assist dragon tragic helmet salute stuff later twice consider grit pulse cement obvious trick sponsor stereo hello win royal more',
       'f1858bc9675f9e4f7ab29429',
+      encryptedContent.length,
       writable,
     );
 
@@ -214,7 +216,12 @@ describe('Network Facade Service', () => {
     const options = { progressCallback: vi.fn() };
 
     vi.spyOn(axios, 'get').mockImplementation((_, config) => {
-      config?.onDownloadProgress?.({ loaded: 100, total: 100, bytes: 100, lengthComputable: true });
+      config?.onDownloadProgress?.({
+        loaded: encryptedContent.length,
+        total: encryptedContent.length,
+        bytes: encryptedContent.length,
+        lengthComputable: true
+      });
       return Promise.resolve({ data: readableContent });
     });
 
@@ -223,13 +230,14 @@ describe('Network Facade Service', () => {
       // eslint-disable-next-line max-len
       'index course habit soon assist dragon tragic helmet salute stuff later twice consider grit pulse cement obvious trick sponsor stereo hello win royal more',
       'f1858bc9675f9e4f7ab29429',
+      encryptedContent.length,
       writable,
       undefined,
       options,
     );
 
     await executeDownload;
 
-    expect(options.progressCallback).toHaveBeenCalledWith(1);
+    expect(options.progressCallback).toHaveBeenCalledWith(100);
   });
 });

test/services/network/upload.service.test.ts

@@ -2,6 +2,7 @@ import { beforeEach, describe, expect, it, vi } from 'vitest';
 import { UploadService } from '../../../src/services/network/upload.service';
 import nock from 'nock';
 import { Readable } from 'node:stream';
+import crypto from 'node:crypto';
 
 describe('Upload Service', () => {
   const sut = UploadService.instance;
@@ -12,9 +13,10 @@ describe('Upload Service', () => {
 
   it('When a file is uploaded and etag is missing, should throw an error', async () => {
     const url = 'https://example.com/upload';
+    const file = crypto.randomBytes(16).toString('hex');
     const data = new Readable({
       read() {
-        this.push('test content');
+        this.push(file);
         this.push(null);
       },
     });
@@ -34,9 +36,10 @@ describe('Upload Service', () => {
 
   it('When a file is uploaded and etag is returned, the etag should be returned', async () => {
     const url = 'https://example.com/upload';
+    const file = crypto.randomBytes(16).toString('hex');
     const data = new Readable({
       read() {
-        this.push('test content');
+        this.push(file);
         this.push(null);
       },
     });
@@ -55,9 +58,10 @@ describe('Upload Service', () => {
 
   it('When a file is uploaded, should update the progress', async () => {
     const url = 'https://example.com/upload';
+    const file = crypto.randomBytes(16).toString('hex');
     const data = new Readable({
       read() {
-        this.push('test content');
+        this.push(file);
         this.push(null);
       },
     });
@@ -71,7 +75,7 @@ describe('Upload Service', () => {
     });
 
     await sut.uploadFile(url, data, options);
-    expect(options.progressCallback).toHaveBeenCalledWith(1);
+    expect(options.progressCallback).toHaveBeenCalledWith(file.length);
   });
 
   it('When a file is uploaded and the upload is aborted, should cancel the request', async () => {

test/webdav/handlers/GET.handler.test.ts

@@ -134,6 +134,7 @@ describe('GET request handler', () => {
       mockFile.bucket,
       mockAuthDetails.user.mnemonic,
       mockFile.fileId,
+      mockFile.size,
       expect.any(Object),
       undefined,
     );
@@ -205,6 +206,7 @@ describe('GET request handler', () => {
       mockFile.bucket,
       mockAuthDetails.user.mnemonic,
       mockFile.fileId,
+      mockSize - rangeStart,
       expect.any(Object),
       expectedRangeOptions,
     );