fix: remove freeform error message text from telemetry (#3050)

Even accounting for our best attempts to sanitize the freeform text, the
chance something undesirable slips through is too high.

Don't collect the text at all.


_By submitting this pull request, I confirm that my contribution is made
under the terms of the Apache 2.0 license._

Author: rix0rrr

.changeset/thick-papers-wish.md

@@ -0,0 +1,5 @@
+---
+'@aws-amplify/platform-core': patch
+---
+
+Remove freeform error message text from telemetry

packages/platform-core/API.md

@@ -131,8 +131,6 @@ export class ConfigurationControllerFactory {
 // @public (undocumented)
 export type ErrorDetails = {
     name: string;
-    message: string;
-    stack: string;
     caused?: ErrorDetails;
 };
 

packages/platform-core/src/telemetry/telemetry_payload.ts

@@ -53,16 +53,20 @@ const latencySchema = z.object({
 
 export type ErrorDetails = {
   name: string;
-  message: string;
-  stack: string;
+  // Purposely omitting message and stack. Removing them from the Zod schema
+  // removes them from the payload sent to the server.
+  // message: string;
+  // stack: string;
   caused?: ErrorDetails;
 };
 
 const errorSchema: z.ZodType<ErrorDetails> = z.lazy(() =>
   z.object({
     name: z.string(),
-    message: z.string(),
-    stack: z.string(),
+    // Purposely omitting message and stack. Removing them from the Zod schema
+    // removes them from the payload sent to the server.
+    // message: z.string(),
+    // stack: z.string(),
     caused: z.optional(errorSchema), // Recursive reference
   }),
 );

packages/platform-core/src/telemetry/telemetry_payload_exporter.test.ts

@@ -250,10 +250,12 @@ void describe('DefaultTelemetryPayloadExporter', () => {
     assert.strictEqual(telemetryPayloadSent.latency.deployment, 740);
     assert.strictEqual(telemetryPayloadSent.error?.name, 'test error');
     assert.strictEqual(
-      telemetryPayloadSent.error.message,
-      'test error message',
+      // eslint-disable-next-line @typescript-eslint/no-explicit-any
+      (telemetryPayloadSent.error as any).message,
+      undefined,
     );
-    assert.strictEqual(telemetryPayloadSent.error.stack, 'test error stack');
+    // eslint-disable-next-line @typescript-eslint/no-explicit-any
+    assert.strictEqual((telemetryPayloadSent.error as any).stack, undefined);
     assert.deepStrictEqual(mockResultCallback.mock.calls[0].arguments[0], {
       code: ExportResultCode.SUCCESS,
     });
@@ -329,11 +331,6 @@ void describe('DefaultTelemetryPayloadExporter', () => {
       telemetryPayloadSent.error?.name,
       'TelemetrySpanAttributeCountLimitFault',
     );
-    assert.strictEqual(
-      telemetryPayloadSent.error.message,
-      `Telemetry span attribute count has hit the limit of ${telemetrySpanAttributeCountLimit}`,
-    );
-    assert.ok(telemetryPayloadSent.error.stack);
     assert.deepStrictEqual(mockResultCallback.mock.calls[0].arguments[0], {
       code: ExportResultCode.SUCCESS,
     });

packages/platform-core/src/telemetry/translate_error_to_telemetry_error_details.test.ts

@@ -9,8 +9,6 @@ void describe('translateErrorToTelemetryErrorDetails', () => {
     error.stack = 'test stack';
     const expectedError: TelemetryPayload['error'] = {
       name: 'Error',
-      message: 'test error message',
-      stack: 'test stack',
     };
     const actual = translateErrorToTelemetryErrorDetails(error);
     assert.deepStrictEqual(actual, expectedError);
@@ -30,16 +28,10 @@ void describe('translateErrorToTelemetryErrorDetails', () => {
 
     const expectedError: TelemetryPayload['error'] = {
       name: 'DeeplyNestedError',
-      message: 'deeply nested error',
-      stack: 'stack for deeply nested error',
       caused: {
         name: 'NestedError',
-        message: 'nested error',
-        stack: 'stack for nested error',
         caused: {
           name: 'Error',
-          message: 'top level error',
-          stack: 'stack for error',
         },
       },
     };

packages/platform-core/src/telemetry/translate_error_to_telemetry_error_details.ts

@@ -18,8 +18,6 @@ export const translateErrorToTelemetryErrorDetails = (
       const serializedError = new SerializableError(currentError);
       const errorDetail: TelemetryPayload['error'] = {
         name: serializedError.name,
-        message: serializedError.message,
-        stack: serializedError.stack ?? '',
       };
 
       if (errorDetails) {