@thinkwise/testwise 0.1.97 → 0.2.0-beta.22

package/page-extensions/SubjectRegistry.ts

@@ -0,0 +1,30 @@
+// import type { Page } from '@playwright/test';
+import type { Test } from '../types/Test.js';
+
+export type SubjectType = {
+  none: unknown;
+};
+
+declare module '@playwright/test' {
+  interface Page {
+    subject: SubjectType;
+  }
+}
+
+export class SubjectRegistry {
+  private _test: Test;
+
+  constructor(test: Test) {
+    this._test = test.extend({
+      page: async ({ page }, use) => {
+        page.subject = {} as SubjectType;
+
+        await use(page);
+      }
+    });
+  }
+
+  get test() {
+    return this._test;
+  }
+}

package/page-extensions/index.ts

@@ -1,4 +1,7 @@
 export * from './GlobalComponents.js';
 export * from './GoToDeepLink.js';
 export * from './LoginFeatures.js';
+export * from './SubjectProvider.js';
+export * from './SubjectRegistry.js';
 export * from './UserSimulation.js';
+export * from './WaitEventHandler.js';

package/promptCredentials.js

@@ -1,124 +1,124 @@
-#!/usr/bin/env node
-import { spawnSync } from 'node:child_process';
-import { readFileSync } from 'node:fs';
-import process from 'node:process';
-import chalk from 'chalk';
-import prompts from 'prompts';
-
-const packageScripts = JSON.parse(readFileSync('./package.json')).scripts;
-
-function exitWithError(error) {
-  console.log(chalk.red(error));
-  process.exit(1);
-}
-
-function startTestSolution() {
-  console.log('Now starting test solution...');
-  spawnSync(`yarn --cwd ../ ${args.join(' ')}`, {
-    shell: true,
-    stdio: 'inherit'
-  });
-  process.exit();
-}
-
-const args = process.argv.slice(2);
-
-if (!args.length) {
-  exitWithError('Error: Got too few parameters. Usage: yarn test:credentials test');
-}
-
-const yarnScriptToExec = args[0];
-
-if (!packageScripts[yarnScriptToExec]) {
-  exitWithError(`Error: Given script "${yarnScriptToExec}" doesn't exist in package.json.`);
-}
-
-// INCOMING HACK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-// temp fix to be reworked when converting this file to TS
-import fs from 'node:fs';
-import path from 'node:path';
-
-const indiciumURL = (() => {
-  try {
-    const configPath = path.resolve(process.cwd(), './Testwise.json');
-    const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
-    return config.environmentSettings?.serviceUrl || '';
-  } catch (error) {
-    console.error('Error reading Testwise.json:', error);
-    return '';
-  }
-})();
-
-// END OF HACK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
-
-if (process.env.SF_TEST_USERNAME && process.env.SF_TEST_PASSWORD) {
-  console.log('Using SF_TEST_USERNAME and SF_TEST_PASSWORD environment variables.');
-  startTestSolution();
-}
-
-const questions = [
-  {
-    type: 'text',
-    name: 'username',
-    message: 'Username:',
-    validate: (value) => {
-      if (!value?.length) {
-        return 'Username is required';
-      }
-
-      if (value.toLowerCase() === 'demo') {
-        return 'Running tests locally with demo is forbidden as it results in dataset concurrency problems';
-      }
-
-      return true;
-    }
-  },
-  {
-    type: 'invisible',
-    name: 'password',
-    message: 'Password:',
-    validate: (value) => (!value?.length ? 'Password is required' : true)
-  }
-];
-
-(async () => {
-  const credentialsResponse = await prompts(questions);
-
-  if (!credentialsResponse || !credentialsResponse.username || !credentialsResponse.password) {
-    exitWithError('Username or password was not given');
-  }
-
-  const { password, username } = credentialsResponse;
-  const params = new URLSearchParams();
-
-  params.append('UserName', username);
-  params.append('Password', password);
-
-  const fetch = (await import('node-fetch')).default;
-  const authResponse = await fetch(`${indiciumURL}/account/api/login`, {
-    method: 'POST',
-    body: params
-  });
-
-  if (authResponse.status === 204) {
-    console.log('Confirmed credentials work @', indiciumURL);
-  } else {
-    const confirmResponse = await prompts([
-      {
-        type: 'confirm',
-        name: 'value',
-        message: `Can't login to ${indiciumURL} with the given credentials. Continue anyways?`,
-        initial: true
-      }
-    ]);
-
-    if (!confirmResponse.value) {
-      return;
-    }
-  }
-
-  process.env.SF_TEST_USERNAME = username;
-  process.env.SF_TEST_PASSWORD = password;
-
-  startTestSolution();
-})();
+#!/usr/bin/env node
+import { spawnSync } from 'node:child_process';
+import { readFileSync } from 'node:fs';
+import process from 'node:process';
+import chalk from 'chalk';
+import prompts from 'prompts';
+
+const packageScripts = JSON.parse(readFileSync('./package.json')).scripts;
+
+function exitWithError(error) {
+  console.log(chalk.red(error));
+  process.exit(1);
+}
+
+function startTestSolution() {
+  console.log('Now starting test solution...');
+  spawnSync(`yarn --cwd ../ ${args.join(' ')}`, {
+    shell: true,
+    stdio: 'inherit'
+  });
+  process.exit();
+}
+
+const args = process.argv.slice(2);
+
+if (!args.length) {
+  exitWithError('Error: Got too few parameters. Usage: yarn test:credentials test');
+}
+
+const yarnScriptToExec = args[0];
+
+if (!packageScripts[yarnScriptToExec]) {
+  exitWithError(`Error: Given script "${yarnScriptToExec}" doesn't exist in package.json.`);
+}
+
+// INCOMING HACK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+// temp fix to be reworked when converting this file to TS
+import fs from 'node:fs';
+import path from 'node:path';
+
+const indiciumURL = (() => {
+  try {
+    const configPath = path.resolve(process.cwd(), './Testwise.json');
+    const config = JSON.parse(fs.readFileSync(configPath, 'utf-8'));
+    return config.environmentSettings?.serviceUrl || '';
+  } catch (error) {
+    console.error('Error reading Testwise.json:', error);
+    return '';
+  }
+})();
+
+// END OF HACK!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!
+
+if (process.env.SF_TEST_USERNAME && process.env.SF_TEST_PASSWORD) {
+  console.log('Using SF_TEST_USERNAME and SF_TEST_PASSWORD environment variables.');
+  startTestSolution();
+}
+
+const questions = [
+  {
+    type: 'text',
+    name: 'username',
+    message: 'Username:',
+    validate: (value) => {
+      if (!value?.length) {
+        return 'Username is required';
+      }
+
+      if (value.toLowerCase() === 'demo') {
+        return 'Running tests locally with demo is forbidden as it results in dataset concurrency problems';
+      }
+
+      return true;
+    }
+  },
+  {
+    type: 'invisible',
+    name: 'password',
+    message: 'Password:',
+    validate: (value) => (!value?.length ? 'Password is required' : true)
+  }
+];
+
+(async () => {
+  const credentialsResponse = await prompts(questions);
+
+  if (!credentialsResponse || !credentialsResponse.username || !credentialsResponse.password) {
+    exitWithError('Username or password was not given');
+  }
+
+  const { password, username } = credentialsResponse;
+  const params = new URLSearchParams();
+
+  params.append('UserName', username);
+  params.append('Password', password);
+
+  const fetch = (await import('node-fetch')).default;
+  const authResponse = await fetch(`${indiciumURL}/account/api/login`, {
+    method: 'POST',
+    body: params
+  });
+
+  if (authResponse.status === 204) {
+    console.log('Confirmed credentials work @', indiciumURL);
+  } else {
+    const confirmResponse = await prompts([
+      {
+        type: 'confirm',
+        name: 'value',
+        message: `Can't login to ${indiciumURL} with the given credentials. Continue anyways?`,
+        initial: true
+      }
+    ]);
+
+    if (!confirmResponse.value) {
+      return;
+    }
+  }
+
+  process.env.SF_TEST_USERNAME = username;
+  process.env.SF_TEST_PASSWORD = password;
+
+  startTestSolution();
+})();

