Fix race conditions in 03-narrow casper tests.

Re-arranges code so that two waitFor functions that can have
a race condition are separated by a then function.

Fixes: #1455

frontend_tests/casper_lib/common.js

@@ -250,8 +250,7 @@ exports.trim = function (str) {
 // Call get_rendered_messages and then check that the last few headings and
 // bodies match the specified arrays.
 exports.expected_messages = function (table, headings, bodies) {
-    casper.test.assertVisible('#'+table,
+    casper.test.assertVisible('#'+table, table + ' is visible');
-        table + ' is visible');
 
     var msg = exports.get_rendered_messages(table);
 

frontend_tests/casper_tests/03-narrow.js

@@ -46,6 +46,8 @@ common.then_send_many([
 // Define the messages we expect to see when narrowed.
 
 function expect_home() {
+    casper.then(function () {
+        casper.waitUntilVisible('#zhome', function () {
             common.expected_messages('zhome', [
                 'Verona > frontend test',
                 'You and Cordelia Lear, King Hamlet',
@@ -55,9 +57,13 @@ function expect_home() {
                 '<p>personal D</p>',
                 '<p>personal E</p>'
             ]);
+        });
+    });
 }
 
 function expect_stream() {
+    casper.then(function () {
+        casper.waitUntilVisible('#zfilt', function () {
             common.expected_messages('zfilt', [
                 'Verona > frontend test',
                 'Verona > other subject',
@@ -68,9 +74,13 @@ function expect_stream() {
                 '<p>test message C</p>',
                 '<p>test message D</p>'
             ]);
+        });
+    });
 }
 
 function expect_stream_subject() {
+    casper.then(function () {
+        casper.waitUntilVisible('#zfilt', function () {
             common.expected_messages('zfilt', [
                 'Verona > frontend test'
             ], [
@@ -78,9 +88,13 @@ function expect_stream_subject() {
                 '<p>test message B</p>',
                 '<p>test message D</p>'
             ]);
+        });
+    });
 }
 
 function expect_subject() {
+    casper.then(function () {
+        casper.waitUntilVisible('#zfilt', function () {
             common.expected_messages('zfilt', [
                 'Verona > frontend test',
                 'Denmark > frontend test',
@@ -91,9 +105,13 @@ function expect_subject() {
                 '<p>other message</p>',
                 '<p>test message D</p>'
             ]);
+        });
+    });
 }
 
 function expect_huddle() {
+    casper.then(function () {
+        casper.waitUntilVisible('#zfilt', function () {
             common.expected_messages('zfilt', [
                 'You and Cordelia Lear, King Hamlet'
             ], [
@@ -101,18 +119,26 @@ function expect_huddle() {
                 '<p>personal B</p>',
                 '<p>personal D</p>'
             ]);
+        });
+    });
 }
 
 function expect_1on1() {
+    casper.then(function () {
+        casper.waitUntilVisible('#zfilt', function () {
             common.expected_messages('zfilt', [
                 'You and Cordelia Lear'
             ], [
                 '<p>personal C</p>',
                 '<p>personal E</p>'
             ]);
+        });
+    });
 }
 
 function expect_all_pm() {
+    casper.then(function () {
+        casper.waitUntilVisible('#zfilt', function () {
             common.expected_messages('zfilt', [
                 'You and Cordelia Lear, King Hamlet',
                 'You and Cordelia Lear'
@@ -123,6 +149,8 @@ function expect_all_pm() {
                 '<p>personal D</p>',
                 '<p>personal E</p>'
             ]);
+        });
+    });
 }
 
 function check_narrow_title(title) {
@@ -135,72 +163,13 @@ function check_narrow_title(title) {
 
 function un_narrow() {
     casper.then(common.un_narrow);
-    casper.then(expect_home);
+    expect_home();
     casper.then(check_narrow_title('home - Zulip Dev - Zulip'));
 }
 
-// Narrow by clicking links.
-
-casper.then(function () {
-    common.wait_for_receive(function () {
-        casper.test.info('Narrowing by clicking stream');
-        casper.click('*[title="Narrow to stream \\\"Verona\\\""]');
-    });
-});
-
-casper.then(function () {
-    casper.waitUntilVisible('#zfilt', function () {
-        expect_stream();
-    });
-});
-
-casper.then(check_narrow_title('Verona - Zulip Dev - Zulip'));
-un_narrow();
-
-casper.then(function () {
-    casper.waitUntilVisible('#zhome', function () {
-        expect_home();
-        casper.test.info('Narrowing by clicking subject');
-        casper.click('*[title="Narrow to stream \\\"Verona\\\", topic \\\"frontend test\\\""]');
-    });
-});
-
-casper.then(function () {
-    check_narrow_title('frontend test - Zulip Dev - Zulip');
-    casper.waitUntilVisible('#zfilt', function () {
-        expect_stream_subject();
-
-        // This time, un-narrow by hitting the search 'x'
-        casper.test.info('Un-narrowing');
-        casper.click('#search_exit');
-    });
-});
-
-casper.then(function () {
-    casper.waitUntilVisible('#zhome', function () {
-        expect_home();
-        casper.test.info('Narrowing by clicking personal');
-        casper.click('*[title="Narrow to your private messages with Cordelia Lear, King Hamlet"]');
-    });
-});
-
-casper.then(function () {
-    check_narrow_title('private - Zulip Dev - Zulip');
-    casper.waitUntilVisible('#zfilt', function () {
-        expect_huddle();
-
-        // Un-narrow by clicking "Zulip"
-        casper.test.info('Un-narrowing');
-        casper.click('.brand');
-    });
-});
-
-
-// Narrow by typing in search strings or operators.
-
 function search_and_check(str, item, check, narrow_title) {
     common.select_item_via_typeahead('#search_query', str, item);
-    casper.then(check);
+    check();
     casper.then(check_narrow_title(narrow_title));
     un_narrow();
 }
@@ -231,56 +200,111 @@ function search_non_existing_user(str, item) {
     un_narrow();
 }
 
+// Narrow by clicking links.
+
 casper.then(function () {
-    casper.waitUntilVisible('#zhome', expect_home);
+    common.wait_for_receive(function () {
+        casper.test.info('Narrowing by clicking stream');
+        casper.click('*[title="Narrow to stream \\\"Verona\\\""]');
+    });
 });
 
+expect_stream();
+
+casper.then(check_narrow_title('Verona - Zulip Dev - Zulip'));
+
+un_narrow();
+
+expect_home();
+
+casper.then(function () {
+    casper.test.info('Narrowing by clicking subject');
+    casper.click('*[title="Narrow to stream \\\"Verona\\\", topic \\\"frontend test\\\""]');
+});
+
+expect_stream_subject();
+
+casper.then(check_narrow_title('frontend test - Zulip Dev - Zulip'));
+
+casper.then(function () {
+    // This time, un-narrow by hitting the search 'x'
+    casper.test.info('Un-narrowing');
+    casper.click('#search_exit');
+});
+
+expect_home();
+
+casper.then(function () {
+    casper.test.info('Narrowing by clicking personal');
+    casper.click('*[title="Narrow to your private messages with Cordelia Lear, King Hamlet"]');
+});
+
+expect_huddle();
+
+casper.then(check_narrow_title('private - Zulip Dev - Zulip'));
+
+casper.then(function () {
+    // Un-narrow by clicking "Zulip"
+    casper.test.info('Un-narrowing');
+    casper.click('.brand');
+});
+
+expect_home();
+
+// Narrow by typing in search strings or operators.
 // Test stream / recipient autocomplete in the search bar
 search_and_check('Verona', 'Narrow to stream', expect_stream,
                  'Verona - Zulip Dev - Zulip');
+
 search_and_check('Cordelia', 'Narrow to private', expect_1on1,
                  'private - Zulip Dev - Zulip');
 
 // Test operators
 search_and_check('stream:Verona', 'Narrow', expect_stream,
                  'Verona - Zulip Dev - Zulip');
+
 search_and_check('stream:Verona subject:frontend+test', 'Narrow', expect_stream_subject,
                  'frontend test - Zulip Dev - Zulip');
+
 search_and_check('subject:frontend+test', 'Narrow', expect_subject,
                  'home - Zulip Dev - Zulip');
 
 search_silent_user('sender:emailgateway@zulip.com', 'Narrow');
+
 search_non_existing_user('sender:dummyuser@zulip.com', 'Narrow');
 
 // Narrow by clicking the left sidebar.
 casper.then(function () {
     casper.test.info('Narrowing with left sidebar');
+    casper.click('#stream_filters [data-name="Verona"] a');
 });
-casper.thenClick('#stream_filters [data-name="Verona"]  a', expect_stream);
-casper.then(check_narrow_title('Verona - Zulip Dev - Zulip'));
-casper.thenClick('#global_filters [data-name="home"]    a', expect_home);
-casper.then(check_narrow_title('home - Zulip Dev - Zulip'));
-casper.thenClick('#global_filters [data-name="private"] a', expect_all_pm);
-casper.then(check_narrow_title('private - Zulip Dev - Zulip'));
-un_narrow();
 
+expect_stream();
+
+casper.then(check_narrow_title('Verona - Zulip Dev - Zulip'));
+
+casper.thenClick('#global_filters [data-name="home"] a');
+
+expect_home();
+
+casper.then(check_narrow_title('home - Zulip Dev - Zulip'));
+
+casper.thenClick('#global_filters [data-name="private"] a');
+
+expect_all_pm();
+
+casper.then(check_narrow_title('private - Zulip Dev - Zulip'));
+
+un_narrow();
 
 // Make sure stream search filters the stream list
 casper.then(function () {
     casper.test.info('Search streams using left sidebar');
-});
-
-casper.then(function () {
     casper.test.assertExists('.stream-list-filter.notdisplayed', 'Stream filter box not visible initially');
+    casper.click('#streams_header .sidebar-title');
 });
 
-casper.thenClick('#streams_header .sidebar-title');
+casper.waitWhileSelector('.stream-list-filter.notdisplayed', function () {
-
-casper.then(function () {
-    casper.test.assertDoesntExist('.stream-list-filter.notdisplayed', 'Stream filter box visible after click');
-});
-
-casper.then(function () {
     casper.test.assertExists('#stream_filters [data-name="Denmark"]', 'Original stream list contains Denmark');
     casper.test.assertExists('#stream_filters [data-name="Scotland"]', 'Original stream list contains Scotland');
     casper.test.assertExists('#stream_filters [data-name="Verona"]', 'Original stream list contains Verona');
@@ -295,9 +319,17 @@ casper.then(function () {
             .trigger($.Event('input'));
     });
 });
-casper.then(function () {
+
+// There will be no race condition between these two waits because we
+// expect them to happen in parallel.
+casper.waitWhileSelector('#stream_filters [data-name="Denmark"]', function () {
     casper.test.assertDoesntExist('#stream_filters [data-name="Denmark"]', 'Filtered stream list does not contain Denmark');
+});
+casper.waitWhileSelector('#stream_filters [data-name="Scotland"]', function () {
     casper.test.assertDoesntExist('#stream_filters [data-name="Scotland"]', 'Filtered stream list does not contain Scotland');
+});
+
+casper.then(function () {
     casper.test.assertExists('#stream_filters [data-name="Verona"]', 'Filtered stream list does contain Verona');
 });
 
@@ -310,21 +342,28 @@ casper.then(function () {
             .trigger($.Event('input'));
     });
 });
-casper.then(function () {
+
+// There will be no race condition between these waits because we
+// expect them to happen in parallel.
+casper.waitForSelector('#stream_filters [data-name="Denmark"]', function () {
     casper.test.assertExists('#stream_filters [data-name="Denmark"]', 'Restored stream list contains Denmark');
-    casper.test.assertExists('#stream_filters [data-name="Scotland"]', 'Restored stream list contains Scotland');
-    casper.test.assertExists('#stream_filters [data-name="Verona"]', 'Restored stream list contains Verona');
 });
+casper.waitForSelector('#stream_filters [data-name="Scotland"]', function () {
+    casper.test.assertExists('#stream_filters [data-name="Denmark"]', 'Restored stream list contains Scotland');
+});
+casper.waitForSelector('#stream_filters [data-name="Verona"]', function () {
+    casper.test.assertExists('#stream_filters [data-name="Denmark"]', 'Restored stream list contains Verona');
+});
+
 
 casper.thenClick('#streams_header .sidebar-title');
 
-casper.then(function () {
+casper.waitForSelector('.stream-list-filter.notdisplayed', function () {
     casper.test.assertExists('.stream-list-filter.notdisplayed', 'Stream filter box not visible after second click');
 });
 
 un_narrow();
 
-
 common.then_log_out();
 
 // Run the above queued actions.