nginx testing needed + docs, then we're done, really
[catagits/Catalyst-Runtime.git] / TODO
1 # Known Bugs:
2
3    - Bug ->go or ->visit causes actions which have Args or CaptureArgs called
4      twice when called via ->go or ->visit.
5
6      Test app: http://github.com/bobtfish/catalyst-app-bug-go_chain/tree/master
7
8 # Compatibility warnings to add:
9
10   - $self->config should warn as config should only ever be called as a
11     class method (TESTS).
12
13 # Proposed functionality / feature additions:
14
15 ## Log setup needs to be less lame
16
17 So Catalyst::Plugin::Log::* can die
18 in a fire. Having $c->log_class would be a good start. kane volunteered
19 to do some of this.
20
21 Simple example: Catalyst::Plugin::Log::Colorful should just be a
22 subclass of Catalyst::Log, no ::Plugin:: needed.
23
24 See also: Catalyst::Plugin::Log::Dispatch and
25 http://github.com/willert/catalyst-plugin-log4perl-simple/tree
26
27 # REFACTORING
28
29 ##  PSGI
30
31 ###  To do at release time
32
33   - Release psgi branch of Catalyst-Devel
34   - Release new Task::Catalyst
35
36 ###  Blockers
37
38   * Test everything in the %conflicts list
39
40   * Anything left in Task::Catalyst failing?
41
42   * Test tutotial apps?
43
44   * Test nginx middleware to determine if it is needed with:
45
46     root app - with use_request_uri_for_path
47     root app - without use_request_uri_for_path
48     non-root app - with use_request_uri_for_path
49     non-root app - without use_request_uri_for_path
50
51     If it isn't needed, remove. If it is needed, split it out into it's own
52     file and document why it's needed.
53
54   * Where do all the setup docs from Engine::* go? Into the Manual?
55     At least for nginx, these are somewhat cat specific
56
57   * I've noticed a small difference with Catalyst::Test. The latest stable
58     version include two headers, 'host' and 'https'. They are missing from
59     this version - Pedro Melo on list
60     ^^ Cannot replicate this? Mailed back to ask for tests..
61
62 ###  Nice to have
63
64   * Test/WWW/Mechanize/Catalyst.pm stable throws a deprecation alert when
65     using Catalyst::Test changes introduced by Cataplack.  Suggested fix is
66     in the repo: http://dev.catalystframework.org/svnweb/Catalyst/revision?rev=14059
67
68   * Capture arguments that the plack engine component was run with somewhere,
69     to more easily support custom args from scripts (e.g. Gitalist's
70     --git_dir)
71   * throw away the restarter and allow using the restarters Plack provides
72   * remove per-request state from the engine instance
73   * be smarter about how we use PSGI - not every response needs to be delayed
74     and streaming
75
76 ##  The horrible hack for plugin setup - replacing it:
77
78  * Have a look at the Devel::REPL BEFORE_PLUGIN stuff
79    I wonder if what we need is that combined with plugins-as-roles
80
81 ## App / ctx split:
82
83   NOTE - these are notes that t0m thought up after doing back compat for
84          catalyst_component_class, may be inaccurate, wrong or missing things
85          bug mst (at least) to correct before trying more than the first 2
86          steps. Please knock yourself out on the first two however :)
87
88   - Eliminate actions in MyApp from the main test suite
89   - Uncomment warning in C::C::register_action_methods, add tests it works
90     by mocking out the logging..
91   - Remove MyApp @ISA controller (ask metaclass if it has attributes, and if
92                                   so you need back compat :/)
93   - Make Catalyst::Context, move the per request stuff in there, handles from
94     main app class to delegate
95   - Make an instance of the app class which is a global variable
96   - Make new instance of the context class, not the app class per-request
97   - Remove the components as class data, move to instance data on the app
98     class (you probably have to do this for _all_ the class data, good luck!)
99   - Make it possible for users to spin up different instances of the app class
100     (with different config etc each)
101   - Profit! (Things like changing the complete app config per vhost, i.e.
102     writing a config loader / app class role which dispatches per vhost to
103     differently configured apps is piss easy)