allow extension-api-caller to accept other https methods, headers, body

Author: cyyeh

packages/extension-api-caller/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@vulcan-sql/extension-api-caller",
   "description": "Calling APIs to get data from other sources",
-  "version": "0.8.0",
+  "version": "0.8.1",
   "type": "commonjs",
   "publishConfig": {
     "access": "public"

packages/extension-api-caller/src/lib/filters/restApiCaller.ts

@@ -11,10 +11,22 @@ export const RestApiCallerFilter: FunctionalFilter = async ({
   value,
 }) => {
   if (!args['url']) throw new InternalError('url is required');
+
   const url = args['arg'] && args['arg'] === ':id' ? `${args['url']}/${value}` : args['url'];
-  const results = await axios.get<Array<any>>(url, {
+  const httpMethod = args['method'] || 'get';
+  let options: any = {
+    url: url,
+    method: httpMethod,
     params: args['arg'] && args['arg'] !== ':id' ? { [args['arg']]: value } : {},
-  });
+  }
+  if (args['body']) {
+    options = {...options, body: JSON.parse(args['body'])}
+  }
+  if (args['headers']) {
+    options = {...options, headers: JSON.parse(args['headers'])}
+  }
+
+  const results = await axios(options);
 
   return JSON.stringify(results.data);
 };

packages/extension-api-caller/test/restApiCaller.spec.ts

@@ -9,8 +9,7 @@ describe('Test "rest_api" filter', () => {
         extensions: { rest_api: path.join(__dirname, '..', 'src') },
       });
 
-      const sql = `{% set result = 1990 %}SELECT {{ result | 
-        rest_api(url='', arg='begin_date') }}`;
+      const sql = `{% set result = 1990 %}SELECT {{ result | rest_api(url='', arg='begin_date') }}`;
 
       // Act
       await compileAndLoad(sql);
@@ -24,8 +23,22 @@ describe('Test "rest_api" filter', () => {
   );
 
   it(
-    'The call API extensions created by createFilter function should work with template engine',
+    'The rest_api function should work with template engine',
     async () => {
+      const { compileAndLoad, execute, getExecutedQueries, getCreatedBinding } = await getTestCompiler({
+        extensions: { rest_api: path.join(__dirname, '..', 'src') },
+      });
+
+      const sql = `{% set result = 1990 %}SELECT {{ result | rest_api(url='http://localhost:3000/api/artists', arg='begin_date') }}`;
+
+      // Act
+      await compileAndLoad(sql);
+      await execute({});
+
+      // Assert
+      const queries = await getExecutedQueries();
+      const bindings = await getCreatedBinding();
+
       const expected = JSON.stringify(
         [
           {
@@ -141,12 +154,20 @@ describe('Test "rest_api" filter', () => {
         ]
       );
 
+      expect(queries[0]).toBe('SELECT $1');
+      expect(bindings[0].get('$1')).toEqual(expected);
+    },
+    50 * 1000
+  );
+
+  it(
+    'The rest_api function should work with HTTP Post request',
+    async () => {
       const { compileAndLoad, execute, getExecutedQueries, getCreatedBinding } = await getTestCompiler({
         extensions: { rest_api: path.join(__dirname, '..', 'src') },
       });
 
-      const sql = `{% set result = 1990 %}SELECT {{ result | 
-        rest_api(url='http://localhost:3000/api/artists', arg='begin_date') }}`;
+      const sql = `{% set body = '{"title": "BMW Pencil"}' %}SELECT {{ body | rest_api(url='https://dummyjson.com/products/add', method='POST', arg='body') }}`;
 
       // Act
       await compileAndLoad(sql);
@@ -156,9 +177,13 @@ describe('Test "rest_api" filter', () => {
       const queries = await getExecutedQueries();
       const bindings = await getCreatedBinding();
 
+      const expected = JSON.stringify({
+        "id": 101
+      });
+
       expect(queries[0]).toBe('SELECT $1');
       expect(bindings[0].get('$1')).toEqual(expected);
     },
     50 * 1000
-  );
+  )
 });

tsconfig.base.json

@@ -104,6 +104,9 @@
       "@vulcan-sql/extension-store-canner": [
         "packages/extension-store-canner/src/index.ts"
       ],
+      "@vulcan-sql/extension-api-caller": [
+        "packages/extension-api-caller/src/index.ts"
+      ],
       "@vulcan-sql/integration-testing": [
         "packages/integration-testing/src/index"
       ],