fix(metadata): preserve public primary-key request contract

Signed-off-by: Vu Anh Phung <vu.phung@databricks.com>

Author: vuanhphung

lib/contracts/IDBSQLSession.ts

@@ -122,8 +122,8 @@ export type FunctionsRequest = {
 };
 
 export type PrimaryKeysRequest = {
-  catalogName?: string | null;
-  schemaName?: string | null;
+  catalogName?: string;
+  schemaName: string;
   tableName: string;
   /**
    * @deprecated This option is no longer supported and will be removed in future releases

lib/thrift-backend/ThriftSessionBackend.ts

@@ -302,8 +302,8 @@ export default class ThriftSessionBackend implements ISessionBackend {
     const driver = await this.context.getDriver();
     const response = await driver.getPrimaryKeys({
       sessionHandle: this.sessionHandle,
-      catalogName: request.catalogName ?? undefined,
-      schemaName: request.schemaName ?? undefined,
+      catalogName: request.catalogName,
+      schemaName: request.schemaName,
       tableName: request.tableName,
       runAsync: this.getRunAsyncForMetadataOperations(),
       ...getDirectResultsOptions(request.maxRows, this.context.getConfig()),

tests/unit/DBSQLSession.test.ts

@@ -5,6 +5,7 @@ import DBSQLSession, { numberToInt64 } from '../../lib/DBSQLSession';
 import InfoValue from '../../lib/dto/InfoValue';
 import Status from '../../lib/dto/Status';
 import DBSQLOperation from '../../lib/DBSQLOperation';
+import { PrimaryKeysRequest } from '../../lib/contracts/IDBSQLSession';
 import ISessionBackend from '../../lib/contracts/ISessionBackend';
 import ParameterError from '../../lib/errors/ParameterError';
 import { TSessionHandle, TProtocolVersion } from '../../thrift/TCLIService_types';
@@ -514,16 +515,20 @@ describe('DBSQLSession', () => {
   });
 
   describe('getPrimaryKeys', () => {
-    it('should omit null namespace fields and preserve empty strings for Thrift', async () => {
+    it('should forward null, omitted, and empty namespace names unchanged for Thrift', async () => {
       for (const catalogName of [undefined, null, '', 'catalog']) {
         for (const schemaName of [undefined, null, '', 'schema']) {
           const context = new ClientContextStub();
           const session = createSessionForTest({ handle: sessionHandleStub, context });
           // eslint-disable-next-line no-await-in-loop
-          const result = await session.getPrimaryKeys({ catalogName, schemaName, tableName: 't1' });
+          const result = await session.getPrimaryKeys({
+            catalogName,
+            schemaName,
+            tableName: 't1',
+          } as PrimaryKeysRequest);
           expect(result).instanceOf(DBSQLOperation);
-          expect(context.driver.getPrimaryKeysReq?.catalogName).to.equal(catalogName ?? undefined);
-          expect(context.driver.getPrimaryKeysReq?.schemaName).to.equal(schemaName ?? undefined);
+          expect(context.driver.getPrimaryKeysReq?.catalogName).to.equal(catalogName);
+          expect(context.driver.getPrimaryKeysReq?.schemaName).to.equal(schemaName);
           expect(context.driver.getPrimaryKeysReq?.tableName).to.equal('t1');
         }
       }

tests/unit/kernel/execution.test.ts

@@ -21,6 +21,7 @@ import KernelSessionBackend from '../../../lib/kernel/KernelSessionBackend';
 import KernelOperationBackend from '../../../lib/kernel/KernelOperationBackend';
 import { KernelNativeBinding, KernelConnection, KernelStatement } from '../../../lib/kernel/KernelNativeLoader';
 import IClientContext, { ClientConfig } from '../../../lib/contracts/IClientContext';
+import { PrimaryKeysRequest } from '../../../lib/contracts/IDBSQLSession';
 import IDBSQLLogger, { LogLevel } from '../../../lib/contracts/IDBSQLLogger';
 import HiveDriverError from '../../../lib/errors/HiveDriverError';
 import ParameterError from '../../../lib/errors/ParameterError';
@@ -1101,7 +1102,11 @@ describe('KernelSessionBackend', () => {
     for (const catalogName of [undefined, null, '', 'main']) {
       for (const schemaName of [undefined, null, '', 'def']) {
         // eslint-disable-next-line no-await-in-loop
-        const operation = await session.getPrimaryKeys({ catalogName, schemaName, tableName: 't' });
+        const operation = await session.getPrimaryKeys({
+          catalogName,
+          schemaName,
+          tableName: 't',
+        } as PrimaryKeysRequest);
         expect(operation).to.be.instanceOf(KernelOperationBackend);
         expected.push(['getPrimaryKeys', catalogName, schemaName, 't']);
       }