[Surrey] Cobrand & integration

.cypress/cypress.json

@@ -1,7 +1,7 @@
 {
   "baseUrl": "http://fixmystreet.localhost:3001",
   "projectId": "y8vvs1",
-  "blacklistHosts": ["gaze.mysociety.org", "*.openstreetmap.org", "portal.roadworks.org", "tilma.mysociety.org", "tilma.staging.mysociety.org", "isharemaps.bathnes.gov.uk", "consent.cookiebot.com", "assets.adobedtm.com", "www.googletagmanager.com", "www.googleadservices.com", "*.virtualearth.net"],
+  "blacklistHosts": ["gaze.mysociety.org", "*.openstreetmap.org", "portal.roadworks.org", "tilma.mysociety.org", "tilma.staging.mysociety.org", "isharemaps.bathnes.gov.uk", "consent.cookiebot.com", "assets.adobedtm.com", "www.googletagmanager.com", "www.googleadservices.com", "*.virtualearth.net", "feedback.happy-or-not.com"],
   "env": {
      "postcode": "BS10 5EE"
   },

.cypress/cypress/integration/surrey.js

@@ -0,0 +1,26 @@
+describe('Surrey cobrand', function() {
+    it('contains Surrey configuration', function() {
+        cy.viewport(480, 800);
+        cy.visit('http://surrey.localhost:3001/');
+        cy.contains('Surrey');
+    });
+});
+
+describe('Reporting not on a road', function() {
+    it('Can report certain categories not on a road', function() {
+        cy.server();
+        cy.route('/report/new/ajax*').as('report-ajax');
+        cy.visit('http://surrey.localhost:3001/report/new?longitude=-0.441269&latitude=51.293415');
+        cy.wait('@report-ajax');
+        cy.pickCategory('Abandoned vehicles');
+        cy.contains('You cannot send Surrey County Council a report');
+        cy.get('#map_sidebar').scrollTo('bottom');
+        cy.get('.js-reporting-page--next:visible').should('be.disabled');
+        cy.pickCategory('Flooding inside a building');
+        cy.contains('You cannot send Surrey County Council a report').should('not.be.visible');
+        cy.get('#map_sidebar').scrollTo('bottom');
+        cy.get('.js-reporting-page--next:visible').should('not.be.disabled');
+    });
+});
+
+

CHANGELOG.md

@@ -28,6 +28,7 @@
         - Fix setting of fixed timestamp in CSV export. #5119
         - Fix CSV export of reports with only hidden/unconfirmed updates. #5119
         - Fix displaying category page if over 1,000 history entries.
+        - Stop wrapping category notices in a label.
     - Admin improvements:
         - Rename emergency message to site message.
         - Added a category control for overriding the text of the new report details field.
@@ -49,7 +50,7 @@
         - Add `send_state` column to reports. #4048
         - Return random unprocessed row to daemon.
         - A cobrand level text override for the details field label on new reports can now be configured.
-        - Cobrands can provide per-category custom distances for duplicate lookup. #4746
+        - Cobrands can provide per-category custom distances for duplicate lookup. #4746 #5162
         - Add perl 5.38 support.
         - Add plain text template previews to /_dev/email. #5105
     - Performance improvements:

bin/browser-tests

@@ -28,6 +28,7 @@ BEGIN {
         oxfordshire
         peterborough
         shropshire
+        surrey
         tfl
         westminster
     )];

bin/export-import-data

