Add maintenance window notification for Acuant (LG-3451) by zachmargolis · Pull Request #4202 · 18F/identity-idp

zachmargolis · 2020-09-15T19:48:44Z

During the maintenance window, the sign-in page will look like:

And the proofing page will look like:

Instead of what it normally looks like:

zachmargolis · 2020-09-15T19:49:46Z

app/views/idv/cac/choose_method.html.erb

+<%= render 'shared/maintenance_window_alert' do %>
+  <h1 class="h3 mt0 mb1"><%= t('cac_proofing.headings.choose_method') %></h1>


this is just indenting & wrapping in a block (recommend that you hide whitespace for this diff)

zachmargolis · 2020-09-15T19:49:54Z

app/views/idv/doc_auth/welcome.html.erb

+<%= render 'shared/maintenance_window_alert' do %>
+  <h1 class='h3 my0'><%= t('doc_auth.headings.welcome') %></h1>


ditto, this is just indenting & wrapping in a block (recommend that you hide whitespace for this diff)

zachmargolis · 2020-09-15T19:50:39Z

app/views/shared/_maintenance_window_alert.html.erb

+    start: Figaro.env.acuant_maintenance_window_start,
+    finish: Figaro.env.acuant_maintenance_window_finish,


In the future, we can make these start/end variables we pass in, but I figured for the time being, we have just the one maintenance window, so I hardcoded it here

aduth · 2020-09-15T19:58:00Z

app/views/shared/_maintenance_window_alert.html.erb

+  <div class="usa-alert usa-alert--warning margin-bottom-2">
+    <div class="usa-alert__body">
+      <div class="usa-alert__text">
+        <p>
+          <%= t('notices.maintenance.currently_under_maintenance_html',
+                finish: l(maintenance_window.finish,
+                          format: t('time.formats.event_timestamp_with_zone'))) %>
+        </p>
+        <p class="margin-bottom-0">
+          <%= t('notices.maintenance.need_assistance') %>
+          <%= link_to(t('notices.maintenance.contact_us'), MarketingSite.contact_url) %>
+        </p>
+      </div>
+    </div>
+  </div>


Would it be possible to reuse the _alert.html.erb partial here?

Suggested change

<div class="usa-alert usa-alert--warning margin-bottom-2">

<div class="usa-alert__body">

<div class="usa-alert__text">

<p>

<%= t('notices.maintenance.currently_under_maintenance_html',

finish: l(maintenance_window.finish,

format: t('time.formats.event_timestamp_with_zone'))) %>

</p>

<p class="margin-bottom-0">

<%= t('notices.maintenance.need_assistance') %>

<%= link_to(t('notices.maintenance.contact_us'), MarketingSite.contact_url) %>

</p>

</div>

</div>

</div>

<%= render 'shared/alert', { type: 'warning', class: 'margin-bottom-2' } do %>

<p>

<%= t('notices.maintenance.currently_under_maintenance_html',

finish: l(maintenance_window.finish,

format: t('time.formats.event_timestamp_with_zone'))) %>

</p>

<p class="margin-bottom-0">

<%= t('notices.maintenance.need_assistance') %>

<%= link_to(t('notices.maintenance.contact_us'), MarketingSite.contact_url) %>

</p>

<% end %>

I guess if we're using <div> for .usa-alert__text, it won't work to nest the paragraphs. But I think it's something where either we shouldn't be using it that way, or we could update the alert partial to support multiple paragraphs of content like this.

Oh duh, I forgot that partial existed 🙈

Two ideas:

I could just add two <br />s to be able to reuse the <p> (booooo)

I could make a local param for alert_text_tag that defaults to <p> and override it to div here?

I went for (2) in ce2c963, WDYT?

Seems reasonable to me. It got me wondering if there's really much effect to using p over div, as in whether we could just default to div. I think there's some value in having the semantics associated with a paragraph, though I'm not sure there's actually any practical difference one way or the other.

There's also another option where the block usage could assume more advanced HTML, use div as default, and assume the developer will pass one (or more) <p> tags. The message parameter could be reserved for simple strings and use p as the default wrapper.

But as I sit here trying to explain it, it sounds like it might be more complicated than it is worthwhile 😄

We only use shared/alert in 3 places..... let's not make it that complicated yet

Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov>

app/services/maintenance_window.rb

config/locales/notices/en.yml

app/views/shared/_maintenance_window_alert.html.erb

Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov>

mitchellhenke

👍🏼

Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov>

