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:
-
- - Finished documentation for ::IOC parts.
-
- - 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
+### Final steps for GSOC
- - Allowing people to change component lifecycles
+##### Things that work:
- role Service::WithAcceptContext {}
- role Service::WithCOMPONENT {}
- class Service::CatalystComponent extends Service with (WithAcceptContext, WithCOMPONENT) {}
+ - the default container loads all components, calls ACCEPT_CONTEXT() when appropriate, and COMPONENT() when appropriate, behaving like current Catalyst does
- 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
- } }
- };
- b) make component services depend on that, and
+ - its possible to create a custom container, and override the components you want. Lifecycle, class, dependencies, all overridable.
+ - config files are loaded without Catalyst::Plugin::ConfigLoader
- c) ask for those
- services declared in a) outside of a web context
- simple as well. $customised_container->fetch('service')->get # or whatever the api was
+ - per request life cycle somewhat works
-19:23 < andrewalker> edenc, when explaining to me how it should be, drafted this: https://gist.github.com/1098186
-19:26 < edenc> I like the possibility of being able to provide a backwards-compatible structure which we can muck around with by configuring B::B
-19:26 <@rafl> so, the request context clearly isn't a service
-19:27 <@rafl> but that's ok. there's parametrised services
-19:27 < edenc> yeah, that was a draft
-19:27 <@rafl> the outer Foo service is pretty much what i'd expect Service::WithAcceptContext to do, except with a dependency on a context instead of a service parameter
-19:32 <@rafl> actually having services for the pre-ACCEPT_CONTEXT bits is what i want to think about
+ - external modules are loaded just using a custom container, much like Catalyst::Model::Adaptor
-### To polish off
+##### Things that don't work:
- - Document current methods
- - + $class->container->get_sub_container('model')->make_single_default;
-+ $class->container->get_sub_container('view')->make_single_default;
-
-### Known issues
+ - expand_component_module
- - Broken $instance->expand_modules() in setup_components and figure
- out later how to bring it back
+ - 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 { ... };
+ ...
+ }
- - expand_component_module
+##### Items for discussion and planning
+# (in no particular order, just numbered to be more easily refered to)
+ 1) per request life cycle
+
+ 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
+
+### 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;