feat: apply rule @typescript-eslint/explicit-member-accessibility

Author: legendecas

eslint.config.mjs

@@ -156,6 +156,12 @@ const baseConfig = tseslint.config(
       '@typescript-eslint/no-empty-function': ['off'],
       '@typescript-eslint/no-shadow': ['warn'],
       'prefer-rest-params': 'off',
+      '@typescript-eslint/explicit-member-accessibility': ['error', {
+        overrides: {
+          // `constructor` is public by default.
+          'constructors': 'no-public',
+        },
+      }],
     },
   },
 
@@ -184,6 +190,7 @@ const baseConfig = tseslint.config(
         'warn',
         { argsIgnorePattern: '^_' },
       ],
+      '@typescript-eslint/explicit-member-accessibility': 'off',
       'no-empty': 'off',
     },
   },
@@ -213,7 +220,17 @@ const baseConfig = tseslint.config(
         Task: 'readonly',
       },
     },
-  }
+  },
+
+  // Gradual adoption of explicit-member-accessibility
+  {
+    files: [
+      '**/packages/instrumentation-*/**',
+    ],
+    rules: {
+      '@typescript-eslint/explicit-member-accessibility': 'off',
+    },
+  },
 );
 
 export default baseConfig;

packages/baggage-log-record-processor/src/baggage-log-record-processor.ts

