Add cookbook article for using MongoDB to store session data #5478

stevenmusumeche · 2015-07-03T02:31:51Z

Q	A
Doc fix?	yes
New docs?	yes
Applies to	all
Fixed tickets	none

stevenmusumeche · 2015-07-03T02:32:50Z

This is my first contribution so please let me know if anything needs to be changed.

javiereguiluz · 2015-07-03T14:52:03Z

cookbook/configuration/mongodb_session_storage.rst

+Symfony has a built-in solution for NoSQL database session storage called
+:class:`Symfony\\Component\\HttpFoundation\\Session\\Storage\\Handler\\MongoDbSessionHandler`.
+MongoDB is an open-source document database that provides high performance,
+high availability, and automatic scaling. This article assumes that you have


Minor correction: we don't use the so-called "serial comma", so the comma before the and word must be removed. Thanks.

javiereguiluz · 2015-07-03T15:01:39Z

@stevenmusumeche thanks for this proposal and congratulations on your first contribution!

Right now there is a minor technical issue which is the reason why the latest doc build throwed this error:

Warning, treated as error:
/home/travis/build/symfony/symfony-docs/cookbook/configuration/mongodb_session_storage.rst::   
WARNING: document isn't included in any toctree

To solve this issue, you need to edit the cookbook/map.rst.inc file and add a link to your article. The syntax is the same that you'll find for the other articles in the config section of the cookbook. If you have any question, please ask.

Lastly, regarding the article itself, I like it and it's very easy to read! The only thing I didn't like is how convoluted is the configuration to use Mongo for storing sessions. But of course this is not a problem of this article.

wouterj · 2015-07-03T15:13:22Z

Actually, the build error shown by @javiereguiluz is not fixed by updating map.rst.inc (while you should update that article as well). The error is fixed by adding this document to the list of documents in cookbook/configuration/index.rst.

stevenmusumeche · 2015-07-03T18:00:49Z

@wouterj thank you for the XML and PHP code blocks, I have added them to the PR.

stevenmusumeche · 2015-07-03T19:11:50Z

@javiereguiluz looks like the build passed this time, ready to be merged

xabbuh · 2015-07-04T06:41:35Z

I suggest to also add a reference to the new article in the session section (we do the same with the PDO session handler).

stevenmusumeche · 2015-07-04T15:45:09Z

@xabbuh good idea, I added that and reworded the existing tip

xabbuh · 2015-07-04T20:26:21Z

@stevenmusumeche Good catch, I actually didn't remember that we had a notice in /cookbook/session/sessions_directory.rst too. Could you also add a reference to /cookbook/session/index.rst (that's file I initially had in mind).

stevenmusumeche · 2015-07-05T15:46:57Z

I don't see a reference to PDO session handler on this page (http://symfony.com/doc/current/cookbook/session/index.html). Is that what you are referring to?

…erformance

xabbuh · 2015-07-05T16:59:46Z

I'm sorry cause I pointed you to the wrong file. The reference Im talking about is in the Session section of the /cookbook/map.rst.inc file.

stevenmusumeche · 2015-07-06T16:03:37Z

@xabbuh, just updated

xabbuh · 2015-07-07T07:47:59Z

cookbook/session/index.rst

+    avoid_session_start
+    /cookbook/configuration/pdo_session_storage
+    /cookbook/configuration/mongodb_session_storage


The two lines from the configuration section need to be removed. Sorry for the confusion.

@xabbuh got it, sorry about that

stevenmusumeche · 2015-07-13T01:03:36Z

@xabbuh anything else need to be done?

xabbuh · 2015-07-14T18:52:21Z

👍

wouterj · 2015-07-22T21:34:57Z

cookbook/configuration/mongodb_session_storage.rst

