test(MM-59431): file.ts unit test (#8424)
* test(MM-59431): file.ts unit test * get to 100% coverage * add regression proof for some callback methods in uploadFile * add unhappy path
This commit is contained in:
Rahim Rahman
GitHub
parent
e15e7d3a57
commit
8b5c50e6e8
1 changed files with 252 additions and 0 deletions
252
app/actions/remote/file.test.ts
Normal file
252
app/actions/remote/file.test.ts
Normal file
|
|
@ -0,0 +1,252 @@
|
|||
// Copyright (c) 2015-present Mattermost, Inc. All Rights Reserved.
|
||||
// See LICENSE.txt for license information.
|
||||
|
||||
import {DOWNLOAD_TIMEOUT} from '@constants/network';
|
||||
import NetworkManager from '@managers/network_manager';
|
||||
|
||||
import {
|
||||
downloadFile,
|
||||
downloadProfileImage,
|
||||
uploadFile,
|
||||
fetchPublicLink,
|
||||
buildFileUrl,
|
||||
buildAbsoluteUrl,
|
||||
buildFilePreviewUrl,
|
||||
buildFileThumbnailUrl,
|
||||
} from './file';
|
||||
|
||||
jest.mock('@managers/network_manager');
|
||||
jest.mock('@utils/log');
|
||||
|
||||
describe('actions/remote/file', () => {
|
||||
const serverUrl = 'https://server.com';
|
||||
const mockClient = {
|
||||
apiClient: {
|
||||
download: jest.fn(),
|
||||
},
|
||||
getFileRoute: jest.fn(),
|
||||
getProfilePictureUrl: jest.fn(),
|
||||
uploadAttachment: jest.fn(),
|
||||
getFilePublicLink: jest.fn(),
|
||||
getFileUrl: jest.fn(),
|
||||
getAbsoluteUrl: jest.fn(),
|
||||
getFilePreviewUrl: jest.fn(),
|
||||
getFileThumbnailUrl: jest.fn(),
|
||||
};
|
||||
|
||||
beforeEach(() => {
|
||||
(NetworkManager.getClient as jest.Mock).mockReturnValue(mockClient);
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
jest.clearAllMocks();
|
||||
});
|
||||
|
||||
describe('downloadFile', () => {
|
||||
it('should download file successfully', async () => {
|
||||
const fileId = 'file123';
|
||||
const destination = 'file:///path/to/file';
|
||||
mockClient.getFileRoute.mockReturnValue('/files/file123');
|
||||
mockClient.apiClient.download.mockResolvedValue({});
|
||||
|
||||
await downloadFile(serverUrl, fileId, destination);
|
||||
|
||||
expect(mockClient.getFileRoute).toHaveBeenCalledWith(fileId);
|
||||
expect(mockClient.apiClient.download).toHaveBeenCalledWith(
|
||||
'/files/file123',
|
||||
'/path/to/file',
|
||||
{timeoutInterval: DOWNLOAD_TIMEOUT},
|
||||
);
|
||||
});
|
||||
|
||||
/**
|
||||
* Not catching/handling the error thrown by the downloadFile function.
|
||||
* It should be caught and handled by the caller of the function.
|
||||
*/
|
||||
it('does not catch/handle download error', async () => {
|
||||
const error = new Error('Download failed');
|
||||
mockClient.getFileRoute.mockReturnValue('/files/file123');
|
||||
mockClient.apiClient.download.mockRejectedValue(error);
|
||||
|
||||
try {
|
||||
await downloadFile(serverUrl, 'file123', 'file:///path/to/file');
|
||||
} catch (e) {
|
||||
expect(e).toBe(error);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('downloadProfileImage', () => {
|
||||
it('should download profile image successfully', async () => {
|
||||
const userId = 'user123';
|
||||
const lastPictureUpdate = 12345;
|
||||
const destination = 'file:///path/to/image';
|
||||
mockClient.getProfilePictureUrl.mockReturnValue('/users/user123/image');
|
||||
mockClient.apiClient.download.mockResolvedValue({});
|
||||
|
||||
await downloadProfileImage(serverUrl, userId, lastPictureUpdate, destination);
|
||||
|
||||
expect(mockClient.getProfilePictureUrl).toHaveBeenCalledWith(userId, lastPictureUpdate);
|
||||
expect(mockClient.apiClient.download).toHaveBeenCalledWith(
|
||||
'/users/user123/image',
|
||||
'/path/to/image',
|
||||
{timeoutInterval: DOWNLOAD_TIMEOUT},
|
||||
);
|
||||
});
|
||||
|
||||
/**
|
||||
* Not catching/handling the error thrown by the downloadFile function.
|
||||
* It should be caught and handled by the caller of the function.
|
||||
*/
|
||||
it('does not catch/handle download error', async () => {
|
||||
const error = new Error('Download failed');
|
||||
mockClient.getProfilePictureUrl.mockReturnValue('/users/user123/image');
|
||||
mockClient.apiClient.download.mockRejectedValue(error);
|
||||
|
||||
try {
|
||||
await downloadProfileImage(serverUrl, 'user123', 12345, 'file:///path/to/image');
|
||||
} catch (e) {
|
||||
expect(e).toBe(error);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('uploadFile', () => {
|
||||
const file = {
|
||||
id: 'file123',
|
||||
name: 'test.jpg',
|
||||
mime_type: 'image/jpeg',
|
||||
size: 1024,
|
||||
extension: 'jpg',
|
||||
has_preview_image: true,
|
||||
localPath: '/path/to/file',
|
||||
};
|
||||
const channelId = 'channel123';
|
||||
|
||||
it('should upload file successfully', () => {
|
||||
const onProgress = jest.fn();
|
||||
const onComplete = jest.fn();
|
||||
const onError = jest.fn();
|
||||
mockClient.uploadAttachment.mockReturnValue(() => {});
|
||||
|
||||
const result = uploadFile(serverUrl, file, channelId, onProgress, onComplete, onError);
|
||||
|
||||
expect(mockClient.uploadAttachment).toHaveBeenCalledWith(
|
||||
file,
|
||||
channelId,
|
||||
onProgress,
|
||||
onComplete,
|
||||
onError,
|
||||
0,
|
||||
false,
|
||||
);
|
||||
expect(result).toHaveProperty('cancel');
|
||||
});
|
||||
|
||||
it('should use default callbacks when not provided', () => {
|
||||
mockClient.uploadAttachment.mockReturnValue(() => {});
|
||||
|
||||
const result = uploadFile(serverUrl, file, channelId);
|
||||
|
||||
const uploadCall = mockClient.uploadAttachment.mock.calls[0];
|
||||
|
||||
// Verify default callbacks are undefined
|
||||
expect(uploadCall[2]()).toBeUndefined(); // onProgress should return undefined
|
||||
expect(uploadCall[3]()).toBeUndefined(); // onComplete should return undefined
|
||||
expect(uploadCall[4]()).toBeUndefined(); // onError should return undefined
|
||||
|
||||
// Call with actual parameters to ensure they handle inputs correctly
|
||||
expect(uploadCall[2](0.5, 512)).toBeUndefined(); // onProgress
|
||||
expect(uploadCall[3]({data: 'test'})).toBeUndefined(); // onComplete
|
||||
expect(uploadCall[4]({message: 'test error'})).toBeUndefined(); // onError
|
||||
|
||||
expect(result).toHaveProperty('cancel');
|
||||
});
|
||||
|
||||
it('should handle upload error', () => {
|
||||
const error = new Error('Upload failed');
|
||||
(NetworkManager.getClient as jest.Mock).mockImplementation(() => {
|
||||
throw error;
|
||||
});
|
||||
|
||||
const result = uploadFile(serverUrl, {
|
||||
id: 'file123',
|
||||
name: 'test.jpg',
|
||||
mime_type: 'image/jpeg',
|
||||
size: 1024,
|
||||
extension: 'jpg',
|
||||
has_preview_image: true,
|
||||
localPath: '/path/to/file',
|
||||
}, 'channel123');
|
||||
|
||||
expect(result).toEqual({error});
|
||||
});
|
||||
});
|
||||
|
||||
describe('fetchPublicLink', () => {
|
||||
it('should fetch public link successfully', async () => {
|
||||
const fileId = 'file123';
|
||||
const expectedLink = 'https://public-link.com';
|
||||
mockClient.getFilePublicLink.mockResolvedValue(expectedLink);
|
||||
|
||||
const result = await fetchPublicLink(serverUrl, fileId);
|
||||
|
||||
expect(mockClient.getFilePublicLink).toHaveBeenCalledWith(fileId);
|
||||
expect(result).toBe(expectedLink);
|
||||
});
|
||||
|
||||
it('should handle fetch error', async () => {
|
||||
const error = new Error('Fetch failed');
|
||||
mockClient.getFilePublicLink.mockRejectedValue(error);
|
||||
|
||||
const result = await fetchPublicLink(serverUrl, 'file123');
|
||||
|
||||
expect(result).toEqual({error});
|
||||
});
|
||||
});
|
||||
|
||||
describe('URL building functions', () => {
|
||||
const fileId = 'file123';
|
||||
const timestamp = 12345;
|
||||
const relativePath = '/path/to/resource';
|
||||
|
||||
it('should build file URL', () => {
|
||||
mockClient.getFileUrl.mockReturnValue('https://file-url.com');
|
||||
const result = buildFileUrl(serverUrl, fileId, timestamp);
|
||||
expect(mockClient.getFileUrl).toHaveBeenCalledWith(fileId, timestamp);
|
||||
expect(result).toBe('https://file-url.com');
|
||||
});
|
||||
|
||||
it('should build absolute URL', () => {
|
||||
mockClient.getAbsoluteUrl.mockReturnValue('https://absolute-url.com');
|
||||
const result = buildAbsoluteUrl(serverUrl, relativePath);
|
||||
expect(mockClient.getAbsoluteUrl).toHaveBeenCalledWith(relativePath);
|
||||
expect(result).toBe('https://absolute-url.com');
|
||||
});
|
||||
|
||||
it('should build file preview URL', () => {
|
||||
mockClient.getFilePreviewUrl.mockReturnValue('https://preview-url.com');
|
||||
const result = buildFilePreviewUrl(serverUrl, fileId, timestamp);
|
||||
expect(mockClient.getFilePreviewUrl).toHaveBeenCalledWith(fileId, timestamp);
|
||||
expect(result).toBe('https://preview-url.com');
|
||||
});
|
||||
|
||||
it('should build file thumbnail URL', () => {
|
||||
mockClient.getFileThumbnailUrl.mockReturnValue('https://thumbnail-url.com');
|
||||
const result = buildFileThumbnailUrl(serverUrl, fileId, timestamp);
|
||||
expect(mockClient.getFileThumbnailUrl).toHaveBeenCalledWith(fileId, timestamp);
|
||||
expect(result).toBe('https://thumbnail-url.com');
|
||||
});
|
||||
|
||||
it('should handle errors in URL building functions', () => {
|
||||
(NetworkManager.getClient as jest.Mock).mockImplementation(() => {
|
||||
throw new Error('Network error');
|
||||
});
|
||||
|
||||
expect(buildFileUrl(serverUrl, fileId)).toBe('');
|
||||
expect(buildAbsoluteUrl(serverUrl, relativePath)).toBe('');
|
||||
expect(buildFilePreviewUrl(serverUrl, fileId)).toBe('');
|
||||
expect(buildFileThumbnailUrl(serverUrl, fileId)).toBe('');
|
||||
});
|
||||
});
|
||||
});
|
||||
Loading…
Reference in a new issue