package/scripts/Testwise.template.json

@@ -2,7 +2,10 @@
   "environmentSettings" :{
     "baseUrl" : "https://develop.example.app",
     "serviceUrl" : "https://develop.example.app/service",
-    "metaEndpoint" : "iam"
+    "metaEndpoint" : "iam",
+    "authUser" : "ExampleUser",
+    "authUserPassword" : "ExamplePassword@1",
+    "guiApplAlias" : "ExampleName"
   },
   "featureSettings" :{
     "logger" : {

package/scripts/main.js

@@ -1,11 +1,84 @@
-#!/usr/bin/env node
-import process from 'node:process';
-import { setup } from './setup.js';
-
-if (process.argv[2] === 'install') {
-  setup();
-} else if (process.argv[2] === 'sync') {
-  console.log('This feature is coming soon!');
-} else {
-  console.warn('Command unknown. Use "install" or "sync".');
-}
+#!/usr/bin/env node
+import fs from 'node:fs';
+import path from 'node:path';
+import process from 'node:process';
+import { PathResolver } from '../dist/helpers/index.js';
+import { postinstall } from './postinstall.js';
+import { setup } from './setup.js';
+import { sync } from './sync.js';
+
+await setup();
+const { testwiseConfig } = await import('../dist/services/index.js');
+const config = testwiseConfig();
+const configBuilder = await config.load();
+
+if (process.argv[2] === 'postinstall') {
+  if (!(await verifiedSeedData())) process.exit(0);
+
+  postinstall();
+} else if (process.argv[2] === 'sync') {
+  if (!(await verifiedSeedData())) process.exit(0);
+
+  sync();
+} else {
+  console.warn('Command unknown.');
+}
+
+async function verifiedSeedData() {
+  const consumerRoot = new PathResolver().getConsumerRootDirectory();
+  const seedDataDir = path.join(consumerRoot, 'seed-data');
+  const subjectsJson = path.join(seedDataDir, 'subjects.json');
+  const screensDir = path.join(seedDataDir, 'screen-schemas');
+  const projectIsConfigured = await isConfigured();
+
+  if (!fs.existsSync(seedDataDir)) {
+    if (projectIsConfigured) {
+      fs.mkdirSync(seedDataDir);
+      fs.mkdirSync(screensDir);
+
+      console.log('Created seed-data directory structure.');
+      return true;
+    }
+
+    console.info('No seed-data directory found.');
+    return false;
+  }
+
+  if (!fs.existsSync(subjectsJson) && !projectIsConfigured) {
+    console.info('No subjects.json');
+    return false;
+  }
+
+  if (!fs.existsSync(screensDir)) {
+    if (projectIsConfigured) {
+      fs.mkdirSync(screensDir);
+      console.log('Created screen-schemas directory.');
+      return true;
+    }
+
+    console.info('No screen-schemas directory found.');
+    return false;
+  }
+
+  const screenFiles = fs.readdirSync(screensDir).filter((f) => f.endsWith('.json'));
+  if (screenFiles.length === 0 && !projectIsConfigured) {
+    console.info('No screen JSON files found in seed-data/screen-schemas');
+    return false;
+  }
+  return true;
+}
+
+async function isConfigured() {
+  const user = configBuilder.get('environmentSettings.authUser');
+  const password = configBuilder.get('environmentSettings.authUserPassword');
+  const guiApplAlias = configBuilder.get('environmentSettings.guiApplAlias');
+
+  return Boolean(
+    user &&
+      user !== 'ExampleUser' &&
+      password &&
+      password !== 'ExamplePassword@1' &&
+      guiApplAlias &&
+      guiApplAlias !== 'ExampleName'
+  );
+}

package/scripts/postinstall.js

@@ -0,0 +1,39 @@
+import { execSync } from 'node:child_process';
+import path from 'node:path';
+import process from 'node:process';
+import { fileURLToPath } from 'node:url';
+import { ArtifactManager } from '../dist/artifact-builder/index.js';
+import { testwiseConfig } from '../dist/services/ConfigBuilder.js';
+import { sync } from './sync.js';
+
+const _filename = fileURLToPath(import.meta.url);
+const _dirname = path.dirname(_filename);
+
+export async function postinstall() {
+  try {
+    const autoSync = testwiseConfig().get('featureSettings.other.autoSync') ?? true;
+    if (!autoSync) return;
+
+    const rootDir = path.resolve(_dirname, '..');
+    const artifactManager = new ArtifactManager();
+
+    if (artifactManager.backupExists()) {
+      artifactManager.restoreBackup();
+      console.info('Restored artifacts from backup.');
+
+      // const { SubjectRegistration } = await import('../dist/artifact-builder/index.js');
+      // new SubjectRegistration().run();
+
+      execSync('npx tsc', { cwd: rootDir, stdio: 'inherit' });
+
+      console.info('Postinstall restore process completed successfully.');
+
+      return;
+    }
+
+    await sync();
+  } catch (error) {
+    console.error('Postinstall process failed:', error.message);
+    process.exit(1);
+  }
+}

package/scripts/setup.js

@@ -1,34 +1,37 @@
-/* eslint-disable @typescript-eslint/naming-convention */
-import fs from 'node:fs';
-import path from 'node:path';
-import process from 'node:process';
-import { fileURLToPath } from 'node:url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-export function setup() {
-  try {
-    const testwiseConfigFile = path.resolve(process.cwd(), 'Testwise.json');
-    const testwiseConfigTemplateFile = path.join(__dirname, 'Testwise.template.json');
-    const tsConfigFile = path.resolve(process.cwd(), 'tsconfig.json');
-    const tsConfigTemplateFile = path.join(__dirname, 'tsconfig.template.json');
-
-    if (!fs.existsSync(testwiseConfigFile)) {
-      fs.copyFileSync(testwiseConfigTemplateFile, testwiseConfigFile);
-      console.info('Testwise.json config file created.');
-    } else {
-      console.info('Testwise.json already exists, skipping creation.');
-    }
-
-    if (!fs.existsSync(tsConfigFile)) {
-      fs.copyFileSync(tsConfigTemplateFile, tsConfigFile);
-      console.info('tsconfig.json config file created.');
-    } else {
-      console.info('tsconfig.json already exists, skipping creation.');
-    }
-  } catch (error) {
-    console.error('Error during installation:', error.message);
-    process.exit(1); // Exit with an error code if something goes wrong
-  }
-}
+import fs from 'node:fs';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { PathResolver } from '../dist/helpers/index.js';
+
+const _filename = fileURLToPath(import.meta.url);
+const _dirname = path.dirname(_filename);
+
+export async function setup() {
+  try {
+    const consumerRoot = new PathResolver().getConsumerRootDirectory();
+    const testwiseConfigFile = path.resolve(consumerRoot, 'Testwise.json');
+    const testwiseConfigTemplateFile = path.join(_dirname, 'Testwise.template.json');
+    const tsConfigFile = path.resolve(consumerRoot, 'tsconfig.json');
+    const tsConfigTemplateFile = path.join(_dirname, 'tsconfig.template.json');
+
+    let filesCreated = false;
+
+    if (!fs.existsSync(testwiseConfigFile)) {
+      fs.copyFileSync(testwiseConfigTemplateFile, testwiseConfigFile);
+      console.info('Testwise.json config file created.');
+      filesCreated = true;
+    }
+
+    if (!fs.existsSync(tsConfigFile)) {
+      fs.copyFileSync(tsConfigTemplateFile, tsConfigFile);
+      console.info('tsconfig.json config file created.');
+      filesCreated = true;
+    }
+
+    if (!filesCreated) {
+      await new Promise((resolve) => setTimeout(resolve, 1000));
+    }
+  } catch (error) {
+    console.error('Error during installation:', error.message);
+  }
+}

package/scripts/sync.js

@@ -0,0 +1,102 @@
+/* eslint-disable @typescript-eslint/naming-convention */
+import { execSync } from 'node:child_process';
+import path from 'node:path';
+import process from 'node:process';
+import { fileURLToPath } from 'node:url';
+import { Stopwatch } from '../dist/artifact-builder/helpers/index.js';
+import { ArtifactManager } from '../dist/artifact-builder/index.js';
+
+const _filename = fileURLToPath(import.meta.url);
+const _dirname = path.dirname(_filename);
+const stopwatch = new Stopwatch();
+const timerTotal = stopwatch.start('Sync process start to end');
+
+export async function sync() {
+  try {
+    const rootDir = path.resolve(_dirname, '..');
+    let timer;
+
+    // 1. Cleanup
+    timer = stopwatch.start('Clear distribution directory');
+    const { rimrafSync } = await import('rimraf');
+    rimrafSync(path.join(rootDir, 'dist'));
+    timer.stop();
+
+    // 2. Initial Compilation
+    timer = stopwatch.start('Recompile TypeScript sources');
+    execSync('npx tsc', { cwd: rootDir, stdio: 'inherit' });
+    timer.stop();
+
+    // Lazy imports...
+    const {
+      InterfaceGenerator,
+      ScreenInterfaceRefiner,
+      SchemaGenerator,
+      SubjectComponentGenerator,
+      SubjectGenerator,
+      // SubjectRegistration,
+      ModelDataRefiner
+    } = await import('../dist/artifact-builder/index.js');
+    const { buildSubjects, buildScreens } = await import('../dist/artifact-builder/ModelDataBuilder.js');
+
+    // 3. Data Building
+    timer = stopwatch.start('Build subjects from model data');
+    await buildSubjects();
+    timer.stop();
+
+    timer = stopwatch.start('Build screens from model data');
+    await buildScreens();
+    timer.stop();
+
+    // 4. Refinement
+    timer = stopwatch.start('Refine model data');
+    await new ModelDataRefiner().run();
+    timer.stop();
+
+    // 5. Artifact Generation
+    const interfaceGenerator = new InterfaceGenerator();
+
+    timer = stopwatch.start('Generate screen interfaces from screen schemas');
+    await interfaceGenerator.generateScreenInterfacesFromSchemas();
+    timer.stop();
+
+    timer = stopwatch.start('Refine interfaces');
+    new ScreenInterfaceRefiner().refine();
+    timer.stop();
+
+    timer = stopwatch.start('Generate subject component schemas');
+    new SchemaGenerator().generateSchema();
+    timer.stop();
+
+    timer = stopwatch.start('Generate subject component interfaces from schemas');
+    await interfaceGenerator.generateSubjectInterfacesFromSchemas();
+    timer.stop();
+
+    timer = stopwatch.start('Build components that implement interfaces');
+    new SubjectComponentGenerator().run();
+    timer.stop();
+
+    timer = stopwatch.start('Generate subjects classes');
+    new SubjectGenerator().run();
+    timer.stop();
+
+    // timer = stopwatch.start('Add subjects to registry');
+    // new SubjectRegistration().run();
+    // timer.stop();
+
+    // 6. Final Compilation
+    timer = stopwatch.start('Compile generated artifacts');
+    execSync('npx tsc', { cwd: rootDir, stdio: 'inherit' });
+    timer.stop();
+
+    console.info('Sync process completed successfully.');
+  } catch (error) {
+    console.error('Sync process failed:', error.message);
+    process.exit(1);
+  } finally {
+    const timerBackup = stopwatch.start('Perform Backup');
+    new ArtifactManager().performBackup();
+    timerBackup.stop();
+    timerTotal.stop();
+  }
+}

package/scripts/tsconfig.template.json

@@ -2,7 +2,7 @@
   "compilerOptions": {
     "target": "ES2016",
     "module": "ESNext",
-    "moduleResolution": "node",
+    "moduleResolution": "bundler",
     "typeRoots": ["./node_modules/@types", "./types"],
     "resolveJsonModule": true,
     "esModuleInterop": true,

package/services/ConfigBuilder.ts

@@ -3,7 +3,7 @@ import path from 'node:path';
 import dotenv from 'dotenv';
 
 class ConfigBuilder {
-  private config: Record<string, unknown>;
+  private config: Record<string, unknown> | null = null;
 
   constructor() {
     const baseDir = process.env.INIT_CWD || process.cwd();
@@ -18,19 +18,42 @@ class ConfigBuilder {
     }
 
     if (!fs.existsSync(configFilePath)) {
-      throw new Error(`Config file not found at path: ${configFilePath}`);
+      console.warn(`Config file not found at path: ${configFilePath}`);
+      return;
     }
 
     const fileContent = fs.readFileSync(configFilePath, 'utf-8');
     this.config = JSON.parse(fileContent);
   }
 
+  public async load() {
+    const baseDir = process.env.INIT_CWD || process.cwd();
+    const configFilePath = path.resolve(baseDir, 'Testwise.json');
+
+    if (!fs.existsSync(configFilePath)) {
+      console.warn(`Config file not found at path: ${configFilePath}`);
+      return this;
+    }
+
+    const fileContent = fs.readFileSync(configFilePath, 'utf-8');
+    this.config = JSON.parse(fileContent);
+    return this;
+  }
+
   /**
    * Retrieves a value from the config using a dot-separated key.
    * @param key - The dot-separated key to retrieve the value.
    * @returns The value associated with the key, or undefined if not found.
    */
   public get<T>(key: string): T | undefined {
+    if (!key || typeof key !== 'string') {
+      return undefined;
+    }
+
+    if (!this.config) {
+      return undefined;
+    }
+
     const result = key
       .split('.')
       .reduce(