You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR solves the issue by showing an error/warning toast message to already existing users on the waitlist. Before this PR, every user with a single email was getting the success toast message multiple times. Ideally, this should not happen, every user should be able to join the waitlist one time through one email. This PR fixes this problem.
Clear the text field after adding the user to the waitlist
Check if user has already been whitelisted
Not compliant requirements:
Perform validation on the email field
Only show toast when the whitelist response is successful
⏱️ Estimated effort to review: 2 🔵🔵⚪⚪⚪
🧪 No relevant tests
🔒 No security concerns identified
⚡ Recommended focus areas for review
Email Validation The PR adds a check for already waitlisted users but doesn't implement proper email validation as required by the ticket.
Toast Handling The PR doesn't address the requirement to show toast only when the whitelist response is successful. The toast is shown for already waitlisted users, but not for successful additions.
Add negative test cases for invalid Shopify token patterns
Consider adding negative test cases for inputs that partially match the Shopify token patterns but are invalid. This will help ensure the regex doesn't produce false positives.
Why: Including negative test cases for invalid Shopify token patterns is valuable for ensuring the regex does not produce false positives, thus improving the reliability and accuracy of the tests.
8
Add a test case for an input with an invalid prefix to ensure correct token identification
Consider adding a test case for an input that matches the pattern but has an invalid prefix (not 'pat', 'sat', or 'shppa'). This will help ensure the regex is correctly identifying only valid Harness tokens.
Why: Adding a test case for an input with an invalid prefix helps verify that the regex correctly identifies only valid tokens, enhancing the accuracy and robustness of the test suite.
8
Add a negative test case for input that partially matches the pattern
Consider adding a negative test case for an input that starts with 'atlassian', 'confluence', or 'jira' but doesn't meet the length requirement of 24 characters.
Why: Adding a negative test case for inputs that partially match the pattern but do not meet the length requirement enhances the robustness of the test suite by ensuring the regex correctly identifies invalid inputs.
7
Performance
Use a Set for more efficient email lookup in the waitlist
Consider using a Set instead of an array for waitListedEmails to improve lookup performance when checking if an email is already waitlisted.
-const waitListedEmails: string[] = dataInStorage- ? (JSON.parse(dataInStorage) as string[])- : []+const waitListedEmails: Set<string> = dataInStorage+ ? new Set(JSON.parse(dataInStorage) as string[])+ : new Set()
// actual logic where we are checking if this email is already in waitlisted users or not
-if (waitListedEmails.includes(email)) {+if (waitListedEmails.has(email)) {
Apply this suggestion
Suggestion importance[1-10]: 8
Why: Using a Set instead of an array for storing waitlisted emails improves lookup performance, which is beneficial for checking if an email is already waitlisted. This change enhances the efficiency of the code without altering its functionality.
8
Best practice
Refactor localStorage operations into a separate function for better code organization
Move the localStorage operations into a separate function to improve code organization and reusability.
-const dataInStorage: string | null = localStorage.getItem('waitListData')-const waitListedEmails: string[] = dataInStorage- ? (JSON.parse(dataInStorage) as string[])- : []+const getWaitlistedEmails = (): string[] => {+ const dataInStorage: string | null = localStorage.getItem('waitListData')+ return dataInStorage ? JSON.parse(dataInStorage) as string[] : []+}-// actual logic where we are checking if this email is already in waitlisted users or not+const waitListedEmails = getWaitlistedEmails()+
if (waitListedEmails.includes(email)) {
toast.custom(() => (
<div className="text-brandBlue border-brandBlue/20 w-[90vw] rounded-lg border bg-[#852b2c] p-2 shadow-2xl backdrop-blur-3xl md:w-[20vw]">
<p className="text-sm">
You have been already added to the waitlist. We will notify you once
we launch.{' '}
</p>
</div>
))
return
}
Apply this suggestion
Suggestion importance[1-10]: 7
Why: Moving localStorage operations into a separate function improves code organization and reusability. This refactor enhances maintainability by encapsulating related logic, making the codebase cleaner and more modular.
7
Use a more descriptive variable name for test cases
Consider using a more descriptive variable name instead of testcase. For example, grafanaTestCases would be more specific and align with the function name.
Why: The suggestion to rename testcase to grafanaTestCases improves code readability and clarity by providing a more descriptive variable name that aligns with the function's purpose.
6
Use a more descriptive variable name for test cases
Consider using a more descriptive variable name instead of testcase. For example, facebookTestCases would be more specific and easier to understand in the context of this file.
Why: The suggestion to use a more descriptive variable name improves code readability and maintainability, but it is not critical to the functionality of the code.
5
Maintainability
Extract toast message into a separate component for better code organization
Extract the toast message into a separate component to improve code readability and maintainability.
-toast.custom(() => (+const AlreadyWaitlistedToast = () => (
<div className="text-brandBlue border-brandBlue/20 w-[90vw] rounded-lg border bg-[#852b2c] p-2 shadow-2xl backdrop-blur-3xl md:w-[20vw]">
<p className="text-sm">
You have been already added to the waitlist. We will notify you once
we launch.{' '}
</p>
</div>
-))+);+toast.custom(() => <AlreadyWaitlistedToast />)+
Apply this suggestion
Suggestion importance[1-10]: 6
Why: Extracting the toast message into a separate component improves code readability and maintainability. This change makes the code more organized and easier to manage, especially if the toast message needs to be reused or modified in the future.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
User description
Description
This PR solves the issue by showing an error/warning toast message to already existing users on the waitlist. Before this PR, every user with a single email was getting the success toast message multiple times. Ideally, this should not happen, every user should be able to join the waitlist one time through one email. This PR fixes this problem.
Fixes #463
Dependencies
No extra package used.
Screenshots of relevant screens
Developer's checklist
If changes are made in the code:
Documentation Update
PR Type
enhancement, other
Description
constfor immutable variables inworkspace-membership.ts.Changes walkthrough 📝
60 files
grafana.ts
Code formatting improvements for better readability.packages/secret-scan/src/rules/grafana.ts
grafanafunction andtestcasearray.authress.ts
Code formatting adjustments for consistency.packages/secret-scan/src/rules/authress.ts
authressfunction andtestcasearray.
cloudflare.ts
Improved code formatting for clarity.packages/secret-scan/src/rules/cloudflare.ts
cloudflarefunction andtestcasearray.
bitbucket.ts
Code formatting enhancements for readability.packages/secret-scan/src/rules/bitbucket.ts
bitbucketfunction andtestcasearray.
facebook.ts
Code formatting corrections for uniformity.packages/secret-scan/src/rules/facebook.ts
facebookfunction andtestcasearray.
confluent.ts
Code formatting improvements for consistency.packages/secret-scan/src/rules/confluent.ts
confluentfunction andtestcasearray.
atlassian.ts
Improved code formatting for better readability.packages/secret-scan/src/rules/atlassian.ts
atlassianfunction andtestcasearray.
shopify.ts
Code formatting corrections for clarity.packages/secret-scan/src/rules/shopify.ts
shopifyfunction andtestcasearray.harness.ts
Code formatting improvements for consistency.packages/secret-scan/src/rules/harness.ts
harnessfunction andtestcasearray.planetscale.ts
Improved code formatting for better readability.packages/secret-scan/src/rules/planetscale.ts
planetscalefunction andtestcasearray.
dropbox.ts
Code formatting corrections for clarity.packages/secret-scan/src/rules/dropbox.ts
dropboxfunction andtestcasearray.dynatrace.ts
Code formatting improvements for consistency.packages/secret-scan/src/rules/dynatrace.ts
dynatracefunction andtestcasearray.
digitalocean.ts
Improved code formatting for better readability.packages/secret-scan/src/rules/digitalocean.ts
digitaloceanfunction andtestcasearray.definednetworking.ts
Code formatting corrections for clarity.packages/secret-scan/src/rules/definednetworking.ts
definednetworkingfunction andtestcasearray.sidekiq.ts
Code formatting improvements for consistency.packages/secret-scan/src/rules/sidekiq.ts
sidekiqfunction andtestcasearray.intra42.ts
Improved code formatting for better readability.packages/secret-scan/src/rules/intra42.ts
intra42function andtestcasearray.
huggingface.ts
Code formatting corrections for clarity.packages/secret-scan/src/rules/huggingface.ts
huggingfacefunction andtestcasearray.
gitlab.ts
Code formatting improvements for consistency.packages/secret-scan/src/rules/gitlab.ts
gitlabfunction andtestcasearray.heroku.ts
Improved code formatting for better readability.packages/secret-scan/src/rules/heroku.ts
herokufunction andtestcasearray.
coinbase.ts
Code formatting corrections for clarity.packages/secret-scan/src/rules/coinbase.ts
coinbasefunction andtestcasearray.
frameio.ts
Code formatting improvements for consistency.packages/secret-scan/src/rules/frameio.ts
frameiofunction andtestcasearray.hubspot.ts
Improved code formatting for better readability.packages/secret-scan/src/rules/hubspot.ts
hubspotfunction andtestcasearray.
easypost.ts
Code formatting corrections for clarity.packages/secret-scan/src/rules/easypost.ts
easypostfunction andtestcasearray.
clojars.ts
Code formatting improvements for consistency.packages/secret-scan/src/rules/clojars.ts
clojarsfunction andtestcasearray.flutterwave.ts
Improved code formatting for better readability.packages/secret-scan/src/rules/flutterwave.ts
flutterwavefunction andtestcasearray.
contentful.ts
Code formatting corrections for clarity.packages/secret-scan/src/rules/contentful.ts
contentfulfunction andtestcasearray.
beamer.ts
Code formatting improvements for consistency.packages/secret-scan/src/rules/beamer.ts
beamerfunction andtestcasearray.doppler.ts
Improved code formatting for better readability.packages/secret-scan/src/rules/doppler.ts
dopplerfunction andtestcasearray.
duffel.ts
Code formatting corrections for clarity.packages/secret-scan/src/rules/duffel.ts
duffelfunction andtestcasearray.datadog.ts
Code formatting improvements for consistency.packages/secret-scan/src/rules/datadog.ts
datadogfunction andtestcasearray.lob.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/lob.ts
sendinblue.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/sendinblue.ts
hashicorp.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/hashicorp.ts
databricks.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/databricks.ts
index.ts
Uniform import statement quotation stylepackages/secret-scan/src/rules/index.ts
age.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/age.ts
readme.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/readme.ts
postman.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/postman.ts
scalingo.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/scalingo.ts
linear.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/linear.ts
infracost.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/infracost.ts
rubygems.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/rubygems.ts
asana.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/asana.ts
prefect.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/prefect.ts
pulumi.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/pulumi.ts
shippo.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/shippo.ts
update.role.ts
Logger message quotation style updateapps/cli/src/commands/workspace/role/update.role.ts
list.environment.ts
Improved readability of destructuring assignmentsapps/cli/src/commands/environment/list.environment.ts
get.role.ts
Logger message quotation style updateapps/cli/src/commands/workspace/role/get.role.ts
codecov.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/codecov.ts
page.tsx
Improved readability of import statementsapps/platform/src/app/auth/page.tsx
delete.environment.ts
Improved readability of destructuring assignmentsapps/cli/src/commands/environment/delete.environment.ts
list.workspace.ts
Consistent use of `type` keyword in importsapps/cli/src/commands/workspace/list.workspace.ts
typekeyword to import statements for consistency.bittrex.ts
Code formatting improvements for consistencypackages/secret-scan/src/rules/bittrex.ts
update.environment.ts
Improved readability of destructuring assignmentsapps/cli/src/commands/environment/update.environment.ts
get.environment.ts
Improved readability of destructuring assignmentsapps/cli/src/commands/environment/get.environment.ts
list.role.ts
Consistent use of `type` keyword in importsapps/cli/src/commands/workspace/role/list.role.ts
typekeyword to import statements for consistency.page.tsx
Consistent import statement orderingapps/web/src/app/(main)/career/page.tsx
ColorBGSVGfor consistency.airtable.ts
Ensure newline at end of filepackages/secret-scan/src/rules/airtable.ts
pagination-options.ts
Consistent use of `type` keyword in importsapps/cli/src/util/pagination-options.ts
typekeyword to import statement for consistency.3 files
index.tsx
Added waitlist check and toast notification for users.apps/web/src/components/hero/index.tsx
_waitListDatato manage waitlisted emails.create.environment.ts
Refactored method call for better readability.apps/cli/src/commands/environment/create.environment.ts
createEnvironmentmethod call for improved readability.workspace-membership.ts
Use of `const` for immutable variablespackages/api-client/src/controllers/workspace-membership.ts
lettoconstfor variable declaration.