ci: add e2e workflow, optimize client code for testing (#771)

* refactor(e2e): fix tests with latest changes, convert to TS, use test Ids

* chore(EndpointMenu.jsx): add data-testid attribute to new-conversation-menu button

* refactor(EndpointItem): add data-testid attr., convert to TS

* refactor(e2e): remove unnecessary awaits and convert to TS

* chore(playwright.config.local.ts): add absolute path to server index.js file
chore(playwright.config.local.ts): add dotenv configuration
chore(playwright.config.local.ts): change webServer command to use absolute path
chore(playwright.config.local.ts): add NODE_ENV and process.env to webServer env
chore(playwright.config.local.ts): remove unused import
chore(login.spec.js): delete login.spec.js file

* chore(.gitignore): add 'my.secrets' to the list of ignored files
fix(Registration.tsx): add 'data-testid' attribute to the error message div
fix(Registration.spec.tsx): comment out test case that calls 'registerUser.mutate'

* chore(ConvoIcon.tsx): add data-testid attribute to svg element
chore(messages.spec.ts): refactor conversation navigation logic

* chore(playwright.config.ts): add support for absolute path to server index.js file
feat(playwright.config.ts): add support for dotenv configuration
feat(playwright.config.ts): set NODE_ENV to 'production' in webServer environment variables

* chore(workflows): comment out push event and specify paths for pull_request event in backend-review.yml
chore(workflows): comment out push event and specify paths for pull_request event in frontend-review.yml

* chore(install.js): add check to skip install script in CI environment

* chore: complete playwright workflow

* chore(Landing.tsx): add data-testid attribute to landing title element
chore(authenticate.ts): update selector to wait for landing title element by test id instead of text content

* chore(playwright.yml): add step to upload screenshot artifact on failure
fix(authenticate.ts): capture screenshot before waiting for landing title and increase timeout due to GH Actions load time

* chore(playwright.yml): rename artifact name from 'screenshot' to 'login-screenshot'
feat(LoginForm.tsx): add data-testid attribute to login button
fix(authenticate.ts): change screenshot name to 'login-screenshot.png' and conditionally take screenshot only in CI environment

* chore(playwright.yml): add CI environment variable and set it to true

* chore(playwright.yml): update Playwright installation command
chore(playwright.config.ts): update storageState path to use process.cwd()

* fix(playwright.yml): update node version to 18 in setup-node action
fix(playwright.yml): update actions/cache to v3 in Cache Node.js modules step
fix(playwright.yml): update actions/cache to v3 in Cache Playwright installations step
fix(authenticate.ts): change login button click to press 'Enter' on password input

* chore(playwright.yml): update E2E_USER_EMAIL and E2E_USER_PASSWORD values for testing purposes
chore(authenticate.ts): add console.dir to log user object for debugging

* chore(playwright.yml): add step to upload storageState artifact

The storageState artifact is now uploaded as part of the workflow. This artifact contains the state of the storage used during the end-to-end tests. It will be retained for 2 days.

* chore(playwright.yml): comment out upload screenshot step
chore(playwright.config.ts): change NODE_ENV to development
chore(authenticate.ts): comment out screenshot related code

* chore(playwright.config.ts): add SESSION_EXPIRY environment variable with value 86400000

* chore(playwright.yml): update environment variables in Playwright workflow
fix(General.tsx): add data-testid attributes to clear conversations buttons
test(messages.spec.ts): add setup and teardown steps for clearing conversations before and after tests

* fix(messages.spec.ts): fix clearing conversations before and after message tests
feat(messages.spec.ts): add beforeEach and afterEach hooks to create and close new page for each test

* chore: remove storageStage upload artifact

e2e/specs/settings.spec.ts

@@ -0,0 +1,75 @@
+import { expect, test } from '@playwright/test';
+
+test.describe('Settings suite', () => {
+  test('Last Bing settings', async ({ page }) => {
+    await page.goto('http://localhost:3080/');
+    await page.evaluate(() =>
+      window.localStorage.setItem(
+        'lastConversationSetup',
+        JSON.stringify({
+          conversationId: 'new',
+          title: 'New Chat',
+          endpoint: 'bingAI',
+          createdAt: '',
+          updatedAt: '',
+          jailbreak: false,
+          context: null,
+          systemMessage: null,
+          toneStyle: 'creative',
+          jailbreakConversationId: null,
+          conversationSignature: null,
+          clientId: null,
+          invocationId: 1,
+        }),
+      ),
+    );
+    await page.goto('http://localhost:3080/');
+
+    const initialLocalStorage = await page.evaluate(() => window.localStorage);
+    const lastConvoSetup = JSON.parse(initialLocalStorage.lastConversationSetup);
+    expect(lastConvoSetup.endpoint).toEqual('bingAI');
+
+    const newTopicButton = page.getByTestId('new-conversation-menu');
+    await newTopicButton.click();
+
+    // includes the icon + endpoint names in obj property
+    const endpointItem = page.getByTestId('endpoint-item-bingAI');
+    await endpointItem.click();
+
+    await page.getByTestId('text-input').click();
+    const button1 = page.getByRole('button', { name: 'Mode: BingAI' });
+    const button2 = page.getByRole('button', { name: 'Mode: Sydney' });
+
+    try {
+      await button1.click({ timeout: 100 });
+    } catch (e) {
+      // console.log('Bing button', e);
+    }
+
+    try {
+      await button2.click({ timeout: 100 });
+    } catch (e) {
+      // console.log('Sydney button', e);
+    }
+    await page.getByRole('option', { name: 'Sydney' }).click();
+    await page.getByRole('tab', { name: 'Balanced' }).click();
+
+    // Change Endpoint to see if settings will persist
+    await newTopicButton.click();
+    await page.getByRole('menuitemradio', { name: 'ChatGPT OpenAI' }).click();
+
+    // Close endpoint menu & re-select BingAI
+    await page.getByTestId('text-input').click();
+    await newTopicButton.click();
+    await endpointItem.click();
+
+    // Check if the settings persisted
+    const localStorage = await page.evaluate(() => window.localStorage);
+    const lastBingSettings = JSON.parse(localStorage.lastBingSettings);
+    const { jailbreak, toneStyle } = lastBingSettings;
+    expect(jailbreak).toBeTruthy();
+    expect(toneStyle).toEqual('balanced');
+    const button = page.getByRole('button', { name: 'Mode: Sydney' });
+    expect(button.count()).toBeTruthy();
+  });
+});