3 Catalyst::Upgrading - Instructions for upgrading to the latest Catalyst
5 =head1 Upgrading to Catalyst 5.90085
7 In this version of Catalyst we made a small change to Chained Dispatching so
8 that when two or more actions all have the same path specification AND they
9 all have Args(0), we break the tie by choosing the last action defined, and
10 not the first one defined. This was done to normalize Chaining to following
11 the 'longest Path wins, and when several actions match the same Path specification
12 we choose the last defined.' rule. Previously Args(0) was hard coded to be a special
13 case such that the first action defined would match (which is not the case when
16 Its possible that this could be a breaking change for you, if you had used
17 action roles (custom or otherwise) to add additional matching rules to differentiate
18 between several Args(0) actions that share the same root action chain. For
19 example if you have code now like this:
21 sub check_default :Chained(/) CaptureArgs(0) { ... }
23 sub default_get :Chained('check_default') PathPart('') Args(0) GET {
24 pop->res->body('get3');
27 sub default_post :Chained('check_default') PathPart('') Args(0) POST {
28 pop->res->body('post3');
31 sub chain_default :Chained('check_default') PathPart('') Args(0) {
32 pop->res->body('chain_default');
35 The way that chaining will work previous is that when two or more equal actions can
36 match, the 'top' one wins. So if the request is "GET .../check_default" BOTH
37 actions 'default_get' AND 'chain_default' would match. To break the tie in
38 the case when Args is 0, we'd previous take the 'top' (or first defined) action.
39 Unfortunately this treatment of Args(0) is special case. In all other cases
40 we choose the 'last defined' action to break a tie. So this version of
41 Catalyst changed the dispatcher to make Args(0) no longer a special case for
42 breaking ties. This means that the above code must now become:
44 sub check_default :Chained(/) CaptureArgs(0) { ... }
46 sub chain_default :Chained('check_default') PathPart('') Args(0) {
47 pop->res->body('chain_default');
50 sub default_get :Chained('check_default') PathPart('') Args(0) GET {
51 pop->res->body('get3');
54 sub default_post :Chained('check_default') PathPart('') Args(0) POST {
55 pop->res->body('post3');
58 If we want it to work as expected (for example we we GET to match 'default_get' and
59 POST to match 'default_post' and any other http Method to match 'chain_default').
61 In other words Arg(0) and chained actions must now follow the normal rule where
62 in a tie the last defined action wins and you should place all your less defined
63 or 'catch all' actions first.
65 If this causes you trouble and you can't fix your code to conform, you may set the
66 application configuration setting "use_chained_args_0_special_case" to true and
67 that will revert you code to the previous behavior.
69 =head2 More backwards compatibility options with UTF-8 changes
71 In order to give better backwards compatiblity with the 5.90080+ UTF-8 changes
72 we've added several configuration options around control of how we try to decode
73 your URL keywords / query parameters.
75 C<do_not_decode_query>
77 If true, then do not try to character decode any wide characters in your
78 request URL query or keywords. Most readings of the relevent specifications
79 suggest these should be UTF-* encoded, which is the default that L<Catalyst>
80 will use, hwoever if you are creating a lot of URLs manually or have external
81 evil clients, this might cause you trouble. If you find the changes introduced
82 in Catalyst version 5.90080+ break some of your query code, you may disable
83 the UTF-8 decoding globally using this configuration.
85 This setting takes precedence over C<default_query_encoding> and
86 C<decode_query_using_global_encoding>
88 C<default_query_encoding>
90 By default we decode query and keywords in your request URL using UTF-8, which
91 is our reading of the relevent specifications. This setting allows one to
92 specify a fixed value for how to decode your query. You might need this if
93 you are doing a lot of custom encoding of your URLs and not using UTF-8.
95 This setting take precedence over C<decode_query_using_global_encoding>.
97 C<decode_query_using_global_encoding>
99 Setting this to true will default your query decoding to whatever your
100 general global encoding is (the default is UTF-8).
103 =head1 Upgrading to Catalyst 5.90080
105 UTF8 encoding is now default. For temporary backwards compatibility, if this
106 change is causing you trouble, you can disable it by setting the application
107 configuration option to undef:
109 MyApp->config(encoding => undef);
111 But please consider this a temporary measure since it is the intention that
112 UTF8 is enabled going forwards and the expectation is that other ecosystem
113 projects will assume this as well. At some point you application will not
114 correctly function without this setting.
116 As of 5.90084 we've added two additional configuration flags for more selective
117 control over some encoding changes: 'skip_body_param_unicode_decoding' and
118 'skip_complex_post_part_handling'. You may use these to more selectively
119 disable new features while you are seeking a long term fix. Please review
120 CONFIGURATION in L<Catalyst>.
122 For further information, please see L<Catalyst::UTF8>
124 A number of projects in the wider ecosystem required minor updates to be able
125 to work correctly. Here's the known list:
127 L<Catalyst::View::TT>, L<Catalyst::View::Mason>, L<Catalyst::View::HTML::Mason>,
128 L<Catalyst::View::Xslate>, L<Test::WWW::Mechanize::Catalyst>
130 You will need to update to modern versions in most cases, although quite a few
131 of these only needed minor test case and documentation changes so you will need
132 to review the changelog of each one that is relevant to you to determine your
135 =head1 Upgrading to Catalyst 5.90060
137 Starting in the v5.90059_001 development release, the regexp dispatch type is
138 no longer automatically included as a dependency. If you are still using this
139 dispatch type, you need to add L<Catalyst::DispatchType::Regex> into your build
142 The standalone distribution of Regexp will be supported for the time being, but
143 should we find that supporting it prevents us from moving L<Catalyst> forward
144 in necessary ways, we reserve the right to drop that support. It is highly
145 recommended that you use this last stage of deprecation to change your code.
147 =head1 Upgrading to Catalyst 5.90040
149 =head2 Catalyst::Plugin::Unicode::Encoding is now core
151 The previously stand alone Unicode support module L<Catalyst::Plugin::Unicode::Encoding>
152 has been brought into core as a default plugin. Going forward, all you need is
153 to add a configuration setting for the encoding type. For example:
159 __PACKAGE__->config( encoding => 'UTF-8' );
161 Please note that this is different from the old stand alone plugin which applied
162 C<UTF-8> encoding by default (that is, if you did not set an explicit
163 C<encoding> configuration value, it assumed you wanted UTF-8). In order to
164 preserve backwards compatibility you will need to explicitly turn it on via the
165 configuration setting. THIS MIGHT CHANGE IN THE FUTURE, so please consider
166 starting to test your application with proper UTF-8 support and remove all those
167 crappy hacks you munged into the code because you didn't know the Plugin
170 For people that are using the Plugin, you will note a startup warning suggesting
171 that you can remove it from the plugin list. When you do so, please remember to
172 add the configuration setting, since you can no longer rely on the default being
173 UTF-8. We'll add it for you if you continue to use the stand alone plugin and
174 we detect this, but this backwards compatibility shim will likely be removed in
175 a few releases (trying to clean up the codebase after all).
177 If you have trouble with any of this, please bring it to the attention of the
178 Catalyst maintainer group.
180 =head2 basic async and event loop support
182 This version of L<Catalyst> offers some support for using L<AnyEvent> and
183 L<IO::Async> event loops in your application. These changes should work
184 fine for most applications however if you are already trying to perform
185 some streaming, minor changes in this area of the code might affect your
186 functionality. Please see L<Catalyst::Response\write_fh> for more and for a
189 We consider this feature experimental. We will try not to break it, but we
190 reserve the right to make necessary changes to fix major issues that people
191 run into when the use this functionality in the wild.
193 =head1 Upgrading to Catalyst 5.90030
195 =head2 Regex dispatch type is deprecated.
197 The Regex dispatchtype (L<Catalyst::DispatchType::Regex>) has been deprecated.
199 You are encouraged to move your application to Chained dispatch (L<Catalyst::DispatchType::Chained>).
201 If you cannot do so, please add a dependency to Catalyst::DispatchType::Regex to your application's
204 =head1 Upgrading to Catalyst 5.9
206 The major change is that L<Plack>, a toolkit for using the L<PSGI>
207 specification, now replaces most of the subclasses of L<Catalyst::Engine>. If
208 you are using one of the standard subclasses of L<Catalyst::Engine> this
209 should be a straightforward upgrade for you. It was a design goal for
210 this release to preserve as much backwards compatibility as possible.
211 However, since L<Plack> is different from L<Catalyst::Engine>, it is
212 possible that differences exist for edge cases. Therefore, we recommend
213 that care be taken with this upgrade and that testing should be greater
214 than would be the case with a minor point update. Please inform the
215 Catalyst developers of any problems so that we can fix them and
218 It is highly recommended that you become familiar with the L<Plack> ecosystem
219 and documentation. Being able to take advantage of L<Plack> development and
220 middleware is a major bonus to this upgrade. Documentation about how to
221 take advantage of L<Plack::Middleware> by writing your own C<< .psgi >> file
222 is contained in L<Catalyst::PSGI>.
224 If you have created a custom subclass of L<Catalyst:Engine>, you will
225 need to convert it to be a subclass of L<Plack::Handler>.
227 If you are using the L<Plack> engine, L<Catalyst::Engine::PSGI>, this new
228 release supersedes that code.
230 If you are using a subclass of L<Catalyst::Engine> that is aimed at
231 nonstandard or internal/testing uses, such as
232 L<Catalyst::Engine::Embeddable>, you should still be able to continue
235 Advice for specific subclasses of L<Catalyst::Engine> follows:
237 =head2 Upgrading the FastCGI Engine
239 No upgrade is needed if your myapp_fastcgi.pl script is already upgraded
240 to use L<Catalyst::Script::FastCGI>.
242 =head2 Upgrading the mod_perl / Apache Engines
244 The engines that are built upon the various iterations of mod_perl,
245 L<Catalyst::Engine::Apache::MP13> (for mod_perl 1, and Apache 1.x) and
246 L<Catalyst::Engine::Apache2::MP20> (for mod_perl 2, and Apache 2.x),
247 should be seamless upgrades and will work using L<Plack::Handler::Apache1>
248 or L<Plack::Handler::Apache2> as required.
250 L<Catalyst::Engine::Apache2::MP19>, however, is no longer supported, as
251 Plack does not support mod_perl version 1.99. This is unlikely to be a
252 problem for anyone, as 1.99 was a brief beta-test release for mod_perl
253 2, and all users of mod_perl 1.99 are encouraged to upgrade to a
254 supported release of Apache 2 and mod_perl 2.
256 =head2 Upgrading the HTTP Engine
258 The default development server that comes with the L<Catalyst> distribution
259 should continue to work as expected with no changes as long as your C<myapp_server>
260 script is upgraded to use L<Catalyst::Script::HTTP>.
262 =head2 Upgrading the CGI Engine
264 If you were using L<Catalyst::Engine::CGI> there is no upgrade needed if your
265 myapp_cgi.pl script is already upgraded to use L<Catalyst::Script::CGI>.
267 =head2 Upgrading Catalyst::Engine::HTTP::Prefork
269 If you were using L<Catalyst::Engine::HTTP::Prefork> then L<Starman>
270 is automatically loaded. You should (at least) change your C<Makefile.PL>
271 to depend on Starman.
273 You can regenerate your C<myapp_server.pl> script with C<catalyst.pl>
274 and implement a C<MyApp::Script::Server> class that looks like this:
276 package MyApp::Script::Server;
278 use namespace::autoclean;
280 extends 'CatalystX::Script::Server::Starman';
284 This takes advantage of the new script system, and will add a number of
285 options to the standard server script as extra options are added by
288 More information about these options can be seen at
289 L<CatalystX::Script::Server::Starman/SYNOPSIS>.
291 An alternate route to implement this functionality is to write a simple .psgi
292 file for your application, and then use the L<plackup> utility to start the
295 =head2 Upgrading the PSGI Engine
297 If you were using L<Catalyst::Engine::PSGI>, this new release supersedes
298 this engine in supporting L<Plack>. By default the Engine is now always
299 L<Plack>. As a result, you can remove the dependency on
300 L<Catalyst::Engine::PSGI> in your C<Makefile.PL>.
302 Applications that were using L<Catalyst::Engine::PSGI>
303 previously should entirely continue to work in this release with no changes.
305 However, if you have an C<app.psgi> script, then you no longer need to
306 specify the PSGI engine. Instead, the L<Catalyst> application class now
307 has a new method C<psgi_app> which returns a L<PSGI> compatible coderef
308 which you can wrap in the middleware of your choice.
310 Catalyst will use the .psgi for your application if it is located in the C<home>
311 directory of the application.
313 For example, if you were using L<Catalyst::Engine::PSGI> in the past, you will
314 have written (or generated) a C<script/myapp.psgi> file similar to this one:
319 MyCatalystApp->setup_engine('PSGI');
322 enable ... # enable your desired middleware
323 sub { MyCatalystApp->run(@_) };
326 Instead, you now say:
332 enable ... #enable your desired middleware
333 MyCatalystApp->psgi_app;
336 In the simplest case:
338 MyCatalystApp->setup_engine('PSGI');
339 my $app = sub { MyCatalystApp->run(@_) }
343 my $app = MyCatalystApp->psgi_app(@_);
347 my $app = sub { MyCatalystApp->psgi_app(@_) };
348 # If you make ^^ this mistake, your app won't work, and will confuse the hell out of you!
350 You can now move C<< script/myapp.psgi >> to C<< myapp.psgi >>, and the built-in
351 Catalyst scripts and your test suite will start using your .psgi file.
353 B<NOTE:> If you rename your .psgi file without these modifications, then
354 any tests run via L<Catalyst::Test> will not be compatible with the new
355 release, and will result in the development server starting, rather than
356 the expected test running.
358 B<NOTE:> If you are directly accessing C<< $c->req->env >> to get the PSGI
359 environment then this accessor is moved to C<< $c->engine->env >>,
360 you will need to update your code.
362 =head2 Engines which are known to be broken
364 The following engines B<DO NOT> work as of Catalyst version 5.9. The
365 core team will be happy to work with the developers and/or users of
366 these engines to help them port to the new Plack/Engine system, but for
367 now, applications which are currently using these engines B<WILL NOT>
368 run without modification to the engine code.
372 =item Catalyst::Engine::Wx
374 =item Catalyst::Engine::Zeus
376 =item Catalyst::Engine::JobQueue::POE
378 =item Catalyst::Engine::XMPP2
380 =item Catalyst::Engine::SCGI
384 =head2 Engines with unknown status
386 The following engines are untested or have unknown compatibility.
387 Reports are highly encouraged:
391 =item Catalyst::Engine::Mojo
393 =item Catalyst::Engine::Server (marked as Deprecated)
395 =item Catalyst::Engine::HTTP::POE (marked as Deprecated)
399 =head2 Plack functionality
401 See L<Catalyst::PSGI>.
405 Tests should generally work the same in Catalyst 5.9, but there are
408 Previously, if using L<Catalyst::Test> and doing local requests (against
409 a local server), if the application threw an exception then this
410 exception propagated into the test.
412 This behavior has been removed, and now a 500 response will be returned
413 to the test. This change standardizes behavior, so that local test
414 requests behave similarly to remote requests.
416 =head1 Upgrading to Catalyst 5.80
418 Most applications and plugins should run unaltered on Catalyst 5.80.
420 However, a lot of refactoring work has taken place, and several changes have
421 been made which could cause incompatibilities. If your application or plugin
422 is using deprecated code, or relying on side effects, then you could have
423 issues upgrading to this release.
425 Most issues found with existing components have been easy to
426 solve. This document provides a complete description of behavior changes
427 which may cause compatibility issues, and of new Catalyst warnings which
430 If you think you have found an upgrade-related issue which is not covered in
431 this document, please email the Catalyst list to discuss the problem.
433 =head1 Moose features
435 =head2 Application class roles
437 You can only apply method modifiers after the application's C<< ->setup >>
438 method has been called. This means that modifiers will not work with methods
439 run during the call to C<< ->setup >>.
441 See L<Catalyst::Manual::ExtendingCatalyst> for more information about using
442 L<Moose> in your applications.
444 =head2 Controller actions in Moose roles
446 You can use L<MooseX::MethodAttributes::Role> if you want to declare actions
449 =head2 Using Moose in Components
451 The correct way to use Moose in a component in a both forward and backwards
454 package TestApp::Controller::Root;
456 BEGIN { extends 'Catalyst::Component' }; # Or ::Controller, or whatever
458 See L<Components which inherit from Moose::Object before Catalyst::Component>.
460 =head1 Known backwards compatibility breakages
462 =head2 Applications in a single file
464 Applications must be in their own file, and loaded at compile time. This
465 issue generally only affects the tests of CPAN distributions. Your
466 application will fail if you try to define an application inline in a
467 block, and use plugins which supply a C< new > method, then use that
468 application latter in tests within the same file.
470 This is due to the fact that Catalyst is inlining a new method on your
471 application class allowing it to be compatible with Moose. The method
472 used to do this changed in 5.80004 to avoid the possibility of reporting
473 an 'Unknown Error' if your application failed to compile.
475 =head2 Issues with Class::C3
477 Catalyst 5.80 uses the L<Algorithm::C3> method dispatch order. This is
478 built into Perl 5.10, and comes via L<Class::C3> for Perl 5.8. This
479 replaces L<NEXT> with L<Class::C3::Adopt::NEXT>, forcing all components
480 to resolve methods using C3, rather than the unpredictable dispatch
483 This issue manifests itself by your application failing to start due to an
484 error message about having a non-linear @ISA.
486 The Catalyst plugin most often causing this is
487 L<Catalyst::Plugin::Session::Store::FastMmap> - if you are using this
488 plugin and see issues, then please upgrade your plugins, as it has been
489 fixed. Note that Makefile.PL in the distribution will warn about known
490 incompatible components.
492 This issue can, however, be found in your own application - the only solution is
493 to go through each base class of the class the error was reported against, until
494 you identify the ones in conflict, and resolve them.
496 To be able to generate a linear @ISA, the list of superclasses for each
497 class must be resolvable using the C3 algorithm. Unfortunately, when
498 superclasses are being used as mixins (to add functionality used in your class),
499 and with multiple inheritance, it is easy to get this wrong.
501 Most common is the case of:
503 package Component1; # Note, this is the common case
504 use base qw/Class::Accessor::Fast Class::Data::Inheritable/;
506 package Component2; # Accidentally saying it this way causes a failure
507 use base qw/Class::Data::Inheritable Class::Accessor::Fast/;
510 use base qw/Component1 Component2/;
512 Any situation like this will cause your application to fail to start.
514 For additional documentation about this issue, and how to resolve it, see
515 L<Class::C3::Adopt::NEXT>.
517 =head2 Components which inherit from Moose::Object before Catalyst::Component
519 Moose components which say:
521 package TestApp::Controller::Example;
523 extends qw/Moose::Object Catalyst::Component/;
525 to use the constructor provided by Moose, while working (if you do some hacks
526 with the C< BUILDARGS > method), will not work with Catalyst 5.80 as
527 C<Catalyst::Component> inherits from C<Moose::Object>, and so C< @ISA > fails
530 The correct way to use Moose in a component in a both forward and backwards
533 package TestApp::Controller::Root;
535 BEGIN { extends 'Catalyst::Component' }; # Or ::Controller, or whatever
537 Note that the C< extends > declaration needs to occur in a begin block for
538 L<attributes> to operate correctly.
540 This way you do not inherit directly from C<Moose::Object>
541 yourself. Having components which do not inherit their constructor from
542 C<Catalyst::Component> is B<unsupported>, and has never been recommended,
543 therefore you're on your own if you're using this technique. You'll need
544 to detect the version of Catalyst your application is running, and deal
545 with it appropriately.
547 You also don't get the L<Moose::Object> constructor, and therefore attribute
548 initialization will not work as normally expected. If you want to use Moose
549 attributes, then they need to be made lazy to correctly initialize.
551 Note that this only applies if your component needs to maintain component
552 backwards compatibility for Catalyst versions before 5.71001 - in 5.71001
553 attributes work as expected, and the BUILD method is called normally
554 (although BUILDARGS is not).
556 If you depend on Catalyst 5.8, then B<all> Moose features work as expected.
558 You will also see this issue if you do the following:
560 package TestApp::Controller::Example;
562 use base 'Catalyst::Controller';
564 as C< use base > appends to @ISA.
566 =head3 use Moose in MyApp
568 Similar to the above, this will also fail:
577 If you need to use Moose in your application class (e.g. for method modifiers
578 etc.) then the correct technique is:
586 __PACKAGE__->config( name => 'MyApp' );
587 __PACKAGE__->setup(qw/
591 =head2 Anonymous closures installed directly into the symbol table
593 If you have any code which installs anonymous subroutine references directly
594 into the symbol table, you may encounter breakages. The simplest solution is
595 to use L<Sub::Name> to name the subroutine. Example:
597 # Original code, likely to break:
598 my $full_method_name = join('::', $package_name, $method_name);
599 *$full_method_name = sub { ... };
602 use Sub::Name 'subname';
603 my $full_method_name = join('::',$package_name, $method_name);
604 *$full_method_name = subname $full_method_name, sub { ... };
606 Additionally, you can take advantage of Catalyst's use of L<Class::MOP> and
607 install the closure using the appropriate metaclass. Example:
610 my $metaclass = Moose::Meta::Class->initialize($package_name);
611 $metaclass->add_method($method_name => sub { ... });
613 =head2 Hooking into application setup
615 To execute code during application start-up, the following snippet in MyApp.pm
619 my ($class, @args) = @_;
620 $class->NEXT::setup(@args);
621 ... # things to do after the actual setup
624 With Catalyst 5.80 this won't work anymore, because Catalyst no longer
625 uses NEXT.pm for method resolution. The functionality was only ever
626 originally operational as L<NEXT> remembers what methods have already
627 been called, and will not call them again.
629 Using this now causes infinite recursion between MyApp::setup and
630 Catalyst::setup, due to other backwards compatibility issues related to how
631 plugin setup works. Moose method modifiers like C<< before|after|around setup
632 => sub { ... }; >> also will not operate correctly on the setup method.
634 The right way to do it is this:
636 after setup_finalize => sub {
637 ... # things to do after the actual setup
640 The setup_finalize hook was introduced as a way to avoid this issue.
642 =head2 Components with a new method which returns false
644 Previously, if you had a component which inherited from Catalyst::COMPONENT,
645 but overrode the new method to return false, then your class's configuration
646 would be blessed into a hash on your behalf, and this would be returned from
647 the COMPONENT method.
649 This behavior makes no sense, and so has been removed. Implementing your own
650 C< new > method in components is B<highly> discouraged. Instead, you should
651 inherit the new method from Catalyst::Component, and use Moose's BUILD
652 functionality and/or Moose attributes to perform any construction work
653 necessary for your class.
655 =head2 __PACKAGE__->mk_accessor('meta');
657 Won't work due to a limitation of L<Moose>. This is currently being fixed
660 =head2 Class::Data::Inheritable side effects
662 Previously, writing to a class data accessor would copy the accessor method
663 down into your package.
665 This behavior has been removed. While the class data is still stored
666 per-class, it is stored on the metaclass of the class defining the accessor.
668 Therefore anything relying on the side effect of the accessor being copied down
671 The following test demonstrates the problem:
675 use base qw/Class::Data::Inheritable/;
676 __PACKAGE__->mk_classdata('foo');
681 use base qw/BaseClass/;
684 BaseClass->foo('base class');
685 Child->foo('sub class');
688 isnt(BaseClass->can('foo'), Child->can('foo'));
690 =head2 Extending Catalyst::Request or other classes in an ad hoc manner using mk_accessors
692 Previously, it was possible to add additional accessors to Catalyst::Request
693 (or other classes) by calling the mk_accessors class method.
695 This is no longer supported - users should make a subclass of the class whose
696 behavior they would like to change, rather than globally polluting the
699 =head2 Confused multiple inheritance with Catalyst::Component::COMPONENT
701 Previously, Catalyst's COMPONENT method would delegate to the method on
702 the right hand side, which could then delegate back again with
703 NEXT. This is poor practice, and in addition, makes no sense with C3
704 method dispatch order, and is therefore no longer supported.
706 If a COMPONENT method is detected in the inheritance hierarchy to the right
707 hand side of Catalyst::Component::COMPONENT, then the following warning
708 message will be emitted:
710 There is a COMPONENT method resolving after Catalyst::Component
713 The correct fix is to re-arrange your class's inheritance hierarchy so that the
714 COMPONENT method you would like to inherit is the first (left-hand most)
715 COMPONENT method in your @ISA.
717 =head2 Development server relying on environment variables
719 Previously, the development server would allow propagation of system
720 environment variables into the request environment, this has changed with the
721 adoption of Plack. You can use L<Plack::Middleware::ForceEnv> to achieve the
726 =head2 Actions in your application class
728 Having actions in your application class will now emit a warning at application
729 startup as this is deprecated. It is highly recommended that these actions are moved
730 into a MyApp::Controller::Root (as demonstrated by the scaffold application
731 generated by catalyst.pl).
733 This warning, also affects tests. You should move actions in your test,
734 creating a myTest::Controller::Root, like the following example:
736 package MyTest::Controller::Root;
741 use parent 'Catalyst::Controller';
743 __PACKAGE__->config(namespace => '');
746 my ( $self, $c ) = @_;
752 =head2 ::[MVC]:: naming scheme
754 Having packages called MyApp::[MVC]::XX is deprecated and can no longer be generated
757 This is still supported, but it is recommended that you rename your application
758 components to Model/View/Controller.
760 A warning will be issued at application startup if the ::[MVC]:: naming scheme is
763 =head2 Catalyst::Base
765 Any code using L<Catalyst::Base> will now emit a warning; this
766 module will be removed in a future release.
768 =head2 Methods in Catalyst::Dispatcher
770 The following methods in Catalyst::Dispatcher are implementation
771 details, which may change in the 5.8X release series, and therefore their use
772 is highly deprecated.
780 =item registered_dispatch_types
782 =item method_action_class
790 The first time one of these methods is called, a warning will be emitted:
792 Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,
793 this will be removed in Catalyst 5.9
795 You should B<NEVER> be calling any of these methods from application code.
797 Plugin authors and maintainers whose plugins currently call these methods
798 should change to using the public API, or, if you do not feel the public API
799 adequately supports your use case, please email the development list to
800 discuss what API features you need so that you can be appropriately supported.
802 =head2 Class files with names that don't correspond to the packages they define
804 In this version of Catalyst, if a component is loaded from disk, but no
805 symbols are defined in that component's name space after it is loaded, this
806 warning will be issued:
808 require $class was successful but the package is not defined.
810 This is to protect against confusing bugs caused by mistyping package names,
811 and will become a fatal error in a future version.
813 Please note that 'inner packages' (via L<Devel::InnerPackage>) are still fully
814 supported; this warning is only issued when component file naming does not map
815 to B<any> of the packages defined within that component.
817 =head2 $c->plugin method
819 Calling the plugin method is deprecated, and calling it at run time is B<highly
822 Instead you are recommended to use L<Catalyst::Model::Adaptor> or similar to
823 compose the functionality you need outside of the main application name space.
825 Calling the plugin method will not be supported past Catalyst 5.81.