Merge pull request #3217 from alphagov/provider-priority

Display and set provider priority in a non-independent way

app/assets/javascripts/radioSlider.js

@@ -0,0 +1,28 @@
+(function(global) {
+
+  "use strict";
+
+  global.GOVUK.Modules.RadioSlider = function() {
+
+    this.start = function(component) {
+
+      $(component)
+        .on('click', function() {
+
+          valuesInLabel = $(this).find(':checked').next('label').text().split('/');
+
+          if (valuesInLabel.length === 2) {
+            leftValue = valuesInLabel[0];
+            rightValue = valuesInLabel[1];
+            $(this).find('.radio-slider-left-value').html(leftValue);
+            $(this).find('.radio-slider-right-value').html(rightValue);
+          }
+
+        })
+        .trigger('click');
+
+    };
+
+  };
+
+})(window);

app/assets/stylesheets/components/page-footer.scss

@@ -65,6 +65,15 @@
     margin: 0;
   }
 
+  &-centered-button {
+
+    .button {
+      display: block;
+      margin: 0 auto;
+    }
+
+  }
+
 }
 
 .align-button-with-textbox {

app/assets/stylesheets/components/radios.scss

@@ -117,3 +117,56 @@
     margin-right: 15px;
   }
 }
+
+.radio-slider {
+
+  border-bottom: 2px solid $black;
+  height: 18px;
+  margin-bottom: 18px + 30px;
+  margin-right: -18px;
+  margin-left: -18px;
+  white-space: nowrap;
+
+  legend {
+    display: none;
+  }
+
+  .multiple-choice {
+
+    display: inline-block;
+    margin-right: 0;
+    padding: 0;
+    width: 38px;
+    margin-right: calc((100% - (38px * 11)) / 10);
+
+    &:last-child {
+      margin-right: 0;
+    }
+
+    label {
+
+      font-size: 0;
+      padding: 0;
+
+      &:before {
+        background: $white;
+      }
+
+    }
+
+  }
+
+  &-left-value {
+    position: absolute;
+    bottom: 30px;
+    left: 0;
+  }
+
+  &-right-value {
+    position: absolute;
+    bottom: 30px;
+    right: 0;
+    text-align: right;
+  }
+
+}

app/assets/stylesheets/views/history.scss

@@ -15,6 +15,10 @@ $item-top-padding: $gutter-half;
       border-bottom: 1px solid $border-colour;
     }
 
+    .page-footer {
+      margin-bottom: 5px;
+    }
+
   }
 
   &-user {
@@ -26,4 +30,66 @@ $item-top-padding: $gutter-half;
     color: $secondary-text-colour;
   }
 
+  &-percentage {
+
+    $axis-thickness: 2px;
+    border-bottom: $axis-thickness solid $black;
+    position: relative;
+    margin-bottom: 35px;
+    height: 35px;
+
+    &:before,
+    &:after {
+      content: "";
+      position: absolute;
+      bottom: -6px;
+      left: 0;
+      height: 10px;
+      width: $axis-thickness;
+      background: $black;
+    }
+
+    &:after {
+      left: auto;
+      right: 0;
+    }
+
+    &-without-border {
+      position: relative;
+      padding-top: 35px;
+    }
+
+    &-marker {
+      $size: 20px;
+      $border-thickness: 7px;
+      $text-width: 100px;
+      display: block;
+      width: $size;
+      height: $size;
+      position: absolute;
+      top: 35px - ($size / 2) - ($border-thickness - ($axis-thickness / 2));
+      margin-left: 0 - ($size / 2) - $border-thickness;
+      background: $black;
+      border-radius: $size;
+      border: $border-thickness solid $white;
+    }
+
+    &-left-label,
+    &-right-label {
+      width: 100%;
+      position: absolute;
+      top: 0;
+    }
+
+    &-left-label {
+      left: 0;
+    }
+
+    &-right-label {
+      right: 0;
+      text-align: right;
+    }
+
+  }
+
 }

app/main/forms.py

@@ -952,6 +952,22 @@ class ProviderForm(StripWhitespaceForm):
     priority = IntegerField('Priority', [validators.NumberRange(min=1, max=100, message="Must be between 1 and 100")])
 
 
