Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove "Refresh codename" feature #6195

Merged
merged 1 commit into from
Dec 10, 2021
Merged

Remove "Refresh codename" feature #6195

merged 1 commit into from
Dec 10, 2021

Conversation

eloquence
Copy link
Member

@eloquence eloquence commented Dec 10, 2021

Status

Ready for review

Description

Removes the "Refresh" icon from the page that presents a source with a seven word codename. In practice, this feature has potential for user confusion, as it introduces complexity to a critical step of the submission process while delivering minimal end user value.

One key motivation for this feature has been the occasional generation of problematic words in codenames. We have already iterated over the wordlists several times, and will continue to do so.

Testing

  1. Log into the Source Interface
  2. Verify that there no longer is an icon to refresh the codename

Deployment

Note that this PR removes an image from the package, which is also removed from the AppArmor allow-list.

Checklist

If you made changes to the server application code:

  • Linting (make lint) and tests (make test) pass in the development container

If you made changes to securedrop-admin:

  • Linting and tests (make -C admin test) pass in the admin development container

If you made changes to the system configuration:

If you added or removed a file deployed with the application:

  • I have updated AppArmor rules to include the change

If you made non-trivial code changes:

  • I have written a test plan and validated it for this PR

Choose one of the following:

  • I have opened a PR in the docs repo for these changes, or will do so later
  • I would appreciate help with the documentation
  • These changes do not require documentation

In practice, this feature has potential for user confusion, as a critical
step of the submission process while delivering minimal end user value.

One key motivation for this feature has been the occasional generation
of problematic words in codenames. We have already iterated over
the wordlists several times, and will continue to do so.

Reloading will also continue to work just fine.
@eloquence eloquence marked this pull request as ready for review December 10, 2021 06:47
@eloquence eloquence requested a review from a team as a code owner December 10, 2021 06:47
@@ -47,7 +47,7 @@ def _source_clicks_submit_documents_on_homepage(self):
assert self._is_on_generate_page()

def _source_regenerates_codename(self):
self.safe_click_by_id("regenerate-submit")
self.driver.refresh()
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From my read, test_refreshed_duplicate_generate_pages is still useful even without the "refresh codename" feature (for example, it tests that the user is redirected to the lookup page when they have already logged in in a separate tab), so I have simply altered the behavior here to reload the page instead.

@eloquence
Copy link
Member Author

For context, @zenmonkeykstop, @ninavizz and I identified this as a potential "quick win" on the path towards improving the source user experience, prior to bigger changes such as overhauling/inverting the authentication flow and retiring the term "codename".

Copy link
Contributor

@zenmonkeykstop zenmonkeykstop left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, quick wins ftw.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants