X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?p=catagits%2FCatalyst-Runtime.git;a=blobdiff_plain;f=lib%2FCatalyst%2FUpgrading.pod;h=ebfa2a35a7b8f10ee800dffc66be621c874f6f2e;hp=1955bfb642845dba22be309dd82fd48a74669ef9;hb=772bd9deac85d462d77bfe2cbbe73f3de1688ebf;hpb=e60068484721132e6fe1855f53f9542d8bb17a35 diff --git a/lib/Catalyst/Upgrading.pod b/lib/Catalyst/Upgrading.pod index 1955bfb..ebfa2a3 100644 --- a/lib/Catalyst/Upgrading.pod +++ b/lib/Catalyst/Upgrading.pod @@ -2,10 +2,111 @@ Catalyst::Upgrading - Instructions for upgrading to the latest Catalyst +=head1 Upgrading to Catalyst 5.90080 + +UTF8 encoding is now default. For temporary backwards compatibility, if this +change is causing you trouble, you can disable it by setting the application +configuration option to undef: + + MyApp->config(encoding => undef); + +But please consider this a temporary measure since it is the intention that +UTF8 is enabled going forwards and the expectation is that other ecosystem +projects will assume this as well. At some point you application will not +correctly function without this setting. + +As of 5.90084 we've added two additional configuration flags for more selective +control over some encoding changes: 'skip_body_param_unicode_decoding' and +'skip_complex_post_part_handling'. You may use these to more selectively +disable new features while you are seeking a long term fix. Please review +CONFIGURATION in L. + +For further information, please see L + +A number of projects in the wider ecosystem required minor updates to be able +to work correctly. Here's the known list: + +L, L, L, +L, L + +You will need to update to modern versions in most cases, although quite a few +of these only needed minor test case and documentation changes so you will need +to review the changelog of each one that is relevant to you to determine your +true upgrade needs. + +=head1 Upgrading to Catalyst 5.90060 + +Starting in the v5.90059_001 development release, the regexp dispatch type is +no longer automatically included as a dependency. If you are still using this +dispatch type, you need to add L into your build +system. + +The standalone distribution of Regexp will be supported for the time being, but +should we find that supporting it prevents us from moving L forward +in necessary ways, we reserve the right to drop that support. It is highly +recommended that you use this last stage of deprecation to change your code. + +=head1 Upgrading to Catalyst 5.90040 + +=head2 Catalyst::Plugin::Unicode::Encoding is now core + +The previously stand alone Unicode support module L +has been brought into core as a default plugin. Going forward, all you need is +to add a configuration setting for the encoding type. For example: + + package Myapp::Web; + + use Catalyst; + + __PACKAGE__->config( encoding => 'UTF-8' ); + +Please note that this is different from the old stand alone plugin which applied +C encoding by default (that is, if you did not set an explicit +C configuration value, it assumed you wanted UTF-8). In order to +preserve backwards compatibility you will need to explicitly turn it on via the +configuration setting. THIS MIGHT CHANGE IN THE FUTURE, so please consider +starting to test your application with proper UTF-8 support and remove all those +crappy hacks you munged into the code because you didn't know the Plugin +existed :) + +For people that are using the Plugin, you will note a startup warning suggesting +that you can remove it from the plugin list. When you do so, please remember to +add the configuration setting, since you can no longer rely on the default being +UTF-8. We'll add it for you if you continue to use the stand alone plugin and +we detect this, but this backwards compatibility shim will likely be removed in +a few releases (trying to clean up the codebase after all). + +If you have trouble with any of this, please bring it to the attention of the +Catalyst maintainer group. + +=head2 basic async and event loop support + +This version of L offers some support for using L and +L event loops in your application. These changes should work +fine for most applications however if you are already trying to perform +some streaming, minor changes in this area of the code might affect your +functionality. Please see L for more and for a +basic example. + +We consider this feature experimental. We will try not to break it, but we +reserve the right to make necessary changes to fix major issues that people +run into when the use this functionality in the wild. + +=head1 Upgrading to Catalyst 5.90030 + +=head2 Regex dispatch type is deprecated. + +The Regex dispatchtype (L) has been deprecated. + +You are encouraged to move your application to Chained dispatch (L). + +If you cannot do so, please add a dependency to Catalyst::DispatchType::Regex to your application's +Makefile.PL + =head1 Upgrading to Catalyst 5.9 The major change is that L, a toolkit for using the L -stack, now replaces most of the subclasses of L. If +specification, now replaces most of the subclasses of L. If you are using one of the standard subclasses of L this should be a straightforward upgrade for you. It was a design goal for this release to preserve as much backwards compatibility as possible. @@ -43,12 +144,16 @@ to use L. =head2 Upgrading the mod_perl / Apache Engines The engines that are built upon the various iterations of mod_perl, -L and L, -should be seamless upgrades and will work using using -L or L as required. +L (for mod_perl 1, and Apache 1.x) and +L (for mod_perl 2, and Apache 2.x), +should be seamless upgrades and will work using L +or L as required. L, however, is no longer supported, as -Plack does not support mod_perl version 1.99 +Plack does not support mod_perl version 1.99. This is unlikely to be a +problem for anyone, as 1.99 was a brief beta-test release for mod_perl +2, and all users of mod_perl 1.99 are encouraged to upgrade to a +supported release of Apache 2 and mod_perl 2. =head2 Upgrading the HTTP Engine @@ -61,7 +166,7 @@ script is upgraded to use L. If you were using L there is no upgrade needed if your myapp_cgi.pl script is already upgraded to use L. -=head2 Upgrading the Preforking Engine +=head2 Upgrading Catalyst::Engine::HTTP::Prefork If you were using L then L is automatically loaded. You should (at least) change your C @@ -137,7 +242,6 @@ In the simplest case: becomes - MyCatalystApp->setup_engine('PSGI'); my $app = MyCatalystApp->psgi_app(@_); B: @@ -153,6 +257,10 @@ any tests run via L will not be compatible with the new release, and will result in the development server starting, rather than the expected test running. +B If you are directly accessing C<< $c->req->env >> to get the PSGI +environment then this accessor is moved to C<< $c->engine->env >>, +you will need to update your code. + =head2 Engines which are known to be broken The following engines B work as of Catalyst version 5.9. The @@ -190,10 +298,6 @@ Reports are highly encouraged: =back -=head2 Specifying the engine in the call to ->setup - -XXX FIXME - =head2 Plack functionality See L. @@ -220,7 +324,7 @@ been made which could cause incompatibilities. If your application or plugin is using deprecated code, or relying on side effects, then you could have issues upgrading to this release. -Most issues found with pre-existing components have been easy to +Most issues found with existing components have been easy to solve. This document provides a complete description of behavior changes which may cause compatibility issues, and of new Catalyst warnings which might be unclear. @@ -278,7 +382,7 @@ replaces L with L, forcing all components to resolve methods using C3, rather than the unpredictable dispatch order of L. -This issue is characterised by your application failing to start due to an +This issue manifests itself by your application failing to start due to an error message about having a non-linear @ISA. The Catalyst plugin most often causing this is @@ -485,7 +589,7 @@ The following test demonstrates the problem: use Test::More; isnt(BaseClass->can('foo'), Child->can('foo')); -=head2 Extending Catalyst::Request or other classes in an ad-hoc manner using mk_accessors +=head2 Extending Catalyst::Request or other classes in an ad hoc manner using mk_accessors Previously, it was possible to add additional accessors to Catalyst::Request (or other classes) by calling the mk_accessors class method. @@ -512,6 +616,13 @@ The correct fix is to re-arrange your class's inheritance hierarchy so that the COMPONENT method you would like to inherit is the first (left-hand most) COMPONENT method in your @ISA. +=head2 Development server relying on environment variables + +Previously, the development server would allow propagation of system +environment variables into the request environment, this has changed with the +adoption of Plack. You can use L to achieve the +same effect. + =head1 WARNINGS =head2 Actions in your application class @@ -519,7 +630,7 @@ COMPONENT method in your @ISA. Having actions in your application class will now emit a warning at application startup as this is deprecated. It is highly recommended that these actions are moved into a MyApp::Controller::Root (as demonstrated by the scaffold application -generated by catalyst.pl). +generated by catalyst.pl). This warning, also affects tests. You should move actions in your test, creating a myTest::Controller::Root, like the following example: @@ -535,7 +646,7 @@ creating a myTest::Controller::Root, like the following example: sub action : Local { my ( $self, $c ) = @_; - $c->do_something; + $c->do_something; } 1;