/** * @jest-environment jsdom */ import { findEligibleTour, getGuidedTourState, hasTourJustBeenVisible } from '../selectors'; jest.mock( 'calypso/layout/guided-tours/config', () => { return require( 'calypso/state/guided-tours/test/fixtures/config' ); } ); describe( 'selectors', () => { describe( '#hasTourJustBeenVisible', () => { test( 'should return false when no tour has been seen', () => { const state = { ui: { actionLog: [] } }; expect( hasTourJustBeenVisible( state ) ).toBeUndefined(); } ); test( 'should return true when a tour has just been seen', () => { const now = 1478623930204; const state = { ui: { actionLog: [ { type: 'GUIDED_TOUR_UPDATE', shouldShow: false, timestamp: now - 10000, // 10 seconds earlier }, ], }, }; expect( hasTourJustBeenVisible( state, now ) ).toBe( true ); } ); test( 'should return false when a tour has been seen longer ago', () => { const now = 1478623930204; const state = { ui: { actionLog: [ { type: 'GUIDED_TOUR_UPDATE', shouldShow: false, timestamp: now - 120000, // 2 minutes earlier }, ], }, }; expect( hasTourJustBeenVisible( state, now ) ).toBe( false ); } ); } ); describe( '#getGuidedTourState()', () => { test( 'should return an empty object if no state is present', () => { const tourState = getGuidedTourState( { route: { query: { current: {}, initial: {}, }, }, guidedTours: false, ui: { shouldShow: false, actionLog: [], }, preferences: { lastFetchedTimestamp: 1, remoteValues: { 'guided-tours-history': [], }, }, } ); expect( tourState ).toEqual( { shouldShow: false } ); } ); } ); describe( '#findEligibleTour()', () => { const makeState = ( { actionLog = [], toursHistory = [], queryArguments = {}, userData = {}, timestamp = null, } ) => ( { route: { query: { current: queryArguments, initial: queryArguments, }, timestamp, }, ui: { actionLog, }, preferences: { lastFetchedTimestamp: 1, remoteValues: { 'guided-tours-history': toursHistory, }, }, currentUser: { id: 1337, user: { ID: 1337, date: '2015-11-20T00:00:00+00:00', ...userData, }, }, } ); const navigateToThemes = { type: 'ROUTE_SET', path: '/themes/77203074', }; const navigateToTest = { type: 'ROUTE_SET', path: '/test', }; const mainTourStarted = { type: 'GUIDED_TOUR_UPDATE', tour: 'main', }; const mainTourAborted = { type: 'GUIDED_TOUR_UPDATE', shouldShow: false, shouldReallyShow: false, tour: 'main', stepName: 'init', finished: false, }; const mainTourSeen = { tourName: 'main', timestamp: 1337, finished: true, }; const themesTourSeen = { tourName: 'themes', timestamp: 1337, finished: true, }; const testTourSeen = { tourName: 'test', timestamp: 1337, finished: true, }; test( 'should return undefined if nothing relevant in log', () => { const state = makeState( { actionLog: [ { type: 'IRRELEVANT' } ] } ); const tour = findEligibleTour( state ); expect( tour ).toBeUndefined(); } ); test( 'should find `themes` when applicable', () => { const state = makeState( { actionLog: [ navigateToThemes ] } ); const tour = findEligibleTour( state ); expect( tour ).toBe( 'themes' ); } ); test( 'should not find `themes` if previously seen', () => { const state = makeState( { actionLog: [ navigateToThemes ], toursHistory: [ themesTourSeen ], } ); const tour = findEligibleTour( state ); expect( tour ).toBeUndefined(); } ); test( 'should see to it that an ongoing tour is selected', () => { const havingStartedTour = makeState( { actionLog: [ mainTourStarted, navigateToThemes ], } ); const havingQuitTour = makeState( { actionLog: [ mainTourStarted, mainTourAborted, navigateToThemes ], } ); expect( findEligibleTour( havingStartedTour ) ).toBe( 'main' ); expect( findEligibleTour( havingQuitTour ) ).toBe( 'themes' ); } ); test( 'should favor a tour launched via query arguments', () => { const state = makeState( { actionLog: [ navigateToThemes ], toursHistory: [ mainTourSeen, themesTourSeen ], queryArguments: { tour: 'main' }, } ); const tour = findEligibleTour( state ); expect( tour ).toBe( 'main' ); } ); test( 'should dismiss a requested tour at the end', () => { const mainTourJustSeen = { tourName: 'main', timestamp: 1338, finished: true, }; const state = makeState( { actionLog: [ navigateToThemes ], toursHistory: [ themesTourSeen, mainTourJustSeen ], queryArguments: { tour: 'main' }, timestamp: 0, } ); const tour = findEligibleTour( state ); expect( tour ).toBeUndefined(); } ); test( 'should respect tour "when" conditions', () => { const state = makeState( { actionLog: [ navigateToThemes ], userData: { date: new Date().toJSON() }, // user was created just now } ); const tour = findEligibleTour( state ); // Even though we navigated to `/themes`, this counts as navigating // to `/`, and `state` satisfies `main`'s "when" condition that the user // should be a new user. In our config, `main` is declared before // `themes`, so the selector should prefer the former. expect( tour ).toBe( 'main' ); } ); test( "shouldn't show a requested tour twice", () => { /* * Assume that a lot has happened during a Calypso session, so the * action log doesn't contain actions specific to Guided Tours * anymore. */ const state = makeState( { actionLog: Array.from( { length: 50 }, () => navigateToTest ), toursHistory: [ testTourSeen, themesTourSeen ], queryArguments: { tour: 'themes' }, timestamp: 0, } ); const tour = findEligibleTour( state ); expect( tour ).toBeUndefined(); } ); test( 'should bail if user preferences are stale', () => { const state = makeState( { actionLog: [ navigateToThemes ], userData: { date: new Date().toJSON() }, // user was created just now } ); delete state.preferences.lastFetchedTimestamp; const tour = findEligibleTour( state ); expect( tour ).toBeUndefined(); } ); describe( 'picking a tour based on the most recent actions', () => { test( 'should pick `themes`', () => { const state = makeState( { actionLog: [ navigateToThemes, navigateToTest ], } ); const tour = findEligibleTour( state ); expect( tour ).toBe( 'test' ); } ); test( 'should pick `test`', () => { const state = makeState( { actionLog: [ navigateToTest, navigateToThemes ], } ); const tour = findEligibleTour( state ); expect( tour ).toBe( 'themes' ); } ); } ); } ); } );