3 Catalyst::Upgrading - Instructions for upgrading to the latest Catalyst
5 =head1 Upgrading to Catalyst 5.90090
7 L<Catalyst::Utils> has a new method 'inject_component' which works the same as the method of
8 the same name in L<CatalystX::InjectComponent>. You should start converting any
9 use of the non core method in your code as future changes to Catalyst will be
10 sychronized to the core method first. We reserve the right to cease support
11 of the non core version should we reach a point in time where it cannot be
12 properly supported as an external module. Luckily this should be a trivial
13 search and replace. Change all occurances of:
15 CatalystX::InjectComponent->inject(...)
19 Catalyst::Utils::inject_component(...)
21 and we expect everything to work the same (we'd consider it not working the same
22 to be a bug, and please report it.)
24 We also cored features from L<CatalystX::RoleApplicator> to compose a role into the
25 request, response and stats classes. The main difference is that with L<CatalystX::RoleApplicator>
31 use CatalystX::RoleApplicator;
33 __PACKAGE__->apply_request_class_roles(
34 qw/My::Request::Role Other::Request::Role/);
36 Whereas now we have three class attributes, 'request_class_traits', 'response_class_traits'
37 and 'stats_class_traits', so you use like this (note this value is an ArrayRef)
44 __PACKAGE__->request_class_traits([qw/
46 Other::Request::Role/]);
48 (And the same for response_class_traits and stats_class_traits. We left off the
49 traits for Engine, since that class does a lot less nowadays, and dispatcher. If you
50 used those and can share a use case, we'd be likely to support them.
52 =head1 Upgrading to Catalyst 5.90085
54 In this version of Catalyst we made a small change to Chained Dispatching so
55 that when two or more actions all have the same path specification AND they
56 all have Args(0), we break the tie by choosing the last action defined, and
57 not the first one defined. This was done to normalize Chaining to following
58 the 'longest Path wins, and when several actions match the same Path specification
59 we choose the last defined.' rule. Previously Args(0) was hard coded to be a special
60 case such that the first action defined would match (which is not the case when
63 Its possible that this could be a breaking change for you, if you had used
64 action roles (custom or otherwise) to add additional matching rules to differentiate
65 between several Args(0) actions that share the same root action chain. For
66 example if you have code now like this:
68 sub check_default :Chained(/) CaptureArgs(0) { ... }
70 sub default_get :Chained('check_default') PathPart('') Args(0) GET {
71 pop->res->body('get3');
74 sub default_post :Chained('check_default') PathPart('') Args(0) POST {
75 pop->res->body('post3');
78 sub chain_default :Chained('check_default') PathPart('') Args(0) {
79 pop->res->body('chain_default');
82 The way that chaining will work previous is that when two or more equal actions can
83 match, the 'top' one wins. So if the request is "GET .../check_default" BOTH
84 actions 'default_get' AND 'chain_default' would match. To break the tie in
85 the case when Args is 0, we'd previous take the 'top' (or first defined) action.
86 Unfortunately this treatment of Args(0) is special case. In all other cases
87 we choose the 'last defined' action to break a tie. So this version of
88 Catalyst changed the dispatcher to make Args(0) no longer a special case for
89 breaking ties. This means that the above code must now become:
91 sub check_default :Chained(/) CaptureArgs(0) { ... }
93 sub chain_default :Chained('check_default') PathPart('') Args(0) {
94 pop->res->body('chain_default');
97 sub default_get :Chained('check_default') PathPart('') Args(0) GET {
98 pop->res->body('get3');
101 sub default_post :Chained('check_default') PathPart('') Args(0) POST {
102 pop->res->body('post3');
105 If we want it to work as expected (for example we we GET to match 'default_get' and
106 POST to match 'default_post' and any other http Method to match 'chain_default').
108 In other words Arg(0) and chained actions must now follow the normal rule where
109 in a tie the last defined action wins and you should place all your less defined
110 or 'catch all' actions first.
112 If this causes you trouble and you can't fix your code to conform, you may set the
113 application configuration setting "use_chained_args_0_special_case" to true and
114 that will revert you code to the previous behavior.
116 =head2 More backwards compatibility options with UTF-8 changes
118 In order to give better backwards compatiblity with the 5.90080+ UTF-8 changes
119 we've added several configuration options around control of how we try to decode
120 your URL keywords / query parameters.
122 C<do_not_decode_query>
124 If true, then do not try to character decode any wide characters in your
125 request URL query or keywords. Most readings of the relevent specifications
126 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
127 will use, hwoever if you are creating a lot of URLs manually or have external
128 evil clients, this might cause you trouble. If you find the changes introduced
129 in Catalyst version 5.90080+ break some of your query code, you may disable
130 the UTF-8 decoding globally using this configuration.
132 This setting takes precedence over C<default_query_encoding> and
133 C<decode_query_using_global_encoding>
135 C<default_query_encoding>
137 By default we decode query and keywords in your request URL using UTF-8, which
138 is our reading of the relevent specifications. This setting allows one to
139 specify a fixed value for how to decode your query. You might need this if
140 you are doing a lot of custom encoding of your URLs and not using UTF-8.
142 This setting take precedence over C<decode_query_using_global_encoding>.
144 C<decode_query_using_global_encoding>
146 Setting this to true will default your query decoding to whatever your
147 general global encoding is (the default is UTF-8).
150 =head1 Upgrading to Catalyst 5.90080
152 UTF8 encoding is now default. For temporary backwards compatibility, if this
153 change is causing you trouble, you can disable it by setting the application
154 configuration option to undef:
156 MyApp->config(encoding => undef);
158 But please consider this a temporary measure since it is the intention that
159 UTF8 is enabled going forwards and the expectation is that other ecosystem
160 projects will assume this as well. At some point you application will not
161 correctly function without this setting.
163 As of 5.90084 we've added two additional configuration flags for more selective
164 control over some encoding changes: 'skip_body_param_unicode_decoding' and
165 'skip_complex_post_part_handling'. You may use these to more selectively
166 disable new features while you are seeking a long term fix. Please review
167 CONFIGURATION in L<Catalyst>.
169 For further information, please see L<Catalyst::UTF8>
171 A number of projects in the wider ecosystem required minor updates to be able
172 to work correctly. Here's the known list:
174 L<Catalyst::View::TT>, L<Catalyst::View::Mason>, L<Catalyst::View::HTML::Mason>,
175 L<Catalyst::View::Xslate>, L<Test::WWW::Mechanize::Catalyst>
177 You will need to update to modern versions in most cases, although quite a few
178 of these only needed minor test case and documentation changes so you will need
179 to review the changelog of each one that is relevant to you to determine your
182 =head1 Upgrading to Catalyst 5.90060
184 Starting in the v5.90059_001 development release, the regexp dispatch type is
185 no longer automatically included as a dependency. If you are still using this
186 dispatch type, you need to add L<Catalyst::DispatchType::Regex> into your build
189 The standalone distribution of Regexp will be supported for the time being, but
190 should we find that supporting it prevents us from moving L<Catalyst> forward
191 in necessary ways, we reserve the right to drop that support. It is highly
192 recommended that you use this last stage of deprecation to change your code.
194 =head1 Upgrading to Catalyst 5.90040
196 =head2 Catalyst::Plugin::Unicode::Encoding is now core
198 The previously stand alone Unicode support module L<Catalyst::Plugin::Unicode::Encoding>
199 has been brought into core as a default plugin. Going forward, all you need is
200 to add a configuration setting for the encoding type. For example:
206 __PACKAGE__->config( encoding => 'UTF-8' );
208 Please note that this is different from the old stand alone plugin which applied
209 C<UTF-8> encoding by default (that is, if you did not set an explicit
210 C<encoding> configuration value, it assumed you wanted UTF-8). In order to
211 preserve backwards compatibility you will need to explicitly turn it on via the
212 configuration setting. THIS MIGHT CHANGE IN THE FUTURE, so please consider
213 starting to test your application with proper UTF-8 support and remove all those
214 crappy hacks you munged into the code because you didn't know the Plugin
217 For people that are using the Plugin, you will note a startup warning suggesting
218 that you can remove it from the plugin list. When you do so, please remember to
219 add the configuration setting, since you can no longer rely on the default being
220 UTF-8. We'll add it for you if you continue to use the stand alone plugin and
221 we detect this, but this backwards compatibility shim will likely be removed in
222 a few releases (trying to clean up the codebase after all).
224 If you have trouble with any of this, please bring it to the attention of the
225 Catalyst maintainer group.
227 =head2 basic async and event loop support
229 This version of L<Catalyst> offers some support for using L<AnyEvent> and
230 L<IO::Async> event loops in your application. These changes should work
231 fine for most applications however if you are already trying to perform
232 some streaming, minor changes in this area of the code might affect your
233 functionality. Please see L<Catalyst::Response\write_fh> for more and for a
236 We consider this feature experimental. We will try not to break it, but we
237 reserve the right to make necessary changes to fix major issues that people
238 run into when the use this functionality in the wild.
240 =head1 Upgrading to Catalyst 5.90030
242 =head2 Regex dispatch type is deprecated.
244 The Regex dispatchtype (L<Catalyst::DispatchType::Regex>) has been deprecated.
246 You are encouraged to move your application to Chained dispatch (L<Catalyst::DispatchType::Chained>).
248 If you cannot do so, please add a dependency to Catalyst::DispatchType::Regex to your application's
251 =head1 Upgrading to Catalyst 5.9
253 The major change is that L<Plack>, a toolkit for using the L<PSGI>
254 specification, now replaces most of the subclasses of L<Catalyst::Engine>. If
255 you are using one of the standard subclasses of L<Catalyst::Engine> this
256 should be a straightforward upgrade for you. It was a design goal for
257 this release to preserve as much backwards compatibility as possible.
258 However, since L<Plack> is different from L<Catalyst::Engine>, it is
259 possible that differences exist for edge cases. Therefore, we recommend
260 that care be taken with this upgrade and that testing should be greater
261 than would be the case with a minor point update. Please inform the
262 Catalyst developers of any problems so that we can fix them and
265 It is highly recommended that you become familiar with the L<Plack> ecosystem
266 and documentation. Being able to take advantage of L<Plack> development and
267 middleware is a major bonus to this upgrade. Documentation about how to
268 take advantage of L<Plack::Middleware> by writing your own C<< .psgi >> file
269 is contained in L<Catalyst::PSGI>.
271 If you have created a custom subclass of L<Catalyst:Engine>, you will
272 need to convert it to be a subclass of L<Plack::Handler>.
274 If you are using the L<Plack> engine, L<Catalyst::Engine::PSGI>, this new
275 release supersedes that code.
277 If you are using a subclass of L<Catalyst::Engine> that is aimed at
278 nonstandard or internal/testing uses, such as
279 L<Catalyst::Engine::Embeddable>, you should still be able to continue
282 Advice for specific subclasses of L<Catalyst::Engine> follows:
284 =head2 Upgrading the FastCGI Engine
286 No upgrade is needed if your myapp_fastcgi.pl script is already upgraded
287 to use L<Catalyst::Script::FastCGI>.
289 =head2 Upgrading the mod_perl / Apache Engines
291 The engines that are built upon the various iterations of mod_perl,
292 L<Catalyst::Engine::Apache::MP13> (for mod_perl 1, and Apache 1.x) and
293 L<Catalyst::Engine::Apache2::MP20> (for mod_perl 2, and Apache 2.x),
294 should be seamless upgrades and will work using L<Plack::Handler::Apache1>
295 or L<Plack::Handler::Apache2> as required.
297 L<Catalyst::Engine::Apache2::MP19>, however, is no longer supported, as
298 Plack does not support mod_perl version 1.99. This is unlikely to be a
299 problem for anyone, as 1.99 was a brief beta-test release for mod_perl
300 2, and all users of mod_perl 1.99 are encouraged to upgrade to a
301 supported release of Apache 2 and mod_perl 2.
303 =head2 Upgrading the HTTP Engine
305 The default development server that comes with the L<Catalyst> distribution
306 should continue to work as expected with no changes as long as your C<myapp_server>
307 script is upgraded to use L<Catalyst::Script::HTTP>.
309 =head2 Upgrading the CGI Engine
311 If you were using L<Catalyst::Engine::CGI> there is no upgrade needed if your
312 myapp_cgi.pl script is already upgraded to use L<Catalyst::Script::CGI>.
314 =head2 Upgrading Catalyst::Engine::HTTP::Prefork
316 If you were using L<Catalyst::Engine::HTTP::Prefork> then L<Starman>
317 is automatically loaded. You should (at least) change your C<Makefile.PL>
318 to depend on Starman.
320 You can regenerate your C<myapp_server.pl> script with C<catalyst.pl>
321 and implement a C<MyApp::Script::Server> class that looks like this:
323 package MyApp::Script::Server;
325 use namespace::autoclean;
327 extends 'CatalystX::Script::Server::Starman';
331 This takes advantage of the new script system, and will add a number of
332 options to the standard server script as extra options are added by
335 More information about these options can be seen at
336 L<CatalystX::Script::Server::Starman/SYNOPSIS>.
338 An alternate route to implement this functionality is to write a simple .psgi
339 file for your application, and then use the L<plackup> utility to start the
342 =head2 Upgrading the PSGI Engine
344 If you were using L<Catalyst::Engine::PSGI>, this new release supersedes
345 this engine in supporting L<Plack>. By default the Engine is now always
346 L<Plack>. As a result, you can remove the dependency on
347 L<Catalyst::Engine::PSGI> in your C<Makefile.PL>.
349 Applications that were using L<Catalyst::Engine::PSGI>
350 previously should entirely continue to work in this release with no changes.
352 However, if you have an C<app.psgi> script, then you no longer need to
353 specify the PSGI engine. Instead, the L<Catalyst> application class now
354 has a new method C<psgi_app> which returns a L<PSGI> compatible coderef
355 which you can wrap in the middleware of your choice.
357 Catalyst will use the .psgi for your application if it is located in the C<home>
358 directory of the application.
360 For example, if you were using L<Catalyst::Engine::PSGI> in the past, you will
361 have written (or generated) a C<script/myapp.psgi> file similar to this one:
366 MyCatalystApp->setup_engine('PSGI');
369 enable ... # enable your desired middleware
370 sub { MyCatalystApp->run(@_) };
373 Instead, you now say:
379 enable ... #enable your desired middleware
380 MyCatalystApp->psgi_app;
383 In the simplest case:
385 MyCatalystApp->setup_engine('PSGI');
386 my $app = sub { MyCatalystApp->run(@_) }
390 my $app = MyCatalystApp->psgi_app(@_);
394 my $app = sub { MyCatalystApp->psgi_app(@_) };
395 # If you make ^^ this mistake, your app won't work, and will confuse the hell out of you!
397 You can now move C<< script/myapp.psgi >> to C<< myapp.psgi >>, and the built-in
398 Catalyst scripts and your test suite will start using your .psgi file.
400 B<NOTE:> If you rename your .psgi file without these modifications, then
401 any tests run via L<Catalyst::Test> will not be compatible with the new
402 release, and will result in the development server starting, rather than
403 the expected test running.
405 B<NOTE:> If you are directly accessing C<< $c->req->env >> to get the PSGI
406 environment then this accessor is moved to C<< $c->engine->env >>,
407 you will need to update your code.
409 =head2 Engines which are known to be broken
411 The following engines B<DO NOT> work as of Catalyst version 5.9. The
412 core team will be happy to work with the developers and/or users of
413 these engines to help them port to the new Plack/Engine system, but for
414 now, applications which are currently using these engines B<WILL NOT>
415 run without modification to the engine code.
419 =item Catalyst::Engine::Wx
421 =item Catalyst::Engine::Zeus
423 =item Catalyst::Engine::JobQueue::POE
425 =item Catalyst::Engine::XMPP2
427 =item Catalyst::Engine::SCGI
431 =head2 Engines with unknown status
433 The following engines are untested or have unknown compatibility.
434 Reports are highly encouraged:
438 =item Catalyst::Engine::Mojo
440 =item Catalyst::Engine::Server (marked as Deprecated)
442 =item Catalyst::Engine::HTTP::POE (marked as Deprecated)
446 =head2 Plack functionality
448 See L<Catalyst::PSGI>.
452 Tests should generally work the same in Catalyst 5.9, but there are
455 Previously, if using L<Catalyst::Test> and doing local requests (against
456 a local server), if the application threw an exception then this
457 exception propagated into the test.
459 This behavior has been removed, and now a 500 response will be returned
460 to the test. This change standardizes behavior, so that local test
461 requests behave similarly to remote requests.
463 =head1 Upgrading to Catalyst 5.80
465 Most applications and plugins should run unaltered on Catalyst 5.80.
467 However, a lot of refactoring work has taken place, and several changes have
468 been made which could cause incompatibilities. If your application or plugin
469 is using deprecated code, or relying on side effects, then you could have
470 issues upgrading to this release.
472 Most issues found with existing components have been easy to
473 solve. This document provides a complete description of behavior changes
474 which may cause compatibility issues, and of new Catalyst warnings which
477 If you think you have found an upgrade-related issue which is not covered in
478 this document, please email the Catalyst list to discuss the problem.
480 =head1 Moose features
482 =head2 Application class roles
484 You can only apply method modifiers after the application's C<< ->setup >>
485 method has been called. This means that modifiers will not work with methods
486 run during the call to C<< ->setup >>.
488 See L<Catalyst::Manual::ExtendingCatalyst> for more information about using
489 L<Moose> in your applications.
491 =head2 Controller actions in Moose roles
493 You can use L<MooseX::MethodAttributes::Role> if you want to declare actions
496 =head2 Using Moose in Components
498 The correct way to use Moose in a component in a both forward and backwards
501 package TestApp::Controller::Root;
503 BEGIN { extends 'Catalyst::Component' }; # Or ::Controller, or whatever
505 See L<Components which inherit from Moose::Object before Catalyst::Component>.
507 =head1 Known backwards compatibility breakages
509 =head2 Applications in a single file
511 Applications must be in their own file, and loaded at compile time. This
512 issue generally only affects the tests of CPAN distributions. Your
513 application will fail if you try to define an application inline in a
514 block, and use plugins which supply a C< new > method, then use that
515 application latter in tests within the same file.
517 This is due to the fact that Catalyst is inlining a new method on your
518 application class allowing it to be compatible with Moose. The method
519 used to do this changed in 5.80004 to avoid the possibility of reporting
520 an 'Unknown Error' if your application failed to compile.
522 =head2 Issues with Class::C3
524 Catalyst 5.80 uses the L<Algorithm::C3> method dispatch order. This is
525 built into Perl 5.10, and comes via L<Class::C3> for Perl 5.8. This
526 replaces L<NEXT> with L<Class::C3::Adopt::NEXT>, forcing all components
527 to resolve methods using C3, rather than the unpredictable dispatch
530 This issue manifests itself by your application failing to start due to an
531 error message about having a non-linear @ISA.
533 The Catalyst plugin most often causing this is
534 L<Catalyst::Plugin::Session::Store::FastMmap> - if you are using this
535 plugin and see issues, then please upgrade your plugins, as it has been
536 fixed. Note that Makefile.PL in the distribution will warn about known
537 incompatible components.
539 This issue can, however, be found in your own application - the only solution is
540 to go through each base class of the class the error was reported against, until
541 you identify the ones in conflict, and resolve them.
543 To be able to generate a linear @ISA, the list of superclasses for each
544 class must be resolvable using the C3 algorithm. Unfortunately, when
545 superclasses are being used as mixins (to add functionality used in your class),
546 and with multiple inheritance, it is easy to get this wrong.
548 Most common is the case of:
550 package Component1; # Note, this is the common case
551 use base qw/Class::Accessor::Fast Class::Data::Inheritable/;
553 package Component2; # Accidentally saying it this way causes a failure
554 use base qw/Class::Data::Inheritable Class::Accessor::Fast/;
557 use base qw/Component1 Component2/;
559 Any situation like this will cause your application to fail to start.
561 For additional documentation about this issue, and how to resolve it, see
562 L<Class::C3::Adopt::NEXT>.
564 =head2 Components which inherit from Moose::Object before Catalyst::Component
566 Moose components which say:
568 package TestApp::Controller::Example;
570 extends qw/Moose::Object Catalyst::Component/;
572 to use the constructor provided by Moose, while working (if you do some hacks
573 with the C< BUILDARGS > method), will not work with Catalyst 5.80 as
574 C<Catalyst::Component> inherits from C<Moose::Object>, and so C< @ISA > fails
577 The correct way to use Moose in a component in a both forward and backwards
580 package TestApp::Controller::Root;
582 BEGIN { extends 'Catalyst::Component' }; # Or ::Controller, or whatever
584 Note that the C< extends > declaration needs to occur in a begin block for
585 L<attributes> to operate correctly.
587 This way you do not inherit directly from C<Moose::Object>
588 yourself. Having components which do not inherit their constructor from
589 C<Catalyst::Component> is B<unsupported>, and has never been recommended,
590 therefore you're on your own if you're using this technique. You'll need
591 to detect the version of Catalyst your application is running, and deal
592 with it appropriately.
594 You also don't get the L<Moose::Object> constructor, and therefore attribute
595 initialization will not work as normally expected. If you want to use Moose
596 attributes, then they need to be made lazy to correctly initialize.
598 Note that this only applies if your component needs to maintain component
599 backwards compatibility for Catalyst versions before 5.71001 - in 5.71001
600 attributes work as expected, and the BUILD method is called normally
601 (although BUILDARGS is not).
603 If you depend on Catalyst 5.8, then B<all> Moose features work as expected.
605 You will also see this issue if you do the following:
607 package TestApp::Controller::Example;
609 use base 'Catalyst::Controller';
611 as C< use base > appends to @ISA.
613 =head3 use Moose in MyApp
615 Similar to the above, this will also fail:
624 If you need to use Moose in your application class (e.g. for method modifiers
625 etc.) then the correct technique is:
633 __PACKAGE__->config( name => 'MyApp' );
634 __PACKAGE__->setup(qw/
638 =head2 Anonymous closures installed directly into the symbol table
640 If you have any code which installs anonymous subroutine references directly
641 into the symbol table, you may encounter breakages. The simplest solution is
642 to use L<Sub::Name> to name the subroutine. Example:
644 # Original code, likely to break:
645 my $full_method_name = join('::', $package_name, $method_name);
646 *$full_method_name = sub { ... };
649 use Sub::Name 'subname';
650 my $full_method_name = join('::',$package_name, $method_name);
651 *$full_method_name = subname $full_method_name, sub { ... };
653 Additionally, you can take advantage of Catalyst's use of L<Class::MOP> and
654 install the closure using the appropriate metaclass. Example:
657 my $metaclass = Moose::Meta::Class->initialize($package_name);
658 $metaclass->add_method($method_name => sub { ... });
660 =head2 Hooking into application setup
662 To execute code during application start-up, the following snippet in MyApp.pm
666 my ($class, @args) = @_;
667 $class->NEXT::setup(@args);
668 ... # things to do after the actual setup
671 With Catalyst 5.80 this won't work anymore, because Catalyst no longer
672 uses NEXT.pm for method resolution. The functionality was only ever
673 originally operational as L<NEXT> remembers what methods have already
674 been called, and will not call them again.
676 Using this now causes infinite recursion between MyApp::setup and
677 Catalyst::setup, due to other backwards compatibility issues related to how
678 plugin setup works. Moose method modifiers like C<< before|after|around setup
679 => sub { ... }; >> also will not operate correctly on the setup method.
681 The right way to do it is this:
683 after setup_finalize => sub {
684 ... # things to do after the actual setup
687 The setup_finalize hook was introduced as a way to avoid this issue.
689 =head2 Components with a new method which returns false
691 Previously, if you had a component which inherited from Catalyst::COMPONENT,
692 but overrode the new method to return false, then your class's configuration
693 would be blessed into a hash on your behalf, and this would be returned from
694 the COMPONENT method.
696 This behavior makes no sense, and so has been removed. Implementing your own
697 C< new > method in components is B<highly> discouraged. Instead, you should
698 inherit the new method from Catalyst::Component, and use Moose's BUILD
699 functionality and/or Moose attributes to perform any construction work
700 necessary for your class.
702 =head2 __PACKAGE__->mk_accessor('meta');
704 Won't work due to a limitation of L<Moose>. This is currently being fixed
707 =head2 Class::Data::Inheritable side effects
709 Previously, writing to a class data accessor would copy the accessor method
710 down into your package.
712 This behavior has been removed. While the class data is still stored
713 per-class, it is stored on the metaclass of the class defining the accessor.
715 Therefore anything relying on the side effect of the accessor being copied down
718 The following test demonstrates the problem:
722 use base qw/Class::Data::Inheritable/;
723 __PACKAGE__->mk_classdata('foo');
728 use base qw/BaseClass/;
731 BaseClass->foo('base class');
732 Child->foo('sub class');
735 isnt(BaseClass->can('foo'), Child->can('foo'));
737 =head2 Extending Catalyst::Request or other classes in an ad hoc manner using mk_accessors
739 Previously, it was possible to add additional accessors to Catalyst::Request
740 (or other classes) by calling the mk_accessors class method.
742 This is no longer supported - users should make a subclass of the class whose
743 behavior they would like to change, rather than globally polluting the
746 =head2 Confused multiple inheritance with Catalyst::Component::COMPONENT
748 Previously, Catalyst's COMPONENT method would delegate to the method on
749 the right hand side, which could then delegate back again with
750 NEXT. This is poor practice, and in addition, makes no sense with C3
751 method dispatch order, and is therefore no longer supported.
753 If a COMPONENT method is detected in the inheritance hierarchy to the right
754 hand side of Catalyst::Component::COMPONENT, then the following warning
755 message will be emitted:
757 There is a COMPONENT method resolving after Catalyst::Component
760 The correct fix is to re-arrange your class's inheritance hierarchy so that the
761 COMPONENT method you would like to inherit is the first (left-hand most)
762 COMPONENT method in your @ISA.
764 =head2 Development server relying on environment variables
766 Previously, the development server would allow propagation of system
767 environment variables into the request environment, this has changed with the
768 adoption of Plack. You can use L<Plack::Middleware::ForceEnv> to achieve the
773 =head2 Actions in your application class
775 Having actions in your application class will now emit a warning at application
776 startup as this is deprecated. It is highly recommended that these actions are moved
777 into a MyApp::Controller::Root (as demonstrated by the scaffold application
778 generated by catalyst.pl).
780 This warning, also affects tests. You should move actions in your test,
781 creating a myTest::Controller::Root, like the following example:
783 package MyTest::Controller::Root;
788 use parent 'Catalyst::Controller';
790 __PACKAGE__->config(namespace => '');
793 my ( $self, $c ) = @_;
799 =head2 ::[MVC]:: naming scheme
801 Having packages called MyApp::[MVC]::XX is deprecated and can no longer be generated
804 This is still supported, but it is recommended that you rename your application
805 components to Model/View/Controller.
807 A warning will be issued at application startup if the ::[MVC]:: naming scheme is
810 =head2 Catalyst::Base
812 Any code using L<Catalyst::Base> will now emit a warning; this
813 module will be removed in a future release.
815 =head2 Methods in Catalyst::Dispatcher
817 The following methods in Catalyst::Dispatcher are implementation
818 details, which may change in the 5.8X release series, and therefore their use
819 is highly deprecated.
827 =item registered_dispatch_types
829 =item method_action_class
837 The first time one of these methods is called, a warning will be emitted:
839 Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,
840 this will be removed in Catalyst 5.9
842 You should B<NEVER> be calling any of these methods from application code.
844 Plugin authors and maintainers whose plugins currently call these methods
845 should change to using the public API, or, if you do not feel the public API
846 adequately supports your use case, please email the development list to
847 discuss what API features you need so that you can be appropriately supported.
849 =head2 Class files with names that don't correspond to the packages they define
851 In this version of Catalyst, if a component is loaded from disk, but no
852 symbols are defined in that component's name space after it is loaded, this
853 warning will be issued:
855 require $class was successful but the package is not defined.
857 This is to protect against confusing bugs caused by mistyping package names,
858 and will become a fatal error in a future version.
860 Please note that 'inner packages' (via L<Devel::InnerPackage>) are still fully
861 supported; this warning is only issued when component file naming does not map
862 to B<any> of the packages defined within that component.
864 =head2 $c->plugin method
866 Calling the plugin method is deprecated, and calling it at run time is B<highly
869 Instead you are recommended to use L<Catalyst::Model::Adaptor> or similar to
870 compose the functionality you need outside of the main application name space.
872 Calling the plugin method will not be supported past Catalyst 5.81.