@jahia/cypress 3.11.0 → 3.13.0

package/dist/utils/ClusterHelper.d.ts

@@ -0,0 +1 @@
+export declare const waitUntilJournalSync: (predicate?: (cluster: any) => boolean, timeout?: number, interval?: number) => void;

package/dist/utils/ClusterHelper.js

@@ -0,0 +1,27 @@
+"use strict";
+exports.__esModule = true;
+exports.waitUntilJournalSync = void 0;
+var waitUntilJournalSync = function (predicate, timeout, interval) {
+    if (timeout === void 0) { timeout = 60000; }
+    if (interval === void 0) { interval = 1000; }
+    cy.waitUntil(function () {
+        return cy.apollo({
+            fetchPolicy: 'no-cache',
+            queryFile: 'graphql/jcr/query/adminCluster.graphql'
+        }).then(function (result) {
+            var _a;
+            var adminResult = (_a = result === null || result === void 0 ? void 0 : result.data) === null || _a === void 0 ? void 0 : _a.admin;
+            if (adminResult) {
+                return adminResult.cluster.isActivated &&
+                    adminResult.cluster.journal.isClusterSync &&
+                    (!predicate || predicate(adminResult.cluster));
+            }
+        });
+    }, {
+        errorMsg: 'Timeout waiting for journal to be synced',
+        timeout: timeout,
+        verbose: true,
+        interval: interval
+    });
+};
+exports.waitUntilJournalSync = waitUntilJournalSync;

package/dist/utils/JCRHelper.d.ts

