import {strict as assert} from "assert"; import type {ElementHandle, Page} from "puppeteer"; import common from "../puppeteer_lib/common"; async function user_row_selector(page: Page, name: string): Promise { const user_id = await common.get_user_id_from_name(page, name); const selector = `.remove_potential_subscriber[data-user-id="${user_id}"]`; return selector; } async function await_user_visible(page: Page, name: string): Promise { const selector = await user_row_selector(page, name); await page.waitForSelector(selector, {visible: true}); } async function await_user_hidden(page: Page, name: string): Promise { const selector = await user_row_selector(page, name); await page.waitForSelector(selector, {hidden: true}); } async function add_user_to_stream(page: Page, name: string): Promise { const user_id = await common.get_user_id_from_name(page, name); await page.evaluate( (user_id: Number) => zulip_test.add_user_id_to_new_stream(user_id), user_id, ); await await_user_visible(page, name); } async function stream_name_error(page: Page): Promise { await page.waitForSelector("#stream_name_error", {visible: true}); return await common.get_text_from_selector(page, "#stream_name_error"); } async function open_streams_modal(page: Page): Promise { const all_streams_selector = "#add-stream-link"; await page.waitForSelector(all_streams_selector, {visible: true}); await page.click(all_streams_selector); await page.waitForSelector("#subscription_overlay.new-style", {visible: true}); const url = await common.page_url_with_fragment(page); assert.ok(url.includes("#streams/all")); } async function test_subscription_button(page: Page): Promise { const stream_selector = "[data-stream-name='Venice']"; const button_selector = `${stream_selector} .sub_unsub_button`; const subscribed_selector = `${button_selector}.checked`; const unsubscribed_selector = `${button_selector}:not(.checked)`; async function subscribed(): Promise { return await page.waitForSelector(subscribed_selector, {visible: true}); } async function unsubscribed(): Promise { return await page.waitForSelector(unsubscribed_selector, {visible: true}); } // Make sure that Venice is even in our list of streams. await page.waitForSelector(stream_selector, {visible: true}); await page.waitForSelector(button_selector, {visible: true}); // Note that we intentionally re-find the button after each click, since // the live-update code may replace the whole row. let button; // We assume Venice is already subscribed, so the first line here // should happen immediately. button = await subscribed(); // Toggle subscriptions several times. This test code has been known // to flake, so we add console statements. It appears that the console // statements help prevent the flake, which is probably caused by some // subtle race condition. We will hopefully diagnose the root cause of // the flake, but I am confident that the test will mostly catch actual // bugs in the real code, so as long as the console.info statements help // here, we should just leave them in. for (let i = 0; i < 10; i += 1) { console.info(`\n unsubscribe/subscribe loop ${i}\n\n`); await button!.click(); button = await unsubscribed(); await button!.click(); button = await subscribed(); console.info(`\n end loop ${i}\n\n`); } } async function click_create_new_stream(page: Page): Promise { await page.click("#add_new_subscription .create_stream_button"); await page.waitForSelector(".finalize_create_stream", {visible: true}); // sanity check that desdemona is the initial subsscriber await await_user_visible(page, "desdemona"); } async function clear_ot_filter_with_backspace(page: Page): Promise { await page.click(".add-user-list-filter"); await page.keyboard.press("Backspace"); await page.keyboard.press("Backspace"); } async function test_user_filter_ui(page: Page): Promise { await page.waitForSelector("form#stream_creation_form", {visible: true}); // Desdemona should be there by default await await_user_visible(page, "desdemona"); await add_user_to_stream(page, "cordelia"); await add_user_to_stream(page, "othello"); await page.type(`form#stream_creation_form [name="user_list_filter"]`, "ot", {delay: 100}); await page.waitForSelector("#create_stream_subscribers", {visible: true}); // Wait until filtering is completed. await page.waitForFunction( () => document.querySelectorAll("#create_stream_subscribers .remove_potential_subscriber") .length === 1, ); await await_user_hidden(page, "cordelia"); await await_user_hidden(page, "desdemona"); await await_user_visible(page, "othello"); // Clear the filter. await clear_ot_filter_with_backspace(page); await await_user_visible(page, "cordelia"); await await_user_visible(page, "desdemona"); await await_user_visible(page, "othello"); } async function create_stream(page: Page): Promise { await page.waitForXPath('//*[text()="Create stream"]', {visible: true}); await common.fill_form(page, "form#stream_creation_form", { stream_name: "Puppeteer", stream_description: "Everything Puppeteer", }); await page.click("form#stream_creation_form .finalize_create_stream"); await page.waitForFunction(() => $(".stream-name").is(':contains("Puppeteer")')); const stream_name = await common.get_text_from_selector( page, ".stream-header .stream-name .sub-stream-name", ); const stream_description = await common.get_text_from_selector( page, ".stream-description .sub-stream-description", ); const subscriber_count_selector = "[data-stream-name='Puppeteer'] .subscriber-count"; assert.strictEqual(stream_name, "Puppeteer"); assert.strictEqual(stream_description, "Everything Puppeteer"); // Assert subscriber count becomes 3 (cordelia, desdemona, othello) await page.waitForFunction( (subscriber_count_selector: string) => $(subscriber_count_selector).text().trim() === "3", {}, subscriber_count_selector, ); } async function test_streams_with_empty_names_cannot_be_created(page: Page): Promise { await page.click("#add_new_subscription .create_stream_button"); await page.waitForSelector("form#stream_creation_form", {visible: true}); await common.fill_form(page, "form#stream_creation_form", {stream_name: " "}); await page.click("form#stream_creation_form button.finalize_create_stream"); assert.strictEqual(await stream_name_error(page), "A stream needs to have a name"); } async function test_streams_with_duplicate_names_cannot_be_created(page: Page): Promise { await common.fill_form(page, "form#stream_creation_form", {stream_name: "Puppeteer"}); await page.click("form#stream_creation_form button.finalize_create_stream"); assert.strictEqual(await stream_name_error(page), "A stream with this name already exists"); const cancel_button_selector = "form#stream_creation_form button.button.white"; await page.click(cancel_button_selector); } async function test_stream_creation(page: Page): Promise { await click_create_new_stream(page); await test_user_filter_ui(page); await create_stream(page); await test_streams_with_empty_names_cannot_be_created(page); await test_streams_with_duplicate_names_cannot_be_created(page); } async function test_streams_search_feature(page: Page): Promise { assert.strictEqual(await common.get_text_from_selector(page, "#search_stream_name"), ""); const hidden_streams_selector = ".stream-row.notdisplayed .stream-name"; assert.strictEqual( await common.get_text_from_selector( page, '.stream-row[data-stream-name="Verona"] .stream-name', ), "Verona", ); assert.ok( !(await common.get_text_from_selector(page, hidden_streams_selector)).includes("Verona"), "#Verona is hidden", ); await page.type('#stream_filter input[type="text"]', "Puppeteer"); await page.waitForSelector(".stream-row[data-stream-name='core team']", {hidden: true}); assert.strictEqual( await common.get_text_from_selector(page, ".stream-row:not(.notdisplayed) .stream-name"), "Puppeteer", ); assert.ok( (await common.get_text_from_selector(page, hidden_streams_selector)).includes("Verona"), "#Verona is not hidden", ); assert.ok( !(await common.get_text_from_selector(page, hidden_streams_selector)).includes("Puppeteer"), "Puppeteer is hidden after searching.", ); } async function subscriptions_tests(page: Page): Promise { await common.log_in(page); await open_streams_modal(page); await test_subscription_button(page); await test_stream_creation(page); await test_streams_search_feature(page); } common.run_test(subscriptions_tests);