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

Version 2.0.5 #70

Merged
merged 5 commits into from
Jul 3, 2024
Merged

Version 2.0.5 #70

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
f550d32
Ensure that callbacks won't capture self strongly
stelabouras Jul 3, 2024
a954a79
Ensure Designed for iPhone/iPad apps use the proper device name
stelabouras Jul 3, 2024
486c500
Disclose that completion handlers are called from background threads
stelabouras Jul 3, 2024
87e1568
Resolve cache update issues after fetch translations
stelabouras Jul 3, 2024
eabf479
Bump version to 2.0.5
stelabouras Jul 3, 2024
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
9 changes: 9 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,12 @@ logic now normalizes the locale name to match the format that iOS accepts.
*June 21, 2024*

- Updates minimum supported OS versions.

## Transifex iOS SDK 2.0.5

*July 3, 2024*

* Ensures that callbacks won't capture `self` strongly.
* Ensures Designed for iPhone/iPad apps use the proper device name.
* Discloses that completion handlers are called from background threads.
* Improves cache update after a `fetchTranslations` call.
207 changes: 103 additions & 104 deletions Sources/Transifex/CDSHandler.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -119,94 +119,6 @@ TXPushConfiguration(purge: \(purge), overrideTags: \(overrideTags), overrideOccu
}
}

/// Handles the logic of a pull HTTP request to CDS for a certain locale code
class CDSPullRequest {
let code : String
let request : URLRequest
let session : URLSession

private var retryCount = 0

struct RequestData : Codable {
var data: TXLocaleStrings
}

init(with request : URLRequest, code : String, session : URLSession) {
self.code = code
self.request = request
self.session = session
}

/// Performs the request to CDS and offers a completion handler when the request succeeds or fails.
///
/// - Parameter completionHandler: The completion handler that includes the locale code,
/// the extracted LocaleStrings structure from the server response and the error object when the
/// request fails
func perform(with completionHandler: @escaping (String,
TXLocaleStrings?,
TXCDSError?) -> Void) {
session.dataTask(with: request) { (data, response, error) in
guard error == nil else {
completionHandler(self.code,
nil,
.requestFailed(error: error!))
return
}

guard let httpResponse = response as? HTTPURLResponse else {
completionHandler(self.code,
nil,
.invalidHTTPResponse)
return
}

let statusCode = httpResponse.statusCode

switch statusCode {

case CDSHandler.HTTP_STATUS_CODE_OK:
if let data = data {
let decoder = JSONDecoder()

do {
let request = try decoder.decode(RequestData.self,
from: data)
completionHandler(self.code,
request.data,
nil)
}
catch {
completionHandler(self.code,
nil,
.requestFailed(error: error))
}
}
else {
completionHandler(self.code,
nil,
.nonParsableResponse)
}
case CDSHandler.HTTP_STATUS_CODE_ACCEPTED:
Logger.info("Received 202 response while fetching locale: \(self.code)")

if self.retryCount < CDSHandler.MAX_RETRIES {
self.retryCount += 1
self.perform(with: completionHandler)
}
else {
completionHandler(self.code,
nil,
.maxRetriesReached)
}
default:
completionHandler(self.code,
nil,
.serverError(statusCode: statusCode))
}
}.resume()
}
}

