Commit | Line | Data |
8c57b129 |
1 | =head1 NAME |
2 | |
3 | Catalyst::Upgrading - Instructions for upgrading to the latest Catalyst |
4 | |
dacd8b0e |
5 | =head1 Upgrading to Catalyst 5.9 |
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. |
773b3b08 |
11 | However since L<Plack> is different from L<Catalyst::Engine> it is possible |
12 | that edge case differences exist. Therefore we recommend care be taken with |
13 | this upgrade and that testing should be greater than would be the case with a |
14 | minor point update. |
5d5f4a73 |
15 | |
773b3b08 |
16 | It is highly recommended that you become familiar 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 |
773b3b08 |
26 | release supersedes that code. |
5d5f4a73 |
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 |
773b3b08 |
43 | L<Catalyst::Engine::Apache2::MP20> should be seamless upgrades and will |
5d5f4a73 |
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 | |
773b3b08 |
66 | If you were customising your server script to pass options to the prefork engine, |
24fd6115 |
67 | then this is no longer supported. The recommended route to implement this functionality |
773b3b08 |
68 | is to write a simple .psgi file for your application, then use the L<plackup> utility. |
5d5f4a73 |
69 | |
93d60cae |
70 | =head2 Upgrading the PSGI Engine |
5d5f4a73 |
71 | |
773b3b08 |
72 | If you were using L<Catalyst::Engine::PSGI> this new release supersedes 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 | |
773b3b08 |
126 | You can now move 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 | |
dacd8b0e |
135 | The following engines B<DO NOT> work as of Catalyst version 5.9. The core |
93a57b4b |
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 | |
3f22de0b |
174 | =head2 Plack functionality |
040835f0 |
175 | |
3f22de0b |
176 | See L<Catalyst::PSGI>. |
0aafa77a |
177 | |
dacd8b0e |
178 | =head2 Tests in 5.9 |
4db14a9a |
179 | |
dacd8b0e |
180 | Tests should generally work the same in Catalyst 5.9, however there are some differences. |
4db14a9a |
181 | |
182 | Previously, if using L<Catalyst::Test> and doing local requests (against a local server), |
183 | if the application threw an exception then this exception propagated into the test. |
184 | |
773b3b08 |
185 | This behavior has been removed, and now a 500 response will be returned to the test. |
186 | This change unifies behavior, to make local test requests behave similarly to remote |
4db14a9a |
187 | requests. |
188 | |
7e2ec16e |
189 | =head1 Upgrading to Catalyst 5.80 |
190 | |
5687c7f9 |
191 | Most applications and plugins should run unaltered on Catalyst 5.80. |
7e2ec16e |
192 | |
8f61d649 |
193 | However, a lot of refactoring work has taken place, and several changes have |
1a98f036 |
194 | been made which could cause incompatibilities. If your application or plugin |
8f61d649 |
195 | is using deprecated code, or relying on side effects, then you could have |
ba03ccca |
196 | issues upgrading to this release. |
5687c7f9 |
197 | |
8f61d649 |
198 | Most issues found with pre-existing components have been easy to |
199 | solve. This document provides a complete description of behavior changes |
200 | which may cause compatibility issues, and of new Catalyst warnings which |
773b3b08 |
201 | might be unclear. |
7e2ec16e |
202 | |
8f61d649 |
203 | If you think you have found an upgrade-related issue which is not covered in |
204 | this document, please email the Catalyst list to discuss the problem. |
7e2ec16e |
205 | |
85f0a66f |
206 | =head1 Moose features |
207 | |
8f61d649 |
208 | =head2 Application class roles |
85f0a66f |
209 | |
8f61d649 |
210 | You can only apply method modifiers after the application's C<< ->setup >> |
85f0a66f |
211 | method has been called. This means that modifiers will not work with methods |
773b3b08 |
212 | run during the call to C<< ->setup >>. |
85f0a66f |
213 | |
a6eb852a |
214 | See L<Catalyst::Manual::ExtendingCatalyst> for more information about using |
215 | L<Moose> in your applications. |
216 | |
85f0a66f |
217 | =head2 Controller actions in Moose roles |
218 | |
d76c88f3 |
219 | You can use L<MooseX::MethodAttributes::Role> if you want to declare actions |
220 | inside Moose roles. |
85f0a66f |
221 | |
d935773d |
222 | =head2 Using Moose in Components |
223 | |
224 | The correct way to use Moose in a component in a both forward and backwards |
225 | compatible way is: |
226 | |
227 | package TestApp::Controller::Root; |
228 | use Moose; |
229 | BEGIN { extends 'Catalyst::Component' }; # Or ::Controller, or whatever |
230 | |
231 | See L<Components which inherit from Moose::Object before Catalyst::Component>. |
232 | |
8f61d649 |
233 | =head1 Known backwards compatibility breakages |
7e2ec16e |
234 | |
8f61d649 |
235 | =head2 Applications in a single file |
85f0a66f |
236 | |
237 | Applications must be in their own file, and loaded at compile time. This |
8f61d649 |
238 | issue generally only affects the tests of CPAN distributions. Your |
239 | application will fail if you try to define an application inline in a |
240 | block, and use plugins which supply a C< new > method, then use that |
241 | application latter in tests within the same file. |
85f0a66f |
242 | |
243 | This is due to the fact that Catalyst is inlining a new method on your |
8f61d649 |
244 | application class allowing it to be compatible with Moose. The method |
245 | used to do this changed in 5.80004 to avoid the possibility of reporting |
246 | an 'Unknown Error' if your application failed to compile. |
85f0a66f |
247 | |
38f90e49 |
248 | =head2 Issues with Class::C3 |
249 | |
8f61d649 |
250 | Catalyst 5.80 uses the L<Algorithm::C3> method dispatch order. This is |
251 | built into Perl 5.10, and comes via L<Class::C3> for Perl 5.8. This |
252 | replaces L<NEXT> with L<Class::C3::Adopt::NEXT>, forcing all components |
253 | to resolve methods using C3, rather than the unpredictable dispatch |
254 | order of L<NEXT>. |
38f90e49 |
255 | |
5d06547d |
256 | This issue is characterised by your application failing to start due to an |
257 | error message about having a non-linear @ISA. |
258 | |
8f61d649 |
259 | The Catalyst plugin most often causing this is |
260 | L<Catalyst::Plugin::Session::Store::FastMmap> - if you are using this |
261 | plugin and see issues, then please upgrade your plugins, as it has been |
262 | fixed. Note that Makefile.PL in the distribution will warn about known |
263 | incompatible components. |
5d06547d |
264 | |
265 | This issue can, however, be found in your own application - the only solution is |
266 | to go through each base class of the class the error was reported against, until |
267 | you identify the ones in conflict, and resolve them. |
268 | |
269 | To be able to generate a linear @ISA, the list of superclasses for each |
270 | class must be resolvable using the C3 algorithm. Unfortunately, when |
271 | superclasses are being used as mixins (to add functionality used in your class), |
ae7da8f5 |
272 | and with multiple inheritance, it is easy to get this wrong. |
38f90e49 |
273 | |
274 | Most common is the case of: |
275 | |
276 | package Component1; # Note, this is the common case |
277 | use base qw/Class::Accessor::Fast Class::Data::Inheritable/; |
278 | |
8f61d649 |
279 | package Component2; # Accidentally saying it this way causes a failure |
38f90e49 |
280 | use base qw/Class::Data::Inheritable Class::Accessor::Fast/; |
281 | |
282 | package GoesBang; |
283 | use base qw/Component1 Component2/; |
284 | |
5d06547d |
285 | Any situation like this will cause your application to fail to start. |
38f90e49 |
286 | |
8f61d649 |
287 | For additional documentation about this issue, and how to resolve it, see |
5d06547d |
288 | L<Class::C3::Adopt::NEXT>. |
38f90e49 |
289 | |
6f04e56a |
290 | =head2 Components which inherit from Moose::Object before Catalyst::Component |
7e2ec16e |
291 | |
6f04e56a |
292 | Moose components which say: |
7e2ec16e |
293 | |
6f04e56a |
294 | package TestApp::Controller::Example; |
295 | use Moose; |
845bfcd2 |
296 | extends qw/Moose::Object Catalyst::Component/; |
7e2ec16e |
297 | |
8f61d649 |
298 | to use the constructor provided by Moose, while working (if you do some hacks |
1a98f036 |
299 | with the C< BUILDARGS > method), will not work with Catalyst 5.80 as |
6f04e56a |
300 | C<Catalyst::Component> inherits from C<Moose::Object>, and so C< @ISA > fails |
25f61108 |
301 | to linearize. |
6f04e56a |
302 | |
6f04e56a |
303 | The correct way to use Moose in a component in a both forward and backwards |
304 | compatible way is: |
305 | |
306 | package TestApp::Controller::Root; |
307 | use Moose; |
308 | BEGIN { extends 'Catalyst::Component' }; # Or ::Controller, or whatever |
309 | |
ba03ccca |
310 | Note that the C< extends > declaration needs to occur in a begin block for |
3df46b1b |
311 | L<attributes> to operate correctly. |
312 | |
d935773d |
313 | This way you do not inherit directly from C<Moose::Object> |
314 | yourself. Having components which do not inherit their constructor from |
315 | C<Catalyst::Component> is B<unsupported>, and has never been recommended, |
316 | therefore you're on your own if you're using this technique. You'll need |
317 | to detect the version of Catalyst your application is running, and deal |
318 | with it appropriately. |
319 | |
eaae9a92 |
320 | You also don't get the L<Moose::Object> constructor, and therefore attribute |
321 | initialization will not work as normally expected. If you want to use Moose |
3df46b1b |
322 | attributes, then they need to be made lazy to correctly initialize. |
323 | |
324 | Note that this only applies if your component needs to maintain component |
325 | backwards compatibility for Catalyst versions before 5.71001 - in 5.71001 |
326 | attributes work as expected, and the BUILD method is called normally |
eaae9a92 |
327 | (although BUILDARGS is not). |
3df46b1b |
328 | |
329 | If you depend on Catalyst 5.8, then B<all> Moose features work as expected. |
8566c0de |
330 | |
d935773d |
331 | You will also see this issue if you do the following: |
332 | |
333 | package TestApp::Controller::Example; |
334 | use Moose; |
335 | use base 'Catalyst::Controller'; |
336 | |
337 | as C< use base > appends to @ISA. |
338 | |
e11cac87 |
339 | =head3 use Moose in MyApp |
340 | |
341 | Similar to the above, this will also fail: |
342 | |
343 | package MyApp; |
344 | use Moose; |
345 | use Catalyst qw/ |
346 | ConfigLoader |
347 | /; |
348 | __PACKAGE__->setup; |
349 | |
350 | If you need to use Moose in your application class (e.g. for method modifiers |
8f61d649 |
351 | etc.) then the correct technique is: |
e11cac87 |
352 | |
353 | package MyApp; |
354 | use Moose; |
5b6f82d2 |
355 | use Catalyst; |
356 | |
e11cac87 |
357 | extends 'Catalyst'; |
5b6f82d2 |
358 | |
359 | __PACKAGE__->config( name => 'MyApp' ); |
e11cac87 |
360 | __PACKAGE__->setup(qw/ |
361 | ConfigLoader |
362 | /); |
363 | |
04a48104 |
364 | =head2 Anonymous closures installed directly into the symbol table |
365 | |
366 | If you have any code which installs anonymous subroutine references directly |
367 | into the symbol table, you may encounter breakages. The simplest solution is |
368 | to use L<Sub::Name> to name the subroutine. Example: |
369 | |
e11cac87 |
370 | # Original code, likely to break: |
1a98f036 |
371 | my $full_method_name = join('::', $package_name, $method_name); |
04a48104 |
372 | *$full_method_name = sub { ... }; |
373 | |
e11cac87 |
374 | # Fixed Code |
04a48104 |
375 | use Sub::Name 'subname'; |
376 | my $full_method_name = join('::',$package_name, $method_name); |
377 | *$full_method_name = subname $full_method_name, sub { ... }; |
378 | |
8f61d649 |
379 | Additionally, you can take advantage of Catalyst's use of L<Class::MOP> and |
380 | install the closure using the appropriate metaclass. Example: |
04a48104 |
381 | |
382 | use Class::MOP; |
383 | my $metaclass = Moose::Meta::Class->initialize($package_name); |
384 | $metaclass->add_method($method_name => sub { ... }); |
385 | |
780654ad |
386 | =head2 Hooking into application setup |
387 | |
8f61d649 |
388 | To execute code during application start-up, the following snippet in MyApp.pm |
780654ad |
389 | used to work: |
390 | |
391 | sub setup { |
392 | my ($class, @args) = @_; |
393 | $class->NEXT::setup(@args); |
394 | ... # things to do after the actual setup |
395 | } |
396 | |
8f61d649 |
397 | With Catalyst 5.80 this won't work anymore, because Catalyst no longer |
398 | uses NEXT.pm for method resolution. The functionality was only ever |
399 | originally operational as L<NEXT> remembers what methods have already |
400 | been called, and will not call them again. |
780654ad |
401 | |
1a98f036 |
402 | Using this now causes infinite recursion between MyApp::setup and |
403 | Catalyst::setup, due to other backwards compatibility issues related to how |
e6c5b548 |
404 | plugin setup works. Moose method modifiers like C<< before|after|around setup |
1a98f036 |
405 | => sub { ... }; >> also will not operate correctly on the setup method. |
780654ad |
406 | |
407 | The right way to do it is this: |
408 | |
409 | after setup_finalize => sub { |
410 | ... # things to do after the actual setup |
411 | }; |
412 | |
ade00972 |
413 | The setup_finalize hook was introduced as a way to avoid this issue. |
1a98f036 |
414 | |
e11cac87 |
415 | =head2 Components with a new method which returns false |
7e2ec16e |
416 | |
8dd2f514 |
417 | Previously, if you had a component which inherited from Catalyst::COMPONENT, |
8f61d649 |
418 | but overrode the new method to return false, then your class's configuration |
8dd2f514 |
419 | would be blessed into a hash on your behalf, and this would be returned from |
a87f5aa5 |
420 | the COMPONENT method. |
7e2ec16e |
421 | |
8f61d649 |
422 | This behavior makes no sense, and so has been removed. Implementing your own |
423 | C< new > method in components is B<highly> discouraged. Instead, you should |
424 | inherit the new method from Catalyst::Component, and use Moose's BUILD |
1a98f036 |
425 | functionality and/or Moose attributes to perform any construction work |
426 | necessary for your class. |
7e2ec16e |
427 | |
428 | =head2 __PACKAGE__->mk_accessor('meta'); |
429 | |
e11cac87 |
430 | Won't work due to a limitation of L<Moose>. This is currently being fixed |
431 | inside Moose. |
7e2ec16e |
432 | |
433 | =head2 Class::Data::Inheritable side effects |
434 | |
8dd2f514 |
435 | Previously, writing to a class data accessor would copy the accessor method |
436 | down into your package. |
437 | |
8f61d649 |
438 | This behavior has been removed. While the class data is still stored |
8dd2f514 |
439 | per-class, it is stored on the metaclass of the class defining the accessor. |
7e2ec16e |
440 | |
8f61d649 |
441 | Therefore anything relying on the side effect of the accessor being copied down |
8dd2f514 |
442 | will be broken. |
7e2ec16e |
443 | |
1a98f036 |
444 | The following test demonstrates the problem: |
8dd2f514 |
445 | |
446 | { |
447 | package BaseClass; |
448 | use base qw/Class::Data::Inheritable/; |
449 | __PACKAGE__->mk_classdata('foo'); |
450 | } |
451 | |
452 | { |
453 | package Child; |
454 | use base qw/BaseClass/; |
455 | } |
456 | |
457 | BaseClass->foo('base class'); |
458 | Child->foo('sub class'); |
eaae9a92 |
459 | |
e11cac87 |
460 | use Test::More; |
8dd2f514 |
461 | isnt(BaseClass->can('foo'), Child->can('foo')); |
7e2ec16e |
462 | |
8f61d649 |
463 | =head2 Extending Catalyst::Request or other classes in an ad-hoc manner using mk_accessors |
7e2ec16e |
464 | |
8dd2f514 |
465 | Previously, it was possible to add additional accessors to Catalyst::Request |
466 | (or other classes) by calling the mk_accessors class method. |
7e2ec16e |
467 | |
8f61d649 |
468 | This is no longer supported - users should make a subclass of the class whose |
469 | behavior they would like to change, rather than globally polluting the |
e11cac87 |
470 | Catalyst objects. |
8be895a7 |
471 | |
10011c19 |
472 | =head2 Confused multiple inheritance with Catalyst::Component::COMPONENT |
8be895a7 |
473 | |
8f61d649 |
474 | Previously, Catalyst's COMPONENT method would delegate to the method on |
475 | the right hand side, which could then delegate back again with |
476 | NEXT. This is poor practice, and in addition, makes no sense with C3 |
477 | method dispatch order, and is therefore no longer supported. |
bcc773b9 |
478 | |
ba03ccca |
479 | If a COMPONENT method is detected in the inheritance hierarchy to the right |
bcc773b9 |
480 | hand side of Catalyst::Component::COMPONENT, then the following warning |
481 | message will be emitted: |
7e2ec16e |
482 | |
8dd2f514 |
483 | There is a COMPONENT method resolving after Catalyst::Component |
5687c7f9 |
484 | in ${next_package}. |
8dd2f514 |
485 | |
8f61d649 |
486 | The correct fix is to re-arrange your class's inheritance hierarchy so that the |
bcc773b9 |
487 | COMPONENT method you would like to inherit is the first (left-hand most) |
488 | COMPONENT method in your @ISA. |
7e2ec16e |
489 | |
c571d2c8 |
490 | =head1 WARNINGS |
491 | |
63b546b1 |
492 | =head2 Actions in your application class |
493 | |
494 | Having actions in your application class will now emit a warning at application |
e256d0e1 |
495 | startup as this is deprecated. It is highly recommended that these actions are moved |
63b546b1 |
496 | into a MyApp::Controller::Root (as demonstrated by the scaffold application |
55dd186c |
497 | generated by catalyst.pl). |
da73c6af |
498 | |
e256d0e1 |
499 | This warning, also affects tests. You should move actions in your test, |
500 | creating a myTest::Controller::Root, like the following example: |
da73c6af |
501 | |
502 | package MyTest::Controller::Root; |
95a52a01 |
503 | |
da73c6af |
504 | use strict; |
505 | use warnings; |
95a52a01 |
506 | |
da73c6af |
507 | use parent 'Catalyst::Controller'; |
95a52a01 |
508 | |
da73c6af |
509 | __PACKAGE__->config(namespace => ''); |
95a52a01 |
510 | |
da73c6af |
511 | sub action : Local { |
512 | my ( $self, $c ) = @_; |
513 | $c->do_something; |
514 | } |
95a52a01 |
515 | |
da73c6af |
516 | 1; |
63b546b1 |
517 | |
ac9279b0 |
518 | =head2 ::[MVC]:: naming scheme |
519 | |
520 | Having packages called MyApp::[MVC]::XX is deprecated and can no longer be generated |
521 | by catalyst.pl |
522 | |
523 | This is still supported, but it is recommended that you rename your application |
524 | components to Model/View/Controller. |
525 | |
526 | A warning will be issued at application startup if the ::[MVC]:: naming scheme is |
527 | in use. |
528 | |
ade00972 |
529 | =head2 Catalyst::Base |
530 | |
8f61d649 |
531 | Any code using L<Catalyst::Base> will now emit a warning; this |
532 | module will be removed in a future release. |
ade00972 |
533 | |
c571d2c8 |
534 | =head2 Methods in Catalyst::Dispatcher |
535 | |
8f61d649 |
536 | The following methods in Catalyst::Dispatcher are implementation |
537 | details, which may change in the 5.8X release series, and therefore their use |
bcc773b9 |
538 | is highly deprecated. |
c571d2c8 |
539 | |
540 | =over |
541 | |
8dd2f514 |
542 | =item tree |
c571d2c8 |
543 | |
8dd2f514 |
544 | =item dispatch_types |
c571d2c8 |
545 | |
8dd2f514 |
546 | =item registered_dispatch_types |
c571d2c8 |
547 | |
8dd2f514 |
548 | =item method_action_class |
c571d2c8 |
549 | |
8dd2f514 |
550 | =item action_hash |
c571d2c8 |
551 | |
552 | =item container_hash |
553 | |
554 | =back |
555 | |
556 | The first time one of these methods is called, a warning will be emitted: |
7e2ec16e |
557 | |
bcc773b9 |
558 | Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name, |
dacd8b0e |
559 | this will be removed in Catalyst 5.9 |
7e2ec16e |
560 | |
c571d2c8 |
561 | You should B<NEVER> be calling any of these methods from application code. |
562 | |
8f61d649 |
563 | Plugin authors and maintainers whose plugins currently call these methods |
8f5a2bd9 |
564 | should change to using the public API, or, if you do not feel the public API |
8f61d649 |
565 | adequately supports your use case, please email the development list to |
8f5a2bd9 |
566 | discuss what API features you need so that you can be appropriately supported. |
7e2ec16e |
567 | |
95b20422 |
568 | =head2 Class files with names that don't correspond to the packages they define |
7e2ec16e |
569 | |
e11cac87 |
570 | In this version of Catalyst, if a component is loaded from disk, but no |
ba03ccca |
571 | symbols are defined in that component's name space after it is loaded, this |
bcc773b9 |
572 | warning will be issued: |
7e2ec16e |
573 | |
bcc773b9 |
574 | require $class was successful but the package is not defined. |
7e2ec16e |
575 | |
8f61d649 |
576 | This is to protect against confusing bugs caused by mistyping package names, |
bcc773b9 |
577 | and will become a fatal error in a future version. |
578 | |
579 | Please note that 'inner packages' (via L<Devel::InnerPackage>) are still fully |
8f61d649 |
580 | supported; this warning is only issued when component file naming does not map |
bcc773b9 |
581 | to B<any> of the packages defined within that component. |
7e2ec16e |
582 | |
5687c7f9 |
583 | =head2 $c->plugin method |
584 | |
25f61108 |
585 | Calling the plugin method is deprecated, and calling it at run time is B<highly |
8dd2f514 |
586 | deprecated>. |
7e2ec16e |
587 | |
95a52a01 |
588 | Instead you are recommended to use L<Catalyst::Model::Adaptor> or similar to |
ba03ccca |
589 | compose the functionality you need outside of the main application name space. |
7e2ec16e |
590 | |
4e68badc |
591 | Calling the plugin method will not be supported past Catalyst 5.81. |
bcc773b9 |
592 | |
7e2ec16e |
593 | =cut |
4e68badc |
594 | |