refine implementation and tests

Author: cyyeh

labs/playground1/sqls/artist/artists.sql

@@ -16,3 +16,33 @@ Allow to call APIs from other sources for VulcanSQL, provided by [Canner](https:
    extensions:
      api: '@vulcan-sql/extension-api-caller'
    ```
+
+## Usage
+
+To pass the path parameters:
+
+```sql
+{% set a_variable_you_can_define = { "path": { "id": 1 } } %}
+SELECT {{ a_variable_you_can_define | rest_api(url='https://dummyjson.com/products/:id') }}
+```
+
+To pass the query parameters:
+
+```sql
+{% set a_variable_you_can_define = { "query": { "q": "phone" }  } %}
+SELECT {{ a_variable_you_can_define | rest_api(url='https://dummyjson.com/products/search') }}
+```
+
+To issue the POST request:
+
+```sql
+{% set a_variable_you_can_define = { "body": { "title": "BMW Pencil" } } %}
+SELECT {{ a_variable_you_can_define | rest_api(url='https://dummyjson.com/products/add', method='POST') }}
+```
+
+To pass the headers and multiple fields:
+
+```sql
+{% set a_variable_you_can_define = { "headers": { "Content-Type": "application/json" }, "body": { "title": "BMW Pencil" } } %}
+SELECT {{ a_variable_you_can_define | rest_api(url='https://dummyjson.com/products/add', method='POST') }}
+```

labs/playground1/sqls/artist/artists.yaml

@@ -2,6 +2,7 @@ import {
   FunctionalFilter,
   InternalError,
   createFilterExtension,
+  getLogger,
 } from '@vulcan-sql/core';
 
 import axios from 'axios';
@@ -12,23 +13,49 @@ export const RestApiCallerFilter: FunctionalFilter = async ({
 }) => {
   if (!args['url']) throw new InternalError('url is required');
 
-  const url = args['arg'] && args['arg'] === ':id' ? `${args['url']}/${value}` : args['url'];
+  const logger = getLogger({
+    scopeName: 'CORE',
+  });
+  let url = args['url'];
   const httpMethod = args['method'] || 'get';
+
   let options: any = {
-    url: url,
     method: httpMethod,
-    params: args['arg'] && args['arg'] !== ':id' ? { [args['arg']]: value } : {},
+    url,
   }
-  if (args['body']) {
-    options = {...options, body: JSON.parse(args['body'])}
+
+  if ('path' in value) {
+    for (const key in value['path']) {
+      url = url.replace(`:${key}`, value['path'][key]);
+    }
+    options = {...options, url}
   }
-  if (args['headers']) {
-    options = {...options, headers: JSON.parse(args['headers'])}
+
+  if ('query' in value) {
+    options = {...options, params: value['query']}
   }
 
-  const results = await axios(options);
+  if ('body' in value) {
+    options = {...options, data: value['body']}
+  }
 
-  return JSON.stringify(results.data);
+  if ('headers' in value) {
+    options = {...options, headers: value['headers']}
+  }
+
+  try {
+    logger.info('API request:', options);
+    const results = await axios(options);
+    logger.info('API response:', results.data);
+    return JSON.stringify(results.data);
+  } catch (error: any) {
+    const message = error.response
+      ? `response status: ${error.response.status}, response data: ${JSON.stringify(error.response.data)}`
+      : `remote server does not response. request ${error.toJSON()}}`;
+    throw new InternalError(
+      `Failed to execute API request "${url}" data, ${message}`
+    );
+  }
 };
 
 export const [Builder, Runner] = createFilterExtension(