Fix parameter serialization logic #404

ob-stripe · 2017-12-20T14:25:19Z

r? @brandur-stripe
cc @stripe/api-libraries

This is a pretty beefy PR, sorry about that! I can probably split it up in a few smaller PRs.

Basically, this replaces the entire parameter serialization logic to make it as similar as possible to stripe-ruby's. This lets us get rid of the nested parameters whitelist (with a minor exception for metadata), so this PR fixes #402 and replaces #396.

While I expect most users will be able to upgrade without issues, this PR does introduce some breaking changes:

AttachedObject no longer exists. All nested objects that are not a specific API resource are now StripeObjects (as is the case in stripe-ruby and stripe-python).
Collection now derives from StripeObject instead of ApiResource. This is also the case in stripe-ruby, and is necessary to solve a serialization quirk when replacing a list object (e.g. when replacing items on a subscription object)

Tagged as WIP to avoid merging for now. Since this will require a major version bump, we might want to bundle some other breaking changes with it.

Let me know if you have any questions or if you want me to split the PR into smaller ones.

brandur-stripe · 2018-01-03T17:25:18Z

Sorry for the delay on this one OB. I've done a partial review, and will get to the rest of it today (I think).

ob-stripe · 2018-01-04T10:09:43Z

Since this is a breaking change, I've updated the base branch to be integration-v6 so that we can solve potential conflicts once #410 is merged in.

ob-stripe · 2018-01-04T15:59:45Z

I rebased the branch on integration-v6 and set that as the merge target.

brandur-stripe

Incredible Olivier!! Another great example of an improvement that never would have been done without you.

I left a couple comments on the code, but it's all pretty minor. 🚢

brandur-stripe · 2017-12-22T18:24:22Z

lib/ApiResource.php

-    private static $HEADERS_TO_PERSIST = array('Stripe-Account' => true, 'Stripe-Version' => true);
+    /**
+     * @return Stripe\Util\Set A list of fields that can be their own type of
+     * API resource (say a nested card under an account fore xample), and if


Minor typo: "fore xample".

brandur-stripe · 2018-01-05T19:19:29Z

lib/Account.php

@@ -173,4 +185,45 @@ public static function createLoginLink($id, $params = null, $opts = null)
    {
        return self::_createNestedResource($id, static::PATH_LOGIN_LINKS, $params, $opts);
    }
+
+    public function serializeParameters($force = false)


Just OOC, is this mostly copied from the Ruby implementation? The test suite looks like it's pretty good in terms of vetting the new code, but just wondering how much we should expect to have to worry about it.

Yep, it's basically a straight port from the Ruby implementation.

brandur-stripe · 2018-01-05T19:21:32Z

lib/ApiResource.php

+     * individually on their own endpoints, but there are certain cases,
+     * replacing a customer's source for example, where this is allowed.
+     */
+    public $saveWithParent = false;


Somewhat too bad this is getting copied across — it felt a little janky as it was coming into Ruby and I was secretly hoping that there was a better way that I hadn't thought of :) It's okay though. At least similar implementations will make easier to reason about it if you're familiar with the other.

Yeah... I might have been cargo culting a little bit too much in this PR but I couldn't come up with anything better and I like that the implementations are consistent across languages for the reason you exposed.

brandur-stripe · 2018-01-05T19:21:55Z

lib/ApiResource.php

+     * @param array|null|mixed $params The list of parameters to validate
+     *
+     * @throws Stripe\Error\Api if $params exists and is not an array
+     */


Thanks for filling in this documentation!

brandur-stripe · 2018-01-05T19:22:32Z

lib/ApiResource.php

@@ -206,7 +301,7 @@ protected function _delete($params = null, $options = null)
     * @param array|null $params
     * @param array|string|null $options
     *
-     * @return StripeObject
+     * @return Stripe\StripeObject


Nice fixes too ...

brandur-stripe · 2018-01-05T19:26:10Z

lib/StripeObject.php

