PerlDancer / PerlDancer/Dancer2

Configuration item strict_utf8 - in root config or in serializer?

Open
#1,795 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Perl
Stars
604
Forks
288
Avg merge
1d 5h
Merged PRs (30d)
5

Description

m@c ~/tmp/test-dancer2 (1) $ dancer2 gen -a Mikko
+ Mikko
+ Mikko/.dancer
+ Mikko/cpanfile
+ Mikko/config.yml
+ Mikko/MANIFEST.SKIP
+ Mikko/Makefile.PL
+ Mikko/public
+ Mikko/public/dispatch.cgi
+ Mikko/public/404.html
+ Mikko/public/favicon.ico
+ Mikko/public/500.html
+ Mikko/public/dispatch.fcgi
+ Mikko/environments
+ Mikko/environments/development.yml
+ Mikko/environments/production.yml
+ Mikko/t
+ Mikko/t/001_base.t
+ Mikko/t/002_index_route.t
+ Mikko/bin
+ Mikko/bin/app.psgi
+ Mikko/lib
+ Mikko/lib/Mikko.pm
+ Mikko/views
+ Mikko/views/index.tt
+ Mikko/public/css
+ Mikko/public/css/style.css
+ Mikko/public/css/error.css
+ Mikko/public/images
+ Mikko/public/images/perldancer-bg.jpg
+ Mikko/public/images/perldancer.jpg
+ Mikko/views/layouts
+ Mikko/views/layouts/main.tt

Your new application is ready! To run it:

        cd Mikko
        plackup bin/app.psgi

To access your application, point your browser to http://localhost:5000/

If you need community assistance, the following resources are available:
- Dancer website: https://perldancer.org
- GitHub: https://github.com/PerlDancer/Dancer2/
- Mailing list: https://lists.perldancer.org/mailman/listinfo/dancer-users
- IRC: irc.perl.org#dancer

Happy Dancing!

m@c ~/tmp/test-dancer2 $ cd Mikko/
m@c ~/tmp/test-dancer2/Mikko (127) $ plackup -E development bin/app.psgi
Unknown configuration key 'strict_utf8'
Set strict_config => 0 to silence these warnings.
HTTP::Server::PSGI: Accepting connections at http://0:5000/
[...]

Config key strict_utf8 is read from the root of the config.
It is used in Dancer::Core::App, Dancer2::Core::Request, Dancer2::Core::Response, , Dancer2::Core::Role::Serializer and , Dancer2::Serializer::JSON.

It seems that this item would server better if placed under serializer JSON in config.

Regardless, we should add it to the list of allowed keys (either Core or others) in Dancer2::ConfigReader.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with Dancer2::ConfigReader and trace the strict_utf8 references in Dancer::Core::App, Dancer2::Core::Request, Dancer2::Core::Response, Dancer2::Core::Role::Serializer, and Dancer2::Serializer::JSON. Determine whether the setting belongs at the root or under the JSON serializer, then update the allowed-key handling so the generated application no longer reports an unknown configuration key when run with plackup.

Written by the indexing model from the issue text.

Assessment

Tech stack
perl
Domain
backend
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.