Skip to content

Commit 47601cd

Browse files
phantumcodephantumcode
authored
chore(analytics): resolve swiftformat errors and warnings (#3844)
* chore(analytics): resolve swiftformat errors and warnings * chore(analytics): resolve swiftformat errors and warnings * resolve review comments * fix build errors
1 parent 4e0fb7c commit 47601cd

File tree

78 files changed

+1281
-897
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

78 files changed

+1281
-897
lines changed

‎AmplifyPlugins/Analytics/Sources/AWSPinpointAnalyticsPlugin/AWSPinpointAnalyticsPlugin+ClientBehavior.swift

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ import AWSPinpoint
1010
import Foundation
1111
@_spi(InternalAWSPinpoint) import InternalAWSPinpoint
1212

13-
extension AWSPinpointAnalyticsPlugin {
14-
public func identifyUser(userId: String, userProfile: AnalyticsUserProfile?) {
13+
public extension AWSPinpointAnalyticsPlugin {
14+
func identifyUser(userId: String, userProfile: AnalyticsUserProfile?) {
1515
if !isEnabled {
1616
log.warn("Cannot identify user. Analytics is disabled. Call Amplify.Analytics.enable() to enable")
1717
return
@@ -20,20 +20,22 @@ extension AWSPinpointAnalyticsPlugin {
2020
Task {
2121
var currentEndpointProfile = await pinpoint.currentEndpointProfile()
2222
currentEndpointProfile.addUserId(userId)
23-
if let userProfile = userProfile {
23+
if let userProfile {
2424
currentEndpointProfile.addUserProfile(userProfile)
2525
}
2626
do {
27-
try await pinpoint.updateEndpoint(with: currentEndpointProfile,
28-
source: .analytics)
27+
try await pinpoint.updateEndpoint(
28+
with: currentEndpointProfile,
29+
source: .analytics
30+
)
2931
Amplify.Hub.dispatchIdentifyUser(userId, userProfile: userProfile)
3032
} catch {
3133
Amplify.Hub.dispatchIdentifyUser(AnalyticsErrorHelper.getDefaultError(error))
3234
}
3335
}
3436
}
3537

36-
public func record(event: AnalyticsEvent) {
38+
func record(event: AnalyticsEvent) {
3739
if !isEnabled {
3840
log.warn("Cannot record events. Analytics is disabled. Call Amplify.Analytics.enable() to enable")
3941
return
@@ -55,12 +57,12 @@ extension AWSPinpointAnalyticsPlugin {
5557
}
5658
}
5759

58-
public func record(eventWithName eventName: String) {
60+
func record(eventWithName eventName: String) {
5961
let event = BasicAnalyticsEvent(name: eventName)
6062
record(event: event)
6163
}
6264

63-
public func registerGlobalProperties(_ properties: [String: AnalyticsPropertyValue]) {
65+
func registerGlobalProperties(_ properties: [String: AnalyticsPropertyValue]) {
6466
// TODO: check if there is a limit on total number of properties
6567
properties.forEach { key, _ in
6668
guard key.count >= 1, key.count <= 50 else {
@@ -75,13 +77,13 @@ extension AWSPinpointAnalyticsPlugin {
7577
}
7678
}
7779

78-
public func unregisterGlobalProperties(_ keys: Set<String>?) {
80+
func unregisterGlobalProperties(_ keys: Set<String>?) {
7981
Task {
8082
await unregisterGlobalProperties(keys)
8183
}
8284
}
8385

84-
public func flushEvents() {
86+
func flushEvents() {
8587
if !isEnabled {
8688
log.warn("Cannot flushEvents. Analytics is disabled. Call Amplify.Analytics.enable() to enable")
8789
return
@@ -105,18 +107,18 @@ extension AWSPinpointAnalyticsPlugin {
105107
}
106108
}
107109

108-
public func enable() {
110+
func enable() {
109111
isEnabled = true
110112
}
111113

112-
public func disable() {
114+
func disable() {
113115
isEnabled = false
114116
}
115117

116118
/// Retrieve the escape hatch to perform actions directly on PinpointClient.
117119
///
118120
/// - Returns: PinpointClientProtocol instance
119-
public func getEscapeHatch() -> PinpointClientProtocol {
121+
func getEscapeHatch() -> PinpointClientProtocol {
120122
pinpoint.pinpointClient
121123
}
122124

@@ -128,7 +130,7 @@ extension AWSPinpointAnalyticsPlugin {
128130
}
129131

130132
private func unregisterGlobalProperties(_ keys: Set<String>?) async {
131-
guard let keys = keys else {
133+
guard let keys else {
132134
for (key, value) in globalProperties {
133135
await pinpoint.removeGlobalProperty(value, forKey: key)
134136
}

‎AmplifyPlugins/Analytics/Sources/AWSPinpointAnalyticsPlugin/AWSPinpointAnalyticsPlugin+Configure.swift

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ import Foundation
1111
@_spi(InternalAWSPinpoint) import InternalAWSPinpoint
1212
import Network
1313

14-
extension AWSPinpointAnalyticsPlugin {
14+
public extension AWSPinpointAnalyticsPlugin {
1515
/// Configures AWSPinpointAnalyticsPlugin with the specified configuration.
1616
///
1717
/// This method will be invoked as part of the Amplify configuration flow.
1818
///
1919
/// - Parameter configuration: The configuration specified for this plugin
2020
/// - Throws:
2121
/// - PluginError.pluginConfigurationError: If one of the configuration values is invalid or empty
22-
public func configure(using configuration: Any?) throws {
22+
func configure(using configuration: Any?) throws {
2323
let pluginConfiguration: AWSPinpointAnalyticsPluginConfiguration
2424
if let config = configuration as? AmplifyOutputsData {
2525
print(config)
@@ -45,7 +45,7 @@ extension AWSPinpointAnalyticsPlugin {
4545
}
4646

4747
/// Configure AWSPinpointAnalyticsPlugin programatically using AWSPinpointAnalyticsPluginConfiguration
48-
public func configure(using configuration: AWSPinpointAnalyticsPluginConfiguration) throws {
48+
func configure(using configuration: AWSPinpointAnalyticsPluginConfiguration) throws {
4949
let pinpoint = try AWSPinpointFactory.sharedPinpoint(
5050
appId: configuration.appId,
5151
region: configuration.region
@@ -82,10 +82,12 @@ extension AWSPinpointAnalyticsPlugin {
8282
// MARK: Internal
8383

8484
/// Internal configure method to set the properties of the plugin
85-
func configure(pinpoint: AWSPinpointBehavior,
86-
networkMonitor: NetworkMonitor,
87-
globalProperties: AtomicDictionary<String, AnalyticsPropertyValue> = [:],
88-
isEnabled: Bool = true) {
85+
internal func configure(
86+
pinpoint: AWSPinpointBehavior,
87+
networkMonitor: NetworkMonitor,
88+
globalProperties: AtomicDictionary<String, AnalyticsPropertyValue> = [:],
89+
isEnabled: Bool = true
90+
) {
8991
self.pinpoint = pinpoint
9092
self.networkMonitor = networkMonitor
9193
self.globalProperties = globalProperties

‎AmplifyPlugins/Analytics/Sources/AWSPinpointAnalyticsPlugin/AWSPinpointAnalyticsPlugin+Options.swift

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,23 +7,27 @@
77

88
import Foundation
99

10-
extension AWSPinpointAnalyticsPlugin {
11-
public struct Options {
10+
public extension AWSPinpointAnalyticsPlugin {
11+
struct Options {
1212
static let defaultAutoFlushEventsInterval: TimeInterval = 60
1313
static let defaultTrackAppSession = true
1414

1515
public let autoFlushEventsInterval: TimeInterval
1616
public let trackAppSessions: Bool
1717

1818
#if os(macOS)
19-
public init(autoFlushEventsInterval: TimeInterval = 60,
20-
trackAppSessions: Bool = true) {
19+
public init(
20+
autoFlushEventsInterval: TimeInterval = 60,
21+
trackAppSessions: Bool = true
22+
) {
2123
self.autoFlushEventsInterval = autoFlushEventsInterval
2224
self.trackAppSessions = trackAppSessions
2325
}
2426
#else
25-
public init(autoFlushEventsInterval: TimeInterval = 60,
26-
trackAppSessions: Bool = true) {
27+
public init(
28+
autoFlushEventsInterval: TimeInterval = 60,
29+
trackAppSessions: Bool = true
30+
) {
2731
self.autoFlushEventsInterval = autoFlushEventsInterval
2832
self.trackAppSessions = trackAppSessions
2933
}

‎AmplifyPlugins/Analytics/Sources/AWSPinpointAnalyticsPlugin/AWSPinpointAnalyticsPlugin+Reset.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,9 @@ import Amplify
99
import Foundation
1010
@_spi(InternalAWSPinpoint) import InternalAWSPinpoint
1111

12-
extension AWSPinpointAnalyticsPlugin {
12+
public extension AWSPinpointAnalyticsPlugin {
1313
/// Resets the state of the plugin
14-
public func reset() async {
14+
func reset() async {
1515
if pinpoint != nil {
1616
pinpoint = nil
1717
}

‎AmplifyPlugins/Analytics/Sources/AWSPinpointAnalyticsPlugin/Configuration/AWSPinpointAnalyticsPluginConfiguration.swift

Lines changed: 29 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@
66
//
77

88
@_spi(InternalAmplifyConfiguration) import Amplify
9-
import AWSPinpoint
109
import AWSClientRuntime
10+
import AWSPinpoint
1111
import Foundation
1212
@_spi(InternalAWSPinpoint) import InternalAWSPinpoint
1313

@@ -58,9 +58,11 @@ public struct AWSPinpointAnalyticsPluginConfiguration {
5858
if let options {
5959
configOptions = options
6060
} else {
61-
configOptions = .init(
62-
autoFlushEventsInterval: try Self.getAutoFlushEventsInterval(configObject),
63-
trackAppSessions: try Self.getTrackAppSessions(configObject))
61+
configOptions = try .init(
62+
autoFlushEventsInterval: Self.getAutoFlushEventsInterval(configObject),
63+
trackAppSessions: Self.getTrackAppSessions(configObject)
64+
)
65+
6466
}
6567
let autoSessionTrackingInterval = try Self.getAutoSessionTrackingInterval(configObject)
6668

@@ -71,14 +73,18 @@ public struct AWSPinpointAnalyticsPluginConfiguration {
7173
Self.logger.warn("Having different regions for Analytics and Targeting operations is not supported. The Analytics region will be used.")
7274
}
7375

74-
self.init(appId: pluginConfiguration.appId,
75-
region: pluginConfiguration.region,
76-
autoSessionTrackingInterval: autoSessionTrackingInterval,
77-
options: configOptions)
76+
self.init(
77+
appId: pluginConfiguration.appId,
78+
region: pluginConfiguration.region,
79+
autoSessionTrackingInterval: autoSessionTrackingInterval,
80+
options: configOptions
81+
)
7882
}
7983

80-
init(_ configuration: AmplifyOutputsData,
81-
options: AWSPinpointAnalyticsPlugin.Options) throws {
84+
init(
85+
_ configuration: AmplifyOutputsData,
86+
options: AWSPinpointAnalyticsPlugin.Options
87+
) throws {
8288
guard let analyticsConfig = configuration.analytics else {
8389
throw PluginError.pluginConfigurationError(
8490
AnalyticsPluginErrorConstant.missingAnalyticsCategoryConfiguration.errorDescription,
@@ -93,16 +99,20 @@ public struct AWSPinpointAnalyticsPluginConfiguration {
9399
)
94100
}
95101

96-
self.init(appId: pinpointAnalyticsConfig.appId,
97-
region: pinpointAnalyticsConfig.awsRegion,
98-
autoSessionTrackingInterval: Self.defaultAutoSessionTrackingInterval,
99-
options: options)
102+
self.init(
103+
appId: pinpointAnalyticsConfig.appId,
104+
region: pinpointAnalyticsConfig.awsRegion,
105+
autoSessionTrackingInterval: Self.defaultAutoSessionTrackingInterval,
106+
options: options
107+
)
100108
}
101109

102-
init(appId: String,
103-
region: String,
104-
autoSessionTrackingInterval: TimeInterval,
105-
options: AWSPinpointAnalyticsPlugin.Options) {
110+
init(
111+
appId: String,
112+
region: String,
113+
autoSessionTrackingInterval: TimeInterval,
114+
options: AWSPinpointAnalyticsPlugin.Options
115+
) {
106116
self.appId = appId
107117
self.region = region
108118
self.autoSessionTrackingInterval = autoSessionTrackingInterval
@@ -148,7 +158,7 @@ public struct AWSPinpointAnalyticsPluginConfiguration {
148158

149159
private static func getAutoSessionTrackingInterval(_ configuration: [String: JSONValue]) throws -> TimeInterval {
150160
guard let autoSessionTrackingInterval = configuration[autoSessionTrackingIntervalKey] else {
151-
return Self.defaultAutoSessionTrackingInterval
161+
return defaultAutoSessionTrackingInterval
152162
}
153163

154164
guard case let .number(autoSessionTrackingIntervalValue) = autoSessionTrackingInterval else {

‎AmplifyPlugins/Analytics/Sources/AWSPinpointAnalyticsPlugin/Support/Constants/AnalyticsErrorConstants.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ import Foundation
1010

1111
typealias AnalyticsPluginErrorString = (errorDescription: ErrorDescription, recoverySuggestion: RecoverySuggestion)
1212

13-
struct AnalyticsPluginErrorConstant {
13+
enum AnalyticsPluginErrorConstant {
1414
static let decodeConfigurationError: AnalyticsPluginErrorString = (
1515
"Unable to decode configuration",
1616
"Make sure the plugin configuration is JSONValue"

‎AmplifyPlugins/Analytics/Sources/AWSPinpointAnalyticsPlugin/Support/Extensions/AWSPinpointAnalyticsPlugin+HubCategory.swift

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,10 @@ import Foundation
1111

1212
extension HubCategory {
1313
func dispatchIdentifyUser(_ identityId: String, userProfile: AnalyticsUserProfile?) {
14-
let payload = HubPayload(eventName: HubPayload.EventName.Analytics.identifyUser,
15-
data: (identityId, userProfile))
14+
let payload = HubPayload(
15+
eventName: HubPayload.EventName.Analytics.identifyUser,
16+
data: (identityId, userProfile)
17+
)
1618
dispatch(to: .analytics, payload: payload)
1719
}
1820

‎AmplifyPlugins/Analytics/Sources/AWSPinpointAnalyticsPlugin/Support/Extensions/PinpointEvent+AnalyticsEvent.swift

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ import Amplify
99
import Foundation
1010
@_spi(InternalAWSPinpoint) import InternalAWSPinpoint
1111

12-
extension PinpointEvent {
13-
public func asAnalyticsEvent() -> AnalyticsEvent {
12+
public extension PinpointEvent {
13+
func asAnalyticsEvent() -> AnalyticsEvent {
1414
var properties: AnalyticsProperties = [:]
1515

1616
for attribute in attributes {
@@ -21,12 +21,14 @@ extension PinpointEvent {
2121
properties[metric.key] = metric.value
2222
}
2323

24-
return BasicAnalyticsEvent(name: eventType,
25-
properties: properties)
24+
return BasicAnalyticsEvent(
25+
name: eventType,
26+
properties: properties
27+
)
2628
}
2729
}
2830

29-
extension Array where Element == PinpointEvent {
31+
extension [PinpointEvent] {
3032
func asAnalyticsEventArray() -> [AnalyticsEvent] {
3133
map { $0.asAnalyticsEvent() }
3234
}

‎AmplifyPlugins/Analytics/Sources/AWSPinpointAnalyticsPlugin/Support/Utils/AWSPinpoint+AnalyticsErrorConvertible.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,10 @@
55
// SPDX-License-Identifier: Apache-2.0
66
//
77

8-
import Foundation
98
import Amplify
109
import AWSPinpoint
1110
import ClientRuntime
11+
import Foundation
1212

1313
extension AWSPinpoint.BadRequestException: AnalyticsErrorConvertible {
1414
var analyticsError: AnalyticsError {

‎AmplifyPlugins/Analytics/Sources/AWSPinpointAnalyticsPlugin/Support/Utils/AnalyticsErrorConvertible.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@
55
// SPDX-License-Identifier: Apache-2.0
66
//
77

8-
import Foundation
98
import Amplify
9+
import Foundation
1010

1111
protocol AnalyticsErrorConvertible {
1212
var analyticsError: AnalyticsError { get }

0 commit comments

Comments
 (0)