@@ -11,3 +11,4 @@ export declare const addNode: (variables: {
 export declare const getNodeByPath: (path: string, properties?: string[], language?: string, childrenTypes?: string[], workspace?: 'EDIT' | 'LIVE') => Cypress.Chainable;
 export declare const getNodeAcl: (path: string) => Cypress.Chainable;
 export declare const moveNode: (pathOrId: string, destParentPathOrId: string, destName?: string) => Cypress.Chainable;
+export declare const getNodeTypes: (filter?: {}) => Cypress.Chainable;

package/dist/utils/JCRHelper.js

@@ -1,6 +1,6 @@
 "use strict";
 exports.__esModule = true;
-exports.moveNode = exports.getNodeAcl = exports.getNodeByPath = exports.addNode = exports.deleteNodeProperty = exports.deleteNode = exports.setNodeProperty = void 0;
+exports.getNodeTypes = exports.moveNode = exports.getNodeAcl = exports.getNodeByPath = exports.addNode = exports.deleteNodeProperty = exports.deleteNode = exports.setNodeProperty = void 0;
 var setNodeProperty = function (pathOrId, property, value, language) {
     var mutationFile = 'graphql/jcr/mutation/setProperty.graphql';
     if (value instanceof Array) {
@@ -80,3 +80,13 @@ var moveNode = function (pathOrId, destParentPathOrId, destName) {
     });
 };
 exports.moveNode = moveNode;
+var getNodeTypes = function (filter) {
+    if (filter === void 0) { filter = {}; }
+    return cy.apollo({
+        variables: {
+            filter: filter
+        },
+        queryFile: 'graphql/jcr/query/getNodeTypes.graphql'
+    });
+};
+exports.getNodeTypes = getNodeTypes;

package/dist/utils/index.d.ts

@@ -3,3 +3,4 @@ export * from './PublicationAndWorkflowHelper';
 export * from './SiteHelper';
 export * from './UsersHelper';
 export * from './VanityUrlHelper';
+export * from './ClusterHelper';

package/dist/utils/index.js

@@ -15,3 +15,4 @@ __exportStar(require("./PublicationAndWorkflowHelper"), exports);
 __exportStar(require("./SiteHelper"), exports);
 __exportStar(require("./UsersHelper"), exports);
 __exportStar(require("./VanityUrlHelper"), exports);
+__exportStar(require("./ClusterHelper"), exports);

package/fixtures/graphql/jcr/query/adminCluster.graphql

@@ -0,0 +1,19 @@
+query {
+    admin {
+        cluster {
+            journal {
+                globalRevision
+                localRevision {
+                    revision
+                    serverId
+                }
+                revisions {
+                    revision
+                    serverId
+                }
+                isClusterSync
+            }
+            isActivated
+        }
+    }
+}

package/fixtures/graphql/jcr/query/getNodeTypes.graphql

@@ -0,0 +1,16 @@
+query getNodeTypes($filter: InputNodeTypesListInput!) {
+    jcr {
+        nodeTypes(filter: $filter) {
+            nodes {
+                name
+                icon
+                properties {
+                    name
+                }
+                supertypes {
+                    name
+                }
+            }
+        }
+    }
+}

package/package.json

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

package/schema.graphql

@@ -327,8 +327,6 @@ type AdminMutation {
     jahia: JahiaAdminMutation!
     "Personal API tokens mutations"
     personalApiTokens: PersonalApiTokensMutation
-    "Sitemap API mutations"
-    sitemap: GqlSitemapMutation
 }
 
 "Admin queries root"
@@ -343,8 +341,6 @@ type AdminQuery {
     personalApiTokens: PersonalApiTokensQuery
     "Get available ACL roles; does not include any hidden or privileged roles"
     roles: [AclRole]
-    "Sitemap API queries"
-    sitemap: GqlSitemapQueries
     "Get user administration endpoint"
     userAdmin: UserAdminQuery
     "Get user group endpoint"
@@ -377,6 +373,8 @@ type Category {
 type Cluster {
     "Is the cluster mode activated on this Jahia instance"
     isActivated: Boolean
+    "Query operation on Jahia's journal across all nodes of a cluster"
+    journal: Journal
 }
 
 "Mutation for configuration value object"
@@ -1069,6 +1067,13 @@ type GqlEditorForms {
     ): Int
 }
 
+"Server healthCheck"
+type GqlHealthCheck {
+    probes: [GqlProbe]
+    "Highest reported status across all probes"
+    status: GqlProbeStatus
+}
+
 type GqlJcrImageTransformMutation {
     "Crop an image under the current node"
     cropImage(
@@ -1132,6 +1137,25 @@ type GqlOperationsSupport {
     publication: Boolean!
 }
 
+type GqlProbe {
+    "Description specified by the developer of the probe"
+    description: String
+    "Name of the probe"
+    name: String
+    "Severity of the probe (LOW to CRITICAL)"
+    severity: GqlProbeSeverity
+    "Status reported by the probe (GREEN to RED)"
+    status: GqlProbeStatus
+}
+
+"Probe status"
+type GqlProbeStatus {
+    "Health of the probe"
+    health: GqlProbeHealth
+    "Message explaining probe status"
+    message: String
+}
+
 "Publication status information for a JCR node"
 type GqlPublicationInfo {
     "Whether current user is allowed to publish the node omitting any workflows"
@@ -1160,27 +1184,6 @@ type GqlScope {
     name: String
 }
 
-type GqlSitemapMutation {
-    "Delete existing sitemap cache if exists before expiration time difference"
-    deleteSitemapCache(
-        "Site key"
-        siteKey: String
-    ): Boolean
-    "Sending sitemap(s) based on either sitemap index XML or sitemap XML URL to search engine URL(s) specified in CFG"
-    sendSitemapToSearchEngine(
-        "Sitemap index XML or sitemap XML URL"
-        sitemapURL: String!
-    ): Boolean
-}
-
-type GqlSitemapQueries {
-    "Get site URL with only server domain appended from sitemap URL"
-    siteUrl(
-        "Sitemap index XML or sitemap XML URL"
-        siteKey: String!
-    ): String
-}
-
 type GqlWorkflowEvent {
     "Number of tasks for current user"
     activeWorkflowTaskCountForUser: Int
@@ -1510,6 +1513,8 @@ type JCRNodeMutation {
     ): [VanityUrlMappingMutation]
     "Unlock all nodes under the specified node"
     clearAllLocks: Boolean
+    "Create new version for the node if the node supports versioning"
+    createVersion: Boolean
     "Add wip information"
     createWipInfo(
         "Work in progress information to save"
@@ -2344,6 +2349,29 @@ type JahiaAdminMutation {
         "Configuration pid ot factory pid"
         pid: String!
     ): GqlConfigurationMutation
+    "Create a task"
+    createTask(
+        "Task name"
+        name: String!,
+        "Service name"
+        service: String!
+    ): Boolean
+    "Delete a task"
+    deleteTask(
+        "Task name"
+        name: String!,
+        "Service name"
+        service: String!
+    ): Boolean
+    "Shutdown the server"
+    shutdown(
+        "Do not send the shutdown event"
+        dryRun: Boolean,
+        "Force immediate shutdown even if server is busy"
+        force: Boolean,
+        "In seconds, maximum time to wait for server to be ready to shutdown"
+        timeout: Int
+    ): Boolean
 }
 
 "Jahia admin queries root"
@@ -2357,10 +2385,16 @@ type JahiaAdminQuery {
     ): GqlConfigurationQuery
     "Details about the database Jahia is connected to"
     database: JahiaDatabase
+    "HealthCheck node"
+    healthCheck(severity: GqlProbeSeverity): GqlHealthCheck
+    "Get server load"
+    load: Load
     "Get jobs scheduler"
     scheduler: GqlScheduler
     "Details about the system hosting Jahia"
     system: JahiaSystem
+    "Lists tasks running on the Jahia server. A server should not be stopped/restarted when any of these tasks are present. These tasks are specific to the server being queried and are not shared accorss a cluster"
+    tasks: [task]
     "Version of the running Jahia instance"
     version: JahiaVersion
 }
@@ -2421,6 +2455,42 @@ type JahiaVersion {
     release: String
 }
 
+"Details about the Jahia cluster journal"
+type Journal {
+    "The latest revision of the journal on the cluster"
+    globalRevision: Long
+    "Is the journal in sync across all nodes of a cluster"
+    isClusterSync: Boolean
+    "The latest revision of the journal on the current node"
+    localRevision: JournalRevision
+    "The latest revisions of the journal for all cluster nodes"
+    revisions: [JournalRevision]
+}
+
+"Details about one journal revision"
+type JournalRevision {
+    "The revision"
+    revision: Long
+    "The cluster node server Id"
+    serverId: String
+}
+
+"Server load"
+type Load {
+    "Get requests load"
+    requests: LoadValue
+    "Get JCR Sessions load"
+    sessions: LoadValue
+}
+
+"Load value"
+type LoadValue {
+    "Exponential moving average"
+    average(interval: LoadInterval): Float
+    "Instantaneous count"
+    count: Int
+}
+
 "Information on node lock"
 type LockInfo {
     "Can the node be locked"
@@ -3239,6 +3309,16 @@ type ZipFileMutation {
     ): Boolean
 }
 
+"Task that prevents server from shutdown"
+type task {
+    "The name of the task associated with the service"
+    name: String
+    "Service attached to the task being monitored"
+    service: String
+    "Datetime at which the task was started or registered"
+    started: String
+}
+
 "Work in progress information"
 type wipInfo {
     "The languages set for Work in progress"
@@ -3288,6 +3368,26 @@ enum GqlBackgroundJobStatus {
     SUCCESSFUL
 }
 
+enum GqlProbeHealth {
+    "GREEN"
+    GREEN
+    "RED"
+    RED
+    "YELLOW"
+    YELLOW
+}
+
+enum GqlProbeSeverity {
+    "CRITICAL"
+    CRITICAL
+    "HIGH"
+    HIGH
+    "LOW"
+    LOW
+    "MEDIUM"
+    MEDIUM
+}
+
 enum GroupingType {
     "Put grouped items at the end in the order groups appear in the 'groups' list"
     END
@@ -3331,6 +3431,15 @@ enum JCRPropertyType {
     WEAKREFERENCE
 }
 
+enum LoadInterval {
+    "FIFTEEN"
+    FIFTEEN
+    "FIVE"
+    FIVE
+    "ONE"
+    ONE
+}
+
 enum MulticriteriaEvaluation {
     "The result criteria evaluates positive if all sub-criteria evaluate positive"
     ALL

package/src/utils/ClusterHelper.ts

@@ -0,0 +1,21 @@
+export const waitUntilJournalSync = (predicate?: (cluster: any) => boolean, timeout = 60000,
+    interval = 1000) : void => {
+    cy.waitUntil(() =>
+        cy.apollo({
+            fetchPolicy: 'no-cache',
+            queryFile: 'graphql/jcr/query/adminCluster.graphql'
+        }).then(result => {
+            const adminResult = result?.data?.admin;
+            if (adminResult) {
+                return adminResult.cluster.isActivated &&
+                        adminResult.cluster.journal.isClusterSync &&
+                        (!predicate || predicate(adminResult.cluster));
+            }
+        }),
+    {
+        errorMsg: 'Timeout waiting for journal to be synced',
+        timeout: timeout,
+        verbose: true,
+        interval: interval
+    });
+};

package/src/utils/JCRHelper.ts

@@ -75,3 +75,12 @@ export const moveNode = (pathOrId: string, destParentPathOrId: string, destName?
         mutationFile: 'graphql/jcr/mutation/moveNode.graphql'
     });
 };
+
+export const getNodeTypes = (filter = {}): Cypress.Chainable => {
+    return cy.apollo({
+        variables: {
+            filter: filter
+        },
+        queryFile: 'graphql/jcr/query/getNodeTypes.graphql'
+    });
+};

package/src/utils/index.ts

@@ -3,3 +3,4 @@ export * from './PublicationAndWorkflowHelper';
 export * from './SiteHelper';
 export * from './UsersHelper';
 export * from './VanityUrlHelper';
+export * from './ClusterHelper';