RUM-7285 Add api-surface step to Lint stage

Author: mariedm

.gitlab-ci.yml

@@ -91,6 +91,17 @@ Lint:
     - make clean repo-setup ENV=ci
     - make lint license-check
     - make rum-models-verify sr-models-verify
+    - make api-surface ENV=ci
+    - if ! diff api-surface-swift api-surface-swift-generated; then
+        echo "❌ Swift API surface mismatch";
+        echo "👉 Run \`make api-surface\` locally to update \`api-surface-swift\` and commit the changes.";
+        exit 1;
+      fi
+    - if ! diff api-surface-objc api-surface-objc-generated; then
+        echo "❌ Objective-C API surface mismatch";
+        echo "👉 Run \`make api-surface\` locally to update \`api-surface-objc\` and commit the changes.";
+        exit 1;
+      fi
 
 Unit Tests (iOS):
   stage: test

Makefile

@@ -356,9 +356,21 @@ sr-snapshot-tests-open:
 	@$(ECHO_TITLE) "make sr-snapshot-tests-open"
 	./tools/sr-snapshot-test.sh --open-project
 
+# Define default paths for API output files
+SWIFT_OUTPUT_PATH ?= api-surface-swift
+OBJC_OUTPUT_PATH ?= api-surface-objc
+
+# Use different paths when running in CI
+ifeq ($(ENV),ci)
+  SWIFT_OUTPUT_PATH := api-surface-swift-generated
+  OBJC_OUTPUT_PATH := api-surface-objc-generated
+endif
+
 # Generate api-surface files for Datadog and DatadogObjc.
 api-surface:
+		@echo "ENV variable is set to: $(ENV)"
 		@echo "Generating api-surface-swift"
+		@echo "SWIFT_OUTPUT_PATH: $(SWIFT_OUTPUT_PATH)"
 		@cd tools/api-surface && \
 			swift run api-surface spm \
 			--path ../../ \
@@ -369,15 +381,16 @@ api-surface:
 			--library-name DatadogCrashReporting \
 			--library-name DatadogWebViewTracking \
 			--library-name DatadogSessionReplay \
-			> ../../api-surface-swift && \
+			> ../../$(SWIFT_OUTPUT_PATH) && \
 			cd -
 
 		@echo "Generating api-surface-objc"
+		@echo "OBJC_OUTPUT_PATH: $(OBJC_OUTPUT_PATH)"
 		@cd tools/api-surface && \
 			swift run api-surface spm \
 			--path ../../ \
 			--library-name DatadogObjc \
-			> ../../api-surface-objc && \
+			> ../../$(OBJC_OUTPUT_PATH) && \
 			cd -
 
 # Generate Datadog monitors terraform definition for E2E tests:

api-surface-swift

@@ -284,6 +284,24 @@ public struct SpanEvent: Encodable
     public let applicationVersion: String
     public let networkConnectionInfo: NetworkConnectionInfo?
     public let mobileCarrierInfo: CarrierInfo?
+    public struct DeviceInfo: Codable
+        public enum DeviceType: String, Codable
+            case mobile = "mobile"
+            case tablet = "tablet"
+            case tv = "tv"
+            case other = "other"
+        public let brand: String
+        public let name: String
+        public let model: String
+        public let architecture: String
+        public let type: DeviceType
+    public let deviceInfo: DeviceInfo
+    public struct OperatingSystemInfo: Codable
+        public let name: String
+        public let version: String
+        public let build: String?
+        public let versionMajor: String
+    public let osInfo: OperatingSystemInfo
     public struct UserInfo
         public let id: String?
         public let name: String?
@@ -2094,11 +2112,11 @@ public typealias WireframeID = NodeID
 public class SessionReplayWireframesBuilder
     public struct FontOverride
         public init(size: CGFloat?)
