jsf.js_next_gen 4.1.0-beta.2 → 4.1.0-beta.21

package/src/main/typescript/test/api/JsfPushShimTest.spec.ts

@@ -0,0 +1,126 @@
+/*! Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// AI-generated: this file was created with assistance from Claude (Anthropic) — see AI_CONTRIBUTIONS.md
+import {describe} from "mocha";
+import * as sinon from "sinon";
+import {expect} from "chai";
+import {StandardInits} from "../frameworkBase/_ext/shared/StandardInits";
+import {FakeWebsocket} from "../xhrCore/FakeWebsocket";
+
+const defaultMyFaces23 = StandardInits.defaultMyFaces23;
+
+describe("JSF 2.3 push compatibility shim", function () {
+    beforeEach(async function () {
+        return defaultMyFaces23().then((close) => {
+            this.fakeWebsocket = new FakeWebsocket();
+            this.socket = sinon.stub(window, 'WebSocket').returns(this.fakeWebsocket);
+            (global as any).WebSocket = this.socket;
+            this.pushImpl = (global as any).PushImpl;
+            this.initSpy = sinon.spy(this.pushImpl, "init");
+            this.closeIt = () => {
+                this.initSpy.restore();
+                this.socket.restore();
+                delete (global as any).WebSocket;
+                this.pushImpl.reset();
+                close();
+            };
+        });
+    });
+
+    afterEach(function () {
+        this.closeIt();
+    });
+
+    it("must adapt legacy jsf.push.init without onerror to the Faces 4 init signature", function () {
+        const onopen = () => {};
+        const onmessage = () => {};
+        const onclose = () => {};
+        const behaviors = {"event": [() => {}]};
+
+        window.jsf.push.init("blarg", "booga.ws", "mychannel",
+            onopen,
+            onmessage,
+            onclose,
+            behaviors,
+            false
+        );
+
+        expect(this.initSpy.calledOnce).to.be.true;
+        const args = this.initSpy.firstCall.args;
+        expect(args[0]).to.eq("blarg");
+        expect(args[1]).to.eq("booga.ws");
+        expect(args[2]).to.eq("mychannel");
+        expect(args[3]).to.eq(onopen);
+        expect(args[4]).to.eq(onmessage);
+        expect(args[5], "legacy shim must pass null for Faces 4 onerror").to.eq(null);
+        expect(args[6]).to.eq(onclose);
+        expect(args[7]).to.eq(behaviors);
+        expect(args[8]).to.eq(false);
+        expect(args.length).to.eq(9);
+    });
+
+    it("must route legacy terminal close through onclose", function () {
+        let closeCalled = false;
+        let closeCode: any = null;
+        let closeChannel: any = null;
+        let closeEvent: any = null;
+
+        window.jsf.push.init("blarg", "booga.ws", "mychannel",
+            () => {},
+            () => {},
+            (code: number, channel: string, event: any) => {
+                closeCalled = true;
+                closeCode = code;
+                closeChannel = channel;
+                closeEvent = event;
+            },
+            "",
+            true
+        );
+
+        const event = {code: 1000, reason: "Normal Closure"};
+        this.fakeWebsocket._close(event);
+
+        expect(closeCalled, "legacy jsf.push terminal close must call onclose").to.be.true;
+        expect(closeCode).to.eq(1000);
+        expect(closeChannel).to.eq("mychannel");
+        expect(closeEvent).to.eq(event);
+    });
+
+    it("must keep legacy reconnectable broken connection internal without calling onclose", function () {
+        const clock = sinon.useFakeTimers();
+        let closeCalled = false;
+        let openCount = 0;
+
+        try {
+            window.jsf.push.init("blarg", "booga.ws", "mychannel",
+                () => { openCount++; },
+                () => {},
+                () => { closeCalled = true; },
+                "",
+                true
+            );
+
+            this.fakeWebsocket.onopen({});
+            this.fakeWebsocket._close({code: 1006, reason: "abnormal"});
+
+            expect(openCount, "legacy onopen must fire for the first connection attempt").to.eq(1);
+            expect(closeCalled, "legacy onclose must not fire while reconnect is possible").to.be.false;
+        } finally {
+            clock.restore();
+        }
+    });
+});

package/src/main/typescript/test/api/MyFacesABTest.spec.ts

@@ -1,3 +1,19 @@
+/*! Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import {describe} from "mocha";
 import {StandardInits} from "../frameworkBase/_ext/shared/StandardInits";
 const defaultMyFaces = StandardInits.defaultMyFaces;

package/src/main/typescript/test/api/PushTypeCompatibility.ts

@@ -0,0 +1,65 @@
+/*! Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// AI-generated: this file was created with assistance from Claude (Anthropic) — see AI_CONTRIBUTIONS.md
+
+import type { faces } from '../../api/_api';
+
+/**
+ * Compatibility interface covering both the faces 9-param form (with onerror)
+ * and the JSF 2.3 8-param form (without onerror). Both must be callable so
+ * that the runtime implementation works correctly in both the faces and JSF realms.
+ * This file is never executed — tsc rejecting it signals a broken signature.
+ */
+interface PushCompat {
+    init(socketClientId: string, url: string, channel: string,
+         onopen: faces.push.OnOpenHandler | string | null,
+         onmessage: faces.push.OnMessageHandler | string | null,
+         onerror: faces.push.OnErrorHandler | string | null,
+         onclose: faces.push.OnCloseHandler | string | null,
+         behaviors: Record<string, Array<() => void>>,
+         autoConnect: boolean): void;
+    init(socketClientId: string, url: string, channel: string,
+         onopen: faces.push.OnOpenHandler | string | null,
+         onmessage: faces.push.OnMessageHandler | string | null,
+         onclose: faces.push.OnCloseHandler | string | null,
+         behaviors: Record<string, Array<() => void>>,
+         autoConnect: boolean): void;
+    open(socketClientId: string): void;
+    close(socketClientId: string): void;
+}
+
+function verifyPushInitTypeCompatibility(push: PushCompat): void {
+    // faces 4.0 form — with onerror
+    push.init("clientId1", "booga.ws", "mychannel",
+        () => {},
+        () => {},
+        () => {},
+        () => {},
+        {},
+        true
+    );
+
+    // JSF 2.3 legacy form — without onerror
+    push.init("clientId1", "booga.ws", "mychannel",
+        () => {},
+        () => {},
+        () => {},
+        {},
+        true
+    );
+}
+
+verifyPushInitTypeCompatibility;

