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