headers for api witness

XYOracleNetwork · May 7, 2024 · c4975bf · c4975bf
1 parent aa2acc8
commit c4975bf
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 2 deletions.
diff --git a/packages/payloadset/packages/api/src/Config.ts b/packages/payloadset/packages/api/src/Config.ts
@@ -9,6 +9,7 @@ export type ApiCallWitnessConfigSchema = typeof ApiCallWitnessConfigSchema
 
 export type ApiCallWitnessConfigBase = WitnessConfig<{
   accept?: 'application/json'
+  headers?: Record<string, string | undefined>
   queries?: ApiCall['queries']
   schema: ApiCallWitnessConfigSchema
   timeout?: number

diff --git a/packages/payloadset/packages/api/src/Payload.ts b/packages/payloadset/packages/api/src/Payload.ts
@@ -9,6 +9,7 @@ export type Verb = 'get' | 'post'
 export type Queries = Record<string, string>
 
 export interface ApiCallFields {
+  headers?: Record<string, string | undefined>
   queries?: Queries
   verb?: Verb
 }

diff --git a/packages/payloadset/packages/api/src/Witness.ts b/packages/payloadset/packages/api/src/Witness.ts
@@ -78,6 +78,10 @@ export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnes
     throw new Error('Unable to determine uri. No uri/uriTemplate specified in either the call or config.')
   }
 
+  getHeaders(headers?: Record<string, string | undefined>): Record<string, string | undefined> {
+    return { ...this.params.headers, ...this.config.headers, ...headers }
+  }
+
   protected override async observeHandler(inPayloads: ApiCall[] = []): Promise<ApiCallResult[]> {
     await this.started('throw')
     try {
@@ -110,15 +114,15 @@ export class ApiCallWitness<TParams extends ApiCallWitnessParams = ApiCallWitnes
     }
   }
 
-  private async httpGet(url: string, call: Hash): Promise<ApiCallResult> {
+  private async httpGet(url: string, call: Hash, headers?: Record<string, string | undefined>): Promise<ApiCallResult> {
     const result: ApiCallResult = {
       call,
       schema: ApiCallResultSchema,
     }
     try {
       switch (this.accept) {
         case 'application/json': {
-          const axios = new AxiosJson({ headers: { ...this.params.headers, Accept: 'application/json' }, timeout: this.timeout })
+          const axios = new AxiosJson({ headers: { ...this.getHeaders(headers), Accept: 'application/json' }, timeout: this.timeout })
           const response = await axios.get<ApiCallJsonResultType>(url)
           if (response.status >= 200 && response.status < 300) {
             const jsonResult = result as ApiCallJsonResult