Merge pull request #9 from AutomateThePlanet/bellatrix-extras

Added extras project, added Services hooks and added onError listener for all hooks

Author: teo-nikolov

@bellatrix/appium/tsconfig.json

@@ -3,10 +3,6 @@
     "baseUrl": "src",
     "rootDir": "src",
     "outDir": "lib",
-    "paths": {
-      "*": [ "@bellatrix/appium/*" ],
-      "@bellatrix/core/*": [ "../../core/src/*" ]
-    },
     "lib": [ "ESNext" ],
     "module": "esnext",
     "target": "esnext",
@@ -24,9 +20,6 @@
     "forceConsistentCasingInFileNames": true,
     "allowJs": false
   },
-  "references": [
-    { "path": "../core" }
-  ],
   "include": ["**/*.ts"],
   "exclude": ["node_modules"]
 }

@bellatrix/core/src/types/config.ts

@@ -45,7 +45,7 @@ export type BellatrixConfigurationOverride = BellatrixConfiguration
 //             "delayBeforeAction": 0
 //         },
 //         "executionSettings": {
-//             "browserAutomationTool": "playwright", // selenium, cypress
+//             "browserController": "playwright", // selenium, cypress
 //             "browser": "chrome", // firefox, safari, edge
 //             "headless": false,
 //             "executionType": "local" // remote

@bellatrix/extras/package-lock.json

@@ -0,0 +1,16 @@
+{
+  "name": "@bellatrix/extras",
+  "version": "0.0.1",
+  "type": "module",
+  "exports": {
+    "./hooks": "./src/hooks/index.ts",
+    "./plugins": "./src/plugins/index.ts"
+  },
+  "dependencies": {
+    "@bellatrix/core": "file:../core",
+    "@bellatrix/web": "file:../web"
+  },
+  "peerDependencies": {
+    "typescript": "^5.0.0"
+  }
+}

@bellatrix/extras/package.json

@@ -1,10 +1,10 @@
 import { WebComponentHooks } from '@bellatrix/web/components/utilities';
 import { Anchor, Button, CheckBox, ColorInput, DateInput, DateTimeInput, EmailField, FileInput, MonthInput, NumberInput, PasswordField, PhoneField, RangeInput, SearchField, Select, TextArea, TextField, TimeInput, UrlField, WebComponent, WeekInput } from '@bellatrix/web/components';
 
