feat(core): allow keep var syntax in yaml via escaping character (#262)

* feat: allow envvar syntax in yaml to be retained via escaping chars

* test on apisix 3.12

* prevent conflict

Author: bzp2010

.github/workflows/e2e.yaml

@@ -23,6 +23,7 @@ jobs:
           - 3.9.1
           - 3.10.0
           - 3.11.0
+          - 3.12.0
     env:
       BACKEND_APISIX_VERSION: ${{ matrix.version }}
       BACKEND_APISIX_IMAGE: ${{ matrix.version }}-debian

apps/cli/src/command/utils.spec.ts

@@ -267,6 +267,9 @@ describe('CLI utils', () => {
               },
             ],
           },
+          {
+            name: 'Test escape \\${NAME}',
+          },
         ],
         consumers: [
           {
@@ -322,6 +325,9 @@ describe('CLI utils', () => {
             name: 'Test name',
             routes: [{ name: 'Test name', uris: ['/test/name'] }],
           },
+          {
+            name: 'Test escape ${NAME}',
+          },
         ],
         ssls: [
           {

apps/cli/src/command/utils.ts

@@ -284,14 +284,21 @@ export const recursiveReplaceEnvVars = (
   dataSource = process.env,
 ): ADCSDK.Configuration => {
   const envVarRegex = /\$\{(\w+)\}/g;
+  const escapedVarRegex = /\\\$\{(\w+)\}/g;
+  const placeholder = '__ESCAPED_ENV_VAR_PLACEHOLDER__';
   const replaceValue = (value: unknown): unknown => {
-    if (typeof value === 'string')
-      return value.replace(
-        envVarRegex,
-        (_, envVar) => dataSource?.[envVar] || '',
-      );
+    if (typeof value !== 'string') return value;
 
-    return value;
+    const escaped = value.replace(escapedVarRegex, (_, envVar) => {
+      return `${placeholder}${envVar}${placeholder}`;
+    });
+    const replaced = escaped.replace(envVarRegex, (_, envVar) => {
+      return dataSource?.[envVar] || '';
+    });
+    return replaced.replace(
+      new RegExp(`${placeholder}(\\w+)${placeholder}`, 'g'),
+      (_, envVar) => `\${${envVar}}`,
+    );
   };
 
   const recurseReplace = (value: unknown): unknown =>