@jahia/cypress 3.20.0 → 3.20.1

package/dist/utils/SAMHelper.d.ts

@@ -1 +1 @@
-export declare const waitUntilSAMStatusGreen: (severity?: string, timeout?: number, interval?: number) => void;
+export declare const waitUntilSAMStatusGreen: (severity?: string, timeout?: number, interval?: number, greenMatchCount?: number) => void;

package/dist/utils/SAMHelper.js

@@ -1,10 +1,22 @@
 "use strict";
 exports.__esModule = true;
 exports.waitUntilSAMStatusGreen = void 0;
-var waitUntilSAMStatusGreen = function (severity, timeout, interval) {
+/*
+    When Jahia is starting or performing provisioning operations
+    it is expected for the SAM probe to alternate beween GREEN, YELLOW and RED statuses.
+
+    The primary use of this method is to wait until a Jahia platform stabilizes after a startup or
+    provisioning operation.
+
+    Instead of waiting only for one occurence of a GREEN status, this function will wait until the a
+    GREEN status was returned a number of consecutive times (greenMatchCount).
+*/
+var waitUntilSAMStatusGreen = function (severity, timeout, interval, greenMatchCount) {
     if (severity === void 0) { severity = 'MEDIUM'; }
     if (timeout === void 0) { timeout = 60000; }
-    if (interval === void 0) { interval = 1000; }
+    if (interval === void 0) { interval = 500; }
+    if (greenMatchCount === void 0) { greenMatchCount = 10; }
+    var greenCount = 0;
     cy.waitUntil(function () {
         return cy.apollo({
             fetchPolicy: 'no-cache',
@@ -16,7 +28,8 @@ var waitUntilSAMStatusGreen = function (severity, timeout, interval) {
             var _a, _b, _c, _d;
             var healthStatus = (_d = (_c = (_b = (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.admin) === null || _b === void 0 ? void 0 : _b.jahia) === null || _c === void 0 ? void 0 : _c.healthCheck) === null || _d === void 0 ? void 0 : _d.status;
             if (healthStatus) {
-                return healthStatus.health === 'GREEN';
+                greenCount = healthStatus.health === 'GREEN' ? greenCount + 1 : 0;
+                return greenCount >= greenMatchCount;
             }
         });
     }, {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jahia/cypress",
-  "version": "3.20.0",
+  "version": "3.20.1",
   "scripts": {
     "build": "tsc",
     "lint": "eslint src -c .eslintrc.json --ext .ts"

package/src/utils/SAMHelper.ts

@@ -1,4 +1,15 @@
-export const waitUntilSAMStatusGreen = (severity = 'MEDIUM', timeout = 60000, interval = 1000) : void => {
+/*
+    When Jahia is starting or performing provisioning operations
+    it is expected for the SAM probe to alternate beween GREEN, YELLOW and RED statuses.
+
+    The primary use of this method is to wait until a Jahia platform stabilizes after a startup or
+    provisioning operation.
+
+    Instead of waiting only for one occurence of a GREEN status, this function will wait until the a
+    GREEN status was returned a number of consecutive times (greenMatchCount).
+*/
+export const waitUntilSAMStatusGreen = (severity = 'MEDIUM', timeout = 60000, interval = 500, greenMatchCount = 10) : void => {
+    let greenCount = 0;
     cy.waitUntil(() =>
         cy.apollo({
             fetchPolicy: 'no-cache',
@@ -9,7 +20,8 @@ export const waitUntilSAMStatusGreen = (severity = 'MEDIUM', timeout = 60000, in
         }).then(result => {
             const healthStatus = result?.data?.admin?.jahia?.healthCheck?.status;
             if (healthStatus) {
-                return healthStatus.health === 'GREEN';
+                greenCount = healthStatus.health === 'GREEN' ? greenCount + 1 : 0;
+                return greenCount >= greenMatchCount;
             }
         }),
     {