Fix calling completion closure twice #323
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ejensen
commented
Dec 3, 2020
| @@ -458,13 +452,10 @@ open class Client { | |||
| """ | |||
| ContentfulLogger.log(.error, message: errorMessage) | |||
| // In this case, .success means that a RateLimitError was successfully initialized. | |||
| completion(Result.success(rateLimitError)) | |||
| return .success(rateLimitError) | |||
There was a problem hiding this comment.
This is an example where the return was missing, so the execution would continue after calling completion and would result in completion being called multiple times.
ejensen
commented
Dec 3, 2020
| @@ -473,7 +464,7 @@ open class Client { | |||
| } catch let error { | |||
| let sdkError = SDKError.unparseableJSON(data: data, errorMessage: "\(error)") | |||
| ContentfulLogger.log(.error, message: sdkError.message) | |||
| completion(.failure(sdkError)) | |||
| return .failure(sdkError) | |||
There was a problem hiding this comment.
Another example of where function execution would continue after calling completion, resulting in completion being called twice.
…Client result handling methods return their results
ejensen
force-pushed
the
client-result-handling
branch
from
52170e9
to
9a4b618
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Prevents calling
completionclosures multiple times by making the synchronousClientResulthandling methods return their values rather than havingcompletionparameters.The changed method signatures are
privateso the change is non-breaking.