backport: Widen allowed HTTP parameters (#1797)

aquarat · dcroote · dcroote · commit fc70573b205e · 2023-06-08T08:05:12.000-07:00
* Widen parameter type

* Fix validation tests

* Update @api3/ois fixtures

* Bump zod to match zod version in @api3/ois v2.1.0

---------

Co-authored-by: Derek Croote &lt;dcroote@users.noreply.github.com&gt;
diff --git a/.changeset/flat-emus-worry.md b/.changeset/flat-emus-worry.md
@@ -0,0 +1,6 @@
+---
+'@api3/airnode-validator': minor
+'@api3/airnode-node': minor
+---
+
+Widen accepted types for parameters to allow for native types to be sent as JSON
diff --git a/package.json b/package.json
@@ -131,6 +131,6 @@
     "solhint": "^3.4.1",
     "ts-node": "^10.9.1",
     "typescript": "^4.9.5",
-    "yargs": "^17.7.1"
+    "yargs": "^17.7.2"
   }
 }
diff --git a/packages/airnode-adapter/package.json b/packages/airnode-adapter/package.json
@@ -19,7 +19,7 @@
     "test:watch": "yarn test:ts --watch"
   },
   "dependencies": {
-    "@api3/ois": "2.0.0",
+    "@api3/ois": "2.1.0",
     "@api3/promise-utils": "^0.4.0",
     "axios": "^1.3.4",
     "bignumber.js": "^9.1.1",
diff --git a/packages/airnode-adapter/test/fixtures/ois.ts b/packages/airnode-adapter/test/fixtures/ois.ts
@@ -2,7 +2,7 @@ import { OIS } from '@api3/ois';
 
 export function buildOIS(overrides?: Partial<OIS>): OIS {
   return {
-    oisFormat: '2.0.0',
+    oisFormat: '2.1.0',
     version: '1.2.3',
     title: 'Currency Converter API',
     apiSpecifications: {
diff --git a/packages/airnode-admin/package.json b/packages/airnode-admin/package.json
@@ -31,7 +31,7 @@
     "@api3/promise-utils": "^0.4.0",
     "ethers": "^5.7.2",
     "lodash": "^4.17.21",
-    "yargs": "^17.7.1"
+    "yargs": "^17.7.2"
   },
   "devDependencies": {
     "@types/lodash": "^4.14.191",
diff --git a/packages/airnode-deployer/config/config.example.json b/packages/airnode-deployer/config/config.example.json
@@ -94,7 +94,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-deployer/package.json b/packages/airnode-deployer/package.json
@@ -42,8 +42,8 @@
     "ethers": "^5.7.2",
     "lodash": "^4.17.21",
     "ora": "^5.4.1",
-    "yargs": "^17.7.1",
-    "zod": "^3.20.6"
+    "yargs": "^17.7.2",
+    "zod": "^3.21.4"
   },
   "devDependencies": {
     "@aws-sdk/util-stream-node": "^3.295.0",
diff --git a/packages/airnode-deployer/test/fixtures/config.aws.valid.json b/packages/airnode-deployer/test/fixtures/config.aws.valid.json
@@ -95,7 +95,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-deployer/test/fixtures/config.gcp.valid.json b/packages/airnode-deployer/test/fixtures/config.gcp.valid.json
@@ -93,7 +93,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-examples/integrations/authenticated-coinmarketcap/config.example.json b/packages/airnode-examples/integrations/authenticated-coinmarketcap/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "CoinMarketCap Basic Authenticated Request",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-examples/integrations/authenticated-coinmarketcap/create-config.ts b/packages/airnode-examples/integrations/authenticated-coinmarketcap/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.0.0',
+      oisFormat: '2.1.0',
       title: 'CoinMarketCap Basic Authenticated Request',
       version: '1.0.0',
       apiSpecifications: {
diff --git a/packages/airnode-examples/integrations/coingecko-cross-chain-authorizer/config.example.json b/packages/airnode-examples/integrations/coingecko-cross-chain-authorizer/config.example.json
@@ -95,7 +95,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-examples/integrations/coingecko-cross-chain-authorizer/create-config.ts b/packages/airnode-examples/integrations/coingecko-cross-chain-authorizer/create-config.ts
@@ -103,7 +103,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.0.0',
+      oisFormat: '2.1.0',
       title: 'CoinGecko basic request',
       version: '1.0.0',
       apiSpecifications: {
diff --git a/packages/airnode-examples/integrations/coingecko-http-gateways/config.example.json b/packages/airnode-examples/integrations/coingecko-http-gateways/config.example.json
@@ -99,7 +99,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-examples/integrations/coingecko-http-gateways/create-config.ts b/packages/airnode-examples/integrations/coingecko-http-gateways/create-config.ts
@@ -106,7 +106,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.0.0',
+      oisFormat: '2.1.0',
       title: 'CoinGecko basic request',
       version: '1.0.0',
       apiSpecifications: {
diff --git a/packages/airnode-examples/integrations/coingecko-post-processing/config.example.json b/packages/airnode-examples/integrations/coingecko-post-processing/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "CoinGecko coins markets request",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-examples/integrations/coingecko-post-processing/create-config.ts b/packages/airnode-examples/integrations/coingecko-post-processing/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.0.0',
+      oisFormat: '2.1.0',
       title: 'CoinGecko coins markets request',
       version: '1.0.0',
       apiSpecifications: {
diff --git a/packages/airnode-examples/integrations/coingecko-pre-processing/config.example.json b/packages/airnode-examples/integrations/coingecko-pre-processing/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "CoinGecko history data request",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-examples/integrations/coingecko-pre-processing/create-config.ts b/packages/airnode-examples/integrations/coingecko-pre-processing/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.0.0',
+      oisFormat: '2.1.0',
       title: 'CoinGecko history data request',
       version: '1.0.0',
       apiSpecifications: {
diff --git a/packages/airnode-examples/integrations/coingecko-template/config.example.json b/packages/airnode-examples/integrations/coingecko-template/config.example.json
@@ -89,7 +89,7 @@
   ],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-examples/integrations/coingecko-template/create-config.ts b/packages/airnode-examples/integrations/coingecko-template/create-config.ts
@@ -98,7 +98,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   ],
   ois: [
     {
-      oisFormat: '2.0.0',
+      oisFormat: '2.1.0',
       title: 'CoinGecko basic request',
       version: '1.0.0',
       apiSpecifications: {
diff --git a/packages/airnode-examples/integrations/coingecko/config.example.json b/packages/airnode-examples/integrations/coingecko/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-examples/integrations/coingecko/create-config.ts b/packages/airnode-examples/integrations/coingecko/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.0.0',
+      oisFormat: '2.1.0',
       title: 'CoinGecko basic request',
       version: '1.0.0',
       apiSpecifications: {
diff --git a/packages/airnode-examples/integrations/failing-example/config.example.json b/packages/airnode-examples/integrations/failing-example/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "Failure Example",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-examples/integrations/failing-example/create-config.ts b/packages/airnode-examples/integrations/failing-example/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.0.0',
+      oisFormat: '2.1.0',
       title: 'Failure Example',
       version: '1.0.0',
       apiSpecifications: {
diff --git a/packages/airnode-examples/integrations/relay-security-schemes/config.example.json b/packages/airnode-examples/integrations/relay-security-schemes/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "Relay Security Schemes via httpbin",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-examples/integrations/relay-security-schemes/create-config.ts b/packages/airnode-examples/integrations/relay-security-schemes/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.0.0',
+      oisFormat: '2.1.0',
       title: 'Relay Security Schemes via httpbin',
       version: '1.0.0',
       apiSpecifications: {
diff --git a/packages/airnode-examples/integrations/weather-multi-value/config.example.json b/packages/airnode-examples/integrations/weather-multi-value/config.example.json
@@ -83,7 +83,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "OpenWeather Multiple Encoded Values",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-examples/integrations/weather-multi-value/create-config.ts b/packages/airnode-examples/integrations/weather-multi-value/create-config.ts
@@ -90,7 +90,7 @@ const createConfig = async (generateExampleFile: boolean): Promise<Config> => ({
   templates: [],
   ois: [
     {
-      oisFormat: '2.0.0',
+      oisFormat: '2.1.0',
       title: 'OpenWeather Multiple Encoded Values',
       version: '1.0.0',
       apiSpecifications: {
diff --git a/packages/airnode-node/config/config.example.json b/packages/airnode-node/config/config.example.json
@@ -84,7 +84,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "version": "1.2.3",
       "title": "Currency Converter API",
       "apiSpecifications": {
diff --git a/packages/airnode-node/package.json b/packages/airnode-node/package.json
@@ -29,7 +29,7 @@
     "@api3/airnode-protocol": "^0.11.1",
     "@api3/airnode-utilities": "^0.11.1",
     "@api3/airnode-validator": "^0.11.1",
-    "@api3/ois": "2.0.0",
+    "@api3/ois": "2.1.0",
     "@api3/promise-utils": "^0.4.0",
     "@aws-sdk/client-lambda": "^3.295.0",
     "date-fns": "^2.29.3",
@@ -38,8 +38,8 @@
     "express": "^4.18.2",
     "google-auth-library": "^8.7.0",
     "lodash": "^4.17.21",
-    "yargs": "^17.7.1",
-    "zod": "^3.20.6"
+    "yargs": "^17.7.2",
+    "zod": "^3.21.4"
   },
   "devDependencies": {
     "@api3/airnode-operation": "^0.11.1",
diff --git a/packages/airnode-node/src/adapters/http/parameters.ts b/packages/airnode-node/src/adapters/http/parameters.ts
@@ -5,7 +5,7 @@ export function getReservedParameterValue(
   name: ReservedParameterName,
   endpoint: Endpoint,
   requestParameters: ApiCallParameters
-): string | undefined {
+): any {
   const reservedParameter = endpoint.reservedParameters.find((rp) => rp.name === name);
   // Reserved parameters must be whitelisted in order to be used, even if they have no fixed or default value
   if (!reservedParameter) {
diff --git a/packages/airnode-node/src/api/processing.test.ts b/packages/airnode-node/src/api/processing.test.ts
@@ -1,4 +1,3 @@
-import { ZodError } from 'zod';
 import { postProcessApiSpecifications, preProcessApiSpecifications } from './processing';
 import * as fixtures from '../../test/fixtures';
 
@@ -56,35 +55,6 @@ describe('processing', () => {
 
       await expect(throwingFunc).rejects.toEqual(new Error('SyntaxError: Unexpected identifier'));
     });
-
-    it('throws validation error if result does not have parameters shape', async () => {
-      const config = fixtures.buildConfig();
-      const preProcessingSpecifications = [
-        {
-          environment: 'Node' as const,
-          value: 'const output = {...input, object: {a: 123, b: false}};',
-          timeoutMs: 5_000,
-        },
-      ];
-      config.ois[0].endpoints[0] = { ...config.ois[0].endpoints[0], preProcessingSpecifications };
-
-      const parameters = { _type: 'int256', _path: 'price', from: '*ETH' };
-      const aggregatedApiCall = fixtures.buildAggregatedRegularApiCall({ parameters });
-
-      const throwingFunc = () => preProcessApiSpecifications({ type: 'regular', config, aggregatedApiCall });
-
-      await expect(throwingFunc).rejects.toEqual(
-        new ZodError([
-          {
-            code: 'invalid_type',
-            expected: 'string',
-            received: 'object',
-            path: ['object'],
-            message: 'Expected string, received object',
-          },
-        ])
-      );
-    });
   });
 });
 
diff --git a/packages/airnode-node/src/handlers/process-http-request.ts b/packages/airnode-node/src/handlers/process-http-request.ts
@@ -7,7 +7,7 @@ import { Config } from '../config';
 export async function processHttpRequest(
   config: Config,
   endpointId: string,
-  parameters: Record<string, string>
+  parameters: Record<string, any>
 ): Promise<[Error, null] | [null, HttpGatewayApiCallSuccessResponse]> {
   // Guaranteed to exist because validation is already performed in the deployer handler
   const trigger = find(config.triggers.http, ['endpointId', endpointId])!;
diff --git a/packages/airnode-node/src/validation.ts b/packages/airnode-node/src/validation.ts
@@ -1,3 +1,3 @@
 import { z } from 'zod';
 
-export const apiCallParametersSchema = z.record(z.string(), z.string());
+export const apiCallParametersSchema = z.record(z.string(), z.any());
diff --git a/packages/airnode-node/src/workers/local-gateways/validation.test.ts b/packages/airnode-node/src/workers/local-gateways/validation.test.ts
@@ -106,18 +106,6 @@ describe('verifyHttpRequest', () => {
     });
   });
 
-  it('returns error when the parameters are invalid', () => {
-    const config = loadConfigFixture();
-
-    const result = verifyHttpRequest(config, { nonStringValue: 123 }, validEndpointId);
-
-    expect(result).toEqual({
-      error: { message: 'Invalid request body' },
-      statusCode: 400,
-      success: false,
-    });
-  });
-
   it('returns success when the data is valid', () => {
     const config = loadConfigFixture();
 
diff --git a/packages/airnode-node/test/fixtures/config/config.valid.json b/packages/airnode-node/test/fixtures/config/config.valid.json
@@ -84,7 +84,7 @@
   "templates": [],
   "ois": [
     {
-      "oisFormat": "2.0.0",
+      "oisFormat": "2.1.0",
       "title": "CoinGecko basic request",
       "version": "1.0.0",
       "apiSpecifications": {
diff --git a/packages/airnode-node/test/fixtures/config/ois.ts b/packages/airnode-node/test/fixtures/config/ois.ts
@@ -2,7 +2,7 @@ import { OIS } from '@api3/ois';
 
 export function buildOIS(ois?: Partial<OIS>): OIS {
   return {
-    oisFormat: '2.0.0',
+    oisFormat: '2.1.0',
     version: '1.2.3',
     title: 'Currency Converter API',
     apiSpecifications: {
diff --git a/packages/airnode-validator/package.json b/packages/airnode-validator/package.json
diff --git a/packages/airnode-validator/test/fixtures/config.valid.json b/packages/airnode-validator/test/fixtures/config.valid.json
diff --git a/packages/airnode-validator/test/fixtures/interpolated-config.valid.json b/packages/airnode-validator/test/fixtures/interpolated-config.valid.json
diff --git a/packages/airnode-validator/test/fixtures/invalid-secret-name/config.json b/packages/airnode-validator/test/fixtures/invalid-secret-name/config.json
diff --git a/packages/airnode-validator/test/fixtures/ois.json b/packages/airnode-validator/test/fixtures/ois.json
diff --git a/yarn.lock b/yarn.lock

Original file line number	Diff line number	Diff line change
`@@ -131,6 +131,6 @@`
`131`	`131`	`"solhint": "^3.4.1",`
`132`	`132`	`"ts-node": "^10.9.1",`
`133`	`133`	`"typescript": "^4.9.5",`
`134`		`- "yargs": "^17.7.1"`
	`134`	`+ "yargs": "^17.7.2"`
`135`	`135`	`}`
`136`	`136`	`}`
Original file line number	Diff line number	Diff line change
`@@ -94,7 +94,7 @@`
`94`	`94`	`"templates": [],`
`95`	`95`	`"ois": [`
`96`	`96`	`{`
`97`		`- "oisFormat": "2.0.0",`
	`97`	`+ "oisFormat": "2.1.0",`
`98`	`98`	`"title": "CoinGecko basic request",`
`99`	`99`	`"version": "1.0.0",`
`100`	`100`	`"apiSpecifications": {`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@`
`95`	`95`	`"templates": [],`
`96`	`96`	`"ois": [`
`97`	`97`	`{`
`98`		`- "oisFormat": "2.0.0",`
	`98`	`+ "oisFormat": "2.1.0",`
`99`	`99`	`"title": "CoinGecko basic request",`
`100`	`100`	`"version": "1.0.0",`
`101`	`101`	`"apiSpecifications": {`
Original file line number	Diff line number	Diff line change
`@@ -93,7 +93,7 @@`
`93`	`93`	`"templates": [],`
`94`	`94`	`"ois": [`
`95`	`95`	`{`
`96`		`- "oisFormat": "2.0.0",`
	`96`	`+ "oisFormat": "2.1.0",`
`97`	`97`	`"title": "CoinGecko basic request",`
`98`	`98`	`"version": "1.0.0",`
`99`	`99`	`"apiSpecifications": {`
Original file line number	Diff line number	Diff line change
`@@ -83,7 +83,7 @@`
`83`	`83`	`"templates": [],`
`84`	`84`	`"ois": [`
`85`	`85`	`{`
`86`		`- "oisFormat": "2.0.0",`
	`86`	`+ "oisFormat": "2.1.0",`
`87`	`87`	`"title": "CoinMarketCap Basic Authenticated Request",`
`88`	`88`	`"version": "1.0.0",`
`89`	`89`	`"apiSpecifications": {`