@@ -44,7 +44,7 @@ export class BaggageLogRecordProcessor implements LogRecordProcessor {
   /**
    * Forces to export all finished log records.
    */
-  forceFlush(): Promise<void> {
+  public forceFlush(): Promise<void> {
     // no-op
     return Promise.resolve();
   }
@@ -54,7 +54,7 @@ export class BaggageLogRecordProcessor implements LogRecordProcessor {
    * @param logRecord the ReadWriteLogRecord that just emitted.
    * @param context the current Context, or an empty Context if the Logger was obtained with include_trace_context=false
    */
-  onEmit(logRecord: SdkLogRecord, context?: Context): void {
+  public onEmit(logRecord: SdkLogRecord, context?: Context): void {
     if (context) {
       (propagation.getBaggage(context)?.getAllEntries() ?? [])
         .filter(entry => this._keyPredicate(entry[0]))
@@ -66,7 +66,7 @@ export class BaggageLogRecordProcessor implements LogRecordProcessor {
    * Shuts down the processor. Called when SDK is shut down. This is an
    * opportunity for processor to do any cleanup required.
    */
-  shutdown(): Promise<void> {
+  public shutdown(): Promise<void> {
     // no-op
     return Promise.resolve();
   }

packages/baggage-span-processor/src/baggage-span-processor.ts

@@ -57,7 +57,7 @@ export class BaggageSpanProcessor implements SpanProcessor {
   /**
    * Forces to export all finished spans
    */
-  forceFlush(): Promise<void> {
+  public forceFlush(): Promise<void> {
     // no-op
     return Promise.resolve();
   }
@@ -67,7 +67,7 @@ export class BaggageSpanProcessor implements SpanProcessor {
    * returns true.
    * @param span the Span that just started.
    */
-  onStart(span: Span, parentContext: Context): void {
+  public onStart(span: Span, parentContext: Context): void {
     (propagation.getBaggage(parentContext)?.getAllEntries() ?? [])
       .filter(entry => this._keyPredicate(entry[0]))
       .forEach(entry => span.setAttribute(entry[0], entry[1].value));
@@ -78,15 +78,15 @@ export class BaggageSpanProcessor implements SpanProcessor {
    * returns true.
    * @param span the Span that just ended.
    */
-  onEnd(_: ReadableSpan): void {
+  public onEnd(_: ReadableSpan): void {
     // no-op
   }
 
   /**
    * Shuts down the processor. Called when SDK is shut down. This is an
    * opportunity for processor to do any cleanup required.
    */
-  shutdown(): Promise<void> {
+  public shutdown(): Promise<void> {
     // no-op
     return Promise.resolve();
   }

packages/contrib-test-utils/src/test-fixtures.ts

@@ -67,21 +67,21 @@ export type TestSpan = ISpan & {
  * There is little error checking here; we are assuming valid OTLP.
  */
 export class TestCollector {
-  endpointUrl?: string;
-  spans: Array<TestSpan> = [];
+  public endpointUrl?: string;
+  public spans: Array<TestSpan> = [];
   private _http;
 
   constructor() {
     this.clear();
     this._http = createServer(this._onRequest.bind(this));
   }
 
-  clear(): void {
+  public clear(): void {
     this.spans = [];
   }
 
   // Start listening and set address to `endpointUrl`.
-  async start(): Promise<void> {
+  public async start(): Promise<void> {
     return new Promise(resolve => {
       this._http.listen(() => {
         this.endpointUrl = `http://localhost:${
@@ -92,7 +92,7 @@ export class TestCollector {
     });
   }
 
-  close() {
+  public close() {
     this.endpointUrl = undefined;
     return this._http.close();
   }
@@ -106,7 +106,7 @@ export class TestCollector {
    * same, this attempts to get the correct ordering using `parentSpanId` -- a
    * parent span starts before any of its direct children. This isn't perfect.
    */
-  get sortedSpans(): Array<TestSpan> {
+  public get sortedSpans(): Array<TestSpan> {
     return this.spans.slice().sort((a, b) => {
       assert(typeof a.startTimeUnixNano === 'string');
       assert(typeof b.startTimeUnixNano === 'string');
@@ -132,7 +132,7 @@ export class TestCollector {
     });
   }
 
-  _onRequest(req: IncomingMessage, res: ServerResponse) {
+  private _onRequest(req: IncomingMessage, res: ServerResponse) {
     const parsedUrl = new URL(req.url as string, this.endpointUrl);
     let instream: EventEmitter;
     if (req.headers['content-encoding'] === 'gzip') {
@@ -171,7 +171,7 @@ export class TestCollector {
     });
   }
 
-  _ingestTraces(body: string) {
+  private _ingestTraces(body: string) {
     const data = JSON.parse(body);
     // Read an OTLP `resourceSpans` body into `this.spans`.
     for (const resourceSpan of data.resourceSpans) {

packages/host-metrics/src/metric.ts

@@ -334,7 +334,7 @@ export class HostMetrics extends BaseMetrics {
   /**
    * Starts collecting metrics
    */
-  start() {
+  public start() {
     this._createMetrics();
   }
 

packages/id-generator-aws-xray/src/platform/browser/AWSXRayIdGenerator.ts

@@ -32,15 +32,15 @@ export class AWSXRayIdGenerator implements IdGenerator {
    * characters corresponding to 128 bits. The first 4 bytes correspond to the current
    * time, in seconds, as per X-Ray trace ID format.
    */
-  generateTraceId(): string {
+  public generateTraceId(): string {
     return generateTraceId(generateRandomBytes);
   }
 
   /**
    * Returns a random 8-byte span ID formatted/encoded as a 16 lowercase hex
    * characters corresponding to 64 bits.
    */
-  generateSpanId(): string {
+  public generateSpanId(): string {
     return generateSpanId(generateRandomBytes);
   }
 }

packages/id-generator-aws-xray/src/platform/node/AWSXRayIdGenerator.ts

@@ -32,15 +32,15 @@ export class AWSXRayIdGenerator implements IdGenerator {
    * characters corresponding to 128 bits. The first 4 bytes correspond to the current
    * time, in seconds, as per X-Ray trace ID format.
    */
-  generateTraceId(): string {
+  public generateTraceId(): string {
     return generateTraceId(generateRandomBytes);
   }
 
   /**
    * Returns a random 8-byte span ID formatted/encoded as a 16 lowercase hex
    * characters corresponding to 64 bits.
    */
-  generateSpanId(): string {
+  public generateSpanId(): string {
     return generateSpanId(generateRandomBytes);
   }
 }

packages/plugin-react-load/src/BaseOpenTelemetryComponent.ts

@@ -36,8 +36,8 @@ import {
  * This class is the base component for a React component with lifecycle instrumentation
  */
 export class BaseOpenTelemetryComponent extends React.Component {
-  readonly component: string = 'react-load';
-  moduleName = this.component;
+  private readonly component: string = 'react-load';
+  private moduleName = this.component;
   private _parentSpanMap: WeakMap<React.Component, api.Span>;
   private static _tracer: api.Tracer;
   private static _logger: api.DiagLogger = api.diag;
@@ -56,7 +56,7 @@ export class BaseOpenTelemetryComponent extends React.Component {
    * @param name Name of tracer
    * @param version Version of tracer, this is optional. When not provided it will use the latest.
    */
-  static setTracer(name: string, version?: string): void {
+  public static setTracer(name: string, version?: string): void {
     BaseOpenTelemetryComponent._tracer = api.trace.getTracer(
       name,
       version ? version : PACKAGE_VERSION
@@ -67,7 +67,7 @@ export class BaseOpenTelemetryComponent extends React.Component {
    * Sets the logger for all components being instrumented
    * @param logger
    */
-  static setLogger(logger: api.DiagLogger): void {
+  public static setLogger(logger: api.DiagLogger): void {
     api.diag.setLogger(logger);
     BaseOpenTelemetryComponent._logger = logger;
   }

packages/propagator-aws-xray-lambda/src/AWSXRayLambdaPropagator.ts

@@ -40,11 +40,11 @@ export const AWSXRAY_TRACE_ID_ENV_VAR = '_X_AMZN_TRACE_ID';
 export class AWSXRayLambdaPropagator implements TextMapPropagator {
   private _awsXrayPropagator = new AWSXRayPropagator();
 
-  inject(context: Context, carrier: unknown, setter: TextMapSetter) {
+  public inject(context: Context, carrier: unknown, setter: TextMapSetter) {
     this._awsXrayPropagator.inject(context, carrier, setter);
   }
 
-  extract(context: Context, carrier: unknown, getter: TextMapGetter): Context {
+  public extract(context: Context, carrier: unknown, getter: TextMapGetter): Context {
     const xrayContext = this._awsXrayPropagator.extract(
       context,
       carrier,
@@ -68,7 +68,7 @@ export class AWSXRayLambdaPropagator implements TextMapPropagator {
     );
   }
 
-  fields(): string[] {
+  public fields(): string[] {
     return this._awsXrayPropagator.fields();
   }
 }

packages/propagator-aws-xray/src/AWSXRayPropagator.ts

@@ -58,7 +58,7 @@ const NOT_SAMPLED = '0';
  * X-Amzn-Trace-Id: Root=1-5759e988-bd862e3fe1be46a994272793;Parent=53995c3f42cd8ad8;Sampled=1
  */
 export class AWSXRayPropagator implements TextMapPropagator {
-  inject(context: Context, carrier: unknown, setter: TextMapSetter) {
+  public inject(context: Context, carrier: unknown, setter: TextMapSetter) {
     const spanContext = trace.getSpan(context)?.spanContext();
     if (!spanContext || !isSpanContextValid(spanContext)) return;
 
@@ -77,7 +77,7 @@ export class AWSXRayPropagator implements TextMapPropagator {
     setter.set(carrier, AWSXRAY_TRACE_ID_HEADER, traceHeader);
   }
 
-  extract(context: Context, carrier: unknown, getter: TextMapGetter): Context {
+  public extract(context: Context, carrier: unknown, getter: TextMapGetter): Context {
     const spanContext = this.getSpanContextFromHeader(carrier, getter);
     if (!isSpanContextValid(spanContext)) return context;
 
@@ -90,7 +90,7 @@ export class AWSXRayPropagator implements TextMapPropagator {
     return trace.setSpan(context, trace.wrapSpanContext(spanContext));
   }
 
-  fields(): string[] {
+  public fields(): string[] {
     return [AWSXRAY_TRACE_ID_HEADER];
   }