Commit | Line | Data |
d442cc9f |
1 | =head1 NAME |
2 | |
3533daff |
3 | Catalyst::Manual::Tutorial::Debugging - Catalyst Tutorial - Part 7: Debugging |
4 | |
d442cc9f |
5 | |
6 | =head1 OVERVIEW |
7 | |
3533daff |
8 | This is B<Part 7 of 10> for the Catalyst tutorial. |
d442cc9f |
9 | |
10 | L<Tutorial Overview|Catalyst::Manual::Tutorial> |
11 | |
12 | =over 4 |
13 | |
14 | =item 1 |
15 | |
16 | L<Introduction|Catalyst::Manual::Tutorial::Intro> |
17 | |
18 | =item 2 |
19 | |
20 | L<Catalyst Basics|Catalyst::Manual::Tutorial::CatalystBasics> |
21 | |
22 | =item 3 |
23 | |
3533daff |
24 | L<More Catalyst Basics|Catalyst::Manual::Tutorial::MoreCatalystBasics> |
d442cc9f |
25 | |
26 | =item 4 |
27 | |
3533daff |
28 | L<Basic CRUD|Catalyst::Manual::Tutorial::BasicCRUD> |
d442cc9f |
29 | |
30 | =item 5 |
31 | |
3533daff |
32 | L<Authentication|Catalyst::Manual::Tutorial::Authentication> |
d442cc9f |
33 | |
34 | =item 6 |
35 | |
3533daff |
36 | L<Authorization|Catalyst::Manual::Tutorial::Authorization> |
d442cc9f |
37 | |
38 | =item 7 |
39 | |
3533daff |
40 | B<Debugging> |
d442cc9f |
41 | |
42 | =item 8 |
43 | |
3533daff |
44 | L<Testing|Catalyst::Manual::Tutorial::Testing> |
d442cc9f |
45 | |
46 | =item 9 |
47 | |
3533daff |
48 | L<Advanced CRUD|Catalyst::Manual::Tutorial::AdvancedCRUD> |
49 | |
50 | =item 10 |
51 | |
d442cc9f |
52 | L<Appendices|Catalyst::Manual::Tutorial::Appendices> |
53 | |
54 | =back |
55 | |
56 | |
57 | =head1 DESCRIPTION |
58 | |
59 | This part of the tutorial takes a brief look at the primary options |
60 | available for troubleshooting Catalyst applications. |
61 | |
62 | Note that when it comes to debugging and troubleshooting, there are two |
63 | camps: |
64 | |
65 | =over 4 |
66 | |
67 | =item * |
68 | |
69 | Fans of C<log> and C<print> statements embedded in the code. |
70 | |
71 | =item * |
72 | |
73 | Fans of interactive debuggers. |
74 | |
75 | =back |
76 | |
77 | Catalyst is able to easily accommodate both styles of debugging. |
78 | |
1390ef0e |
79 | |
d442cc9f |
80 | =head1 LOG STATEMENTS |
81 | |
1390ef0e |
82 | Folks in the former group can use Catalyst's C<$c-E<gt>log> facility. |
83 | (See L<Catalyst::Log|Catalyst::Log> for more detail.) For example, if |
84 | you add the following code to a controller action method: |
d442cc9f |
85 | |
86 | $c->log->info("Starting the foreach loop here"); |
87 | |
cae937d8 |
88 | $c->log->debug("Value of \$id is: ".$id); |
d442cc9f |
89 | |
90 | Then the Catalyst development server will display your message along |
1390ef0e |
91 | with the other debug output. To accomplish the same thing in a TT |
92 | template view use: |
d442cc9f |
93 | |
8a7c5151 |
94 | [% c.log.debug("This is a test log message") %] |
d442cc9f |
95 | |
96 | You can also use L<Data::Dumper|Data::Dumper> in both Catalyst code |
8c4a5110 |
97 | (C<use Data::Dumper; $c-E<gt>log-E<gt>debug("\$var is: ".Dumper($var));)>) |
d442cc9f |
98 | and TT templates (C<[% Dumper.dump(book) %]>. |
99 | |
1390ef0e |
100 | |
d442cc9f |
101 | =head1 RUNNING CATALYST UNDER THE PERL DEBUGGER |
102 | |
103 | Members of the interactive-debugger fan club will also be at home with |
104 | Catalyst applications. One approach to this style of Perl debugging is |
105 | to embed breakpoints in your code. For example, open |
106 | C<lib/MyApp/Controller/Books.pm> in your editor and add the |
107 | C<DB::single=1> line as follows inside the C<list> method (I like to |
108 | "left-justify" my debug statements so I don't forget to remove them, but |
109 | you can obviously indent them if you prefer): |
110 | |
111 | sub list : Local { |
3533daff |
112 | # Retrieve the usual Perl OO '$self' for this object. $c is the Catalyst |
d442cc9f |
113 | # 'Context' that's used to 'glue together' the various components |
114 | # that make up the application |
115 | my ($self, $c) = @_; |
116 | |
117 | $DB::single=1; |
118 | |
119 | # Retrieve all of the book records as book model objects and store in the |
120 | # stash where they can be accessed by the TT template |
d0496197 |
121 | $c->stash->{books} = [$c->model('DB::Books')->all]; |
d442cc9f |
122 | |
123 | # Set the TT template to use. You will almost always want to do this |
124 | # in your action methods. |
125 | $c->stash->{template} = 'books/list.tt2'; |
126 | } |
127 | |
128 | This causes the Perl Debugger to enter "single step mode" when this command is |
129 | encountered (it has no effect when Perl is run without the C<-d> flag). |
130 | |
d0496197 |
131 | B<NOTE:> The C<DB> here is the Perl Debugger, not the DB model. |
132 | |
d442cc9f |
133 | To now run the Catalyst development server under the Perl debugger, simply |
134 | prepend C<perl -d> to the front of C<script/myapp_server.pl>: |
135 | |
136 | $ perl -d script/myapp_server.pl |
137 | |
138 | This will start the interactive debugger and produce output similar to: |
139 | |
140 | $ perl -d script/myapp_server.pl |
141 | |
028b4e1a |
142 | Loading DB routines from perl5db.pl version 1.3 |
d442cc9f |
143 | Editor support available. |
144 | |
145 | Enter h or `h h' for help, or `man perldebug' for more help. |
146 | |
028b4e1a |
147 | main::(script/myapp_server.pl:16): my $debug = 0; |
d442cc9f |
148 | |
149 | DB<1> |
150 | |
151 | Press the C<c> key and hit C<Enter> to continue executing the Catalyst |
152 | development server under the debugger. Although execution speed will be |
153 | slightly slower than normal, you should soon see the usual Catalyst |
154 | startup debug information. |
155 | |
156 | Now point your browser to L<http://localhost:3000/books/list> and log |
157 | in. Once the breakpoint is encountered in the |
158 | C<MyApp::Controller::list> method, the console session running the |
159 | development server will drop to the Perl debugger prompt: |
160 | |
028b4e1a |
161 | MyApp::Controller::Books::list(/home/me/MyApp/script/../lib/MyApp/Controller/Books.pm:48): |
162 | 48: $c->stash->{books} = [$c->model('DB::Books')->all]; |
d442cc9f |
163 | |
164 | DB<1> |
165 | |
166 | You now have the full Perl debugger at your disposal. First use the |
167 | C<next> feature by typing C<n> to execute the C<all> method on the Book |
168 | model (C<n> jumps over method/subroutine calls; you can also use C<s> to |
169 | C<single-step> into methods/subroutines): |
170 | |
171 | DB<1> n |
172 | SELECT me.id, me.authors, me.title, me.rating FROM books me: |
028b4e1a |
173 | MyApp::Controller::Books::list(/home/me/MyApp/script/../lib/MyApp/Controller/Books.pm:53): |
174 | 53: $c->stash->{template} = 'books/list.tt2'; |
d442cc9f |
175 | |
176 | DB<1> |
177 | |
178 | This takes you to the next line of code where the template name is set. |
179 | Notice that because we enabled C<DBIC_TRACE=1> earlier, SQL debug |
180 | output also shows up in the development server debug information. |
181 | |
182 | Next, list the methods available on our C<Book> model: |
183 | |
d0496197 |
184 | DB<1> m $c->model('DB::Books') |
d442cc9f |
185 | () |
186 | (0+ |
187 | (bool |
028b4e1a |
188 | __source_handle_accessor |
189 | _add_alias |
190 | _build_unique_query |
191 | _calculate_score |
192 | _collapse_cond |
d442cc9f |
193 | <lines removed for brevity> |
194 | |
195 | DB<2> |
196 | |
197 | We can also play with the model directly: |
198 | |
d0496197 |
199 | DB<2> x ($c->model('DB::Books')->all)[1]->title |
d442cc9f |
200 | SELECT me.id, me.title, me.rating FROM books me: |
201 | 0 'TCP/IP Illustrated, Volume 1' |
202 | |
203 | This uses the Perl debugger C<x> command to display the title of a book. |
204 | |
205 | Next we inspect the C<books> element of the Catalyst C<stash> (the C<4> |
206 | argument to the C<x> command limits the depth of the dump to 4 levels): |
207 | |
208 | DB<3> x 4 $c->stash->{books} |
209 | 0 ARRAY(0xa8f3b7c) |
d0496197 |
210 | 0 MyApp::Model::DB::Book=HASH(0xb8e702c) |
d442cc9f |
211 | '_column_data' => HASH(0xb8e5e2c) |
212 | 'id' => 1 |
213 | 'rating' => 5 |
214 | 'title' => 'CCSP SNRS Exam Certification Guide' |
215 | '_in_storage' => 1 |
216 | <lines removed for brevity> |
217 | |
218 | Then enter the C<c> command to continue processing until the next |
219 | breakpoint is hit (or the application exits): |
220 | |
221 | DB<4> c |
222 | SELECT author.id, author.first_name, author.last_name FROM ... |
223 | |
224 | Finally, press C<Ctrl+C> to break out of the development server. |
225 | Because we are running inside the Perl debugger, you will drop to the |
226 | debugger prompt. Press C<q> to exit the debugger and return to your OS |
227 | shell prompt: |
228 | |
229 | DB<4> q |
230 | $ |
231 | |
232 | For more information on using the Perl debugger, please see C<perldebug> |
233 | and C<perldebtut>. You can also type C<h> or C<h h> at the debugger |
234 | prompt to view the built-in help screens. |
235 | |
236 | |
237 | =head1 DEBUGGING MODULES FROM CPAN |
238 | |
239 | Although the techniques discussed above work well for code you are |
240 | writing, what if you want to use print/log/warn messages or set |
241 | breakpoints in code that you have installed from CPAN (or in module that |
242 | ship with Perl)? One helpful approach is to place a copy of the module |
243 | inside the C<lib> directory of your Catalyst project. When Catalyst |
244 | loads, it will load from inside your C<lib> directory first, only |
245 | turning to the global modules if a local copy cannot be found. You can |
246 | then make modifications such as adding a C<$DB::single=1> to the local |
247 | copy of the module without risking the copy in the original location. |
248 | This can also be a great way to "locally override" bugs in modules while |
249 | you wait for a fix on CPAN. |
250 | |
251 | |
252 | Matt Trout has suggested the following shortcut to create a local |
253 | copy of an installed module: |
254 | |
255 | mkdir -p lib/Module; cp `perldoc -l Module::Name` lib/Module/ |
256 | |
3533daff |
257 | Note: If you are following along in Ubuntu, you will need to install |
258 | the C<perl-doc> package to use the C<perldoc> command. Use |
259 | C<sudo apt-get install perl-doc> to do that. |
260 | |
d442cc9f |
261 | For example, you could make a copy of |
262 | L<Catalyst::Plugin::Authentication|Catalyst::Plugin::Authentication> |
263 | with the following command: |
264 | |
265 | mkdir -p lib/Catalyst/Plugin; cp \ |
266 | `perldoc -l Catalyst::Plugin::Authentication` lib/Catalyst/Plugin |
267 | |
3533daff |
268 | You can then use the local copy inside your project to place logging |
269 | messages and/or breakpoints for further study of that module. |
270 | |
d442cc9f |
271 | B<Note:> Matt has also suggested the following tips for Perl |
272 | debugging: |
273 | |
274 | =over 4 |
275 | |
276 | =item * |
277 | |
278 | Check the version of an installed module: |
279 | |
1390ef0e |
280 | perl -ME<lt>mod_nameE<gt> -e '"print $E<lt>mod_nameE<gt>::VERSION\n"' |
d442cc9f |
281 | |
282 | For example: |
283 | |
284 | $ perl -MCatalyst::Plugin::Authentication -e \ |
285 | 'print $Catalyst::Plugin::Authentication::VERSION;' |
286 | 0.07 |
287 | |
288 | =item * |
289 | |
290 | Check if a modules contains a given method: |
291 | |
292 | perl -MModule::Name -e 'print Module::Name->can("method");' |
293 | |
294 | For example: |
295 | |
296 | $ perl -MCatalyst::Plugin::Authentication -e \ |
3533daff |
297 | 'print Catalyst::Plugin::Authentication->can("user");' |
d442cc9f |
298 | CODE(0x9c8db2c) |
299 | |
300 | If the method exists, the Perl C<can> method returns a coderef. |
301 | Otherwise, it returns undef and nothing will be printed. |
302 | |
303 | =back |
304 | |
305 | |
1390ef0e |
306 | =head1 TT DEBUGGING |
307 | |
308 | If you run into issues during the rendering of your template, it might |
309 | be helpful to enable TT C<DEBUG> options. You can do this in a Catalyst |
310 | environment by adding a C<DEBUG> line to the C<__PACKAGE__->config> |
311 | declaration in C<lib/MyApp/View/TT.pm>: |
312 | |
313 | __PACKAGE__->config({ |
314 | TEMPLATE_EXTENSION => '.tt2', |
315 | DEBUG => 'undef', |
316 | }); |
317 | |
318 | There are a variety of options you can use, such as 'undef', 'all', |
319 | 'service', 'context', 'parser' and 'provider'. See |
320 | L<Template::Constants|Template::Constants> for more information |
321 | (remove the C<DEBUG_> portion of the name shown in the TT docs and |
322 | convert to lower case for use inside Catalyst). |
323 | |
324 | B<NOTE:> B<Please be sure to disable TT debug options before continuing |
325 | with the tutorial> (especially the 'undef' option -- leaving this |
326 | enabled will conflict with several of the conventions used by this |
327 | tutorial to leave some variables undefined on purpose). |
328 | |
329 | |
d442cc9f |
330 | =head1 AUTHOR |
331 | |
332 | Kennedy Clark, C<hkclark@gmail.com> |
333 | |
334 | Please report any errors, issues or suggestions to the author. The |
335 | most recent version of the Catalyst Tutorial can be found at |
82ab4bbf |
336 | L<http://dev.catalyst.perl.org/repos/Catalyst/Catalyst-Manual/5.70/trunk/lib/Catalyst/Manual/Tutorial/>. |
d442cc9f |
337 | |
45c7830f |
338 | Copyright 2006-2008, Kennedy Clark, under Creative Commons License |
1390ef0e |
339 | (L<http://creativecommons.org/licenses/by-sa/3.0/us/>). |