X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=TODO;h=5e3c68e4339e3ae8d7fc76401f13e33250366d48;hp=23cdab70a426324c1aa2a0c60378a5fee7b9d53f;hb=gsoc_breadboard;hpb=c31259881c5bdcab50409ff2e167a6aeb9df52cd diff --git a/TODO b/TODO index 23cdab7..5e3c68e 100644 --- a/TODO +++ b/TODO @@ -24,14 +24,17 @@ subclass of Catalyst::Log, no ::Plugin:: needed. See also: Catalyst::Plugin::Log::Dispatch and http://github.com/willert/catalyst-plugin-log4perl-simple/tree -# REFACTORING +## throw away the restarter and allow using the restarters Plack provides -## The horrible hack for plugin setup - replacing it: +## 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 -## App / ctx split: +# 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 @@ -57,140 +60,145 @@ http://github.com/willert/catalyst-plugin-log4perl-simple/tree ## GSOC -### Next large steps, planned: +### Final steps for GSOC -For all components that have been discovered, in whatever way, we create a service: - - that's a catalyst component service - - which is basically just a constructor injection - - except the constructor name is COMPONENT - - and we're "implicitly" passing along some constructor args - - Lifecycle => Singleton +##### Things that work: - - Fix B::B so that Service::WithParametrs' parameters attribute has a builder - - Fix ConstructorInjection so that default parameters are supplied (for accept_context_args) - - Fix ConstructorInjection's 'suffix' - should be called 'config_key' or something, and - should be an attribute on the service (as it never changes), rather than a parameter - to the service + - the default container loads all components, calls ACCEPT_CONTEXT() when appropriate, and COMPONENT() when appropriate, behaving like current Catalyst does - - We make a 'components' sub container in the main container. - - This gets the ConstructorInjection COMPONENT services, as model_Foo. - - Lifecycle of these services is Singleton - - This simplifies the code for MyApp->components, as it need only list one sub-container + - its possible to create a custom container, and override the components you want. Lifecycle, class, dependencies, all overridable. - - We create a second service (depending on the first one) for ACCEPT_CONTEXT - - This has a custom service which calls ACCEPT_CONTEXT when the instance is fetched - - Not Singleton lifecycle - - Note - ACCEPT_CONTEXT can be called on app values - if you have a Model::Foo, with an ACCEPT_CONTEXT - and you call MyApp->model('Foo') then ACCEPT_CONTEXT gets invoked with a $c of 'MyApp' (this is not\ - the normal case, but we need to preserve for compat) + - config files are loaded without Catalyst::Plugin::ConfigLoader -### Next steps - less planned: + - per request life cycle somewhat works - - Creating service()-like sugar for component + - external modules are loaded just using a custom container, much like Catalyst::Model::Adaptor - - Test cases for extending the container in an application. - - Using the sugar added in the previous item - - Test when Model::Foo depends_on Model::Bar +##### Things that don't work: + - expand_component_module -#### Extending my app, notes + - Some back compat + - wrappers around setup_component, setup_components in Catalyst.pm + - $instance->expand_modules + - search_extra + - Crazy tests for things such as: + sub COMPONENT { + ... + *${appclass}::Model::TopLevel::GENERATED::ACCEPT_CONTEXT = sub { ... }; + ... + } -Basically try to implement something like this (starting out without the sugar!), and see how it breaks -and what needs to be done to fix it! +##### Items for discussion and planning +# (in no particular order, just numbered to be more easily refered to) -##### Eventual syntax + 1) per request life cycle -package MyApp::Container; -use Catalyst::IOC; - - container $self, as { - container model => as { - component Foo => (); # As per default! - component Bar => (dependencies => ['/model/Foo']); # Magic! - component Baz => ( lifecycle => 'InstancePerContext ); - component Quux => ( lifecycle => 'Singleton' ); # ACCEPT_CONTEXT not called - }; - # Note - implementation of BB may need to be changed to support making sure existing - # services actually get overridden. not sure how the default container behaves when doing that - # above code would build the constructor injection as it currently does, - # defaulting to the class name in the right namespace as declared by the surrounding container - # as well as adding using the catalyst-specific service class - }; + 2) sugar syntax -1; + 3) when / when not COMPONENT should be called -##### To start with + 4) problems when get_all_components() is called when there is no 'context' yet -package MyApp::Container; -use Moose; + 5) Back compat problems: + - expand_component_module + - $instance->expand_modules + - search_extra + - what to do when a user overrides the locate_components method? -extends 'Catalyst::Container; + 6) locate_components service vs setup_components method + - can we be more lazy? + - should setup_components be a service that things like the ->component lookup + can depend on? -after BUILD => sub { - my $self = shift; - my $model_container = $self->get_sub_container('model'); - my $service = Catalyst::IOC::ConstructorInjection->new( - name => 'Baz', - class => 'MyApp::Model::Baz', - dependencies => [ - depends_on( '/application_name' ), - depends_on( '/config' ), - depends_on( '/model/Foo' ), - ], - lifecycle => 'InstancePerContext', - ); - $model_container->add_service( 'Foo', $service ); -}; + 7) $class->log->warn is being used to give warnings, but maybe there is a + better way to do it -### To polish off / t0m review + 8) the ConstructorInjection depends on the application_name, which probably + makes app/ctx split harder. We need a way to get the application instance + passed properly. - - + $class->container->get_sub_container('model')->make_single_default; - + $class->container->get_sub_container('view')->make_single_default; + 9) there is a call in Catalyst::Controller to catalyst_component_name class + accessor (which doesn't exist anymore). - +sub controller { shift->_lookup_mvc('controller', @_) } + 10) make ACCEPT_CONTEXT and COMPONENT optional in Catalyst::IOC::BlockInjection and Catalyst::IOC::ConstructorInjection + - Create COMPONENTSingleton life cycle - get_components_names_types + 11) we build the service too early, causing the COMPONENT method to be + called early, breaking components which build other components (e.g. + Model::DBIC::Schema). - locate_components + 12) root service has a very ambiguous name - maybe root_dir? - +# FIXME - t0m, how do you feel about this name? - +# also, do you think I should draw it here, or just return the data structure? - +sub get_components_names_types { + 13) should _get_component_type_name (in Catalyst::IOC::Container) exist? - + MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = { + 14) Test cases for extending the container in an application. + - Using the sugar added in the previous item + - Test when Model::Foo depends_on Model::Bar + - Test for component Foo => ( lifecycle => 'Singleton', class => 'My::External::Class', dependencies => { config => depends_on("config") } ) + - Fix ^^ so that you can get your component's namespaced config nicely. - +# FIXME - just till I understand how it's supposed to be done - +# Made this so that COMPONENT is executed once, - +# and ACCEPT_CONTEXT every call. - +has instance => ( - + is => 'rw', + 15) Tests for using the container outside of Catalyst + - Custom container which adds some (very simple) services which are initialized from + the application config file (note plain services, not components) + - Depend on (and test) these inside Catalyst + - Test loading container outside Catalyst, and these services working + - Test Catalyst / MyApp is not loaded - # This is ok?? - +my $applevel_config = TestAppContainer->container->resolve(service => 'config')->{applevel_config}; - +__PACKAGE__->config(applevel_config => 'foo'); + 16) _build_(request|response)_constructor_args need replicating in + this branch. +### Next steps - +Same as L, but for controllers. The difference is - +that there is no ACCEPT_CONTEXT for controllers. - ^^ This is wrong!! - - - my $accept_context_args = $self->param('accept_context_args'); - + my $accept_context_args = $params{accept_context_args}; - ^^ This is wrong! The service should be allowed to mangle the accept_context args, no? - Without this change, the user could make a custom service which mangled the param, and use - Catalyst/IOC/Service/WithAcceptContext.pm, with this change, that module will always see the - un-mangled version?? + - Push the config built in the container back up onto the app - accept_context_args - where does this come from? - - + $purity = $purity // 1; - ^^ perl 5.10 only + - Find a better way to make path_to work. Current fix is in + Catalyst::IOC::Container, subs build_home_service, build_root_service. -### Known issues + - Improve validation on the 'component' methods in Catalyst::IOC + (check the type of the component, etc) - - Broken $instance->expand_modules() in setup_components and figure - out later how to bring it back + - Thigs to test: + - Imports getting the importing package in Catalyst::IOC + - Back compat for Catalyst.pm moved methods (locate_components) + - Custom container + - writing some tests which verify that the models you think should be + there are there, and that they received their dependencies as arguments + - i.e. Model::Bar should get params { foo => $model_foo } when being + constructed, etc + - Need to test that if you have a standard component Frotz + and a customized component Fnar, and Fnar depends on Frotz + - And yeah, some tests that the customised components actually work via + $c->model('Foo'), and that COMPONENT is called (or not called) + as appropiate and that ACCEPT_CONTEXT is called (or not) as appropriate - - expand_component_module +#### Extending my app, notes + +Basically try to implement something like this (starting out without the sugar!), and see how it breaks +and what needs to be done to fix it! + +##### Eventual syntax + +package MyApp::Container; +use Catalyst::IOC; + + container $self, as { + container model => as { + component Foo => (); # As per default! + component Bar => (dependencies => ['/model/Foo']); # Magic! + component Baz => ( lifecycle => 'InstancePerContext ); + component Quux => ( lifecycle => 'Singleton' ); # ACCEPT_CONTEXT not called + # Catalyst::Model::Adaptor example + component Fnar => ( lifecycle => 'Singleton', class => 'My::External::Class', dependencies => { config => depends_on('config')} ); + # ^^ FIXME - gets whole config, not Model::Foo + # There should be a 'nice' way to get the 'standard' config + }; + # Note - implementation of BB may need to be changed to support making sure existing + # services actually get overridden. not sure how the default container behaves when doing that + # above code would build the constructor injection as it currently does, + # defaulting to the class name in the right namespace as declared by the surrounding container + # as well as adding using the catalyst-specific service class + }; + +1;