address comments

aws-observability · Aug 8, 2024 · ba88fca · ba88fca
1 parent 8c64f96
commit ba88fca
Show file tree

Hide file tree

Showing 8 changed files with 11 additions and 24 deletions.
diff --git a/aws-distro-opentelemetry-node-autoinstrumentation/src/always-record-sampler.ts b/aws-distro-opentelemetry-node-autoinstrumentation/src/always-record-sampler.ts
@@ -24,8 +24,8 @@ export class AlwaysRecordSampler implements Sampler {
   }
 
   private constructor(rootSampler: Sampler) {
-    if (rootSampler === null) {
-      throw new Error('rootSampler is null. It must be provided');
+    if (rootSampler == null) {
+      throw new Error('rootSampler is null/undefined. It must be provided');
     }
     this.rootSampler = rootSampler;
   }

diff --git a/...distro-opentelemetry-node-autoinstrumentation/src/attribute-propagating-span-processor.ts b/...distro-opentelemetry-node-autoinstrumentation/src/attribute-propagating-span-processor.ts
@@ -116,17 +116,9 @@ export class AttributePropagatingSpanProcessor implements SpanProcessor {
     return SpanKind.SERVER === span.kind;
   }
 
-  public isStartRequired(): boolean {
-    return true;
-  }
-
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   public onEnd(span: ReadableSpan): void {}
 
-  public isEndRequired(): boolean {
-    return false;
-  }
-
   public shutdown(): Promise<void> {
     return this.forceFlush();
   }

diff --git a/...opentelemetry-node-autoinstrumentation/src/aws-metric-attributes-span-exporter-builder.ts b/...opentelemetry-node-autoinstrumentation/src/aws-metric-attributes-span-exporter-builder.ts
@@ -32,6 +32,9 @@ export class AwsMetricAttributesSpanExporterBuilder {
    * defaults to {@link DEFAULT_GENERATOR}. Must not be null.
    */
   public setGenerator(generator: MetricAttributeGenerator): AwsMetricAttributesSpanExporterBuilder {
+    if (generator == null) {
+      throw new Error('generator must not be null/undefined');
+    }
     this.generator = generator;
     return this;
   }

diff --git a/aws-distro-opentelemetry-node-autoinstrumentation/src/aws-metric-attributes-span-exporter.ts b/aws-distro-opentelemetry-node-autoinstrumentation/src/aws-metric-attributes-span-exporter.ts
@@ -125,6 +125,8 @@ export class AwsMetricAttributesSpanExporter implements SpanExporter {
     }
 
     // Bypass `readonly` restriction of ReadableSpan's attributes.
+    // Workaround provided from official TypeScript docs:
+    // https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#improved-control-over-mapped-type-modifiers
     type Mutable<T> = { -readonly [P in keyof T]: T[P] };
     const mutableSpan: Mutable<ReadableSpan> = span;
     mutableSpan.attributes = updateAttributes;

diff --git a/aws-distro-opentelemetry-node-autoinstrumentation/src/aws-span-metrics-processor-builder.ts b/aws-distro-opentelemetry-node-autoinstrumentation/src/aws-span-metrics-processor-builder.ts
@@ -41,6 +41,9 @@ export class AwsSpanMetricsProcessorBuilder {
    * processor. If unset, defaults to {@link DEFAULT_GENERATOR}. Must not be null.
    */
   public setGenerator(generator: MetricAttributeGenerator): AwsSpanMetricsProcessorBuilder {
+    if (generator == null) {
+      throw new Error('generator must not be null/undefined');
+    }
     this.generator = generator;
     return this;
   }

diff --git a/aws-distro-opentelemetry-node-autoinstrumentation/src/aws-span-metrics-processor.ts b/aws-distro-opentelemetry-node-autoinstrumentation/src/aws-span-metrics-processor.ts
@@ -68,10 +68,6 @@ export class AwsSpanMetricsProcessor implements SpanProcessor {
   // eslint-disable-next-line @typescript-eslint/no-unused-vars
   public onStart(span: Span, parentContext: Context): void {}
 
-  public isStartRequired(): boolean {
-    return false;
-  }
-
   public onEnd(span: ReadableSpan): void {
     const attributeMap: AttributeMap = this.generator.generateMetricAttributeMapFromSpan(span, this.resource);
 
@@ -80,10 +76,6 @@ export class AwsSpanMetricsProcessor implements SpanProcessor {
     }
   }
 
-  public isEndRequired(): boolean {
-    return true;
-  }
-
   // The logic to record error and fault should be kept in sync with the aws-xray exporter whenever
   // possible except for the throttle
   // https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/exporter/awsxrayexporter/internal/translator/cause.go#L121-L160

diff --git a/aws-distro-opentelemetry-node-autoinstrumentation/src/sqs-url-parser.ts b/aws-distro-opentelemetry-node-autoinstrumentation/src/sqs-url-parser.ts
@@ -45,7 +45,7 @@ export class SqsUrlParser {
   }
 
   private static isValidQueueName(input: string): boolean {
-    if (input === null || input.length === 0 || input.length > 80) {
+    if (input == null || input.length === 0 || input.length > 80) {
       return false;
     }
 

diff --git a/aws-distro-opentelemetry-node-autoinstrumentation/test/aws-span-metrics-processor.test.ts b/aws-distro-opentelemetry-node-autoinstrumentation/test/aws-span-metrics-processor.test.ts
@@ -97,11 +97,6 @@ describe('AwsSpanMetricsProcessorTest', () => {
     );
   });
 
-  it('testIsRequired', () => {
-    expect(awsSpanMetricsProcessor.isStartRequired()).toBeFalsy();
-    expect(awsSpanMetricsProcessor.isEndRequired()).toBeTruthy();
-  });
-
   it('testStartDoesNothingToSpan', () => {
     const parentContextMock: Context = {
       getValue: (key: symbol) => 'unknown',