1 =head1 Upgrading to Catalyst 5.80
3 Most applications and plugins should run unaltered on Catalyst 5.80.
5 However as a lot of refactoring work has taken place, several changes
6 have been made which could cause incompatibilities, if your application
7 or plugin is using deprecated code, or relying on side-effects then
8 there could be incompatibility.
10 Most issues found with pre-existing components have been easy to solve,
11 and a complete description of behavior changes which may cause compatibility
12 issues, or warnings to be emitted is included below to help if you have
15 If you think you have found an upgrade related issue which is not covered in
16 this document, then please email the Catalyst list to discuss the problem.
18 =head1 Known backwards compatibility breakages.
20 =head2 Moose applications
22 Moose components for Catalyst 5.70 needed to do
24 extends qw/Moose::Object Catalyst::Component/;
26 to be able to use the constructor provided by Moose. In 5.80
27 C<Catalyst::Component> already inherits from C<Moose::Object>. Therefore you
28 shouldn't directly inherit from C<Moose::Object> yourself, otherwise your
29 Class' @ISA will not linearize with C3.
31 You will also see this issue if you do the following:
34 use base 'Catalyst::Controller';
36 as C< use base > appends to @ISA.
38 FIXME - Add note about the appropriate magic to detect $Catalyst::VERSION
39 and work around it at compile time.
41 =head2 Anonymous closures installed directly into the symbol table
43 If you have any code which installs anonymous subroutine references directly
44 into the symbol table, you may encounter breakages. The simplest solution is
45 to use L<Sub::Name> to name the subroutine. Example:
47 #Originalcode, likely to break:
48 my $full_method_name = join('::',$package_name, $method_name);
49 *$full_method_name = sub { ... };
52 use Sub::Name 'subname';
53 my $full_method_name = join('::',$package_name, $method_name);
54 *$full_method_name = subname $full_method_name, sub { ... };
56 Additionally, you can take advantage of Catalyst's use of L<Class::MOP> and
57 install the closure using the appropriate metaclass. Example:
60 my $metaclass = Moose::Meta::Class->initialize($package_name);
61 $metaclass->add_method($method_name => sub { ... });
63 =head2 Components whos new method returns false
65 Previously if your new method returned a false value,
67 Previously, if you had a component which inherited from Catalyst::COMPONENT, but
68 overrode the new method, to return false, then your class' configuration would be blessed into a hash on your behalf,
69 and this would be returned from the COMPONENT method. T
71 This behaviour makes no sense, and so has been removed.. You are recommended to implement your own new method
72 in components, instead, you should inherit the new method from Catalyst::Component, and use Moose's BUILD functionality
73 to perform any construction work necessary for your sub-class.
75 =head2 __PACKAGE__->mk_accessor('meta');
77 Won't work due to a limitation of L<Moose>
79 This is currently being fixed inside core Moose.
81 =head2 Class::Data::Inheritable side effects
83 Previously, writing to a class data accessor would copy the accessor method down into your package.
85 This behavior has been removed. Whilst the class data is still stored per-class, it is stored on
86 the metaclass of the class defining the accessor.
88 Therefore anything relying on the side-effect of the accessor being copied down will be broken.
90 =head2 Extending Catalyst::Request or other classes in an ad-hoc manor using mk_accessors
92 Previously, it was possible to add additional accessors to Catalyst::Request (or other classes)
93 by calling the mk_accessors class method.
95 This is no longer supported - users should make a sub-class of the class who's behavior they would
96 like to change, rather than globally polluting the Catalyst objects.
98 =head2 Confused multiple inheritance with Catalyst::Component::COMPONENT
102 There is a COMPONENT method resolving after Catalyst::Component
105 This means that one of the packages on the right hand side of
106 Catalyst::Component in your Class' inheritance hierarchy defines
109 Previously, Catalyst's COMPONENT method would delegate to the
110 method on the right hand side, which could then delegate back again
111 with NEXT. This (as it is insane), is no longer supported, as it
112 makes no sense with C3 method dispatch order.
114 Therefore the correct fix is to re-arrange your class' inheritance
115 hierarchy so that the COMPONENT method you would like to inherit is
116 the first COMPONENT method in your @ISA.
118 =head2 Assigning lists to accessors
120 Accessors generated by Class::Accessor::Fast will, when multiple values
121 are assigned to them, store a reference to a list automatically for you.
123 This is not currently supported by MooseX::Emulate::Class::Accessor::Fast,
124 and only the first value in the list will be stored.
126 If you are relying on this behavior, and inheriting mk_accessors from a
127 Catalyst component, then your code will fail.
131 =head2 Methods in Catalyst::Dispatcher
133 The following methods in Catalyst::Dispatcher are likely to change
134 significantly in the 5.8X release series, and therefore their use is highly
143 =item registered_dispatch_types
145 =item method_action_class
153 The first time one of these methods is called, a warning will be emitted:
155 Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,\n"
156 . "this will be removed in Catalyst 5.9X"
158 You should B<NEVER> be calling any of these methods from application code.
160 Plugins authors and maintainers whos plugins need to call these methods
161 should email the development list to discuss your use-case, and what a
162 better API should look like.
164 =head2 require $class was successful but the package is not defined.
166 In this version of Catalyst, if a component is loaded from disk, but no symbols are defined in that component's namespace
167 after it is loaded, this warning will be issued.
169 This is to protect against confusing bugs caused by mis-typing package names.
171 This will become a fatal error in a future version.
173 =head2 $c->plugin method
175 Calling the plugin method is deprecated, and calling it at runtime is B<highly deprecated>.
177 Instead you are recommended to use L< Catalyst::Model::Adaptor > or similar to compose the functionality
178 you need outside of the main application namespace.