feat: Include displayed timestamp in default order by

Author: pulpdrew

.changeset/twelve-beers-buy.md

@@ -0,0 +1,5 @@
+---
+"@hyperdx/app": patch
+---
+
+feat: Include displayed timestamp in default order by

packages/app/src/DBSearchPage.tsx

@@ -532,14 +532,26 @@ function useSearchedConfigToChartConfig({
 
 function optimizeDefaultOrderBy(
   timestampExpr: string,
+  displayedTimestampExpr: string | undefined,
   sortingKey: string | undefined,
 ) {
   const defaultModifier = 'DESC';
-  const fallbackOrderByItems = [
-    getFirstTimestampValueExpression(timestampExpr ?? ''),
-    defaultModifier,
-  ];
-  const fallbackOrderBy = fallbackOrderByItems.join(' ');
+  const firstTimestampValueExpression =
+    getFirstTimestampValueExpression(timestampExpr ?? '') ?? '';
+  const defaultOrderByItems = [firstTimestampValueExpression];
+  const trimmedDisplayedTimestampExpr = displayedTimestampExpr?.trim();
+
+  if (
+    trimmedDisplayedTimestampExpr &&
+    trimmedDisplayedTimestampExpr !== firstTimestampValueExpression
+  ) {
+    defaultOrderByItems.push(trimmedDisplayedTimestampExpr);
+  }
+
+  const fallbackOrderBy =
+    defaultOrderByItems.length > 1
+      ? `(${defaultOrderByItems.join(', ')}) ${defaultModifier}`
+      : `${defaultOrderByItems[0]} ${defaultModifier}`;
 
   if (!sortingKey) return fallbackOrderBy;
 
@@ -562,6 +574,8 @@ function optimizeDefaultOrderBy(
         orderByArr.push(sortKey);
         break;
       }
+    } else if (sortKey === trimmedDisplayedTimestampExpr) {
+      orderByArr.push(sortKey);
     }
   }
 
@@ -570,6 +584,13 @@ function optimizeDefaultOrderBy(
     return fallbackOrderBy;
   }
 
+  if (
+    trimmedDisplayedTimestampExpr &&
+    !orderByArr.includes(trimmedDisplayedTimestampExpr)
+  ) {
+    orderByArr.push(trimmedDisplayedTimestampExpr);
+  }
+
   return `(${orderByArr.join(', ')}) ${defaultModifier}`;
 }
 
