Merge pull request #35 from joomcode/fix/update-config-after-do-befor…

…e-functions

fix: update pack config by values from `doBeforePack` functions

autotests/tests/main/exists.ts

@@ -32,6 +32,11 @@ it('exists', {meta: {testId: '1'}, testIdleTimeout: 35_000, testTimeout: 90_000}
 
   await expect(customPackProperties.name, 'custom pack properties is correct').eql('allTests');
 
+  await expect(
+    customPackProperties.internalPackRunId,
+    'dynamic custom pack properties is correct',
+  ).gt(0);
+
   const mainPage = await navigateToPage(Main, {language});
 
   await expect(mainPage.pageParams, 'pageParams is correct after navigateToPage').eql({language});

src/utils/events/registerStartE2edRunEvent.ts

@@ -3,6 +3,7 @@ import {EVENTS_DIRECTORY_PATH, TMP_DIRECTORY_PATH} from '../../constants/interna
 
 import {createDirectory, removeDirectory, writeStartInfo} from '../fs';
 import {generalLog, writeLogsToFile} from '../generalLog';
+import {getFullPackConfig, updateConfig} from '../getFullPackConfig';
 import {compilePack, setPackTimeout} from '../pack';
 import {getStartInfo} from '../startInfo';
 
@@ -22,6 +23,10 @@ export const registerStartE2edRunEvent = async (): Promise<void> => {
 
   await runBeforePackFunctions(startInfo);
 
+  const fullPackConfig = getFullPackConfig();
+
+  updateConfig(fullPackConfig, startInfo);
+
   const {e2ed, runEnvironment} = startInfo;
   const isDockerRun = runEnvironment === RunEnvironment.Docker;
   const startMessage = `Run tests ${isDockerRun ? 'in docker' : 'local'} with e2ed@${e2ed.version}`;

src/utils/fs/readStartInfoSync.ts

@@ -0,0 +1,15 @@
+import {readFileSync} from 'node:fs';
+
+import {READ_FILE_OPTIONS, START_INFO_PATH} from '../../constants/internal';
+
+import type {StartInfo} from '../../types/internal';
+
+/**
+ * Read start info from tmp directory in sync manner.
+ * @internal
+ */
+export const readStartInfoSync = (): StartInfo => {
+  const startInfoJsonString = readFileSync(START_INFO_PATH, READ_FILE_OPTIONS);
+
+  return JSON.parse(startInfoJsonString) as StartInfo;
+};

src/utils/getFullPackConfig/getFullPackConfig.ts

@@ -0,0 +1,40 @@
+// eslint-disable-next-line import/no-internal-modules
+import {readStartInfoSync} from '../fs/readStartInfoSync';
+
+import {updateConfig} from './updateConfig';
+
+import type {FullPackConfig} from '../../types/internal';
+
+let updatedConfig: FullPackConfig | undefined;
+
+/**
+ * Get full pack configuration object.
+ * This function can only be called after the `E2edRunEvent` is registered,
+ * because the packs with configurations (`e2ed/packs`) is compiled when this event is registered.
+ */
+export const getFullPackConfig = <
+  CustomPackProperties = unknown,
+  CustomReportProperties = unknown,
+  SkipTests = unknown,
+  TestMeta = unknown,
+>(): FullPackConfig<CustomPackProperties, CustomReportProperties, SkipTests, TestMeta> => {
+  if (updatedConfig === undefined) {
+    // eslint-disable-next-line global-require, @typescript-eslint/no-var-requires
+    const {fullPackConfig} = require<typeof import('../../testcaferc')>('../../testcaferc');
+
+    updatedConfig = fullPackConfig;
+
+    try {
+      const startInfo = readStartInfoSync();
+
+      updateConfig(updatedConfig, startInfo);
+    } catch (error) {}
+  }
+
+  return updatedConfig as unknown as FullPackConfig<
+    CustomPackProperties,
+    CustomReportProperties,
+    SkipTests,
+    TestMeta
+  >;
+};

src/utils/getFullPackConfig/index.ts

@@ -0,0 +1,3 @@
+export {getFullPackConfig} from './getFullPackConfig';
+/** @internal */
+export {updateConfig} from './updateConfig';

src/utils/getFullPackConfig/updateConfig.ts

@@ -0,0 +1,20 @@
+import type {FullPackConfig, StartInfo} from '../../types/internal';
+
+/**
+ * Updates full pack config by values from `startInfo` (getted by `doBeforePack` functions).
+ * @internal
+ */
+export const updateConfig = (fullPackConfig: FullPackConfig, startInfo: StartInfo): void => {
+  for (const field of Object.keys(fullPackConfig) as (keyof FullPackConfig)[]) {
+    if (field === 'doAfterPack' || field === 'doBeforePack') {
+      continue;
+    }
+
+    if (typeof fullPackConfig[field] === 'function') {
+      continue;
+    }
+
+    // @ts-expect-error: full pack config have different types of field values
+    fullPackConfig[field] = startInfo.fullPackConfig[field]; // eslint-disable-line no-param-reassign
+  }
+};