Traces custom source - Bug Fixes

[TackAdam]

Description

1. Handle a bug that was causing a page crash if the filter was selected twice.
2. Now removes the filter when clicking.
3. Set a default metric when page loading for custom source. (Was defaulting to no selection)
4. Handle detection of start time by distinguishing between mili and nano seconds based on the sort field length.
5. Added toast messages for 503 returns from traces and services request handlers so the UI reflects issues.
6. Added trace-mode to the url so that new tabs and re-directs/favorites will work. (Previously it defaulted to data_prepper causing jaeger and custom_data_prepper links to break as session storage was not available in the new tabs)

Before: (Bug crashing page when a selected filter was clicked again)

Before.mov

After: (No longer crashes, now removes the filter when clicked again)

After.mov

Before: (When the custom traces sources used date for the start time mapping instead of date_nanos the times would all start at 0)

After: (Now the time conversion is determined by the length of the sort metric. This example uses the mapping of start time "date", the indexes themselves have some in mili seconds and some in nanos but because the mapping of "date" is used the nanosecond precision is lost.)

Toast message example (manually setting buckets to 1 to cause failure)

ToastMessage.mov

URL redirection working:

UrlTest.mov

Issues Resolved

Check List

• New functionality includes testing.
  • All tests pass, including unit test, integration test and doctest
• New functionality has been documented.
  • New functionality has javadoc added
  • New functionality has user manual doc added
• Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

[joshuali925]

this will only get the standard search params, but not the search param we use with hash router. for example in playground https://playground.opensearch.org/app/observability-traces#/traces?datasourceId=44cc4c50-6f80-11ed-a8ec-958f39714b93

window.location.search is '', and currentUrl is 'https://playground.opensearch.org/app/observability-traces#/traces'. The dataSourceId information becomes lost?

[TackAdam]

Updated too

  const updateUrlWithMode = (key: TraceAnalyticsMode) => {
    const currentUrl = window.location.href.split('#')[0];
    const hash = window.location.hash;
  
    if (hash) {
      const [hashPath, hashQueryString] = hash.split('?');
      const queryParams = new URLSearchParams(hashQueryString || '');
      queryParams.set('mode', key);

      const newHash = `${hashPath}?${queryParams.toString()}`;
      const newUrl = `${currentUrl}#${newHash}`;
      window.history.replaceState(null, '', newUrl);
    } else {
      //Non-hash-based URL
      const queryParams = new URLSearchParams(window.location.search);
      queryParams.set('mode', key);
  
      const newUrl = `${currentUrl}?${queryParams.toString()}`;
      window.history.replaceState(null, '', newUrl);
    }
  };

[joshuali925]

does this work correctly with hash router?

[TackAdam]

Updated too

const currentUrl = window.location.href;
const traceMode = new URLSearchParams(currentUrl.split('?')[1]).get('mode') || sessionStorage.getItem('TraceAnalyticsMode');

export const appendModeToTraceViewUri = (
  traceId: string,
  getTraceViewUri?: (traceId: string) => string,
  traceMode?: string | null
): string => {
  const baseUri = getTraceViewUri ? getTraceViewUri(traceId) : '';
  const isHashRouter = baseUri.includes('#');
  const separator = isHashRouter ? (baseUri.includes('?') ? '&' : '?') : (baseUri.includes('?') ? '&' : '?');

  if (traceMode) {
    return `${baseUri}${separator}mode=${encodeURIComponent(traceMode)}`;
  }
  return baseUri;
};

[joshuali925]

this logic is being duplicated, can it be extracted? might also need unit tests

[TackAdam]

Moved to public/components/trace_analytics/components/common/helper_functions.tsx

Added unit test

  describe('getTimestampPrecision', () => {
    it('returns "millis" for 13-digit timestamps', () => {
      expect(getTimestampPrecision(1703599200000)).toEqual('millis');
    });
  
    it('returns "micros" for 16-digit timestamps', () => {
      expect(getTimestampPrecision(1703599200000000)).toEqual('micros');
    });
  
    it('returns "nanos" for 19-digit timestamps', () => {
      expect(getTimestampPrecision(1703599200000000000)).toEqual('nanos');
    });
  
    it('returns "millis" for invalid or missing timestamps', () => {
      expect(getTimestampPrecision(undefined as unknown as number)).toEqual('millis');
      expect(getTimestampPrecision(123)).toEqual('millis');
    });
  });
  
  describe('appendModeToTraceViewUri', () => {
    const mockGetTraceViewUri = (traceId: string) => `#/traces/${traceId}`;
  
    it('appends mode to the URI when mode is provided', () => {
      const result = appendModeToTraceViewUri('123', mockGetTraceViewUri, 'data_prepper');
      expect(result).toEqual('#/traces/123?mode=data_prepper');
    });
  
    it('appends mode correctly for hash router URIs with existing query params', () => {
      const result = appendModeToTraceViewUri('123', (id) => `#/traces/${id}?foo=bar`, 'jaeger');
      expect(result).toEqual('#/traces/123?foo=bar&mode=jaeger');
    });
  
    it('does not append mode if not provided', () => {
      const result = appendModeToTraceViewUri('123', mockGetTraceViewUri, null);
      expect(result).toEqual('#/traces/123');
    });
  
    it('handles URIs without a hash router', () => {
      const result = appendModeToTraceViewUri('123', (id) => `/traces/${id}`, 'custom_data_prepper');
      expect(result).toEqual('/traces/123?mode=custom_data_prepper');
    });
  
    it('handles URIs without a hash router and existing query params', () => {
      const result = appendModeToTraceViewUri('123', (id) => `/traces/${id}?foo=bar`, 'jaeger');
      expect(result).toEqual('/traces/123?foo=bar&mode=jaeger');
    });
  }); 

[joshuali925]

is this needed?

[TackAdam]

Removed, became unnecessary after the url mode implementation.

[joshuali925]

"update get trace view uri" is not very clear, maybe

Suggested change

	const updatedGetTraceViewUri = (traceId: string) => {
	const appendModeToTraceViewUri = (traceId: string) => {

[TackAdam]

Updated, thank you.