/// The struct used to configure the communication with CDS, passed into the CDSHander initializer.
struct CDSConfiguration {
/// A list of locale codes for the configured languages in the application
Expand Down Expand Up @@ -326,7 +238,13 @@ class CDSHandler {
case completed
case failed
}


private struct RequestData : Codable {
var data: TXLocaleStrings
}

private typealias CDSPullRequestResult = Result<TXLocaleStrings, TXCDSError>

/// The url session to be used for the requests to the CDS, defaults to an ephemeral URLSession with
/// a disabled URL cache.
let session: URLSession
Expand Down Expand Up @@ -404,24 +322,28 @@ class CDSHandler {
}

var requestsFinished = 0
let totalRequests = requestsByLocale.count
var translationsByLocale: TXTranslations = [:]
var errors: [Error] = []

for (code, requestByLocale) in requestsByLocale {
let cdsRequest = CDSPullRequest(with: requestByLocale,
code: code,
session: self.session)
cdsRequest.perform { (code, localeStrings, error) in
requestsFinished += 1

if let error = error {
errors.append(error)
performFetch(retryCount: 0,
code: code,
request: requestByLocale) { [weak self] result in
guard let _ = self else {
return
}
else {

requestsFinished += 1

switch result {
case .success(let localeStrings):
translationsByLocale[code] = localeStrings
case .failure(let error):
errors.append(error)
}
if requestsFinished == requestsByLocale.count {

if requestsFinished == totalRequests {
completionHandler(translationsByLocale, errors)
}
}
Expand All @@ -446,7 +368,10 @@ class CDSHandler {
request.httpMethod = "POST"
request.allHTTPHeaderFields = getHeaders(withSecret: true)

session.dataTask(with: request) { (data, response, error) in
session.dataTask(with: request) { [weak self] (data, response, error) in
guard let _ = self else {
return
}
guard error == nil else {
Logger.error("Error invalidating CDS cache: \(error!)")
completionHandler(false)
Expand Down Expand Up @@ -523,6 +448,71 @@ class CDSHandler {
}
}

// MARK: - Private

/// Performs the fetch (pull) request to CDS and offers a completion handler when the request succeeds
/// or fails, with the associated Result type (CDSPullRequestResult).
///
/// - Parameters:
/// - retryCount: The current retry count [0, CDSHandler.MAX_RETRIES]
/// - code: The locale code that is pulled from CDS
/// - request: The actual URLRequest
/// - requestCompleted: The completion handler.
private func performFetch(retryCount: Int,
code: String,
request: URLRequest,
requestCompleted: @escaping (CDSPullRequestResult) -> Void) {
session.dataTask(with: request) { [weak self]
(data, response, error) in
guard let self = self else {
return
}

if let error = error {
requestCompleted(.failure(.requestFailed(error: error)))
return
}

guard let httpResponse = response as? HTTPURLResponse else {
requestCompleted(.failure(.invalidHTTPResponse))
return
}

let statusCode = httpResponse.statusCode

switch statusCode {

case CDSHandler.HTTP_STATUS_CODE_OK:
if let data = data {
do {
let request = try JSONDecoder().decode(RequestData.self,
from: data)
requestCompleted(.success(request.data))
}
catch {
requestCompleted(.failure(.requestFailed(error: error)))
}
}
else {
requestCompleted(.failure(.nonParsableResponse))
}
case CDSHandler.HTTP_STATUS_CODE_ACCEPTED:
Logger.info("Received 202 response while fetching locale: \(code)")
if retryCount < CDSHandler.MAX_RETRIES {
performFetch(retryCount: retryCount + 1,
code: code,
request: request,
requestCompleted: requestCompleted)
}
else {
requestCompleted(.failure(.maxRetriesReached))
}
default:
requestCompleted(.failure(.serverError(statusCode: statusCode)))
}
}.resume()
}

/// Pushes the generated JSON data containing the source strings and propagates any generated
/// warnings to the final completion handler.
///
Expand All @@ -544,7 +534,10 @@ class CDSHandler {
request.httpMethod = "POST"
request.allHTTPHeaderFields = getHeaders(withSecret: true)

session.dataTask(with: request) { (data, response, error) in
session.dataTask(with: request) { [weak self] (data, response, error) in
guard let self = self else {
return
}
if let error = error {
completionHandler(false, [.requestFailed(error: error)], warnings)
return
Expand Down Expand Up @@ -606,8 +599,11 @@ class CDSHandler {
// have enough time to process the job.
Thread.sleep(forTimeInterval: 1.0)

fetchJobStatus(jobURL: jobURL) {
fetchJobStatus(jobURL: jobURL) { [weak self]
jobStatus, jobErrors, jobDetails in
guard let self = self else {
return
}
guard let finalJobStatus = jobStatus else {
completionHandler(false, [.failedJobRequest], warnings)
return
Expand Down Expand Up @@ -683,7 +679,10 @@ failed: \(details.failed)
request.httpMethod = "GET"
request.allHTTPHeaderFields = getHeaders(withSecret: true)

session.dataTask(with: request) { (data, response, error) in
session.dataTask(with: request) { [weak self] (data, response, error) in
guard let _ = self else {
return
}
guard error == nil else {
Logger.error("Error retrieving job status: \(error!)")
completionHandler(nil, nil, nil)
Expand Down
6 changes: 5 additions & 1 deletion Sources/Transifex/Cache.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,7 +265,11 @@ public final class TXFileOutputCacheDecorator: TXDecoratorCache {
public override func update(translations: TXTranslations) {
super.update(translations: translations)

cacheQueue.async {
cacheQueue.async { [weak self] in
guard let self = self else {
return
}

guard let fileURL = self.fileURL else {
return
}
Expand Down
Loading
Loading