+        //
+        // Another example is that on save API calls it's sometimes desirable to
+        // update a customer's default source by setting a new card (or other)
+        // object with `#source=` and then saving the customer. The


The # designation for instance variables is fairly Ruby specific. Is there a more conventional way for PHP? (Maybe just ..)

I used ->source =. I'm not sure how conventional it is but I think it's fairly explicit.

brandur-stripe · 2018-01-05T19:26:41Z

lib/StripeObject.php

+        // Another example is that on save API calls it's sometimes desirable to
+        // update a customer's default source by setting a new card (or other)
+        // object with `#source=` and then saving the customer. The
+        // `#save_with_parent` flag to override the default behavior allows us to


save_with_parent -> saveWithParent

brandur-stripe · 2018-01-05T19:28:20Z

tests/Stripe/AccountTest.php

@@ -179,4 +179,92 @@ public function testCanCreateLoginLink()
        $resource = Account::createLoginLink(self::TEST_RESOURCE_ID);
        $this->assertInstanceOf("Stripe\\LoginLink", $resource);
    }
+
+    public function testSerializeNewAdditionalOwners()


Thanks for adding all these tests. Account's serialization is problematic enough that you really can't have enough test coverage of it.

brandur-stripe · 2018-01-05T19:29:56Z

tests/Stripe/StripeObjectTest.php

+        $this->assertEquals($values["map"]["1"], $copyValues["map"]["1"]);
+        $this->assertEquals($values["map"]["2"], $copyValues["map"]["2"]);
+    }
+    public function testDeepCopyMaintainClass()


Maybe space out these function definitions a bit (should have a newline in there).

brandur-stripe · 2018-01-05T19:30:56Z

tests/Stripe/StripeObjectTest.php

+            $optsReflector->getValue($copyValues["map"]["0"])
+        );
+        $this->assertEquals($values["map"]["1"], $copyValues["map"]["1"]);
+        $this->assertEquals($values["map"]["2"], $copyValues["map"]["2"]);


Nit, but the whole section above is pretty dense. I like that we have good test coverage, but it could probably use some more whitespace for readability.

brandur-stripe · 2018-01-08T17:53:24Z

LGTM.

ob-stripe · 2018-01-08T21:37:02Z

@brandur-stripe I've squashed the existing commits and added a new one. As part of the changes to the serialization logic, Collection no longer derives from ApiResource but rather from StripeObject. This is necessary so serializeParamsValue works as expected, and is similar to stripe-ruby (https://github.com/stripe/stripe-ruby/blob/master/lib/stripe/list_object.rb#L2).

I initially duplicated the _request and _staticRequest methods, but now that we can use traits, this is no longer necessary.

Can you take a look at the latest commit? Thanks :)

ob-stripe · 2018-01-08T21:37:42Z

init.php

@@ -36,10 +36,11 @@
 require(dirname(__FILE__) . '/lib/Error/OAuth/UnsupportedResponseType.php');

 // API operations
-echo "bouh";


Leftover from manual debugging 😨

Oops. Totally missed that apparently, haha.

ob-stripe · 2018-01-08T21:38:40Z

lib/Account.php

@@ -40,6 +40,10 @@ class Account extends ApiResource
    use ApiOperations\All;
    use ApiOperations\Create;
    use ApiOperations\Delete;