-export class DefaultWebComponentHooks {
+// TODO: maybe decouple it in different web-extras plugin so extras does not import @bellatrix/web too?
+export class ExtraWebHooks {
     static addComponentBDDLogging(): void {
-        const locale = Intl.DateTimeFormat().resolvedOptions().locale;// TODO: make it configurable
-        const shouldObfuscatePassword = true; // TODO: add as option in configuration
+        const locale = Intl.DateTimeFormat().resolvedOptions().locale; // TODO: add locale option in the config
 
         WebComponentHooks.addListenerTo(Anchor).before('click', (anchor) => console.log(`clicking ${anchor.componentName}`));
         WebComponentHooks.addListenerTo(Button).before('click', (button) => console.log(`clicking ${button.componentName}`));
@@ -17,7 +17,7 @@ export class DefaultWebComponentHooks {
         WebComponentHooks.addListenerTo(FileInput).before('upload', (fileInput, filePath) => console.log(`uploading '${filePath}' into ${fileInput.componentName}`));
         WebComponentHooks.addListenerTo(MonthInput).before('setMonth', (monthInput, year, month) => console.log(`setting ${monthInput} to ${new Date(year, month - 1).toLocaleDateString(locale, { month: 'long', year: 'numeric' })}`));
         WebComponentHooks.addListenerTo(NumberInput).before('setNumber', (numberInput, number) => console.log(`setting ${numberInput.componentName} to ${number}`));
-        WebComponentHooks.addListenerTo(PasswordField).before('setPassword', (passwordField, password) => console.log(`typing ${shouldObfuscatePassword ? '********' : password} into ${passwordField.componentName}`));
+        WebComponentHooks.addListenerTo(PasswordField).before('setPassword', (passwordField, _) => console.log(`typing '********' into ${passwordField.componentName}`));
         WebComponentHooks.addListenerTo(PhoneField).before('setPhone', (phoneField, phone) => console.log(`typing '${phone}' into ${phoneField.componentName}`));
         WebComponentHooks.addListenerTo(RangeInput).before('setValue', (rangeInput, value) => console.log(`setting ${rangeInput.componentName} to ${value}`));
         WebComponentHooks.addListenerTo(SearchField).before('setSearch', (searchField, search) => console.log(`typing '${search}' into ${searchField.componentName}`));
@@ -29,7 +29,8 @@ export class DefaultWebComponentHooks {
         WebComponentHooks.addListenerTo(TimeInput).before('setTime', (timeInput, hours, minutes, seconds) => console.log(`setting ${timeInput.componentName} to ${[hours, minutes, seconds].map(n => String(n ?? 0).padStart(2, '0')).join(':')}`));
         WebComponentHooks.addListenerTo(UrlField).before('setUrl', (urlField, url) => console.log(`typing '${url}' into ${urlField.componentName}`));
         WebComponentHooks.addListenerTo(WeekInput).before('setWeek', (weekInput, year, weekNumber) => console.log(`setting ${weekInput.componentName} to ${year}-W${weekNumber.toString().padStart(2, '0')}`));
-        WebComponentHooks.addListenerTo(WebComponent).before('scrollToVisible', (component) => console.log(`scrolling ${component} into view`));
-        WebComponentHooks.addListenerTo(WebComponent).before('hover', (component) => console.log(`hovering ${component}`)); // TODO: add focus method?
+        WebComponentHooks.addListenerTo(WebComponent).before('scrollIntoView', (component) => console.log(`scrolling ${component} into view`));
+        WebComponentHooks.addListenerTo(WebComponent).before('hover', (component) => console.log(`hovering ${component}`));
+        WebComponentHooks.addListenerTo(WebComponent).before('focus', (component) => console.log(`focusing ${component}`));
     }
 }

@bellatrix/web/src/components/hooks/DefaultWebComponentHooks.ts renamed to @bellatrix/extras/src/hooks/ExtraWebHooks.ts

@@ -0,0 +1 @@
+export * from './ExtraWebHooks';

@bellatrix/extras/src/hooks/index.ts

@@ -0,0 +1,13 @@
+import { Plugin } from '@bellatrix/core/infrastructure';
+import { TestMetadata } from '@bellatrix/core/test/props';
+
+export class LogLifecyclePlugin extends Plugin {
+    override async preBeforeTest(testMetadata: TestMetadata): Promise<void> {
+        console.log('\n==================================================================================\n' +
+            `starting test: ${testMetadata.suiteClass.name} > ${testMetadata.testMethod.name}\n`);
+    }
+
+    override async postAfterTest(_: TestMetadata): Promise<void> {
+        console.log('\n==================================================================================\n');
+    }
+}

@bellatrix/extras/src/plugins/LogLifecyclePlugin.ts

@@ -0,0 +1 @@
+export * from './LogLifecyclePlugin';

@bellatrix/extras/src/plugins/index.ts

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "baseUrl": "src",
+    "rootDir": "src",
+    "outDir": "lib",
+    "lib": [ "ESNext", "DOM" ],
+    "module": "esnext",
+    "target": "esnext",
+    "moduleResolution": "bundler",
+    "moduleDetection": "force",
+    "noImplicitOverride": true,
+    "experimentalDecorators": true,
+    "emitDecoratorMetadata": true,
+    "composite": true,
+    "sourceMap": true,
+    "strict": true,
+    "downlevelIteration": true,
+    "skipLibCheck": true,
+    "allowSyntheticDefaultImports": true,
+    "forceConsistentCasingInFileNames": true,
+    "allowJs": false
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["node_modules"]
+}

@bellatrix/extras/tsconfig.json

@@ -11,10 +11,12 @@
     "./infrastructure": "./src/infrastructure/index.ts",
     "./pages": "./src/pages/index.ts",
     "./pages/decorators": "./src/pages/decorators/index.ts",
-    "./infrastructure/browserautomationtools/core": "./src/infrastructure/browserautomationtools/core/index.ts",
-    "./infrastructure/browserautomationtools/playwright": "./src/infrastructure/browserautomationtools/playwright/index.ts",
-    "./infrastructure/browserautomationtools/selenium": "./src/infrastructure/browserautomationtools/selenium/index.ts",
+    "./infrastructure/browsercontroller/core": "./src/infrastructure/browsercontroller/core/index.ts",
+    "./infrastructure/browsercontroller/playwright": "./src/infrastructure/browsercontroller/playwright/index.ts",
+    "./infrastructure/browsercontroller/selenium": "./src/infrastructure/browsercontroller/selenium/index.ts",
     "./services": "./src/services/index.ts",
+    "./services/decorators": "./src/services/decorators/index.ts",
+    "./services/utilities": "./src/services/utilities/index.ts",
     "./plugins": "./src/plugins/index.ts",
     "./test": "./src/test/index.ts",
     "./types": "./src/types/index.ts",