refactored InstrumentBuilder to make relevant builder function public (#722)

bryce-b · web-flow · commit e5c6a8ab2e32 · 2025-03-10T16:00:37.000-07:00
* refactored InstrumentBuilder to make relevant builder function public

* added tests and made some corrections to instrumentBuilder object
diff --git a/Sources/OpenTelemetrySdk/Metrics/Stable/DoubleCounterMeterBuilderSdk.swift b/Sources/OpenTelemetrySdk/Metrics/Stable/DoubleCounterMeterBuilderSdk.swift
@@ -6,31 +6,21 @@
 import Foundation
 import OpenTelemetryApi
 
-public class DoubleCounterMeterBuilderSdk: DoubleCounterBuilder, InstrumentBuilder {
-  var meterSharedState: StableMeterSharedState
-
-  var meterProviderSharedState: MeterProviderSharedState
-
-  let type: InstrumentType = .counter
-
-  let valueType: InstrumentValueType = .double
-
-  var instrumentName: String
-
-  var description: String
-
-  var unit: String
-
-  init(meterProviderSharedState: MeterProviderSharedState,
-       meterSharedState: StableMeterSharedState,
+public class DoubleCounterMeterBuilderSdk: InstrumentBuilder, DoubleCounterBuilder {
+  init(meterProviderSharedState: inout MeterProviderSharedState,
+       meterSharedState: inout StableMeterSharedState,
        name: String,
        description: String,
        unit: String) {
-    self.meterProviderSharedState = meterProviderSharedState
-    self.meterSharedState = meterSharedState
-    self.unit = unit
-    self.description = description
-    instrumentName = name
+    super.init(
+      meterProviderSharedState: &meterProviderSharedState,
+      meterSharedState: &meterSharedState,
+      type: .counter,
+      valueType: .double,
+      description: description,
+      unit: unit,
+      instrumentName: name
+    )
   }
 
   public func build() -> OpenTelemetryApi.DoubleCounter {
diff --git a/Sources/OpenTelemetrySdk/Metrics/Stable/DoubleGaugeBuilderSdk.swift b/Sources/OpenTelemetrySdk/Metrics/Stable/DoubleGaugeBuilderSdk.swift
@@ -6,25 +6,17 @@
 import Foundation
 import OpenTelemetryApi
 
-public class DoubleGaugeBuilderSdk: DoubleGaugeBuilder, InstrumentBuilder {
-  var meterProviderSharedState: MeterProviderSharedState
-
-  var meterSharedState: StableMeterSharedState
-
-  var type: InstrumentType = .observableGauge
-
-  var valueType: InstrumentValueType = .double
-
-  var description: String = ""
-
-  var unit: String = ""
-
-  var instrumentName: String
-
+public class DoubleGaugeBuilderSdk: InstrumentBuilder, DoubleGaugeBuilder {
   init(meterProviderSharedState: inout MeterProviderSharedState, meterSharedState: inout StableMeterSharedState, name: String) {
-    self.meterProviderSharedState = meterProviderSharedState
-    self.meterSharedState = meterSharedState
-    instrumentName = name
+    super.init(
+      meterProviderSharedState: &meterProviderSharedState,
+      meterSharedState: &meterSharedState,
+      type: .observableGauge,
+      valueType: .double,
+      description: "",
+      unit: "",
+      instrumentName: name
+    )
   }
 
   public func ofLongs() -> OpenTelemetryApi.LongGaugeBuilder {
diff --git a/Sources/OpenTelemetrySdk/Metrics/Stable/DoubleHistogramMeterBuilderSdk.swift b/Sources/OpenTelemetrySdk/Metrics/Stable/DoubleHistogramMeterBuilderSdk.swift
@@ -6,31 +6,21 @@
 import Foundation
 import OpenTelemetryApi
 
-public class DoubleHistogramMeterBuilderSdk: DoubleHistogramBuilder, InstrumentBuilder {
-  var meterProviderSharedState: MeterProviderSharedState
-
-  var meterSharedState: StableMeterSharedState
-
-  let type: InstrumentType = .histogram
-
-  let valueType: InstrumentValueType = .double
-
-  let instrumentName: String
-
-  var description: String
-
-  var unit: String
-
+public class DoubleHistogramMeterBuilderSdk: InstrumentBuilder, DoubleHistogramBuilder {
   init(meterProviderSharedState: inout MeterProviderSharedState,
        meterSharedState: inout StableMeterSharedState,
        name: String,
        description: String = "",
        unit: String = "") {
-    self.meterProviderSharedState = meterProviderSharedState
-    self.meterSharedState = meterSharedState
-    instrumentName = name
-    self.description = description
-    self.unit = unit
+    super.init(
+      meterProviderSharedState: &meterProviderSharedState,
+      meterSharedState: &meterSharedState,
+      type: .histogram,
+      valueType: .double,
+      description: description,
+      unit: unit,
+      instrumentName: name
+    )
   }
 
   public func ofLongs() -> OpenTelemetryApi.LongHistogramBuilder {
diff --git a/Sources/OpenTelemetrySdk/Metrics/Stable/DoubleUpDownCounterBuilderSdk.swift b/Sources/OpenTelemetrySdk/Metrics/Stable/DoubleUpDownCounterBuilderSdk.swift
@@ -6,31 +6,21 @@
 import Foundation
 import OpenTelemetryApi
 
-public class DoubleUpDownCounterBuilderSdk: DoubleUpDownCounterBuilder, InstrumentBuilder {
-  var meterSharedState: StableMeterSharedState
-
-  var meterProviderSharedState: MeterProviderSharedState
-
-  let type: InstrumentType = .upDownCounter
-
-  let valueType: InstrumentValueType = .double
-
-  var instrumentName: String
-
-  var description: String
-
-  var unit: String
-
-  init(meterProviderSharedState: MeterProviderSharedState,
-       meterSharedState: StableMeterSharedState,
+public class DoubleUpDownCounterBuilderSdk: InstrumentBuilder, DoubleUpDownCounterBuilder {
+  init(meterProviderSharedState: inout MeterProviderSharedState,
+       meterSharedState: inout StableMeterSharedState,
        name: String,
        description: String,
        unit: String) {
-    self.meterProviderSharedState = meterProviderSharedState
-    self.meterSharedState = meterSharedState
-    self.unit = unit
-    self.description = description
-    instrumentName = name
+    super.init(
+      meterProviderSharedState: &meterProviderSharedState,
+      meterSharedState: &meterSharedState,
+      type: .upDownCounter,
+      valueType: .double,
+      description: description,
+      unit: unit,
+      instrumentName: name
+    )
   }
 
   public func build() -> OpenTelemetryApi.DoubleUpDownCounter {
diff --git a/Sources/OpenTelemetrySdk/Metrics/Stable/InstrumentBuilder.swift b/Sources/OpenTelemetrySdk/Metrics/Stable/InstrumentBuilder.swift
@@ -6,40 +6,49 @@
 import Foundation
 import OpenTelemetryApi
 
-protocol InstrumentBuilder: AnyObject {
-  var meterProviderSharedState: MeterProviderSharedState { get }
-  var meterSharedState: StableMeterSharedState { get set }
-  var type: InstrumentType { get }
-  var valueType: InstrumentValueType { get }
-  var description: String { get set }
-  var unit: String { get set }
-  var instrumentName: String { get }
+public class InstrumentBuilder {
+  private var meterProviderSharedState: MeterProviderSharedState
+  private var meterSharedState: StableMeterSharedState
+  internal var type: InstrumentType
+  internal var valueType: InstrumentValueType
+  internal var description: String
+  internal var unit: String
+  internal var instrumentName: String
+  internal init(meterProviderSharedState: inout MeterProviderSharedState, meterSharedState: inout StableMeterSharedState, type: InstrumentType, valueType: InstrumentValueType, description: String, unit: String, instrumentName: String) {
+    self.meterProviderSharedState = meterProviderSharedState
+    self.meterSharedState = meterSharedState
+    self.type = type
+    self.valueType = valueType
+    self.description = description
+    self.unit = unit
+    self.instrumentName = instrumentName
+  }
 }
 
-extension InstrumentBuilder {
-  public func setUnit(_ units: String) -> Self {
+public extension InstrumentBuilder {
+  func setUnit(_ units: String) -> Self {
     // todo : validate unit
-    unit = unit
+    unit = units
     return self
   }
 
-  public func setDescription(_ description: String) -> Self {
+  func setDescription(_ description: String) -> Self {
     self.description = description
     return self
   }
 
-  func swapBuilder<T: InstrumentBuilder>(_ builder: (MeterProviderSharedState, StableMeterSharedState, String, String, String) -> T) -> T {
-    return builder(meterProviderSharedState, meterSharedState, instrumentName, description, unit)
+  internal func swapBuilder<T: InstrumentBuilder>(_ builder: (inout MeterProviderSharedState, inout StableMeterSharedState, String, String, String) -> T) -> T {
+    return builder(&meterProviderSharedState, &meterSharedState, instrumentName, description, unit)
   }
 
   // todo : Is it necessary to use inout for writableMetricStorage?
-  public func buildSynchronousInstrument<T: Instrument>(_ instrumentFactory: (InstrumentDescriptor, WritableMetricStorage) -> T) -> T {
+  func buildSynchronousInstrument<T: Instrument>(_ instrumentFactory: (InstrumentDescriptor, WritableMetricStorage) -> T) -> T {
     let descriptor = InstrumentDescriptor(name: instrumentName, description: description, unit: unit, type: type, valueType: valueType)
     let storage = meterSharedState.registerSynchronousMetricStorage(instrument: descriptor, meterProviderSharedState: meterProviderSharedState)
     return instrumentFactory(descriptor, storage)
   }
 
-  public func registerDoubleAsynchronousInstrument(type: InstrumentType, updater: @escaping (ObservableDoubleMeasurement) -> Void) -> ObservableInstrumentSdk {
+  func registerDoubleAsynchronousInstrument(type: InstrumentType, updater: @escaping (ObservableDoubleMeasurement) -> Void) -> ObservableInstrumentSdk {
     let sdkObservableMeasurement = buildObservableMeasurement(type: type)
     let callbackRegistration = CallbackRegistration(observableMeasurements: [sdkObservableMeasurement]) {
       updater(sdkObservableMeasurement)
@@ -48,7 +57,7 @@ extension InstrumentBuilder {
     return ObservableInstrumentSdk(meterSharedState: meterSharedState, callbackRegistration: callbackRegistration)
   }
 
-  public func registerLongAsynchronousInstrument(type: InstrumentType, updater: @escaping (ObservableLongMeasurement) -> Void) -> ObservableInstrumentSdk {
+  func registerLongAsynchronousInstrument(type: InstrumentType, updater: @escaping (ObservableLongMeasurement) -> Void) -> ObservableInstrumentSdk {
     let sdkObservableMeasurement = buildObservableMeasurement(type: type)
     let callbackRegistration = CallbackRegistration(observableMeasurements: [sdkObservableMeasurement], callback: {
       updater(sdkObservableMeasurement)
@@ -57,7 +66,7 @@ extension InstrumentBuilder {
     return ObservableInstrumentSdk(meterSharedState: meterSharedState, callbackRegistration: callbackRegistration)
   }
 
-  public func buildObservableMeasurement(type: InstrumentType) -> StableObservableMeasurementSdk {
+  func buildObservableMeasurement(type: InstrumentType) -> StableObservableMeasurementSdk {
     let descriptor = InstrumentDescriptor(name: instrumentName, description: description, unit: unit, type: type, valueType: valueType)
     return meterSharedState.registerObservableMeasurement(instrumentDescriptor: descriptor)
   }
diff --git a/Sources/OpenTelemetrySdk/Metrics/Stable/LongCounterMeterBuilderSdk.swift b/Sources/OpenTelemetrySdk/Metrics/Stable/LongCounterMeterBuilderSdk.swift
@@ -6,27 +6,19 @@
 import Foundation
 import OpenTelemetryApi
 
-public class LongCounterMeterBuilderSdk: LongCounterBuilder, InstrumentBuilder {
-  var meterProviderSharedState: MeterProviderSharedState
-
-  var meterSharedState: StableMeterSharedState
-
-  let type: InstrumentType = .counter
-
-  let valueType: InstrumentValueType = .long
-
-  var instrumentName: String
-
-  var description: String = ""
-
-  var unit: String = ""
-
+public class LongCounterMeterBuilderSdk: InstrumentBuilder, LongCounterBuilder {
   init(meterProviderSharedState: inout MeterProviderSharedState,
        meterSharedState: inout StableMeterSharedState,
        name: String) {
-    self.meterProviderSharedState = meterProviderSharedState
-    self.meterSharedState = meterSharedState
-    instrumentName = name
+    super.init(
+      meterProviderSharedState: &meterProviderSharedState,
+      meterSharedState: &meterSharedState,
+      type: .counter,
+      valueType: .long,
+      description: "",
+      unit: "",
+      instrumentName: name
+    )
   }
 
   public func ofDoubles() -> OpenTelemetryApi.DoubleCounterBuilder {
diff --git a/Sources/OpenTelemetrySdk/Metrics/Stable/LongGaugeBuilderSdk.swift b/Sources/OpenTelemetrySdk/Metrics/Stable/LongGaugeBuilderSdk.swift
@@ -6,27 +6,17 @@
 import Foundation
 import OpenTelemetryApi
 
-public class LongGaugeBuilderSdk: LongGaugeBuilder, InstrumentBuilder {
-  var meterProviderSharedState: MeterProviderSharedState
-
-  var meterSharedState: StableMeterSharedState
-
-  var type: InstrumentType = .observableGauge
-
-  var valueType: InstrumentValueType = .long
-
-  var description: String = ""
-
-  var unit: String = ""
-
-  var instrumentName: String
-
-  init(meterProviderSharedState: MeterProviderSharedState, meterSharedState: StableMeterSharedState, name: String, description: String, unit: String) {
-    instrumentName = name
-    self.unit = unit
-    self.description = description
-    self.meterSharedState = meterSharedState
-    self.meterProviderSharedState = meterProviderSharedState
+public class LongGaugeBuilderSdk: InstrumentBuilder, LongGaugeBuilder {
+  init(meterProviderSharedState: inout MeterProviderSharedState, meterSharedState: inout StableMeterSharedState, name: String, description: String, unit: String) {
+    super.init(
+      meterProviderSharedState: &meterProviderSharedState,
+      meterSharedState: &meterSharedState,
+      type: .observableGauge,
+      valueType: .long,
+      description: description,
+      unit: unit,
+      instrumentName: name
+    )
   }
 
   public func build() -> OpenTelemetryApi.LongGauge {
diff --git a/Sources/OpenTelemetrySdk/Metrics/Stable/LongHistogramMeterBuilderSdk.swift b/Sources/OpenTelemetrySdk/Metrics/Stable/LongHistogramMeterBuilderSdk.swift
@@ -6,31 +6,21 @@
 import Foundation
 import OpenTelemetryApi
 
-public class LongHistogramMeterBuilderSdk: LongHistogramBuilder, InstrumentBuilder {
-  var meterProviderSharedState: MeterProviderSharedState
-
-  var meterSharedState: StableMeterSharedState
-
-  let type: InstrumentType = .histogram
-
-  let valueType: InstrumentValueType = .long
-
-  var description: String
-
-  var unit: String
-
-  var instrumentName: String
-
-  init(meterProviderSharedState: MeterProviderSharedState,
-       meterSharedState: StableMeterSharedState,
+public class LongHistogramMeterBuilderSdk: InstrumentBuilder, LongHistogramBuilder {
+  init(meterProviderSharedState: inout MeterProviderSharedState,
+       meterSharedState: inout StableMeterSharedState,
        instrumentName: String,
        description: String,
        unit: String) {
-    self.meterProviderSharedState = meterProviderSharedState
-    self.meterSharedState = meterSharedState
-    self.instrumentName = instrumentName
-    self.description = description
-    self.unit = unit
+    super.init(
+      meterProviderSharedState: &meterProviderSharedState,
+      meterSharedState: &meterSharedState,
+      type: .histogram,
+      valueType: .long,
+      description: description,
+      unit: unit,
+      instrumentName: instrumentName
+    )
   }
 
   public func build() -> OpenTelemetryApi.LongHistogram {
diff --git a/Sources/OpenTelemetrySdk/Metrics/Stable/LongUpDownCounterBuilderSdk.swift b/Sources/OpenTelemetrySdk/Metrics/Stable/LongUpDownCounterBuilderSdk.swift
diff --git a/Tests/OpenTelemetrySdkTests/Metrics/StableMetrics/BuilderTests.swift b/Tests/OpenTelemetrySdkTests/Metrics/StableMetrics/BuilderTests.swift
