X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FDelta.pod;h=bbc1a364ac0062c46c5bbcedd37a6e9d523d57b7;hp=81cd3198fcd1b9fd37bf6e24c9d1d856b2daf875;hb=c1192f1ed63f124eb2d143e10b215703e7dc6284;hpb=14eb7697d007e9e1b08be593846233533a880f60 diff --git a/lib/Catalyst/Delta.pod b/lib/Catalyst/Delta.pod index 81cd319..bbc1a36 100755 --- a/lib/Catalyst/Delta.pod +++ b/lib/Catalyst/Delta.pod @@ -4,7 +4,216 @@ Catalyst::Delta - Overview of changes between versions of Catalyst =head1 DESCRIPTION -This is an overview of the user-visible changes to Catalyst between major Catalyst releases. +This is an overview of the user-visible changes to Catalyst between major +Catalyst releases. + +=head2 VERSION 5.90090+ + +=head2 Type constraints on Args and CaptureArgs. + +You may now use a type constraint (using L, L or preferably +L in your Args or CaptureArgs action attributes. This can be used +to restrict the value of the Arg. For example: + + sub myaction :Local Args(Int) { ... } + +Would match '.../myaction/5' but not '.../myaction/string'. + +When an action (or action chain) has Args (or CaptureArgs) that declare type constraints +your arguments to $c->uri_for(...) must match those constraints. + +See L for more. + +=head2 VERSION 5.90080+ + +The biggest change in this release is that UTF8 encoding is now enabled by +default. So you no longer need any plugins (such as L) +which you can just no go ahead and remove. You also don't need to set +the encoding configuration (__PACKAGE__->config(encoding=>'UTF-8')) anymore +as well (although its presence hurts nothing). + +If this change causes you trouble, you can disable it: + + __PACKAGE__->config(encoding=>undef); + +For further information, please see L + +But please report bugs. You will find that a number of common Views have been +updated for this release (such as L). In all cases that the +author is aware of these updates were to fix test cases only. You shouldn't +need to update unless you are installing fresh and want tests to pass. + +L was updated to be compatible with this release. +You will need to upgrade if you are using this plugin. L +also has details. + +A small change is that the configuration setting C +was not doing the right thing if you started your application with C +and did not apply the default middleware. This setting is now honored in +all the ways an application may be started. This could cause trouble if you +are using the configuration value and also adding the proxy middleware +manually with a custom application startup. The solution is that you only +need the configuration value set, or the middleware manually added (not both). + +=head2 VERSION 5.90060+ + +=head3 Catalyst::Log object autoflush on by default + +Starting in 5.90065, the Catalyst::Log object has 'autoflush' which is on +by default. This causes all messages to be written to the log immediately +instead of at the end of startup and then at the end of each request. In +order to access the old behavior, you must now call: + + $c->log->autoflush(0); + +=head3 Deprecate Catalyst::Utils::ensure_class_loaded + +Going forward we recommend you use L. In fact we will +be converting all uses of L to L. We will +also convert L to be based on +L to allow some time for you to update code, however at +some future point this method will be removed so you should stop +using it now. + +=head3 Support passing Body filehandles directly to your Plack server. + +We changed the way we return body content (from response) to whatever +Plack handler you are using (Starman, FastCGI, etc.) We no longer +always use the streaming interface for the cases when the body is a +simple scalar, object or filehandle like. In those cases we now just +pass the simple response on to the plack handler. This might lead to +some minor differences in how streaming is handled. For example, you +might notice that streaming starts properly supporting chunked encoding when +on a server that supports that, or that previously missing headers +(possible content-length) might appear suddenly correct. Also, if you +are using middleware like L and are using +a filehandle that sets a readable path, your server might now correctly +handle the file (rather than as before where Catalyst would stream it +very likely very slowly). + +In other words, some things might be meaninglessly different and some +things that were broken codewise but worked because of Catalyst being +incorrect might suddenly be really broken. The behavior is now more +correct in that Catalyst plays better with features that Plack offers +but if you are making heavy use of the streaming interface there could +be some differences so you should test carefully (this is probably not +the vast majority of people). In particular if you are developing +using one server but deploying using a different one, differences in +what those server do with streaming should be noted. + +Please see note below about changes to filehandle support and existing +Plack middleware to aid in backwards compatibility. + +=head3 Distinguish between body null versus undef. + +We also now more carefully distingush the different between a body set +to '' and a body that is undef. This might lead to situations where +again you'll get a content-length were you didn't get one before or +where a supporting server will start chunking output. If this is an +issue you can apply the middleware L +or report specific problems to the dev team. + +=head3 More Catalyst Middleware + +We have started migrating code in Catalyst to equivilent Plack +Middleware when such exists and is correct to do so. For example we now use +L to determine content length of a response +when none is provided. This replaces similar code inlined with L +The main advantages to doing this is 1) more similar Catalyst core that is +focused on the Catalyst special sauce, 2) Middleware is more broadly shared +so we benefit from better collaboration with developers outside Catalyst, 3) +In the future you'll be able to change or trim the middleware stack to get +additional performance when you don't need all the checks and constraints. + +=head3 Deprecate Filehandle like objects that do read but not getline + +We also deprecated setting the response body to an object that does 'read' +but not 'getline'. If you are using a custom IO-Handle like object for +response you should verify that 'getline' is supported in your interface. +Unless we here this case is a major issue for people, we will be removing support +in a near future release of Catalyst. When the code encounters this it +will issue a warning. You also may run into this issue with L +which does read but not getline. For now we will just warn when encountering +such an object and fallback to the previous behavior (where L +itself unrolls the filehandle and performs blocking streams). However +this backwards compatibility will be removed in an upcoming release so you should either +rewrite your custom filehandle objects to support getline or start using the +middleware that adapts read for getline L. + +=head3 Response->headers become read-only after finalizing + +Once the response headers are finalized, trying to change them is not allowed +(in the past you could change them and this would lead to unexpected results). + +=head3 Officially deprecate L + +L is also officially no longer supported. We will +no long run test cases against this and can remove backwards compatibility code for it +as deemed necessary for the evolution of the platform. You should simply +discontinue use of this engine, as L has been PSGI at the core for +several years. + +=head3 Officially deprecate finding the PSGI $env anyplace other than Request + +A few early releases of Cataplack had the PSGI $env in L. +Code has been maintained here for backwards compatibility reasons. This is no +longer supported and will be removed in upcoming release, so you should update +your code and / or upgrade to a newer version of L + +=head3 Deprecate setting Response->body after using write/write_fh + +Setting $c->res->body to a filehandle after using $c->res->write or +$c->res->write_fh is no longer considered allowed, since we can't send +the filehandle to the underlying Plack handler. For now we will continue +to support setting body to a simple value since this is possible, but at +some future release a choice to use streaming indicates that you will do +so for the rest of the request. + + +=head2 VERSION 5.90053 + +We are now clarifying the behavior of log, plugins and configuration during +the setup phase. Since Plugins might require a log during setup, setup_log +must run BEFORE setup_plugins. This has the unfortunate side effect that +anyone using the popular ConfigLoader plugin will not be able to supply +configuration to custom logs since the configuration is not yet finalized +when setup_log is run (when using ConfigLoader, which is a plugin and is +not loaded until later.) + +As a workaround, you can supply custom log configuration directly into +the configuration: + + package MyApp; + use Catalyst; + + __PACKAGE__->config( + my_custom_log_info => { %custom_args }, + ); + + __PACKAGE__->setup; + +If you wish to configure the custom logger differently based on ENV, you can +try: + + package MyApp; + + use Catalyst; + use Catalyst::Utils; + + __PACKAGE__->config( + Catalyst::Utils::merge_hashes( + +{ my_custom_log_info => { %base_custom_args } }, + +{ do __PACKAGE__->path_to( $ENV{WHICH_CONF}."_conf.pl") }, + ), + ); + + __PACKAGE__->setup; + +Or create a standalone Configuration class that does the right thing. + +Basically if you want to configure a logger via Catalyst global configuration +you can't use ConfigLoader because it will always be loaded too late to be of +any use. Patches and workaround options welcomed! =head2 VERSION 5.9XXXX 'cataplack' @@ -89,7 +298,7 @@ Below is a brief list of features which have been deprecated in this release: =item MyApp->plugin method is deprecated, use L instead. -=item __PACKAGE__->mk_accessors() is supported for backward compatibility only, use Moose attributes instead in new code. +=item __PACKAGE__->mk_accessors() is supported for backwards compatibility only, use Moose attributes instead in new code. =item Use of Catalyst::Base now warns @@ -167,7 +376,7 @@ classes are better implemented as Moose roles. =item * -L is used to contain action +L is used to contain action attributes. This means that attributes are represented in the MOP, and decouples action creation from attributes.