Skip to content

feat(content-preview): request waveform representation when v2 is enabled #4829

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 3 commits into from
Sep 10, 2026
Merged

feat(content-preview): request waveform representation when v2 is enabled #4829

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
916ce8d
feat(content-preview): request waveform representation when v2 is ena…
abhishek1128 Sep 9, 2026
fd79415
style(api): restore File.test isDestroyed mock wrapping
abhishek1128 Sep 9, 2026
30db628
chore(deps): bump box-content-preview to 3.90.0
abhishek1128 Sep 10, 2026
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
4 changes: 2 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,7 +202,7 @@
"babel-plugin-react-remove-properties": "^0.3.0",
"babel-plugin-rewire": "^1.0.0",
"babel-plugin-styled-components": "^1.10.7",
"box-content-preview": "3.79.0",
"box-content-preview": "3.90.0",
"chromatic": "^18.0.1",
"circular-dependency-plugin": "^5.2.2",
"classnames": "^2.5.1",
Expand Down Expand Up @@ -334,7 +334,7 @@
"@hapi/address": "^2.1.4",
"@tanstack/react-virtual": "^3.13.12",
"axios": "^0.33.0",
"box-content-preview": "^3.79.0",
"box-content-preview": "^3.90.0",
"classnames": "^2.5.1",
"color": "^3.2.1",
"draft-js": "^0.11.7",
Expand Down
2 changes: 1 addition & 1 deletion src/api/File.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -231,7 +231,7 @@ class File extends Item {
const xhrOptions: Object = {
id: getTypedFileId(id),
url: this.getUrl(id),
headers: { 'X-Rep-Hints': X_REP_HINTS },
headers: { 'X-Rep-Hints': `${X_REP_HINTS}${options.repHints || ''}` },
};
this.errorCode = ERROR_CODE_FETCH_FILE;
this.successCallback = successCallback;
Expand Down
28 changes: 24 additions & 4 deletions src/api/__tests__/File.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -472,10 +472,7 @@ describe('api/File', () => {

test('should make xhr to get file and not call success callback when destroyed', async () => {
fields.findMissingProperties = jest.fn().mockReturnValueOnce([]);
file.isDestroyed = jest
.fn()
.mockReturnValueOnce(false)
.mockReturnValueOnce(true);
file.isDestroyed = jest.fn().mockReturnValueOnce(false).mockReturnValueOnce(true);
file.xhr = {
get: jest.fn().mockReturnValueOnce(Promise.resolve({ data: { file: 'new file' } })),
};
Expand Down Expand Up @@ -581,6 +578,29 @@ describe('api/File', () => {
},
});
});

test('should append extra repHints to X-Rep-Hints when provided', async () => {
file.options = { cache };
file.getCache = jest.fn().mockReturnValueOnce(cache);
file.getCacheKey = jest.fn().mockReturnValueOnce('key');
fields.findMissingProperties = jest.fn().mockReturnValueOnce(['missing']);
fields.fillMissingProperties = jest.fn().mockReturnValueOnce({ id: 'id' });
file.xhr = {
get: jest.fn().mockReturnValueOnce(Promise.resolve({ data: { id: 'id' } })),
};

await file.getFile('id', jest.fn(), jest.fn(), { repHints: '[waveform]' });
expect(file.xhr.get).toHaveBeenCalledWith({
id: 'file_id',
url: 'https://api.box.com/2.0/files/id',
params: {
fields: 'missing',
},
headers: {
'X-Rep-Hints': `${X_REP_HINTS}[waveform]`,
},
});
});
});

