-
Notifications
You must be signed in to change notification settings - Fork 687
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
Rename journalist key routes #5651
Rename journalist key routes #5651
Conversation
Thanks @DrGFreeman for your contribution. This PR will need a rebase on latest develop to include the changes to from #5648 to get all CI tests passing. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Test plan passes, but it would be a good idea to include a redirect from the old /journalist-key
to the new /public-key
in case its in use anywhere. See patch in comment for simplest approach.
Rename why-journalist-key and journalist-key routes of the Source Interface to why-public-key and public-key respectively. This aligns the route names with the language used in the associated pages where "public key" is used to designate the SecureDrop Submission Key of the instance.
Restore /journalist-key and redirect it to public-key in case it may be used or linked by instances or sources. Add a test to verify the redirect.
dc121a9
to
57c141a
Compare
@zenmonkeykstop, thanks for the feedback. Good points that I'll consider in future PRs. I restored the Note that the default return type of I rebased the branch as requested by @emkll. I intended to do it before submitting the PR but I forgot. 😕 |
Codecov Report
@@ Coverage Diff @@
## develop #5651 +/- ##
===========================================
+ Coverage 53.10% 53.13% +0.03%
===========================================
Files 50 50
Lines 5928 5932 +4
Branches 530 531 +1
===========================================
+ Hits 3148 3152 +4
Misses 2678 2678
Partials 102 102
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM! Thanks for adding in the 301 on the old path.
Status
Ready for review
Description of Changes
Fixes #4421
Changes proposed in this pull request:
Rename
why-journalist-key
andjournalist-key
routes of the Source Interface towhy-public-key
andpublic-key
respectively. This aligns the route names with the language used in the associated pages where "public key" is used to designate the SecureDrop Submission Key of the instance.Also rename the functions associated with the routes.
Maintain the
journalist-key
and redirect it topublic-key
in case it is used or linked by instance owners or sources. Add a unit test to verify the redirect.Testing
How should the reviewer test this PR?
Write out any special testing steps here.
/lookup
./public-key
./why-public-key
page loads./public-key
./journalist-key
.Deployment
Any special considerations for deployment? Consider both:
Checklist
If you made changes to the server application code:
make lint
) and tests (make test
) pass in the development containerIf you made changes to
securedrop-admin
:make -C admin test
) pass in the admin development containerIf you made changes to the system configuration:
If you made non-trivial code changes:
Choose one of the following:
Ref.: Source Interface /journalist-key route is being deprecated, update references to /public-key securedrop-docs#111, Update reference to Source Interface /journalist-key route securedrop-docs#112
If you added or updated a code dependency:
Choose one of the following: