skip onboarding tour in cypress tests

Author: chriscollins3456

datahub-web-react/src/app/onboarding/OnboardingTour.tsx

@@ -8,6 +8,7 @@ import { useUserContext } from '../context/useUserContext';
 import { REDESIGN_COLORS } from '../entityV2/shared/constants';
 import { useIsThemeV2 } from '../useIsThemeV2';
 import { convertStepId, getConditionalStepIdsToAdd, getStepsToRender } from './utils';
+import useShouldSkipOnboardingTour from './useShouldSkipOnboardingTour';
 
 type Props = {
     stepIds: string[];
@@ -56,7 +57,9 @@ export const OnboardingTour = ({ stepIds }: Props) => {
         });
     }
 
-    if (!filteredSteps.length) return null;
+    const shouldSkipOnboardingTour = useShouldSkipOnboardingTour();
+
+    if (!filteredSteps.length || shouldSkipOnboardingTour) return null;
 
     return (
         <Tour

datahub-web-react/src/app/onboarding/useShouldSkipOnboardingTour.ts

@@ -0,0 +1,8 @@
+// this key is used in commands.js to turn off onboarding tours in cypress tests
+const SKIP_ONBOARDING_TOUR_KEY = 'skipOnboardingTour';
+
+export default function useShouldSkipOnboardingTour() {
+    const shouldSkipOnboardingTour = localStorage.getItem(SKIP_ONBOARDING_TOUR_KEY);
+
+    return shouldSkipOnboardingTour === 'true';
+}

smoke-test/tests/cypress/cypress/support/commands.js

@@ -22,6 +22,8 @@ export function getTimestampMillisNumDaysAgo(numDays) {
   return dayjs().subtract(numDays, "day").valueOf();
 }
 
+const SKIP_ONBOARDING_TOUR_KEY = "skipOnboardingTour";
+
 Cypress.Commands.add("login", () => {
   cy.request({
     method: "POST",
@@ -31,7 +33,7 @@ Cypress.Commands.add("login", () => {
       password: Cypress.env("ADMIN_PASSWORD"),
     },
     retryOnStatusCodeFailure: true,
-  });
+  }).then(() => localStorage.setItem(SKIP_ONBOARDING_TOUR_KEY, "true"));
 });
 
 Cypress.Commands.add("loginWithCredentials", (username, password) => {
@@ -45,6 +47,7 @@ Cypress.Commands.add("loginWithCredentials", (username, password) => {
   }
   cy.contains("Sign In").click();
   cy.get(".ant-avatar-circle").should("be.visible");
+  localStorage.setItem(SKIP_ONBOARDING_TOUR_KEY, "true");
 });
 
 Cypress.Commands.add("deleteUrn", (urn) => {