[HttpFoundation] MongoDbSessionHandler supports auto expiry via configurable expiry_field #11510

catchamonkey · 2014-07-29T13:46:14Z

Q	A
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#11508
License	MIT
Doc PR	no

ToDo

Fix Tests

Looking for feedback on this early PR.

This adds a config option that disables the PHP GC method call from doing anything,
It also means that the write method sets up the auto expiring index.

Ref: #11508

This adds a config option that disables the PHP GC method call from doing anything, and also means that the write method sets up the auto expiring index

…or expiry checks

Tobion · 2014-07-29T15:14:18Z

Do you know how to implement locking in Mongo to prevent race conditions? See #4976

catchamonkey · 2014-07-29T15:23:13Z

MongoDB has DB level locking itself.
Are we really talking about read your own writes here?
If so, then updating the docs to specify a read preference may be enough without forcing it here.

Either way, that is an issue currently right, not created by this PR?

jderusse · 2014-07-29T20:28:08Z

src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php

@@ -109,11 +110,14 @@ public function gc($maxlifetime)
         *
         * See: http://docs.mongodb.org/manual/tutorial/expire-data/
         */
-        $time = new \MongoDate(time() - $maxlifetime);
+        if ($this->options['expiry_field'] == false) {


use === on boolean tests

xabbuh · 2014-07-30T10:43:14Z

src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php

@@ -109,11 +110,14 @@ public function gc($maxlifetime)
         *
         * See: http://docs.mongodb.org/manual/tutorial/expire-data/
         */
-        $time = new \MongoDate(time() - $maxlifetime);
+        if ($this->options['expiry_field'] === false) {


You should use Yoda expressions:

false === $this->options['expiry_field']

Ah yes, will modify.

xabbuh · 2014-07-30T11:04:08Z

...Symfony/Component/HttpFoundation/Tests/Session/Storage/Handler/MongoDbSessionHandlerTest.php

+            ->method('remove')
+            ->will($this->returnCallback(function ($criteria) use ($that) {
+                $that->assertInstanceOf('MongoDate', $criteria[$that->options['time_field']]['$lt']);
+                $that->assertGreaterThanOrEqual(time() - -1, $criteria[$that->options['time_field']]['$lt']->sec);


Why not time() + 1?

I used the existing testGc as the basis for this. No reason from my end then, @jmikola ?

I sorted through the git history and this goes back to @Baachi's original unit tests in 40df3bf, which were later refactored in f2d8a8a.

Looking at it now, I have no idea why gc() is called with -1 below, but I think the syntax above (time() - -1) is just for readability, as it makes it clear that the criteria subtracts the $maxlifetime argument from time(). I actually don't see any documentation in PHP about negative session timeouts (0 means limited to the browser session). It might be best just to update all of the tests to use a positive value for the gc() calls, and then we'll have time() - <positive number> above.

There was no especially reason, why i called gc with -1.

OK thanks guys, i'll update these then.

catchamonkey · 2014-07-31T13:22:01Z

Hi, What needs to be done so this can be merged?

jmikola · 2014-07-31T16:42:03Z

src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php

@@ -109,11 +110,14 @@ public function gc($maxlifetime)
         *
         * See: http://docs.mongodb.org/manual/tutorial/expire-data/
         */
-        $time = new \MongoDate(time() - $maxlifetime);


Rather than most of the existing method body in an if statement, it would be preferable to simply do the following at the top of the function:

if (false !== $this->options['expiry_field']) { return true; }

That keeps the diff smaller, which benefits anyone working on the file in the future.

catchamonkey · 2014-08-11T10:14:44Z

Any further comments here?

jmikola · 2014-08-11T19:20:11Z

I have no further input. I think @stof can give this a final look, or some of the core team voters can chime in.

stof · 2014-08-11T19:46:58Z

...Symfony/Component/HttpFoundation/Tests/Session/Storage/Handler/MongoDbSessionHandlerTest.php

+        $this->mongo->expects($this->never())
+            ->method('selectCollection')
+            ->with($this->options['database'], $this->options['collection'])
+            ->will($this->returnValue($collection));


will() and with can be removed, as you expect it will never be called

👍 Cheers, have updated those.

stof · 2014-08-11T19:48:04Z

except for the small cleanup in tests, 👍

…alled

romainneutron · 2014-08-12T18:03:30Z

👍

nicolas-grekas · 2014-08-13T19:10:17Z

Thank you @catchamonkey.

…xpiry via configurable expiry_field (catchamonkey) This PR was squashed before being merged into the 2.3 branch (closes #11510). Discussion ---------- [HttpFoundation] MongoDbSessionHandler supports auto expiry via configurable expiry_field | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #11508 | License | MIT | Doc PR | no ToDo * [x] Fix Tests Looking for feedback on this early PR. This adds a config option that disables the PHP GC method call from doing anything, It also means that the write method sets up the auto expiring index. Ref: #11508 Commits ------- b56b740 [HttpFoundation] MongoDbSessionHandler supports auto expiry via configurable expiry_field

nicolas-grekas · 2014-08-13T19:11:41Z

Closed via 4f098dc

Tobion · 2014-08-13T19:19:35Z

@nicolas-grekas I didn't know you are allowed to merge into HttpFoundation?

Tobion · 2014-08-13T19:21:06Z

Also since this is a new feature, it should not have been merged into 2.3

nicolas-grekas · 2014-08-13T19:35:07Z

@fabpot being almost off line for two weeks, he asked me and @romainneutron to merge "easypicks" so that Symfony does not stand by meanwhile.
I rely on @symfony/deciders and @symfony/mergers for identifying merge-able PRs.
I merged this one based on the votes from @romainneutron and @stof , please tell me if I should revert it and cherry-pick on an other branch instead.

stof · 2014-08-13T19:48:32Z

this would indeed be better in the master branch.

@Tobion if he had not merged it because of @fabpot's vacations, I would have done it though (I'm merger for the component)

Tobion · 2014-08-13T20:55:47Z

ok just asking

…ekas) This PR was merged into the 2.3 branch. Discussion ---------- [HttpFoundation] revert #11510, moved to 2.6 | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | none | License | MIT | Doc PR | none This reverts PR #11510 from 2.3. Commits ------- fb120c7 revert #11510, moved to 2.6

* 2.3: add missing options revert #11510, moved to 2.6 [WebProfilerBundle] Fixed double height of canvas

* 2.4: add missing options revert #11510, moved to 2.6 [WebProfilerBundle] Fixed double height of canvas

* 2.5: add missing options [Form] Fixed ValidatorExtension to work with the 2.5 Validation API revert #11510, moved to 2.6 [WebProfilerBundle] Fixed double height of canvas

…xpiry via configurable expiry_field (catchamonkey) This PR was merged into the 2.6-dev branch. Discussion ---------- [HttpFoundation] MongoDbSessionHandler supports auto expiry via configurable expiry_field | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #11508 | License | MIT | Doc PR | no This PR applies #11510 to master instead of 2.3 Should be merged on master: - [x] after #11667 is merged to 2.3 - [x] and after 2.3 is merged back to master Commits ------- beca900 [HttpFoundation] MongoDbSessionHandler supports auto expiry via configurable expiry_field

Tobion · 2014-10-07T08:50:45Z

src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php

+            $this->options['time_field'] => new \MongoDate(),
+        );
+
+        /* Note: As discussed in the gc method of this class. You can utilise


this comment should be in the phpdoc where it is actually visible to users

Probably best to submit a new PR with that chance, since this has already been merged and closed.

* 2.3: add missing options revert symfony#11510, moved to 2.6 [WebProfilerBundle] Fixed double height of canvas

* 2.4: add missing options revert symfony#11510, moved to 2.6 [WebProfilerBundle] Fixed double height of canvas

* 2.5: add missing options [Form] Fixed ValidatorExtension to work with the 2.5 Validation API revert symfony#11510, moved to 2.6 [WebProfilerBundle] Fixed double height of canvas

catchamonkey added 2 commits July 29, 2014 14:52

[HttpFOundation] Added support for auto expiry in MongoSbSessionHandler

bb336a5

This adds a config option that disables the PHP GC method call from doing anything, and also means that the write method sets up the auto expiring index

Fixes an issue in the mongo handler where the wrong option was used f…

796b18a

…or expiry checks

catchamonkey changed the title ~~[HttpFoundation] Added support for auto expiry in MongoSbSessionHandler~~ [HttpFoundation] Added support for auto expiry in MongoDbSessionHandler Jul 29, 2014

catchamonkey added 2 commits July 29, 2014 16:42

[HttpFoundation] Fixes unit test following the recent update

2d8b2bd

Fixes usage of short array syntax to support 5.3

4d42f32

jderusse reviewed Jul 29, 2014
View reviewed changes

Use strict comparisons on boolean checks

cb5e562

catchamonkey changed the title ~~[HttpFoundation] Added support for auto expiry in MongoDbSessionHandler~~ [HttpFoundation] MongoDbSessionHandler supports auto expiry and auto index creation Jul 30, 2014

xabbuh reviewed Jul 30, 2014
View reviewed changes

Switched to using yoda expressions

d748743

xabbuh reviewed Jul 30, 2014
View reviewed changes

catchamonkey added the HttpFoundation label Jul 31, 2014

jmikola reviewed Jul 31, 2014
View reviewed changes

catchamonkey added 4 commits August 1, 2014 09:00

Return early from the gc method when expiry indexes are used

2f8742e

Modifies the gc tests to use positive values

fc962db

Now longer creating the index during write, but have documented it

b55c63b

Corrects error in comment

88b256c

stof reviewed Aug 11, 2014
View reviewed changes

Removes will and with expectations from method tests that are never c…

9744f61

…alled

catchamonkey changed the title ~~[HttpFoundation] MongoDbSessionHandler supports auto expiry and auto index creation~~ [HttpFoundation] MongoDbSessionHandler supports auto expiry via configurable expiry_field Aug 11, 2014

nicolas-grekas closed this Aug 13, 2014

catchamonkey deleted the mongo_gc_11508 branch August 13, 2014 21:17

nicolas-grekas added a commit to nicolas-grekas/symfony that referenced this pull request Aug 14, 2014

revert symfony#11510, moved to 2.6

fb120c7

This was referenced Aug 14, 2014

[HttpFoundation] revert #11510, moved to 2.6 #11667

Merged

[HttpFoundation] MongoDbSessionHandler supports auto expiry via configurable expiry_field #11668

Merged

nicolas-grekas added a commit that referenced this pull request Aug 18, 2014

Merge branch '2.3' into 2.4

562ca3d

* 2.3: add missing options revert #11510, moved to 2.6 [WebProfilerBundle] Fixed double height of canvas

nicolas-grekas added a commit that referenced this pull request Aug 18, 2014

Merge branch '2.4' into 2.5

de871dc

* 2.4: add missing options revert #11510, moved to 2.6 [WebProfilerBundle] Fixed double height of canvas

nicolas-grekas added a commit that referenced this pull request Aug 18, 2014

Merge branch '2.5'

7f38207

* 2.5: add missing options [Form] Fixed ValidatorExtension to work with the 2.5 Validation API revert #11510, moved to 2.6 [WebProfilerBundle] Fixed double height of canvas

Tobion reviewed Oct 7, 2014
View reviewed changes

ostrolucky pushed a commit to ostrolucky/symfony that referenced this pull request Mar 25, 2018

Merge branch '2.3' into 2.4

b4d0e71

* 2.3: add missing options revert symfony#11510, moved to 2.6 [WebProfilerBundle] Fixed double height of canvas

ostrolucky pushed a commit to ostrolucky/symfony that referenced this pull request Mar 25, 2018

Merge branch '2.4' into 2.5

52719a6

* 2.4: add missing options revert symfony#11510, moved to 2.6 [WebProfilerBundle] Fixed double height of canvas

Uh oh!

[HttpFoundation] MongoDbSessionHandler supports auto expiry via configurable expiry_field #11510

[HttpFoundation] MongoDbSessionHandler supports auto expiry via configurable expiry_field #11510

Uh oh!

Conversation

catchamonkey commented Jul 29, 2014

Uh oh!

Tobion commented Jul 29, 2014

Uh oh!

catchamonkey commented Jul 29, 2014

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

catchamonkey commented Jul 31, 2014

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

catchamonkey commented Aug 11, 2014

Uh oh!

jmikola commented Aug 11, 2014

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stof commented Aug 11, 2014

Uh oh!

romainneutron commented Aug 12, 2014

Uh oh!

nicolas-grekas commented Aug 13, 2014

Uh oh!

nicolas-grekas commented Aug 13, 2014

Uh oh!

Tobion commented Aug 13, 2014

Uh oh!

Tobion commented Aug 13, 2014

Uh oh!

nicolas-grekas commented Aug 13, 2014

Uh oh!

stof commented Aug 13, 2014

Uh oh!

Tobion commented Aug 13, 2014

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!