package/src/main/typescript/test/frameworkBase/LangTest.spec.ts

@@ -1,3 +1,19 @@
+/*! Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 import {expect} from 'chai';
 import {describe, it} from 'mocha';
 import {Lang} from "mona-dish";

package/src/main/typescript/test/frameworkBase/_ext/monadish/DomQueryTest.spec.ts

@@ -59,6 +59,7 @@ describe('DOMQuery tests', function () {
         (global as any).window = window;
         (global as any).body = window.document.body;
         (global as any).document = window.document;
+        delete (global as any).MutationObserver;
 
 
     });

package/src/main/typescript/test/frameworkBase/_ext/monadish/XmlQueryTest.spec.ts

@@ -0,0 +1,16 @@
+/*! Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+

package/src/main/typescript/test/frameworkBase/_ext/monadish/markups/tobago-with-header.ts

@@ -1,3 +1,19 @@
+/*! Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 export const tobagoSheetWithHeader = `<tobago-sheet id="page:mainForm:s1" data-tobago-selection-mode="multi" data-tobago-first="0" rows="0" row-count="88" data-tobago-layout="{&quot;columns&quot;:[1.0]}">
                    <style nonce="" id="page:mainForm:s1:j_id_2n">#page\\:mainForm\\:s1{max-height:486px;}
                    </style>

package/src/main/typescript/test/frameworkBase/_ext/monadish/markups/tobago-without-header.ts

@@ -1,3 +1,19 @@
+/*! Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 export const tobagoSheetWithoutHeader = `<tobago-sheet id="page:mainForm:s1" data-tobago-selection-mode="multi" data-tobago-first="0" rows="0" row-count="88" data-tobago-layout="{&quot;columns&quot;:[1.0]}">
   <style nonce="" id="page:mainForm:s1:j_id_2n">#page\\:mainForm\\:s1{max-height:486px;}
   </style>

package/src/main/typescript/test/frameworkBase/_ext/shared/StandardInits.ts

@@ -16,9 +16,7 @@
 
 
 import {DomQuery} from "mona-dish";
-
-
-declare let global;
+declare let global: any;
 declare let faces: any;
 declare let jsf: any;
 declare let myfaces: any;
@@ -38,6 +36,49 @@ declare let myfaces: any;
  */
 export namespace StandardInits {
 
+    type GlobalJsdom = (html?: string, options?: object) => () => void;
+    type GlobalJsdomModule = GlobalJsdom | { default?: GlobalJsdom };
+
+    function resolveGlobalJsdom(domIt: GlobalJsdomModule): GlobalJsdom {
+        return typeof domIt === "function" ? domIt : domIt.default;
+    }
+
+    function createStorageMock(): Storage {
+        const data: Record<string, string> = {};
+
+        return {
+            get length() {
+                return Object.keys(data).length;
+            },
+            clear() {
+                Object.keys(data).forEach(key => delete data[key]);
+            },
+            getItem(key: string) {
+                return Object.prototype.hasOwnProperty.call(data, key) ? data[key] : null;
+            },
+            key(index: number) {
+                return Object.keys(data)[index] ?? null;
+            },
+            removeItem(key: string) {
+                delete data[key];
+            },
+            setItem(key: string, value: string) {
+                data[key] = `${value}`;
+            }
+        };
+    }
+
+    function installStorageMocks(window: Window) {
+        Object.defineProperty(window, "localStorage", {
+            configurable: true,
+            value: createStorageMock()
+        });
+        Object.defineProperty(window, "sessionStorage", {
+            configurable: true,
+            value: createStorageMock()
+        });
+    }
+
     export const HTML_DEFAULT = `<!DOCTYPE html>
 <html lang="en">
 <head>
@@ -637,15 +678,17 @@ function triggerRequestChain(event) {
      */
     let initJSDOM = async function (template: string) {
         // @ts-ignore
-        return import('jsdom-global').then((domIt) => {
+        return import('global-jsdom').then((domIt) => {
+            (global as any).document?.destroy?.();
             let params = {
                 contentType: "text/html",
                 runScripts: "dangerously",
                 resources: "usable",
-                url: `file://${__dirname}/index.html`
+                url: `file://${__dirname}/index.html`,
+                beforeParse: installStorageMocks
             };
             //we have two different apis depending whether we allow module interop with sinon or not
-            return (domIt?.default ?? domIt)?.(template, params) ;
+            return resolveGlobalJsdom(domIt)(template, params);
         });
     };
 
@@ -700,8 +743,11 @@ function triggerRequestChain(event) {
             await initJSF(IS_JSF_40);
         } else {
             // @ts-ignore
-            await import('jsdom-global').then((domIt) => {
-                clean = (domIt?.default ?? domIt)?.(template);
+            await import('global-jsdom').then((domIt) => {
+                clean = resolveGlobalJsdom(domIt)(template, {
+                    url: `file://${__dirname}/index.html`,
+                    beforeParse: installStorageMocks
+                });
             });
         }
         //the async is returning a promise on the caller level
@@ -709,4 +755,4 @@ function triggerRequestChain(event) {
         return clean;
 
     }
-}
+}

package/src/main/typescript/test/frameworkBase/_ext/shared/XmlResponses.ts

@@ -1,3 +1,19 @@
+/*! Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
 export class XmlResponses {
 
     static EVAL_1 = `

package/src/main/typescript/test/impl/AssertionsTest.spec.ts

@@ -0,0 +1,168 @@
+/*! Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to you under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License.  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+// AI-generated: this file was created with assistance from Claude (Anthropic) — see AI_CONTRIBUTIONS.md
+import {describe, it} from "mocha";
+import {expect} from "chai";
+import {XMLQuery} from "mona-dish";
+import {Assertions} from "../../impl/util/Assertions";
+import {StandardInits} from "../frameworkBase/_ext/shared/StandardInits";
+import {Implementation} from "../../impl/AjaxImpl";
+
+const defaultMyFaces = StandardInits.defaultMyFaces;
+
+// Pure functions — no DOM required.
+describe("Assertions.assert", () => {
+
+    it("does not throw when the value is truthy", () => {
+        expect(() => Assertions.assert(true, "msg")).not.to.throw();
+        expect(() => Assertions.assert(1, "msg")).not.to.throw();
+        expect(() => Assertions.assert("x", "msg")).not.to.throw();
+    });
+
+    it("throws when the value is falsy", () => {
+        expect(() => Assertions.assert(false, "must fail")).to.throw();
+        expect(() => Assertions.assert(0, "must fail")).to.throw();
+        expect(() => Assertions.assert(null, "must fail")).to.throw();
+    });
+
+    it("includes the message in the thrown error", () => {
+        expect(() => Assertions.assert(false, "sentinel message"))
+            .to.throw(/sentinel message/);
+    });
+});
+
+describe("Assertions.assertType", () => {
+
+    it("does not throw when value is null or undefined", () => {
+        expect(() => Assertions.assertType(null, "function")).not.to.throw();
+        expect(() => Assertions.assertType(undefined, "function")).not.to.throw();
+    });
+
+    it("does not throw when value matches the expected type", () => {
+        expect(() => Assertions.assertType(() => {}, "function")).not.to.throw();
+        expect(() => Assertions.assertType("hello", "string")).not.to.throw();
+    });
+
+    it("throws when value is truthy but does not match the expected type", () => {
+        expect(() => Assertions.assertType(42, "function", "bad type")).to.throw();
+        expect(() => Assertions.assertType("str", "function", "bad type")).to.throw();
+    });
+});
+
+describe("Assertions.assertFunction", () => {
+
+    it("does not throw for null or undefined (falsy passthrough)", () => {
+        expect(() => Assertions.assertFunction(null)).not.to.throw();
+        expect(() => Assertions.assertFunction(undefined)).not.to.throw();
+    });
+
+    it("does not throw for an actual function", () => {
+        expect(() => Assertions.assertFunction(() => {})).not.to.throw();
+    });
+
+    it("throws when a non-function truthy value is passed", () => {
+        expect(() => Assertions.assertFunction(42 as any)).to.throw();
+        expect(() => Assertions.assertFunction("callback" as any)).to.throw();
+    });
+});
+
+describe("Assertions.assertDelay", () => {
+
+    it("does not throw for zero", () => {
+        expect(() => Assertions.assertDelay(0)).not.to.throw();
+    });
+
+    it("does not throw for positive numbers", () => {
+        expect(() => Assertions.assertDelay(100)).not.to.throw();
+        expect(() => Assertions.assertDelay(0.5)).not.to.throw();
+    });
+
+    it("throws for negative numbers", () => {
+        expect(() => Assertions.assertDelay(-1)).to.throw("Invalid delay value");
+    });
+
+    it("throws for NaN", () => {
+        expect(() => Assertions.assertDelay(NaN)).to.throw("Invalid delay value");
+    });
+
+    it("throws for a non-numeric string", () => {
+        expect(() => Assertions.assertDelay("fast" as any)).to.throw("Invalid delay value");
+    });
+});
+
+describe("Assertions.raiseError", () => {
+
+    it("returns an Error instance", () => {
+        const err = Assertions.raiseError(new Error(), "something went wrong");
+        expect(err).to.be.instanceOf(Error);
+    });
+
+    it("falls back to MALFORMEDXML when title and name are omitted", () => {
+        const err = Assertions.raiseError(new Error(), "msg", "caller") as any;
+        expect(err).to.be.instanceOf(Error);
+    });
+
+    it("uses the supplied title and name when provided", () => {
+        const err = Assertions.raiseError(new Error(), "msg", "caller", "MyTitle", "MyName") as any;
+        expect(err).to.be.instanceOf(Error);
+    });
+});
+
+// Tests that require XMLQuery / DOMParser — JSDOM setup needed.
+describe("Assertions XML (requires DOM)", () => {
+
+    beforeEach(async function () {
+        return defaultMyFaces().then((close) => {
+            this.closeIt = () => { Implementation.reset(); close(); };
+        });
+    });
+
+    afterEach(function () { this.closeIt(); });
+
+    describe("assertUrlExists", () => {
+
+        function xqWithUrl(present: boolean): XMLQuery {
+            // assertUrlExists only calls node.attr(ATTR_URL).isAbsent()
+            return { attr: (_: string) => ({ isAbsent: () => !present }) } as any;
+        }
+
+        it("does not throw when the url attribute is present", () => {
+            expect(() => Assertions.assertUrlExists(xqWithUrl(true))).not.to.throw();
+        });
+
+        it("throws when the url attribute is absent", () => {
+            expect(() => Assertions.assertUrlExists(xqWithUrl(false))).to.throw();
+        });
+    });
+
+    describe("assertValidXMLResponse", () => {
+
+        it("does not throw for a well-formed partial-response document", () => {
+            const doc = new DOMParser().parseFromString(
+                '<partial-response><changes/></partial-response>', "text/xml");
+            expect(() => Assertions.assertValidXMLResponse(new XMLQuery(doc))).not.to.throw();
+        });
+
+        it("throws when the response is absent (null)", () => {
+            expect(() => Assertions.assertValidXMLResponse(new XMLQuery(null as any))).to.throw();
+        });
+
+        it("throws when the partial-response root element is missing", () => {
+            const doc = new DOMParser().parseFromString('<other-root/>', "text/xml");
+            expect(() => Assertions.assertValidXMLResponse(new XMLQuery(doc))).to.throw();
+        });
+    });
+});