+                arguments: [mongodb://%mongodb_host%:27017]
+            session.handler.mongo:
+                class: Symfony\Component\HttpFoundation\Session\Storage\Handler\MongoDbSessionHandler
+                arguments: [@mongo_client, %mongo.session.options%]


% is a reserved first character in older versions of the Yaml spec. Unfortunately, the syntax highlighter used on symfony.com follows this spec and breaks. Can you please wrap it in double quotes, "%mongo.session.options%"?

… data (stevenmusumeche) This PR was merged into the 2.3 branch. Discussion ---------- Add cookbook article for using MongoDB to store session data | Q | A | ------------- | --- | Doc fix? | yes | New docs? | yes | Applies to | all | Fixed tickets | none Commits ------- deccf85 remove links from incorrect page 5f30b07 add reference to mongodb session storage to cookbook index 4238fcc add reference to PDO and MongoDB session handlers in session index 2faa2ac add information about adding an index to improve garbage collection performance dde0ee1 add link to MongoDB cookbook article d3ba62f move parameter configuration into separate section of the article 4048e97 fix formatting 52d89dc add xml and php configuration blocks 8e20ba4 add new cookbook article to index files 2e7757f Add cookbook article for using MongoDB to store session data

wouterj · 2015-07-22T21:48:24Z

Great! As you already did such a great job, I just merged it in and created a new PR myself with the 2 little changes: #5554 Feel free to comment if you disagree with any of them.

stevenmusumeche · 2015-07-24T18:56:53Z

@wouterj one small change, the field that should be indexed is expires_at

xabbuh · 2015-07-25T09:15:37Z

@stevenmusumeche Do you mean line 168?

timglabisch · 2015-07-25T10:04:28Z

👍

stevenmusumeche · 2015-07-25T22:30:18Z

@xabbuh yes line 168. I mistyped the field name that should be indexed for improved GC performance.

@stevenmusumeche

This PR was merged into the 2.3 branch. Discussion ---------- [Cookbook][Session] fix default expiry field name | Q | A | ------------- | --- | Doc fix? | yes | New docs? | no | Applies to | all | Fixed tickets | As @stevenmusumeche noted in #5478 (comment), the [default expiry field name is expires_at](https://github.com/symfony/symfony/blob/2.8/src/Symfony/Component/HttpFoundation/Session/Storage/Handler/MongoDbSessionHandler.php#L86). Commits ------- 1e1a129 [Cookbook][Session] fix default expiry field name

Add cookbook article for using MongoDB to store session data

2e7757f

stevenmusumeche mentioned this pull request Jul 3, 2015

Storing Sessions in MongoDB #5477

Closed

javiereguiluz reviewed Jul 3, 2015
View reviewed changes

stevenmusumeche added 3 commits July 3, 2015 12:52

add new cookbook article to index files

8e20ba4

add xml and php configuration blocks

52d89dc

fix formatting

4048e97

xabbuh added the Status: Needs Work label Jul 4, 2015

stevenmusumeche added 2 commits July 4, 2015 10:33

move parameter configuration into separate section of the article

d3ba62f

add link to MongoDB cookbook article

dde0ee1

stevenmusumeche added 2 commits July 5, 2015 10:57

add information about adding an index to improve garbage collection p…

2faa2ac

…erformance

add reference to PDO and MongoDB session handlers in session index

4238fcc

add reference to mongodb session storage to cookbook index

5f30b07

xabbuh reviewed Jul 7, 2015
View reviewed changes

remove links from incorrect page

deccf85

xabbuh added Status: Reviewed and removed Status: Needs Work labels Jul 14, 2015

wouterj reviewed Jul 22, 2015
View reviewed changes

wouterj merged commit deccf85 into symfony:2.3 Jul 22, 2015

wouterj added a commit to wouterj/symfony-docs that referenced this pull request Jul 22, 2015

[symfony#5478] Some minor changes

8c92bfd

wouterj removed the Status: Reviewed label Jul 22, 2015

xabbuh mentioned this pull request Aug 1, 2015

[Cookbook][Session] fix default expiry field name #5589

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add cookbook article for using MongoDB to store session data #5478

Add cookbook article for using MongoDB to store session data #5478

stevenmusumeche commented Jul 3, 2015

stevenmusumeche commented Jul 3, 2015

javiereguiluz Jul 3, 2015

javiereguiluz commented Jul 3, 2015

wouterj commented Jul 3, 2015

stevenmusumeche commented Jul 3, 2015

stevenmusumeche commented Jul 3, 2015

xabbuh commented Jul 4, 2015

stevenmusumeche commented Jul 4, 2015

xabbuh commented Jul 4, 2015

stevenmusumeche commented Jul 5, 2015

xabbuh commented Jul 5, 2015

stevenmusumeche commented Jul 6, 2015

xabbuh Jul 7, 2015

stevenmusumeche Jul 7, 2015

stevenmusumeche commented Jul 13, 2015

xabbuh commented Jul 14, 2015

wouterj Jul 22, 2015

wouterj commented Jul 22, 2015

stevenmusumeche commented Jul 24, 2015

xabbuh commented Jul 25, 2015

timglabisch commented Jul 25, 2015

stevenmusumeche commented Jul 25, 2015

Add cookbook article for using MongoDB to store session data #5478

Add cookbook article for using MongoDB to store session data #5478

Conversation

stevenmusumeche commented Jul 3, 2015

stevenmusumeche commented Jul 3, 2015

javiereguiluz Jul 3, 2015

Choose a reason for hiding this comment

javiereguiluz commented Jul 3, 2015

wouterj commented Jul 3, 2015

stevenmusumeche commented Jul 3, 2015

stevenmusumeche commented Jul 3, 2015

xabbuh commented Jul 4, 2015

stevenmusumeche commented Jul 4, 2015

xabbuh commented Jul 4, 2015

stevenmusumeche commented Jul 5, 2015

xabbuh commented Jul 5, 2015

stevenmusumeche commented Jul 6, 2015

xabbuh Jul 7, 2015

Choose a reason for hiding this comment

stevenmusumeche Jul 7, 2015

Choose a reason for hiding this comment

stevenmusumeche commented Jul 13, 2015

xabbuh commented Jul 14, 2015

wouterj Jul 22, 2015

Choose a reason for hiding this comment

wouterj commented Jul 22, 2015

stevenmusumeche commented Jul 24, 2015

xabbuh commented Jul 25, 2015

timglabisch commented Jul 25, 2015

stevenmusumeche commented Jul 25, 2015