feat: add option to ignore urls for auto waiting #575

sebbi08 · 2024-01-10T14:26:47Z

Add the option to skip the XHRWaiter an the fetchWaiter based on an regex in the wdi5 config.

sebbi08 · 2024-01-11T08:46:05Z

Could you hint me where in the Docs this should be documented ?

Siolto

Type definition for new optional wdi5 property is missing here

Documentation should be added somewhere here I guess.

client-side-js/injectXHRPatch.cjs

vobu

main thing is my naming suggestion (don't hate me, please)

vobu · 2024-01-12T08:51:51Z

src/types/wdi5.types.ts

+ * Regex for XHR/Fetch requests to be ignored by the auto waiter
+ * Ideal for long polling as this would result in the waiter waiting forever
+ */
+ autoWaitUrlIgnoreRegex?: string[]


don't hate me, please, but I suggest to keep config options as short as possible - would it be possible to drop the "Regex" and just make it ignoreAutoWaitUrls?

haha no hate here :D my naming skills are way to verbal. I am fine with that.

vobu · 2024-01-12T08:54:25Z

src/lib/wdi5-bridge.ts

@@ -135,6 +136,7 @@ export async function injectUI5(config: wdi5Config, browserInstance) {
 const version = await (browserInstance as WebdriverIO.Browser).getUI5Version()
 await checkUI5Version(version)
 await clientSide_injectTools(browserInstance) // helpers for wdi5 browser scope
+ await clientSide_injectXHRPatch(config, browserInstance)


would it be possible to do a await Promise.all([clientSide_injectTools(browserInstance), clientSide_injectXHRPatch(config, browserInstance)]) in order to have those run in parallel and to squeeze out some performance?

hi sadly not the clientSide_injectTools function add the compare version function to the browser and that is needed in clientSide_injectXHRPatch and checkUI5Version is actualy not async.

vobu · 2024-01-12T08:54:48Z

client-side-js/injectXHRPatch.cjs

+ return await browserInstance.executeAsync((config, done) => {
+ const originalFetch = window.fetch
+
+ const autoWaitUrlIgnoreRegex = config.wdi5.autoWaitUrlIgnoreRegex


see my other comment with the renaming suggestion

vobu · 2024-01-12T08:55:27Z

docs/configuration.md

@@ -26,7 +26,8 @@ exports.config = {
 logLevel: "verbose", // [optional] error | verbose | silent, default: "error"
 skipInjectUI5OnStart: false, // [optional] {boolean}, default: false; true when UI5 is not on the start page, you need to later call <wdioUI5service>.injectUI5() manually
 waitForUI5Timeout: 15000, // [optional] {number}, default: 15000; maximum waiting time in milliseconds while checking for UI5 availability
- btpWorkZoneEnablement: false // [optional] {boolean}, default: false; whether to instruct wdi5 to inject itself in both the SAP Build Workzone, standard edition, shell and app
+ btpWorkZoneEnablement: false, // [optional] {boolean}, default: false; whether to instruct wdi5 to inject itself in both the SAP Build Workzone, standard edition, shell and app
+ autoWaitUrlIgnoreRegex: [] // [optional] {string[]}, default: []; Array of regex to ignore certain XHR/Fetch calls wile autowaiting


see my other comment about renaming this setting, please

docs/configuration.md

vobu · 2024-01-12T09:02:03Z

docs/configuration.md

@@ -133,6 +134,12 @@ Number in milliseconds (default: `15000`) to wait for UI5-related operations wit
 Boolean setting to trigger injecting `wdi5` into both the shell and the app when used with the SAP Build Workzone, standard edition. 
 Recommended complement is to also [configure IAS Authentication](authentication?id=sap-cloud-identity-services-identity-authentication): as SAP Build requires its own Identity Provider (most likely provided by using an IAS tenant), you'll have to configure authentication against that as well in `wdi5`.

+### `autoWaitUrlIgnoreRegex`


see my rename comment

vobu · 2024-01-12T09:02:46Z

examples/ui5-js-app/scripts/delayedMockServer.js

@@ -0,0 +1,13 @@
+const femiddleware = require("@sap-ux/ui5-middleware-fe-mockserver")
+
+module.exports = async function middleware(middlewareConfig) {


this is so cool. well well done!!!

vobu · 2024-01-12T09:03:53Z

examples/ui5-js-app/ui5.yaml

@@ -10,3 +10,19 @@ server:
 configuration:
 baseUri: "https://services.odata.org/V2"
 strictSSL: false
+ - name: delayed-mockserver


again: cool idea, well done 😀

vobu · 2024-01-12T09:05:43Z

examples/ui5-js-app/webapp/Component.js

+ })
+ }
+ startXHR()
+ const startFetch = () => {


i keep my fingers crossed that the gh runners are equipped with enough memory for the CI runs 😁

Co-authored-by: Volker Buzek <[email protected]>

sebbi08 added 2 commits January 10, 2024 12:58

feat: add option to ignore urls for auto waiting

3a0445d

fix: fetch waiter is only avaiable after 1.114.0

0d40993

sebbi08 temporarily deployed to internal January 10, 2024 14:26 — with GitHub Actions Inactive

sebbi08 temporarily deployed to internal January 10, 2024 16:05 — with GitHub Actions Inactive

sebbi08 requested review from vobu and Siolto January 11, 2024 08:45

Siolto requested changes Jan 11, 2024

View reviewed changes

client-side-js/injectXHRPatch.cjs Outdated Show resolved Hide resolved

Siolto mentioned this pull request Jan 11, 2024

Endless waiting of XHR requests (Auto Waiter?) #569

Closed

sebbi08 added 3 commits January 11, 2024 10:32

chore: typo

ed1c8f1

chore: added type for new config with documentation

ee4132e

docs: add documentation for autoWaitUrlIgnoreRegex

f278361

sebbi08 temporarily deployed to internal January 11, 2024 12:34 — with GitHub Actions Inactive

vobu reviewed Jan 12, 2024

View reviewed changes

Update docs/configuration.md

39584ed

Co-authored-by: Volker Buzek <[email protected]>

sebbi08 temporarily deployed to internal January 15, 2024 07:10 — with GitHub Actions Inactive

chore: change option naming

3308eb2

sebbi08 temporarily deployed to internal January 15, 2024 07:16 — with GitHub Actions Inactive

Update docs/configuration.md

e3dca08

Co-authored-by: Volker Buzek <[email protected]>

sebbi08 temporarily deployed to internal January 15, 2024 07:18 — with GitHub Actions Inactive

chore: remove unused await

b33fa1b

sebbi08 temporarily deployed to internal January 15, 2024 07:19 — with GitHub Actions Inactive

Merge branch 'main' into feature/add-xhr-fetch-ignore

93164db

vobu temporarily deployed to internal January 15, 2024 08:20 — with GitHub Actions Inactive

vobu merged commit 4f1255c into main Jan 15, 2024
13 checks passed

vobu deleted the feature/add-xhr-fetch-ignore branch January 15, 2024 09:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add option to ignore urls for auto waiting #575

feat: add option to ignore urls for auto waiting #575

sebbi08 commented Jan 10, 2024

sebbi08 commented Jan 11, 2024

Siolto left a comment

vobu left a comment

vobu Jan 12, 2024

sebbi08 Jan 15, 2024

vobu Jan 12, 2024 •

edited

Loading

sebbi08 Jan 15, 2024

vobu Jan 12, 2024

vobu Jan 12, 2024

vobu Jan 12, 2024

vobu Jan 12, 2024

vobu Jan 12, 2024

vobu Jan 12, 2024

		@@ -0,0 +1,13 @@
		const femiddleware = require("@sap-ux/ui5-middleware-fe-mockserver")

		module.exports = async function middleware(middlewareConfig) {

feat: add option to ignore urls for auto waiting #575

feat: add option to ignore urls for auto waiting #575

Conversation

sebbi08 commented Jan 10, 2024

sebbi08 commented Jan 11, 2024

Siolto left a comment

Choose a reason for hiding this comment

vobu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vobu Jan 12, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vobu Jan 12, 2024 •

edited

Loading