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

Rename "security key" into "recovery key" #29217

Merged
merged 6 commits into from
Feb 10, 2025

Conversation

florianduros
Copy link
Member

@florianduros florianduros commented Feb 7, 2025

Checklist

  • Tests written for new code (and old code if feasible).
  • New or updated public/exported symbols have accurate TSDoc documentation.
  • Linter and other CI checks pass.
  • I have licensed the changes to Element by completing the Contributor License Agreement (CLA)

Task #26468
Rename "security key" into "recovery key". I didn't rename the i18n keys to avoid a huge change in all the translations.

@florianduros florianduros force-pushed the florianduros/security-key-to-recovery-key branch from 71093f1 to 044313c Compare February 7, 2025 14:47
Copy link
Member

@dbkr dbkr left a comment

Choose a reason for hiding this comment

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

Wow, there were quite a few of these.

Copy link
Member

@andybalaam andybalaam left a comment

Choose a reason for hiding this comment

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

WOOHOO! I am guessing you are deliberately updating strings that are usually controlled by localazy?

@florianduros
Copy link
Member Author

florianduros commented Feb 10, 2025

@andybalaam en_EN.json strings are not directly managed by localazy. They are the source of truth of the translations.

@florianduros florianduros added this pull request to the merge queue Feb 10, 2025
Merged via the queue into develop with commit 047e8e8 Feb 10, 2025
31 checks passed
@florianduros florianduros deleted the florianduros/security-key-to-recovery-key branch February 10, 2025 17:04
@richvdh
Copy link
Member

richvdh commented Feb 10, 2025

Related: #27713

@richvdh
Copy link
Member

richvdh commented Feb 10, 2025

I've got a few concerns about merging this as it is:

  1. People may not realise that they can continue to use a "Security Key" where we now ask for a "Recovery Key". Of course, without this change, we have the opposite problem, so this is a weak argument, but...

  2. Having "Security Key" littered throughout the codebase is actually quite a good guide for places we need to make sure we update properly to align with new designs. With a blanket s/Security Key/Recovery Key/, we lose this discriminator.

  3. This introduces a new inconsistency between "Security Phrase" and "Recovery Key". For example, we now have this dialog:
    image

    What do I do if I think I have a "Recovery Phrase"? I think I would probably click on the link, because I would focus on the "Recovery" bit rather than the "Security" bit. However, that is the wrong thing to do.

In short, I think I'd prefer an approach where we update each dialog/flow in turn to ensure that they use modern designs and copy.

Let's discuss further with @mxandreas.

@mxandreas
Copy link

In short, I think I'd prefer an approach where we update each dialog/flow in turn to ensure that they use modern designs and copy

@richvdh I am afraid we do not have an ideal (normal) solution here, because we already have updated some flows (like setting up recovery which talks about recovery key only), so one way or the other we have problem. Especially I am guessing that some models are re-used between flows.

The ideal would be to update all the modals to the new designs indeed where we take care of the "backward compatibility" (by saying that security key works, too); but it seems we struggle to afford it at once.

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.

5 participants