chore(cli): allow valid enum values in telemetry data (#711)

Enum values are defined as `choices` in the `cli-type-registry.json`
file. If the choices array exists, and if the value we get is included
as a choice, then we allow that raw value to be recorded in telemetry
because it is not free text. Invalid values passed in an enum property
are not recorded. In practice, the CLI fails before telemetry starts
with

```
Invalid values:
  Argument: require-approval, Given: "neveasdfr", Choices: "never", "any-change", "broadening"
```

---
By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache-2.0 license

---------

Signed-off-by: github-actions <[email protected]>
Co-authored-by: github-actions <[email protected]>

Author: kaizencc

packages/aws-cdk/lib/cli/telemetry/sanitation.ts

@@ -34,7 +34,7 @@ export function sanitizeCommandLineArguments(argv: any): { path: string[]; param
     if (argv[argName] === undefined || (!globalOptions.includes(argName) && !commandOptions.includes(argName))) {
       continue;
     }
-    if (isNumberOrBoolean(argv[argName])) {
+    if (isNumberOrBoolean(argv[argName]) || isKnownEnumValue(argName, argv[argName], command, config)) {
       parameters[argName] = argv[argName];
     } else {
       parameters[argName] = '<redacted>';
@@ -71,6 +71,15 @@ function isNumberOrBoolean(value: any): boolean {
   return typeof value === 'number' || isBoolean(value);
 }
 
+function isKnownEnumValue(name: string, value: any, command: string, config: any): boolean {
+  const propertyDefiniton = config.globalOptions[name] ?? config.commands[command]?.options[name];
+  if (propertyDefiniton.type === 'string') {
+    // Even if the property has choices, only record if the value is a valid choice
+    return propertyDefiniton.choices?.includes(value);
+  }
+  return false;
+}
+
 function isFeatureFlag(flag: string): flag is FeatureFlag {
   return Object.values(FeatureFlag).includes(flag as FeatureFlag);
 }

packages/aws-cdk/test/cli/telemetry/sanitation.test.ts

@@ -103,12 +103,35 @@ describe(sanitizeCommandLineArguments, () => {
     const argv = {
       _: ['deploy'],
       STACKS: ['MyStack'],
-      ['require-approval']: 'broadening',
       ['build-exclude']: ['something'],
     };
     expect(sanitizeCommandLineArguments(argv)).toEqual({
       path: ['deploy', '$STACKS_1'],
-      parameters: { 'require-approval': '<redacted>', 'build-exclude': '<redacted>' },
+      parameters: { 'build-exclude': '<redacted>' },
+    });
+  });
+
+  test('enum options are allowed', () => {
+    const argv = {
+      _: ['deploy'],
+      STACKS: ['MyStack'],
+      ['require-approval']: 'broadening',
+    };
+    expect(sanitizeCommandLineArguments(argv)).toEqual({
+      path: ['deploy', '$STACKS_1'],
+      parameters: { 'require-approval': 'broadening' },
+    });
+  });
+
+  test('invalid enum options are redacted', () => {
+    const argv = {
+      _: ['deploy'],
+      STACKS: ['MyStack'],
+      ['require-approval']: 'invalid',
+    };
+    expect(sanitizeCommandLineArguments(argv)).toEqual({
+      path: ['deploy', '$STACKS_1'],
+      parameters: { 'require-approval': '<redacted>' },
     });
   });
 });