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
## GSOC
-### Next large steps, planned:
-
-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
-
- - 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
-
- - 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)
-
-### Next steps - less planned:
-
- - Creating service()-like sugar for component
-
- - 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
-
- a) configure additional services in that container
- - super simple container $default_container => as { more services };
- class MyApp::Container extends Catalyst::Container {
- use Bread::Board; # Or our own sugar?
- method BUILD { container $self => as {
- service model => ...; # some constructor injection to MyApp::Model or something
- container Model => as {
- component Foo => (dependencies => ['/model']); # As per default!
- component Bar => (dependencies => ['/model/Foo']); # Magic!
- };
- # 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
- } }
- };
-
- let's consider the usage patterns we actually want to enable by doing the whole B::B thing
- what happens if i make the "per-app" service for a component life only for the duration of the request?
- or be instanciated every time i look up the component?
- (or scoping it per session, or having a block injection, or something)
-
- say you override the app service to be per-request
- now the wrapper for the per-request variant doesn't make sense anymore. does it?
- because you're only overriding one half of what has been generated automatically
+### Final steps for GSOC
- ah, so you have basically ended up with getting a request scoped thing to be used to construct a request scoped thing, which is pointless? Would/could you not just override the
- service which is actually getting looked up instead, and make it not depend on the auto-generated per-app scope service, which will then just never be built?
+##### Things that work:
- yes, you could. but then you'd have to be aware of the distinction
- which is what i hoped to be a barely visible backcompat thing
- but which i'm afraid it won't be if we go for two actual separate services
+ - the default container loads all components, calls ACCEPT_CONTEXT() when appropriate, and COMPONENT() when appropriate, behaving like current Catalyst does
- what stops the sugar we give from not just making you specify the lifecycle, and giving you the obvious name / wiring?
- i.e. everything looks like 'Foo', so you don't have to know COMPONENT/Foo exists
+ - its possible to create a custom container, and override the components you want. Lifecycle, class, dependencies, all overridable.
- my hopes of not needing any sugar at all, i guess
+ - config files are loaded without Catalyst::Plugin::ConfigLoader
- only a couple of new lifecycles to be registered with the container - ??
+ - per request life cycle somewhat works
+ - external modules are loaded just using a custom container, much like Catalyst::Model::Adaptor
-### To polish off / t0m review
-
- - + $class->container->get_sub_container('model')->make_single_default;
- + $class->container->get_sub_container('view')->make_single_default;
-
- get_components_names_types
-
- locate_components
-
- +# 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 {
-
- + MyApp->config->{ 'Plugin::ConfigLoader' }->{ substitutions } = {
-
- +# 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',
-
- # This is ok??
- +my $applevel_config = TestAppContainer->container->resolve(service => 'config')->{applevel_config};
- +__PACKAGE__->config(applevel_config => 'foo');
+##### Things that don't work:
+ - expand_component_module
- accept_context_args - where does this come from?
+ - 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 { ... };
+ ...
+ }
-### Known issues
+##### Items for discussion and planning
+# (in no particular order, just numbered to be more easily refered to)
- - Broken $instance->expand_modules() in setup_components and figure
- out later how to bring it back
+ 1) per request life cycle
- - expand_component_module
+ 2) sugar syntax
+ 3) when / when not COMPONENT should be called
+
+ 4) problems when get_all_components() is called when there is no 'context' yet
+
+ 5) Back compat problems:
+ - expand_component_module
+ - $instance->expand_modules
+ - search_extra
+ - what to do when a user overrides the locate_components method?
+
+ 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?
+
+ 7) $class->log->warn is being used to give warnings, but maybe there is a
+ better way to do it
+
+ 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.
+
+ 9) there is a call in Catalyst::Controller to catalyst_component_name class
+ accessor (which doesn't exist anymore).
+
+ 10) make ACCEPT_CONTEXT and COMPONENT optional in Catalyst::IOC::BlockInjection and Catalyst::IOC::ConstructorInjection
+ - Create COMPONENTSingleton life cycle
+
+ 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).
+
+ 12) root service has a very ambiguous name - maybe root_dir?
+
+ 13) should _get_component_type_name (in Catalyst::IOC::Container) exist?
+
+ 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.
+
+ 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
+
+ 16) _build_(request|response)_constructor_args need replicating in
+ this branch.
+
+### Next steps
+
+ - Push the config built in the container back up onto the app
+
+ - Find a better way to make path_to work. Current fix is in
+ Catalyst::IOC::Container, subs build_home_service, build_root_service.
+
+ - Improve validation on the 'component' methods in Catalyst::IOC
+ (check the type of the component, etc)
+
+ - 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
+
+
+#### 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;
projects / catagits/Catalyst-Runtime.git / blobdiff