@@ -582,6 +603,7 @@ export function useDefaultOrderBy(sourceID: string | undefined | null) {
     () =>
       optimizeDefaultOrderBy(
         source?.timestampValueExpression ?? '',
+        source?.displayedTimestampValueExpression,
         tableMetadata?.sorting_key,
       ),
     [source, tableMetadata],

packages/app/src/__tests__/DBSearchPage.test.tsx

@@ -17,82 +17,133 @@ describe('useDefaultOrderBy', () => {
 
   describe('optimizeOrderBy function', () => {
     describe('should handle', () => {
-      const mockSource = {
-        timestampValueExpression: 'Timestamp',
-      };
-
       const testCases = [
         {
-          input: undefined,
+          sortingKey: undefined,
           expected: 'Timestamp DESC',
         },
         {
-          input: '',
+          sortingKey: '',
           expected: 'Timestamp DESC',
         },
         {
           // Traces Table
-          input: 'ServiceName, SpanName, toDateTime(Timestamp)',
+          sortingKey: 'ServiceName, SpanName, toDateTime(Timestamp)',
           expected: 'Timestamp DESC',
         },
         {
           // Optimized Traces Table
-          input:
+          sortingKey:
             'toStartOfHour(Timestamp), ServiceName, SpanName, toDateTime(Timestamp)',
           expected: '(toStartOfHour(Timestamp), toDateTime(Timestamp)) DESC',
         },
         {
           // Unsupported for now as it's not a great sort key, want to just
           // use default behavior for this
-          input: 'toDateTime(Timestamp), ServiceName, SpanName, Timestamp',
+          sortingKey: 'toDateTime(Timestamp), ServiceName, SpanName, Timestamp',
           expected: 'Timestamp DESC',
         },
         {
           // Unsupported prefix sort key
-          input: 'toDateTime(Timestamp), ServiceName, SpanName',
+          sortingKey: 'toDateTime(Timestamp), ServiceName, SpanName',
           expected: 'Timestamp DESC',
         },
         {
           // Inverted sort key order, we should not try to optimize this
-          input:
+          sortingKey:
             'ServiceName, toDateTime(Timestamp), SeverityText, toStartOfHour(Timestamp)',
           expected: 'Timestamp DESC',
         },
         {
-          input: 'toStartOfHour(Timestamp), other_column, Timestamp',
+          sortingKey: 'toStartOfHour(Timestamp), other_column, Timestamp',
           expected: '(toStartOfHour(Timestamp), Timestamp) DESC',
         },
         {
-          input: 'Timestamp, other_column',
+          sortingKey: 'Timestamp, other_column',
           expected: 'Timestamp DESC',
         },
         {
-          input: 'user_id, toStartOfHour(Timestamp), status, Timestamp',
+          sortingKey: 'user_id, toStartOfHour(Timestamp), status, Timestamp',
           expected: '(toStartOfHour(Timestamp), Timestamp) DESC',
         },
         {
-          input:
+          sortingKey:
             'toStartOfMinute(Timestamp), user_id, status, toUnixTimestamp(Timestamp)',
           expected:
             '(toStartOfMinute(Timestamp), toUnixTimestamp(Timestamp)) DESC',
         },
         {
           // test variation of toUnixTimestamp
-          input:
+          sortingKey:
             'toStartOfMinute(Timestamp), user_id, status, toUnixTimestamp64Nano(Timestamp)',
           expected:
             '(toStartOfMinute(Timestamp), toUnixTimestamp64Nano(Timestamp)) DESC',
         },
         {
-          input:
+          sortingKey:
             'toUnixTimestamp(toStartOfMinute(Timestamp)), user_id, status, Timestamp',
           expected:
             '(toUnixTimestamp(toStartOfMinute(Timestamp)), Timestamp) DESC',
         },
+        {
+          sortingKey: 'Timestamp',
+          displayedTimestampValueExpression: 'Timestamp64',
+          expected: '(Timestamp, Timestamp64) DESC',
+        },
+        {
+          sortingKey: 'Timestamp',
+          displayedTimestampValueExpression: 'Timestamp64 ',
+          expected: '(Timestamp, Timestamp64) DESC',
+        },
+        {
+          sortingKey: 'Timestamp',
+          displayedTimestampValueExpression: 'Timestamp',
+          expected: 'Timestamp DESC',
+        },
+        {
+          sortingKey: 'Timestamp',
+          displayedTimestampValueExpression: '',
+          expected: 'Timestamp DESC',
+        },
+        {
+          sortingKey: 'Timestamp, ServiceName, Timestamp64',
+          displayedTimestampValueExpression: 'Timestamp64',
+          expected: '(Timestamp, Timestamp64) DESC',
+        },
+        {
+          sortingKey:
+            'toStartOfMinute(Timestamp), Timestamp, ServiceName, Timestamp64',
+          displayedTimestampValueExpression: 'Timestamp64',
+          expected: '(toStartOfMinute(Timestamp), Timestamp, Timestamp64) DESC',
+        },
+        {
+          sortingKey:
+            'toStartOfMinute(Timestamp), Timestamp64, ServiceName, Timestamp',
+          displayedTimestampValueExpression: 'Timestamp64',
+          expected: '(toStartOfMinute(Timestamp), Timestamp64, Timestamp) DESC',
+        },
+        {
+          sortingKey: 'SomeOtherTimeColumn',
+          displayedTimestampValueExpression: 'Timestamp64',
+          expected: '(Timestamp, Timestamp64) DESC',
+        },
+        {
+          sortingKey: '',
+          displayedTimestampValueExpression: 'Timestamp64',
+          expected: '(Timestamp, Timestamp64) DESC',
+        },
       ];
       for (const testCase of testCases) {
-        it(`${testCase.input}`, () => {
-          const mockTableMetadata = { sorting_key: testCase.input };
+        it(`${testCase.sortingKey}`, () => {
+          const mockSource = {
+            timestampValueExpression: 'Timestamp',
+            displayedTimestampValueExpression:
+              testCase.displayedTimestampValueExpression,
+          };
+
+          const mockTableMetadata = {
+            sorting_key: testCase.sortingKey,
+          };
 
           jest.spyOn(sourceModule, 'useSource').mockReturnValue({
             data: mockSource,

packages/app/src/components/SourceForm.tsx

@@ -285,7 +285,7 @@ export function LogTableModelForm({ control, watch }: TableModelProps) {
         </FormRow>
         <FormRow
           label={'Displayed Timestamp Column'}
-          helpText="This DateTime column is used to display search results."
+          helpText="This DateTime column is used to display and order search results."
         >
           <SQLInlineEditorControlled
             tableConnection={{
@@ -631,6 +631,21 @@ export function TraceTableModelForm({ control, watch }: TableModelProps) {
           placeholder="SpanName"
         />
       </FormRow>
+      <FormRow
+        label={'Displayed Timestamp Column'}
+        helpText="This DateTime column is used to display and order search results."
+      >
+        <SQLInlineEditorControlled
+          tableConnection={{
+            databaseName,
+            tableName,
+            connectionId,
+          }}
+          control={control}
+          name="displayedTimestampValueExpression"
+          disableKeywordAutocomplete
+        />
+      </FormRow>
     </Stack>
   );
 }