Skip to content

feat(content-sharing): Define sharing service for shared link and access #4340

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mergify merged 5 commits into from
Oct 16, 2025
Merged

feat(content-sharing): Define sharing service for shared link and access #4340

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1bf0665
feat(content-sharing): Define sharing service for shared link and access
reneshen0328 Oct 15, 2025
fd2a1f6
feat(content-sharing): Define sharing service for shared link and access
reneshen0328 Oct 15, 2025
020f1aa
fix: nits
reneshen0328 Oct 15, 2025
2a09934
fix: nits
reneshen0328 Oct 15, 2025
6ef8c05
Merge branch 'master' into create-changeSharedLinkAccess-createShared…
mergify[bot] Oct 16, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
122 changes: 89 additions & 33 deletions src/elements/content-sharing/__tests__/sharingService.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { PERMISSION_CAN_DOWNLOAD, PERMISSION_CAN_PREVIEW } from '../../../constants';
import { ACCESS_NONE, PERMISSION_CAN_DOWNLOAD, PERMISSION_CAN_PREVIEW } from '../../../constants';
import { CONTENT_SHARING_SHARED_LINK_UPDATE_PARAMS } from '../constants';
import { createSharingService } from '../sharingService';
import { convertSharedLinkPermissions, convertSharedLinkSettings } from '../utils';
Expand All @@ -7,9 +7,20 @@ jest.mock('../utils');

const mockItemApiInstance = {
updateSharedLink: jest.fn(),
share: jest.fn(),
};
const options = { id: '123', permissions: { can_set_share_access: true, can_share: true } };
const mockOnSuccess = jest.fn();
const mockOnUpdateSharedLink = jest.fn();
const mockOnRemoveSharedLink = jest.fn();

const createSharingServiceWrapper = () => {
return createSharingService({
itemApiInstance: mockItemApiInstance,
onUpdateSharedLink: mockOnUpdateSharedLink,
onRemoveSharedLink: mockOnRemoveSharedLink,
options,
});
};