+class ProviderRatioForm(StripWhitespaceForm):
+
+    ratio = RadioField(choices=[
+        (str(value), '{}% / {}%'.format(value, 100 - value))
+        for value in range(100, -10, -10)
+    ])
+
+    @property
+    def percentage_left(self):
+        return int(self.ratio.data)
+
+    @property
+    def percentage_right(self):
+        return 100 - self.percentage_left
+
+
 class ServiceContactDetailsForm(StripWhitespaceForm):
     contact_details_type = RadioField(
         'Type of contact details',

app/main/views/providers.py

@@ -1,11 +1,17 @@
-from flask import render_template, url_for
+from collections import defaultdict
+from datetime import datetime
+from operator import itemgetter
+
+from flask import abort, render_template, url_for
 from werkzeug.utils import redirect
 
-from app import provider_client
+from app import format_date_numeric, provider_client
 from app.main import main
-from app.main.forms import ProviderForm
+from app.main.forms import ProviderForm, ProviderRatioForm
 from app.utils import user_is_platform_admin
 
+PROVIDER_PRIORITY_MEANING_SWITCHOVER = datetime(2019, 11, 29, 11, 0).isoformat()
+
 
 @main.route("/providers")
 @user_is_platform_admin
@@ -51,6 +57,65 @@ def edit_provider(provider_id):
     return render_template('views/providers/edit-provider.html', form=form, provider=provider)
 
 
+@main.route("/provider/edit-sms-provider-ratio", methods=['GET', 'POST'])
+@user_is_platform_admin
+def edit_sms_provider_ratio():
+
+    providers = sorted([
+        provider
+        for provider in provider_client.get_all_providers()['provider_details']
+        if provider['notification_type'] == 'sms'
+    ], key=itemgetter('identifier'), reverse=True)
+
+    form = ProviderRatioForm(ratio=providers[0]['priority'])
+
+    if len(providers) < 2:
+        abort(400)
+
+    primary_provider, secondary_provider = providers[0:2]
+
+    if form.validate_on_submit():
+        provider_client.update_provider(primary_provider['id'], form.percentage_left)
+        provider_client.update_provider(secondary_provider['id'], form.percentage_right)
+        return redirect(url_for('.edit_sms_provider_ratio'))
+
+    return render_template(
+        'views/providers/edit-sms-provider-ratio.html',
+        versions=_chunk_versions_by_day(_get_versions_since_switchover(primary_provider['id'])),
+        form=form,
+        primary_provider=providers[0]['display_name'],
+        secondary_provider=providers[1]['display_name'],
+    )
+
+
+def _get_versions_since_switchover(provider_id):
+
+    for version in sorted(
+        provider_client.get_provider_versions(provider_id)['data'],
+        key=lambda version: version['updated_at'] or ''
+    ):
+
+        if not version['updated_at']:
+            continue
+
+        if version['updated_at'] < PROVIDER_PRIORITY_MEANING_SWITCHOVER:
+            continue
+
+        yield version
+
+
+def _chunk_versions_by_day(versions):
+
+    days = defaultdict(list)
+
+    for version in sorted(versions, key=lambda version: version['updated_at'] or '', reverse=True):
+        days[
+            format_date_numeric(version['updated_at'])
+        ].append(version)
+
+    return sorted(days.items(), reverse=True)
+
+
 @main.route("/provider/<uuid:provider_id>")
 @user_is_platform_admin
 def view_provider(provider_id):

app/navigation.py

@@ -89,6 +89,7 @@ class HeaderNavigation(Navigation):
             'clear_cache',
             'create_email_branding',
             'create_letter_branding',
+            'edit_sms_provider_ratio',
             'email_branding',
             'find_services_by_name',
             'find_users_by_email',
@@ -497,6 +498,7 @@ class MainNavigation(Navigation):
         'edit_organisation_name',
         'edit_organisation_type',
         'edit_provider',
+        'edit_sms_provider_ratio',
         'edit_user_org_permissions',
         'email_branding',
         'email_not_received',
@@ -717,6 +719,7 @@ class CaseworkNavigation(Navigation):
         'edit_organisation_name',
         'edit_organisation_type',
         'edit_provider',
+        'edit_sms_provider_ratio',
         'edit_service_template',
         'edit_template_postage',
         'edit_user_email',
@@ -1002,6 +1005,7 @@ class OrgNavigation(Navigation):
         'edit_data_retention',
         'edit_provider',
         'edit_service_template',
+        'edit_sms_provider_ratio',
         'edit_template_postage',
         'edit_user_email',
         'edit_user_mobile_number',

app/templates/components/page-footer.html

@@ -6,9 +6,10 @@
   secondary_link=False,
   secondary_link_text=None,
   delete_link=False,
-  delete_link_text="delete"
+  delete_link_text="delete",
+  centered_button=False
 ) %}
-  <div class="page-footer">
+  <div class="page-footer {% if centered_button %}page-footer-centered-button{% endif %}">
     {% if button_text %}
       <input type="hidden" name="csrf_token" value="{{ csrf_token() }}" />
       <button

app/templates/views/providers/edit-sms-provider-ratio.html

@@ -0,0 +1,92 @@
+{% extends "views/platform-admin/_base_template.html" %}
+{% from "components/textbox.html" import textbox %}
+{% from "components/page-header.html" import page_header %}
+{% from "components/page-footer.html" import page_footer %}
+{% from "components/form.html" import form_wrapper %}
+{% from "components/radios.html" import radios %}
+
+{% block per_page_title %}
+  Text message providers
+{% endblock %}
+
+{% block platform_admin_content %}
+
+  {{ page_header('Text message providers') }}
+
+
+  <h2 class="heading-small top-gutter">
+    Now
+  </h2>
+  <div class="bottom-gutter">
+    <div class="history-list-item">
+      <div class="grid-row">
+        <div class="column-one-third">&nbsp;</div>
+        <div class="column-two-thirds">
+          <div class="history-list-percentage-without-border">
+            <div class="history-list-percentage-left-label">
+              {{ primary_provider }}
+            </div>
+            <div class="history-list-percentage-right-label">
+              {{ secondary_provider }}
+            </div>
+            {% call form_wrapper() %}
+              <div class="radio-slider" data-module="radio-slider">
+                {{ radios(form.ratio, inline=True, hide_legend=True) }}
+                <div class="radio-slider-left-value">
+                  —
+                </div>
+                <div class="radio-slider-right-value">
+                  —
+                </div>
+              </div>
+              {{ page_footer('Update', centered_button=True) }}
+            {% endcall %}
+          </div>
+        </div>
+      </div>
+    </div>
+  </div>
+
+
+  {% for day, versions in versions %}
+    <h2 class="heading-small top-gutter">
+      {% if day %}
+        {{ day|format_date_human|title }}
+      {% else %}
+        Start
+      {% endif %}
+    </h2>
+    <ul class="bottom-gutter">
+      {% for version in versions %}
+        <li class="history-list-item">
+          <div class="grid-row">
+            <div class="column-one-third">
+              <div class="history-list-user">
+                {{ version.created_by.name or ('&nbsp;'|safe) }}
+              </div>
+              {% if version.updated_at %}
+                <div class="history-list-time">
+                  {{ version.updated_at|format_time }}
+                </div>
+              {% endif %}
+            </div>
+            <div class="column-two-thirds">
+              <div class="history-list-percentage">
+                <div class="history-list-percentage-left-label">
+                  {{ primary_provider }}<br><br>
+                  {{ version.priority|format_thousands }}%
+                </div>
+                <div class="history-list-percentage-right-label">
+                  {{ secondary_provider }}<br><br>
+                  {{ (100 - version.priority)|format_thousands }}%
+                </div>
+                <div class="history-list-percentage-marker" style="left: {{ (100 -version.priority)|format_thousands }}%"></div>
+              </div>
+            </div>
+          </div>
+        </li>
+      {% endfor %}
+    </ul>
+  {% endfor %}
+
+{% endblock %}

app/templates/views/providers/providers.html

@@ -12,6 +12,8 @@ Providers
 
   <h2 class="heading-medium">SMS</h2>
 
+  <a href="{{ url_for('main.edit_sms_provider_ratio') }}">Change priority</a>
+
   {% call(item, row_number) list_table(
       domestic_sms_providers,
       caption="Domestic SMS providers",
@@ -21,7 +23,7 @@ Providers
       field_headings_visible=True
   ) %}
 
-      {{ link_field(item.display_name, url_for('main.view_provider', provider_id=item.id)) }}
+      {{ text_field(item.display_name) }}
 
       {{ text_field(item.priority) }}
 