@@ -23,6 +23,7 @@ my ($opt, $usage) = describe_options(
     [ 'import=s', "File to import" ],
     [ 'commit', "Actually commit changes to the database" ],
     [ 'update-templates', "Update existing templates (default is to skip)" ],
+    [ 'update-contacts', "Update existing contacts (default is to skip)" ],
     [ 'categories=s', "pipe-separated list of categories to export contacts for and filter templates by" ],
     [ 'all-categories', "Use instead of --categories to export all contacts & templates" ],
     [ 'help', "print usage message and exit", { shortcircuit => 1 } ],
@@ -36,7 +37,7 @@ my $body = FixMyStreet::DB->resultset("Body")->find({ name => $opt->name }) or d
 my @categories = split(/\|/, ($opt->{categories} || ''));
 
 if ($opt->import) {
-    import($opt->import, $opt->update_templates);
+    import($opt->import, $opt->update_templates, $opt->update_contacts);
 } else {
     export();
 }
@@ -108,6 +109,7 @@ sub export {
 sub import {
     my $file = shift;
     my $update_templates = shift;
+    my $update_contacts = shift;
 
     my $json = path($file)->slurp;
     my $out = $J->decode($json);
@@ -118,20 +120,33 @@ sub import {
     foreach (@{$out->{contacts}}) {
         my $existing = $body->contacts->search({ category => $_->{category} })->single;
         if ($existing) {
-            warn "Category $_->{category} already exists, skipping";
-            next;
+            if ($update_contacts) {
+                $existing->update({
+                    note => "Updated from $file",
+                    editor => 'export-import-data',
+                    whenedited => \'current_timestamp',
+                    email => $_->{email},
+                    state => $_->{state},
+                    non_public => $_->{non_public},
+                    extra => $_->{extra},
+                });
+            } else {
+                warn "Category $_->{category} already exists, skipping";
+                next;
+            }
+        } else {
+            my $contact = $body->contacts->new({
+                note => "Imported from $file",
+                editor => 'export-import-data',
+                whenedited => \'current_timestamp',
+                category => $_->{category},
+                email => $_->{email},
+                state => $_->{state},
+                non_public => $_->{non_public},
+                extra => $_->{extra},
+            });
+            $contact->insert;
         }
-        my $contact = $body->contacts->new({
-            note => "Imported from $file",
-            editor => 'export-import-data',
-            whenedited => \'current_timestamp',
-            category => $_->{category},
-            email => $_->{email},
-            state => $_->{state},
-            non_public => $_->{non_public},
-            extra => $_->{extra},
-        });
-        $contact->insert;
     }
 
     foreach (@{$out->{templates}}) {

bin/fixmystreet.com/fixture

@@ -150,6 +150,7 @@ if ($opt->test_fixtures) {
         { area_id => 2500, categories => [ 'Abandoned vehicles', 'Flytipping', 'Flyposting' ], name => 'Merton Council', cobrand => 'merton' },
         { area_id => 2488, categories => [ 'Grass verges / shrub beds - littering' , 'Pavement damage', 'Fly-tipping', 'Dog fouling'], name => 'Brent Council', cobrand => 'brent' },
         { area_id => 2535, categories => [ 'Abandoned vehicles', 'Graffiti', 'Street lights'], name => 'Sandwell Borough Council' },
+        { area_id => 2242, categories => [ 'Abandoned vehicles', 'Graffiti', 'Street lights', 'Flooding inside a building'], name => 'Surrey County Council' },
     ) {
         $bodies->{$_->{area_id}} = FixMyStreet::DB::Factory::Body->find_or_create($_);
         if ($_->{cobrand}) {

data/test-asset-layers.yml

@@ -381,6 +381,39 @@ shropshire:
     actions:
       found: 'fixmystreet.assets.shropshire.street_found'
       not_found: 'fixmystreet.assets.shropshire.street_not_found'
+surrey:
+  - asset_type: 'spot'
+    max_resolution: 4.777314267158508
+    asset_id_field: 'assetNo'
+    srsName: "EPSG:4326"
+    body: "Surrey County Council"
+    format_class: OpenLayers.Format.GeoJSON
+    format_options: {ignoreExtraDims: true}
+    protocol_class: OpenLayers.Protocol.ArcgisHTTP
+    class: OpenLayers.Layer.VectorAssetMove
+    http_options:
+      params:
+        inSR: '4326'
+        f: 'geojson'
+  - always_visible: true
+    asset_type: road
+    road: true
+    actions:
+      found: fixmystreet.message_controller.road_found
+      not_found: fixmystreet.assets.surrey.road_not_found
+    permissive_categories: ['Flooding inside a building', 'Flooding not on the highway but in a park or private land']
+    no_asset_msg_id: '#js-not-a-road'
+    http_options:
+      params:
+        outFields: USRN
+        where: MAINTAINED_BY='Surrey CC'
+      url: https://tilma.mysociety.org/resource-proxy/proxy.php?https://surrey.assets/2/query?
+    non_interactive: true
+    class: OpenLayers.Layer.VectorNearest
+    stylemap: fixmystreet.assets.stylemap_invisible
+    usrn:
+      attribute: USRN
+      field: site_code
 tfl:
   - - http_wfs_url: "https://tilma.staging.mysociety.org/mapserver/tfl"
       name: 'road'

perllib/FixMyStreet/App/Controller/Report.pm

@@ -727,38 +727,42 @@ sub _nearby_json :Private {
         # This is for the list template, this is a list on that page.
         $c->stash->{page} = 'report';
 
-        my $dist = $self->_find_distance($c, $params);
-        $params->{distance} = $dist / 1000 unless $params->{distance}; # DB measures in km
+        if (my $dist = $self->_find_distance($c, $params)) { # distance of 0 means we can skip lookup entirely
+            $params->{distance} = $dist / 1000 unless $params->{distance}; # DB measures in km
 
-        my $pin_size = $c->get_param('pin_size') || '';
-        $pin_size = 'small' unless $pin_size =~ /^(mini|small|normal|big)$/;
+            my $pin_size = $c->get_param('pin_size') || '';
+            $pin_size = 'small' unless $pin_size =~ /^(mini|small|normal|big)$/;
 
-        $params->{extra} = $c->cobrand->call_hook('display_location_extra_params');
-        $params->{limit} = 5;
+            $params->{extra} = $c->cobrand->call_hook('display_location_extra_params');
+            $params->{limit} = 5;
 
-        my $nearby = $c->model('DB::Nearby')->nearby($c, %$params);
+            my $nearby = $c->model('DB::Nearby')->nearby($c, %$params);
 
-        # Want to treat these as if they were on map
-        $nearby = [ map { $_->problem } @$nearby ];
-        my @pins = map {
-            my $p = $_->pin_data('around');
-            [ $p->{latitude}, $p->{longitude}, $p->{colour},
-            $p->{id}, $p->{title}, $pin_size, JSON->false
-            ]
-        } @$nearby;
+            # Want to treat these as if they were on map
+            $nearby = [ map { $_->problem } @$nearby ];
+            my @pins = map {
+                my $p = $_->pin_data('around');
+                [ $p->{latitude}, $p->{longitude}, $p->{colour},
+                $p->{id}, $p->{title}, $pin_size, JSON->false
+                ]
+            } @$nearby;
 
-        my @extra_pins = $c->cobrand->call_hook('extra_nearby_pins', $params->{latitude}, $params->{longitude}, $dist);
-        @pins = (@pins, @extra_pins) if @extra_pins;
+            my @extra_pins = $c->cobrand->call_hook('extra_nearby_pins', $params->{latitude}, $params->{longitude}, $dist);
+            @pins = (@pins, @extra_pins) if @extra_pins;
 
-        my $list_html = $c->render_fragment(
-            'report/nearby.html',
-            { reports => $nearby, inline_maps => $c->get_param("inline_maps") ? 1 : 0, extra_pins => \@extra_pins }
-        );
-        my $json = { pins => \@pins };
-        $json->{reports_list} = $list_html if $list_html;
-        my $body = encode_json($json);
-        $c->res->content_type('application/json; charset=utf-8');
-        $c->res->body($body);
+            my $list_html = $c->render_fragment(
+                'report/nearby.html',
+                { reports => $nearby, inline_maps => $c->get_param("inline_maps") ? 1 : 0, extra_pins => \@extra_pins }
+            );
+            my $json = { pins => \@pins };
+            $json->{reports_list} = $list_html if $list_html;
+            my $body = encode_json($json);
+            $c->res->content_type('application/json; charset=utf-8');
+            $c->res->body($body);
+        } else {
+            $c->res->content_type('application/json; charset=utf-8');
+            $c->res->body(encode_json({ 'pins' => []}));
+        }
     }
 }
 
@@ -769,7 +773,9 @@ sub _nearby_json :Private {
 # b) distances for a group/parent category
 # c) distances by mode
 #
-# NOTE: Distances for category or group only apply for the 'suggestions' mode.
+# NOTES:
+#  - Distances for category or group only apply for the 'suggestions' mode.
+#  - Returning a distance of 0 means we can skip the nearby lookup entirely.
 sub _find_distance {
     my ($self, $c, $params) = @_;
 
@@ -782,17 +788,17 @@ sub _find_distance {
             my $category = $params->{categories}[0];
             my $group    = $params->{group};
 
-            $dist = $category && $cobrand_distances->{$mode}{$category}
+            $dist = $category && defined $cobrand_distances->{$mode}{$category}
             ? $cobrand_distances->{$mode}{$category}
-            : $group && $cobrand_distances->{$mode}{$group}
+            : $group && defined $cobrand_distances->{$mode}{$group}
             ? $cobrand_distances->{$mode}{$group}
             : $cobrand_distances->{$mode}{_fallback};
         } else {
             $dist = $cobrand_distances->{$mode};
         }
     }
 
-    $dist ||= $c->get_param('distance') || '';
+    $dist //= $c->get_param('distance') || '';
     $dist = 1000 unless $dist =~ /^\d+$/;
     $dist = 1000 if $dist > 1000;
 
@@ -839,7 +845,15 @@ sub stash_category_groups : Private {
                 my $contact = $category_groups{$_}[0];
                 push @list, [ $contact->category_display, $contact ];
             } else {
-                push @list, [ $_, { id => $id, name => $_, categories => $category_groups{$_} } ];
+                my $cats = $category_groups{$_};
+                @$cats = sort {
+                    my $aa = $a->category_display;
+                    return 1 if $aa eq _('Other');
+                    my $bb = $b->category_display;
+                    return -1 if $bb eq _('Other');
+                    $aa cmp $bb;
+                } @$cats;
+                push @list, [ $_, { id => $id, name => $_, categories => $cats } ];
             }
         }
         @list = sort {

perllib/FixMyStreet/Cobrand/Default.pm

@@ -1474,6 +1474,8 @@ inspector de-duplication and report duplicate suggestions features.
 
 Defaults to 1000m for inspectors, 250m for duplicate suggestions.
 
+Returning a distance of 0 means no nearby reports will be returned at all.
+
 Should return a hashref of the form
 
 {