logo
Free, unlimited AI code reviews that run on commit
git-lrc git-lrc GitHub Install Now We'd appreciate a star git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt git-lrc - Free, unlimited AI code reviews that run on commit | Product Hunt

CatalystX::LeakChecker - Debug memory leaks in Catalyst applications

Authors

       Florian Ragwitz <rafl@debian.org> Tomas Doran <bobtfish@bobtfish.net>

Description

       It's easy to create memory leaks in Catalyst applications and often they're hard to find. This module
       tries to help you finding them by automatically checking for common causes of leaks.

       This module is intended for debugging only. I suggest to not enable it in a production environment.

Methods

found_leaks(@leaks)
       If any leaks were found, this method is called at the end of each request. A list of leaks is passed to
       it. It logs a debug message like this:

           [debug] Circular reference detected:
           +------------------------------------------------------+-----------------+
           | $ctx->{stash}->{ctx}                                                   |
           '------------------------------------------------------+-----------------'

       It's also able to find leaks in code references. A debug message for that might look like this:

           [debug] Circular reference detected:
           +------------------------------------------------------+-----------------+
           | $a = $ctx->{stash}->{leak_closure};                                    |
           | code reference $a deparses to: sub {                                   |
           |     package TestApp::Controller::Affe;                                 |
           |     use warnings;                                                      |
           |     use strict 'refs';                                                 |
           |     $ctx->response->body('from leaky closure');                        |
           | };                                                                     |
           | ${ $ctx }                                                              |
           '------------------------------------------------------+-----------------'

       Override this method if you want leaks to be reported differently.

Name

       CatalystX::LeakChecker - Debug memory leaks in Catalyst applications

Synopsis

           package MyApp;
           use namespace::autoclean;

           extends 'Catalyst';
           with 'CatalystX::LeakChecker';

           __PACKAGE__->setup;

Version

       version 0.06

See Also