describe('getFileExtension()', () => {
Expand Down
2 changes: 2 additions & 0 deletions src/common/types/api.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ type RequestOptions = {
forceFetch?: boolean,
noPagination?: boolean,
refreshCache?: boolean,
// Extra X-Rep-Hints brackets appended to the default header (e.g. '[waveform]')
repHints?: string,
};

type PayloadType = StringAnyMap | Array<StringAnyMap>;
Expand Down
1 change: 1 addition & 0 deletions src/constants.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,7 @@ const X_REP_HINT_IMAGE = '[webp?dimensions=1024x1024][jpg?dimensions=2048x2048,p
const X_REP_HINT_VIDEO_DASH = '[dash,mp4][filmstrip]';
const X_REP_HINT_VIDEO_MP4 = '[mp4]';
const videoHint = Browser.canPlayDash() ? X_REP_HINT_VIDEO_DASH : X_REP_HINT_VIDEO_MP4;
export const X_REP_HINT_WAVEFORM = '[waveform]';
export const X_REP_HINTS = `${X_REP_HINT_BASE}${X_REP_HINT_DOC_THUMBNAIL}${X_REP_HINT_IMAGE}${videoHint}`;

/* ------------------ Uploader ---------------------- */
Expand Down
5 changes: 5 additions & 0 deletions src/elements/content-preview/ContentPreview.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,7 @@ import {
ORIGIN_PREVIEW,
ORIGIN_CONTENT_PREVIEW,
ERROR_CODE_UNKNOWN,
X_REP_HINT_WAVEFORM,
} from '../../constants';
import type { Annotation } from '../../common/types/feed';
import type { Target } from '../../common/types/annotations';
Expand Down Expand Up @@ -1268,6 +1269,9 @@ class ContentPreview extends React.PureComponent<Props, State> {
this.fetchFileStartTime = performance.now();
this.fetchFileEndTime = null;

const { features }: Props = this.props;
const repHints = isFeatureEnabled(features, 'audioPlayerV2.enabled') ? X_REP_HINT_WAVEFORM : '';

this.api
.getFileAPI()
.getFile(
Expand All @@ -1277,6 +1281,7 @@ class ContentPreview extends React.PureComponent<Props, State> {
{
...fetchOptions,
fields: PREVIEW_FIELDS_TO_FETCH,
...(repHints ? { repHints } : {}),
Comment thread
coderabbitai[bot] marked this conversation as resolved.
},
);
}
Expand Down
41 changes: 41 additions & 0 deletions src/elements/content-preview/__tests__/ContentPreview.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -804,6 +804,47 @@ describe('elements/content-preview/ContentPreview', () => {
);
});

test('should append waveform rep hint when audio player v2 is enabled', () => {
const wrapper = getWrapper({
...props,
features: { audioPlayerV2: { enabled: true } },
});
const v2Instance = wrapper.instance();
v2Instance.api = instance.api;
v2Instance.fetchFileSuccessCallback = jest.fn();
v2Instance.fetchFileErrorCallback = jest.fn();
v2Instance.fetchFile(file.id);
expect(getFileStub).toBeCalledWith(
file.id,
v2Instance.fetchFileSuccessCallback,
v2Instance.fetchFileErrorCallback,
{
fields: PREVIEW_FIELDS_TO_FETCH,
repHints: '[waveform]',
},
);
});

test('should not append waveform rep hint when audio player v2 is disabled', () => {
const wrapper = getWrapper({
...props,
features: { audioPlayerV2: { enabled: false } },
});
const v2Instance = wrapper.instance();
v2Instance.api = instance.api;
v2Instance.fetchFileSuccessCallback = jest.fn();
v2Instance.fetchFileErrorCallback = jest.fn();
v2Instance.fetchFile(file.id);
expect(getFileStub).toBeCalledWith(
file.id,
v2Instance.fetchFileSuccessCallback,
v2Instance.fetchFileErrorCallback,
{
fields: PREVIEW_FIELDS_TO_FETCH,
},
);
});

test('should fetch the file without sidebar fields', () => {
instance.fetchFileSuccessCallback = jest.fn();
instance.fetchFileErrorCallback = jest.fn();
Expand Down
14 changes: 10 additions & 4 deletions yarn.lock
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7380,12 +7380,13 @@ bottleneck@^2.15.3:
resolved "https://registry.yarnpkg.com/bottleneck/-/bottleneck-2.19.5.tgz#5df0b90f59fd47656ebe63c78a98419205cadd91"
integrity sha512-VHiNCbI1lKdl44tGrhNfU3lup0Tj/ZBMJB5/2ZbNXRCPuRCO7ed2mgcK4r17y+KB2EfuYuRaVlwNbAeaWGSpbw==

box-content-preview@3.79.0:
version "3.79.0"
resolved "https://registry.yarnpkg.com/box-content-preview/-/box-content-preview-3.79.0.tgz#4888779a5c79bcb40e242544f274b734170f1b24"
integrity sha512-xOuVmxVnCOySzWCE7eTpV5Mud/qdJCy0Q0cPGwdfjU2nY+zd5ZjlmYzjU66mT8usiRgBoANNM4rOgc6LaQWMDw==
box-content-preview@3.90.0:
version "3.90.0"
resolved "https://registry.yarnpkg.com/box-content-preview/-/box-content-preview-3.90.0.tgz#11293ed2e3898b6f884d36bd34287eb78f033f69"
integrity sha512-/TLCDYhelKr7+NLkVPJQQA2MyyxAy+T8OBWXPktl9JtHi6uouBAt2pOfExMRt9jkfTUo/xs0HpsfDiF2kR+XLA==
dependencies:
pdfjs-dist "4.3.136"
wavesurfer.js "7.12.11"

brace-expansion@^1.1.7:
version "1.1.16"
Expand Down Expand Up @@ -19794,6 +19795,11 @@ watchpack@^2.5.1:
glob-to-regexp "^0.4.1"
graceful-fs "^4.1.2"

wavesurfer.js@7.12.11:
version "7.12.11"
resolved "https://registry.yarnpkg.com/wavesurfer.js/-/wavesurfer.js-7.12.11.tgz#e82811da84d3796c3dbe41f440fdc6177304febe"
integrity sha512-Sx0yZIz7jRJ9J9p7UL+pl9y0UQBB6UN/XNo+R7Gy4tCR5xZI9jMyA0dnt1R8TMVSQ4LZ10SeB2HJYQ+dV2dPSA==

wbuf@^1.1.0, wbuf@^1.7.3:
version "1.7.3"
resolved "https://registry.yarnpkg.com/wbuf/-/wbuf-1.7.3.tgz#c1d8d149316d3ea852848895cb6a0bfe887b87df"
Expand Down
Loading