diff options
| -rw-r--r-- | perllib/Open311/GetServiceRequestUpdates.pm | 280 | ||||
| -rw-r--r-- | t/open311/getservicerequestupdates.t | 98 |
2 files changed, 223 insertions, 155 deletions
diff --git a/perllib/Open311/GetServiceRequestUpdates.pm b/perllib/Open311/GetServiceRequestUpdates.pm index 3d593a4eb..7480ba258 100644 --- a/perllib/Open311/GetServiceRequestUpdates.pm +++ b/perllib/Open311/GetServiceRequestUpdates.pm @@ -15,6 +15,9 @@ has verbose => ( is => 'ro', default => 0 ); has schema => ( is =>'ro', lazy => 1, default => sub { FixMyStreet::DB->schema->connect } ); has blank_updates_permitted => ( is => 'rw', default => 0 ); +has current_body => ( is => 'rw' ); +has current_open311 => ( is => 'rw' ); + Readonly::Scalar my $AREA_ID_BROMLEY => 2482; Readonly::Scalar my $AREA_ID_OXFORDSHIRE => 2237; @@ -35,6 +38,7 @@ sub fetch { } while ( my $body = $bodies->next ) { + $self->current_body( $body ); my %open311_conf = ( endpoint => $body->endpoint, @@ -47,17 +51,20 @@ sub fetch { $cobrand->call_hook(open311_config_updates => \%open311_conf) if $cobrand; - my $o = $open311 || Open311->new(%open311_conf); + $self->current_open311( $open311 || Open311->new(%open311_conf) ); $self->suppress_alerts( $body->suppress_alerts ); $self->blank_updates_permitted( $body->blank_updates_permitted ); $self->system_user( $body->comment_user ); - $self->update_comments( $o, $body ); + $self->process_body(); } } -sub update_comments { - my ( $self, $open311, $body ) = @_; +sub process_body { + my $self = shift; + + my $open311 = $self->current_open311; + my $body = $self->current_body; my @args = (); @@ -86,143 +93,158 @@ sub update_comments { return 0; } - my $cobrand = $body->get_cobrand_handler; - for my $request (@$requests) { - my $request_id = $request->{service_request_id}; + next unless defined $request->{update_id}; - # If there's no request id then we can't work out - # what problem it belongs to so just skip - next unless $request_id || $request->{fixmystreet_id}; + my $p = $self->find_problem($request, @args) or next; + my $c = $p->comments->search( { external_id => $request->{update_id} } ); + next if $c->first; - my $comment_time = eval { - DateTime::Format::W3CDTF->parse_datetime( $request->{updated_datetime} || "" ) - ->set_time_zone(FixMyStreet->local_time_zone); - }; - next if $@; - my $updated = DateTime::Format::W3CDTF->format_datetime($comment_time->clone->set_time_zone('UTC')); - next if @args && ($updated lt $args[0] || $updated gt $args[1]); + $self->process_update($request, $p); + } - my $problem; - my $criteria = { - external_id => $request_id, + return 1; +} + +sub find_problem { + my ($self, $request, @args) = @_; + + my $body = $self->current_body; + my $request_id = $request->{service_request_id}; + + # If there's no request id then we can't work out + # what problem it belongs to so just skip + return unless $request_id || $request->{fixmystreet_id}; + + my $comment_time = eval { + DateTime::Format::W3CDTF->parse_datetime( $request->{updated_datetime} || "" ) + ->set_time_zone(FixMyStreet->local_time_zone); + }; + return if $@; + my $updated = DateTime::Format::W3CDTF->format_datetime($comment_time->clone->set_time_zone('UTC')); + return if @args && ($updated lt $args[0] || $updated gt $args[1]); + $request->{comment_time} = $comment_time; + + my $problem; + my $criteria = { + external_id => $request_id, + }; + + # in some cases we only have the FMS id and not the request id so use that + if ( $request->{fixmystreet_id} ) { + unless ( $request->{fixmystreet_id} =~ /^\d+$/ ) { + warn "skipping bad fixmystreet id in updates for " . $body->name . ": [" . $request->{fixmystreet_id} . "], external id is $request_id\n"; + return; + } + + $criteria = { + id => $request->{fixmystreet_id}, }; + } - # in some cases we only have the FMS id and not the request id so use that - if ( $request->{fixmystreet_id} ) { - unless ( $request->{fixmystreet_id} =~ /^\d+$/ ) { - warn "skipping bad fixmystreet id in updates for " . $body->name . ": [" . $request->{fixmystreet_id} . "], external id is $request_id\n"; - next; - } + $problem = $self->schema->resultset('Problem')->to_body($body)->search( $criteria ); + return $problem->first; +} - $criteria = { - id => $request->{fixmystreet_id}, - }; +sub process_update { + my ($self, $request, $p) = @_; + my $open311 = $self->current_open311; + my $body = $self->current_body; + + my $state = $open311->map_state( $request->{status} ); + my $old_state = $p->state; + my $external_status_code = $request->{external_status_code} || ''; + my $customer_reference = $request->{customer_reference} || ''; + my $old_external_status_code = $p->get_extra_metadata('external_status_code') || ''; + my $comment = $self->schema->resultset('Comment')->new( + { + problem => $p, + user => $self->system_user, + external_id => $request->{update_id}, + text => $self->comment_text_for_request( + $request, $p, $state, $old_state, + $external_status_code, $old_external_status_code + ), + mark_fixed => 0, + mark_open => 0, + anonymous => 0, + name => $self->system_user->name, + confirmed => $request->{comment_time}, + created => $request->{comment_time}, + state => 'confirmed', + } + ); + + # Some Open311 services, e.g. Confirm via open311-adapter, provide + # a more fine-grained status code that we use within FMS for + # response templates. + if ( $external_status_code ) { + $comment->set_extra_metadata(external_status_code => $external_status_code); + $p->set_extra_metadata(external_status_code => $external_status_code); + } + + # if the customer reference to display in the report metadata is + # not the same as the external_id + if ( $customer_reference ) { + $p->set_extra_metadata( customer_reference => $customer_reference ); + } + + $open311->add_media($request->{media_url}, $comment) + if $request->{media_url}; + + # don't update state unless it's an allowed state + if ( FixMyStreet::DB::Result::Problem->visible_states()->{$state} && + # For Oxfordshire, don't allow changes back to Open from other open states + !( $body->areas->{$AREA_ID_OXFORDSHIRE} && $state eq 'confirmed' && $p->is_open ) && + # Don't let it change between the (same in the front end) fixed states + !( $p->is_fixed && FixMyStreet::DB::Result::Problem->fixed_states()->{$state} ) ) { + + $comment->problem_state($state); + + # if the comment is older than the last update do not + # change the status of the problem as it's tricky to + # determine the right thing to do. Allow the same time in + # case report/update created at same time (in external + # system). Only do this if the report is currently visible. + if ( $comment->created >= $p->lastupdate && $p->state ne $state && $p->is_visible ) { + $p->state($state); } + } - $problem = $self->schema->resultset('Problem')->to_body($body)->search( $criteria ); - - if (my $p = $problem->first) { - next unless defined $request->{update_id}; - my $c = $p->comments->search( { external_id => $request->{update_id} } ); - - if ( !$c->first ) { - my $state = $open311->map_state( $request->{status} ); - my $old_state = $p->state; - my $external_status_code = $request->{external_status_code} || ''; - my $customer_reference = $request->{customer_reference} || ''; - my $old_external_status_code = $p->get_extra_metadata('external_status_code') || ''; - my $comment = $self->schema->resultset('Comment')->new( - { - problem => $p, - user => $self->system_user, - external_id => $request->{update_id}, - text => $self->comment_text_for_request( - $request, $p, $state, $old_state, - $external_status_code, $old_external_status_code - ), - mark_fixed => 0, - mark_open => 0, - anonymous => 0, - name => $self->system_user->name, - confirmed => $comment_time, - created => $comment_time, - state => 'confirmed', - } - ); - - # Some Open311 services, e.g. Confirm via open311-adapter, provide - # a more fine-grained status code that we use within FMS for - # response templates. - if ( $external_status_code ) { - $comment->set_extra_metadata(external_status_code => $external_status_code); - $p->set_extra_metadata(external_status_code => $external_status_code); - } - - # if the customer reference to display in the report metadata is - # not the same as the external_id - if ( $customer_reference ) { - $p->set_extra_metadata( customer_reference => $customer_reference ); - } - - $open311->add_media($request->{media_url}, $comment) - if $request->{media_url}; - - # don't update state unless it's an allowed state - if ( FixMyStreet::DB::Result::Problem->visible_states()->{$state} && - # For Oxfordshire, don't allow changes back to Open from other open states - !( $body->areas->{$AREA_ID_OXFORDSHIRE} && $state eq 'confirmed' && $p->is_open ) && - # Don't let it change between the (same in the front end) fixed states - !( $p->is_fixed && FixMyStreet::DB::Result::Problem->fixed_states()->{$state} ) ) { - - $comment->problem_state($state); - - # if the comment is older than the last update do not - # change the status of the problem as it's tricky to - # determine the right thing to do. Allow the same time in - # case report/update created at same time (in external - # system). Only do this if the report is currently visible. - if ( $comment->created >= $p->lastupdate && $p->state ne $state && $p->is_visible ) { - $p->state($state); - } - } - - # If nothing to show (no text, photo, or state change), don't show this update - $comment->state('hidden') unless $comment->text || $comment->photo - || ($comment->problem_state && $state ne $old_state); - - $cobrand->call_hook(open311_get_update_munging => $comment) - if $cobrand; - - # As comment->created has been looked at above, its time zone has been shifted - # to TIME_ZONE (if set). We therefore need to set it back to local before - # insertion. We also then need a clone, otherwise the setting of lastupdate - # will *also* reshift comment->created's time zone to TIME_ZONE. - my $created = $comment->created->set_time_zone(FixMyStreet->local_time_zone); - $p->lastupdate($created->clone); - $p->update; - $comment->insert(); - - if ( $self->suppress_alerts ) { - my @alerts = $self->schema->resultset('Alert')->search( { - alert_type => 'new_updates', - parameter => $p->id, - confirmed => 1, - user_id => $p->user->id, - } ); - - for my $alert (@alerts) { - my $alerts_sent = $self->schema->resultset('AlertSent')->find_or_create( { - alert_id => $alert->id, - parameter => $comment->id, - } ); - } - } - } + # If nothing to show (no text, photo, or state change), don't show this update + $comment->state('hidden') unless $comment->text || $comment->photo + || ($comment->problem_state && $state ne $old_state); + + my $cobrand = $body->get_cobrand_handler; + $cobrand->call_hook(open311_get_update_munging => $comment) + if $cobrand; + + # As comment->created has been looked at above, its time zone has been shifted + # to TIME_ZONE (if set). We therefore need to set it back to local before + # insertion. We also then need a clone, otherwise the setting of lastupdate + # will *also* reshift comment->created's time zone to TIME_ZONE. + my $created = $comment->created->set_time_zone(FixMyStreet->local_time_zone); + $p->lastupdate($created->clone); + $p->update; + $comment->insert(); + + if ( $self->suppress_alerts ) { + my @alerts = $self->schema->resultset('Alert')->search( { + alert_type => 'new_updates', + parameter => $p->id, + confirmed => 1, + user_id => $p->user->id, + } ); + + for my $alert (@alerts) { + my $alerts_sent = $self->schema->resultset('AlertSent')->find_or_create( { + alert_id => $alert->id, + parameter => $comment->id, + } ); } } - return 1; + return $comment; } sub comment_text_for_request { diff --git a/t/open311/getservicerequestupdates.t b/t/open311/getservicerequestupdates.t index 32f1ec2ee..d58855122 100644 --- a/t/open311/getservicerequestupdates.t +++ b/t/open311/getservicerequestupdates.t @@ -510,8 +510,13 @@ for my $test ( $problemB->state( $test->{start_state} ); $problemB->update; - my $update = Open311::GetServiceRequestUpdates->new( system_user => $user ); - $update->update_comments( $o, $bodies{2237} ); + my $update = Open311::GetServiceRequestUpdates->new( + system_user => $user, + current_open311 => $o, + current_body => $bodies{2237}, + ); + $update->process_body; + is $problemB->comments->count, 1, 'comment count'; $problemB->discard_changes; @@ -530,11 +535,16 @@ subtest 'Marking report as fixed closes it for updates (Bexley)' => sub { $problemB->update( { bodies_str => $bodies{2494}->id } ); - my $update = Open311::GetServiceRequestUpdates->new( system_user => $user ); + my $update = Open311::GetServiceRequestUpdates->new( + system_user => $user, + current_open311 => $o, + current_body => $bodies{2494}, + current_cobrand => $bodies{2494}->get_cobrand_handler, + ); FixMyStreet::override_config { ALLOWED_COBRANDS => 'bexley', }, sub { - $update->update_comments( $o, $bodies{2494} ); + $update->process_body; }; $problemB->discard_changes; @@ -562,8 +572,12 @@ subtest 'Update with media_url includes image in update' => sub { $problem->state('confirmed'); $problem->update; - my $update = Open311::GetServiceRequestUpdates->new( system_user => $user ); - $update->update_comments( $o, $bodies{2482} ); + my $update = Open311::GetServiceRequestUpdates->new( + system_user => $user, + current_open311 => $o, + current_body => $bodies{2482}, + ); + $update->process_body; is $problem->comments->count, 1, 'comment count'; my $c = $problem->comments->first; @@ -585,8 +599,12 @@ subtest 'Update with customer_reference adds reference to problem' => sub { $problem->state('confirmed'); $problem->update; - my $update = Open311::GetServiceRequestUpdates->new( system_user => $user ); - $update->update_comments( $o, $bodies{2482} ); + my $update = Open311::GetServiceRequestUpdates->new( + system_user => $user, + current_open311 => $o, + current_body => $bodies{2482}, + ); + $update->process_body; $problem->discard_changes; is $problem->comments->count, 1, 'comment count'; @@ -600,11 +618,15 @@ subtest 'date for comment correct' => sub { my $local_requests_xml = setup_xml($problem->external_id, $problem->id, ""); my $o = Open311->new( jurisdiction => 'mysociety', endpoint => 'http://example.com', test_mode => 1, test_get_returns => { 'servicerequestupdates.xml' => $local_requests_xml } ); - my $update = Open311::GetServiceRequestUpdates->new( system_user => $user ); + my $update = Open311::GetServiceRequestUpdates->new( + system_user => $user, + current_open311 => $o, + current_body => $bodies{2482}, + ); FixMyStreet::override_config { TIME_ZONE => 'Australia/Sydney', }, sub { - $update->update_comments( $o, $bodies{2482} ); + $update->process_body; }; my $comment = $problem->comments->first; @@ -639,8 +661,12 @@ for my $test ( my $local_requests_xml = setup_xml($test->{request_id}, $test->{request_id_ext}, ""); my $o = Open311->new( jurisdiction => 'mysociety', endpoint => 'http://example.com', test_mode => 1, test_get_returns => { 'servicerequestupdates.xml' => $local_requests_xml } ); - my $update = Open311::GetServiceRequestUpdates->new( system_user => $user ); - $update->update_comments( $o, $bodies{$test->{area_id}} ); + my $update = Open311::GetServiceRequestUpdates->new( + system_user => $user, + current_open311 => $o, + current_body => $bodies{$test->{area_id}}, + ); + $update->process_body; is $problem->comments->count, $test->{p1_comments}, 'comment count for first problem'; is $problem2->comments->count, $test->{p2_comments}, 'comment count for second problem'; @@ -658,26 +684,30 @@ subtest 'using start and end date' => sub { my $update = Open311::GetServiceRequestUpdates->new( system_user => $user, start_date => $start_dt, + current_open311 => $o, ); - my $res = $update->update_comments( $o ); + my $res = $update->process_body; is $res, 0, 'returns 0 if start but no end date'; $update = Open311::GetServiceRequestUpdates->new( system_user => $user, end_date => $end_dt, + current_open311 => $o, ); - $res = $update->update_comments( $o ); + $res = $update->process_body; is $res, 0, 'returns 0 if end but no start date'; $update = Open311::GetServiceRequestUpdates->new( system_user => $user, start_date => $start_dt, end_date => $end_dt, + current_open311 => $o, + current_body => $bodies{2482}, ); - $update->update_comments( $o, $bodies{2482} ); + $update->process_body; my $start = $start_dt . ''; my $end = $end_dt . ''; @@ -735,19 +765,21 @@ subtest 'check that existing comments are not duplicated' => sub { my $update = Open311::GetServiceRequestUpdates->new( system_user => $user, + current_open311 => $o, + current_body => $bodies{2482}, ); - $update->update_comments( $o, $bodies{2482} ); + $update->process_body; $problem->discard_changes; is $problem->comments->count, 2, 'two comments after fetching updates'; - $update->update_comments( $o, $bodies{2482} ); + $update->process_body; $problem->discard_changes; is $problem->comments->count, 2, 're-fetching updates does not add comments'; $problem->comments->delete; - $update->update_comments( $o, $bodies{2482} ); + $update->process_body; $problem->discard_changes; is $problem->comments->count, 2, 'if comments are deleted then they are added'; }; @@ -826,9 +858,11 @@ subtest 'check that external_status_code is stored correctly' => sub { my $update = Open311::GetServiceRequestUpdates->new( system_user => $user, + current_open311 => $o, + current_body => $bodies{2482}, ); - $update->update_comments( $o, $bodies{2482} ); + $update->process_body; $problem->discard_changes; is $problem->comments->count, 2, 'two comments after fetching updates'; @@ -871,9 +905,11 @@ subtest 'check that external_status_code triggers auto-responses' => sub { my $update = Open311::GetServiceRequestUpdates->new( system_user => $user, + current_open311 => $o, + current_body => $bodies{2482}, ); - $update->update_comments( $o, $bodies{2482} ); + $update->process_body; $problem->discard_changes; is $problem->comments->count, 1, 'one comment after fetching updates'; @@ -925,9 +961,11 @@ foreach my $test ( { my $update = Open311::GetServiceRequestUpdates->new( system_user => $user, + current_open311 => $o, + current_body => $bodies{2482}, ); - $update->update_comments( $o, $bodies{2482} ); + $update->process_body; $problem->discard_changes; is $problem->comments->count, 2, 'two comments after fetching updates'; @@ -990,9 +1028,11 @@ foreach my $test ( { my $update = Open311::GetServiceRequestUpdates->new( system_user => $user, suppress_alerts => $test->{suppress_alerts}, + current_open311 => $o, + current_body => $bodies{2482}, ); - $update->update_comments( $o, $bodies{2482} ); + $update->process_body; $problem->discard_changes; my $alerts_sent = FixMyStreet::DB->resultset('AlertSent')->search( @@ -1052,12 +1092,14 @@ foreach my $test ( { my $update = Open311::GetServiceRequestUpdates->new( system_user => $user, blank_updates_permitted => $test->{blank_updates_permitted}, + current_open311 => $o, + current_body => $bodies{2482}, ); if ( $test->{blank_updates_permitted} ) { - stderr_is { $update->update_comments( $o, $bodies{2482} ) } '', 'No error message' + stderr_is { $update->process_body } '', 'No error message' } else { - stderr_like { $update->update_comments( $o, $bodies{2482} ) } qr/Couldn't determine update text for/, 'Error message displayed' + stderr_like { $update->process_body } qr/Couldn't determine update text for/, 'Error message displayed' } $problem->discard_changes; $problem->comments->delete; @@ -1106,9 +1148,11 @@ subtest 'check matching on fixmystreet_id overrides service_request_id' => sub { my $update = Open311::GetServiceRequestUpdates->new( system_user => $user, + current_open311 => $o, + current_body => $bodies{2482}, ); - $update->update_comments( $o, $bodies{2482} ); + $update->process_body; $problem->discard_changes; is $problem->comments->count, 2, 'two comments after fetching updates'; @@ -1141,10 +1185,12 @@ subtest 'check bad fixmystreet_id is handled' => sub { my $update = Open311::GetServiceRequestUpdates->new( system_user => $user, + current_open311 => $o, + current_body => $bodies{2482}, ); warning_like { - $update->update_comments( $o, $bodies{2482} ) + $update->process_body } qr/skipping bad fixmystreet id in updates for Bromley: \[123456 654321\], external id is 8888888888888/, "warning emitted for bad fixmystreet id"; |