Sunday, March 23, 2014

Dancer Sessions using PSGI

A few weeks on #dancer channel, a user was having issues using Dancer::Session::PSGI. I've never worked directly with Plack besides reading the handbook and few play apps. (well a few weeks ago, I dug into Dancer::Debug.). Using both together was an intriguing problem stuck in my mind.

The person on the channel was reporting unreliable reading of session data and other odd behavior. As I started to dig into the problem, I realized that i need to create two apps, one pure Plack and one Dancer with middleware wrapper. I created a public repo on github with my test apps: Dancer and Plack session.

Since, I didn't want to deal with html and wanted a bit of structure with return data, I made both test apps return JSON and have pretty simple routes

I started off using the documentation from Plack::Middleware::Session to create this test app:

Next I created a Test Dancer PSGI app, which basically had a way to show value and update it. Here is the non-exciting Dancer app:

I updated bin/ to use Plack::Builder directly instead of creating a wrapper (which I'd like to try as well probably in a branch):

With those all setup, I started both apps using plackup but each with slightly different command lines:

 magic-bus> plackup pure_plack/bin/app.psgi &
 magic-bus> plackup -p 3000 dancer_plack_session/bin/ &

I created a curl_cookie script to use and store cookies and verbose dump out request/response information. I needed to see what cookies where getting sent in and back.

After i fired up each app server, the first set of requests dumped the following:

Well that is odd. A couple quick bullets:

  • plack app did what was expected (the app increments counter in session after return response therefore on 2nd request being set to 1 is ok).
  • dancer app didn't return '2' (since other app has write to the counter twice) plus it appears to be using both 'dancer.session' and 'plack_session'. This is wrong.
After I dug around a bit (since that session name seems wrong), I found two things.
  • A bug with Dancer::Session::Abstract: #1004
  • And in this case, Dancer::Session is only creating the session not retrieving (since it doesn't think there is one yet) which makes sense. (why retrieve when you are first generating the session.)

The initial session being created to the first request to Dancer not finding the existing plack session information. After that initial request, then it would pick up plack session data. The current behavior would lead to this confusing response the 2nd time from Dancer app:

   "visits" : 2

I fixed up Dancer::Session::Abstract to use 'plack_session' cookie and that resolved the session not getting read on initial request.

A bit unexpectedly, I see that Dancer is setting cookie with different session id than PSGI. PSGI includes its own session cookie. This is expected since the Plack middleware runs after Dancer (think of the onion from handbook: ).

Here is example of response made to Dancer app:

In the end its working now. Dancer is able to pull in session information from Plack session but its still a bit messy. I'm not sure if multiple session cookies is considered a bug or not. I think it might be best to have Dancer not do any cookie stuff and only use the session data if its available in the environment but looking over the Dancer session code, this doesn't look straightforward w/out major changes to core Dancer code.

Any ideas out there?


Wednesday, March 12, 2014

Template Toolkit Debugging inside of Perl Dancer

The other day someone was asking how to enable Template Toolkit debugging inside of Perl Dancer in the #dancer IRC channel, it seemed like a good time for a write up.

The template engine configuration directive supports passing through various options like start_tag and stop_tag as explained in Dancer::Template::TemplateToolkit POD. And alludes to being able to pass other options.


To pass TT options like those found in Template::Constants, there must be a DEBUG section in engines -> template_toolkit, usually found in config.yml.

Example Snippet

Here is an example:

A few notes

  • Remove leading DEBUG_ from TT constants. The option DEBUG_PLUGINS becomes plugins.
  • Multiple options can be separated with a comma. Example:DEBUG: "provider,plugins".
  • Be warned, some of these options can lead to tons of information :)