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

OCPBUGS-44505: remove crypto-browserify library and use Crypto instead #14507

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

Mylanos
Copy link
Contributor

@Mylanos Mylanos commented Nov 18, 2024

This PR replaces the use of crypto-browserify for generating a hash for a given username with the native Crypto object and its subtle.digest method, which is supported in all browsers compatible with v4.18. This way we not only remove unnecessary dependencies, but also use browser-optimized native cryptographic functionality.

Changes in this PR:

  • Replaced crypto-browserify's createHash function with a newly implemented generateHash function that utilizes browser-native Crypto.subtle.digest.
  • Removed crypto-browserify from the dependencies as this was its sole usage in the codebase.

Analysis:
The way we generated the hashes inside of the useSelector hook call for userUid retrieval, had to be refined as the subtle.digest returns a Promise and the useSelector hook should remain synchronous by design. I split the hook call into two parts, where the first part only retrieves the userImpersonateNameOrUID and the second one username. The username contents change is used to active an effect which generates its unique identifier/hash into uniqueUsername. The userUid is then initialized based on the prior implementation userImpersonateNameOrUID || uniqueUsername.

@openshift-ci-robot openshift-ci-robot added jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Nov 18, 2024
@openshift-ci-robot
Copy link
Contributor

@Mylanos: This pull request references Jira Issue OCPBUGS-44505, which is invalid:

  • expected the bug to target the "4.18.0" version, but no target version was set

Comment /jira refresh to re-evaluate validity if changes to the Jira bug are made, or edit the title of this pull request to link to a different bug.

The bug has been updated to refer to the pull request using the external bug tracker.

In response to this:

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot added the component/shared Related to console-shared label Nov 18, 2024
@Mylanos Mylanos force-pushed the crypto-browserify-removal-attempt branch from abdbd47 to c771cf1 Compare November 19, 2024 11:56
@Mylanos
Copy link
Contributor Author

Mylanos commented Nov 19, 2024

/jira refresh

@openshift-ci-robot openshift-ci-robot added jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. and removed jira/invalid-bug Indicates that a referenced Jira bug is invalid for the branch this PR is targeting. labels Nov 19, 2024
@openshift-ci-robot
Copy link
Contributor

@Mylanos: This pull request references Jira Issue OCPBUGS-44505, which is valid. The bug has been moved to the POST state.

3 validation(s) were run on this bug
  • bug is open, matching expected state (open)
  • bug target version (4.18.0) matches configured target version for branch (4.18.0)
  • bug is in the state ASSIGNED, which is one of the valid states (NEW, ASSIGNED, POST)

Requesting review from QA contact:
/cc @yapei

In response to this:

/jira refresh

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci bot requested a review from yapei November 19, 2024 12:16
@cyril-ui-developer
Copy link
Contributor

/retest

2 similar comments
@Mylanos
Copy link
Contributor Author

Mylanos commented Nov 21, 2024

/retest

@Mylanos
Copy link
Contributor Author

Mylanos commented Nov 22, 2024

/retest

Copy link
Contributor

openshift-ci bot commented Nov 22, 2024

@Mylanos: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name Commit Details Required Rerun command
ci/prow/e2e-gcp-console c771cf1 link true /test e2e-gcp-console

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

Copy link
Member

@spadgett spadgett left a comment

Choose a reason for hiding this comment

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

/lgtm

👍

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 22, 2024
Copy link
Contributor

openshift-ci bot commented Nov 22, 2024

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Mylanos, spadgett

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@openshift-ci openshift-ci bot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. component/shared Related to console-shared jira/valid-bug Indicates that a referenced Jira bug is valid for the branch this PR is targeting. jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants