retoolrpc 0.1.1 → 0.1.2

package/src/rpc.spec.ts

@@ -10,17 +10,6 @@ import { Arguments } from './types'
 import { parseFunctionArguments } from './utils/schema'
 import { RetoolRPCVersion } from './version'
 
-// Expose the protected methods for testing
-class TestRetoolRPC extends RetoolRPC {
-  public testRegisterAgent() {
-    return this.protectedRegisterAgent()
-  }
-
-  public testFetchQueryAndExecute() {
-    return this.protectedFetchQueryAndExecute()
-  }
-}
-
 describe('RetoolRPC', () => {
   const CURRENT_DATE = new Date(2012, 12, 21)
   const resourceId = uuidv4()
@@ -47,13 +36,14 @@ describe('RetoolRPC', () => {
     vi.resetAllMocks()
   })
 
-  const rpcAgent = new TestRetoolRPC({
+  const rpcAgent = new RetoolRPC({
     apiToken: 'secret-api-token',
     host,
     resourceId,
     environmentName,
     agentUuid,
     pollingIntervalMs: 1000,
+    pollingTimeoutMs: 5000,
     version: '0.0.1',
   })
 
@@ -106,7 +96,8 @@ describe('RetoolRPC', () => {
     beforeEach(async () => {
       nock(host).post('/api/v1/retoolrpc/registerAgent').reply(200, { versionHash })
 
-      await rpcAgent.testRegisterAgent()
+      // @ts-expect-error: private method in test
+      await rpcAgent.registerAgent()
     })
 
     test('should "continue" if popQuery has no query', async () => {
@@ -114,7 +105,8 @@ describe('RetoolRPC', () => {
         .post('/api/v1/retoolrpc/popQuery', JSON.stringify(popQueryRequestBody))
         .reply(200, { query: null })
 
-      const result = await rpcAgent.testFetchQueryAndExecute()
+      // @ts-expect-error: private method in test
+      const result = await rpcAgent.fetchQueryAndExecute()
 
       expect(nockScope.isDone()).toBe(true)
       expect(result).toEqual('continue')
@@ -168,7 +160,8 @@ describe('RetoolRPC', () => {
         )
         .reply(200, { success: true })
 
-      const result = await rpcAgent.testFetchQueryAndExecute()
+      // @ts-expect-error: private method in test
+      const result = await rpcAgent.fetchQueryAndExecute()
 
       expect(nockScope1.isDone()).toBe(true)
       expect(nockScope2.isDone()).toBe(true)
@@ -220,7 +213,8 @@ describe('RetoolRPC', () => {
         )
         .reply(200, { success: true })
 
-      const result = await rpcAgent.testFetchQueryAndExecute()
+      // @ts-expect-error: private method in test
+      const result = await rpcAgent.fetchQueryAndExecute()
 
       expect(nockScope1.isDone()).toBe(true)
       expect(nockScope2.isDone()).toBe(true)

package/src/rpc.ts

@@ -13,12 +13,13 @@ import { createAgentServerError, FunctionNotFoundError } from './utils/errors'
 import { parseFunctionArguments } from './utils/schema'
 import { isClientError } from './utils/helpers'
 import { loopWithBackoff } from './utils/polling'
-import { Logger, LoggerService } from './utils/logger';
+import { Logger, LoggerService } from './utils/logger'
 import { RetoolAPI } from './utils/api'
 import { RetoolRPCVersion } from './version'
 
 const MINIMUM_POLLING_INTERVAL_MS = 100
 const DEFAULT_POLLING_INTERVAL_MS = 1000
+const DEFAULT_POLLING_TIMEOUT_MS = 5000
 const DEFAULT_ENVIRONMENT_NAME = 'production'
 const DEFAULT_VERSION = '0.0.1'
 
@@ -31,6 +32,7 @@ export class RetoolRPC {
   private _resourceId: string
   private _environmentName: string
   private _pollingIntervalMs: number
+  private _pollingTimeoutMs: number
   private _version: string
   private _agentUuid: string
   private _versionHash: string | undefined
@@ -49,10 +51,15 @@ export class RetoolRPC {
     this._pollingIntervalMs = config.pollingIntervalMs
       ? Math.max(config.pollingIntervalMs, MINIMUM_POLLING_INTERVAL_MS)
       : DEFAULT_POLLING_INTERVAL_MS
+    this._pollingTimeoutMs = config.pollingTimeoutMs || DEFAULT_POLLING_TIMEOUT_MS
     this._version = config.version || DEFAULT_VERSION
     this._agentUuid = config.agentUuid || uuidv4()
 
-    this._retoolApi = new RetoolAPI({ hostUrl: this._hostUrl, apiKey: this._apiKey })
+    this._retoolApi = new RetoolAPI({
+      hostUrl: this._hostUrl,
+      apiKey: this._apiKey,
+      pollingTimeoutMs: this._pollingTimeoutMs || DEFAULT_POLLING_TIMEOUT_MS,
+    })
     this._logger = config.logger ?? new Logger({ logLevel: config.logLevel })
 
     this._logger.debug('Retool RPC Configuration', {
@@ -245,18 +252,4 @@ export class RetoolRPC {
 
     return 'continue'
   }
-
-  /**
-   * Export registerAgent as a protected method for testing purpose only. Lookup TestRetoolRPC for usage.
-   */
-  protected async protectedRegisterAgent() {
-    return this.registerAgent()
-  }
-
-  /**
-   * Export fetchQueryAndExecute as a protected method for testing purpose only. Lookup TestRetoolRPC for usage.
-   */
-  protected async protectedFetchQueryAndExecute() {
-    return this.fetchQueryAndExecute()
-  }
 }

package/src/types.ts

@@ -1,4 +1,4 @@
-import type { LoggerService } from './utils/logger';
+import type { LoggerService } from './utils/logger'
 
 /**
  * Configuration options for the Retool RPC.
@@ -19,6 +19,8 @@ export type RetoolRPCConfig = {
   version?: string
   /** The optional polling interval in milliseconds. Defaults to 1000. Minimum is 100. */
   pollingIntervalMs?: number
+  /** The optional polling timeout in milliseconds. Defaults to 5000. */
+  pollingTimeoutMs?: number
   /** The optional UUID of the agent. Will be automatically generated by default */
   agentUuid?: string
   /** The optional log level. */

package/src/utils/api.ts

@@ -8,8 +8,6 @@ const AbortController = globalThis.AbortController || AbortControllerFallback
 import { AgentServerError } from '../types'
 import { RetoolRPCVersion } from '../version'
 
-const POLLING_TIMEOUT_MS = 5 * 1000 // 5 seconds
-
 type PopQueryRequest = {
   resourceId: string
   environmentName: string
@@ -46,17 +44,19 @@ type PostQueryResponseRequest = {
 export class RetoolAPI {
   private _hostUrl: string
   private _apiKey: string
+  private _pollingTimeoutMs: number
 
-  constructor({ hostUrl, apiKey }: { hostUrl: string; apiKey: string }) {
+  constructor({ hostUrl, apiKey, pollingTimeoutMs }: { hostUrl: string; apiKey: string; pollingTimeoutMs: number }) {
     this._hostUrl = hostUrl
     this._apiKey = apiKey
+    this._pollingTimeoutMs = pollingTimeoutMs
   }
 
   async popQuery(options: PopQueryRequest) {
     const abortController = new AbortController()
     setTimeout(() => {
       abortController.abort()
-    }, POLLING_TIMEOUT_MS)
+    }, this._pollingTimeoutMs)
 
     try {
       return await fetch(`${this._hostUrl}/api/v1/retoolrpc/popQuery`, {
@@ -73,7 +73,7 @@ export class RetoolAPI {
       })
     } catch (error: any) {
       if (abortController.signal.aborted) {
-        throw new Error(`Polling timeout after ${POLLING_TIMEOUT_MS}ms`)
+        throw new Error(`Polling timeout after ${this._pollingTimeoutMs}ms`)
       }
       throw error
     }

package/src/version.ts

@@ -1 +1 @@
-export const RetoolRPCVersion = '0.1.1'
+export const RetoolRPCVersion = '0.1.2'