Commit | Line | Data |
7e2ec16e |
1 | =head1 Upgrading to Catalyst 5.80 |
2 | |
5687c7f9 |
3 | Most applications and plugins should run unaltered on Catalyst 5.80. |
7e2ec16e |
4 | |
5687c7f9 |
5 | However as a lot of refactoring work has taken place, several changes |
10011c19 |
6 | have been made which could cause incompatibilities, if your application |
5687c7f9 |
7 | or plugin is using deprecated code, or relying on side-effects then |
8 | there could be incompatibility. |
9 | |
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 |
13 | problems. |
7e2ec16e |
14 | |
5687c7f9 |
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. |
7e2ec16e |
17 | |
5687c7f9 |
18 | =head1 Known backwards compatibility breakages. |
7e2ec16e |
19 | |
20 | =head2 Moose applications |
21 | |
845bfcd2 |
22 | Moose components for Catalyst 5.70 needed to do |
7e2ec16e |
23 | |
845bfcd2 |
24 | extends qw/Moose::Object Catalyst::Component/; |
7e2ec16e |
25 | |
845bfcd2 |
26 | to be able to use the constructor provided by Moose. In 5.80 |
8566c0de |
27 | C<Catalyst::Component> already inherits from C<Moose::Object>. Therefore you |
845bfcd2 |
28 | shouldn't directly inherit from C<Moose::Object> yourself, otherwise your |
10011c19 |
29 | Class' @ISA will not linearize with C3. |
7e2ec16e |
30 | |
8566c0de |
31 | You will also see this issue if you do the following: |
32 | |
33 | use Moose; |
34 | use base 'Catalyst::Controller'; |
35 | |
36 | as C< use base > appends to @ISA. |
37 | |
38 | FIXME - Add note about the appropriate magic to detect $Catalyst::VERSION |
39 | and work around it at compile time. |
40 | |
04a48104 |
41 | =head2 Anonymous closures installed directly into the symbol table |
42 | |
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: |
46 | |
47 | #Originalcode, likely to break: |
48 | my $full_method_name = join('::',$package_name, $method_name); |
49 | *$full_method_name = sub { ... }; |
50 | |
51 | #Fixed Code |
52 | use Sub::Name 'subname'; |
53 | my $full_method_name = join('::',$package_name, $method_name); |
54 | *$full_method_name = subname $full_method_name, sub { ... }; |
55 | |
56 | Additionally, you can take advantage of Catalyst's use of L<Class::MOP> and |
57 | install the closure using the appropriate metaclass. Example: |
58 | |
59 | use Class::MOP; |
60 | my $metaclass = Moose::Meta::Class->initialize($package_name); |
61 | $metaclass->add_method($method_name => sub { ... }); |
62 | |
5687c7f9 |
63 | =head2 Components whos new method returns false |
7e2ec16e |
64 | |
5687c7f9 |
65 | Previously if your new method returned a false value, |
7e2ec16e |
66 | |
5687c7f9 |
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 |
7e2ec16e |
70 | |
5687c7f9 |
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. |
7e2ec16e |
74 | |
75 | =head2 __PACKAGE__->mk_accessor('meta'); |
76 | |
5687c7f9 |
77 | Won't work due to a limitation of L<Moose> |
7e2ec16e |
78 | |
5687c7f9 |
79 | This is currently being fixed inside core Moose. |
7e2ec16e |
80 | |
81 | =head2 Class::Data::Inheritable side effects |
82 | |
5687c7f9 |
83 | Previously, writing to a class data accessor would copy the accessor method down into your package. |
7e2ec16e |
84 | |
5687c7f9 |
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. |
7e2ec16e |
87 | |
5687c7f9 |
88 | Therefore anything relying on the side-effect of the accessor being copied down will be broken. |
7e2ec16e |
89 | |
5687c7f9 |
90 | =head2 Extending Catalyst::Request or other classes in an ad-hoc manor using mk_accessors |
7e2ec16e |
91 | |
5687c7f9 |
92 | Previously, it was possible to add additional accessors to Catalyst::Request (or other classes) |
93 | by calling the mk_accessors class method. |
7e2ec16e |
94 | |
5687c7f9 |
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. |
8be895a7 |
97 | |
10011c19 |
98 | =head2 Confused multiple inheritance with Catalyst::Component::COMPONENT |
8be895a7 |
99 | |
5687c7f9 |
100 | Warning message: |
7e2ec16e |
101 | |
5687c7f9 |
102 | There is a COMPONENT method resolving after Catalyst::Component |
103 | in ${next_package}. |
104 | |
105 | This means that one of the packages on the right hand side of |
106 | Catalyst::Component in your Class' inheritance hierarchy defines |
107 | a COMPONENT method. |
7e2ec16e |
108 | |
5687c7f9 |
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. |
113 | |
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. |
7e2ec16e |
117 | |
6c04a1ea |
118 | =head2 Assigning lists to accessors |
119 | |
cb092ef3 |
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. |
122 | |
123 | This is not currently supported by MooseX::Emulate::Class::Accessor::Fast, |
124 | and only the first value in the list will be stored. |
125 | |
126 | If you are relying on this behavior, and inheriting mk_accessors from a |
127 | Catalyst component, then your code will fail. |
6c04a1ea |
128 | |
c571d2c8 |
129 | =head1 WARNINGS |
130 | |
131 | =head2 Methods in Catalyst::Dispatcher |
132 | |
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 |
135 | deprecated. |
136 | |
137 | =over |
138 | |
139 | =item tree |
140 | |
141 | =item dispatch_types |
142 | |
143 | =item registered_dispatch_types |
144 | |
145 | =item method_action_class |
146 | |
147 | =item action_hash |
148 | |
149 | =item container_hash |
150 | |
151 | =back |
152 | |
153 | The first time one of these methods is called, a warning will be emitted: |
7e2ec16e |
154 | |
155 | Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,\n" |
156 | . "this will be removed in Catalyst 5.9X" |
157 | |
c571d2c8 |
158 | You should B<NEVER> be calling any of these methods from application code. |
159 | |
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. |
7e2ec16e |
163 | |
5687c7f9 |
164 | =head2 require $class was successful but the package is not defined. |
7e2ec16e |
165 | |
5687c7f9 |
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. |
7e2ec16e |
168 | |
10011c19 |
169 | This is to protect against confusing bugs caused by mis-typing package names. |
7e2ec16e |
170 | |
5687c7f9 |
171 | This will become a fatal error in a future version. |
7e2ec16e |
172 | |
5687c7f9 |
173 | =head2 $c->plugin method |
174 | |
175 | Calling the plugin method is deprecated, and calling it at runtime is B<highly deprecated>. |
7e2ec16e |
176 | |
5687c7f9 |
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. |
7e2ec16e |
179 | |
180 | =cut |