Skip to content
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.

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

feat(preview-error): Display file icon based on extension for errors #1536

Merged
merged 2 commits into from
Oct 4, 2024

Conversation

patlm
Copy link
Contributor

@patlm patlm commented Oct 3, 2024

Description
Remove restriction such that preview will fetch the icon based on the extension from box-ui-elements when there is a preview error. Will rely on the logic there to return a default icon when one does not exist for the extension.

See: https://github.com/box/box-ui-elements/blob/1850977829e4888139462a6f65794b1cffc52a08/src/components/preview/previewIcons.ts#L183

Screenshots
image
image-1

@patlm patlm requested a review from a team as a code owner October 3, 2024 21:33
@@ -80,8 +80,7 @@ class PreviewErrorViewer extends BaseViewer {

const { displayMessage, details, message } = error;
const { file } = this.options;
const { extension } = file || {};
const iconExtension = extension === 'flv' || extension === 'tgz' || extension === 'zip' ? extension : undefined;
const { extension: iconExtension } = file || {};

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what happens if iconExtension is undefined?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These scenarios will be handled by getIcon in box-ui-elements. In the case of undefined, it will return the same default item as it returned before when iconExtension was explicitly set to undefined.

@@ -55,7 +55,8 @@ describe('lib/viewers/error/PreviewErrorViewer', () => {
['zip', 'zip'],
['tgz', 'tgz'],
['flv', 'flv'],
['blah', undefined],
['pdf', 'pdf'],
['pptx', 'pptx'],

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is it still possible for [blah, undefined] to happen?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It will no longer be possible. If 'blah' is the extension, it will be passed into box-ui-elements getIcon function which in the case where it can not find it, it will return the default icon that was previous being used when iconExtension was passed in as undefined.

Copy link

@jmcbgaston jmcbgaston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

* Remove restriction such that preview will fetch the icon based on the extension from box-ui-elements when there is a preview error. Will rely on the logic there to return a default icon when one does not exist for the extension.

See: https://github.com/box/box-ui-elements/blob/1850977829e4888139462a6f65794b1cffc52a08/src/components/preview/previewIcons.ts#L183
@patlm patlm force-pushed the always-use-file-icon-for-errors branch from 4380397 to 6076e76 Compare October 4, 2024 22:14
Copy link

@jmcbgaston jmcbgaston left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@mergify mergify bot merged commit d0b10cb into box:master Oct 4, 2024
5 checks passed
@patlm patlm deleted the always-use-file-icon-for-errors branch October 7, 2024 21:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants