implement ability for e2e tests to patch appConfig (#4548)

e2e/client/playwright/authoring.publish.embargo.spec.ts

@@ -0,0 +1,34 @@
+import {test, expect} from '@playwright/test';
+import {Monitoring} from './page-object-models/monitoring';
+import {restoreDatabaseSnapshot, s} from './utils';
+import {getStorageState} from './utils/storage-state';
+
+test.use({
+    storageState: getStorageState({ui: {publishEmbargo: false}}),
+});
+
+test('disabling publish embargo by adjusting instance configuration', async ({page}) => {
+    await restoreDatabaseSnapshot();
+
+    const monitoring = new Monitoring(page);
+
+    await page.goto('/#/workspace/monitoring');
+
+    await monitoring.selectDeskOrWorkspace('Sports');
+
+    await page.locator(
+        s('monitoring-group=Sports / Working Stage', 'article-item=test sports story'),
+    ).dblclick();
+
+    await page.locator(s('authoring', 'open-send-publish-pane')).click();
+
+    // "target" section is not relevant for this test
+    // but is used as a control to make sure panel content has finished loading
+    await expect(
+        page.locator(s('authoring', 'interactive-actions-panel')).getByRole('button', {name: 'Target'}),
+    ).toBeVisible();
+
+    await expect(
+        page.locator(s('authoring', 'interactive-actions-panel')).getByRole('button', {name: 'Embargo'}),
+    ).not.toBeVisible();
+});

e2e/client/playwright/utils/storage-state.ts

@@ -0,0 +1,16 @@
+import {BrowserContextOptions} from '@playwright/test';
+import {ISuperdeskGlobalConfig} from 'superdesk-api';
+import storageState from '../.auth/user.json';
+
+type StorageState = BrowserContextOptions['storageState'];
+
+/**
+ * Allows to set custom application configs while preserving values defined in .auth/user.json
+ */
+export function getStorageState(appConfigPatch: Partial<ISuperdeskGlobalConfig>): StorageState {
+    const storageStateCopy = JSON.parse(JSON.stringify(storageState));
+
+    storageStateCopy['origins'][0].localStorage.push({name: 'TEST_APP_CONFIG', value: JSON.stringify(appConfigPatch)});
+
+    return storageStateCopy;
+}

scripts/appConfig.ts

@@ -1,3 +1,4 @@
+import {merge} from 'lodash';
 import {ISuperdeskGlobalConfig, IExtensions, IUser} from 'superdesk-api';
 
 /* globals __SUPERDESK_CONFIG__: true */
@@ -27,6 +28,9 @@ if (appConfig.features.autorefreshContent == null) {
     appConfig.features.autorefreshContent = true; // default to true
 }
 
+// allow e2e tests to overwrite appConfig via local storage
+Object.assign(appConfig, merge(appConfig, JSON.parse(localStorage.getItem('TEST_APP_CONFIG') ?? '{}')));
+
 export const dashboardRoute = '/workspace';
 export const IDENTITY_KEY = 'sess:user';
 export const extensions: IExtensions = {};