lib/Catalyst/Controller/MessageDriven.pm

   1 package Catalyst::Controller::MessageDriven;
   2 use Moose;
   3 use YAML::XS qw/ LoadFile Dump /;
   4
   5 BEGIN { extends 'Catalyst::Controller' }
   6
   7 =head1 NAME
   8
   9 Catalyst::Controller::MessageDriven
  10
  11 =head1 SYNOPSIS
  12
  13   package MyApp::Controller::Queue;
  14   use Moose;
  15   BEGIN { extends 'Catalyst::Controller::MessageDriven' }
  16
  17   sub some_action : Local {
  18       my ($self, $c, $message) = @_;
  19
  20       # Handle message
  21
  22       # Reply with a minimal response message
  23       my $response = { type => 'testaction_response' };
  24       $c->stash->{response} = $response;
  25   }
  26
  27 =head1 DESCRIPTION
  28
  29 A Catalyst controller base class for use with Catalyst::Engine::Stomp,
  30 which handles YAML-serialized messages. A top-level "type" key in the
  31 YAML determines the action dispatched to.
  32
  33 =cut
  34
  35 sub begin : Private {
  36         my ($self, $c) = @_;
  37
  38         # Deserialize the request message
  39
  40         my $message;
  41         eval {
  42                 my $body = $c->request->body;
  43                 $message = LoadFile( "$body" );
  44         };
  45         if ($@) {
  46                 # can't reply - reply_to is embedded in the message
  47                 $c->error("exception in deserialize: $@");
  48         }
  49         else {
  50                 $c->stash->{request} = $message;
  51         }
  52 }
  53
  54 sub end : Private {
  55         my ($self, $c) = @_;
  56
  57         # Engine will send our reply based on the value of this header.
  58         $c->response->headers->header( 'X-Reply-Address' => $c->stash->{request}->{reply_to} );
  59
  60         # Custom error handler - steal errors from catalyst and dump them into
  61         # the stash, to get them serialized out as the reply.
  62         if (scalar @{$c->error}) {
  63                 my $error = join "\n", @{$c->error};
  64                 $c->stash->{response} = { status => 'ERROR', error => $error };
  65                 $c->error(0); # clear errors, so our response isn't clobbered
  66         }
  67
  68         # Serialize the response
  69         my $output;
  70         eval {
  71                 $output = Dump( $c->stash->{response} );
  72         };
  73         if ($@) {
  74                 my $error = "exception in serialize: $@";
  75                 $c->error($error);
  76                 $c->stash->{response} = { status => 'ERROR', error => $error };
  77                 $output = Dump( $c->stash->{response} );
  78         }
  79
  80         $c->response->output( $output );
  81 }
  82
  83 sub default : Private {
  84         my ($self, $c) = @_;
  85
  86         # Forward the request to the appropriate action, based on the
  87         # message type.
  88         my $action = $c->stash->{request}->{type};
  89         $c->forward($action, [$c->stash->{request}]);
  90 }
  91
  92 __PACKAGE__->meta->make_immutable;
  93
  94 1;