lib/Catalyst/Delta.pod

   1 =head1 NAME
   2
   3 Catalyst::Delta - Overview of changes between versions of Catalyst
   4
   5 =head1 DESCRIPTION
   6
   7 This is an overview of the user-visible changes to Catalyst between major
   8 Catalyst releases.
   9
  10 =head2 VERSION 5.90060+
  11
  12 =head3 Support passing Bpdy filehandles directly to your Plack server.
  13
  14 We changed the way we return body content (from response) to whatever
  15 Plack handler you are using (Starman, FastCGI, etc.)  We no longer
  16 always use the streaming interface for the cases when the body is a
  17 simple scalar, object or filehandle like.  In those cases we now just
  18 pass the simple response on to the plack handler.  This might lead to
  19 some minor differences in how streaming is handled.  For example, you
  20 might notice that streaming starts properly supportubg chunked encoding when
  21 on a server that supports that, or that previously missing headers
  22 (possible content-length) might appear suddenly correct.  Also, if you
  23 are using middleware like L<Plack::Middleware::XSendfile> and are using
  24 a filehandle that sets a readable path, your server might now correctly
  25 handle the file (rather than as before where Catalyst would stream it
  26 very likely very slowly).
  27
  28 In other words, some things might be meaninglessly different and some
  29 things that were broken codewise but worked because of Catalyst being
  30 incorrect might suddenly be really broken.  The behavior is now more
  31 correct in that Catalyst plays better with features that Plack offers
  32 but if you are making heavy use of the streaming interface there could
  33 be some differences so you should test carefully (this is probably not
  34 the vast majority of people).  In particular if you are developing
  35 using one server but deploying using a different one, differences in
  36 what those server do with streaming should be noted.
  37
  38 Please see note below about changes to filehandle support and existing
  39 Plack middleware to aid in back compatibility.
  40
  41 =head3 Distinguish between body null versus undef.
  42
  43 We also now more carefully distingush the different between a body set
  44 to '' and a body that is undef.  This might lead to situations where
  45 again you'll get a content-length were you didn't get one before or
  46 where a supporting server will start chunking output.  If this is an
  47 issue you can apply the middleware L<Plack::Middleware::BufferedStreaming>
  48 or report specific problems to the dev team.
  49
  50 =head3 More Catalyst Middleware
  51
  52 We have started migrating code in Catalyst to equivilent Plack
  53 Middleware when such exists and is correct to do so.  For example we now use
  54 L<Plack::Middleware::ContentLength> to determine content length of a response
  55 when none is provided.  This replaces similar code inlined with L<Catalyst>
  56 The main advantages to doing this is 1) more similar Catalyst core that is
  57 focused on the Catalyst special sauce, 2) Middleware is more broadly shared
  58 so we benefit from better collaboration with developers outside Catalyst, 3)
  59 In the future you'll be able to change or trim the middleware stack to get
  60 additional performance when you don't need all the checks and constraints.
  61
  62 =head3 Deprecation of Filehandle like objects that do read but not getline
  63
  64 We also deprecated setting the response body to an object that does 'read'
  65 but not 'getline'.  If you are using a custom IO-Handle like object for
  66 response you should verify that 'getline' is supported in your interface.
  67 You will get a first use warning for this error in your logs.  Unless we
  68 here this case is a major issue for people, we will be removing support
  69 in a near future release of Catalyst.  When the code encounters this it
  70 will issue a warning.  You also may run into this issue with L<MogileFS::Client>
  71 which does read but not getline.  For now we will just warn when encountering
  72 such an object and fallback to the previous behavior (where L<Catalyst::Engine>
  73 itself unrolls the filehandle and performs blocking streams).  However
  74 this backcompat will be removed in an upcoming release so you should either
  75 rewrite your custom filehandle objects to support getline or start using the
  76 middleware that adapts read for getline L<Plack::Middleware::AdaptFilehandleRead>.
  77
  78 =head3 Response->headers become readonly after finalizing
  79
  80 Once the response headers are finalized, trying to change them is not allowed
  81 (in the past you could change them and this would lead to unexpected results).
  82
  83 =head3 Offically deprecation of L<Catalyst::Engine::PSGI>
  84
  85 L<Catalyst::Engine::PSGI> is also officially no longer supported.  We will
  86 no long run test cases against this and can remove backcompat code for it
  87 as deemed necessary for the evolution of the platform.  You should simple
  88 discontinue use of this engine, as L<Catalyst> has been PSGI at the core
  89 for several years.
  90
  91 =head2 Officially deprecate finding the PSGI $env anyplace other than Request
  92
  93 A few early releases of Cataplack had the PSGI $env in L<Catalyst::Engine>.
  94 Code has been maintained here for backcompat reasons.  This is no longer
  95 supported and will be removed in upcoming release, so you should update
  96 your code and / or upgrade to a newer version of L<Catalyst>
  97
  98 =head2 Deprecate setting Response->body after using write/write_fh
  99
 100 Setting $c->res->body to a filehandle after using $c->res->write or
 101 $c->res->write_fh is no longer considered allowed, since we can't send
 102 the filehandle to the underlying Plack handler.  For now we will continue
 103 to support setting body to a simple value since this is possible, but at
 104 some future release a choice to use streaming indicates that you will do
 105 so for the rest of the request.
 106
 107 =head2 VERSION 5.90053
 108
 109 We are now clarifying the behavior of log, plugins and configuration during
 110 the setup phase.  Since Plugins might require a log during setup, setup_log
 111 must run BEFORE setup_plugins.   This has the unfortunate side effect that
 112 anyone using the popular ConfigLoader plugin will not be able to supply
 113 configuration to custom logs since the configuration is not yet finalized
 114 when setup_log is run (when using ConfigLoader, which is a plugin and is
 115 not loaded until later.)
 116
 117 As a workaround, you can supply custom log configuration directly into
 118 the configuration:
 119
 120     package MyApp;
 121     use Catalyst;
 122
 123     __PACKAGE__->config(
 124       my_custom_log_info => { %custom_args },
 125     );
 126
 127     __PACKAGE__->setup;
 128
 129 If you wish to configure the custom logger differently based on ENV, you can
 130 try:
 131
 132     package MyApp;
 133
 134     use Catalyst;
 135     use Catalyst::Utils;
 136
 137     __PACKAGE__->config(
 138       Catalyst::Utils::merge_hashes(
 139         +{ my_custom_log_info => { %base_custom_args } },
 140         +{ do __PACKAGE__->path_to( $ENV{WHICH_CONF}."_conf.pl") },
 141       ),
 142     );
 143
 144     __PACKAGE__->setup;
 145
 146 Or create a standalone Configuration class that does the right thing.
 147
 148 Basically if you want to configure a logger via Catalyst global configuration
 149 you can't use ConfigLoader because it will always be loaded too late to be of
 150 any use.  Patches and workaround options welcomed!
 151
 152 =head2 VERSION 5.9XXXX 'cataplack'
 153
 154 The Catalyst::Engine sub-classes have all been removed and deprecated,
 155 to be replaced with Plack handlers.
 156
 157 Plack is an implementation of the L<PSGI> specification, which is
 158 a standard interface between web servers and application frameworks.
 159
 160 This should be no different for developers, and you should not have to
 161 migrate your applications unless you are using a custom engine already.
 162
 163 This change benefits Catalyst significantly by reducing the amount of
 164 code inside the framework, and means that the framework gets upstream
 165 bug fixes in L<Plack>, and automatically gains support for any web server
 166 which a L<PSGI> compliant handler is written for.
 167
 168 It also allows you more flexibility with your application, and allows
 169 the use of cross web framework 'middleware'.
 170
 171 Developers are recommended to read L<Catalyst::Upgrading> for notes about
 172 upgrading, especially if you are using an unusual deployment method.
 173
 174 Documentation for how to take advantage of L<PSGI> can be found in
 175 L<Catalyst::PSGI>, and information about deploying your application
 176 has been moved to L<Catalyst::Manual::Deployment>.
 177
 178 =head3 Updated modules:
 179
 180 A number of modules have been updated to pass their tests or not
 181 produce deprecation warnings with the latest version of Catalyst.
 182 It is recommended that you upgrade any of these that you are using
 183 after installing this version of Catalyst.
 184
 185 These extensions are:
 186
 187 =over
 188
 189 =item L<Catalyst::Engine::HTTP::Prefork>
 190
 191 This is now deprecated, see L<Catalyst::Upgrading>.
 192
 193 =item L<Test::WWW::Mechanize::Catalyst>
 194
 195 Has been updated to not produce deprecation warnings, upgrade recommended.
 196
 197 =item Catalyst::ActionRole::ACL
 198
 199 Has been updated to fix failing tests (although older versions still
 200 function perfectly with this version of Catalyst).
 201
 202 =item Catalyst::Plugin::Session::Store::DBIC
 203
 204 Has been updated to fix failing tests (although older versions still
 205 function perfectly with this version of Catalyst).
 206
 207 =item Catalyst::Plugin::Authentication
 208
 209 Has been updated to fix failing tests (although older versions still
 210 function perfectly with this version of Catalyst).
 211
 212 =back
 213
 214 =head1 PREVIOUS VERSIONS
 215
 216 =head2 VERSION 5.8XXXX 'catamoose'
 217
 218 =head3 Deprecations
 219
 220 Please see L<Catalyst::Upgrading> for a full description of how changes in the
 221 framework may affect your application.
 222
 223 Below is a brief list of features which have been deprecated in this release:
 224
 225 =over
 226
 227 =item ::[MVC]:: style naming scheme has been deprecated and will warn
 228
 229 =item NEXT is deprecated for all applications and components, use MRO::Compat
 230
 231 =item Dispatcher methods which are an implementation detail made private, public versions now warn.
 232
 233 =item MyApp->plugin method is deprecated, use L<Catalyst::Model::Adaptor> instead.
 234
 235 =item __PACKAGE__->mk_accessors() is supported for backward compatibility only, use Moose attributes instead in new code.
 236
 237 =item Use of Catalyst::Base now warns
 238
 239 =back
 240
 241 =head3 New features
 242
 243 =head3 Dispatcher
 244
 245 =over
 246
 247 =item Fix forwarding to Catalyst::Action objects.
 248
 249 =item Add the dispatch_type method
 250
 251 =back
 252
 253 =head3 Restarter
 254
 255 The development server restarter has been improved to be compatible with
 256 immutable Moose classes, and also to optionally use
 257 L<B::Hooks::OP::Check::StashChange> to handle more complex application layouts
 258 correctly.
 259
 260 =head3 $c->uri_for_action method.
 261
 262 Give a private path to the Catalyst action you want to create a URI for.
 263
 264 =head3 Logging
 265
 266 Log levels have been made additive.
 267
 268 =head3 L<Catalyst::Test>
 269
 270 =over
 271
 272 =item Change to use L<Sub::Exporter>.
 273
 274 =item Support mocking multiple virtual hosts
 275
 276 =item New methods like action_ok and action_redirect to write more compact tests
 277
 278 =back
 279
 280 =head3 Catalyst::Response
 281
 282 =over
 283
 284 =item *
 285
 286 New print method which prints @data to the output stream, separated by $,.
 287 This lets you pass the response object to functions that want to write to an
 288 L<IO::Handle>.
 289
 290 =item *
 291
 292 Added code method as an alias for C<< $res->status >>
 293
 294 =back
 295
 296 =head3 Consequences of the Moose back end
 297
 298 =over
 299
 300 =item *
 301
 302 Components are fully compatible with Moose, and all Moose features, such as
 303 method modifiers, attributes, roles, BUILD and BUILDARGS methods are fully
 304 supported and may be used in components and applications.
 305
 306 =item *
 307
 308 Many reusable extensions which would previously have been plugins or base
 309 classes are better implemented as Moose roles.
 310
 311 =item *
 312
 313 L<MooseX::MethodAttributes::Role::AttrContainer::Inheritable> is used to contain action
 314 attributes. This means that attributes are represented in the MOP, and
 315 decouples action creation from attributes.
 316
 317 =item *
 318
 319 There is a reasonable API in Catalyst::Controller for working with
 320 and registering actions, allowing a controller sub-class to replace
 321 subroutine attributes for action declarations with an alternate
 322 syntax.
 323
 324 =item *
 325
 326 Refactored capturing of $app from L<Catalyst::Controller> into
 327 L<Catalyst::Component::ApplicationAttribute> for easier reuse in other
 328 components.
 329
 330 =item *
 331
 332 Your application class is forced to become immutable at the end of compilation.
 333
 334 =back
 335
 336 =head3 Bug fixes
 337
 338 =over
 339
 340 =item *
 341
 342 Don't ignore SIGCHLD while handling requests with the development server, so that
 343 system() and other ways of creating child processes work as expected.
 344
 345 =item *
 346
 347 Fixes for FastCGI when used with IIS 6.0
 348
 349 =item *
 350
 351 Fix a bug in uri_for which could cause it to generate paths with multiple
 352 slashes in them.
 353
 354 =item *
 355
 356 Fix a bug in Catalyst::Stats, stopping garbage being inserted into
 357 the stats if a user calls begin => but no end
 358
 359 =back
 360