+    use ApiOperations\NestedResource;
+    use ApiOperations\Retrieve {
+        retrieve as protected _retrieve;


Resources that have their own custom implementation of API methods but need to call the standard implementation (usually because they have some additional parameter checking) can use this syntax to "inherit" the trait methods under a different name.

That's pretty cool. Thanks for the ntoe!

brandur-stripe · 2018-01-08T23:36:44Z

I've squashed the existing commits and added a new one. As part of the changes to the serialization logic, Collection no longer derives from ApiResource but rather from StripeObject. This is necessary so serializeParamsValue works as expected, and is similar to stripe-ruby (https://github.com/stripe/stripe-ruby/blob/master/lib/stripe/list_object.rb#L2).

I initially duplicated the _request and _staticRequest methods, but now that we can use traits, this is no longer necessary.

Makes sense. Thanks!

Alright, I had one more look over, and I think it's pretty solid. LGTM.

stripe-ci assigned brandur-stripe Dec 20, 2017

ob-stripe added the breaking-api-change label Jan 4, 2018

ob-stripe changed the base branch from master to integration-v6 January 4, 2018 10:08

ob-stripe force-pushed the ob-serialize-params-2 branch from 23d3b88 to d6d1645 Compare January 4, 2018 15:49

ob-stripe mentioned this pull request Jan 4, 2018

stripe-php 6.0.0 #412

Merged

9 tasks

ob-stripe changed the title ~~[WIP] Fix parameter serialization logic~~ Fix parameter serialization logic Jan 4, 2018

ob-stripe force-pushed the ob-serialize-params-2 branch from d6d1645 to b97f04d Compare January 4, 2018 22:12

ob-stripe force-pushed the integration-v6 branch from 0b320c6 to 9f10791 Compare January 4, 2018 23:04

ob-stripe force-pushed the ob-serialize-params-2 branch from b97f04d to a8265ad Compare January 4, 2018 23:05

ob-stripe force-pushed the integration-v6 branch from 9f10791 to f1d8593 Compare January 5, 2018 17:06

ob-stripe force-pushed the ob-serialize-params-2 branch from a8265ad to ba0d1d3 Compare January 5, 2018 17:26

brandur-stripe reviewed Jan 5, 2018

View reviewed changes

ob-stripe force-pushed the ob-serialize-params-2 branch from 7ab25b9 to c77b125 Compare January 6, 2018 18:53

Fix parameter serialization logic

42f1b44

ob-stripe force-pushed the ob-serialize-params-2 branch from c77b125 to 42f1b44 Compare January 6, 2018 22:19

More traits usage

8caa107

ob-stripe commented Jan 8, 2018

View reviewed changes

ob-stripe merged commit a8f8c8c into integration-v6 Jan 8, 2018

ob-stripe deleted the ob-serialize-params-2 branch January 8, 2018 23:52

ob-stripe mentioned this pull request Jan 8, 2018

[WIP] Ensure that card is only treated as a nested updatable attribute on Source objects #396

Closed

ob-stripe mentioned this pull request Feb 11, 2018

Fix header persistence on Collection objects #435

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix parameter serialization logic #404

Fix parameter serialization logic #404

ob-stripe commented Dec 20, 2017

brandur-stripe commented Jan 3, 2018

ob-stripe commented Jan 4, 2018

ob-stripe commented Jan 4, 2018

brandur-stripe left a comment

brandur-stripe Dec 22, 2017

brandur-stripe Jan 5, 2018

ob-stripe Jan 6, 2018

brandur-stripe Jan 5, 2018

ob-stripe Jan 6, 2018

brandur-stripe Jan 5, 2018

brandur-stripe Jan 5, 2018

brandur-stripe Jan 5, 2018

ob-stripe Jan 6, 2018

brandur-stripe Jan 5, 2018

brandur-stripe Jan 5, 2018

brandur-stripe Jan 5, 2018

brandur-stripe Jan 5, 2018

brandur-stripe commented Jan 8, 2018

ob-stripe commented Jan 8, 2018

ob-stripe Jan 8, 2018

brandur-stripe Jan 8, 2018

ob-stripe Jan 8, 2018

brandur-stripe Jan 8, 2018

brandur-stripe commented Jan 8, 2018

Fix parameter serialization logic #404

Fix parameter serialization logic #404

Conversation

ob-stripe commented Dec 20, 2017

brandur-stripe commented Jan 3, 2018

ob-stripe commented Jan 4, 2018

ob-stripe commented Jan 4, 2018

brandur-stripe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brandur-stripe commented Jan 8, 2018

ob-stripe commented Jan 8, 2018

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

brandur-stripe commented Jan 8, 2018