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.

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

Jump to bottom

Don't rely on json-markup for non-json strings #587

Merged
merged 6 commits into from
Jun 2, 2020
Merged

Don't rely on json-markup for non-json strings #587

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
20fb5ec
don't rely on json-markup for non-json strings
smanolloff May 25, 2020
6c76e93
prettier
smanolloff May 26, 2020
de51eb6
fix quotes around non-json strings; test coverage
smanolloff May 27, 2020
70cb812
lint
smanolloff May 27, 2020
b1671da
prettier
smanolloff May 27, 2020
52e64dd
don't use toString in tests
smanolloff May 29, 2020
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
6 changes: 3 additions & 3 deletions .../jaeger-ui/src/components/TracePage/TraceTimelineViewer/SpanDetail/KeyValuesTable.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ describe('<KeyValuesTable>', () => {

const data = [
{ key: 'span.kind', value: 'client' },
{ key: 'omg', value: 'mos-def' },
{ key: 'numericString', value: '12345678901234567890' },
Copy link
Member

Choose a reason for hiding this comment

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

please keep this, it's a real use case that cased problems in the past.

{ key: 'omg', value: '{not-a-json' },
{ key: 'numeric', value: 123456789 },
{ key: 'jsonkey', value: JSON.stringify({ hello: 'world' }) },
Copy link
Member

Choose a reason for hiding this comment

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

sorry, how does this one pass if it doesn't have expected field?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

jaeger-ui/packages/jaeger-ui/src/components/TracePage/TraceTimelineViewer/SpanDetail/KeyValuesTable.test.js

Line 141 in 52e64dd

if (data[i].key !== 'jsonkey') {

];

Expand Down Expand Up @@ -138,7 +138,7 @@ describe('<KeyValuesTable>', () => {
expect(el.length).toBe(data.length);
el.forEach((valueDiv, i) => {
if (data[i].key !== 'jsonkey') {
expect(valueDiv.html()).toMatch(`"${data[i].value}"`);
expect(valueDiv.html()).toMatch(data[i].value.toString());
Copy link
Member

Choose a reason for hiding this comment

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

Could we change the data table to contain the exact expectation instead of relying on toString()?

Copy link
Contributor Author

@smanolloff smanolloff May 28, 2020 •
edited
Loading

Choose a reason for hiding this comment

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

I assume you are well aware that the string interpolation was basically doing the same thing.
I did try to make this test more meaningful by comparing against the actual text instead of matching against part of the DOM, but it did not work:

// ----------- this works
valueDiv.html()
// =>  "<div class="ub-inline-block"><div class="json-markup"><span class="json-markup-string">some text</span></div></div>"

valueDiv.text()
// => "some text"

// ----------- this not
valueDiv.html()
// =>  "<div class="ub-inline-block"><div><div class="json-markup"><span class="json-markup-number">some text</span></div></div></div>"

valueDiv.text()
// => ""

I know it is somehow related to the shallow representation of the DOM inside this test, but I am really not familiar with react and its test frameworks, so I am at a dead end.
If you can help me get "some text" in the second example, I would implement the test change.

Copy link
Member

Choose a reason for hiding this comment

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

sorry, maybe I didn't explain clearly. The test is data driven from the data table. I suggest adding the expected values to that table, e.g. { key: 'numeric', value: 123456789, expected: "123456789" } and comparing with those, instead of value.toString() (which is not as obvious in terms of what it would produce).

}
});
});
Expand Down
48 changes: 35 additions & 13 deletions ...ages/jaeger-ui/src/components/TracePage/TraceTimelineViewer/SpanDetail/KeyValuesTable.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,16 +25,42 @@ import './KeyValuesTable.css';

const jsonObjectOrArrayStartRegex = /^(\[|\{)/;

function parseIfComplexJson(value: any) {
function tryParseJson(value: string) {
// if the value is a string representing actual json object or array, then use json-markup
if (typeof value === 'string' && jsonObjectOrArrayStartRegex.test(value)) {
// otherwise just return as is
try {
return JSON.parse(value);
// eslint-disable-next-line no-empty
} catch (_) {}
// otherwise just return as is
try {
return jsonObjectOrArrayStartRegex.test(value) ? JSON.parse(value) : value;
} catch (_) {
return value;
}
return value;
}

const stringMarkup = (value: string) => (
<div className="json-markup">
<span className="json-markup-string">{value}</span>
</div>
);

function _jsonMarkup(value: any) {
const markup = { __html: jsonMarkup(value) };

return (
// eslint-disable-next-line react/no-danger
<div dangerouslySetInnerHTML={markup} />
);
}

function formatValue(value: any) {
let content;

if (typeof value === 'string') {
Copy link
Member

Choose a reason for hiding this comment

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

Why does this logic need to change if the goal is to only remove the quotes? Attempting to parse any value as JSON led to bugs previously, where, for example, a string that looks like a number would get converted to number and change representation / precision.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

but it has not changed - see a few lines below.
Basically, the boolean && has been split into two separate conditionals, due to the need to explicitly handle non-json strings.

Copy link
Member

Choose a reason for hiding this comment

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

ok, thanks. Could you please add unit tests that cover the new conditions? There are only two lines that are not covered: https://codecov.io/gh/jaegertracing/jaeger-ui/compare/3335512110c60ace5b089e1b61d187a6d6ec4000...6c76e930f59843f41817effbf3d57c3f3a999367/diff

const parsed = tryParseJson(value);
content = typeof parsed === 'string' ? stringMarkup(parsed) : _jsonMarkup(parsed);
} else {
content = _jsonMarkup(value);
}

return <div className="ub-inline-block">{content}</div>;
}

export const LinkValue = (props: { href: string; title?: string; children: React.ReactNode }) => (
Expand Down Expand Up @@ -71,11 +97,7 @@ export default function KeyValuesTable(props: KeyValuesTableProps) {
<table className="u-width-100">
<tbody className="KeyValueTable--body">
{data.map((row, i) => {
const markup = {
__html: jsonMarkup(parseIfComplexJson(row.value)),
};
// eslint-disable-next-line react/no-danger
const jsonTable = <div className="ub-inline-block" dangerouslySetInnerHTML={markup} />;
const jsonTable = formatValue(row.value);
const links = linksGetter ? linksGetter(data, i) : null;
let valueMarkup;
if (links && links.length === 1) {
Expand Down