Merge what I've done over the weekend
[catagits/Catalyst-Runtime.git] / TODO
diff --git a/TODO b/TODO
index a88fd21..b905301 100644 (file)
--- a/TODO
+++ b/TODO
-Known issues:
+# Known Bugs:
 
-     - Catalyst-Log-Log4perl Deep recursion on subroutine "MockApp::setup" due
-       to Adopt::NEXT not remembering which setup methods were already called
-       and which not, like NEXT does. Log::Log4perl needs to be fixed and the
-       problem should be described in Upgrading.pod. (rafl)
+   - Bug ->go or ->visit causes actions which have Args or CaptureArgs called
+     twice when called via ->go or ->visit.
 
-     - MX::Emulate::CAF - list assignment (see notes in Upgrading.pod and
-       branch in svn)
+     Test app: http://github.com/bobtfish/catalyst-app-bug-go_chain/tree/master
 
-     - Catalyst::Plugin::Session::State::Cookie - cookie_name is undefined
-       unless explicitly configured because setup_session isn't executed.
+# Compatibility warnings to add:
 
-Documentation:
+  - $self->config should warn as config should only ever be called as a
+    class method (TESTS).
 
-   - Catalyst/Upgrading.pod needs brushing up
+# Proposed functionality / feature additions:
 
-   - Warning when you pass $c->model("MyApp::Model::Foo") is the generic 
-     warning for regex fall back. Should be more specific about what you 
-     screwed up, and the docs for $c->model should be more explicit about
-     what is expected. This probably also applies to view/controller.
+## Log setup needs to be less lame
 
-Profiling:
+So Catalyst::Plugin::Log::* can die
+in a fire. Having $c->log_class would be a good start. kane volunteered
+to do some of this.
 
-  - vs 5.70 and optimisation as needed.
+Simple example: Catalyst::Plugin::Log::Colorful should just be a
+subclass of Catalyst::Log, no ::Plugin:: needed.
+
+See also: Catalyst::Plugin::Log::Dispatch and
+http://github.com/willert/catalyst-plugin-log4perl-simple/tree
+
+## Capture arguments that the plack engine component was run with somewhere,
+    to more easily support custom args from scripts (e.g. Gitalist's
+    --git_dir)
+
+## throw away the restarter and allow using the restarters Plack provides
+
+## remove per-request state from the engine instance
+
+## be smarter about how we use PSGI - not every response needs to be delayed
+    and streaming
+
+#  The horrible hack for plugin setup - replacing it:
+
+ * Have a look at the Devel::REPL BEFORE_PLUGIN stuff
+   I wonder if what we need is that combined with plugins-as-roles
+
+  * Catalyst::Engine::HTTP::Prefork no longer works since it requires
+    Catalyst::Engine::CGI which no longer is in the cataplack distribution.
+    Investigation shows moving CE:CGI to CE:HTTP:Prefork allows tests to pass.
+
+#  PSGI
+
+##  To do at release time
+
+  - Release psgi branch of Catalyst-Devel
+  - Release new Task::Catalyst
+  - Release 5.9 branch of Catalyst-Manual
+  - Release Catalyst::Engine::HTTP::Prefork with deprecation notice
+    (and maybe compat?)
+
+##  Blockers
+
+  * Better docs for stopping using Engine::HTTP::Prefork and
+    starting using Starman, maybe?
+
+  * Test::WWW::Mechanize::Catalyst new release
+
+  * Test nginx middleware to determine if it is needed with:
+
+    root app - with use_request_uri_for_path
+    root app - without use_request_uri_for_path
+    non-root app - with use_request_uri_for_path
+    non-root app - without use_request_uri_for_path
+
+    If it isn't needed, remove. If it is needed, split it out into it's own
+    file and document why it's needed.
+
+  * I've noticed a small difference with Catalyst::Test. The latest stable
+    version include two headers, 'host' and 'https'. They are missing from
+    this version - Pedro Melo on list
+    ^^ Cannot replicate this? Mailed back to ask for tests..
+
+# App / ctx split:
+
+  NOTE - these are notes that t0m thought up after doing back compat for
+         catalyst_component_class, may be inaccurate, wrong or missing things
+         bug mst (at least) to correct before trying more than the first 2
+         steps. Please knock yourself out on the first two however :)
+
+  - Eliminate actions in MyApp from the main test suite
+  - Uncomment warning in C::C::register_action_methods, add tests it works
+    by mocking out the logging..
+  - Remove MyApp @ISA controller (ask metaclass if it has attributes, and if
+                                  so you need back compat :/)
+  - Make Catalyst::Context, move the per request stuff in there, handles from
+    main app class to delegate
+  - Make an instance of the app class which is a global variable
+  - Make new instance of the context class, not the app class per-request
+  - Remove the components as class data, move to instance data on the app
+    class (you probably have to do this for _all_ the class data, good luck!)
+  - Make it possible for users to spin up different instances of the app class
+    (with different config etc each)
+  - Profit! (Things like changing the complete app config per vhost, i.e.
+    writing a config loader / app class role which dispatches per vhost to
+    differently configured apps is piss easy)