imp(sdk): keep legacy support only in TappdClient.

Author: Leechael

sdk/js/src/__tests__/index.test.ts

@@ -1,14 +1,19 @@
 import { expect, describe, it, vi } from 'vitest'
-import { DstackClient } from '../index'
+import { DstackClient, TappdClient } from '../index'
 
 describe('DstackClient', () => {
-  it('should able to derive key', async () => {
-    const client = new DstackClient()
+  it('should able to derive key in TappdClient', async () => {
+    const client = new TappdClient()
     const result = await client.deriveKey('/', 'test')
     expect(result).toHaveProperty('key')
     expect(result).toHaveProperty('certificate_chain')
   })
 
+  it('should throws error in DstackClient', async () => {
+    const client = new DstackClient()
+    await expect(() => client.deriveKey('/', 'test')).rejects.toThrow('deriveKey is deprecated, please use getKey instead.')
+  })
+
   it('should able to get key', async () => {
     const client = new DstackClient()
     const result = await client.getKey('/', 'test')
@@ -141,9 +146,9 @@ describe('DstackClient', () => {
     expect(typeof isReachable).toBe('boolean')
   })
 
-  describe('deprecated methods', () => {
+  describe('deprecated methods with TappdClient', () => {
     it('should support deprecated deriveKey method with warning', async () => {
-      const client = new DstackClient()
+      const client = new TappdClient()
       const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
 
       const result = await client.deriveKey('/', 'test')
@@ -155,7 +160,7 @@ describe('DstackClient', () => {
     })
 
     it('should support deprecated tdxQuote method with warning', async () => {
-      const client = new DstackClient()
+      const client = new TappdClient()
       const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
 
       const result = await client.tdxQuote('test data')
@@ -167,7 +172,7 @@ describe('DstackClient', () => {
     })
 
     it('should support tdxQuote with hash algorithm parameter', async () => {
-      const client = new DstackClient()
+      const client = new TappdClient()
       const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
 
       const result = await client.tdxQuote('test data', 'sha256')
@@ -178,4 +183,54 @@ describe('DstackClient', () => {
       consoleSpy.mockRestore()
     })
   })
+
+  describe('deprecated methods with DstackClient', () => {
+    it('should throws error in deriveKey method', async () => {
+      const client = new DstackClient()
+      const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+      
+      await expect(() => client.deriveKey('/', 'test')).rejects.toThrow('deriveKey is deprecated, please use getKey instead.')
+      
+      consoleSpy.mockRestore()
+    })
+
+    it('should throws error in tdxQuote method without hash algorithm parameter', async () => {
+      const client = new DstackClient()
+      const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+      
+      await expect(() => client.tdxQuote('test data')).rejects.toThrow('tdxQuote only supports raw hash algorithm.')
+
+      consoleSpy.mockRestore()
+    })
+
+    it("should throws error in tdxQuote method with hash algorithm parameter other than raw", async () => {
+      const client = new DstackClient()
+      const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+      
+      await expect(() => client.tdxQuote('test data', 'sha256')).rejects.toThrow('tdxQuote only supports raw hash algorithm.')
+
+      consoleSpy.mockRestore()
+    })
+
+    it('should able to get quote with plain report_data in tdxQuote method with warning', async () => {
+      const client = new DstackClient()
+      const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+      
+      const result = await client.tdxQuote('test data', "raw")
+      expect(result).toHaveProperty('quote')
+      expect(result).toHaveProperty('event_log')
+      expect(consoleSpy).toHaveBeenCalledWith('tdxQuote is deprecated, please use getQuote instead')
+
+      consoleSpy.mockRestore()
+    })
+
+    it('should throws error in tdxQuote with hash algorithm parameter', async () => {
+      const client = new DstackClient()
+      const consoleSpy = vi.spyOn(console, 'warn').mockImplementation(() => {})
+      
+      await expect(() => client.tdxQuote('test data', 'sha256')).rejects.toThrow('tdxQuote only supports raw hash algorithm.')
+      
+      consoleSpy.mockRestore()
+    })
+  })
 })

sdk/js/src/index.ts

@@ -125,24 +125,21 @@ export interface TlsKeyOptions {
 }
 
 export class DstackClient {
-  private endpoint: string
-  private tappdEndpoint: string
+  protected endpoint: string
 
-  constructor(endpoint: string = '/var/run/dstack.sock') {
-    var tappdEndpoint = '/var/run/tappd.sock'
-    if (process.env.DSTACK_SIMULATOR_ENDPOINT) {
-      console.warn(`Using simulator endpoint: ${process.env.DSTACK_SIMULATOR_ENDPOINT}`)
-      endpoint = process.env.DSTACK_SIMULATOR_ENDPOINT
-    }
-    if (process.env.TAPPD_SIMULATOR_ENDPOINT) {
-      console.warn(`Using tappd endpoint: ${process.env.TAPPD_SIMULATOR_ENDPOINT}`)
-      tappdEndpoint = process.env.TAPPD_SIMULATOR_ENDPOINT
+  constructor(endpoint: string | undefined = undefined) {
+    if (endpoint === undefined) {
+      if (process.env.DSTACK_SIMULATOR_ENDPOINT) {
+        console.warn(`Using simulator endpoint: ${process.env.DSTACK_SIMULATOR_ENDPOINT}`)
+        endpoint = process.env.DSTACK_SIMULATOR_ENDPOINT
+      } else {
+        endpoint = '/var/run/dstack.sock'
+      }
     }
     if (endpoint.startsWith('/') && !fs.existsSync(endpoint)) {
       throw new Error(`Unix socket file ${endpoint} does not exist`);
     }
     this.endpoint = endpoint
-    this.tappdEndpoint = tappdEndpoint
   }
 
   async getKey(path: string, purpose: string = ''): Promise<GetKeyResponse> {
@@ -251,6 +248,46 @@ export class DstackClient {
   // These methods don't mean fully compatible as past, but we keep them here until next major version.
   //
 
+  /**
+   * @deprecated Use getKey instead.
+   * @param path The path to the key.
+   * @param subject The subject of the key.
+   * @param altNames The alternative names of the key.
+   * @returns The key.
+   */
+  async deriveKey(path?: string, subject?: string, altNames?: string[]): Promise<GetTlsKeyResponse> {
+    throw new Error('deriveKey is deprecated, please use getKey instead.')
+  }
+
+  /**
+   * @deprecated Use getQuote instead.
+   * @param report_data The report data.
+   * @param hash_algorithm The hash algorithm.
+   * @returns The quote.
+   */
+  async tdxQuote(report_data: string | Buffer | Uint8Array, hash_algorithm?: TdxQuoteHashAlgorithms): Promise<GetQuoteResponse> {
+    console.warn('tdxQuote is deprecated, please use getQuote instead')
+    if (hash_algorithm !== "raw") {
+      throw new Error('tdxQuote only supports raw hash algorithm.')
+    }
+    return this.getQuote(report_data)
+  }
+}
+
+export class TappdClient extends DstackClient {
+  constructor(endpoint: string | undefined = undefined) {
+    if (endpoint === undefined) {
+      if (process.env.TAPPD_SIMULATOR_ENDPOINT) {
+        console.warn(`Using tappd endpoint: ${process.env.TAPPD_SIMULATOR_ENDPOINT}`)
+        endpoint = process.env.TAPPD_SIMULATOR_ENDPOINT
+      } else {
+        endpoint = '/var/run/tappd.sock'
+      }
+    }
+    console.warn('TappdClient is deprecated, please use DstackClient instead')
+    super(endpoint)
+  }
+
   /**
    * @deprecated Use getKey instead.
    * @param path The path to the key.
@@ -265,7 +302,7 @@ export class DstackClient {
       raw['alt_names'] = alt_names
     }
     const payload = JSON.stringify(raw)
-    const result = await send_rpc_request<GetTlsKeyResponse>(this.tappdEndpoint, '/prpc/Tappd.DeriveKey', payload)
+    const result = await send_rpc_request<GetTlsKeyResponse>(this.endpoint, '/prpc/Tappd.DeriveKey', payload)
     Object.defineProperty(result, 'asUint8Array', {
       get: () => (length?: number) => x509key_to_uint8array(result.key, length),
       enumerable: true,
@@ -292,7 +329,7 @@ export class DstackClient {
       }
     }
     const payload = JSON.stringify({ report_data: hex, hash_algorithm })
-    const result = await send_rpc_request<GetQuoteResponse>(this.tappdEndpoint, '/prpc/Tappd.TdxQuote', payload)
+    const result = await send_rpc_request<GetQuoteResponse>(this.endpoint, '/prpc/Tappd.TdxQuote', payload)
     if ('error' in result) {
       const err = result['error'] as string
       throw new Error(err)
@@ -304,11 +341,4 @@ export class DstackClient {
     })
     return Object.freeze(result)
   }
-}
-
-export class TappdClient extends DstackClient {
-  constructor(endpoint: string = '/var/run/tappd.sock') {
-    console.warn('TappdClient is deprecated, please use DstackClient instead')
-    super(endpoint)
-  }
 }