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

Clean up getTraceName memoization #573

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ export function TracePageHeaderFn(props: TracePageHeaderEmbedProps & { forwarded

const title = (
<h1 className={`TracePageHeader--title ${canCollapse ? 'is-collapsible' : ''}`}>
<TraceName traceName={getTraceName(trace.spans, trace.traceID)} />{' '}
<TraceName traceName={getTraceName(trace.spans)} />{' '}
<small className="u-tx-muted">{trace.traceID.slice(0, 7)}</small>
</h1>
);
Expand Down
15 changes: 6 additions & 9 deletions packages/jaeger-ui/src/model/find-trace-name.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
// See the License for the specific language governing permissions and
// limitations under the License.

import { getTraceName } from './trace-viewer';
import { _getTraceNameImpl as getTraceName } from './trace-viewer';

describe('getTraceName', () => {
const firstSpanId = 'firstSpanId';
Expand Down Expand Up @@ -219,29 +219,26 @@ describe('getTraceName', () => {
],
},
];
const getTraceNameWrapper = jest.fn(spans =>
getTraceName(spans, `${spans.length}${getTraceNameWrapper.mock.calls.length}`)
);

const fullTraceName = `${serviceName}: ${operationName}`;

it('returns an empty string if given spans with no root among them', () => {
expect(getTraceNameWrapper(spansWithNoRoots)).toEqual('');
expect(getTraceName(spansWithNoRoots)).toEqual('');
});

it('returns an id of root span with the earliest startTime', () => {
expect(getTraceNameWrapper(spansWithMultipleRootsDifferentByStartTime)).toEqual(fullTraceName);
expect(getTraceName(spansWithMultipleRootsDifferentByStartTime)).toEqual(fullTraceName);
});

it('returns an id of root span without any refs', () => {
expect(getTraceNameWrapper(spansWithMultipleRootsWithOneWithoutRefs)).toEqual(fullTraceName);
expect(getTraceName(spansWithMultipleRootsWithOneWithoutRefs)).toEqual(fullTraceName);
});

it('returns an id of root span with remote ref', () => {
expect(getTraceNameWrapper(spansWithOneRootWithRemoteRef)).toEqual(fullTraceName);
expect(getTraceName(spansWithOneRootWithRemoteRef)).toEqual(fullTraceName);
});

it('returns an id of root span with no refs', () => {
expect(getTraceNameWrapper(spansWithOneRootWithNoRefs)).toEqual(fullTraceName);
expect(getTraceName(spansWithOneRootWithNoRefs)).toEqual(fullTraceName);
});
});
8 changes: 5 additions & 3 deletions packages/jaeger-ui/src/model/trace-viewer.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ import { Span } from '../types/trace';

type spansDict = { [index: string]: Span };

function getTraceNameImpl(spans: Span[], traceID: string) {
export function _getTraceNameImpl(spans: Span[]) {
const allTraceSpans: spansDict = spans.reduce((dict, span) => ({ ...dict, [span.spanID]: span }), {});
const rootSpan = spans
.filter(sp => {
Expand All @@ -40,5 +40,7 @@ function getTraceNameImpl(spans: Span[], traceID: string) {
return rootSpan ? `${rootSpan.process.serviceName}: ${rootSpan.operationName}` : '';
}

// eslint-disable-next-line import/prefer-default-export
export const getTraceName = _memoize(getTraceNameImpl, (_spans, traceID) => traceID);
export const getTraceName = _memoize(_getTraceNameImpl, (spans: Span[]) => {
if (!spans.length) return 0;
return spans[0].traceID;
});
2 changes: 1 addition & 1 deletion packages/jaeger-ui/src/model/transform-trace-data.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ export default function transformTraceData(data: TraceData & { spans: SpanData[]
});
spans.push(span);
});
const traceName = getTraceName(spans, traceID);
const traceName = getTraceName(spans);
const services = Object.keys(svcCounts).map(name => ({ name, numberOfSpans: svcCounts[name] }));
return {
services,
Expand Down