@webiny/app-websockets 0.0.0-unstable.e6f0dc8ca7 → 0.0.0-unstable.e9333b3f0b

package/WebsocketsContextProvider.js

@@ -1,154 +1,146 @@
-import React, { useCallback, useEffect, useMemo, useRef, useState } from "react";
+import react, { useCallback, useEffect, useMemo, useRef, useState } from "react";
 import { useFeature, useTenantContext } from "@webiny/app-admin";
 import { AuthenticationContextFeature } from "@webiny/app-admin/features/security/AuthenticationContext/feature.js";
+import { EventPublisherFeature } from "@webiny/app/features/eventPublisher/feature.js";
+import { EnvConfigFeature } from "@webiny/app/features/envConfig/feature.js";
+import { WebsocketEvent } from "./events/WebsocketEvent.js";
 import { WebsocketsCloseCode } from "./types.js";
 import { createWebsocketsAction, createWebsocketsActions, createWebsocketsConnection, createWebsocketsManager, createWebsocketsSubscriptionManager } from "./domain/index.js";
-import { getUrl } from "./utils/getUrl.js";
-export const WebsocketsContext = /*#__PURE__*/React.createContext(undefined);
-export const WebsocketsContextProvider = props => {
-  const {
-    tenant
-  } = useTenantContext();
-  const {
-    authenticationContext
-  } = useFeature(AuthenticationContextFeature);
-  const socketsRef = useRef(null);
-  const [current, setCurrent] = useState({});
-  const getToken = useCallback(async () => {
-    return await authenticationContext.getIdToken();
-  }, [authenticationContext]);
-  const subscriptionManager = useMemo(() => {
-    const manager = createWebsocketsSubscriptionManager();
-    let currentIteration = 0;
-    manager.onClose(event => {
-      if (currentIteration > 5 || event.code !== WebsocketsCloseCode.GOING_AWAY) {
-        return;
-      }
-      currentIteration++;
-      setTimeout(() => {
-        if (!socketsRef.current) {
-          return;
-        } else if (socketsRef.current.isClosed()) {
-          console.log("Running auto-reconnect.");
-          socketsRef.current.connect();
-        }
-      }, 1000);
+const noopSubscription = ()=>({
+        cb: ()=>void 0,
+        id: "",
+        off: ()=>void 0
     });
-    return manager;
-  }, []);
-
-  /**
-   * We need this useEffect to close the websocket connection and remove window focus event in case component is unmounted.
-   * This will, probably, happen only during the development phase.
-   *
-   * If we did not disconnect on component unmount, we would have a memory leak - multiple connections would be opened.
-   */
-  useEffect(() => {
-    /**
-     * We want to add a window event listener which will check if the connection is closed, and if its - it will connect again.
-     */
-    const abortController = new AbortController();
-    window.addEventListener("focus", () => {
-      if (!socketsRef.current) {
-        return;
-      } else if (socketsRef.current.isClosed()) {
-        console.log("Running auto-reconnect on focus.");
-        socketsRef.current.connect();
-      }
-    }, {
-      signal: abortController.signal
-    });
-    window.addEventListener("close", () => {
-      subscriptionManager.triggerOnClose(new CloseEvent("windowClose", {
-        code: WebsocketsCloseCode.GOING_AWAY,
-        reason: "Closing Window or Tab."
-      }));
-    }, {
-      signal: abortController.signal
-    });
-    return () => {
-      abortController.abort();
-    };
-  }, []);
-  useEffect(() => {
-    (async () => {
-      const token = await getToken();
-      if (!token || !tenant) {
-        return;
-      } else if (current.tenant === tenant) {
-        return;
-      } else if (socketsRef.current) {
-        await socketsRef.current.close(WebsocketsCloseCode.NORMAL, "Changing tenant.");
-      }
-      const url = getUrl();
-      if (!url) {
-        console.error("Not possible to connect to the websocket without a valid URL.", {
-          tenant,
-          token
+const WebsocketsContext = /*#__PURE__*/ react.createContext(void 0);
+const WebsocketsContextProvider = (props)=>{
+    const { tenant } = useTenantContext();
+    const { authenticationContext } = useFeature(AuthenticationContextFeature);
+    const { eventPublisher } = useFeature(EventPublisherFeature);
+    const envConfig = useFeature(EnvConfigFeature);
+    const configuredWsUrl = envConfig.get("websocketUrl");
+    const wsUrl = configuredWsUrl ? configuredWsUrl : void 0;
+    const socketsRef = useRef(null);
+    const [current, setCurrent] = useState({});
+    const getToken = useCallback(async ()=>await authenticationContext.getIdToken(), [
+        authenticationContext
+    ]);
+    const subscriptionManager = useMemo(()=>createWebsocketsSubscriptionManager(), []);
+    useEffect(()=>{
+        const abortController = new AbortController();
+        window.addEventListener("focus", ()=>{
+            if (!socketsRef.current) return;
+            if (socketsRef.current.isClosed()) {
+                console.log("Running auto-reconnect on focus.");
+                socketsRef.current.connect();
+            }
+        }, {
+            signal: abortController.signal
         });
-        return;
-      }
-      socketsRef.current = createWebsocketsManager(createWebsocketsConnection({
-        subscriptionManager,
-        url,
+        window.addEventListener("close", ()=>{
+            subscriptionManager.triggerOnClose(new CloseEvent("windowClose", {
+                code: WebsocketsCloseCode.GOING_AWAY,
+                reason: "Closing Window or Tab."
+            }));
+        }, {
+            signal: abortController.signal
+        });
+        return ()=>{
+            abortController.abort();
+        };
+    }, []);
+    useEffect(()=>{
+        (async ()=>{
+            const token = await getToken();
+            if (!token || !tenant) return;
+            if (current.tenant === tenant) return;
+            if (socketsRef.current) await socketsRef.current.close(WebsocketsCloseCode.NORMAL, "Changing tenant.");
+            const url = wsUrl;
+            if (!url) return void console.warn("WebSocket URL not configured; real-time updates are disabled.");
+            socketsRef.current = createWebsocketsManager(createWebsocketsConnection({
+                subscriptionManager,
+                url,
+                tenant,
+                getToken,
+                protocol: [
+                    "webiny-ws-v1"
+                ]
+            }));
+            await socketsRef.current.connect();
+            setCurrent({
+                tenant
+            });
+        })();
+    }, [
         tenant,
+        subscriptionManager,
         getToken,
-        protocol: ["webiny-ws-v1"]
-      }));
-      await socketsRef.current.connect();
-      setCurrent({
-        tenant
-      });
-    })();
-  }, [tenant, subscriptionManager, getToken]);
-  const websocketActions = useMemo(() => {
-    return createWebsocketsActions({
-      manager: socketsRef.current,
-      tenant,
-      getToken
-    });
-  }, [socketsRef.current, tenant, getToken]);
-  const send = useCallback(async (action, data, timeout) => {
-    return websocketActions.run({
-      action,
-      data,
-      timeout
-    });
-  }, [websocketActions]);
-  const createAction = useCallback(name => {
-    return createWebsocketsAction(websocketActions, name);
-  }, [websocketActions]);
-  const onMessage = useCallback((action, cb) => {
-    return socketsRef.current.onMessage(async event => {
-      if (event.data.action !== action) {
-        return;
-      }
-      cb(event.data);
-    });
-  }, [socketsRef.current]);
-  const onError = useCallback(cb => {
-    return socketsRef.current.onError(data => {
-      return cb(data);
-    });
-  }, [socketsRef.current]);
-  const onClose = useCallback(cb => {
-    return socketsRef.current.onClose(data => {
-      return cb(data);
+        wsUrl
+    ]);
+    useEffect(()=>{
+        if (!socketsRef.current) return;
+        const subscription = socketsRef.current.onMessage(async (event)=>{
+            await eventPublisher.publish(new WebsocketEvent(event.data));
+        });
+        return ()=>{
+            subscription.off();
+        };
+    }, [
+        current.tenant,
+        eventPublisher
+    ]);
+    const websocketActions = useMemo(()=>createWebsocketsActions({
+            manager: socketsRef.current,
+            tenant,
+            getToken
+        }), [
+        socketsRef.current,
+        tenant,
+        getToken
+    ]);
+    const send = useCallback(async (action, data, timeout)=>websocketActions.run({
+            action,
+            data,
+            timeout
+        }), [
+        websocketActions
+    ]);
+    const createAction = useCallback((name)=>createWebsocketsAction(websocketActions, name), [
+        websocketActions
+    ]);
+    const onMessage = useCallback((action, cb)=>{
+        if (!socketsRef.current) return noopSubscription();
+        return socketsRef.current.onMessage(async (event)=>{
+            if (event.data.action !== action) return;
+            cb(event.data);
+        });
+    }, [
+        socketsRef.current
+    ]);
+    const onError = useCallback((cb)=>{
+        if (!socketsRef.current) return noopSubscription();
+        return socketsRef.current.onError((data)=>cb(data));
+    }, [
+        socketsRef.current
+    ]);
+    const onClose = useCallback((cb)=>{
+        if (!socketsRef.current) return noopSubscription();
+        return socketsRef.current.onClose((data)=>cb(data));
+    }, [
+        socketsRef.current
+    ]);
+    if (wsUrl && !socketsRef.current) return props.loader || null;
+    const value = {
+        send,
+        createAction,
+        onMessage,
+        onError,
+        onClose
+    };
+    return /*#__PURE__*/ react.createElement(WebsocketsContext.Provider, {
+        value: value,
+        ...props
     });
-  }, [socketsRef.current]);
-  if (!socketsRef.current) {
-    return props.loader || null;
-  }
-  const value = {
-    send,
-    createAction,
-    onMessage,
-    onError,
-    onClose
-  };
-  return /*#__PURE__*/React.createElement(WebsocketsContext.Provider, Object.assign({
-    value: value
-  }, props));
 };
+export { WebsocketsContext, WebsocketsContextProvider };
 
 //# sourceMappingURL=WebsocketsContextProvider.js.map

package/WebsocketsContextProvider.js.map

@@ -1 +1 @@
-{"version":3,"names":["React","useCallback","useEffect","useMemo","useRef","useState","useFeature","useTenantContext","AuthenticationContextFeature","WebsocketsCloseCode","createWebsocketsAction","createWebsocketsActions","createWebsocketsConnection","createWebsocketsManager","createWebsocketsSubscriptionManager","getUrl","WebsocketsContext","createContext","undefined","WebsocketsContextProvider","props","tenant","authenticationContext","socketsRef","current","setCurrent","getToken","getIdToken","subscriptionManager","manager","currentIteration","onClose","event","code","GOING_AWAY","setTimeout","isClosed","console","log","connect","abortController","AbortController","window","addEventListener","signal","triggerOnClose","CloseEvent","reason","abort","token","close","NORMAL","url","error","protocol","websocketActions","send","action","data","timeout","run","createAction","name","onMessage","cb","onError","loader","value","createElement","Provider","Object","assign"],"sources":["WebsocketsContextProvider.tsx"],"sourcesContent":["import React, { useCallback, useEffect, useMemo, useRef, useState } from \"react\";\nimport { useFeature, useTenantContext } from \"@webiny/app-admin\";\nimport { AuthenticationContextFeature } from \"@webiny/app-admin/features/security/AuthenticationContext/feature.js\";\nimport type {\n    IncomingGenericData,\n    IWebsocketsContext,\n    IWebsocketsContextSendCallable,\n    IWebsocketsManagerCloseEvent,\n    IWebsocketsManagerErrorEvent\n} from \"~/types.js\";\nimport { WebsocketsCloseCode } from \"~/types.js\";\nimport {\n    createWebsocketsAction,\n    createWebsocketsActions,\n    createWebsocketsConnection,\n    createWebsocketsManager,\n    createWebsocketsSubscriptionManager\n} from \"./domain/index.js\";\nimport type { IGenericData, IWebsocketsManager } from \"./domain/types.js\";\nimport { getUrl } from \"./utils/getUrl.js\";\n\nexport interface IWebsocketsContextProviderProps {\n    loader?: React.ReactElement;\n    children: React.ReactNode;\n}\n\nexport const WebsocketsContext = React.createContext<IWebsocketsContext>(\n    undefined as unknown as IWebsocketsContext\n);\n\ninterface ICurrentData {\n    tenant?: string;\n}\n\nexport const WebsocketsContextProvider = (props: IWebsocketsContextProviderProps) => {\n    const { tenant } = useTenantContext();\n    const { authenticationContext } = useFeature(AuthenticationContextFeature);\n\n    const socketsRef = useRef<IWebsocketsManager | null>(null);\n\n    const [current, setCurrent] = useState<ICurrentData>({});\n\n    const getToken = useCallback(async () => {\n        return await authenticationContext.getIdToken();\n    }, [authenticationContext]);\n\n    const subscriptionManager = useMemo(() => {\n        const manager = createWebsocketsSubscriptionManager();\n\n        let currentIteration = 0;\n        manager.onClose(event => {\n            if (currentIteration > 5 || event.code !== WebsocketsCloseCode.GOING_AWAY) {\n                return;\n            }\n            currentIteration++;\n            setTimeout(() => {\n                if (!socketsRef.current) {\n                    return;\n                } else if (socketsRef.current.isClosed()) {\n                    console.log(\"Running auto-reconnect.\");\n\n                    socketsRef.current.connect();\n                }\n            }, 1000);\n        });\n\n        return manager;\n    }, []);\n\n    /**\n     * We need this useEffect to close the websocket connection and remove window focus event in case component is unmounted.\n     * This will, probably, happen only during the development phase.\n     *\n     * If we did not disconnect on component unmount, we would have a memory leak - multiple connections would be opened.\n     */\n    useEffect(() => {\n        /**\n         * We want to add a window event listener which will check if the connection is closed, and if its - it will connect again.\n         */\n        const abortController = new AbortController();\n\n        window.addEventListener(\n            \"focus\",\n            () => {\n                if (!socketsRef.current) {\n                    return;\n                } else if (socketsRef.current.isClosed()) {\n                    console.log(\"Running auto-reconnect on focus.\");\n                    socketsRef.current.connect();\n                }\n            },\n            { signal: abortController.signal }\n        );\n        window.addEventListener(\n            \"close\",\n            () => {\n                subscriptionManager.triggerOnClose(\n                    new CloseEvent(\"windowClose\", {\n                        code: WebsocketsCloseCode.GOING_AWAY,\n                        reason: \"Closing Window or Tab.\"\n                    })\n                );\n            },\n            { signal: abortController.signal }\n        );\n\n        return () => {\n            abortController.abort();\n        };\n    }, []);\n\n    useEffect(() => {\n        (async () => {\n            const token = await getToken();\n            if (!token || !tenant) {\n                return;\n            } else if (current.tenant === tenant) {\n                return;\n            } else if (socketsRef.current) {\n                await socketsRef.current.close(WebsocketsCloseCode.NORMAL, \"Changing tenant.\");\n            }\n            const url = getUrl();\n\n            if (!url) {\n                console.error(\"Not possible to connect to the websocket without a valid URL.\", {\n                    tenant,\n                    token\n                });\n                return;\n            }\n\n            socketsRef.current = createWebsocketsManager(\n                createWebsocketsConnection({\n                    subscriptionManager,\n                    url,\n                    tenant,\n                    getToken,\n                    protocol: [\"webiny-ws-v1\"]\n                })\n            );\n            await socketsRef.current.connect();\n\n            setCurrent({ tenant });\n        })();\n    }, [tenant, subscriptionManager, getToken]);\n\n    const websocketActions = useMemo(() => {\n        return createWebsocketsActions({\n            manager: socketsRef.current!,\n            tenant,\n            getToken\n        });\n    }, [socketsRef.current, tenant, getToken]);\n\n    const send = useCallback<IWebsocketsContextSendCallable>(\n        async (action, data, timeout) => {\n            return websocketActions.run({\n                action,\n                data,\n                timeout\n            });\n        },\n        [websocketActions]\n    );\n\n    const createAction = useCallback(\n        <T extends IGenericData = IGenericData, R extends IGenericData = IGenericData>(\n            name: string\n        ) => {\n            return createWebsocketsAction<T, R>(websocketActions, name);\n        },\n        [websocketActions]\n    );\n\n    const onMessage = useCallback(\n        <T extends IncomingGenericData = IncomingGenericData>(\n            action: string,\n            cb: (data: T) => void\n        ) => {\n            return socketsRef.current!.onMessage<T>(async event => {\n                if (event.data.action !== action) {\n                    return;\n                }\n                cb(event.data);\n            });\n        },\n        [socketsRef.current]\n    );\n\n    const onError = useCallback(\n        (cb: (data: IWebsocketsManagerErrorEvent) => void) => {\n            return socketsRef.current!.onError(data => {\n                return cb(data);\n            });\n        },\n        [socketsRef.current]\n    );\n\n    const onClose = useCallback(\n        (cb: (data: IWebsocketsManagerCloseEvent) => void) => {\n            return socketsRef.current!.onClose(data => {\n                return cb(data);\n            });\n        },\n        [socketsRef.current]\n    );\n\n    if (!socketsRef.current) {\n        return props.loader || null;\n    }\n\n    const value: IWebsocketsContext = {\n        send,\n        createAction,\n        onMessage,\n        onError,\n        onClose\n    };\n    return <WebsocketsContext.Provider value={value} {...props} />;\n};\n"],"mappings":"AAAA,OAAOA,KAAK,IAAIC,WAAW,EAAEC,SAAS,EAAEC,OAAO,EAAEC,MAAM,EAAEC,QAAQ,QAAQ,OAAO;AAChF,SAASC,UAAU,EAAEC,gBAAgB,QAAQ,mBAAmB;AAChE,SAASC,4BAA4B,QAAQ,sEAAsE;AAQnH,SAASC,mBAAmB;AAC5B,SACIC,sBAAsB,EACtBC,uBAAuB,EACvBC,0BAA0B,EAC1BC,uBAAuB,EACvBC,mCAAmC;AAGvC,SAASC,MAAM;AAOf,OAAO,MAAMC,iBAAiB,gBAAGhB,KAAK,CAACiB,aAAa,CAChDC,SACJ,CAAC;AAMD,OAAO,MAAMC,yBAAyB,GAAIC,KAAsC,IAAK;EACjF,MAAM;IAAEC;EAAO,CAAC,GAAGd,gBAAgB,CAAC,CAAC;EACrC,MAAM;IAAEe;EAAsB,CAAC,GAAGhB,UAAU,CAACE,4BAA4B,CAAC;EAE1E,MAAMe,UAAU,GAAGnB,MAAM,CAA4B,IAAI,CAAC;EAE1D,MAAM,CAACoB,OAAO,EAAEC,UAAU,CAAC,GAAGpB,QAAQ,CAAe,CAAC,CAAC,CAAC;EAExD,MAAMqB,QAAQ,GAAGzB,WAAW,CAAC,YAAY;IACrC,OAAO,MAAMqB,qBAAqB,CAACK,UAAU,CAAC,CAAC;EACnD,CAAC,EAAE,CAACL,qBAAqB,CAAC,CAAC;EAE3B,MAAMM,mBAAmB,GAAGzB,OAAO,CAAC,MAAM;IACtC,MAAM0B,OAAO,GAAGf,mCAAmC,CAAC,CAAC;IAErD,IAAIgB,gBAAgB,GAAG,CAAC;IACxBD,OAAO,CAACE,OAAO,CAACC,KAAK,IAAI;MACrB,IAAIF,gBAAgB,GAAG,CAAC,IAAIE,KAAK,CAACC,IAAI,KAAKxB,mBAAmB,CAACyB,UAAU,EAAE;QACvE;MACJ;MACAJ,gBAAgB,EAAE;MAClBK,UAAU,CAAC,MAAM;QACb,IAAI,CAACZ,UAAU,CAACC,OAAO,EAAE;UACrB;QACJ,CAAC,MAAM,IAAID,UAAU,CAACC,OAAO,CAACY,QAAQ,CAAC,CAAC,EAAE;UACtCC,OAAO,CAACC,GAAG,CAAC,yBAAyB,CAAC;UAEtCf,UAAU,CAACC,OAAO,CAACe,OAAO,CAAC,CAAC;QAChC;MACJ,CAAC,EAAE,IAAI,CAAC;IACZ,CAAC,CAAC;IAEF,OAAOV,OAAO;EAClB,CAAC,EAAE,EAAE,CAAC;;EAEN;AACJ;AACA;AACA;AACA;AACA;EACI3B,SAAS,CAAC,MAAM;IACZ;AACR;AACA;IACQ,MAAMsC,eAAe,GAAG,IAAIC,eAAe,CAAC,CAAC;IAE7CC,MAAM,CAACC,gBAAgB,CACnB,OAAO,EACP,MAAM;MACF,IAAI,CAACpB,UAAU,CAACC,OAAO,EAAE;QACrB;MACJ,CAAC,MAAM,IAAID,UAAU,CAACC,OAAO,CAACY,QAAQ,CAAC,CAAC,EAAE;QACtCC,OAAO,CAACC,GAAG,CAAC,kCAAkC,CAAC;QAC/Cf,UAAU,CAACC,OAAO,CAACe,OAAO,CAAC,CAAC;MAChC;IACJ,CAAC,EACD;MAAEK,MAAM,EAAEJ,eAAe,CAACI;IAAO,CACrC,CAAC;IACDF,MAAM,CAACC,gBAAgB,CACnB,OAAO,EACP,MAAM;MACFf,mBAAmB,CAACiB,cAAc,CAC9B,IAAIC,UAAU,CAAC,aAAa,EAAE;QAC1Bb,IAAI,EAAExB,mBAAmB,CAACyB,UAAU;QACpCa,MAAM,EAAE;MACZ,CAAC,CACL,CAAC;IACL,CAAC,EACD;MAAEH,MAAM,EAAEJ,eAAe,CAACI;IAAO,CACrC,CAAC;IAED,OAAO,MAAM;MACTJ,eAAe,CAACQ,KAAK,CAAC,CAAC;IAC3B,CAAC;EACL,CAAC,EAAE,EAAE,CAAC;EAEN9C,SAAS,CAAC,MAAM;IACZ,CAAC,YAAY;MACT,MAAM+C,KAAK,GAAG,MAAMvB,QAAQ,CAAC,CAAC;MAC9B,IAAI,CAACuB,KAAK,IAAI,CAAC5B,MAAM,EAAE;QACnB;MACJ,CAAC,MAAM,IAAIG,OAAO,CAACH,MAAM,KAAKA,MAAM,EAAE;QAClC;MACJ,CAAC,MAAM,IAAIE,UAAU,CAACC,OAAO,EAAE;QAC3B,MAAMD,UAAU,CAACC,OAAO,CAAC0B,KAAK,CAACzC,mBAAmB,CAAC0C,MAAM,EAAE,kBAAkB,CAAC;MAClF;MACA,MAAMC,GAAG,GAAGrC,MAAM,CAAC,CAAC;MAEpB,IAAI,CAACqC,GAAG,EAAE;QACNf,OAAO,CAACgB,KAAK,CAAC,+DAA+D,EAAE;UAC3EhC,MAAM;UACN4B;QACJ,CAAC,CAAC;QACF;MACJ;MAEA1B,UAAU,CAACC,OAAO,GAAGX,uBAAuB,CACxCD,0BAA0B,CAAC;QACvBgB,mBAAmB;QACnBwB,GAAG;QACH/B,MAAM;QACNK,QAAQ;QACR4B,QAAQ,EAAE,CAAC,cAAc;MAC7B,CAAC,CACL,CAAC;MACD,MAAM/B,UAAU,CAACC,OAAO,CAACe,OAAO,CAAC,CAAC;MAElCd,UAAU,CAAC;QAAEJ;MAAO,CAAC,CAAC;IAC1B,CAAC,EAAE,CAAC;EACR,CAAC,EAAE,CAACA,MAAM,EAAEO,mBAAmB,EAAEF,QAAQ,CAAC,CAAC;EAE3C,MAAM6B,gBAAgB,GAAGpD,OAAO,CAAC,MAAM;IACnC,OAAOQ,uBAAuB,CAAC;MAC3BkB,OAAO,EAAEN,UAAU,CAACC,OAAQ;MAC5BH,MAAM;MACNK;IACJ,CAAC,CAAC;EACN,CAAC,EAAE,CAACH,UAAU,CAACC,OAAO,EAAEH,MAAM,EAAEK,QAAQ,CAAC,CAAC;EAE1C,MAAM8B,IAAI,GAAGvD,WAAW,CACpB,OAAOwD,MAAM,EAAEC,IAAI,EAAEC,OAAO,KAAK;IAC7B,OAAOJ,gBAAgB,CAACK,GAAG,CAAC;MACxBH,MAAM;MACNC,IAAI;MACJC;IACJ,CAAC,CAAC;EACN,CAAC,EACD,CAACJ,gBAAgB,CACrB,CAAC;EAED,MAAMM,YAAY,GAAG5D,WAAW,CAExB6D,IAAY,IACX;IACD,OAAOpD,sBAAsB,CAAO6C,gBAAgB,EAAEO,IAAI,CAAC;EAC/D,CAAC,EACD,CAACP,gBAAgB,CACrB,CAAC;EAED,MAAMQ,SAAS,GAAG9D,WAAW,CACzB,CACIwD,MAAc,EACdO,EAAqB,KACpB;IACD,OAAOzC,UAAU,CAACC,OAAO,CAAEuC,SAAS,CAAI,MAAM/B,KAAK,IAAI;MACnD,IAAIA,KAAK,CAAC0B,IAAI,CAACD,MAAM,KAAKA,MAAM,EAAE;QAC9B;MACJ;MACAO,EAAE,CAAChC,KAAK,CAAC0B,IAAI,CAAC;IAClB,CAAC,CAAC;EACN,CAAC,EACD,CAACnC,UAAU,CAACC,OAAO,CACvB,CAAC;EAED,MAAMyC,OAAO,GAAGhE,WAAW,CACtB+D,EAAgD,IAAK;IAClD,OAAOzC,UAAU,CAACC,OAAO,CAAEyC,OAAO,CAACP,IAAI,IAAI;MACvC,OAAOM,EAAE,CAACN,IAAI,CAAC;IACnB,CAAC,CAAC;EACN,CAAC,EACD,CAACnC,UAAU,CAACC,OAAO,CACvB,CAAC;EAED,MAAMO,OAAO,GAAG9B,WAAW,CACtB+D,EAAgD,IAAK;IAClD,OAAOzC,UAAU,CAACC,OAAO,CAAEO,OAAO,CAAC2B,IAAI,IAAI;MACvC,OAAOM,EAAE,CAACN,IAAI,CAAC;IACnB,CAAC,CAAC;EACN,CAAC,EACD,CAACnC,UAAU,CAACC,OAAO,CACvB,CAAC;EAED,IAAI,CAACD,UAAU,CAACC,OAAO,EAAE;IACrB,OAAOJ,KAAK,CAAC8C,MAAM,IAAI,IAAI;EAC/B;EAEA,MAAMC,KAAyB,GAAG;IAC9BX,IAAI;IACJK,YAAY;IACZE,SAAS;IACTE,OAAO;IACPlC;EACJ,CAAC;EACD,oBAAO/B,KAAA,CAAAoE,aAAA,CAACpD,iBAAiB,CAACqD,QAAQ,EAAAC,MAAA,CAAAC,MAAA;IAACJ,KAAK,EAAEA;EAAM,GAAK/C,KAAK,CAAG,CAAC;AAClE,CAAC","ignoreList":[]}
+{"version":3,"file":"WebsocketsContextProvider.js","sources":["../src/WebsocketsContextProvider.tsx"],"sourcesContent":["import React, { useCallback, useEffect, useMemo, useRef, useState } from \"react\";\nimport { useFeature, useTenantContext } from \"@webiny/app-admin\";\nimport { AuthenticationContextFeature } from \"@webiny/app-admin/features/security/AuthenticationContext/feature.js\";\nimport { EventPublisherFeature } from \"@webiny/app/features/eventPublisher/feature.js\";\nimport { EnvConfigFeature } from \"@webiny/app/features/envConfig/feature.js\";\nimport { WebsocketEvent } from \"./events/WebsocketEvent.js\";\nimport type {\n    IncomingGenericData,\n    IWebsocketsContext,\n    IWebsocketsContextSendCallable,\n    IWebsocketsManagerCloseEvent,\n    IWebsocketsManagerErrorEvent\n} from \"~/types.js\";\nimport { WebsocketsCloseCode } from \"~/types.js\";\nimport {\n    createWebsocketsAction,\n    createWebsocketsActions,\n    createWebsocketsConnection,\n    createWebsocketsManager,\n    createWebsocketsSubscriptionManager\n} from \"./domain/index.js\";\nimport type { IGenericData, IWebsocketsManager } from \"./domain/types.js\";\nimport type { IWebsocketsSubscription } from \"./domain/abstractions/IWebsocketsSubscriptionManager.js\";\n\n// No-op subscription returned when WS isn't connected (no URL configured).\nconst noopSubscription = (): IWebsocketsSubscription<any> => ({\n    cb: () => undefined,\n    id: \"\",\n    off: () => undefined\n});\n\nexport interface IWebsocketsContextProviderProps {\n    loader?: React.ReactElement;\n    children: React.ReactNode;\n}\n\nexport const WebsocketsContext = React.createContext<IWebsocketsContext>(\n    undefined as unknown as IWebsocketsContext\n);\n\ninterface ICurrentData {\n    tenant?: string;\n}\n\nexport const WebsocketsContextProvider = (props: IWebsocketsContextProviderProps) => {\n    const { tenant } = useTenantContext();\n    const { authenticationContext } = useFeature(AuthenticationContextFeature);\n    const { eventPublisher } = useFeature(EventPublisherFeature);\n\n    // The WebSocket URL is resolved once, at the admin composition root, into EnvConfig (the only\n    // place that reads process.env). Empty string = not configured → real-time updates are disabled.\n    const envConfig = useFeature(EnvConfigFeature);\n    const configuredWsUrl = envConfig.get(\"websocketUrl\");\n    const wsUrl = configuredWsUrl ? configuredWsUrl : undefined;\n\n    const socketsRef = useRef<IWebsocketsManager | null>(null);\n\n    const [current, setCurrent] = useState<ICurrentData>({});\n\n    const getToken = useCallback(async () => {\n        return await authenticationContext.getIdToken();\n    }, [authenticationContext]);\n\n    // Reconnecting after an unexpected close (with backoff) and the keepalive heartbeat live in\n    // WebsocketsConnection, next to the socket they manage.\n    const subscriptionManager = useMemo(() => createWebsocketsSubscriptionManager(), []);\n\n    /**\n     * We need this useEffect to close the websocket connection and remove window focus event in case component is unmounted.\n     * This will, probably, happen only during the development phase.\n     *\n     * If we did not disconnect on component unmount, we would have a memory leak - multiple connections would be opened.\n     */\n    useEffect(() => {\n        /**\n         * We want to add a window event listener which will check if the connection is closed, and if its - it will connect again.\n         */\n        const abortController = new AbortController();\n\n        window.addEventListener(\n            \"focus\",\n            () => {\n                if (!socketsRef.current) {\n                    return;\n                } else if (socketsRef.current.isClosed()) {\n                    console.log(\"Running auto-reconnect on focus.\");\n                    socketsRef.current.connect();\n                }\n            },\n            { signal: abortController.signal }\n        );\n        window.addEventListener(\n            \"close\",\n            () => {\n                subscriptionManager.triggerOnClose(\n                    new CloseEvent(\"windowClose\", {\n                        code: WebsocketsCloseCode.GOING_AWAY,\n                        reason: \"Closing Window or Tab.\"\n                    })\n                );\n            },\n            { signal: abortController.signal }\n        );\n\n        return () => {\n            abortController.abort();\n        };\n    }, []);\n\n    useEffect(() => {\n        (async () => {\n            const token = await getToken();\n            if (!token || !tenant) {\n                return;\n            } else if (current.tenant === tenant) {\n                return;\n            } else if (socketsRef.current) {\n                await socketsRef.current.close(WebsocketsCloseCode.NORMAL, \"Changing tenant.\");\n            }\n            const url = wsUrl;\n\n            if (!url) {\n                // No WS URL configured (e.g. the standalone hosting type) — skip WS, run app anyway.\n                console.warn(\"WebSocket URL not configured; real-time updates are disabled.\");\n                return;\n            }\n\n            socketsRef.current = createWebsocketsManager(\n                createWebsocketsConnection({\n                    subscriptionManager,\n                    url,\n                    tenant,\n                    getToken,\n                    protocol: [\"webiny-ws-v1\"]\n                })\n            );\n            await socketsRef.current.connect();\n\n            setCurrent({ tenant });\n        })();\n    }, [tenant, subscriptionManager, getToken, wsUrl]);\n\n    /**\n     * Bridge: subscribe once to ALL incoming websocket messages and re-publish each one through\n     * the EventPublisher as a `WebsocketEvent`. Feature code registers `WebsocketEventHandler`\n     * handlers instead of subscribing to the websocket service directly.\n     */\n    useEffect(() => {\n        if (!socketsRef.current) {\n            return;\n        }\n        const subscription = socketsRef.current.onMessage<IncomingGenericData>(async event => {\n            await eventPublisher.publish(new WebsocketEvent(event.data));\n        });\n        return () => {\n            subscription.off();\n        };\n    }, [current.tenant, eventPublisher]);\n\n    const websocketActions = useMemo(() => {\n        return createWebsocketsActions({\n            manager: socketsRef.current!,\n            tenant,\n            getToken\n        });\n    }, [socketsRef.current, tenant, getToken]);\n\n    const send = useCallback<IWebsocketsContextSendCallable>(\n        async (action, data, timeout) => {\n            return websocketActions.run({\n                action,\n                data,\n                timeout\n            });\n        },\n        [websocketActions]\n    );\n\n    const createAction = useCallback(\n        <T extends IGenericData = IGenericData, R extends IGenericData = IGenericData>(\n            name: string\n        ) => {\n            return createWebsocketsAction<T, R>(websocketActions, name);\n        },\n        [websocketActions]\n    );\n\n    const onMessage = useCallback(\n        <T extends IncomingGenericData = IncomingGenericData>(\n            action: string,\n            cb: (data: T) => void\n        ) => {\n            // No-op subscription when WS isn't connected (e.g. no URL configured).\n            if (!socketsRef.current) {\n                return noopSubscription();\n            }\n            return socketsRef.current.onMessage<T>(async event => {\n                if (event.data.action !== action) {\n                    return;\n                }\n                cb(event.data);\n            });\n        },\n        [socketsRef.current]\n    );\n\n    const onError = useCallback(\n        (cb: (data: IWebsocketsManagerErrorEvent) => void) => {\n            if (!socketsRef.current) {\n                return noopSubscription();\n            }\n            return socketsRef.current.onError(data => {\n                return cb(data);\n            });\n        },\n        [socketsRef.current]\n    );\n\n    const onClose = useCallback(\n        (cb: (data: IWebsocketsManagerCloseEvent) => void) => {\n            if (!socketsRef.current) {\n                return noopSubscription();\n            }\n            return socketsRef.current.onClose(data => {\n                return cb(data);\n            });\n        },\n        [socketsRef.current]\n    );\n\n    // Only block the app on the WS connection when WS is actually configured. Without a URL\n    // (e.g. the standalone hosting type), skip WS and render the app anyway.\n    if (wsUrl && !socketsRef.current) {\n        return props.loader || null;\n    }\n\n    const value: IWebsocketsContext = {\n        send,\n        createAction,\n        onMessage,\n        onError,\n        onClose\n    };\n    return <WebsocketsContext.Provider value={value} {...props} />;\n};\n"],"names":["noopSubscription","undefined","WebsocketsContext","React","WebsocketsContextProvider","props","tenant","useTenantContext","authenticationContext","useFeature","AuthenticationContextFeature","eventPublisher","EventPublisherFeature","envConfig","EnvConfigFeature","configuredWsUrl","wsUrl","socketsRef","useRef","current","setCurrent","useState","getToken","useCallback","subscriptionManager","useMemo","createWebsocketsSubscriptionManager","useEffect","abortController","AbortController","window","console","CloseEvent","WebsocketsCloseCode","token","url","createWebsocketsManager","createWebsocketsConnection","subscription","event","WebsocketEvent","websocketActions","createWebsocketsActions","send","action","data","timeout","createAction","name","createWebsocketsAction","onMessage","cb","onError","onClose","value"],"mappings":";;;;;;;;AAyBA,MAAMA,mBAAmB,IAAqC;QAC1D,IAAI,IAAMC;QACV,IAAI;QACJ,KAAK,IAAMA;IACf;AAOO,MAAMC,oBAAoB,WAAHA,GAAGC,MAAAA,aAAmB,CAChDF;AAOG,MAAMG,4BAA4B,CAACC;IACtC,MAAM,EAAEC,MAAM,EAAE,GAAGC;IACnB,MAAM,EAAEC,qBAAqB,EAAE,GAAGC,WAAWC;IAC7C,MAAM,EAAEC,cAAc,EAAE,GAAGF,WAAWG;IAItC,MAAMC,YAAYJ,WAAWK;IAC7B,MAAMC,kBAAkBF,UAAU,GAAG,CAAC;IACtC,MAAMG,QAAQD,kBAAkBA,kBAAkBd;IAElD,MAAMgB,aAAaC,OAAkC;IAErD,MAAM,CAACC,SAASC,WAAW,GAAGC,SAAuB,CAAC;IAEtD,MAAMC,WAAWC,YAAY,UAClB,MAAMf,sBAAsB,UAAU,IAC9C;QAACA;KAAsB;IAI1B,MAAMgB,sBAAsBC,QAAQ,IAAMC,uCAAuC,EAAE;IAQnFC,UAAU;QAIN,MAAMC,kBAAkB,IAAIC;QAE5BC,OAAO,gBAAgB,CACnB,SACA;YACI,IAAI,CAACb,WAAW,OAAO,EACnB;YACG,IAAIA,WAAW,OAAO,CAAC,QAAQ,IAAI;gBACtCc,QAAQ,GAAG,CAAC;gBACZd,WAAW,OAAO,CAAC,OAAO;YAC9B;QACJ,GACA;YAAE,QAAQW,gBAAgB,MAAM;QAAC;QAErCE,OAAO,gBAAgB,CACnB,SACA;YACIN,oBAAoB,cAAc,CAC9B,IAAIQ,WAAW,eAAe;gBAC1B,MAAMC,oBAAoB,UAAU;gBACpC,QAAQ;YACZ;QAER,GACA;YAAE,QAAQL,gBAAgB,MAAM;QAAC;QAGrC,OAAO;YACHA,gBAAgB,KAAK;QACzB;IACJ,GAAG,EAAE;IAELD,UAAU;QACL;YACG,MAAMO,QAAQ,MAAMZ;YACpB,IAAI,CAACY,SAAS,CAAC5B,QACX;YACG,IAAIa,QAAQ,MAAM,KAAKb,QAC1B;YACG,IAAIW,WAAW,OAAO,EACzB,MAAMA,WAAW,OAAO,CAAC,KAAK,CAACgB,oBAAoB,MAAM,EAAE;YAE/D,MAAME,MAAMnB;YAEZ,IAAI,CAACmB,KAAK,YAENJ,QAAQ,IAAI,CAAC;YAIjBd,WAAW,OAAO,GAAGmB,wBACjBC,2BAA2B;gBACvBb;gBACAW;gBACA7B;gBACAgB;gBACA,UAAU;oBAAC;iBAAe;YAC9B;YAEJ,MAAML,WAAW,OAAO,CAAC,OAAO;YAEhCG,WAAW;gBAAEd;YAAO;QACxB;IACJ,GAAG;QAACA;QAAQkB;QAAqBF;QAAUN;KAAM;IAOjDW,UAAU;QACN,IAAI,CAACV,WAAW,OAAO,EACnB;QAEJ,MAAMqB,eAAerB,WAAW,OAAO,CAAC,SAAS,CAAsB,OAAMsB;YACzE,MAAM5B,eAAe,OAAO,CAAC,IAAI6B,eAAeD,MAAM,IAAI;QAC9D;QACA,OAAO;YACHD,aAAa,GAAG;QACpB;IACJ,GAAG;QAACnB,QAAQ,MAAM;QAAER;KAAe;IAEnC,MAAM8B,mBAAmBhB,QAAQ,IACtBiB,wBAAwB;YAC3B,SAASzB,WAAW,OAAO;YAC3BX;YACAgB;QACJ,IACD;QAACL,WAAW,OAAO;QAAEX;QAAQgB;KAAS;IAEzC,MAAMqB,OAAOpB,YACT,OAAOqB,QAAQC,MAAMC,UACVL,iBAAiB,GAAG,CAAC;YACxBG;YACAC;YACAC;QACJ,IAEJ;QAACL;KAAiB;IAGtB,MAAMM,eAAexB,YACjB,CACIyB,OAEOC,uBAA6BR,kBAAkBO,OAE1D;QAACP;KAAiB;IAGtB,MAAMS,YAAY3B,YACd,CACIqB,QACAO;QAGA,IAAI,CAAClC,WAAW,OAAO,EACnB,OAAOjB;QAEX,OAAOiB,WAAW,OAAO,CAAC,SAAS,CAAI,OAAMsB;YACzC,IAAIA,MAAM,IAAI,CAAC,MAAM,KAAKK,QACtB;YAEJO,GAAGZ,MAAM,IAAI;QACjB;IACJ,GACA;QAACtB,WAAW,OAAO;KAAC;IAGxB,MAAMmC,UAAU7B,YACZ,CAAC4B;QACG,IAAI,CAAClC,WAAW,OAAO,EACnB,OAAOjB;QAEX,OAAOiB,WAAW,OAAO,CAAC,OAAO,CAAC4B,CAAAA,OACvBM,GAAGN;IAElB,GACA;QAAC5B,WAAW,OAAO;KAAC;IAGxB,MAAMoC,UAAU9B,YACZ,CAAC4B;QACG,IAAI,CAAClC,WAAW,OAAO,EACnB,OAAOjB;QAEX,OAAOiB,WAAW,OAAO,CAAC,OAAO,CAAC4B,CAAAA,OACvBM,GAAGN;IAElB,GACA;QAAC5B,WAAW,OAAO;KAAC;IAKxB,IAAID,SAAS,CAACC,WAAW,OAAO,EAC5B,OAAOZ,MAAM,MAAM,IAAI;IAG3B,MAAMiD,QAA4B;QAC9BX;QACAI;QACAG;QACAE;QACAC;IACJ;IACA,OAAO,WAAP,GAAO,oBAACnD,kBAAkB,QAAQ;QAAC,OAAOoD;QAAQ,GAAGjD,KAAK;;AAC9D"}

package/domain/WebsocketsAction.js

@@ -1,28 +1,21 @@
-export class WebsocketsAction {
-  constructor(actions, name) {
-    this.name = name;
-    this.actions = actions;
-  }
-  async trigger(params) {
-    const {
-      data,
-      onResponse,
-      timeout = 10000
-    } = params || {};
-    const promise = this.actions.run({
-      action: this.name,
-      data,
-      timeout: onResponse && timeout > 0 ? timeout : undefined
-    });
-    if (!onResponse) {
-      return null;
+class WebsocketsAction {
+    constructor(actions, name){
+        this.name = name;
+        this.actions = actions;
+    }
+    async trigger(params) {
+        const { data, onResponse, timeout = 10000 } = params || {};
+        const promise = this.actions.run({
+            action: this.name,
+            data,
+            timeout: onResponse && timeout > 0 ? timeout : void 0
+        });
+        if (!onResponse) return null;
+        const result = await promise;
+        return onResponse(result);
     }
-    const result = await promise;
-    return onResponse(result);
-  }
 }
-export const createWebsocketsAction = (actions, name) => {
-  return new WebsocketsAction(actions, name);
-};
+const createWebsocketsAction = (actions, name)=>new WebsocketsAction(actions, name);
+export { WebsocketsAction, createWebsocketsAction };
 
 //# sourceMappingURL=WebsocketsAction.js.map

package/domain/WebsocketsAction.js.map

@@ -1 +1 @@
-{"version":3,"names":["WebsocketsAction","constructor","actions","name","trigger","params","data","onResponse","timeout","promise","run","action","undefined","result","createWebsocketsAction"],"sources":["WebsocketsAction.ts"],"sourcesContent":["import type {\n    IGenericData,\n    IWebsocketsAction,\n    IWebsocketsActions,\n    IWebsocketsActionsTriggerParams\n} from \"./types.js\";\n\nexport class WebsocketsAction<\n    T extends IGenericData = IGenericData,\n    R extends IGenericData = IGenericData\n> implements IWebsocketsAction<T, R> {\n    private readonly actions: IWebsocketsActions;\n    private readonly name: string;\n\n    public constructor(actions: IWebsocketsActions, name: string) {\n        this.name = name;\n        this.actions = actions;\n    }\n\n    public async trigger(params?: IWebsocketsActionsTriggerParams<T, R>): Promise<R | null> {\n        const { data, onResponse, timeout = 10000 } = params || {};\n        const promise = this.actions.run<T, R>({\n            action: this.name,\n            data,\n            timeout: onResponse && timeout > 0 ? timeout : undefined\n        });\n        if (!onResponse) {\n            return null;\n        }\n        const result = await promise;\n\n        return onResponse(result);\n    }\n}\n\nexport const createWebsocketsAction = <\n    T extends IGenericData = IGenericData,\n    R extends IGenericData = IGenericData\n>(\n    actions: IWebsocketsActions,\n    name: string\n): IWebsocketsAction<T, R> => {\n    return new WebsocketsAction<T, R>(actions, name);\n};\n"],"mappings":"AAOA,OAAO,MAAMA,gBAAgB,CAGQ;EAI1BC,WAAWA,CAACC,OAA2B,EAAEC,IAAY,EAAE;IAC1D,IAAI,CAACA,IAAI,GAAGA,IAAI;IAChB,IAAI,CAACD,OAAO,GAAGA,OAAO;EAC1B;EAEA,MAAaE,OAAOA,CAACC,MAA8C,EAAqB;IACpF,MAAM;MAAEC,IAAI;MAAEC,UAAU;MAAEC,OAAO,GAAG;IAAM,CAAC,GAAGH,MAAM,IAAI,CAAC,CAAC;IAC1D,MAAMI,OAAO,GAAG,IAAI,CAACP,OAAO,CAACQ,GAAG,CAAO;MACnCC,MAAM,EAAE,IAAI,CAACR,IAAI;MACjBG,IAAI;MACJE,OAAO,EAAED,UAAU,IAAIC,OAAO,GAAG,CAAC,GAAGA,OAAO,GAAGI;IACnD,CAAC,CAAC;IACF,IAAI,CAACL,UAAU,EAAE;MACb,OAAO,IAAI;IACf;IACA,MAAMM,MAAM,GAAG,MAAMJ,OAAO;IAE5B,OAAOF,UAAU,CAACM,MAAM,CAAC;EAC7B;AACJ;AAEA,OAAO,MAAMC,sBAAsB,GAAGA,CAIlCZ,OAA2B,EAC3BC,IAAY,KACc;EAC1B,OAAO,IAAIH,gBAAgB,CAAOE,OAAO,EAAEC,IAAI,CAAC;AACpD,CAAC","ignoreList":[]}
+{"version":3,"file":"domain/WebsocketsAction.js","sources":["../../src/domain/WebsocketsAction.ts"],"sourcesContent":["import type {\n    IGenericData,\n    IWebsocketsAction,\n    IWebsocketsActions,\n    IWebsocketsActionsTriggerParams\n} from \"./types.js\";\n\nexport class WebsocketsAction<\n    T extends IGenericData = IGenericData,\n    R extends IGenericData = IGenericData\n> implements IWebsocketsAction<T, R> {\n    private readonly actions: IWebsocketsActions;\n    private readonly name: string;\n\n    public constructor(actions: IWebsocketsActions, name: string) {\n        this.name = name;\n        this.actions = actions;\n    }\n\n    public async trigger(params?: IWebsocketsActionsTriggerParams<T, R>): Promise<R | null> {\n        const { data, onResponse, timeout = 10000 } = params || {};\n        const promise = this.actions.run<T, R>({\n            action: this.name,\n            data,\n            timeout: onResponse && timeout > 0 ? timeout : undefined\n        });\n        if (!onResponse) {\n            return null;\n        }\n        const result = await promise;\n\n        return onResponse(result);\n    }\n}\n\nexport const createWebsocketsAction = <\n    T extends IGenericData = IGenericData,\n    R extends IGenericData = IGenericData\n>(\n    actions: IWebsocketsActions,\n    name: string\n): IWebsocketsAction<T, R> => {\n    return new WebsocketsAction<T, R>(actions, name);\n};\n"],"names":["WebsocketsAction","actions","name","params","data","onResponse","timeout","promise","undefined","result","createWebsocketsAction"],"mappings":"AAOO,MAAMA;IAOT,YAAmBC,OAA2B,EAAEC,IAAY,CAAE;QAC1D,IAAI,CAAC,IAAI,GAAGA;QACZ,IAAI,CAAC,OAAO,GAAGD;IACnB;IAEA,MAAa,QAAQE,MAA8C,EAAqB;QACpF,MAAM,EAAEC,IAAI,EAAEC,UAAU,EAAEC,UAAU,KAAK,EAAE,GAAGH,UAAU,CAAC;QACzD,MAAMI,UAAU,IAAI,CAAC,OAAO,CAAC,GAAG,CAAO;YACnC,QAAQ,IAAI,CAAC,IAAI;YACjBH;YACA,SAASC,cAAcC,UAAU,IAAIA,UAAUE;QACnD;QACA,IAAI,CAACH,YACD,OAAO;QAEX,MAAMI,SAAS,MAAMF;QAErB,OAAOF,WAAWI;IACtB;AACJ;AAEO,MAAMC,yBAAyB,CAIlCT,SACAC,OAEO,IAAIF,iBAAuBC,SAASC"}

package/domain/WebsocketsActions.js

@@ -1,79 +1,58 @@
-export class WebsocketsActions {
-  constructor(params) {
-    this.manager = params.manager;
-    this.tenant = params.tenant;
-    this.getToken = params.getToken;
-  }
-  async run(params) {
-    const {
-      action,
-      timeout,
-      data
-    } = params;
-    const token = await this.getToken();
-    if (!token) {
-      console.error("Token is not set - cannot send a websocket message.");
-      return null;
-    } else if (!this.tenant) {
-      console.error("Tenant is not set - cannot send a websocket message.");
-      return null;
+class WebsocketsActions {
+    constructor(params){
+        this.manager = params.manager;
+        this.tenant = params.tenant;
+        this.getToken = params.getToken;
     }
-
-    /**
-     * If no timeout was sent, we will just send the message and return null.
-     * No waiting for the response.
-     */
-    if (!timeout || timeout < 0) {
-      this.manager.send({
-        /**
-         * It is ok to cast as we are checking the values a few lines above.
-         */
-        token,
-        tenant: this.tenant,
-        action,
-        data: data || {}
-      });
-      return null;
-    }
-    /**
-     * In case of a timeout, we will send the message and wait for the response.
-     */
-    return await new Promise((resolve, reject) => {
-      let promiseTimeout = null;
-      const subscription = this.manager.onMessage(async event => {
-        if (event.data.messageId !== subscription.id) {
-          return;
+    async run(params) {
+        const { action, timeout, data } = params;
+        const token = await this.getToken();
+        if (token) {
+            if (!this.tenant) {
+                console.error("Tenant is not set - cannot send a websocket message.");
+                return null;
+            }
+        } else {
+            console.error("Token is not set - cannot send a websocket message.");
+            return null;
         }
-        resolve(event.data);
-        subscription.off();
-        if (!promiseTimeout) {
-          return;
+        if (!timeout || timeout < 0) {
+            this.manager.send({
+                token,
+                tenant: this.tenant,
+                action,
+                data: data || {}
+            });
+            return null;
         }
-        clearTimeout(promiseTimeout);
-      });
-      promiseTimeout = setTimeout(() => {
-        const message = `Websocket action "${action}" timeout.`;
-        subscription.off();
-        reject(new Error(message));
-      }, timeout);
-      this.manager.send({
-        /**
-         * It is ok to cast as we are checking the values a few lines above.
-         */
-        token,
-        tenant: this.tenant,
-        messageId: subscription.id,
-        action,
-        data: data || {}
-      });
-    }).catch(ex => {
-      console.error("Error while sending websocket message.", ex);
-      return null;
-    });
-  }
+        return await new Promise((resolve, reject)=>{
+            let promiseTimeout = null;
+            const subscription = this.manager.onMessage(async (event)=>{
+                if (event.data.messageId !== subscription.id) return;
+                resolve(event.data);
+                subscription.off();
+                if (!promiseTimeout) return;
+                clearTimeout(promiseTimeout);
+            });
+            promiseTimeout = setTimeout(()=>{
+                const message = `Websocket action "${action}" timeout.`;
+                subscription.off();
+                reject(new Error(message));
+            }, timeout);
+            this.manager.send({
+                token,
+                tenant: this.tenant,
+                messageId: subscription.id,
+                action,
+                data: data || {}
+            });
+        }).catch((ex)=>{
+            console.error("Error while sending websocket message.", ex);
+            return null;
+        });
+    }
 }
-export const createWebsocketsActions = params => {
-  return new WebsocketsActions(params);
-};
+const createWebsocketsActions = (params)=>new WebsocketsActions(params);
+export { WebsocketsActions, createWebsocketsActions };
 
 //# sourceMappingURL=WebsocketsActions.js.map

package/domain/WebsocketsActions.js.map

@@ -1 +1 @@
-{"version":3,"names":["WebsocketsActions","constructor","params","manager","tenant","getToken","run","action","timeout","data","token","console","error","send","Promise","resolve","reject","promiseTimeout","subscription","onMessage","event","messageId","id","off","clearTimeout","setTimeout","message","Error","catch","ex","createWebsocketsActions"],"sources":["WebsocketsActions.ts"],"sourcesContent":["import type {\n    IGenericData,\n    IWebsocketsActions,\n    IWebsocketsActionsRunParams,\n    IWebsocketsManager,\n    IWebsocketManagerSendData\n} from \"./types.js\";\n\nexport interface IWebsocketActionsParams {\n    manager: IWebsocketsManager;\n    tenant: string | null;\n    getToken: () => Promise<string | undefined>;\n}\n\nexport class WebsocketsActions implements IWebsocketsActions {\n    public readonly manager: IWebsocketsManager;\n\n    private readonly getToken: () => Promise<string | undefined>;\n    private readonly tenant: string | null;\n\n    public constructor(params: IWebsocketActionsParams) {\n        this.manager = params.manager;\n        this.tenant = params.tenant;\n        this.getToken = params.getToken;\n    }\n\n    public async run<T extends IGenericData = IGenericData, R extends IGenericData = IGenericData>(\n        params: IWebsocketsActionsRunParams<T>\n    ): Promise<R | null> {\n        const { action, timeout, data } = params;\n        const token = await this.getToken();\n        if (!token) {\n            console.error(\"Token is not set - cannot send a websocket message.\");\n            return null;\n        } else if (!this.tenant) {\n            console.error(\"Tenant is not set - cannot send a websocket message.\");\n            return null;\n        }\n\n        /**\n         * If no timeout was sent, we will just send the message and return null.\n         * No waiting for the response.\n         */\n        if (!timeout || timeout < 0) {\n            this.manager.send<IWebsocketManagerSendData<T>>({\n                /**\n                 * It is ok to cast as we are checking the values a few lines above.\n                 */\n                token,\n                tenant: this.tenant as string,\n                action,\n                data: data || ({} as T)\n            });\n            return null;\n        }\n        /**\n         * In case of a timeout, we will send the message and wait for the response.\n         */\n        return await new Promise<R>((resolve, reject) => {\n            let promiseTimeout: NodeJS.Timeout | null = null;\n            const subscription = this.manager.onMessage<R>(async event => {\n                if (event.data.messageId !== subscription.id) {\n                    return;\n                }\n                resolve(event.data);\n                subscription.off();\n                if (!promiseTimeout) {\n                    return;\n                }\n                clearTimeout(promiseTimeout);\n            });\n\n            promiseTimeout = setTimeout(() => {\n                const message = `Websocket action \"${action}\" timeout.`;\n                subscription.off();\n                reject(new Error(message));\n            }, timeout);\n\n            this.manager.send<IWebsocketManagerSendData<T>>({\n                /**\n                 * It is ok to cast as we are checking the values a few lines above.\n                 */\n                token,\n                tenant: this.tenant as string,\n                messageId: subscription.id,\n                action,\n                data: data || ({} as T)\n            });\n        }).catch(ex => {\n            console.error(\"Error while sending websocket message.\", ex);\n            return null;\n        });\n    }\n}\n\nexport const createWebsocketsActions = (params: IWebsocketActionsParams): IWebsocketsActions => {\n    return new WebsocketsActions(params);\n};\n"],"mappings":"AAcA,OAAO,MAAMA,iBAAiB,CAA+B;EAMlDC,WAAWA,CAACC,MAA+B,EAAE;IAChD,IAAI,CAACC,OAAO,GAAGD,MAAM,CAACC,OAAO;IAC7B,IAAI,CAACC,MAAM,GAAGF,MAAM,CAACE,MAAM;IAC3B,IAAI,CAACC,QAAQ,GAAGH,MAAM,CAACG,QAAQ;EACnC;EAEA,MAAaC,GAAGA,CACZJ,MAAsC,EACrB;IACjB,MAAM;MAAEK,MAAM;MAAEC,OAAO;MAAEC;IAAK,CAAC,GAAGP,MAAM;IACxC,MAAMQ,KAAK,GAAG,MAAM,IAAI,CAACL,QAAQ,CAAC,CAAC;IACnC,IAAI,CAACK,KAAK,EAAE;MACRC,OAAO,CAACC,KAAK,CAAC,qDAAqD,CAAC;MACpE,OAAO,IAAI;IACf,CAAC,MAAM,IAAI,CAAC,IAAI,CAACR,MAAM,EAAE;MACrBO,OAAO,CAACC,KAAK,CAAC,sDAAsD,CAAC;MACrE,OAAO,IAAI;IACf;;IAEA;AACR;AACA;AACA;IACQ,IAAI,CAACJ,OAAO,IAAIA,OAAO,GAAG,CAAC,EAAE;MACzB,IAAI,CAACL,OAAO,CAACU,IAAI,CAA+B;QAC5C;AAChB;AACA;QACgBH,KAAK;QACLN,MAAM,EAAE,IAAI,CAACA,MAAgB;QAC7BG,MAAM;QACNE,IAAI,EAAEA,IAAI,IAAK,CAAC;MACpB,CAAC,CAAC;MACF,OAAO,IAAI;IACf;IACA;AACR;AACA;IACQ,OAAO,MAAM,IAAIK,OAAO,CAAI,CAACC,OAAO,EAAEC,MAAM,KAAK;MAC7C,IAAIC,cAAqC,GAAG,IAAI;MAChD,MAAMC,YAAY,GAAG,IAAI,CAACf,OAAO,CAACgB,SAAS,CAAI,MAAMC,KAAK,IAAI;QAC1D,IAAIA,KAAK,CAACX,IAAI,CAACY,SAAS,KAAKH,YAAY,CAACI,EAAE,EAAE;UAC1C;QACJ;QACAP,OAAO,CAACK,KAAK,CAACX,IAAI,CAAC;QACnBS,YAAY,CAACK,GAAG,CAAC,CAAC;QAClB,IAAI,CAACN,cAAc,EAAE;UACjB;QACJ;QACAO,YAAY,CAACP,cAAc,CAAC;MAChC,CAAC,CAAC;MAEFA,cAAc,GAAGQ,UAAU,CAAC,MAAM;QAC9B,MAAMC,OAAO,GAAG,qBAAqBnB,MAAM,YAAY;QACvDW,YAAY,CAACK,GAAG,CAAC,CAAC;QAClBP,MAAM,CAAC,IAAIW,KAAK,CAACD,OAAO,CAAC,CAAC;MAC9B,CAAC,EAAElB,OAAO,CAAC;MAEX,IAAI,CAACL,OAAO,CAACU,IAAI,CAA+B;QAC5C;AAChB;AACA;QACgBH,KAAK;QACLN,MAAM,EAAE,IAAI,CAACA,MAAgB;QAC7BiB,SAAS,EAAEH,YAAY,CAACI,EAAE;QAC1Bf,MAAM;QACNE,IAAI,EAAEA,IAAI,IAAK,CAAC;MACpB,CAAC,CAAC;IACN,CAAC,CAAC,CAACmB,KAAK,CAACC,EAAE,IAAI;MACXlB,OAAO,CAACC,KAAK,CAAC,wCAAwC,EAAEiB,EAAE,CAAC;MAC3D,OAAO,IAAI;IACf,CAAC,CAAC;EACN;AACJ;AAEA,OAAO,MAAMC,uBAAuB,GAAI5B,MAA+B,IAAyB;EAC5F,OAAO,IAAIF,iBAAiB,CAACE,MAAM,CAAC;AACxC,CAAC","ignoreList":[]}
+{"version":3,"file":"domain/WebsocketsActions.js","sources":["../../src/domain/WebsocketsActions.ts"],"sourcesContent":["import type {\n    IGenericData,\n    IWebsocketsActions,\n    IWebsocketsActionsRunParams,\n    IWebsocketsManager,\n    IWebsocketManagerSendData\n} from \"./types.js\";\n\nexport interface IWebsocketActionsParams {\n    manager: IWebsocketsManager;\n    tenant: string | null;\n    getToken: () => Promise<string | undefined>;\n}\n\nexport class WebsocketsActions implements IWebsocketsActions {\n    public readonly manager: IWebsocketsManager;\n\n    private readonly getToken: () => Promise<string | undefined>;\n    private readonly tenant: string | null;\n\n    public constructor(params: IWebsocketActionsParams) {\n        this.manager = params.manager;\n        this.tenant = params.tenant;\n        this.getToken = params.getToken;\n    }\n\n    public async run<T extends IGenericData = IGenericData, R extends IGenericData = IGenericData>(\n        params: IWebsocketsActionsRunParams<T>\n    ): Promise<R | null> {\n        const { action, timeout, data } = params;\n        const token = await this.getToken();\n        if (!token) {\n            console.error(\"Token is not set - cannot send a websocket message.\");\n            return null;\n        } else if (!this.tenant) {\n            console.error(\"Tenant is not set - cannot send a websocket message.\");\n            return null;\n        }\n\n        /**\n         * If no timeout was sent, we will just send the message and return null.\n         * No waiting for the response.\n         */\n        if (!timeout || timeout < 0) {\n            this.manager.send<IWebsocketManagerSendData<T>>({\n                /**\n                 * It is ok to cast as we are checking the values a few lines above.\n                 */\n                token,\n                tenant: this.tenant as string,\n                action,\n                data: data || ({} as T)\n            });\n            return null;\n        }\n        /**\n         * In case of a timeout, we will send the message and wait for the response.\n         */\n        return await new Promise<R>((resolve, reject) => {\n            let promiseTimeout: NodeJS.Timeout | null = null;\n            const subscription = this.manager.onMessage<R>(async event => {\n                if (event.data.messageId !== subscription.id) {\n                    return;\n                }\n                resolve(event.data);\n                subscription.off();\n                if (!promiseTimeout) {\n                    return;\n                }\n                clearTimeout(promiseTimeout);\n            });\n\n            promiseTimeout = setTimeout(() => {\n                const message = `Websocket action \"${action}\" timeout.`;\n                subscription.off();\n                reject(new Error(message));\n            }, timeout);\n\n            this.manager.send<IWebsocketManagerSendData<T>>({\n                /**\n                 * It is ok to cast as we are checking the values a few lines above.\n                 */\n                token,\n                tenant: this.tenant as string,\n                messageId: subscription.id,\n                action,\n                data: data || ({} as T)\n            });\n        }).catch(ex => {\n            console.error(\"Error while sending websocket message.\", ex);\n            return null;\n        });\n    }\n}\n\nexport const createWebsocketsActions = (params: IWebsocketActionsParams): IWebsocketsActions => {\n    return new WebsocketsActions(params);\n};\n"],"names":["WebsocketsActions","params","action","timeout","data","token","console","Promise","resolve","reject","promiseTimeout","subscription","event","clearTimeout","setTimeout","message","Error","ex","createWebsocketsActions"],"mappings":"AAcO,MAAMA;IAMT,YAAmBC,MAA+B,CAAE;QAChD,IAAI,CAAC,OAAO,GAAGA,OAAO,OAAO;QAC7B,IAAI,CAAC,MAAM,GAAGA,OAAO,MAAM;QAC3B,IAAI,CAAC,QAAQ,GAAGA,OAAO,QAAQ;IACnC;IAEA,MAAa,IACTA,MAAsC,EACrB;QACjB,MAAM,EAAEC,MAAM,EAAEC,OAAO,EAAEC,IAAI,EAAE,GAAGH;QAClC,MAAMI,QAAQ,MAAM,IAAI,CAAC,QAAQ;QACjC,IAAKA,OAGE;YAAA,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;gBACrBC,QAAQ,KAAK,CAAC;gBACd,OAAO;YACX;QAAA,OANY;YACRA,QAAQ,KAAK,CAAC;YACd,OAAO;QACX;QASA,IAAI,CAACH,WAAWA,UAAU,GAAG;YACzB,IAAI,CAAC,OAAO,CAAC,IAAI,CAA+B;gBAI5CE;gBACA,QAAQ,IAAI,CAAC,MAAM;gBACnBH;gBACA,MAAME,QAAS,CAAC;YACpB;YACA,OAAO;QACX;QAIA,OAAO,MAAM,IAAIG,QAAW,CAACC,SAASC;YAClC,IAAIC,iBAAwC;YAC5C,MAAMC,eAAe,IAAI,CAAC,OAAO,CAAC,SAAS,CAAI,OAAMC;gBACjD,IAAIA,MAAM,IAAI,CAAC,SAAS,KAAKD,aAAa,EAAE,EACxC;gBAEJH,QAAQI,MAAM,IAAI;gBAClBD,aAAa,GAAG;gBAChB,IAAI,CAACD,gBACD;gBAEJG,aAAaH;YACjB;YAEAA,iBAAiBI,WAAW;gBACxB,MAAMC,UAAU,CAAC,kBAAkB,EAAEb,OAAO,UAAU,CAAC;gBACvDS,aAAa,GAAG;gBAChBF,OAAO,IAAIO,MAAMD;YACrB,GAAGZ;YAEH,IAAI,CAAC,OAAO,CAAC,IAAI,CAA+B;gBAI5CE;gBACA,QAAQ,IAAI,CAAC,MAAM;gBACnB,WAAWM,aAAa,EAAE;gBAC1BT;gBACA,MAAME,QAAS,CAAC;YACpB;QACJ,GAAG,KAAK,CAACa,CAAAA;YACLX,QAAQ,KAAK,CAAC,0CAA0CW;YACxD,OAAO;QACX;IACJ;AACJ;AAEO,MAAMC,0BAA0B,CAACjB,SAC7B,IAAID,kBAAkBC"}

package/domain/WebsocketsConnection.d.ts

@@ -10,6 +10,12 @@ declare global {
         WebinyWebsocketsConnectionCache: IConnection;
     }
 }
+/**
+ * API Gateway closes a WebSocket after 10 minutes without traffic (and after 2 hours regardless), so
+ * we ping well inside that window. The ping has no route of its own and lands on `$default`.
+ */
+export declare const WEBSOCKETS_HEARTBEAT_INTERVAL: number;
+export declare const WEBSOCKETS_HEARTBEAT_ACTION = "ping";
 export interface IWebsocketsConnectionParams {
     url: string;
     tenant: string;
@@ -17,6 +23,8 @@ export interface IWebsocketsConnectionParams {
     subscriptionManager: IWebsocketsSubscriptionManager;
     protocol?: IWebsocketsConnectProtocol;
     factory?: IWebsocketsConnectionFactory;
+    heartbeatInterval?: number;
+    reconnectDelay?: (attempt: number) => number;
 }
 export declare class WebsocketsConnection implements IWebsocketsConnection {
     private readonly url;
@@ -25,6 +33,18 @@ export declare class WebsocketsConnection implements IWebsocketsConnection {
     private readonly protocol;
     readonly subscriptionManager: IWebsocketsSubscriptionManager;
     private readonly factory;
+    private readonly heartbeatInterval;
+    private readonly reconnectDelay;
+    private reconnectAttempt;
+    private reconnectTimer;
+    private heartbeatTimer;
+    /**
+     * Opening a socket waits for a token first. `connecting` lets concurrent callers (a reconnect
+     * timer, the window-focus handler, `send()`) share that one attempt instead of each creating a
+     * socket, and `generation` lets `close()` invalidate an attempt that is already waiting.
+     */
+    private connecting;
+    private generation;
     constructor(params: IWebsocketsConnectionParams);
     setTenant(tenant: string): void;
     connect(): Promise<void>;
@@ -34,6 +54,16 @@ export declare class WebsocketsConnection implements IWebsocketsConnection {
     isClosed(): boolean;
     private createUrl;
     private getConnection;
+    /**
+     * Resolves to `null` when `close()` ran while the token was being fetched: the attempt is
+     * abandoned rather than opening a socket nobody asked for any more.
+     */
+    private openConnection;
+    private scheduleReconnect;
+    private cancelReconnect;
+    private startHeartbeat;
+    private stopHeartbeat;
+    private sendHeartbeat;
 }
 export declare const createWebsocketsConnection: (params: IWebsocketsConnectionParams) => IWebsocketsConnection;
 export {};