Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[EXTERNAL] Lock RateLimiter.shouldProceed() entirely to avoid race conditions (#4635) via @nguyenhuy #4637

Merged
merged 2 commits into from
Jan 8, 2025
+19 −16
Merged

[EXTERNAL] Lock RateLimiter.shouldProceed() entirely to avoid race conditions (#4635) via @nguyenhuy #4637

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
874c784
[EXTERNAL] Lock RateLimiter.shouldProceed() entirely to avoid race co…
nguyenhuy Jan 7, 2025
af0d2fc
Update Sources/Misc/RateLimiter.swift via @nguyenhuy
JayShortway Jan 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions RevenueCat.xcodeproj/project.pbxproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@
2C7457882CEDF7C0004ACE52 /* BackgroundStyle.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C7457872CEDF7AC004ACE52 /* BackgroundStyle.swift */; };
2C74578A2CEE314F004ACE52 /* Background.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C7457892CEE314C004ACE52 /* Background.swift */; };
2C7F0AD32B8EEB4600381179 /* RateLimiter.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C7F0AD22B8EEB4600381179 /* RateLimiter.swift */; };
2C7F0AD62B8EEF7B00381179 /* RateLimiterRests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C7F0AD42B8EEF0B00381179 /* RateLimiterRests.swift */; };
2C7F0AD62B8EEF7B00381179 /* RateLimiterTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C7F0AD42B8EEF0B00381179 /* RateLimiterTests.swift */; };
2C8EC6DB2CCC23B700D6CCF8 /* Template5Preview.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C8EC6DA2CCC23B700D6CCF8 /* Template5Preview.swift */; };
2C8EC6DD2CCC7C5B00D6CCF8 /* PackageValidator.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C8EC6DC2CCC7C5500D6CCF8 /* PackageValidator.swift */; };
2C8EC6DF2CCD27A500D6CCF8 /* PartialComponentTests.swift in Sources */ = {isa = PBXBuildFile; fileRef = 2C8EC6DE2CCD27A100D6CCF8 /* PartialComponentTests.swift */; };
Expand Down Expand Up @@ -1289,7 +1289,7 @@
2C7457872CEDF7AC004ACE52 /* BackgroundStyle.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = BackgroundStyle.swift; sourceTree = "<group>"; };
2C7457892CEE314C004ACE52 /* Background.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Background.swift; sourceTree = "<group>"; };
2C7F0AD22B8EEB4600381179 /* RateLimiter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RateLimiter.swift; sourceTree = "<group>"; };
2C7F0AD42B8EEF0B00381179 /* RateLimiterRests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RateLimiterRests.swift; sourceTree = "<group>"; };
2C7F0AD42B8EEF0B00381179 /* RateLimiterTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = RateLimiterTests.swift; sourceTree = "<group>"; };
2C8EC6AE2CCBD33E00D6CCF8 /* ButtonComponentTests.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = ButtonComponentTests.swift; sourceTree = "<group>"; };
2C8EC6DA2CCC23B700D6CCF8 /* Template5Preview.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = Template5Preview.swift; sourceTree = "<group>"; };
2C8EC6DC2CCC7C5500D6CCF8 /* PackageValidator.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = PackageValidator.swift; sourceTree = "<group>"; };
Expand Down Expand Up @@ -3514,7 +3514,7 @@
5712BE9129241F7900A83F15 /* TimingUtilTests.swift */,
4F8DDB682AAA9189000188F2 /* OperationDispatcherTests.swift */,
4FEF41AC2B4F301800CD699F /* MacAppStoreDetectorTests.swift */,
2C7F0AD42B8EEF0B00381179 /* RateLimiterRests.swift */,
2C7F0AD42B8EEF0B00381179 /* RateLimiterTests.swift */,
);
path = Misc;
sourceTree = "<group>";
Expand Down Expand Up @@ -6326,7 +6326,7 @@
1EFA950D2CDB6B6500CA5951 /* BackendPostRedeemWebPurchaseTests.swift in Sources */,
35C05DC82BC8510000109308 /* DiagnosticsTrackerTests.swift in Sources */,
35C272A12BC4084C005A0CE8 /* MockDiagnosticsTracker.swift in Sources */,
2C7F0AD62B8EEF7B00381179 /* RateLimiterRests.swift in Sources */,
2C7F0AD62B8EEF7B00381179 /* RateLimiterTests.swift in Sources */,
FDAADFCB2BE2A5BF00BD1659 /* MockAllTransactionsProvider.swift in Sources */,
356E2DE82CD3CF930055AABB /* StoredEventTests.swift in Sources */,
351B513F26D4496000BD2BD7 /* MockIdentityManager.swift in Sources */,
Expand Down
25 changes: 14 additions & 11 deletions Sources/Misc/RateLimiter.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@

import Foundation

internal class RateLimiter {
internal final class RateLimiter: @unchecked Sendable {
private let lock = Lock()
private var timestamps: [Date?]
private var index: Int = 0
private let maxCallsInclusive: Int
Expand All @@ -30,17 +31,19 @@ internal class RateLimiter {
}

func shouldProceed() -> Bool {
let now = Date()
let oldestIndex = (index + 1) % maxCallsInclusive
let oldestTimestamp = timestamps[oldestIndex]
return self.lock.perform {
let now = Date()
let oldestIndex = (index + 1) % maxCallsInclusive
let oldestTimestamp = timestamps[oldestIndex]

// Check if the oldest timestamp is outside the rate limiting period or if it's nil
if let oldestTimestamp = oldestTimestamp, now.timeIntervalSince(oldestTimestamp) <= period {
return false
} else {
timestamps[index] = now
index = oldestIndex
return true
// Check if the oldest timestamp is outside the rate limiting period or if it's nil
if let oldestTimestamp = oldestTimestamp, now.timeIntervalSince(oldestTimestamp) <= period {
return false
} else {
timestamps[index] = now
index = oldestIndex
return true
}
}
}
}
2 changes: 1 addition & 1 deletion Tests/UnitTests/Misc/RateLimiterRests.swift → Tests/UnitTests/Misc/RateLimiterTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
//
// https://opensource.org/licenses/MIT
//
// RateLimiterRests.swift
// RateLimiterTests.swift
//
// Created by Josh Holtz on 2/27/24.

Expand Down