Propagate parameter encoding error for URLRequest mapping #1248

SD10 · 2017-08-31T12:27:40Z

Changes:

Adds:
MoyaError.parameterEncoding(Swift.Error) case

Refactors:
urlRequest -> urlRequest() (now throwing)

Summary of Pull Request:

As discussed in #1247 I saw that it would be really easy to pass on the errors thrown when attempting to encode URLRequest parameters.

All that had to be done is convert Endpoint's urlRequest property to a throwing function and pass the error to the .failure closure in MoyaProvider.defaultRequestMapping.

Personally, I'm not too fond of having to call try now when accessing an Endpoint's urlRequest. Therefore, I mostly consider this "research" unless any of you think there's value in it.

codecov-io · 2017-08-31T12:39:30Z

Codecov Report

❗ No coverage uploaded for pull request base (10.0.0-dev@a684307). Click here to learn what that means.
The diff coverage is 78.72%.

@@              Coverage Diff              @@
##             10.0.0-dev    #1248   +/-   ##
=============================================
  Coverage              ?   83.98%           
=============================================
  Files                 ?       24           
  Lines                 ?      768           
  Branches              ?        0           
=============================================
  Hits                  ?      645           
  Misses                ?      123           
  Partials              ?        0

Impacted Files	Coverage Δ
Sources/Moya/MoyaError.swift	`28% <0%> (ø)`
Sources/Moya/Plugins/NetworkActivityPlugin.swift	`100% <100%> (ø)`
Sources/Moya/MoyaProvider+Defaults.swift	`76% <25%> (ø)`
Sources/Moya/Endpoint.swift	`93.22% <97.05%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update a684307...42ecf86. Read the comment docs.

sunshinejr · 2017-09-01T21:30:22Z

This is really cool, but I feel like this could be something we think about for version 10.0. We need to release 9.0 in a few. What do you think about it, @SD10?

SD10 · 2017-09-01T22:59:22Z

@sunshinejr I have no problem delaying this until v10.0 or even not going with this solution at all

sunshinejr · 2017-09-04T21:04:32Z

Damn, GitHub did let me remove the 9.0.0-dev branch while PRs were targeted to it still. Reopening!

sunshinejr · 2017-09-16T17:28:00Z

Hey @SD10, would you be up for finishing that one? Conflicts + Docs + Changelog is there to finish I believe? Other than that I think this looks good!

SD10 · 2017-09-17T23:29:15Z

@sunshinejr Yes, I will finish this up. I need about 2 days though

sunshinejr · 2017-09-18T08:02:28Z

Great! Take your time 👍

MoyaBot · 2017-09-22T10:48:04Z

SwiftLint found issues

Warnings

File	Line	Reason
EndpointSpec.swift	245	Colons should be next to the identifier when specifying a type and next to the key in dictionary literals.
EndpointSpec.swift	246	Colons should be next to the identifier when specifying a type and next to the key in dictionary literals.
MoyaProviderSpec.swift	975	File should contain 400 lines or less: currently contains 975

Errors

File	Line	Reason
MoyaProviderSpec.swift	7	Type body should span 350 lines or less excluding comments and whitespace: currently spans 594 lines

Generated by 🚫 Danger

SD10 · 2017-09-22T10:52:37Z

That's what I get for trying to resolve a merge conflict in nano 😃

sunshinejr · 2017-09-23T14:14:50Z

@SD10 would you please rebase & fix the conflicts? I've merged few other PRs in the meantime.

SD10 · 2017-09-23T20:28:32Z

@sunshinejr Sure thing. Should be good to go if resolving the conflicts went well and CI is all green. Unless anyone else has any input/review. Giving it another look over myself now

sunshinejr

Thanks, @SD10! Seems good to me, but I think it would be awesome to get another pair of eyes on that one.

SD10 · 2017-09-23T20:54:26Z

Yes, I'd really appreciate it if another @Moya/contributors gave their input. The goal of this PR is to expose more information about the failure of parameter encoding for a request.

I don't want to hear a ton of complaints about having to use try syntax when accessing the urlRequest for an Endpoint if this were to be merged.

ashfurrow

Looks good to me 👍 From an API perspective I think this makes a lot more sense, and migration is pretty easy. Good job!

ashfurrow · 2017-09-23T22:54:42Z

Sources/Moya/Endpoint.swift

+        let rhsRequest = try? rhs.urlRequest()
+        if lhsRequest != nil, rhsRequest == nil { return false }
+        if lhsRequest == nil, rhsRequest != nil { return false }
+        if lhsRequest == nil, rhsRequest == nil { return lhs.hashValue == rhs.hashValue }


This is totally fine, though I will point out that if two different Endpoints both fail to produce a urlRequest, then they would be "equal". I'm sure that's fine, especially since it's consistent with hashValue. The only consequences would be using an Endpoint as key in a dictionary, or in a Set. I think it's worth a comment, but otherwise this is totally 👍

If two different Endpoints both fail to produce a urlRequest it will compare both endpoints using the hashValue of the url: String property.

So if two different Endpoints both fail to produce a urlRequest and they have the same String for the url -- they will be considered equal. I'll add a comment noting this behavior.

ashfurrow · 2017-09-23T23:02:31Z

Tests/EndpointSpec.swift

@@ -72,8 +72,8 @@ final class EndpointSpec: QuickSpec {

        it("returns a nil urlRequest for an invalid URL") {
            let badEndpoint = Endpoint<Empty>(url: "some invalid URL", sampleResponseClosure: { .networkResponse(200, Data()) }, method: .get, task: .requestPlain, httpHeaderFields: nil)
-
-            expect(badEndpoint.urlRequest).to(beNil())
+            let urlRequest = try? badEndpoint.urlRequest()


This is good – can we also add a test that makes sure the error thrown is correct?

Great idea 👍 Thanks for the input

SD10 · 2017-09-24T06:59:22Z

As per @ashfurrow 's feedback I added tests to make sure urlRequest is throwing the correct error.

I changed the implementation to throw the .parameterEncoding error directly from urlRequest() instead of wrapping it up in defaultEndpointMapping. This is because I was receiving an Alamofire error instead of a MoyaError through urlRequest. Nice how writing a test caught this 😉

Truthfully, it was extremely hard to write a test that caught an error -- it even made me question the value of this change.

This error will only ever be triggered when JSONSerialization fails to serialize the parameters. I went hunting in core-libs-foundation to see what errors it throws -- but the majority of them aren't caught gracefully and come back as an NSInvalidArgumentException.

ashfurrow · 2017-09-24T14:08:20Z

Tests/EndpointSpec.swift

+                it("throws a .parameterEncoding error") {
+
+                    // Non-serializable type to cause serialization error
+                    class InvalidParameter {}


ashfurrow · 2017-09-24T14:11:28Z

Awesome, great work! Let's leave it a few days in case anyone else has input.

@Moya/core-team I wonder if we should target a new moya-10 branch with the PR, to keep master for any non-breaking fixes we can release as 9.0.x patches. Anyone have thoughts on a branching strategy?

pedrovereza · 2017-09-24T15:06:45Z

@ashfurrow This PR is already targeting branch 10.0.0-dev 😉

ashfurrow · 2017-09-24T16:31:47Z

Oops 🙈

sunshinejr · 2017-09-26T15:04:36Z

I was rebasing 10.0.0-dev again as we had documentation changes, so I rebased this one as well. Sorry for trouble.

ashfurrow · 2017-09-26T15:13:38Z

Cool, looks good to merge on 🍏

sunshinejr · 2017-09-26T15:19:05Z

Great! Thanks for all your hard work on that one, @SD10 😉

sunshinejr mentioned this pull request Sep 2, 2017

Release 10.0 #1253

Closed

11 tasks

sunshinejr closed this Sep 4, 2017

sunshinejr changed the base branch from 9.0.0-dev to master September 4, 2017 21:04

sunshinejr reopened this Sep 4, 2017

SD10 added a commit that referenced this pull request Sep 22, 2017

[Changelog] Record breaking changes for #1248

d6b0c17

SD10 changed the base branch from master to 10.0.0-dev September 22, 2017 10:14

SD10 changed the title ~~[WIP] Propagate parameter encoding error for URLRequest mapping~~ Propagate parameter encoding error for URLRequest mapping Sep 22, 2017

sunshinejr force-pushed the 10.0.0-dev branch from 6a038a9 to b12ae5b Compare September 23, 2017 13:17

SD10 force-pushed the feature/parameterEncoding-error branch from 5c92b72 to d1b4ca1 Compare September 23, 2017 20:24

SD10 added a commit that referenced this pull request Sep 23, 2017

[Changelog] Record breaking changes for #1248

99df1f6

sunshinejr approved these changes Sep 23, 2017

View reviewed changes

ashfurrow approved these changes Sep 23, 2017

View reviewed changes

ashfurrow reviewed Sep 24, 2017

View reviewed changes

sunshinejr force-pushed the 10.0.0-dev branch from 4382d73 to a684307 Compare September 26, 2017 15:03

SD10 added 10 commits September 26, 2017 17:03

Propogate new MoyaError.parameterEncoding for defaultRequestMapping

e87914d

[Tests] Update tests to handle throwing urlRequest

3e1be70

[Docs] Update Endpoint.swift comments and Endpoints.md

962d6af

[Docs] Update Authentication.md for urlRequest() throws

3b2b910

[Docs] Update ErrorTypes.md for .parameterEncoding(Swift.Error)

bafd325

[Changelog] Record breaking changes for #1248

482e5fd

[Tests] Fix failing test from missing arg

c309a2f

Throw .parameterEncoding error directly from urlRequest() method

4c3bfb1

[Tests] Add .parameterEncoding & .requestMapping tests for urlRequest()

e11a8e1

Remove unnecessary import of Alamofire.AFError

42ecf86

sunshinejr force-pushed the feature/parameterEncoding-error branch from 2a9fb06 to 42ecf86 Compare September 26, 2017 15:04

sunshinejr merged commit 7c74420 into 10.0.0-dev Sep 26, 2017

sunshinejr deleted the feature/parameterEncoding-error branch September 26, 2017 15:19

sunshinejr pushed a commit that referenced this pull request Oct 2, 2017

[Changelog] Record breaking changes for #1248

2a70350

AndrewSB pushed a commit that referenced this pull request Oct 3, 2017

[Changelog] Record breaking changes for #1248

141507c

sunshinejr pushed a commit that referenced this pull request Oct 8, 2017

[Changelog] Record breaking changes for #1248

43f0343

sunshinejr pushed a commit that referenced this pull request Oct 8, 2017

[Changelog] Record breaking changes for #1248

ead422b

sunshinejr pushed a commit that referenced this pull request Oct 8, 2017

[Changelog] Record breaking changes for #1248

1f90d93

sunshinejr pushed a commit that referenced this pull request Oct 21, 2017

[Changelog] Record breaking changes for #1248

376a829

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Propagate parameter encoding error for URLRequest mapping #1248

Propagate parameter encoding error for URLRequest mapping #1248

SD10 commented Aug 31, 2017

codecov-io commented Aug 31, 2017 •

edited

Loading

sunshinejr commented Sep 1, 2017

SD10 commented Sep 1, 2017

sunshinejr commented Sep 4, 2017

sunshinejr commented Sep 16, 2017

SD10 commented Sep 17, 2017

sunshinejr commented Sep 18, 2017

MoyaBot commented Sep 22, 2017 •

edited

Loading

SD10 commented Sep 22, 2017

sunshinejr commented Sep 23, 2017 •

edited

Loading

SD10 commented Sep 23, 2017

sunshinejr left a comment

SD10 commented Sep 23, 2017

ashfurrow left a comment

ashfurrow Sep 23, 2017

SD10 Sep 24, 2017

ashfurrow Sep 23, 2017

SD10 Sep 24, 2017

SD10 commented Sep 24, 2017

ashfurrow Sep 24, 2017

ashfurrow commented Sep 24, 2017

pedrovereza commented Sep 24, 2017

ashfurrow commented Sep 24, 2017

sunshinejr commented Sep 26, 2017

ashfurrow commented Sep 26, 2017

sunshinejr commented Sep 26, 2017

Propagate parameter encoding error for URLRequest mapping #1248

Propagate parameter encoding error for URLRequest mapping #1248

Conversation

SD10 commented Aug 31, 2017

Changes:

Summary of Pull Request:

codecov-io commented Aug 31, 2017 • edited Loading

Codecov Report

sunshinejr commented Sep 1, 2017

SD10 commented Sep 1, 2017

sunshinejr commented Sep 4, 2017

sunshinejr commented Sep 16, 2017

SD10 commented Sep 17, 2017

sunshinejr commented Sep 18, 2017

MoyaBot commented Sep 22, 2017 • edited Loading

SwiftLint found issues

Warnings

Errors

SD10 commented Sep 22, 2017

sunshinejr commented Sep 23, 2017 • edited Loading

SD10 commented Sep 23, 2017

sunshinejr left a comment

Choose a reason for hiding this comment

SD10 commented Sep 23, 2017

ashfurrow left a comment

Choose a reason for hiding this comment

ashfurrow Sep 23, 2017

Choose a reason for hiding this comment

SD10 Sep 24, 2017

Choose a reason for hiding this comment

ashfurrow Sep 23, 2017

Choose a reason for hiding this comment

SD10 Sep 24, 2017

Choose a reason for hiding this comment

SD10 commented Sep 24, 2017

ashfurrow Sep 24, 2017

Choose a reason for hiding this comment

ashfurrow commented Sep 24, 2017

pedrovereza commented Sep 24, 2017

ashfurrow commented Sep 24, 2017

sunshinejr commented Sep 26, 2017

ashfurrow commented Sep 26, 2017

sunshinejr commented Sep 26, 2017

codecov-io commented Aug 31, 2017 •

edited

Loading

MoyaBot commented Sep 22, 2017 •

edited

Loading

sunshinejr commented Sep 23, 2017 •

edited

Loading