chore: Update queryTableMetadata type to include undefined (#1939)

pulpdrew · web-flow · commit 609ab14d9e7e · 2026-03-18T19:55:29.000Z
## Summary

This change updates the return type of queryTableMetadata (and therefore `getTableMetadata()` and `useTableMetadata()`) to include `undefined`, since the lookup can return undefined when the provided table does not exist. This required adding undefined checks at a few call sites.

### Screenshots or video

There are no behavior changes expected, other than fewer error logs on a few pages where CTEs are used (eg. K8s dashboard).

### How to test locally or on Vercel

This can be tested in the preview environment.

### References



- Linear Issue: n/a
- Related PRs:
diff --git a/packages/app/src/hooks/useMetadata.tsx b/packages/app/src/hooks/useMetadata.tsx
@@ -190,7 +190,7 @@ export function useTableMetadata(
   options?: Omit<UseQueryOptions<any, Error>, 'queryKey'>,
 ) {
   const metadata = useMetadataWithSettings();
-  return useQuery<TableMetadata>({
+  return useQuery<TableMetadata | undefined>({
     queryKey: ['useMetadata.useTableMetadata', { databaseName, tableName }],
     queryFn: async () => {
       return await metadata.getTableMetadata({
diff --git a/packages/app/src/source.ts b/packages/app/src/source.ts
@@ -208,10 +208,10 @@ export async function inferTableSourceConfig({
       tableName,
       connectionId,
     })
-  ).primary_key;
-  const primaryKeyColumns = new Set(
-    extractColumnReferencesFromKey(primaryKeys),
-  );
+  )?.primary_key;
+  const primaryKeyColumns = primaryKeys
+    ? new Set(extractColumnReferencesFromKey(primaryKeys))
+    : new Set();
 
   const isOtelLogSchema = hasAllColumns(columns, [
     'Timestamp',
diff --git a/packages/app/src/utils/materializedViews.ts b/packages/app/src/utils/materializedViews.ts
@@ -18,8 +18,6 @@ import {
   MaterializedViewConfiguration,
 } from '@hyperdx/common-utils/dist/types';
 
-import { getMetadata } from '@/metadata';
-
 export const MV_AGGREGATE_FUNCTIONS = [
   'avg',
   'count',
@@ -78,16 +76,22 @@ const isAggregateFn = (
   return MV_AGGREGATE_FUNCTIONS.includes(aggFn ?? '');
 };
 
-function isMaterializedView(meta: TableMetadata) {
-  return meta.engine?.startsWith('MaterializedView') ?? false;
+function isMaterializedView(
+  meta: TableMetadata | undefined,
+): meta is TableMetadata {
+  return meta?.engine?.startsWith('MaterializedView') ?? false;
 }
 
-function isAggregatingMergeTree(meta: TableMetadata) {
-  return meta.engine?.includes('AggregatingMergeTree') ?? false;
+function isAggregatingMergeTree(
+  meta: TableMetadata | undefined,
+): meta is TableMetadata {
+  return meta?.engine?.includes('AggregatingMergeTree') ?? false;
 }
 
-function isSummingMergeTree(meta: TableMetadata) {
-  return meta.engine?.includes('SummingMergeTree') ?? false;
+function isSummingMergeTree(
+  meta: TableMetadata | undefined,
+): meta is TableMetadata {
+  return meta?.engine?.includes('SummingMergeTree') ?? false;
 }
 
 /**
diff --git a/packages/common-utils/src/__tests__/metadata.int.test.ts b/packages/common-utils/src/__tests__/metadata.int.test.ts
@@ -574,20 +574,20 @@ describe('Metadata Integration Tests', () => {
       });
 
       // Should have the distributed table's create_table_query
-      expect(result.create_table_query).toContain(distributedTableName);
-      expect(result.create_table_query).toContain('Distributed');
+      expect(result!.create_table_query).toContain(distributedTableName);
+      expect(result!.create_table_query).toContain('Distributed');
 
       // Should have the local table's create_table_query
-      expect(result.create_local_table_query).toContain(localTableName);
-      expect(result.create_local_table_query).toContain('MergeTree');
+      expect(result!.create_local_table_query).toContain(localTableName);
+      expect(result!.create_local_table_query).toContain('MergeTree');
 
       // Keys should come from the local table
-      expect(result.primary_key).toBe('ServiceName, Timestamp');
-      expect(result.sorting_key).toBe('ServiceName, Timestamp');
-      expect(result.partition_key).toBe('toDate(Timestamp)');
+      expect(result!.primary_key).toBe('ServiceName, Timestamp');
+      expect(result!.sorting_key).toBe('ServiceName, Timestamp');
+      expect(result!.partition_key).toBe('toDate(Timestamp)');
 
       // Engine should be overridden with local table's engine
-      expect(result.engine).toBe('MergeTree');
+      expect(result!.engine).toBe('MergeTree');
     });
 
     it('should not set create_local_table_query for non-distributed tables', async () => {
@@ -597,9 +597,9 @@ describe('Metadata Integration Tests', () => {
         connectionId: 'test_connection',
       });
 
-      expect(result.create_local_table_query).toBeUndefined();
-      expect(result.engine).toBe('MergeTree');
-      expect(result.primary_key).toBe('ServiceName, Timestamp');
+      expect(result!.create_local_table_query).toBeUndefined();
+      expect(result!.engine).toBe('MergeTree');
+      expect(result!.primary_key).toBe('ServiceName, Timestamp');
     });
 
     it('should return skip indices from the local table when querying a distributed table', async () => {
diff --git a/packages/common-utils/src/__tests__/metadata.test.ts b/packages/common-utils/src/__tests__/metadata.test.ts
@@ -119,7 +119,7 @@ describe('MetadataCache', () => {
 
       try {
         await metadataCache.getOrFetch(key, queryFn);
-      } catch (e) {
+      } catch {
         // Expected to throw
       }
 
@@ -165,7 +165,7 @@ describe('Metadata', () => {
         connectionId: 'test_connection',
       });
 
-      expect(result.partition_key).toEqual('toYYYYMM(timestamp), user_id');
+      expect(result!.partition_key).toEqual('toYYYYMM(timestamp), user_id');
     });
 
     it('should not modify partition_key if it does not have parentheses', async () => {
@@ -189,7 +189,7 @@ describe('Metadata', () => {
         connectionId: 'test_connection',
       });
 
-      expect(result.partition_key).toEqual('column1');
+      expect(result!.partition_key).toEqual('column1');
     });
 
     it('should use the cache when retrieving table metadata', async () => {
diff --git a/packages/common-utils/src/core/metadata.ts b/packages/common-utils/src/core/metadata.ts
@@ -153,7 +153,7 @@ export class Metadata {
     table: string;
     cache: MetadataCache;
     connectionId: string;
-  }) {
+  }): Promise<TableMetadata | undefined> {
     return cache.getOrFetch(
       `${connectionId}.${database}.${table}.metadata`,
       async () => {
@@ -241,7 +241,7 @@ export class Metadata {
       connectionId,
     });
 
-    // Build up materalized fields lookup table
+    // Build up materialized fields lookup table
     return new Map(
       columns
         .filter(
@@ -617,7 +617,7 @@ export class Metadata {
     });
 
     // For Distributed tables, fetch metadata of the underlying local table to get correct partition key, sorting key, etc.
-    if (tableMetadata.engine === 'Distributed') {
+    if (tableMetadata?.engine === 'Distributed') {
       try {
         const { database, table } =
           getLocalTableFromDistributedTable(tableMetadata) ?? {};
@@ -649,7 +649,7 @@ export class Metadata {
             'primary_key',
             'sampling_key',
           ]),
-          create_local_table_query: localTableMetadata.create_table_query,
+          create_local_table_query: localTableMetadata?.create_table_query,
         };
       } catch (e) {
         console.error(
@@ -661,7 +661,7 @@ export class Metadata {
 
     // partition_key which includes parenthesis, unlike other keys such as 'primary_key' or 'sorting_key'
     if (
-      tableMetadata.partition_key.startsWith('(') &&
+      tableMetadata?.partition_key.startsWith('(') &&
       tableMetadata.partition_key.endsWith(')')
     ) {
       tableMetadata.partition_key = tableMetadata.partition_key.slice(1, -1);
@@ -777,7 +777,7 @@ export class Metadata {
         let localTable = tableName;
 
         // For Distributed tables, fetch skip indices on the underlying local table.
-        if (tableMetadata.engine === 'Distributed') {
+        if (tableMetadata?.engine === 'Distributed') {
           try {
             const { database, table } =
               getLocalTableFromDistributedTable(tableMetadata) ?? {};
diff --git a/packages/common-utils/src/core/renderChartConfig.ts b/packages/common-utils/src/core/renderChartConfig.ts
@@ -31,7 +31,6 @@ import {
   CteChartConfig,
   DateRange,
   DisplayType,
-  Filter,
   MetricsDataType,
   QuerySettings,
   RawSqlChartConfig,
@@ -577,14 +576,14 @@ export async function timeFilterExpr({
   try {
     // Not all of these will be available when selecting from a CTE
     if (databaseName && tableName && connectionId) {
-      const { primary_key } = await metadata.getTableMetadata({
+      const tableMetadata = await metadata.getTableMetadata({
         databaseName,
         tableName,
         connectionId,
       });
       optimizedTimestampValueExpression = optimizeTimestampValueExpression(
         timestampValueExpression,
-        primary_key,
+        tableMetadata?.primary_key,
       );
     }
   } catch (e) {
