feat(api7): add parallel backend request as experimental feature (#230)

api7 · Jan 24, 2025 · 05a4b8c · 05a4b8c
1 parent 3a1e8ea
commit 05a4b8c
Show file tree

Hide file tree

Showing 3 changed files with 70 additions and 13 deletions.
diff --git a/apps/cli/src/command/index.ts b/apps/cli/src/command/index.ts
@@ -1,3 +1,4 @@
+import * as ADCSDK from '@api7/adc-sdk';
 import { Command } from 'commander';
 import dotenv from 'dotenv';
 
@@ -22,8 +23,7 @@ export const setupCommands = (): Command => {
     .version('0.17.0', '-v, --version', 'display ADC version');
 
   if (
-    process.env.ADC_EXPERIMENTAL_FEATURE_FLAGS &&
-    process.env.ADC_EXPERIMENTAL_FEATURE_FLAGS.includes('remote-state-file')
+    ADCSDK.utils.featureGateEnabled(ADCSDK.utils.featureGate.REMOTE_STATE_FILE)
   ) {
     const desc =
       'path of the remote state file, which will allow the ADC to skip the initial dump process and use the ADC configuration contained in the remote state file directly';

diff --git a/libs/backend-api7/src/index.ts b/libs/backend-api7/src/index.ts
@@ -206,7 +206,16 @@ export class BackendAPI7 implements ADCSDK.Backend {
         this.getAPI7VersionTask(),
         this.getResourceDefaultValueTask(),
         this.getGatewayGroupIdTask(this.gatewayGroup),
-        ...fetcher.allTask(),
+        ...(ADCSDK.utils.featureGateEnabled(
+          ADCSDK.utils.featureGate.PARALLEL_BACKEND_REQUEST,
+        )
+          ? [
+              {
+                task: (_, task) =>
+                  task.newListr(fetcher.allTask(), { concurrent: true }),
+              },
+            ]
+          : fetcher.allTask()),
       ],
       {
         //@ts-expect-error reorg renderer
@@ -222,16 +231,20 @@ export class BackendAPI7 implements ADCSDK.Backend {
         this.getAPI7VersionTask(),
         this.getGatewayGroupIdTask(this.gatewayGroup),
         this.syncPreprocessEventsTask(),
-        {
-          task: (ctx, task) =>
-            task.newListr(
-              ctx.diff.map((event) =>
-                event.type === ADCSDK.EventType.DELETE
-                  ? operator.deleteResource(event)
-                  : operator.updateResource(event),
-              ),
-            ),
-        },
+        ADCSDK.utils.featureGateEnabled(
+          ADCSDK.utils.featureGate.PARALLEL_BACKEND_REQUEST,
+        )
+          ? this.groupSyncTasks(operator)
+          : {
+              task: (ctx, task) =>
+                task.newListr(
+                  ctx.diff.map((event) =>
+                    event.type === ADCSDK.EventType.DELETE
+                      ? operator.deleteResource(event)
+                      : operator.updateResource(event),
+                  ),
+                ),
+            },
         operator.publishService(),
       ],
       {
@@ -316,4 +329,35 @@ export class BackendAPI7 implements ADCSDK.Backend {
       },
     };
   }
+
+  // Groups tasks so that they are grouped in parallel in order of same
+  // resource type and same operation type.
+  private groupSyncTasks(operator: Operator): ListrTask<OperateContext> {
+    return {
+      task: (ctx, task) => {
+        const groupedEvents = Object.values<Array<ADCSDK.Event>>(
+          ctx.diff.reduce((groups, event) => {
+            const key = `${event.resourceType}.${event.type}`;
+            (groups[key] = groups[key] || []).push(event);
+            return groups;
+          }, {}),
+        );
+
+        return task.newListr(
+          groupedEvents.map((events) => ({
+            task: (_, task) => {
+              return task.newListr(
+                events.map((event) =>
+                  event.type === ADCSDK.EventType.DELETE
+                    ? operator.deleteResource(event)
+                    : operator.updateResource(event),
+                ),
+                { concurrent: true },
+              );
+            },
+          })),
+        );
+      },
+    };
+  }
 }
diff --git a/libs/sdk/src/utils.ts b/libs/sdk/src/utils.ts
@@ -38,8 +38,21 @@ class Logger {
   }
 }
 
+enum featureGate {
+  REMOTE_STATE_FILE = 'remote-state-file',
+  PARALLEL_BACKEND_REQUEST = 'parallel-backend-request',
+}
+const featureGateEnabled = (key: string) => {
+  return (
+    process.env.ADC_EXPERIMENTAL_FEATURE_FLAGS &&
+    process.env.ADC_EXPERIMENTAL_FEATURE_FLAGS.includes(key)
+  );
+};
+
 export const utils = {
   generateId,
   recursiveOmitUndefined,
   getLogger,
+  featureGate,
+  featureGateEnabled,
 };