Add options for entity calls in DatastoreSessionHandler #620

michaelbausor · 2017-08-08T18:35:21Z

Fixes #506

Some notes:

This is added as an option, not as the default behaviour, because that would be (I believe) a BC-break.
It is slightly clumsy in the DatastoreSessionHandler because it is the second optional arg, so someone who wants to pass it will also need to set the $gcLimit parameter

tmatsuo · 2017-08-08T18:42:04Z

Thanks for doing this, however, I think we can safely add this behavior, even it's strictly a BC-break, because the session data is not meant to be indexed as a string in any way.

How about to just automatically add the option under the cover?

src/Datastore/DatastoreSessionHandler.php

    /**
     * Write the session data to Cloud Datastore.
+     *
+     * @param string $id Identifier used to construct a {@see Key} for the {@see Entity} to be written.


michaelbausor · 2017-08-08T20:03:15Z

@tmatsuo Interesting. I feel like I am not familiar enough to understand whether any of our users might be depending on the current behaviour. If the chances are negligible or zero, then I agree that making this the default makes sense, but I do think that we need to be very careful about making such decisions in our GA APIs. @jdpedrie @dwsupplee WDYT?

tmatsuo · 2017-08-08T20:05:50Z

@michaelbausor I would say it's negligible, very close to zero

jdpedrie · 2017-08-08T20:26:44Z

@michaelbausor the tests are failing all over at the moment, we're looking into it. but you do have a couple of code sniffer issues which can be addressed in the meanwhile: https://travis-ci.org/GoogleCloudPlatform/google-cloud-php/jobs/262396218#L841

@codingStandardsIgnoreStart and @codingStandardsIgnoreEnd around the long lines is how we handle those.

dwsupplee · 2017-08-08T20:30:56Z

I do think that we need to be very careful about making such decisions in our GA APIs

I agree wholeheartedly with this.

@tmatsuo, it seems this may be something we want to classify as a bug, WDYT? If that is the case, I am in favor of going ahead and making the fix even if it is technically a BC break.

tmatsuo · 2017-08-08T20:36:50Z

@dwsupplee Yeah agreed with marking this as a bug. This data should not be indexed by any means. It also causes #506.

src/Datastore/DatastoreSessionHandler.php

+     * @return bool
     */
-    public function write($id, $data)
+    public function write($id, $data, $entityOptions = null)


src/Datastore/DatastoreSessionHandler.php

+     *
+     * @param string $id Identifier used to construct a {@see \Google\Cloud\Datastore\Key} for the {@see \Google\Cloud\Datastore\Entity} to be written.
+     * @param string $data The session data to write to the {@see \Google\Cloud\Datastore\Entity}.
+     * @param array $entityOptions Optional arguments that will be passed to the {@see \Google\Cloud\Datastore\DatastoreClient::entity} method


src/Datastore/DatastoreSessionHandler.php

        DatastoreClient $datastore,
-        $gcLimit = self::DEFAULT_GC_LIMIT
+        $gcLimit = self::DEFAULT_GC_LIMIT,
+        $options = []


googlebot · 2017-08-10T14:30:46Z

So there's good news and bad news.

👍 The good news is that everyone that needs to sign a CLA (the pull request submitter and all commit authors) have done so. Everything is all good there.

😕 The bad news is that it appears that one or more commits were authored by someone other than the pull request submitter. We need to confirm that they're okay with their commits being contributed to this project. Please have them confirm that here in the pull request.

Note to project maintainer: This is a terminal state, meaning the cla/google commit status will not change from this state. It's up to you to confirm consent of the commit author(s) and merge this pull request when appropriate.

jdpedrie · 2017-08-10T14:31:12Z

(merged in the travis grpc fix)

michaelbausor · 2017-08-10T15:52:28Z

I have changed the default behaviour to specify 'excludeFromIndexes' => ['data']. If a user really needs the old behaviour, it is possible to override this in the DatastoreSessionHandler constructor using the new $options arg. PTAL.

michaelbausor · 2017-08-10T15:58:21Z

@jdpedrie Thanks for merging in the Travis fix. It looks like there are some other changes in this PR now as well - does that mean this PR should wait until those are in master?

jdpedrie · 2017-08-10T16:03:18Z

@michaelbausor sorry about that! Weird. It appears that the other changes are from #617. But that PR was already merged, so I'm not sure why they are showing up in the diff.

I don't want to mess any more with your PR, so I won't change anything, but you could drop that commit:

$ git rebase -i upstream/master // upstream = whatever you call the googlecloudplatform/google-cloud-php remote.

Change 3625e77 from pick to drop and accept all other changes.

Again, sorry for the mess!

michaelbausor · 2017-08-10T16:15:16Z

@jdpedrie No worries, fixed!

dwsupplee

Looks great!

tmatsuo

LG! Thanks!

jdpedrie

just a couple tiny things, otherwise lg!

src/Datastore/DatastoreSessionHandler.php

+     *
+     *     @type array $entityOptions Default options to be passed to the
+     *           {@see \Google\Cloud\Datastore\DatastoreClient::entity()} method when writing session data to Datastore.
+     *           If not specified, defaults to ['excludeFromIndexes' => ['data']].


src/Datastore/DatastoreSessionHandler.php

        // Cut down to 1000
        $this->gcLimit = min($gcLimit, 1000);
+
+        if (!isset($options['entityOptions'])) {


michaelbausor · 2017-08-11T19:36:56Z

PTAL

jdpedrie

LGTM

jdpedrie · 2017-08-14T13:56:28Z

@michaelbausor a couple of phpcs issues: https://travis-ci.org/GoogleCloudPlatform/google-cloud-php/jobs/263629165#L2710

michaelbausor · 2017-08-14T15:34:40Z

Thanks - fixed

googlebot added the cla: yes This human has signed the Contributor License Agreement. label Aug 8, 2017

jdpedrie reviewed Aug 8, 2017

View reviewed changes

dwsupplee added the api: datastore Issues related to the Datastore API. label Aug 8, 2017

dwsupplee reviewed Aug 8, 2017

View reviewed changes

googlebot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels Aug 10, 2017

dwsupplee and others added 5 commits August 10, 2017 09:13

temporarily require grpc-1.4.1 (googleapis#624)

9efcad7

Add options for entity calls in DatastoreSessionHandler

5ea749a

Update @see docs

888af3d

Address PR comments

7835fe6

Fix line length

d598641

michaelbausor force-pushed the fix-506 branch from 33447cb to d598641 Compare August 10, 2017 16:14

jdpedrie added cla: yes This human has signed the Contributor License Agreement. and removed cla: no This human has *not* signed the Contributor License Agreement. labels Aug 10, 2017

dwsupplee approved these changes Aug 10, 2017

View reviewed changes

tmatsuo approved these changes Aug 11, 2017

View reviewed changes

jdpedrie reviewed Aug 11, 2017

View reviewed changes

Address PR comments

e46797f

googlebot added cla: no This human has *not* signed the Contributor License Agreement. and removed cla: yes This human has signed the Contributor License Agreement. labels Aug 11, 2017

jdpedrie approved these changes Aug 12, 2017

View reviewed changes

Fix format violation

56f6ee5

dwsupplee merged commit 19347f5 into googleapis:master Aug 14, 2017

jdpedrie mentioned this pull request Aug 25, 2017

Prepare v0.37.0 #653

Merged

Add options for entity calls in DatastoreSessionHandler #620

Add options for entity calls in DatastoreSessionHandler #620

Uh oh!

Conversation

michaelbausor commented Aug 8, 2017

Uh oh!

tmatsuo commented Aug 8, 2017

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

michaelbausor commented Aug 8, 2017

Uh oh!

tmatsuo commented Aug 8, 2017

Uh oh!

jdpedrie commented Aug 8, 2017

Uh oh!

dwsupplee commented Aug 8, 2017

Uh oh!

tmatsuo commented Aug 8, 2017

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

googlebot commented Aug 10, 2017

Uh oh!

jdpedrie commented Aug 10, 2017

Uh oh!

michaelbausor commented Aug 10, 2017

Uh oh!

michaelbausor commented Aug 10, 2017

Uh oh!

jdpedrie commented Aug 10, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

michaelbausor commented Aug 10, 2017

Uh oh!

dwsupplee left a comment

Choose a reason for hiding this comment

Uh oh!

tmatsuo left a comment

Choose a reason for hiding this comment

Uh oh!

jdpedrie left a comment

Choose a reason for hiding this comment

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

This comment was marked as spam.

Uh oh!

michaelbausor commented Aug 11, 2017

Uh oh!

jdpedrie left a comment

Choose a reason for hiding this comment

Uh oh!

jdpedrie commented Aug 14, 2017

Uh oh!

michaelbausor commented Aug 14, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

jdpedrie commented Aug 10, 2017 •

edited

Loading