feat: support custom resource id

apps/cli/src/command/dump.command.ts

@@ -18,6 +18,7 @@ import {
 
 type DumpOptions = BackendOptions & {
   output: string;
+  withId: boolean;
 };
 
 export interface LoadRemoteConfigurationTaskOptions {
@@ -74,6 +75,7 @@ export const DumpCommand = new BackendCommand<DumpOptions>(
     'path of the file to save the configuration',
     'adc.yaml',
   )
+  .option('--with-id', 'dump remote resources id')
   .addExamples([
     {
       title: 'Save backend configuration to the default adc.yaml file',
@@ -92,6 +94,10 @@ export const DumpCommand = new BackendCommand<DumpOptions>(
       title: 'Save only the resources with the specified labels',
       command: 'adc dump --label-selector app=catalog',
     },
+    {
+      title: 'Save the remote resources id',
+      command: 'adc dump --with-id',
+    },
   ])
   .handle(async (opts) => {
     const backend = loadBackend(opts.backend, opts);
@@ -105,6 +111,7 @@ export const DumpCommand = new BackendCommand<DumpOptions>(
         }),
         {
           // Remove output resource metadata fields
+          enabled: !opts.withId,
           task: (ctx) => recursiveRemoveMetadataField(ctx.remote),
         },
         {

apps/cli/src/command/utils.ts

@@ -250,6 +250,7 @@ export const filterResourceType = (
 
 export const recursiveRemoveMetadataField = (c: ADCSDK.Configuration) => {
   const removeMetadata = (obj: object) => {
+    if ('id' in obj) delete obj.id;
     if ('metadata' in obj) delete obj.metadata;
   };
   Object.entries(c).forEach(([key, value]) => {

apps/cli/src/differ/differv3.ts

@@ -78,27 +78,19 @@ export class DifferV3 {
         ADCSDK.ResourceType.SERVICE,
         local?.services?.map((res) => [
           res.name,
-          ADCSDK.utils.generateId(res.name),
-          res,
-        ]) ?? [],
-        remote?.services?.map((res) => [
-          res.name,
-          ADCSDK.utils.generateId(res.name),
+          res.id ?? ADCSDK.utils.generateId(res.name),
           res,
         ]) ?? [],
+        remote?.services?.map((res) => [res.name, res.id, res]) ?? [],
       ),
       ...differ.diffResource(
         ADCSDK.ResourceType.SSL,
         local?.ssls?.map((res) => [
           res.snis.join(','),
-          ADCSDK.utils.generateId(res.snis.join(',')),
-          res,
-        ]) ?? [],
-        remote?.ssls?.map((res) => [
-          res.snis.join(','),
-          ADCSDK.utils.generateId(res.snis.join(',')),
+          res.id ?? ADCSDK.utils.generateId(res.snis.join(',')),
           res,
         ]) ?? [],
+        remote?.ssls?.map((res) => [res.snis.join(','), res.id, res]) ?? [],
       ),
       ...differ.diffResource(
         ADCSDK.ResourceType.CONSUMER,
@@ -144,40 +136,29 @@ export class DifferV3 {
         ADCSDK.ResourceType.ROUTE,
         local?.routes?.map((res) => [
           res.name,
-          ADCSDK.utils.generateId(generateResourceName(res.name)),
-          res,
-        ]) ?? [],
-        remote?.routes?.map((res) => [
-          res.name,
-          ADCSDK.utils.generateId(generateResourceName(res.name)),
+          res.id ?? ADCSDK.utils.generateId(generateResourceName(res.name)),
           res,
         ]) ?? [],
+        remote?.routes?.map((res) => [res.name, res.id, res]) ?? [],
       ),
       ...differ.diffResource(
         ADCSDK.ResourceType.STREAM_ROUTE,
         local?.stream_routes?.map((res) => [
           res.name,
-          ADCSDK.utils.generateId(generateResourceName(res.name)),
-          res,
-        ]) ?? [],
-        remote?.stream_routes?.map((res) => [
-          res.name,
-          ADCSDK.utils.generateId(generateResourceName(res.name)),
+          res.id ?? ADCSDK.utils.generateId(generateResourceName(res.name)),
           res,
         ]) ?? [],
+        remote?.stream_routes?.map((res) => [res.name, res.id, res]) ?? [],
       ),
       ...differ.diffResource(
         ADCSDK.ResourceType.CONSUMER_CREDENTIAL,
         local?.consumer_credentials?.map((res) => [
           res.name,
-          ADCSDK.utils.generateId(generateResourceName(res.name)),
-          res,
-        ]) ?? [],
-        remote?.consumer_credentials?.map((res) => [
-          res.name,
-          ADCSDK.utils.generateId(generateResourceName(res.name)),
+          res.id ?? ADCSDK.utils.generateId(generateResourceName(res.name)),
           res,
         ]) ?? [],
+        remote?.consumer_credentials?.map((res) => [res.name, res.id, res]) ??
+          [],
       ),
       /* ...differ.diffResource(
         ADCSDK.ResourceType.UPSTREAM,
@@ -321,22 +302,20 @@ export class DifferV3 {
 
     const checkedRemoteId: Array<ADCSDK.ResourceId> = [];
     remote.forEach(([remoteName, remoteId, remoteItem]) => {
-      const remoteMetadata = cloneDeep(
-        (remoteItem as { metadata: ADCSDK.ResourceMetadata })?.metadata,
-      );
       unset(remoteItem, 'metadata');
-      const eventResourceId = remoteMetadata?.id ?? remoteId;
+      unset(remoteItem, 'id');
 
       // Asserts that the remote resource should exist locally, and that
       // non-existence means that the user deleted that resource.
-      const localItem = localIdMap[eventResourceId];
+      const localItem = localIdMap[remoteId];
+      unset(localItem, 'id');
 
       // Exists remotely but not locally: resource deleted by user
       if (!localItem) {
         return result.push({
           resourceType,
           type: ADCSDK.EventType.DELETE,
-          resourceId: eventResourceId,
+          resourceId: remoteId,
           resourceName: remoteName,
           oldValue: remoteItem,
 
@@ -359,13 +338,13 @@ export class DifferV3 {
             resourceType === ADCSDK.ResourceType.SERVICE
               ? remoteName
               : undefined,
-          ).map(this.postprocessSubEvent(remoteName, eventResourceId)),
+          ).map(this.postprocessSubEvent(remoteName, remoteId)),
         });
       }
 
       // Record the remote IDs that have been checked. It will be used
       // to identify locally added resources.
-      checkedRemoteId.push(eventResourceId);
+      checkedRemoteId.push(remoteId);
 
       const originalLocalItem = cloneDeep(localItem);
 
@@ -588,6 +567,10 @@ export class DifferV3 {
     // Exists locally but not remotely: resource created by user
     local.forEach(([localName, localId, localItem]) => {
       if (checkedRemoteId.includes(localId)) return;
+
+      unset(localItem, 'metadata');
+      unset(localItem, 'id');
+
       return result.push({
         resourceType,
         type: ADCSDK.EventType.CREATE,