feat: add sync request concurrent option (#258)

Author: bzp2010

apps/cli/src/command/helper.ts

@@ -33,7 +33,7 @@ export class BaseCommand extends Command {
   }
 
   // Appends the provided examples to description
-  public addExamples(examples: Array<{ title: string, command: string }>) {
+  public addExamples(examples: Array<{ title: string; command: string }>) {
     this.examples.push(...examples);
 
     // Title of each example is a comment which describes the actual command
@@ -105,17 +105,15 @@ export class BackendCommand<OPTS extends object = object> extends BaseCommand {
         .default('apisix'),
     )
       .addOption(
-        new Option(
-          '--server <string>',
-          'HTTP address of the backend',
-        )
+        new Option('--server <string>', 'HTTP address of the backend')
           .env('ADC_SERVER')
           .default('http://localhost:9180'),
       )
       .addOption(
-        new Option('--token <string>', 'token for ADC to connect to the backend').env(
-          'ADC_TOKEN',
-        ),
+        new Option(
+          '--token <string>',
+          'token for ADC to connect to the backend',
+        ).env('ADC_TOKEN'),
       )
       .addOption(
         new Option(
@@ -212,3 +210,14 @@ export class BackendCommand<OPTS extends object = object> extends BaseCommand {
 }
 
 export const NoLintOption = new Option('--no-lint', 'disable lint check');
+export const RequestConcurrentOption = new Option(
+  '--request-concurrent <integer>',
+  'number of concurrent requests to the backend',
+)
+  .default(10, '10')
+  .argParser((val) => {
+    const int = parseInt(val);
+    if (!Number.isInteger(int))
+      throw new InvalidArgumentError('Not an integer');
+    return int;
+  });

apps/cli/src/command/ingress-sync.command.ts

@@ -12,23 +12,16 @@ import {
 } from '../tasks';
 import { InitializeBackendTask } from '../tasks/init_backend';
 import { TaskContext } from './diff.command';
-import { BackendCommand } from './helper';
-import { BackendOptions } from './typing';
-
-type SyncOption = BackendOptions & {
-  file: Array<string>;
-  lint: boolean;
-
-  // experimental feature
-  remoteStateFile: string;
-};
+import { BackendCommand, RequestConcurrentOption } from './helper';
+import { SyncOption } from './sync.command';
 
 export const IngressSyncCommand = new BackendCommand<SyncOption>('sync')
   .option(
     '-f, --file <file-path>',
     'file to synchronize',
     (filePath, files: Array<string> = []) => files.concat(filePath),
   )
+  .addOption(RequestConcurrentOption)
   .handle(async (opts) => {
     const tasks = new Listr<TaskContext, typeof SilentRenderer>(
       [
@@ -54,7 +47,10 @@ export const IngressSyncCommand = new BackendCommand<SyncOption>('sync')
             try {
               const results = await lastValueFrom(
                 ctx.backend
-                  .sync(ctx.diff, { exitOnFailure: false })
+                  .sync(ctx.diff, {
+                    exitOnFailure: false,
+                    concurrent: opts.requestConcurrent,
+                  })
                   .pipe(toArray()),
               );
 

apps/cli/src/command/sync.command.ts

@@ -11,13 +11,18 @@ import {
 import { InitializeBackendTask } from '../tasks/init_backend';
 import { SignaleRenderer } from '../utils/listr';
 import { TaskContext } from './diff.command';
-import { BackendCommand, NoLintOption } from './helper';
+import {
+  BackendCommand,
+  NoLintOption,
+  RequestConcurrentOption,
+} from './helper';
 import { BackendOptions } from './typing';
 import { addBackendEventListener } from './utils';
 
-type SyncOption = BackendOptions & {
+export type SyncOption = BackendOptions & {
   file: Array<string>;
   lint: boolean;
+  requestConcurrent?: number;
 
   // experimental feature
   remoteStateFile: string;
@@ -34,6 +39,7 @@ export const SyncCommand = new BackendCommand<SyncOption>(
     (filePath, files: Array<string> = []) => files.concat(filePath),
   )
   .addOption(NoLintOption)
+  .addOption(RequestConcurrentOption)
   .addExamples([
     {
       title: 'Synchronize configuration from a single file',
@@ -95,7 +101,10 @@ export const SyncCommand = new BackendCommand<SyncOption>(
             const cancel = addBackendEventListener(ctx.backend, task);
             await lastValueFrom(
               ctx.backend
-                .sync(ctx.diff, { exitOnFailure: true })
+                .sync(ctx.diff, {
+                  exitOnFailure: true,
+                  concurrent: opts.requestConcurrent,
+                })
                 .pipe(toArray()),
             );
             cancel();

libs/backend-api7/src/operator.ts

@@ -102,7 +102,7 @@ export class Operator extends ADCSDK.backend.BackendEventSource {
               }),
               tap(() => logger(taskStateEvent('TASK_DONE'))),
             );
-          }),
+          }, opts.concurrent),
         ),
       ),
     );

libs/backend-apisix/src/operator.ts

@@ -123,7 +123,7 @@ export class Operator extends ADCSDK.backend.BackendEventSource {
               }),
               tap(() => logger(taskStateEvent('TASK_DONE'))),
             );
-          }),
+          }, opts.concurrent),
         ),
       ),
     );

libs/sdk/src/backend/index.ts

@@ -49,6 +49,7 @@ export interface BackendEventAxiosDebug {
 }
 
 export interface BackendSyncOptions {
+  concurrent?: number;
   exitOnFailure?: boolean;
 }