-    public func createShapeWireframe(id: WireframeID,frame: CGRect,clip: SRContentClip? = nil,borderColor: CGColor? = nil,borderWidth: CGFloat? = nil,backgroundColor: CGColor? = nil,cornerRadius: CGFloat? = nil,opacity: CGFloat? = nil) -> SRWireframe
-    public func createImageWireframe(id: WireframeID,resource: SessionReplayResource,frame: CGRect,mimeType: String = "png",clip: SRContentClip? = nil,borderColor: CGColor? = nil,borderWidth: CGFloat? = nil,backgroundColor: CGColor? = nil,cornerRadius: CGFloat? = nil,opacity: CGFloat? = nil) -> SRWireframe
-    public func createTextWireframe(id: WireframeID,frame: CGRect,text: String,textFrame: CGRect? = nil,textAlignment: SRTextPosition.Alignment? = nil,clip: SRContentClip? = nil,textColor: CGColor? = nil,font: UIFont? = nil,fontOverride: FontOverride? = nil,fontScalingEnabled: Bool = false,borderColor: CGColor? = nil,borderWidth: CGFloat? = nil,backgroundColor: CGColor? = nil,cornerRadius: CGFloat? = nil,opacity: CGFloat? = nil) -> SRWireframe
-    public func createPlaceholderWireframe(id: Int64,frame: CGRect,label: String,clip: SRContentClip? = nil) -> SRWireframe
-    public func visibleWebViewWireframe(id: Int,frame: CGRect,clip: SRContentClip? = nil,borderColor: CGColor? = nil,borderWidth: CGFloat? = nil,backgroundColor: CGColor? = nil,cornerRadius: CGFloat? = nil,opacity: CGFloat? = nil) -> SRWireframe
+    public func createShapeWireframe(id: WireframeID,frame: CGRect,clip: CGRect,borderColor: CGColor? = nil,borderWidth: CGFloat? = nil,backgroundColor: CGColor? = nil,cornerRadius: CGFloat? = nil,opacity: CGFloat? = nil) -> SRWireframe
+    public func createImageWireframe(id: WireframeID,resource: SessionReplayResource,frame: CGRect,clip: CGRect,mimeType: String = "png",borderColor: CGColor? = nil,borderWidth: CGFloat? = nil,backgroundColor: CGColor? = nil,cornerRadius: CGFloat? = nil,opacity: CGFloat? = nil) -> SRWireframe
+    public func createTextWireframe(id: WireframeID,frame: CGRect,clip: CGRect,text: String,textFrame: CGRect? = nil,textAlignment: SRTextPosition.Alignment? = nil,textColor: CGColor? = nil,font: UIFont? = nil,fontOverride: FontOverride? = nil,fontScalingEnabled: Bool = false,borderColor: CGColor? = nil,borderWidth: CGFloat? = nil,backgroundColor: CGColor? = nil,cornerRadius: CGFloat? = nil,opacity: CGFloat? = nil) -> SRWireframe
+    public func createPlaceholderWireframe(id: Int64,frame: CGRect,clip: CGRect,label: String) -> SRWireframe
+    public func visibleWebViewWireframe(id: Int,frame: CGRect,clip: CGRect,borderColor: CGColor? = nil,borderWidth: CGFloat? = nil,backgroundColor: CGColor? = nil,cornerRadius: CGFloat? = nil,opacity: CGFloat? = nil) -> SRWireframe
     public func hiddenWebViewWireframes() -> [SRWireframe]
 [?] extension SRContentClip
     public static func create(bottom: Int64?,left: Int64?,right: Int64?,top: Int64?) -> SRContentClip
@@ -2138,12 +2156,13 @@ public protocol SessionReplayResource
     func calculateIdentifier() -> String
     func calculateData() -> Data
 public struct SessionReplayViewAttributes: Equatable
-    public let frame: CGRect
-    public let backgroundColor: CGColor?
-    public let layerBorderColor: CGColor?
-    public let layerBorderWidth: CGFloat
-    public let layerCornerRadius: CGFloat
-    public let alpha: CGFloat
+    public internal(set) var frame: CGRect
+    public internal(set) var clip: CGRect
+    public internal(set) var backgroundColor: CGColor?
+    public internal(set) var layerBorderColor: CGColor?
+    public internal(set) var layerBorderWidth: CGFloat
+    public internal(set) var layerCornerRadius: CGFloat
+    public internal(set) var alpha: CGFloat
 public protocol SessionReplayNodeSemantics
     static var importance: Int
     var subtreeStrategy: SessionReplayNodeSubtreeStrategy