Commit | Line | Data |
8c57b129 |
1 | =head1 NAME |
6c18e892 |
2 | |
8c57b129 |
3 | Catalyst::Delta - Overview of changes between versions of Catalyst |
4 | |
5 | =head1 DESCRIPTION |
6 | |
46fff667 |
7 | This is an overview of the user-visible changes to Catalyst between major |
8 | Catalyst releases. |
9 | |
10 | =head2 VERSION 5.90060+ |
11 | |
0fb94688 |
12 | =head3 Support passing Bpdy filehandles directly to your Plack server. |
13 | |
46fff667 |
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 |
0fb94688 |
20 | might notice that streaming starts properly supportubg chunked encoding when |
46fff667 |
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 | |
0fb94688 |
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 | |
46fff667 |
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. |
b31499bc |
49 | |
0fb94688 |
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 |
8e098614 |
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 |
0fb94688 |
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 Offically deprecation of L<Catalyst::Engine::PSGI> |
8e098614 |
79 | |
80 | L<Catalyst::Engine::PSGI> is also officially no longer supported. We will |
81 | no long run test cases against this and can remove backcompat code for it |
82 | as deemed necessary for the evolution of the platform. You should simple |
83 | discontinue use of this engine, as L<Catalyst> has been PSGI at the core |
84 | for several years. |
aa20e9f5 |
85 | |
0fb94688 |
86 | =head2 Officially deprecate finding the PSGI $env anyplace other than Request |
87 | |
88 | A few early releases of Cataplack had the PSGI $env in L<Catalyst::Engine>. |
89 | Code has been maintained here for backcompat reasons. This is no longer |
90 | supported and will be removed in upcoming release, so you should update |
91 | your code and / or upgrade to a newer version of L<Catalyst> |
92 | |
5bb2a5b3 |
93 | =head2 VERSION 5.90053 |
94 | |
95 | We are now clarifying the behavior of log, plugins and configuration during |
96 | the setup phase. Since Plugins might require a log during setup, setup_log |
97 | must run BEFORE setup_plugins. This has the unfortunate side effect that |
98 | anyone using the popular ConfigLoader plugin will not be able to supply |
99 | configuration to custom logs since the configuration is not yet finalized |
100 | when setup_log is run (when using ConfigLoader, which is a plugin and is |
101 | not loaded until later.) |
102 | |
103 | As a workaround, you can supply custom log configuration directly into |
104 | the configuration: |
105 | |
106 | package MyApp; |
107 | use Catalyst; |
108 | |
109 | __PACKAGE__->config( |
110 | my_custom_log_info => { %custom_args }, |
111 | ); |
112 | |
113 | __PACKAGE__->setup; |
114 | |
115 | If you wish to configure the custom logger differently based on ENV, you can |
116 | try: |
117 | |
118 | package MyApp; |
119 | |
120 | use Catalyst; |
121 | use Catalyst::Utils; |
122 | |
123 | __PACKAGE__->config( |
124 | Catalyst::Utils::merge_hashes( |
125 | +{ my_custom_log_info => { %base_custom_args } }, |
126 | +{ do __PACKAGE__->path_to( $ENV{WHICH_CONF}."_conf.pl") }, |
127 | ), |
128 | ); |
129 | |
130 | __PACKAGE__->setup; |
131 | |
132 | Or create a standalone Configuration class that does the right thing. |
133 | |
134 | Basically if you want to configure a logger via Catalyst global configuration |
135 | you can't use ConfigLoader because it will always be loaded too late to be of |
136 | any use. Patches and workaround options welcomed! |
137 | |
9b3b1b9c |
138 | =head2 VERSION 5.9XXXX 'cataplack' |
c20710a1 |
139 | |
140 | The Catalyst::Engine sub-classes have all been removed and deprecated, |
141 | to be replaced with Plack handlers. |
142 | |
143 | Plack is an implementation of the L<PSGI> specification, which is |
144 | a standard interface between web servers and application frameworks. |
145 | |
146 | This should be no different for developers, and you should not have to |
147 | migrate your applications unless you are using a custom engine already. |
148 | |
149 | This change benefits Catalyst significantly by reducing the amount of |
150 | code inside the framework, and means that the framework gets upstream |
151 | bug fixes in L<Plack>, and automatically gains support for any web server |
152 | which a L<PSGI> compliant handler is written for. |
153 | |
154 | It also allows you more flexibility with your application, and allows |
155 | the use of cross web framework 'middleware'. |
156 | |
157 | Developers are recommended to read L<Catalyst::Upgrading> for notes about |
158 | upgrading, especially if you are using an unusual deployment method. |
159 | |
160 | Documentation for how to take advantage of L<PSGI> can be found in |
161 | L<Catalyst::PSGI>, and information about deploying your application |
162 | has been moved to L<Catalyst::Manual::Deployment>. |
163 | |
164 | =head3 Updated modules: |
165 | |
166 | A number of modules have been updated to pass their tests or not |
167 | produce deprecation warnings with the latest version of Catalyst. |
168 | It is recommended that you upgrade any of these that you are using |
169 | after installing this version of Catalyst. |
170 | |
171 | These extensions are: |
172 | |
173 | =over |
174 | |
175 | =item L<Catalyst::Engine::HTTP::Prefork> |
176 | |
177 | This is now deprecated, see L<Catalyst::Upgrading>. |
178 | |
179 | =item L<Test::WWW::Mechanize::Catalyst> |
180 | |
181 | Has been updated to not produce deprecation warnings, upgrade recommended. |
182 | |
183 | =item Catalyst::ActionRole::ACL |
184 | |
185 | Has been updated to fix failing tests (although older versions still |
186 | function perfectly with this version of Catalyst). |
187 | |
188 | =item Catalyst::Plugin::Session::Store::DBIC |
189 | |
190 | Has been updated to fix failing tests (although older versions still |
191 | function perfectly with this version of Catalyst). |
192 | |
14eb7697 |
193 | =item Catalyst::Plugin::Authentication |
194 | |
195 | Has been updated to fix failing tests (although older versions still |
196 | function perfectly with this version of Catalyst). |
197 | |
c20710a1 |
198 | =back |
1fae8c61 |
199 | |
200 | =head1 PREVIOUS VERSIONS |
201 | |
9b3b1b9c |
202 | =head2 VERSION 5.8XXXX 'catamoose' |
1fae8c61 |
203 | |
204 | =head3 Deprecations |
b31499bc |
205 | |
e88235ff |
206 | Please see L<Catalyst::Upgrading> for a full description of how changes in the |
207 | framework may affect your application. |
208 | |
209 | Below is a brief list of features which have been deprecated in this release: |
210 | |
796a8358 |
211 | =over |
b31499bc |
212 | |
796a8358 |
213 | =item ::[MVC]:: style naming scheme has been deprecated and will warn |
b31499bc |
214 | |
e88235ff |
215 | =item NEXT is deprecated for all applications and components, use MRO::Compat |
b31499bc |
216 | |
e88235ff |
217 | =item Dispatcher methods which are an implementation detail made private, public versions now warn. |
b31499bc |
218 | |
e88235ff |
219 | =item MyApp->plugin method is deprecated, use L<Catalyst::Model::Adaptor> instead. |
796a8358 |
220 | |
0a3b8de0 |
221 | =item __PACKAGE__->mk_accessors() is supported for backward compatibility only, use Moose attributes instead in new code. |
222 | |
7df44a71 |
223 | =item Use of Catalyst::Base now warns |
224 | |
796a8358 |
225 | =back |
226 | |
1fae8c61 |
227 | =head3 New features |
0a3b8de0 |
228 | |
229 | =head3 Dispatcher |
b31499bc |
230 | |
7df44a71 |
231 | =over |
232 | |
233 | =item Fix forwarding to Catalyst::Action objects. |
234 | |
235 | =item Add the dispatch_type method |
236 | |
237 | =back |
b31499bc |
238 | |
0a3b8de0 |
239 | =head3 Restarter |
b31499bc |
240 | |
6171ddd5 |
241 | The development server restarter has been improved to be compatible with |
242 | immutable Moose classes, and also to optionally use |
243 | L<B::Hooks::OP::Check::StashChange> to handle more complex application layouts |
244 | correctly. |
b31499bc |
245 | |
7df44a71 |
246 | =head3 $c->uri_for_action method. |
b31499bc |
247 | |
7df44a71 |
248 | Give a private path to the Catalyst action you want to create a URI for. |
6c18e892 |
249 | |
0a3b8de0 |
250 | =head3 Logging |
b31499bc |
251 | |
7df44a71 |
252 | Log levels have been made additive. |
b31499bc |
253 | |
0a3b8de0 |
254 | =head3 L<Catalyst::Test> |
255 | |
256 | =over |
257 | |
258 | =item Change to use L<Sub::Exporter>. |
259 | |
0a3b8de0 |
260 | =item Support mocking multiple virtual hosts |
261 | |
262 | =item New methods like action_ok and action_redirect to write more compact tests |
263 | |
264 | =back |
265 | |
7df44a71 |
266 | =head3 Catalyst::Response |
0a3b8de0 |
267 | |
7df44a71 |
268 | =over |
269 | |
270 | =item * |
271 | |
272 | New print method which prints @data to the output stream, separated by $,. |
273 | This lets you pass the response object to functions that want to write to an |
274 | L<IO::Handle>. |
275 | |
276 | =item * |
277 | |
278 | Added code method as an alias for C<< $res->status >> |
0a3b8de0 |
279 | |
d5a6de01 |
280 | =back |
281 | |
1fae8c61 |
282 | =head3 Consequences of the Moose back end |
b31499bc |
283 | |
796a8358 |
284 | =over |
285 | |
286 | =item * |
287 | |
7df44a71 |
288 | Components are fully compatible with Moose, and all Moose features, such as |
289 | method modifiers, attributes, roles, BUILD and BUILDARGS methods are fully |
290 | supported and may be used in components and applications. |
291 | |
292 | =item * |
293 | |
294 | Many reusable extensions which would previously have been plugins or base |
295 | classes are better implemented as Moose roles. |
296 | |
297 | =item * |
298 | |
a0c37f08 |
299 | L<MooseX::MethodAttributes::Role::AttrContainer::Inheritable> is used to contain action |
7df44a71 |
300 | attributes. This means that attributes are represented in the MOP, and |
301 | decouples action creation from attributes. |
796a8358 |
302 | |
303 | =item * |
304 | |
0a3b8de0 |
305 | There is a reasonable API in Catalyst::Controller for working with |
796a8358 |
306 | and registering actions, allowing a controller sub-class to replace |
25f61108 |
307 | subroutine attributes for action declarations with an alternate |
0a3b8de0 |
308 | syntax. |
796a8358 |
309 | |
310 | =item * |
311 | |
0a3b8de0 |
312 | Refactored capturing of $app from L<Catalyst::Controller> into |
313 | L<Catalyst::Component::ApplicationAttribute> for easier reuse in other |
7df44a71 |
314 | components. |
315 | |
316 | =item * |
317 | |
318 | Your application class is forced to become immutable at the end of compilation. |
319 | |
320 | =back |
321 | |
1fae8c61 |
322 | =head3 Bug fixes |
7df44a71 |
323 | |
324 | =over |
325 | |
326 | =item * |
327 | |
25f61108 |
328 | Don't ignore SIGCHLD while handling requests with the development server, so that |
7df44a71 |
329 | system() and other ways of creating child processes work as expected. |
330 | |
331 | =item * |
332 | |
333 | Fixes for FastCGI when used with IIS 6.0 |
334 | |
335 | =item * |
336 | |
337 | Fix a bug in uri_for which could cause it to generate paths with multiple |
338 | slashes in them. |
796a8358 |
339 | |
340 | =item * |
341 | |
7df44a71 |
342 | Fix a bug in Catalyst::Stats, stopping garbage being inserted into |
343 | the stats if a user calls begin => but no end |
796a8358 |
344 | |
345 | =back |
346 | |