[tests/functional] opt out of getting started on navigation #11881

spalger · 2017-05-17T22:28:37Z

When running the functional tests, before finishing navigations, check if the getting started page is visible and if so opt out of it.

ycombinator · 2017-05-17T23:24:58Z

test/functional/page_objects/getting_started_page.js

+      return await testSubjects.exists('gettingStartedContainer');
+    }
+
+    async outOut() {


Typo: should be optOut.

…avigation

…f-getting-started-on-navigation

rashmivkulkarni · 2017-05-17T23:30:01Z

Pulled your changes and tested it locally. It opts out of the getting started link on navigation. LGTM .

rashmivkulkarni

LGTM- pulled your changes and tested it locally.

ycombinator · 2017-05-17T23:33:34Z

@spalger how would this work for functional tests about the Getting Started page redirect functionality itself? For example, in #11850 I'm trying to write a test that attempts to navigate to the Discover page and expect to end up on the Getting Started page.

ycombinator · 2017-05-17T23:35:27Z

Never mind, I suppose if I stay clear of navigateToApp() in my tests in #11850, I should be good.

ycombinator · 2017-05-18T00:17:09Z

Ruh roh, CI appears to be failing around the Console functional tests: https://kibana-ci.elastic.co/job/elastic+kibana+pull-request+multijob-selenium/4688/consoleFull

...
12:10:33.538      └- ✖ fail: "console app console app should show the default request"
12:10:33.542      │        tryForTime timeout: NoSuchElement: An element could not be located on the page using the given search parameters.
...

… has settled

…for getting started

spalger · 2017-05-18T00:58:50Z

So, when you visit http://localhost:5601/app/kibana#/dev_tools/console before opt-out of the getting started page the getting started route setup work was calling kbnUrl.change() but then allowing the setup work promise to resolve. This means that the route change didn't go into effect until the next digest cycle and lead to the sense-welcome directive being rendered and then destroyed, which prevents it from showing a second time and broke the tests... Since #11246 is too complicated, and there isn't any other way to prevent this behavior without throwing an error, I updated the setup work to return promises that will never resolve, preventing the setup work from ever completing and the route from ever rendering. Then, on the next digest cycle, the new route (getting started page) will be detected and rendered without ever rendering the console.

ycombinator · 2017-05-18T01:56:45Z

src/core_plugins/getting_started/public/lib/add_setup_work.js

@@ -68,14 +69,14 @@ uiRoutes
        });
        notify.error('Please create a new index pattern');
        kbnUrl.change(CREATE_INDEX_PATTERN_ROUTE);
-        return;
+        return Promise.halt(); //prevent route resolve


It might be good to explain for the benefit of our future selves why this is necessary via a comment in this file somewhere. Since this is being done in a couple of places maybe we can extract a function here that changes the route and return a halted promise?

spalger · 2017-05-18T04:07:18Z

src/core_plugins/getting_started/public/lib/add_setup_work.js

@@ -68,14 +67,14 @@ uiRoutes
        });
        notify.error('Please create a new index pattern');
        kbnUrl.change(CREATE_INDEX_PATTERN_ROUTE);
-        return;
+        throw WAIT_FOR_URL_CHANGE_TOKEN;


@ycombinator I tried a different approach, throwing this token from within a route setup work function will halt the setup work, allowing it to wait for kbnUrl to change. What do you think?

/cc @cjcenizal

@spalger Do you think this throw should just become part of the kbnUrl.change function? It seems to me the two would always want to travel together, no?

… work

ycombinator · 2017-05-18T12:46:30Z

src/ui/public/routes/routes.js

@@ -2,9 +2,11 @@ import RouteManager from './route_manager';
 import 'angular-route/angular-route';
 import { uiModules } from 'ui/modules';
 const defaultRouteManager = new RouteManager();
+import { ABORT_SETUP_WORK_TOKEN } from './route_setup_manager';


Did you mean this to be WAIT_FOR_URL_CHANGE_TOKEN?

cjcenizal · 2017-05-18T15:44:10Z

src/ui/public/routes/route_setup_manager.js

+
+      // prevent moving forward, return a promise that never resolves
+      // so that the $router can observe the $location update
+      return Promise.halt();


Super minor nit, but this seems more like the "early exit" exception, and throwing the error seems more like the default flow, so I'd suggest swapping the two:

if (error === WAIT_FOR_URL_CHANGE_TOKEN) { // prevent moving forward, return a promise that never resolves // so that the $router can observe the $location update return Promise.halt(); } throw error;

cjcenizal · 2017-05-18T15:47:42Z

src/ui/public/routes/route_setup_manager.js

@@ -1,6 +1,8 @@
 import _ from 'lodash';

-module.exports = class RouteSetupManager {
+export const WAIT_FOR_URL_CHANGE_TOKEN = new Error('WAIT_FOR_URL_CHANGE_TOKEN');


If I were coming across this code, I'd end up here, where this token is defined, to try to understand why and how to use it. Maybe just leave a comment here, explaining its role?

// Throw this inside of an Angular route resolver after calling `kbnUrl.change` so that the $router can // observe the $location update. Otherwise, the location won't be updated. export const WAIT_FOR_URL_CHANGE_TOKEN = new Error('WAIT_FOR_URL_CHANGE_TOKEN');

cjcenizal · 2017-05-18T15:48:11Z

@spalger This is a really nice elegant solution! I found it really easy to follow and understand. Thanks for CCing me and letting me take a look.

…f-getting-started-on-navigation

* [tests/functional] automatically opt-out of getting started page on navigation * [test/functional/commonPage] avoid circular reference * [test/functional/commonPage] move check for getting started after url has settled * [gettingStarted] prevent route resolution by returning halt promises * [test/functional/commonPage] wait for kibana to load before checking for getting started * [uiRoutes/setupWork] provide a token that can be thrown to halt setup work * [ui/routes] rename reference to WAIT_FOR_URL_CHANGE_TOKEN * address review feedback (cherry picked from commit c9c8e8d)

spalger · 2017-05-19T02:34:34Z

5.5/5.x: 3f181d1

…11881) * [tests/functional] automatically opt-out of getting started page on navigation * [test/functional/commonPage] avoid circular reference * [test/functional/commonPage] move check for getting started after url has settled * [gettingStarted] prevent route resolution by returning halt promises * [test/functional/commonPage] wait for kibana to load before checking for getting started * [uiRoutes/setupWork] provide a token that can be thrown to halt setup work * [ui/routes] rename reference to WAIT_FOR_URL_CHANGE_TOKEN * address review feedback

spalger added test v5.5.0 v6.0.0 labels May 17, 2017

spalger requested a review from rashmivkulkarni May 17, 2017 22:28

spalger force-pushed the fix/opt-out-of-getting-started-on-navigation branch from cc0ebf2 to 9b4e19b Compare May 17, 2017 23:16

spalger mentioned this pull request May 17, 2017

Functional tests for the Getting Started page #11850

Merged

ycombinator reviewed May 17, 2017

View reviewed changes

spalger force-pushed the fix/opt-out-of-getting-started-on-navigation branch from 9b4e19b to a7fae68 Compare May 17, 2017 23:28

spalger added 2 commits May 17, 2017 16:28

[tests/functional] automatically opt-out of getting started page on n…

263b2b6

…avigation

Merge branch 'master' of github.com:elastic/kibana into fix/opt-out-o…

1b77840

…f-getting-started-on-navigation

spalger force-pushed the fix/opt-out-of-getting-started-on-navigation branch from a7fae68 to 1b77840 Compare May 17, 2017 23:29

rashmivkulkarni approved these changes May 17, 2017

View reviewed changes

[test/functional/commonPage] avoid circular reference

207a00c

spalger added 3 commits May 17, 2017 17:29

[test/functional/commonPage] move check for getting started after url…

9561233

… has settled

[gettingStarted] prevent route resolution by returning halt promises

a890065

[test/functional/commonPage] wait for kibana to load before checking …

01fef54

…for getting started

ycombinator reviewed May 18, 2017

View reviewed changes

spalger force-pushed the fix/opt-out-of-getting-started-on-navigation branch 2 times, most recently from 27a6773 to 9dc3498 Compare May 18, 2017 04:07

spalger commented May 18, 2017

View reviewed changes

[uiRoutes/setupWork] provide a token that can be thrown to halt setup…

f88c940

… work

spalger force-pushed the fix/opt-out-of-getting-started-on-navigation branch from 9dc3498 to f88c940 Compare May 18, 2017 04:08

ycombinator reviewed May 18, 2017

View reviewed changes

[ui/routes] rename reference to WAIT_FOR_URL_CHANGE_TOKEN

b82612a

cjcenizal reviewed May 18, 2017

View reviewed changes

spalger added 2 commits May 18, 2017 14:09

Merge branch 'master' of github.com:elastic/kibana into fix/opt-out-o…

abf58a7

…f-getting-started-on-navigation

address review feedback

274ba24

spalger merged commit c9c8e8d into elastic:master May 19, 2017

spalger deleted the fix/opt-out-of-getting-started-on-navigation branch May 19, 2017 02:34

ycombinator mentioned this pull request May 19, 2017

Prevent flicker on Getting Started page #11826

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[tests/functional] opt out of getting started on navigation #11881

[tests/functional] opt out of getting started on navigation #11881

spalger commented May 17, 2017 •

edited by ycombinator

ycombinator May 17, 2017

rashmivkulkarni commented May 17, 2017

rashmivkulkarni left a comment

ycombinator commented May 17, 2017

ycombinator commented May 17, 2017

ycombinator commented May 18, 2017

spalger commented May 18, 2017

ycombinator May 18, 2017

spalger May 18, 2017

ycombinator May 18, 2017

ycombinator May 18, 2017

spalger May 18, 2017

cjcenizal May 18, 2017

cjcenizal May 18, 2017

cjcenizal commented May 18, 2017

spalger commented May 19, 2017

[tests/functional] opt out of getting started on navigation #11881

[tests/functional] opt out of getting started on navigation #11881

Conversation

spalger commented May 17, 2017 • edited by ycombinator

Choose a reason for hiding this comment

rashmivkulkarni commented May 17, 2017

rashmivkulkarni left a comment

Choose a reason for hiding this comment

ycombinator commented May 17, 2017

ycombinator commented May 17, 2017

ycombinator commented May 18, 2017

spalger commented May 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cjcenizal commented May 18, 2017

spalger commented May 19, 2017

spalger commented May 17, 2017 •

edited by ycombinator