@@ -37,8 +39,6 @@ Providers
 
       {{ optional_text_field(item.created_by_name, default='None') }}
 
-      {{ link_field('change', url_for('main.edit_provider', provider_id=item.id)) }}
-
   {% endcall %}
 
   <h2 class="heading-medium">Email</h2>
@@ -95,8 +95,6 @@ Providers
 
       {{ optional_text_field(item.created_by_name, default='None') }}
 
-      {{ link_field('change', url_for('main.edit_provider', provider_id=item.id)) }}
-
   {% endcall %}
 
 {% endblock %}

gulpfile.js

@@ -159,6 +159,7 @@ const javascripts = () => {
     paths.src + 'javascripts/colourPreview.js',
     paths.src + 'javascripts/templateFolderForm.js',
     paths.src + 'javascripts/collapsibleCheckboxes.js',
+    paths.src + 'javascripts/radioSlider.js',
     paths.src + 'javascripts/main.js'
   ])
   .pipe(plugins.prettyerror())

tests/app/main/views/test_providers.py

@@ -1,12 +1,15 @@
 import copy
 import re
 from datetime import datetime
+from unittest.mock import call
 
+import pytest
 from bs4 import BeautifulSoup
 from flask import url_for
 
 import app
 from app.main.views.providers import add_monthly_traffic
