Skip to content

Conditionally render the progress indicator on the Analytics setup screen, based on the showProgress query parameter. #11379

@techanvil

Description

@techanvil

Feature Description

Conditionally render the progress indicator on the Analytics setup screen, based on the showProgress query parameter.

This includes adding the showProgress query parameter to the module reauth URI.

For reference, see the Analytics setup screen in the Figma design, and the Progress indicator section in the Design Doc.


Do not alter or remove anything below. The following sections will be managed by moderators only.

Acceptance criteria

  • When landing on the Analytics setup screen from the Search Console setup screen, the progress indicator is rendered with four visible segments as per the Figma design.
  • When setting up Analytics after the initial setup, e.g. via the Connect More Services tab, or a setup CTA, the progress indicator is not shown on the Analytics setup screen.
  • The progress indicator is only visible when the setupFlowRefresh feature flag is enabled.

Implementation Brief

  • Make the following changes conditional on the setupFlowRefresh feature flag.
  • In assets/js/components/setup/SetupUsingProxyWithSignIn/index.js:
    • Add the showProgress query parameter to the moduleReauthURL variable when it's assigned the value of the response from the activateModule() action.
  • In assets/js/components/setup/ModuleSetup.js:
    • If the module slug is analytics-4 and the showProgress query parameter is set to a truthy value, use the subHeader prop of the Header component to render the ProgressIndicator component, with totalSegments set to 6 and currentSegment to 4.

Test Coverage

  • Extend the tests for SetupUsingProxyWithSignIn/index.js to cover the above change.
  • Add a story which renders the Analytics setup screen with the progress indicator present.

QA Brief

  • Use the staging proxy plugin to use the v3 setup flow.
  • Turn on the setupFlowRefresh feature flag using the tester plugin.
  • Start setting up Site Kit and choose to connect Analytics.
  • When you land on the Analytics setup screen after completing OAuth, verify that &showProgress=true exists in your URL as a query argument.
  • Verify that the progress indicator appears in the setup screen according to the ACs and Figma designs.
  • Verify the Modules > Analytics4 > Setup > SetupForm > WithProgressIndicator Storybook story.

Changelog entry

  • Display the progress indicator on the Analytics setup screen when it's navigated to in the new setup flow.

Metadata

Metadata

Assignees

No one assigned

    Labels

    P0High priorityTeam MIssues for Squad 2Type: EnhancementImprovement of an existing feature

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions