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

[react-devtools-shared] Added string type check for object name prop in getDisplayName function #16798

Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
58 changes: 58 additions & 0 deletions packages/react-devtools-shared/src/__tests__/utils-test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
* @flow
*/

import {getDisplayName} from 'react-devtools-shared/src/utils';

describe('utils', () => {
describe('getDisplayName', () => {
const fallbackName = 'TestFallbackName';

it('should return default fallback name for empty object', () => {
const result = getDisplayName({});
expect(result).toEqual('Anonymous');
});

it('should return displayName property from object', () => {
const obj = {
displayName: 'TestDisplayName',
};
const result = getDisplayName(obj);
expect(result).toEqual(obj.displayName);
});

it('should return name property from object', () => {
const obj = {
name: 'TestName',
};
const result = getDisplayName(obj);
expect(result).toEqual(obj.name);
});

it('should return provided fallback name for empty object', () => {
const result = getDisplayName({}, fallbackName);
expect(result).toEqual(fallbackName);
});

it('should provide fallback name when displayName prop is not a string', () => {
const obj = {
displayName: {},
};
const result = getDisplayName(obj, fallbackName);
expect(result).toEqual(fallbackName);
});

it('should provide fallback name when name prop is not a string', () => {
const obj = {
name: {},
};
const result = getDisplayName(obj, fallbackName);
expect(result).toEqual(fallbackName);
});
});
});
8 changes: 3 additions & 5 deletions packages/react-devtools-shared/src/utils.js
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,15 @@ export function getDisplayName(
return nameFromCache;
}

let displayName;
let displayName = fallbackName;

// The displayName property is not guaranteed to be a string.
// It's only safe to use for our purposes if it's a string.
// github.com/facebook/react-devtools/issues/803
if (typeof type.displayName === 'string') {
displayName = type.displayName;
}

if (!displayName) {
displayName = type.name || fallbackName;
} else if (typeof type.name === 'string') {
Copy link
Contributor

Choose a reason for hiding this comment

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

The previous truthy check also prevented returning empty strings (for anonymous functions). This test would fail after this change:

expect(getDisplayName(() => {})).toEqual('Anonymous');

I think the check should be:

typeof type.name === 'string' && type.name !== ''

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes, you right :( It would be enough to add one more test...

Copy link
Contributor

Choose a reason for hiding this comment

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

No worries, I added it~

displayName = type.name;
}

cachedDisplayNames.set(type, displayName);
Expand Down