+from tests.conftest import normalize_spaces
 
 stub_providers = {
     'provider_details': [
@@ -79,12 +82,13 @@ stub_providers = {
             'id': '67c770f5-918e-4afa-a5ff-880b9beb161d',
             'active': False,
             'priority': 10,
-            'display_name': 'International SMS Provider (no flag)',
+            'display_name': 'Second International SMS Provider',
             'identifier': 'second_sms_international',
             'notification_type': 'sms',
             'updated_at': None,
             'version': 1,
             'created_by': None,
+            'supports_international': True,
             'current_month_billable_sms': 0,
         }
     ]
@@ -170,26 +174,24 @@ def test_should_show_all_providers(
     domestic_sms_first_row = domestic_sms_table.tbody.find_all('tr')[0]
     table_data = domestic_sms_first_row.find_all('td')
 
-    assert table_data[0].find_all("a")[0]['href'] == '/provider/6005e192-4738-4962-beec-ebd982d0b03f'
+    assert not table_data[0].find_all("a")
     assert table_data[0].text.strip() == "Domestic SMS Provider"
     assert table_data[1].text.strip() == "1"
     assert table_data[2].text.strip() == "42"
     assert table_data[3].text.strip() == "True"
     assert table_data[4].text.strip() == "16 January at 3:20pm"
     assert table_data[5].text.strip() == "Test User"
-    assert table_data[6].find_all("a")[0]['href'] == '/provider/6005e192-4738-4962-beec-ebd982d0b03f/edit'
 
     domestic_sms_second_row = domestic_sms_table.tbody.find_all('tr')[1]
     table_data = domestic_sms_second_row.find_all('td')
 
-    assert table_data[0].find_all("a")[0]['href'] == '/provider/0bd529cd-a0fd-43e5-80ee-b95ef6b0d51f'
+    assert not table_data[0].find_all("a")
     assert table_data[0].text.strip() == "Second Domestic SMS Provider"
     assert table_data[1].text.strip() == "2"
     assert table_data[2].text.strip() == "58"
     assert table_data[3].text.strip() == "True"
     assert table_data[4].text.strip() == "None"
     assert table_data[5].text.strip() == "None"
-    assert table_data[6].find_all("a")[0]['href'] == '/provider/0bd529cd-a0fd-43e5-80ee-b95ef6b0d51f/edit'
 
     domestic_email_first_row = domestic_email_table.tbody.find_all('tr')[0]
     domestic_email_table_data = domestic_email_first_row.find_all('td')
@@ -224,7 +226,6 @@ def test_should_show_all_providers(
     assert table_data[2].text.strip() == "False"
     assert table_data[3].text.strip() == "None"
     assert table_data[4].text.strip() == "None"
-    assert table_data[5].find_all("a")[0]['href'] == '/provider/67c770f5-918e-4afa-a5ff-880b9beb161d/edit'
 
 
 def test_add_monthly_traffic():
@@ -406,3 +407,143 @@ def test_should_show_provider_version_history(
     assert second_row[2].text.strip() == "None"
     assert second_row[3].text.strip() == "10"
     assert second_row[4].text.strip() == "True"
+
+
+def test_should_show_version_history_for_first_two_sms_providers(
+    client_request,
+    platform_admin_user,
+    mocker
+):
+    mocker.patch(
+        'app.provider_client.get_all_providers',
+        return_value=copy.deepcopy(stub_providers)
+    )
+    # second_sms_international will be the primary provider because it’s
+    # the first in the list when reverse sorting the SMS providers
+    second_sms_international = stub_providers['provider_details'][5]
+    mocker.patch(
+        'app.provider_client.get_provider_versions',
+        return_value={'data': [
+            {
+                'id': id,
+                'priority': priority,
+                'display_name': second_sms_international['display_name'],
+                'identifier': second_sms_international['identifier'],
+                'updated_at': updated_at,
+                'created_by': {
+                    'email_address': 'test@foo.bar',
+                    'name': 'Test User',
+                    'id': '7cc1dddb-bcbc-4739-8fc1-61bedde3332a'
+                },
+                'supports_international': False,
+            }
+            for updated_at, priority in [
+                (datetime(2022, 2, 22, 14).isoformat(), 100),
+                (datetime(2020, 1, 1, 5).isoformat(), 80),
+                (datetime(2020, 1, 1, 3).isoformat(), 10),
+                # Anything older than 11am on 29 November 2019
+                # should be ignored because the priority numbers
+                # didn’t mean the same thing before then
+                (datetime(2019, 11, 29, 10, 59).isoformat(), 123),
+                (datetime(2000, 1, 1, 0).isoformat(), 1999),
+                (None, 30),
+            ]
+        ]}
+    )
+
+    client_request.login(platform_admin_user)
+    page = client_request.get('main.edit_sms_provider_ratio')
+
+    assert [
+        radio['value']
+        for radio in page.select('input[name=ratio]')
+    ] == [
+        '100', '90', '80', '70', '60', '50', '40', '30', '20', '10', '0',
+    ]
+
+    assert [
+        radio['value']
+        for radio in page.select('input[checked]')
+    ] == [
+        str(second_sms_international['priority'])
+    ]
+
+    assert [
+        normalize_spaces(heading.text)
+        for heading in page.select('main h2')
+    ] == [
+        'Now',
+        '21 February 2022',
+        '31 December',
+    ]
+
+    assert [
+        normalize_spaces(version.text)
+        for version in page.select('li.history-list-item')
+    ] == [
+        (
+            'Test User 2:00pm '
+            'Second International SMS Provider 100% '
+            'Second Domestic SMS Provider 0%'
+        ),
+        (
+            'Test User 5:00am '
+            'Second International SMS Provider 80% '
+            'Second Domestic SMS Provider 20%'
+        ),
+        (
+            'Test User 3:00am '
+            'Second International SMS Provider 10% '
+            'Second Domestic SMS Provider 90%'
+        ),
+    ]
+
+
+@pytest.mark.parametrize('posted_number, expected_calls', [
+    (
+        '10',
+        [
+            call(stub_providers['provider_details'][5]['id'], 10),
+            call(stub_providers['provider_details'][1]['id'], 90),
+        ],
+    ),
+    (
+        '80',
+        [
+            call(stub_providers['provider_details'][5]['id'], 80),
+            call(stub_providers['provider_details'][1]['id'], 20),
+        ],
+    ),
+])
+def test_should_update_priority_of_first_two_sms_providers(
+    client_request,
+    platform_admin_user,
+    mocker,
+    posted_number,
+    expected_calls,
+):
+    mocker.patch(
+        'app.provider_client.get_all_providers',
+        return_value=copy.deepcopy(stub_providers)
+    )
+    mocker.patch(
+        'app.provider_client.get_provider_versions',
+        return_value={'data': []}
+    )
+    mock_update_provider = mocker.patch(
+        'app.provider_client.update_provider'
+    )
+
+    client_request.login(platform_admin_user)
+    client_request.post(
+        '.edit_sms_provider_ratio',
+        _data={
+            'ratio': posted_number,
+        },
+        _expected_redirect=url_for(
+            '.edit_sms_provider_ratio',
+            _external=True,
+        ),
+    )
+
+    assert mock_update_provider.call_args_list == expected_calls