* Notify via email when resetting password from RISC (LG-3120) (#4177) * Combine reset password classes * Remove rake task and script * Update email copy * Remove docker branch builds, leave "build-release-container" (#4181) * convert idv cac success template to erb * convert backup code setup confirm delete template to erb * convert backup code setup confirm edit template to erb * convert piv cac auth setup error template to erb * Add more randomness to Agency factories (#4186) **Why**: We have a unique index on agency name * fix: Gemfile & Gemfile.lock to reduce vulnerabilities (#4187) The following vulnerabilities are fixed with an upgrade: - https://snyk.io/vuln/SNYK-RUBY-ACTIONVIEW-632514 * refactor account page a bit * placeholder * lint * rubocop * add redirect * fix backup codes spec * add translations to mobile menu * move two factor to own controller * move connected accounts to own controller * move history to own controller * fix indent * fix menu not showing on tablets * fix some specs * fix some specs * rubocop * fix greeting and header nav * fix more specs * double quotes in html attributes * update redirects for piv/cac setup * use USWDS breakpoints * convert navigation class method to being instantiated * rubocop * csscop * fix piv cac spec * remove semi-circle from user-access image * internationalization for new account banner * normalize yaml * update events page to align with new account page design * review changes * LG-3118 Fix bugs discovered while testing AAL3 flows (#4182) This commit fixes 2 bugs: 1.) The WebAuthn setup was not marking the session as AAL3, so the user was needed to interact with their token twice 2.) The "Don't have your <method>" text was appearing on the PIV/WebAuthn verification screen when the user did not have an option to change methods * LG-3334: Support failure testing for document capture in development environments (#4173) * Allow AcuantCapture to receive non-image files in non-production environments **Why**: As a developer, I expect that I can upload files which simulate expected failures which can occur during document capture, so that I can reliably test non-happy-path flows. * Return error from YAML in non-production image upload * rubocop * Fix client test specs * Pass mock client as detail to root upload context * Pass through non-image files to client implementation See: https://github.com/18F/identity-idp/pull/4173/files#r485970570 * Remove unused i18n keys * update user access svg to hide bottom corners * LG-3118 Update the webauthn verification headers (#4190) This was discovered during LG-3118. The headers on the WebAuthn verification screen are supposed to ask you to connect instead of present your key. * Separate links to Privacy Act Statement from Practices (LG-3467) (#4188) * update banner to for mobile design changes * LG-873 Add x509_issuer to piv/cac response data for OIDC (#4174) * Change "Sign in" to "Continue" on user authorization confirmation (#4189) This was found as part of LG-3118. The "Sign in" button on this page should say "Continue". While I was in there I noticed the rest of the text on the page was not translated so I went ahead and took care of that. * LG-3342: Rate limit image uploads during doc auth API response (#4185) * LG-3342: Rate limit image uploads during doc auth API response **Why:** As a legitimate user doing doc auth, I want the image uploads in the react flow to be uploaded, so that users attempting to steal an identity have a harder time proofing. * Pass image form status as argument to render_form_response * Memoize image upload form throttle increment to avoid duplicate counting * Increment throttle by submission See: #4185 (comment) * Assign fallback status at time of use See: #4185 (comment) Co-Authored-By: Zach Margolis <zbmargolis@gmail.com> * Create ImageUploadResponsePresenter to handle image upload response * Add test spec for ImageUploadResponsePresenter Co-authored-by: Zach Margolis <zbmargolis@gmail.com> * do not show account banner on mobile * Forget remembered browsers after RISC password reset (LG-3120) (#4195) * Update CSS style guide image path (#4198) * LG-3294 Replace raw NET::HTTP with Faraday equivalent. (#4197) LG-3294 Replace raw NET::HTTP with Faraday equivalent for the piv_cac_service. * Add maintenance window notification for Acuant (LG-3451) (#4202) Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov> * LG-3320 Prevent uploading selfie (#4199) * Use image-path CSS helper function to cache asset (#4203) * LG-3463: Rate limit image uploads during doc auth: Client response (#4193) * LG-3463: Rate limit image uploads during doc auth: Client response **Why**: As a user who has exceeded the allowable limit of doc auth attempts, I expect to be presented with a message explaining why I'm no longer able to submit my documents. With these changes, when the client detects there are no more attempts, the user is redirected to the error state. See: #4185 (LG-3342) * Return redirect URL in 429 response * Update test spec * Use ref callback to initialize FullScreen modal focus trap (#4200) **Why**: This may resolve an issue where focus trap's event handling is not removed after a FullScreen dialog is hidden, under the assumption that the previous implementation could leave potential for desync between modalRef and useEffect, or between the useEffect's unsubscribe behavior and trapRef.current.deactivate. * LG-3487: Remove file size validation for doc auth images (#4205) **Why**: As a user, I expect that even if my mobile device captures photos with low quality, I will be allowed to submit them in case Acuant will still select them, so that I am not blocked from proofing. * LG-3473: Log analytics for the image upload API (#4201) * LG-3473: Log analytics for the image upload API **Why**: As a user, I want login.gov to log analytics for the doc auth image upload API, so that if I am having an issue the login.gov team can debug it * rubocop * Log analytics using analytics.track_event * Rename doc auth image upload analytics constants **Why**: Clarity * Omit braces in last hash arguments **Why**: See #4201 (comment) * Tweak PIV/CAC and WebAuthn verification controllers (#4191) This was a discovery during LG-3118. This commit has 2 fixes: 1. The presenters renders the help text for AAL3 only when the user could only use the current method. They should render the help text if an AAL3 sign in is required 2. Remove duplicate paragraph from the PIV/CAC screen * Remove redundant "Connect your key" header (#4204) **Why**: We changed the context of the header on the page, making this header duplicative * Remove unused "verify-modal" JavaScript pack (#4210) **Why**: #2259 replaced modal dialogs with dedicated alert screens, and this code is now unused. * LexisNexis doc_auth client now available for use (LG-3263) (#4184) * LexisNexis doc_auth client now available for use (LG-3263) Co-authored-by: amathews <amathews@fearsol.com> * LG-3476: Upgrade focus-trap from ^2.3.0 (2.4.6) to 6.0.1 (#4211) * Upgrade focus-trap from ^2.3.0 (2.4.6) to 6.0.1 * Simplify components index file **Why**: - Exports unused - TrapModal variable as pass-through is unnecessary, since direct access to Modal import is available * Remove proxyquire (#4212) **Why**: While occasionally useful to mock out the behavior of underlying modules, it can give a false sense of security that the behavior of a mocked implementation will match the experience and expectations of the user-facing behavior. * Fix mobile nav rendering (#4209) * make sure nav is rendered in a valid place * render mobile nav as child of body * Update app/views/layouts/base.html.erb Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov> * add usa-overlay div * add title to new account pages Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov> * Remove unused "if checked" JavaScript form validation (#4214) * Remove unused submit auto-enable form validation (#4216) **Why**: While some forms implement custom auto-enable behavior for submit buttons, they do so by bypassing the default auto-enable behavior. There does not appear to be any instances of forms which rely on this core behavior. * LG-3339: Extract submit-with-spinner pack from form-validation.js (#4219) * Extract submit-with-spinner pack from form-validation.js * Add comment for custom event dispatching * Define element-closest as dependency of polyfill package * Convert a few more templates to erb (#4220) * convert edit password templates to erb * convert event disavowal new template to erb * convert pii_review template to erb * convert idv review new template to erb * Update app/views/shared/_pii_review.html.erb Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com> * Update app/views/shared/_pii_review.html.erb Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com> * Update app/views/shared/_pii_review.html.erb Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com> * Update app/views/shared/_pii_review.html.erb Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com> * remove extra space * fix specs Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com> * update rubocop to 0.91.0 (#4218) * Convert some more slim templates (#4222) * remove unused code in layout * convert idv come back later template to erb * convert verify_personal_key template to erb * convert devise passwords new template to erb * convert page took too long template to erb * convert in person find usps template to erb * fix unnecessary space * Use Acuant SDK for selfie capture (#4224) * Use AcuantPassiveLiveness for mobile selfie capture * Cache image data blob * Fix test specs * LG-3339: Make functionality in form-validation.js opt-in (#4221) * LG-3339: Make functionality in form-validation.js opt-in **Why**: As a developer, I want the behavior of forms to be predictable and enable automatic validations only when intended, so that I'm not caught in a situation where automatic validations occur unexpectedly and break user behavior. * Pass through simple_form_for arguments as given * Rename idp_simple_form_for as validated_form_for * Print form validation script once with data attribute * Explicitly include Webpacker helper * Print javascript_pack_tag using variadic arguments * Add test spec for form-validation script * Add test spec for script helper * Rename print_javascript_pack_once_tags to render_javascript_pack_once_tags * Use validated_form_for globally * Preserve this reference in I18n calls * Substitute classlist.js with classlist-polyfill (#4225) * Pass fields used to check if liveness is enabled to the hybrid flow (LG-3471) (#4223) Pass fields used to check if liveness is enabled to the hybrid flow (LG-3471) * LG-3543 Update doc captures to avoid showing the selfie in the hybrid… (#4230) The selfie step currently appears in the hybrid flow even if SPs don't request it. This commit backports the changes from #4223 to the old doc captures table so this bug is fixed for the old liveness flow. Co-authored-by: Doug Price <dprice@fearless.tech> Co-authored-by: Zach Margolis <zachmargolis@users.noreply.github.com> Co-authored-by: Mitchell Henke <mitchell.henke@gsa.gov> Co-authored-by: Snyk bot <snyk-bot@snyk.io> Co-authored-by: Jonathan Hooper <jonathan.hooper@gsa.gov> Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov> Co-authored-by: Steve Urciuoli <steve.urciuoli@gsa.gov> Co-authored-by: Zach Margolis <zbmargolis@gmail.com> Co-authored-by: Shade L. Jenifer <shade.jenifer@gsa.gov> Co-authored-by: Alex Mathews <44584810+amathews-fs@users.noreply.github.com>

Originally added in #4202 (LG-3451), this work has been superceded by the `vendor_status_acuant` flag as described in [the handbook](https://handbook.login.gov/articles/vendor-outage-response-process.html) changelog: Internal, Cleanup, Remove acuant_maintenance_window configs

* Remove acuant_maintenance_window configs Originally added in #4202 (LG-3451), this work has been superceded by the `vendor_status_acuant` flag as described in [the handbook](https://handbook.login.gov/articles/vendor-outage-response-process.html) changelog: Internal, Cleanup, Remove acuant_maintenance_window configs * Remove more references to maintenance window * Remove more unused translations

- Redo of #4202 after it was removed in #8858, to fit with current vendor maintenance configuration changelog: Internal, Vendor outages, Add config to schedule IDV maintenance

* Add scheduled IDV maintenance to OutageStatus - Redo of #4202 after it was removed in #8858, to fit with current vendor maintenance configuration * DRY some analytics changelog: Internal, Vendor outages, Add config to schedule IDV maintenance

Add maintenance window notification for Acuant (LG-3451)

1740310

zachmargolis requested review from jmhooper, mitchellhenke and stevegsa September 15, 2020 19:48

zachmargolis commented Sep 15, 2020

View reviewed changes

zachmargolis requested a review from aduth September 15, 2020 19:51

aduth reviewed Sep 15, 2020

View reviewed changes

zachmargolis and others added 3 commits September 15, 2020 13:07

Update app/views/shared/_maintenance_window_alert.html.erb

babcd4a

Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov>

Update shared/_alert to accept custom tag names

ce2c963

Add in default maintenance window values

6657954

jmhooper approved these changes Sep 15, 2020

View reviewed changes

aduth approved these changes Sep 15, 2020

View reviewed changes

app/services/maintenance_window.rb Outdated Show resolved Hide resolved

config/locales/notices/en.yml Outdated Show resolved Hide resolved

app/views/shared/_maintenance_window_alert.html.erb Show resolved Hide resolved

zachmargolis and others added 3 commits September 15, 2020 13:47

Update config/locales/notices/en.yml

ec94123

Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov>

Update app/services/maintenance_window.rb

05a973b

Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov>

rubocop: trailing whitespace

ea4836e

mitchellhenke approved these changes Sep 15, 2020

View reviewed changes

Fix a few more typos

cb1075b

zachmargolis added the status - ready for review label Sep 15, 2020

zachmargolis merged commit 85ee0e2 into master Sep 15, 2020

zachmargolis deleted the margolis-outage-alert branch September 15, 2020 21:26

zachmargolis added a commit that referenced this pull request Sep 15, 2020

Add maintenance window notification for Acuant (LG-3451) (#4202)

8515387

Co-authored-by: Andrew Duthie <andrew.duthie@gsa.gov>

This was referenced Sep 15, 2020

Deploy RC 118.1 to Staging #4206

Merged

Deploy RC 118.1 to Prod #4207

Merged

matthinz mentioned this pull request Jul 25, 2023

Remove acuant_maintenance_window configs #8858

Merged

zachmargolis mentioned this pull request Nov 6, 2023

Bring back scheduled IDV maintenance (LG-11306) #9552

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add maintenance window notification for Acuant (LG-3451)#4202

Add maintenance window notification for Acuant (LG-3451)#4202
zachmargolis merged 8 commits intomasterfrom
margolis-outage-alert

zachmargolis commented Sep 15, 2020

Uh oh!

zachmargolis Sep 15, 2020

Uh oh!

zachmargolis Sep 15, 2020

Uh oh!

zachmargolis Sep 15, 2020

Uh oh!

aduth Sep 15, 2020

Uh oh!

zachmargolis Sep 15, 2020

Uh oh!

zachmargolis Sep 15, 2020

Uh oh!

aduth Sep 15, 2020

Uh oh!

zachmargolis Sep 15, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mitchellhenke left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

		<%= render 'shared/maintenance_window_alert' do %>
		<h1 class="h3 mt0 mb1"><%= t('cac_proofing.headings.choose_method') %></h1>

		<%= render 'shared/maintenance_window_alert' do %>
		<h1 class='h3 my0'><%= t('doc_auth.headings.welcome') %></h1>

		start: Figaro.env.acuant_maintenance_window_start,
		finish: Figaro.env.acuant_maintenance_window_finish,

Conversation

zachmargolis commented Sep 15, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mitchellhenke left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants