fix(apisix): log scope typo (#253)

Author: bzp2010

apps/cli/src/command/utils.ts

@@ -8,6 +8,7 @@ import { isObject, mapValues, unset } from 'lodash';
 import path from 'node:path';
 import pluralize from 'pluralize';
 
+import { SignaleRendererOutputType } from '../utils/listr';
 import { KVConfiguration } from './typing';
 
 export const loadBackend = (
@@ -306,7 +307,7 @@ export const recursiveReplaceEnvVars = (
 export const buildReqAndRespDebugOutput = (
   resp: AxiosResponse,
   desc?: string,
-  scope = ['API7'],
+  scope = ['APISIX'],
 ) => {
   const capitalizeFirstLetter = (str: string) =>
     str.charAt(0).toUpperCase() + str.slice(1);
@@ -323,7 +324,7 @@ export const buildReqAndRespDebugOutput = (
         `${normalizeKey ? normalizeHeaderKey(key) : key}: ${key !== 'X-API-KEY' ? value : '*****'}\n`,
     );
   return JSON.stringify({
-    type: 'debug',
+    type: SignaleRendererOutputType.DEBUG,
     messages: [
       `${desc ?? ''}\n`, //TODO time consumption
       // request
@@ -344,23 +345,29 @@ export const addBackendEventListener = (
   backend: ADCSDK.Backend,
   task: ListrTaskWrapper<object, any, any>,
 ) => {
+  const metadata = backend.metadata();
+  const logScope = metadata.logScope?.length > 0 ? metadata.logScope : ['ADC'];
   const sub1 = backend.on(
     ADCSDK.BackendEventType.AXIOS_DEBUG,
     ({ response, description }) =>
-      (task.output = buildReqAndRespDebugOutput(response, description)),
+      (task.output = buildReqAndRespDebugOutput(
+        response,
+        description,
+        logScope,
+      )),
   );
   const sub2 = backend.on(ADCSDK.BackendEventType.TASK_START, ({ name }) => {
     task.output = JSON.stringify({
-      type: 'ts',
+      type: SignaleRendererOutputType.LISTR_TASK_START,
       messages: [name],
-      scope: ['API7'],
+      scope: logScope,
     });
   });
   const sub3 = backend.on(ADCSDK.BackendEventType.TASK_DONE, ({ name }) => {
     task.output = JSON.stringify({
-      type: 'td',
+      type: SignaleRendererOutputType.LISTR_TASK_COMPLETE,
       messages: [name],
-      scope: ['API7'],
+      scope: logScope,
     });
   });
   return () => {

apps/cli/src/utils/listr.ts

@@ -21,8 +21,14 @@ export interface SignaleRendererOptions {
   scope?: Array<string>;
 }
 
+export const SignaleRendererOutputType = {
+  DEBUG: 'DEBUG',
+  LISTR_TASK_START: 'LISTR_TASK_START',
+  LISTR_TASK_COMPLETE: 'LISTR_TASK_COMPLETE',
+} as const;
+
 export interface SignaleRendererOutput {
-  type: 'debug' | 'ts' | 'td';
+  type: keyof typeof SignaleRendererOutputType;
   scope?: Array<string>;
   messages: Array<unknown>;
 }
@@ -104,21 +110,21 @@ export class SignaleRenderer implements ListrRenderer {
         if (!output.type || !output.messages) return;
 
         switch (output.type) {
-          case 'ts': {
+          case SignaleRendererOutputType.LISTR_TASK_START: {
             this.getScopedLogger({
               ...rendererOptions,
               scope: output.scope ?? rendererOptions.scope,
             }).start(output.messages.join(''));
             break;
           }
-          case 'td': {
+          case SignaleRendererOutputType.LISTR_TASK_COMPLETE: {
             this.getScopedLogger({
               ...rendererOptions,
               scope: output.scope ?? rendererOptions.scope,
             }).success(output.messages.join(''));
             break;
           }
-          case 'debug': {
+          case SignaleRendererOutputType.DEBUG: {
             if (output?.messages && rendererOptions?.verbose === 2) {
               this.getScopedLogger({
                 ...rendererOptions,
@@ -154,7 +160,7 @@ export class ListrOutputLogger implements Logger {
     if (opts?.showLogEntry && !opts?.showLogEntry({ message, ...kvs })) return;
 
     this.task.output = JSON.stringify({
-      type: 'debug',
+      type: SignaleRendererOutputType.DEBUG,
       messages: [
         `${message}\n`,
         Object.entries(kvs)
@@ -163,37 +169,4 @@ export class ListrOutputLogger implements Logger {
       ],
     } satisfies SignaleRendererOutput);
   }
-
-  axiosDebug(resp: AxiosResponse, desc?: string): void {
-    const config = resp.config;
-
-    const capitalizeFirstLetter = (str: string) =>
-      str.charAt(0).toUpperCase() + str.slice(1);
-
-    // NodeJS will not keep the response header in Xxx-Xxx format, correct it
-    const normalizeHeaderKey = (key: string) =>
-      key.split('-').map(capitalizeFirstLetter).join('-');
-
-    // Transforms HTTP headers to a single line of text formatting
-    const transformHeaders = (headers: object, normalizeKey = false) =>
-      Object.entries(headers).map(
-        ([key, value]) =>
-          `${normalizeKey ? normalizeHeaderKey(key) : key}: ${key !== 'X-API-KEY' ? value : '*****'}\n`,
-      );
-    this.task.output = JSON.stringify({
-      type: 'debug',
-      messages: [
-        `${desc ?? ''}\n`, //TODO time consumption
-        // request
-        `${config.method.toUpperCase()} ${axios.getUri(config)}\n`,
-        ...transformHeaders(config.headers),
-        config?.data ? `\n${config.data}\n` : '',
-        '\n',
-        // response
-        `${resp.status} ${resp.statusText}\n`,
-        ...transformHeaders(resp.headers, true),
-        `${resp?.data ? `\n${JSON.stringify(resp.data)}` : ''}\n`,
-      ],
-    } satisfies SignaleRendererOutput);
-  }
 }

libs/backend-api7/src/index.ts

@@ -65,6 +65,12 @@ export class BackendAPI7 implements ADCSDK.Backend {
     this.gatewayGroupName = opts.gatewayGroup;
   }
 
+  public metadata() {
+    return {
+      logScope: BackendAPI7.logScope,
+    };
+  }
+
   public async ping() {
     await this.client.get('/api/gateway_groups');
   }

libs/backend-apisix/src/index.ts

@@ -17,6 +17,7 @@ import { Fetcher } from './fetcher';
 import { Operator } from './operator';
 
 export class BackendAPISIX implements ADCSDK.Backend {
+  private static logScope = ['APISIX'];
   private readonly client: Axios;
   private readonly subject = new Subject<ADCSDK.BackendEvent>();
 
@@ -58,6 +59,12 @@ export class BackendAPISIX implements ADCSDK.Backend {
     this.client = axios.create(config);
   }
 
+  public metadata() {
+    return {
+      logScope: BackendAPISIX.logScope,
+    };
+  }
+
   public async defaultValue() {
     return {};
   }

libs/converter-openapi/src/index.ts

@@ -166,7 +166,7 @@ export class OpenAPIConverter implements ADCSDK.Converter {
 
   private buildDebugOutput(messages: Array<string>) {
     return JSON.stringify({
-      type: 'debug',
+      type: 'DEBUG',
       messages,
     });
   }

libs/sdk/src/backend/index.ts

@@ -59,7 +59,13 @@ export interface BackendSyncResult {
   error?: Error;
 }
 
+export interface BackendMetadata {
+  logScope: string[];
+}
+
 export interface Backend {
+  metadata: () => BackendMetadata;
+
   ping: () => Promise<void>;
 
   version: () => Promise<SemVer>;