MNTOR-3396 - Organize storybook dashboard states #5308
There are no files selected for viewing
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 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,308 @@ | ||
| /* This Source Code Form is subject to the terms of the Mozilla Public | ||
| * License, v. 2.0. If a copy of the MPL was not distributed with this | ||
| * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ | ||
|
|
||
| import type { Meta, StoryObj } from "@storybook/react"; | ||
|
|
||
| import { OnerepScanResultRow, OnerepScanRow } from "knex/types/tables"; | ||
| import { faker } from "@faker-js/faker"; | ||
| import { View as DashboardEl, TabType } from "./View"; | ||
| import { Shell } from "../../../../Shell"; | ||
| import { getL10n } from "../../../../../../functions/l10n/storybookAndJest"; | ||
| import { | ||
| createRandomScanResult, | ||
| createRandomBreach, | ||
| createUserWithPremiumSubscription, | ||
| } from "../../../../../../../apiMocks/mockData"; | ||
| import { SubscriberBreach } from "../../../../../../../utils/subscriberBreaches"; | ||
| import { LatestOnerepScanData } from "../../../../../../../db/tables/onerep_scans"; | ||
| import { CountryCodeProvider } from "../../../../../../../contextProviders/country-code"; | ||
| import { SessionProvider } from "../../../../../../../contextProviders/session"; | ||
| import { | ||
| ExperimentData, | ||
| defaultExperimentData, | ||
| } from "../../../../../../../telemetry/generated/nimbus/experiments"; | ||
| import { FeatureFlagName } from "../../../../../../../db/tables/featureFlags"; | ||
|
|
||
| const brokerOptions = { | ||
| "no-scan": "No scan started", | ||
| empty: "No scan results", | ||
| unresolved: "With unresolved scan results", | ||
| resolved: "All scan results resolved", | ||
| "scan-in-progress": "Scan is in progress", | ||
| "manually-resolved": "Manually resolved", | ||
| }; | ||
| const breachOptions = { | ||
| empty: "No data breaches", | ||
| unresolved: "With unresolved data breaches", | ||
| resolved: "All data breaches resolved", | ||
| }; | ||
| type DashboardWrapperProps = ( | ||
|
There was a problem hiding this comment. The type |
||
| | { | ||
| countryCode: "us"; | ||
| brokers: keyof typeof brokerOptions; | ||
| premium: boolean; | ||
| } | ||
| | { | ||
| countryCode: "nl"; | ||
| } | ||
| ) & { | ||
| brokers: keyof typeof brokerOptions; | ||
| breaches: keyof typeof breachOptions; | ||
| elapsedTimeInDaysSinceInitialScan?: number; | ||
| totalNumberOfPerformedScans?: number; | ||
| activeTab?: TabType; | ||
| enabledFeatureFlags?: FeatureFlagName[]; | ||
| experimentData?: ExperimentData; | ||
| hasFirstMonitoringScan?: boolean; | ||
| signInCount?: number; | ||
| autoOpenUpsellDialog?: boolean; | ||
| }; | ||
| const DashboardWrapper = (props: DashboardWrapperProps) => { | ||
| const mockedResolvedBreach: SubscriberBreach = createRandomBreach({ | ||
| dataClasses: [ | ||
| "email-addresses", | ||
| "ip-addresses", | ||
| "phone-numbers", | ||
| "passwords", | ||
| "pins", | ||
| "social-security-numbers", | ||
| "partial-credit-card-data", | ||
| "security-questions-and-answers", | ||
| ], | ||
| addedDate: new Date("2023-06-18T14:48:00.000Z"), | ||
| dataClassesEffected: [ | ||
| { "email-addresses": ["[email protected]", "[email protected]"] }, | ||
| { "ip-addresses": 1 }, | ||
| { "phone-numbers": 1 }, | ||
| { passwords: 1 }, | ||
| ], | ||
| isResolved: true, | ||
| }); | ||
|
|
||
| const mockedUnresolvedBreach: SubscriberBreach = createRandomBreach({ | ||
| dataClasses: ["email-addresses", "ip-addresses", "phone-numbers"], | ||
| addedDate: new Date("2023-06-18T14:48:00.000Z"), | ||
| dataClassesEffected: [ | ||
| { "email-addresses": ["[email protected]", "[email protected]"] }, | ||
| { "ip-addresses": 1 }, | ||
| ], | ||
| isResolved: false, | ||
| }); | ||
|
|
||
| let breaches: SubscriberBreach[] = []; | ||
| if (props.breaches === "resolved") { | ||
| breaches = [mockedResolvedBreach]; | ||
| } | ||
| if (props.breaches === "unresolved") { | ||
| breaches = [mockedResolvedBreach, mockedUnresolvedBreach]; | ||
| } | ||
|
|
||
| const mockedScan: OnerepScanRow = { | ||
| created_at: new Date(Date.UTC(1998, 2, 31)), | ||
| updated_at: new Date(Date.UTC(1998, 2, 31)), | ||
| id: 0, | ||
| onerep_profile_id: 0, | ||
| onerep_scan_id: 0, | ||
| onerep_scan_reason: "initial", | ||
| onerep_scan_status: "finished", | ||
| }; | ||
|
|
||
| const mockedScanInProgress: OnerepScanRow = { | ||
| ...mockedScan, | ||
| onerep_scan_status: "in_progress", | ||
| }; | ||
|
|
||
| const mockedInProgressScanResults: OnerepScanResultRow[] = [ | ||
| createRandomScanResult({ status: "removed", manually_resolved: false }), | ||
| createRandomScanResult({ | ||
| status: "waiting_for_verification", | ||
| manually_resolved: false, | ||
| }), | ||
| createRandomScanResult({ | ||
| status: "optout_in_progress", | ||
| manually_resolved: false, | ||
| }), | ||
| ]; | ||
|
|
||
| const mockedAllResolvedScanResults: OnerepScanResultRow[] = [ | ||
| createRandomScanResult({ status: "removed", manually_resolved: false }), | ||
| createRandomScanResult({ status: "removed", manually_resolved: false }), | ||
| ]; | ||
|
|
||
| const mockedUnresolvedScanResults: OnerepScanResultRow[] = [ | ||
| ...mockedInProgressScanResults, | ||
| createRandomScanResult({ status: "new", manually_resolved: false }), | ||
| createRandomScanResult({ status: "new", manually_resolved: false }), | ||
| createRandomScanResult({ status: "new", manually_resolved: true }), | ||
| ]; | ||
|
|
||
| const mockedManuallyResolvedScanResults: OnerepScanResultRow[] = [ | ||
| createRandomScanResult({ status: "new", manually_resolved: true }), | ||
| createRandomScanResult({ | ||
| status: "waiting_for_verification", | ||
| manually_resolved: true, | ||
| }), | ||
| createRandomScanResult({ | ||
| status: "optout_in_progress", | ||
| manually_resolved: true, | ||
| }), | ||
| createRandomScanResult({ status: "removed", manually_resolved: true }), | ||
| ]; | ||
|
|
||
| const scanData: LatestOnerepScanData = { scan: null, results: [] }; | ||
| let scanCount = 0; | ||
|
|
||
| if (props.countryCode === "us") { | ||
| if (props.brokers && props.brokers !== "no-scan") { | ||
| const scanInProgress = props.brokers === "scan-in-progress"; | ||
| scanData.scan = scanInProgress ? mockedScanInProgress : mockedScan; | ||
|
|
||
| if (scanInProgress) { | ||
| scanCount = 1; | ||
| } | ||
| if (props.brokers === "resolved") { | ||
| scanData.results = mockedAllResolvedScanResults; | ||
| } | ||
| if (props.brokers === "unresolved") { | ||
| scanData.results = mockedUnresolvedScanResults; | ||
| } | ||
|
|
||
| if (props.brokers === "manually-resolved") { | ||
| scanData.results = mockedManuallyResolvedScanResults; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| const user = createUserWithPremiumSubscription(); | ||
| if ((props.countryCode !== "us" || !props.premium) && user.fxa) { | ||
| user.fxa.subscriptions = []; | ||
| } | ||
|
|
||
| const mockedSession = { | ||
| expires: new Date().toISOString(), | ||
| user: user, | ||
| }; | ||
|
|
||
| const mockedRemovalTimeEstimates = scanData.results | ||
| .map((scan) => ({ | ||
| d: scan.data_broker, | ||
| t: faker.number.float({ min: 0, max: 200 }), | ||
| })) | ||
| .filter(() => Math.random() < 0.1); | ||
|
|
||
| return ( | ||
| <SessionProvider session={mockedSession}> | ||
| <CountryCodeProvider countryCode={props.countryCode}> | ||
| <Shell | ||
| l10n={getL10n()} | ||
| session={mockedSession} | ||
| nonce="" | ||
| countryCode={props.countryCode} | ||
| > | ||
| <DashboardEl | ||
| user={user} | ||
| userBreaches={breaches} | ||
| userScanData={scanData} | ||
| isEligibleForPremium={props.countryCode === "us"} | ||
| isEligibleForFreeScan={props.countryCode === "us" && !scanData.scan} | ||
| monthlySubscriptionUrl="" | ||
| yearlySubscriptionUrl="" | ||
| fxaSettingsUrl="" | ||
| scanCount={scanCount} | ||
| totalNumberOfPerformedScans={props.totalNumberOfPerformedScans} | ||
| subscriptionBillingAmount={{ | ||
| yearly: 13.37, | ||
| monthly: 42.42, | ||
| }} | ||
| isNewUser={true} | ||
| elapsedTimeInDaysSinceInitialScan={ | ||
| props.elapsedTimeInDaysSinceInitialScan | ||
| } | ||
| enabledFeatureFlags={props.enabledFeatureFlags ?? []} | ||
| experimentData={ | ||
| props.experimentData ?? { | ||
| ...defaultExperimentData, | ||
| "last-scan-date": { | ||
| enabled: true, | ||
| }, | ||
| } | ||
| } | ||
| activeTab={props.activeTab ?? "action-needed"} | ||
| hasFirstMonitoringScan={props.hasFirstMonitoringScan ?? false} | ||
| signInCount={props.signInCount ?? null} | ||
| autoOpenUpsellDialog={props.autoOpenUpsellDialog ?? false} | ||
| removalTimeEstimates={mockedRemovalTimeEstimates} | ||
| /> | ||
| </Shell> | ||
| </CountryCodeProvider> | ||
| </SessionProvider> | ||
| ); | ||
| }; | ||
|
|
||
| const meta: Meta<typeof DashboardWrapper> = { | ||
| title: "Pages/Logged in/Dashboard/Non US User", | ||
| component: DashboardWrapper, | ||
| argTypes: { | ||
| brokers: { | ||
| options: Object.keys(brokerOptions), | ||
| description: "Scan results", | ||
| control: { | ||
| type: "radio", | ||
| labels: brokerOptions, | ||
| }, | ||
| }, | ||
| breaches: { | ||
| options: Object.keys(breachOptions), | ||
| control: { | ||
| type: "radio", | ||
| labels: breachOptions, | ||
| }, | ||
| }, | ||
| elapsedTimeInDaysSinceInitialScan: { | ||
| name: "Days since initial scan", | ||
| control: { | ||
| type: "number", | ||
| }, | ||
| }, | ||
| hasFirstMonitoringScan: { | ||
| name: "Has first monitoring scan", | ||
| control: { | ||
| type: "boolean", | ||
| }, | ||
| }, | ||
| signInCount: { | ||
| name: "Sign-in count", | ||
| control: { | ||
| type: "number", | ||
| }, | ||
| }, | ||
| }, | ||
| }; | ||
|
|
||
| export default meta; | ||
| type Story = StoryObj<typeof DashboardWrapper>; | ||
|
|
||
| export const DashboardNonUsNoBreaches: Story = { | ||
| name: "Non-US user, with 0 breaches", | ||
| args: { | ||
| countryCode: "nl", | ||
| breaches: "empty", | ||
| }, | ||
| }; | ||
|
|
||
| export const DashboardNonUsUnresolvedBreaches: Story = { | ||
| name: "Non-US user, with unresolved breaches", | ||
| args: { | ||
| countryCode: "nl", | ||
| breaches: "unresolved", | ||
| }, | ||
| }; | ||
|
|
||
| export const DashboardNonUsResolvedBreaches: Story = { | ||
| name: "Non-US user, with all breaches resolved", | ||
| args: { | ||
| countryCode: "nl", | ||
| breaches: "resolved", | ||
| }, | ||
| }; | ||
Oops, something went wrong.
Oops, something went wrong.
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.
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.
Suggestion:
brokerOptionsandbreachOptionsis also defined inDashboardUSUsers.stories.tsxand multiple other files — might be a good idea to just have those in one place and import them here.