Commit | Line | Data |
8c57b129 |
1 | =head1 NAME |
2 | |
3 | Catalyst::Upgrading - Instructions for upgrading to the latest Catalyst |
4 | |
93d60cae |
5 | =head1 Upgrading to Catalyst 5.90 |
5d5f4a73 |
6 | |
7 | The major change is that L<Plack> now replaces most of the subclasses of |
8 | L<Catalyst::Engine>. If you are using one of the standard subclasses of |
040835f0 |
9 | L<Catalyst::Engine> this should be a straightforward upgrade for you. It was |
5d5f4a73 |
10 | a design goal for this release to be as backwardly compatible as possible. |
11 | However since L<Plack> is different from L<Catalyst::Engine> it would be |
12 | possible that edge case differences would exist. Therefore we recommend care |
13 | be taken with this upgrade and that testing should be greater than would be |
14 | the case with a minor point update. |
15 | |
16 | It is highly recommended that you become familar with the L<Plack> ecosystem |
ae908e7e |
17 | and documentation. Being able to take advantage of L<Plack> development and |
18 | middleware is a major bonus to this upgrade. Documentation about how to |
19 | take advantage of L<Plack::Middleware> by writing your own C<< .psgi >> file |
20 | is contained in L<Catalyst::PSGI>. |
5d5f4a73 |
21 | |
22 | If you have created a custom subclass of L<Catalyst:Engine> you will need to |
23 | convert it to be a subclass of L<Plack::Handler>. |
24 | |
25 | If you are using the L<Plack> engine, L<Catalyst::Engine::PSGI>, this new |
26 | release supercedes that code. |
27 | |
28 | If you are using a subclass of L<Catalyst::Engine> that is aimed at nonstandard |
29 | or internal / testing uses, such as L<Catalyst::Engine::Embeddable> you should |
30 | still be able to continue using that engine. |
31 | |
32 | Advice for specific subclasses of L<Catalyst::Engine> follows: |
33 | |
93d60cae |
34 | =head2 Upgrading the FastCGI Engine |
5d5f4a73 |
35 | |
040835f0 |
36 | No upgrade needed if your myapp_fastcgi.pl script is already upgraded |
37 | enough to use L<Catalyst::Script::FastCGI>. |
5d5f4a73 |
38 | |
93d60cae |
39 | =head2 Upgrading the mod_perl / Apache Engines |
5d5f4a73 |
40 | |
040835f0 |
41 | The engines that are build upon the various iterations of mod_perl, |
42 | L<Catalyst::Engine::Apache::MP13> and |
5d5f4a73 |
43 | L<Catalyst::Engine::Apache2::MP20> should be seemless upgrades and will |
44 | work using using L<Plack::Handler::Apache1> or L<Plack::Handler::Apache2> |
45 | as required. |
46 | |
040835f0 |
47 | L<Catalyst::Engine::Apache2::MP19>, is however no longer supported, as Plack |
24fd6115 |
48 | does not support mod_perl version 1.99 |
5d5f4a73 |
49 | |
93d60cae |
50 | =head2 Upgrading the HTTP Engine |
5d5f4a73 |
51 | |
040835f0 |
52 | The default development server that comes with the L<Catalyst> distribution |
53 | should continue to work as expected with no changes as long as your C<myapp_server> |
54 | script is upgraded to use L<Catalyst::Script::HTTP>. |
5d5f4a73 |
55 | |
93d60cae |
56 | =head2 Upgrading the CGI Engine |
5d5f4a73 |
57 | |
697a3e9e |
58 | If you were using L<Catalyst::Engine::CGI> there is no upgrade needed if your |
59 | myapp_cgi.pl script is already upgraded enough to use L<Catalyst::Script::CGI>. |
5d5f4a73 |
60 | |
93d60cae |
61 | =head2 Upgrading the Preforking Engine |
5d5f4a73 |
62 | |
040835f0 |
63 | If you were using L<Catalyst::Engine::HTTP::Prefork> then L<Starman> |
0ea8962d |
64 | is automatically loaded. |
65 | |
24fd6115 |
66 | If you were customising your server script to pass opttions to the prefork engine, |
67 | then this is no longer supported. The recommended route to implement this functionality |
68 | is to write a simple .psgi file for your application, then use the L<plackup> untility. |
5d5f4a73 |
69 | |
93d60cae |
70 | =head2 Upgrading the PSGI Engine |
5d5f4a73 |
71 | |
72 | If you were using L<Catalyst::Engine::PSGI> this new release supercedes this |
697a3e9e |
73 | engine in supporting L<Plack>. By default the Engine is now always L<Plack>. |
74 | As a result, you can stop depending on L<Catalyst::Engine::PSGI> in your |
8f912f0b |
75 | C<Makefile.PL>. |
76 | |
77 | Applications that were using L<Catalyst::Engine::PSGI> |
78 | previously should entirely continue to work in this release with no changes. |
79 | |
80 | However, if you have an C<app.psgi> script, then you no longer |
697a3e9e |
81 | need to specify the PSGI engine. Instead, the L<Catalyst> application class |
82452b29 |
82 | now has a new method C<psgi_app> which returns a L<PSGI> compatible coderef |
8f912f0b |
83 | which you can wrap in middleware of your choice. |
84 | |
85 | Catalyst will use the .psgi for your application if it is located in the C<home> |
86 | directory of the application |
697a3e9e |
87 | |
93a57b4b |
88 | For example, if you were using L<Catalyst::Engine::PSGI> in the past, you will |
8f912f0b |
89 | have written (or generated) a C<script/myapp.psgi> file similar to this one: |
697a3e9e |
90 | |
91 | use Plack::Builder; |
92 | use MyCatalytApp; |
93 | |
94 | MyCatalystApp->setup_engine('PSGI'); |
95 | |
96 | builder { |
97 | enable ... # enable your desired middleware |
98 | sub { MyCatalystApp->run(@_) }; |
99 | }; |
100 | |
8f912f0b |
101 | Instead, you now say: |
697a3e9e |
102 | |
103 | use Plack::Builder; |
104 | use MyCatalystApp; |
105 | |
106 | builder { |
107 | enable ... #enable your desired middleware |
75d68821 |
108 | MyCatalystApp->psgi_app; |
697a3e9e |
109 | }; |
5d5f4a73 |
110 | |
34effbc7 |
111 | In the simplest case: |
8f912f0b |
112 | |
34effbc7 |
113 | MyCatalystApp->setup_engine('PSGI'); |
114 | my $app = sub { MyCatalystApp->run(@_) } |
115 | |
116 | becomes |
117 | |
118 | MyCatalystApp->setup_engine('PSGI'); |
119 | my $app = MyCatalystApp->psgi_app(@_); |
120 | |
121 | B<NOT>: |
122 | |
123 | my $app = sub { MyCatalystApp->psgi_app(@_) }; |
124 | # If you make ^^ this mistake, your app won't work, and will confuse the hell out of you! |
125 | |
126 | You can now rename C<< script/myapp.psgi >> to C<< myapp.psgi >>, and the built-in |
127 | Catalyst scripts, and your test suite will start using your .psgi file. |
ad15c817 |
128 | |
34effbc7 |
129 | B<NOTE:> If you rename your .psgi file without these modifications, then any tests run via |
8f912f0b |
130 | L<Catalyst::Test> will not be compatible with the new release, and will result in |
131 | the development server starting, rather than the expected test running. |
93a57b4b |
132 | |
133 | =head2 Engines which are known broken |
134 | |
135 | The following engines B<DO NOT> work as of Catalyst version 5.90. The core |
136 | team is extremely happy to work with the developers and/or users of these |
137 | engines to help them port to the new Plack/Engine system, however applications |
138 | which are currently using these engines B<WILL NOT> run without modification |
139 | to the engine code. |
140 | |
141 | =over |
142 | |
143 | =item Catalyst::Engine::Wx |
144 | |
ad15c817 |
145 | =item Catalyst::Engine::Zeus |
146 | |
147 | =item Catalyst::Engine::JobQueue::POE |
148 | |
149 | =item Catalyst::Engine::XMPP2 |
150 | |
151 | =item Catalyst::Engine::SCGI |
152 | |
93a57b4b |
153 | =back |
154 | |
5d5f4a73 |
155 | =head2 Engines with unknown status |
156 | |
157 | The following engines have untested or unknown compatibility. Reports are |
158 | highly welcomed: |
159 | |
ad15c817 |
160 | =over |
161 | |
162 | =item Catalyst::Engine::Mojo |
163 | |
164 | =item Catalyst::Engine::Server (Marked as Deprecated) |
165 | |
166 | =item Catalyst::Engine::HTTP::POE (Marked as Deprecated) |
167 | |
168 | =back |
5d5f4a73 |
169 | |
0aafa77a |
170 | =head2 Specifying the engine in the call to ->setup |
171 | |
172 | XXX FIXME |
173 | |
040835f0 |
174 | =head2 Using middleware |
175 | |
0aafa77a |
176 | XXX FIXME Should this be here or elsewhere? |
5d5f4a73 |
177 | |
040835f0 |
178 | =head2 Making an app.psgi file |
5d5f4a73 |
179 | |
0aafa77a |
180 | FIXME |
181 | |
040835f0 |
182 | =head2 Running with plackup? |
5d5f4a73 |
183 | |
0aafa77a |
184 | FIXME |
185 | |
4db14a9a |
186 | =head2 Tests in 5.89 |
187 | |
188 | Tests should generally work the same in Catalyst 5.89, however there are some differences. |
189 | |
190 | Previously, if using L<Catalyst::Test> and doing local requests (against a local server), |
191 | if the application threw an exception then this exception propagated into the test. |
192 | |
193 | This behaviour has been removed, and now a 500 response will be returned to the test. |
194 | This change unifies behaviour, to make local test requests behave similarly to remote |
195 | requests. |
196 | |
7e2ec16e |
197 | =head1 Upgrading to Catalyst 5.80 |
198 | |
5687c7f9 |
199 | Most applications and plugins should run unaltered on Catalyst 5.80. |
7e2ec16e |
200 | |
8f61d649 |
201 | However, a lot of refactoring work has taken place, and several changes have |
1a98f036 |
202 | been made which could cause incompatibilities. If your application or plugin |
8f61d649 |
203 | is using deprecated code, or relying on side effects, then you could have |
ba03ccca |
204 | issues upgrading to this release. |
5687c7f9 |
205 | |
8f61d649 |
206 | Most issues found with pre-existing components have been easy to |
207 | solve. This document provides a complete description of behavior changes |
208 | which may cause compatibility issues, and of new Catalyst warnings which |
209 | be unclear. |
7e2ec16e |
210 | |
8f61d649 |
211 | If you think you have found an upgrade-related issue which is not covered in |
212 | this document, please email the Catalyst list to discuss the problem. |
7e2ec16e |
213 | |
85f0a66f |
214 | =head1 Moose features |
215 | |
8f61d649 |
216 | =head2 Application class roles |
85f0a66f |
217 | |
8f61d649 |
218 | You can only apply method modifiers after the application's C<< ->setup >> |
85f0a66f |
219 | method has been called. This means that modifiers will not work with methods |
220 | which run during the call to C<< ->setup >>. |
221 | |
a6eb852a |
222 | See L<Catalyst::Manual::ExtendingCatalyst> for more information about using |
223 | L<Moose> in your applications. |
224 | |
85f0a66f |
225 | =head2 Controller actions in Moose roles |
226 | |
d76c88f3 |
227 | You can use L<MooseX::MethodAttributes::Role> if you want to declare actions |
228 | inside Moose roles. |
85f0a66f |
229 | |
d935773d |
230 | =head2 Using Moose in Components |
231 | |
232 | The correct way to use Moose in a component in a both forward and backwards |
233 | compatible way is: |
234 | |
235 | package TestApp::Controller::Root; |
236 | use Moose; |
237 | BEGIN { extends 'Catalyst::Component' }; # Or ::Controller, or whatever |
238 | |
239 | See L<Components which inherit from Moose::Object before Catalyst::Component>. |
240 | |
8f61d649 |
241 | =head1 Known backwards compatibility breakages |
7e2ec16e |
242 | |
8f61d649 |
243 | =head2 Applications in a single file |
85f0a66f |
244 | |
245 | Applications must be in their own file, and loaded at compile time. This |
8f61d649 |
246 | issue generally only affects the tests of CPAN distributions. Your |
247 | application will fail if you try to define an application inline in a |
248 | block, and use plugins which supply a C< new > method, then use that |
249 | application latter in tests within the same file. |
85f0a66f |
250 | |
251 | This is due to the fact that Catalyst is inlining a new method on your |
8f61d649 |
252 | application class allowing it to be compatible with Moose. The method |
253 | used to do this changed in 5.80004 to avoid the possibility of reporting |
254 | an 'Unknown Error' if your application failed to compile. |
85f0a66f |
255 | |
38f90e49 |
256 | =head2 Issues with Class::C3 |
257 | |
8f61d649 |
258 | Catalyst 5.80 uses the L<Algorithm::C3> method dispatch order. This is |
259 | built into Perl 5.10, and comes via L<Class::C3> for Perl 5.8. This |
260 | replaces L<NEXT> with L<Class::C3::Adopt::NEXT>, forcing all components |
261 | to resolve methods using C3, rather than the unpredictable dispatch |
262 | order of L<NEXT>. |
38f90e49 |
263 | |
5d06547d |
264 | This issue is characterised by your application failing to start due to an |
265 | error message about having a non-linear @ISA. |
266 | |
8f61d649 |
267 | The Catalyst plugin most often causing this is |
268 | L<Catalyst::Plugin::Session::Store::FastMmap> - if you are using this |
269 | plugin and see issues, then please upgrade your plugins, as it has been |
270 | fixed. Note that Makefile.PL in the distribution will warn about known |
271 | incompatible components. |
5d06547d |
272 | |
273 | This issue can, however, be found in your own application - the only solution is |
274 | to go through each base class of the class the error was reported against, until |
275 | you identify the ones in conflict, and resolve them. |
276 | |
277 | To be able to generate a linear @ISA, the list of superclasses for each |
278 | class must be resolvable using the C3 algorithm. Unfortunately, when |
279 | superclasses are being used as mixins (to add functionality used in your class), |
ae7da8f5 |
280 | and with multiple inheritance, it is easy to get this wrong. |
38f90e49 |
281 | |
282 | Most common is the case of: |
283 | |
284 | package Component1; # Note, this is the common case |
285 | use base qw/Class::Accessor::Fast Class::Data::Inheritable/; |
286 | |
8f61d649 |
287 | package Component2; # Accidentally saying it this way causes a failure |
38f90e49 |
288 | use base qw/Class::Data::Inheritable Class::Accessor::Fast/; |
289 | |
290 | package GoesBang; |
291 | use base qw/Component1 Component2/; |
292 | |
5d06547d |
293 | Any situation like this will cause your application to fail to start. |
38f90e49 |
294 | |
8f61d649 |
295 | For additional documentation about this issue, and how to resolve it, see |
5d06547d |
296 | L<Class::C3::Adopt::NEXT>. |
38f90e49 |
297 | |
6f04e56a |
298 | =head2 Components which inherit from Moose::Object before Catalyst::Component |
7e2ec16e |
299 | |
6f04e56a |
300 | Moose components which say: |
7e2ec16e |
301 | |
6f04e56a |
302 | package TestApp::Controller::Example; |
303 | use Moose; |
845bfcd2 |
304 | extends qw/Moose::Object Catalyst::Component/; |
7e2ec16e |
305 | |
8f61d649 |
306 | to use the constructor provided by Moose, while working (if you do some hacks |
1a98f036 |
307 | with the C< BUILDARGS > method), will not work with Catalyst 5.80 as |
6f04e56a |
308 | C<Catalyst::Component> inherits from C<Moose::Object>, and so C< @ISA > fails |
25f61108 |
309 | to linearize. |
6f04e56a |
310 | |
6f04e56a |
311 | The correct way to use Moose in a component in a both forward and backwards |
312 | compatible way is: |
313 | |
314 | package TestApp::Controller::Root; |
315 | use Moose; |
316 | BEGIN { extends 'Catalyst::Component' }; # Or ::Controller, or whatever |
317 | |
ba03ccca |
318 | Note that the C< extends > declaration needs to occur in a begin block for |
3df46b1b |
319 | L<attributes> to operate correctly. |
320 | |
d935773d |
321 | This way you do not inherit directly from C<Moose::Object> |
322 | yourself. Having components which do not inherit their constructor from |
323 | C<Catalyst::Component> is B<unsupported>, and has never been recommended, |
324 | therefore you're on your own if you're using this technique. You'll need |
325 | to detect the version of Catalyst your application is running, and deal |
326 | with it appropriately. |
327 | |
eaae9a92 |
328 | You also don't get the L<Moose::Object> constructor, and therefore attribute |
329 | initialization will not work as normally expected. If you want to use Moose |
3df46b1b |
330 | attributes, then they need to be made lazy to correctly initialize. |
331 | |
332 | Note that this only applies if your component needs to maintain component |
333 | backwards compatibility for Catalyst versions before 5.71001 - in 5.71001 |
334 | attributes work as expected, and the BUILD method is called normally |
eaae9a92 |
335 | (although BUILDARGS is not). |
3df46b1b |
336 | |
337 | If you depend on Catalyst 5.8, then B<all> Moose features work as expected. |
8566c0de |
338 | |
d935773d |
339 | You will also see this issue if you do the following: |
340 | |
341 | package TestApp::Controller::Example; |
342 | use Moose; |
343 | use base 'Catalyst::Controller'; |
344 | |
345 | as C< use base > appends to @ISA. |
346 | |
e11cac87 |
347 | =head3 use Moose in MyApp |
348 | |
349 | Similar to the above, this will also fail: |
350 | |
351 | package MyApp; |
352 | use Moose; |
353 | use Catalyst qw/ |
354 | ConfigLoader |
355 | /; |
356 | __PACKAGE__->setup; |
357 | |
358 | If you need to use Moose in your application class (e.g. for method modifiers |
8f61d649 |
359 | etc.) then the correct technique is: |
e11cac87 |
360 | |
361 | package MyApp; |
362 | use Moose; |
5b6f82d2 |
363 | use Catalyst; |
364 | |
e11cac87 |
365 | extends 'Catalyst'; |
5b6f82d2 |
366 | |
367 | __PACKAGE__->config( name => 'MyApp' ); |
e11cac87 |
368 | __PACKAGE__->setup(qw/ |
369 | ConfigLoader |
370 | /); |
371 | |
04a48104 |
372 | =head2 Anonymous closures installed directly into the symbol table |
373 | |
374 | If you have any code which installs anonymous subroutine references directly |
375 | into the symbol table, you may encounter breakages. The simplest solution is |
376 | to use L<Sub::Name> to name the subroutine. Example: |
377 | |
e11cac87 |
378 | # Original code, likely to break: |
1a98f036 |
379 | my $full_method_name = join('::', $package_name, $method_name); |
04a48104 |
380 | *$full_method_name = sub { ... }; |
381 | |
e11cac87 |
382 | # Fixed Code |
04a48104 |
383 | use Sub::Name 'subname'; |
384 | my $full_method_name = join('::',$package_name, $method_name); |
385 | *$full_method_name = subname $full_method_name, sub { ... }; |
386 | |
8f61d649 |
387 | Additionally, you can take advantage of Catalyst's use of L<Class::MOP> and |
388 | install the closure using the appropriate metaclass. Example: |
04a48104 |
389 | |
390 | use Class::MOP; |
391 | my $metaclass = Moose::Meta::Class->initialize($package_name); |
392 | $metaclass->add_method($method_name => sub { ... }); |
393 | |
780654ad |
394 | =head2 Hooking into application setup |
395 | |
8f61d649 |
396 | To execute code during application start-up, the following snippet in MyApp.pm |
780654ad |
397 | used to work: |
398 | |
399 | sub setup { |
400 | my ($class, @args) = @_; |
401 | $class->NEXT::setup(@args); |
402 | ... # things to do after the actual setup |
403 | } |
404 | |
8f61d649 |
405 | With Catalyst 5.80 this won't work anymore, because Catalyst no longer |
406 | uses NEXT.pm for method resolution. The functionality was only ever |
407 | originally operational as L<NEXT> remembers what methods have already |
408 | been called, and will not call them again. |
780654ad |
409 | |
1a98f036 |
410 | Using this now causes infinite recursion between MyApp::setup and |
411 | Catalyst::setup, due to other backwards compatibility issues related to how |
e6c5b548 |
412 | plugin setup works. Moose method modifiers like C<< before|after|around setup |
1a98f036 |
413 | => sub { ... }; >> also will not operate correctly on the setup method. |
780654ad |
414 | |
415 | The right way to do it is this: |
416 | |
417 | after setup_finalize => sub { |
418 | ... # things to do after the actual setup |
419 | }; |
420 | |
ade00972 |
421 | The setup_finalize hook was introduced as a way to avoid this issue. |
1a98f036 |
422 | |
e11cac87 |
423 | =head2 Components with a new method which returns false |
7e2ec16e |
424 | |
8dd2f514 |
425 | Previously, if you had a component which inherited from Catalyst::COMPONENT, |
8f61d649 |
426 | but overrode the new method to return false, then your class's configuration |
8dd2f514 |
427 | would be blessed into a hash on your behalf, and this would be returned from |
a87f5aa5 |
428 | the COMPONENT method. |
7e2ec16e |
429 | |
8f61d649 |
430 | This behavior makes no sense, and so has been removed. Implementing your own |
431 | C< new > method in components is B<highly> discouraged. Instead, you should |
432 | inherit the new method from Catalyst::Component, and use Moose's BUILD |
1a98f036 |
433 | functionality and/or Moose attributes to perform any construction work |
434 | necessary for your class. |
7e2ec16e |
435 | |
436 | =head2 __PACKAGE__->mk_accessor('meta'); |
437 | |
e11cac87 |
438 | Won't work due to a limitation of L<Moose>. This is currently being fixed |
439 | inside Moose. |
7e2ec16e |
440 | |
441 | =head2 Class::Data::Inheritable side effects |
442 | |
8dd2f514 |
443 | Previously, writing to a class data accessor would copy the accessor method |
444 | down into your package. |
445 | |
8f61d649 |
446 | This behavior has been removed. While the class data is still stored |
8dd2f514 |
447 | per-class, it is stored on the metaclass of the class defining the accessor. |
7e2ec16e |
448 | |
8f61d649 |
449 | Therefore anything relying on the side effect of the accessor being copied down |
8dd2f514 |
450 | will be broken. |
7e2ec16e |
451 | |
1a98f036 |
452 | The following test demonstrates the problem: |
8dd2f514 |
453 | |
454 | { |
455 | package BaseClass; |
456 | use base qw/Class::Data::Inheritable/; |
457 | __PACKAGE__->mk_classdata('foo'); |
458 | } |
459 | |
460 | { |
461 | package Child; |
462 | use base qw/BaseClass/; |
463 | } |
464 | |
465 | BaseClass->foo('base class'); |
466 | Child->foo('sub class'); |
eaae9a92 |
467 | |
e11cac87 |
468 | use Test::More; |
8dd2f514 |
469 | isnt(BaseClass->can('foo'), Child->can('foo')); |
7e2ec16e |
470 | |
8f61d649 |
471 | =head2 Extending Catalyst::Request or other classes in an ad-hoc manner using mk_accessors |
7e2ec16e |
472 | |
8dd2f514 |
473 | Previously, it was possible to add additional accessors to Catalyst::Request |
474 | (or other classes) by calling the mk_accessors class method. |
7e2ec16e |
475 | |
8f61d649 |
476 | This is no longer supported - users should make a subclass of the class whose |
477 | behavior they would like to change, rather than globally polluting the |
e11cac87 |
478 | Catalyst objects. |
8be895a7 |
479 | |
10011c19 |
480 | =head2 Confused multiple inheritance with Catalyst::Component::COMPONENT |
8be895a7 |
481 | |
8f61d649 |
482 | Previously, Catalyst's COMPONENT method would delegate to the method on |
483 | the right hand side, which could then delegate back again with |
484 | NEXT. This is poor practice, and in addition, makes no sense with C3 |
485 | method dispatch order, and is therefore no longer supported. |
bcc773b9 |
486 | |
ba03ccca |
487 | If a COMPONENT method is detected in the inheritance hierarchy to the right |
bcc773b9 |
488 | hand side of Catalyst::Component::COMPONENT, then the following warning |
489 | message will be emitted: |
7e2ec16e |
490 | |
8dd2f514 |
491 | There is a COMPONENT method resolving after Catalyst::Component |
5687c7f9 |
492 | in ${next_package}. |
8dd2f514 |
493 | |
8f61d649 |
494 | The correct fix is to re-arrange your class's inheritance hierarchy so that the |
bcc773b9 |
495 | COMPONENT method you would like to inherit is the first (left-hand most) |
496 | COMPONENT method in your @ISA. |
7e2ec16e |
497 | |
c571d2c8 |
498 | =head1 WARNINGS |
499 | |
63b546b1 |
500 | =head2 Actions in your application class |
501 | |
502 | Having actions in your application class will now emit a warning at application |
e256d0e1 |
503 | startup as this is deprecated. It is highly recommended that these actions are moved |
63b546b1 |
504 | into a MyApp::Controller::Root (as demonstrated by the scaffold application |
55dd186c |
505 | generated by catalyst.pl). |
da73c6af |
506 | |
e256d0e1 |
507 | This warning, also affects tests. You should move actions in your test, |
508 | creating a myTest::Controller::Root, like the following example: |
da73c6af |
509 | |
510 | package MyTest::Controller::Root; |
95a52a01 |
511 | |
da73c6af |
512 | use strict; |
513 | use warnings; |
95a52a01 |
514 | |
da73c6af |
515 | use parent 'Catalyst::Controller'; |
95a52a01 |
516 | |
da73c6af |
517 | __PACKAGE__->config(namespace => ''); |
95a52a01 |
518 | |
da73c6af |
519 | sub action : Local { |
520 | my ( $self, $c ) = @_; |
521 | $c->do_something; |
522 | } |
95a52a01 |
523 | |
da73c6af |
524 | 1; |
63b546b1 |
525 | |
ac9279b0 |
526 | =head2 ::[MVC]:: naming scheme |
527 | |
528 | Having packages called MyApp::[MVC]::XX is deprecated and can no longer be generated |
529 | by catalyst.pl |
530 | |
531 | This is still supported, but it is recommended that you rename your application |
532 | components to Model/View/Controller. |
533 | |
534 | A warning will be issued at application startup if the ::[MVC]:: naming scheme is |
535 | in use. |
536 | |
ade00972 |
537 | =head2 Catalyst::Base |
538 | |
8f61d649 |
539 | Any code using L<Catalyst::Base> will now emit a warning; this |
540 | module will be removed in a future release. |
ade00972 |
541 | |
c571d2c8 |
542 | =head2 Methods in Catalyst::Dispatcher |
543 | |
8f61d649 |
544 | The following methods in Catalyst::Dispatcher are implementation |
545 | details, which may change in the 5.8X release series, and therefore their use |
bcc773b9 |
546 | is highly deprecated. |
c571d2c8 |
547 | |
548 | =over |
549 | |
8dd2f514 |
550 | =item tree |
c571d2c8 |
551 | |
8dd2f514 |
552 | =item dispatch_types |
c571d2c8 |
553 | |
8dd2f514 |
554 | =item registered_dispatch_types |
c571d2c8 |
555 | |
8dd2f514 |
556 | =item method_action_class |
c571d2c8 |
557 | |
8dd2f514 |
558 | =item action_hash |
c571d2c8 |
559 | |
560 | =item container_hash |
561 | |
562 | =back |
563 | |
564 | The first time one of these methods is called, a warning will be emitted: |
7e2ec16e |
565 | |
bcc773b9 |
566 | Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name, |
567 | this will be removed in Catalyst 5.9X |
7e2ec16e |
568 | |
c571d2c8 |
569 | You should B<NEVER> be calling any of these methods from application code. |
570 | |
8f61d649 |
571 | Plugin authors and maintainers whose plugins currently call these methods |
8f5a2bd9 |
572 | should change to using the public API, or, if you do not feel the public API |
8f61d649 |
573 | adequately supports your use case, please email the development list to |
8f5a2bd9 |
574 | discuss what API features you need so that you can be appropriately supported. |
7e2ec16e |
575 | |
95b20422 |
576 | =head2 Class files with names that don't correspond to the packages they define |
7e2ec16e |
577 | |
e11cac87 |
578 | In this version of Catalyst, if a component is loaded from disk, but no |
ba03ccca |
579 | symbols are defined in that component's name space after it is loaded, this |
bcc773b9 |
580 | warning will be issued: |
7e2ec16e |
581 | |
bcc773b9 |
582 | require $class was successful but the package is not defined. |
7e2ec16e |
583 | |
8f61d649 |
584 | This is to protect against confusing bugs caused by mistyping package names, |
bcc773b9 |
585 | and will become a fatal error in a future version. |
586 | |
587 | Please note that 'inner packages' (via L<Devel::InnerPackage>) are still fully |
8f61d649 |
588 | supported; this warning is only issued when component file naming does not map |
bcc773b9 |
589 | to B<any> of the packages defined within that component. |
7e2ec16e |
590 | |
5687c7f9 |
591 | =head2 $c->plugin method |
592 | |
25f61108 |
593 | Calling the plugin method is deprecated, and calling it at run time is B<highly |
8dd2f514 |
594 | deprecated>. |
7e2ec16e |
595 | |
95a52a01 |
596 | Instead you are recommended to use L<Catalyst::Model::Adaptor> or similar to |
ba03ccca |
597 | compose the functionality you need outside of the main application name space. |
7e2ec16e |
598 | |
4e68badc |
599 | Calling the plugin method will not be supported past Catalyst 5.81. |
bcc773b9 |
600 | |
7e2ec16e |
601 | =cut |
4e68badc |
602 | |