feat(app): introduce Enable App setting (#8521)

This commit is contained in:
naman-bruno
2026-07-08 21:46:11 +05:30
committed by GitHub
parent 139d71a8f8
commit d0863e2a43
27 changed files with 472 additions and 133 deletions

View File

@@ -2130,16 +2130,37 @@ const generateCollectionDocs = async (
};
/**
* Set the request's app code. Opens the App tab and writes the editor value
* Toggle the "Enable App" request setting idempotently (Settings tab).
* Enabling exposes the App tab and the Request/App/File view-mode toggle.
* @param page - The page object
* @param enabled - Whether apps should be enabled for the request
*/
const setAppEnabled = async (page: Page, enabled: boolean) => {
await test.step(`Set Enable App ${enabled ? 'ON' : 'OFF'}`, async () => {
await selectRequestPaneTab(page, 'Settings');
const toggle = page.getByTestId('enable-app-toggle');
await expect(toggle).toBeVisible();
const current = (await toggle.getAttribute('aria-checked')) === 'true';
if (current !== enabled) {
await toggle.click();
await expect(toggle).toHaveAttribute('aria-checked', String(enabled));
}
});
};
/**
* Set the request's app code. Enables apps in the request settings (the App
* tab is hidden otherwise), opens the App tab and writes the editor value
* directly via the CodeMirror API (avoids auto-close-bracket corruption when
* typing HTML/JS char-by-char). The app must not be enabled (editor visible).
* typing HTML/JS char-by-char). The app view must not be active (editor visible).
* @param page - The page object
* @param code - The HTML/JS app code
*/
const setAppCode = async (page: Page, code: string) => {
await setAppEnabled(page, true);
await test.step('Set app code', async () => {
await selectRequestPaneTab(page, 'App');
const editor = page.getByTestId('app-code-editor').locator('.CodeMirror').first();
const editor = appCodeEditor(page);
await editor.waitFor({ state: 'visible' });
await editor.evaluate((el, val) => {
const cm = (el as any).CodeMirror;
@@ -2149,15 +2170,70 @@ const setAppCode = async (page: Page, code: string) => {
};
/**
* Enable app mode via the App tab's "Enable App" toggle. Asserts the app view
* The CodeMirror element of the request-level App-tab editor.
* @param page - The page object
*/
const appCodeEditor = (page: Page) => page.getByTestId('app-code-editor').locator('.CodeMirror').first();
/**
* Read the app code currently loaded in the App-tab editor (via the CodeMirror API).
* @param page - The page object
* @returns The editor's current value
*/
const readAppEditor = (page: Page): Promise<string | undefined> =>
appCodeEditor(page).evaluate((el) => (el as any).CodeMirror?.getValue());
/**
* The App tab of the request pane tab bar.
* @param page - The page object
*/
const requestPaneAppTab = (page: Page) => page.getByTestId('responsive-tab-app');
/**
* Open the request pane's tab overflow dropdown if it is present. Tabs that
* don't fit the pane width land there instead of the visible tab row.
* @param page - The page object
*/
const openRequestPaneTabOverflow = async (page: Page) => {
const overflowButton = page.locator('[data-testid="request-pane"] .tabs .more-tabs');
if (await overflowButton.isVisible()) {
await overflowButton.click();
}
};
/**
* A tab entry inside the request pane's overflow dropdown.
* @param page - The page object
* @param label - The tab label to match (exact match via regex recommended)
*/
const requestPaneOverflowTabItem = (page: Page, label: string | RegExp) =>
page.locator('.tippy-box .dropdown-item').filter({ hasText: label });
/**
* The keep-alive preview slot of the ACTIVE tab. The AppPreviewKeepAlive
* overlay keeps app views of background tabs mounted (hidden) and the Electron
* instance is shared across tests in a worker, so bare app-view lookups can
* match a stale slot from another test. Always scope through the active slot.
* @param page - The page object
*/
const activeAppPreviewSlot = (page: Page) => page.locator('.app-preview-slot.active');
/**
* The app view of the ACTIVE tab (see activeAppPreviewSlot).
* @param page - The page object
*/
const activeAppView = (page: Page) => activeAppPreviewSlot(page).getByTestId('app-view');
/**
* Open the app view via the App tab's "Preview" button. Asserts the app view
* takes over the request/response area.
* @param page - The page object
*/
const enableApp = async (page: Page) => {
await test.step('Enable app mode (App tab toggle)', async () => {
const previewApp = async (page: Page) => {
await test.step('Preview app (App tab button)', async () => {
await selectRequestPaneTab(page, 'App');
await page.getByTestId('app-enable-toggle').click();
await expect(page.getByTestId('app-view')).toBeVisible({ timeout: 5000 });
await page.getByTestId('app-preview-btn').click();
await expect(activeAppView(page)).toBeVisible({ timeout: 5000 });
});
};
@@ -2167,8 +2243,8 @@ const enableApp = async (page: Page) => {
*/
const exitApp = async (page: Page) => {
await test.step('Exit app mode', async () => {
await page.getByTestId('app-exit-button').click();
await expect(page.getByTestId('app-view')).toBeHidden({ timeout: 5000 });
await activeAppView(page).getByTestId('app-exit-button').click();
await expect(activeAppView(page)).toHaveCount(0, { timeout: 5000 });
});
};
@@ -2190,7 +2266,7 @@ const selectViewMode = async (page: Page, mode: 'request' | 'app' | 'file') => {
* @returns The decoded HTML document string
*/
const getAppWebviewHtml = async (page: Page): Promise<string> => {
const webview = page.getByTestId('app-view').locator('webview');
const webview = activeAppView(page).locator('webview');
await webview.waitFor({ state: 'attached', timeout: 5000 });
const src = await webview.getAttribute('src');
if (!src) return '';
@@ -2243,7 +2319,10 @@ const createApp = async (
*/
const selectAppView = async (page: Page, view: 'code' | 'preview') => {
await test.step(`Switch collection app to "${view}"`, async () => {
await page.getByTestId(`collection-app-view-${view}`).click();
// Scope through the active keep-alive slot — hidden slots of background
// app tabs (possibly from earlier tests in the shared Electron) also
// render this toggle.
await activeAppPreviewSlot(page).getByTestId(`collection-app-view-${view}`).click();
});
};
@@ -2390,7 +2469,14 @@ export {
openFolderSettings,
setTableRowDescriptionValue,
setAppCode,
enableApp,
setAppEnabled,
readAppEditor,
requestPaneAppTab,
openRequestPaneTabOverflow,
requestPaneOverflowTabItem,
activeAppPreviewSlot,
activeAppView,
previewApp,
exitApp,
selectViewMode,
getAppWebviewHtml,

32
tests/utils/page/ai.ts Normal file
View File

@@ -0,0 +1,32 @@
import { test, Page } from '../../../playwright';
import { openPreferences, selectPreferencesTab } from './preferences';
export type AiPreferencesSubTab = 'config' | 'autocomplete' | 'security';
/**
* Locators for the AI pane of the Preferences dialog: its sub-tabs
* (Config / Autocomplete / Security) and the autocomplete keymap hints.
*/
export const buildAiPreferencesLocators = (page: Page) => ({
/** A sub-tab inside the AI preferences pane */
subTab: (key: AiPreferencesSubTab) => page.getByTestId(`ai-tab-${key}`),
/** The keyboard-shortcut hint block on the Autocomplete sub-tab */
autocompleteKeymap: () => page.locator('.autocomplete-keymap'),
/** A single key label inside the autocomplete keymap (exact match) */
autocompleteKeymapKey: (label: string) =>
page.locator('.autocomplete-keymap').getByText(label, { exact: true })
});
/**
* Open the AI pane of the Preferences dialog, optionally landing on a
* specific sub-tab.
*/
export const openAiPreferences = async (page: Page, subTab?: AiPreferencesSubTab) => {
await test.step(`Open AI preferences${subTab ? ` ("${subTab}" sub-tab)` : ''}`, async () => {
await openPreferences(page);
await selectPreferencesTab(page, 'AI');
if (subTab) {
await buildAiPreferencesLocators(page).subTab(subTab).click();
}
});
};

View File

@@ -2,4 +2,6 @@ export * from './actions';
export * from './runner';
export * from './locators';
export * from './mounting';
export * from './preferences';
export * from './ai';
export * from '../snapshot';

View File

@@ -1,11 +1,15 @@
import { Page, Locator } from '../../../playwright';
import { buildApiSpecPanelLocators } from './openapi/render-spec';
import { buildPreferencesLocators } from './preferences';
import { buildAiPreferencesLocators } from './ai';
export const buildCommonLocators = (page: Page) => ({
runner: () => page.getByTestId('run-button'),
openApi: {
render: buildApiSpecPanelLocators(page)
},
preferences: buildPreferencesLocators(page),
ai: buildAiPreferencesLocators(page),
saveButton: () => page
.locator('.infotip')
.filter({ hasText: /^Save/ }),

View File

@@ -0,0 +1,34 @@
import { test, Page } from '../../../playwright';
/**
* Locators for the Preferences dialog: the status-bar trigger that opens it
* and the top-level tabs inside it (General, Themes, AI, ...).
*/
export const buildPreferencesLocators = (page: Page) => ({
/** Status-bar button that opens the Preferences dialog */
statusBarTrigger: () => page.getByRole('button', { name: 'Open Preferences' }),
/** A top-level tab inside the Preferences dialog (exact name match) */
tab: (name: string) => page.getByRole('tab', { name, exact: true })
});
/**
* Open the Preferences dialog via the status bar. Waits for the app to finish
* loading first so the status bar is interactive.
*/
export const openPreferences = async (page: Page) => {
await test.step('Open Preferences', async () => {
const preferences = buildPreferencesLocators(page);
await page.locator('[data-app-state="loaded"]').waitFor();
await preferences.statusBarTrigger().click();
});
};
/**
* Switch to a top-level tab inside the (already open) Preferences dialog.
*/
export const selectPreferencesTab = async (page: Page, name: string) => {
await test.step(`Select Preferences tab "${name}"`, async () => {
const preferences = buildPreferencesLocators(page);
await preferences.tab(name).click();
});
};