lib/Catalyst/Upgrading.pod

   1 =head1 Upgrading to Catalyst 5.80
   2
   3 Most applications and plugins should run unaltered on Catalyst 5.80.
   4
   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.
   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.
  14
  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.
  17
  18 =head1 Known backwards compatibility breakages.
  19
  20 =head2 Components which inherit from Moose::Object before Catalyst::Component
  21
  22 Moose components which say:
  23
  24     package TestApp::Controller::Example;
  25     use Moose;
  26     extends qw/Moose::Object Catalyst::Component/;
  27
  28 to use the constructor provided by Moose, whilst working if you do some hacks
  29 with the C< BUILDARGS > method, will not work with Catalyst 5.80 as
  30 C<Catalyst::Component> inherits from C<Moose::Object>, and so C< @ISA > fails
  31 to linearise.
  32
  33 The fix for this, is to not inherit directly from C<Moose::Object>
  34 yourself. Having components which do not inherit their constructor from
  35 C<Catalyst::Component> is B<unsupported>, and has never been recommended,
  36 therefore you're on your own if you're using this technique. You'll need
  37 to detect the version of Catalyst your application is running with and deal
  38 with it appropriately.
  39
  40 You will also see this issue if you do the following:
  41
  42     package TestApp::Controller::Example;
  43     use Moose;
  44     use base 'Catalyst::Controller';
  45
  46 as C< use base > appends to @ISA.
  47
  48 The correct way to use Moose in a component in a both forward and backwards
  49 compatible way is:
  50
  51     package TestApp::Controller::Root;
  52     use Moose;
  53     BEGIN { extends 'Catalyst::Component' }; # Or ::Controller, or whatever
  54
  55 Note that the C< extends > decleration needs to occur in a begin block for
  56 L<attributes> to operate correctly.
  57
  58 =head2 Anonymous closures installed directly into the symbol table
  59
  60 If you have any code which installs anonymous subroutine references directly
  61 into the symbol table, you may encounter breakages. The simplest solution is
  62 to use L<Sub::Name> to name the subroutine. Example:
  63
  64     #Originalcode, likely to break:
  65     my $full_method_name = join('::',$package_name, $method_name);
  66     *$full_method_name = sub { ... };
  67
  68     #Fixed Code
  69     use Sub::Name 'subname';
  70     my $full_method_name = join('::',$package_name, $method_name);
  71     *$full_method_name = subname $full_method_name, sub { ... };
  72
  73 Additionally, you can take advantage of Catalyst's use of L<Class::MOP> and
  74 install the closure using the appropriate metaclass. Example:
  75
  76     use Class::MOP;
  77     my $metaclass = Moose::Meta::Class->initialize($package_name);
  78     $metaclass->add_method($method_name => sub { ... });
  79
  80 =head2 Hooking into application setup
  81
  82 To execute code during application startup the following snippet in MyApp.pm
  83 used to work:
  84
  85     sub setup {
  86         my ($class, @args) = @_;
  87         $class->NEXT::setup(@args);
  88         ... # things to do after the actual setup
  89     }
  90
  91 With Catalyst 5.80 this won't work anymore. Because instead of using NEXT.pm it
  92 relies on Class::C3::Adopt::NEXT, which doesn't remember what methods it
  93 already called, like NEXT does and therefore goes into a deep recursion between
  94 MyApp::setup and Catalyst::setup.
  95
  96 Moose method modifiers line C<< before|after|around 'setup => sub { ... }; >>
  97 won't work either because of backward compatibility issues related to plugin
  98 setup methods.
  99
 100 The right way to do it is this:
 101
 102     after setup_finalize => sub {
 103         ... # things to do after the actual setup
 104     };
 105
 106 =head2 Components whos new method returns false
 107
 108 Previously if your new method returned a false value,
 109
 110 Previously, if you had a component which inherited from Catalyst::COMPONENT, but
 111 overrode the new method, to return false, then your class' configuration would be blessed into a hash on your behalf,
 112 and this would be returned from the COMPONENT method. T
 113
 114 This behaviour makes no sense, and so has been removed.. You are recommended to implement your own new method
 115 in components, instead, you should inherit the new method from Catalyst::Component, and use Moose's BUILD functionality
 116 to perform any construction work necessary for your sub-class.
 117
 118 =head2 __PACKAGE__->mk_accessor('meta');
 119
 120 Won't work due to a limitation of L<Moose>
 121
 122 This is currently being fixed inside core Moose.
 123
 124 =head2 Class::Data::Inheritable side effects
 125
 126 Previously, writing to a class data accessor would copy the accessor method down into your package.
 127
 128 This behavior has been removed. Whilst the class data is still stored per-class, it is stored on
 129 the metaclass of the class defining the accessor.
 130
 131 Therefore anything relying on the side-effect of the accessor being copied down will be broken.
 132
 133 =head2 Extending Catalyst::Request or other classes in an ad-hoc manor using mk_accessors
 134
 135 Previously, it was possible to add additional accessors to Catalyst::Request (or other classes)
 136 by calling the mk_accessors class method.
 137
 138 This is no longer supported - users should make a sub-class of the class who's behavior they would
 139 like to change, rather than globally polluting the Catalyst objects.
 140
 141 =head2 Confused multiple inheritance with Catalyst::Component::COMPONENT
 142
 143 Warning message:
 144
 145     There is a COMPONENT method resolving after Catalyst::Component
 146     in ${next_package}.
 147
 148 This means that one of the packages on the right hand side of
 149 Catalyst::Component in your Class' inheritance hierarchy defines
 150 a COMPONENT method.
 151
 152 Previously, Catalyst's COMPONENT method would delegate to the
 153 method on the right hand side, which could then delegate back again
 154 with NEXT. This (as it is insane), is no longer supported, as it
 155 makes no sense with C3 method dispatch order.
 156
 157 Therefore the correct fix is to re-arrange your class' inheritance
 158 hierarchy so that the COMPONENT method you would like to inherit is
 159 the first COMPONENT method in your @ISA.
 160
 161 =head1 WARNINGS
 162
 163 =head2 Methods in Catalyst::Dispatcher
 164
 165 The following methods in Catalyst::Dispatcher are likely to change
 166 significantly in the 5.8X release series, and therefore their use is highly
 167 deprecated.
 168
 169 =over
 170
 171 =item tree
 172
 173 =item dispatch_types
 174
 175 =item registered_dispatch_types
 176
 177 =item method_action_class
 178
 179 =item action_hash
 180
 181 =item container_hash
 182
 183 =back
 184
 185 The first time one of these methods is called, a warning will be emitted:
 186
 187     Class $class is calling the deprecated method Catalyst::Dispatcher::$public_method_name,\n"
 188     . "this will be removed in Catalyst 5.9X"
 189
 190 You should B<NEVER> be calling any of these methods from application code.
 191
 192 Plugins authors and maintainers whos plugins need to call these methods
 193 should email the development list to discuss your use-case, and what a
 194 better API should look like.
 195
 196 =head2 require $class was successful but the package is not defined.
 197
 198 In this version of Catalyst, if a component is loaded from disk, but no symbols are defined in that component's namespace
 199 after it is loaded, this warning will be issued.
 200
 201 This is to protect against confusing bugs caused by mis-typing package names.
 202
 203 This will become a fatal error in a future version.
 204
 205 =head2 $c->plugin method
 206
 207 Calling the plugin method is deprecated, and calling it at runtime is B<highly deprecated>.
 208
 209 Instead you are recommended to use L< Catalyst::Model::Adaptor > or similar to compose the functionality
 210 you need outside of the main application namespace.
 211
 212 =cut