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=63861b47a2c665667d9867ebd4fe5f56f1e0d142;hp=510b61d592a5335fe705448f55693bedf5d98de6;hb=ba7766f8c39cc6120177c4fe7a2f1918481213ed;hpb=995ed4d7bb67c1fa536b9861f7a9e09f3be5f86d diff --git a/lib/Catalyst/Upgrading.pod b/lib/Catalyst/Upgrading.pod index 510b61d..63861b4 100644 --- a/lib/Catalyst/Upgrading.pod +++ b/lib/Catalyst/Upgrading.pod @@ -2,6 +2,69 @@ Catalyst::Upgrading - Instructions for upgrading to the latest Catalyst +=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). + +B: One other difference between the cored plugin and the stand alone one +is that in core we no longer throw an exception when there's a decode failure +but instead log a warning. If you rely on exceptions for control flow, you +will need to override method C to die instead +of warning. Please let the dev team know if this is a problem for you. + +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 @@ -65,7 +128,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 @@ -156,6 +219,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 @@ -219,7 +286,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. @@ -277,7 +344,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 @@ -484,7 +551,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. @@ -511,6 +578,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