describe('elements/content-sharing/sharingService', () => {
beforeEach(() => {
Expand All @@ -29,23 +40,13 @@ describe('elements/content-sharing/sharingService', () => {

describe('changeSharedLinkPermission', () => {
test('should return an object with changeSharedLinkPermission method', () => {
const service = createSharingService({
itemApiInstance: mockItemApiInstance,
onSuccess: mockOnSuccess,
options,
});

const service = createSharingServiceWrapper();
expect(service).toHaveProperty('changeSharedLinkPermission');
expect(typeof service.changeSharedLinkPermission).toBe('function');
});

test('should call updateSharedLink with correct parameters when changeSharedLinkPermission is called', async () => {
const service = createSharingService({
itemApiInstance: mockItemApiInstance,
onSuccess: mockOnSuccess,
options,
});

const service = createSharingServiceWrapper();
const permissionLevel = PERMISSION_CAN_DOWNLOAD;
const expectedPermissions = {
[PERMISSION_CAN_DOWNLOAD]: true,
Expand All @@ -57,7 +58,73 @@ describe('elements/content-sharing/sharingService', () => {
expect(mockItemApiInstance.updateSharedLink).toHaveBeenCalledWith(
options,
{ permissions: expectedPermissions },
mockOnSuccess,
mockOnUpdateSharedLink,
{},
CONTENT_SHARING_SHARED_LINK_UPDATE_PARAMS,
);
});
});

describe('changeSharedLinkAccess', () => {
test('should return an object with changeSharedLinkAccess method', () => {
const service = createSharingServiceWrapper();
expect(service).toHaveProperty('changeSharedLinkAccess');
expect(typeof service.changeSharedLinkAccess).toBe('function');
});

test.each(['open', 'company', 'collaborators'])(
'should call share with correct parameters when changeSharedLinkAccess is called',
async access => {
const service = createSharingServiceWrapper();
await service.changeSharedLinkAccess(access);

expect(mockItemApiInstance.share).toHaveBeenCalledWith(
options,
access,
mockOnUpdateSharedLink,
{},
CONTENT_SHARING_SHARED_LINK_UPDATE_PARAMS,
);
},
);
});

describe('createSharedLink', () => {
test('should return an object with createSharedLink method', () => {
const service = createSharingServiceWrapper();
expect(service).toHaveProperty('createSharedLink');
expect(typeof service.createSharedLink).toBe('function');
});

test('should call share with correct parameters when createSharedLink is called', async () => {
const service = createSharingServiceWrapper();
await service.createSharedLink();

expect(mockItemApiInstance.share).toHaveBeenCalledWith(
options,
undefined,
mockOnUpdateSharedLink,
{},
CONTENT_SHARING_SHARED_LINK_UPDATE_PARAMS,
);
});
});

describe('deleteSharedLink', () => {
test('should return an object with deleteSharedLink method', () => {
const service = createSharingServiceWrapper();
expect(service).toHaveProperty('deleteSharedLink');
expect(typeof service.deleteSharedLink).toBe('function');
});

test('should call share with ACCESS_NONE and onRemoveSharedLink when deleteSharedLink is called', async () => {
const service = createSharingServiceWrapper();
await service.deleteSharedLink();

expect(mockItemApiInstance.share).toHaveBeenCalledWith(
options,
ACCESS_NONE,
mockOnRemoveSharedLink,
{},
CONTENT_SHARING_SHARED_LINK_UPDATE_PARAMS,
);
Expand All @@ -66,22 +133,14 @@ describe('elements/content-sharing/sharingService', () => {

describe('updateSharedLink', () => {
test('should return an object with updateSharedLink method', () => {
const service = createSharingService({
itemApiInstance: mockItemApiInstance,
onSuccess: mockOnSuccess,
options,
});
const service = createSharingServiceWrapper();

expect(service).toHaveProperty('updateSharedLink');
expect(typeof service.updateSharedLink).toBe('function');
});

test('should call updateSharedLink with basic shared link settings', async () => {
const service = createSharingService({
itemApiInstance: mockItemApiInstance,
onSuccess: mockOnSuccess,
options,
});
const service = createSharingServiceWrapper();

const sharedLinkSettings = {
expiration: null,
Expand All @@ -108,7 +167,7 @@ describe('elements/content-sharing/sharingService', () => {
expect(mockItemApiInstance.updateSharedLink).toHaveBeenCalledWith(
options,
expectedConvertedSettings,
mockOnSuccess,
mockOnUpdateSharedLink,
{},
CONTENT_SHARING_SHARED_LINK_UPDATE_PARAMS,
);
Expand All @@ -126,7 +185,8 @@ describe('elements/content-sharing/sharingService', () => {

const service = createSharingService({
itemApiInstance: mockItemApiInstance,
onSuccess: mockOnSuccess,
onUpdateSharedLink: mockOnUpdateSharedLink,
onRemoveSharedLink: mockOnRemoveSharedLink,
options: {
...options,
access: 'open',
Expand Down Expand Up @@ -155,18 +215,14 @@ describe('elements/content-sharing/sharingService', () => {
expect(mockItemApiInstance.updateSharedLink).toHaveBeenCalledWith(
options,
mockConvertedSharedLinkSettings,
mockOnSuccess,
mockOnUpdateSharedLink,
{},
CONTENT_SHARING_SHARED_LINK_UPDATE_PARAMS,
);
});

test('should handle shared link settings correctly', async () => {
const service = createSharingService({
itemApiInstance: mockItemApiInstance,
onSuccess: mockOnSuccess,
options,
});
const service = createSharingServiceWrapper();

const expirationDate = new Date('2024-12-31T23:59:59Z');
const sharedLinkSettings = {
Expand Down
80 changes: 60 additions & 20 deletions src/elements/content-sharing/hooks/__tests__/useSharingService.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,12 @@ const mockApi = {
getFileAPI: jest.fn(),
getFolderAPI: jest.fn(),
};
const mockItemApiInstance = {
updateSharedLink: jest.fn(),
};
const mockSharingService = {
createSharedLink: jest.fn(),
changeSharedLinkAccess: jest.fn(),
changeSharedLinkPermission: jest.fn(),
deleteSharedLink: jest.fn(),
updateSharedLink: jest.fn(),
};

const mockItemId = '123';
Expand All @@ -43,6 +44,11 @@ const mockSharingServiceProps = {
can_share: true,
};

const mockConvertedData = {
item: mockItem,
sharedLink: mockSharedLink,
};

const mockSetItem = jest.fn();
const mockSetSharedLink = jest.fn();

Expand Down Expand Up @@ -104,7 +110,7 @@ describe('elements/content-sharing/hooks/useSharingService', () => {

describe('when itemType is TYPE_FILE', () => {
beforeEach(() => {
mockApi.getFileAPI.mockReturnValue(mockItemApiInstance);
mockApi.getFileAPI.mockReturnValue({});
});

test('should create file API instance and sharing service', () => {
Expand All @@ -114,8 +120,9 @@ describe('elements/content-sharing/hooks/useSharingService', () => {
expect(mockApi.getFolderAPI).not.toHaveBeenCalled();
expect(result.current.sharingService).toBe(mockSharingService);
expect(createSharingService).toHaveBeenCalledWith({
itemApiInstance: mockItemApiInstance,
onSuccess: expect.any(Function),
itemApiInstance: {},
onUpdateSharedLink: expect.any(Function),
onRemoveSharedLink: expect.any(Function),
options: {
access: mockSharedLink.access,
isDownloadAvailable: mockSharedLink.settings.isDownloadAvailable,
Expand All @@ -126,30 +133,36 @@ describe('elements/content-sharing/hooks/useSharingService', () => {
});
});

test('should handle success callback correctly', () => {
const mockConvertedData = {
item: {
id: mockItemId,
permissions: { can_download: false, can_preview: true },
},
sharedLink: {},
};
test('should handle update shared link success callback correctly', () => {
(convertItemResponse as jest.Mock).mockReturnValue(mockConvertedData);
renderHookWithProps();

// Get the callbacks that were passed to mock createSharingService
const createSharingServiceArgs = (createSharingService as jest.Mock).mock.calls[0][0];
createSharingServiceArgs.onUpdateSharedLink(mockConvertedData);

expect(convertItemResponse).toHaveBeenCalledWith(mockConvertedData);
expect(mockSetItem).toHaveBeenCalledTimes(1);
expect(mockSetSharedLink).toHaveBeenCalledTimes(1);
});

test('should handle remove shared link success callback correctly', () => {
(convertItemResponse as jest.Mock).mockReturnValue(mockConvertedData);
renderHookWithProps();

// Get the onSuccess callback that was passed to mock createSharingService
const onSuccessCallback = (createSharingService as jest.Mock).mock.calls[0][0].onSuccess;
onSuccessCallback(mockConvertedData);
// Get the callbacks that were passed to mock createSharingService
const createSharingServiceArgs = (createSharingService as jest.Mock).mock.calls[0][0];
createSharingServiceArgs.onRemoveSharedLink(mockConvertedData);

expect(convertItemResponse).toHaveBeenCalledWith(mockConvertedData);
expect(mockSetItem).toHaveBeenCalledTimes(1);
expect(mockSetSharedLink).toHaveBeenCalledTimes(1);
});
});

describe('when itemType is TYPE_FOLDER', () => {
beforeEach(() => {
mockApi.getFolderAPI.mockReturnValue(mockItemApiInstance);
mockApi.getFolderAPI.mockReturnValue({});
});

test('should create folder API instance and sharing service', () => {
Expand All @@ -159,8 +172,9 @@ describe('elements/content-sharing/hooks/useSharingService', () => {
expect(mockApi.getFileAPI).not.toHaveBeenCalled();
expect(result.current.sharingService).toBe(mockSharingService);
expect(createSharingService).toHaveBeenCalledWith({
itemApiInstance: mockItemApiInstance,
onSuccess: expect.any(Function),
itemApiInstance: {},
onUpdateSharedLink: expect.any(Function),
onRemoveSharedLink: expect.any(Function),
options: {
access: mockSharedLink.access,
isDownloadAvailable: mockSharedLink.settings.isDownloadAvailable,
Expand All @@ -170,5 +184,31 @@ describe('elements/content-sharing/hooks/useSharingService', () => {
},
});
});

test('should handle update shared link success callback correctly for folders', () => {
(convertItemResponse as jest.Mock).mockReturnValue(mockConvertedData);
renderHookWithProps({ itemType: TYPE_FOLDER });

// Get the callbacks that were passed to mock createSharingService
const createSharingServiceArgs = (createSharingService as jest.Mock).mock.calls[0][0];
createSharingServiceArgs.onUpdateSharedLink(mockConvertedData);

expect(convertItemResponse).toHaveBeenCalledWith(mockConvertedData);
expect(mockSetItem).toHaveBeenCalledTimes(1);
expect(mockSetSharedLink).toHaveBeenCalledTimes(1);
});

test('should handle remove shared link success callback correctly for folders', () => {
(convertItemResponse as jest.Mock).mockReturnValue(mockConvertedData);
renderHookWithProps({ itemType: TYPE_FOLDER });

// Get the callbacks that were passed to mock createSharingService
const createSharingServiceArgs = (createSharingService as jest.Mock).mock.calls[0][0];
createSharingServiceArgs.onRemoveSharedLink(mockConvertedData);

expect(convertItemResponse).toHaveBeenCalledWith(mockConvertedData);
expect(mockSetItem).toHaveBeenCalledTimes(1);
expect(mockSetSharedLink).toHaveBeenCalledTimes(1);
});
});
});
15 changes: 13 additions & 2 deletions src/elements/content-sharing/hooks/useSharingService.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,13 +43,24 @@ export const useSharingService = ({
isDownloadAvailable: sharedLink.settings?.isDownloadAvailable ?? false,
};

const handleSuccess = updatedItemData => {
const handleUpdateSharedLink = updatedItemData => {
const { item: updatedItem, sharedLink: updatedSharedLink } = convertItemResponse(updatedItemData);
setItem(prevItem => ({ ...prevItem, ...updatedItem }));
setSharedLink(prevSharedLink => ({ ...prevSharedLink, ...updatedSharedLink }));
};

return createSharingService({ itemApiInstance, onSuccess: handleSuccess, options });
const handleRemoveSharedLink = itemData => {
const { item: updatedItem } = convertItemResponse(itemData);
setItem(prevItem => ({ ...prevItem, ...updatedItem }));
setSharedLink({});
};

return createSharingService({
itemApiInstance,
onUpdateSharedLink: handleUpdateSharedLink,
onRemoveSharedLink: handleRemoveSharedLink,
options,
});
}, [itemApiInstance, itemId, sharedLink, sharingServiceProps, setItem, setSharedLink]);

return { sharingService };
Expand Down
Loading