@carbonorm/carbonreact 3.3.14 → 3.4.1

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@carbonorm/carbonreact",
-  "version": "3.3.14",
+  "version": "3.4.1",
   "browser": "dist/index.umd.js",
   "module": "dist/index.esm.js",
   "main": "dist/index.cjs.js",
   "types": "dist/index.d.ts",
   "type": "module",
   "dependencies": {
-    "@carbonorm/carbonnode": "^1.1.0",
+    "@carbonorm/carbonnode": "^1.2.4",
     "@fortawesome/fontawesome-svg-core": "^6.4.0",
     "@fortawesome/free-solid-svg-icons": "^6.4.0",
     "@fortawesome/react-fontawesome": "^0.2.0",
@@ -70,16 +70,19 @@
   "scripts": {
     "prepublishOnly": "npm run build",
     "c6": "wget https://raw.githubusercontent.com/RichardTMiles/CarbonPHP/lts/view/C6.tsx -O src/variables/C6.tsx",
-    "build": "rm -rf ./dist/ && npm run build:css && npm run build:index && rollup -c && tsc compileValidSQL.tsx && mv compileValidSQL.js compileValidSQL.cjs",
+    "build": "rm -rf ./dist/ && npm run build:css && npm run build:index && rollup -c && npm run build:compileValidSQL",
     "dev": "rollup -c -w",
     "test": "node test/test.js",
     "pretest": "npm run build",
     "build:index": "npx barrelsby --directory ./src --delete --exclude '(jestHoc|\\.test|\\.d).(js|tsx?)$' --exportDefault --verbose --mode top",
     "build:css": "sass ./src:./src && typed-scss-modules 'src/**/*.?(s)css' --nameFormat all --exportType default src",
-    "build:compileValidSQL": "ts-node --experimental-specifier-resolution=node compileValidSQL.tsx"
+    "build:compileValidSQL": "tsc compileValidSQL.tsx && mv compileValidSQL.js compileValidSQL.cjs"
   },
   "files": [
     "compileValidSQL.tsx",
+    "compileValidSQL.cjs",
+    "generateRestBindings.tsx",
+    "generateRestBindings.cjs",
     "dist",
     "src"
   ]

package/src/CarbonReact.tsx

@@ -9,6 +9,7 @@ import 'react-toastify/dist/ReactToastify.min.css';
 import BackendThrowable from 'components/Errors/BackendThrowable';
 import Nest from 'components/Nest/Nest';
 import {initialRestfulObjectsState, iRestfulObjectArrayTypes} from "variables/C6";
+import CarbonWebSocket from "./components/WebSocket/CarbonWebSocket";
 
 
 
@@ -33,6 +34,16 @@ export const initialCarbonReactState: iCarbonReactState & iRestfulObjectArrayTyp
     ...initialRestfulObjectsState,
 }
 
+// @link https://stackoverflow.com/questions/3710204/how-to-check-if-a-string-is-a-valid-json-string
+export function isJsonString(str) {
+    try {
+        JSON.parse(str);
+    } catch (e) {
+        return false;
+    }
+    return true;
+}
+
 const CarbonReact= class <P = {}, S = {}> extends Component<{
     children?: ReactNode | ReactNode[],
 } & P, S & iCarbonReactState> {
@@ -42,6 +53,9 @@ const CarbonReact= class <P = {}, S = {}> extends Component<{
     } & any, any & iCarbonReactState>;
 
     static lastLocation = window.location.pathname;
+    static websocketUrl = (window.location.protocol === 'https:' ? 'wss://' : 'ws://') + window.location.host + ':8888/ws';
+    static websocketTimeoutSeconds : number = 250;
+    static websocketHeartbeatSeconds : number = 250;
 
     // @link https://github.com/welldone-software/why-did-you-render
     // noinspection JSUnusedGlobalSymbols
@@ -71,8 +85,6 @@ const CarbonReact= class <P = {}, S = {}> extends Component<{
         return CarbonReact.instance.state;
     }
 
-    websocketTimeout = 5000;
-
     shouldComponentUpdate(
         nextProps: Readonly<any>,
         nextState: Readonly<iCarbonReactState>,
@@ -117,6 +129,7 @@ const CarbonReact= class <P = {}, S = {}> extends Component<{
 
         return <BrowserRouter>
             <GlobalHistory/>
+            <CarbonWebSocket />
             {this.props.children}
             <ToastContainer/>
         </BrowserRouter>;

package/src/api/hoc/useEffectOnce.tsx

@@ -0,0 +1,33 @@
+import { useEffect, useRef, useState } from 'react';
+
+// @link https://dev.to/ag-grid/react-18-avoiding-use-effect-getting-called-twice-4i9e
+export const useEffectOnce = (effect: () => void | (() => void)) => {
+    const effectFn = useRef<() => void | (() => void)>(effect);
+    const destroyFn = useRef<void | (() => void)>();
+    const effectCalled = useRef(false);
+    const rendered = useRef(false);
+    const [, setVal] = useState<number>(0);
+
+    if (effectCalled.current) {
+        rendered.current = true;
+    }
+
+    useEffect(() => {
+        if (!effectCalled.current) {
+            destroyFn.current = effectFn.current();
+            effectCalled.current = true;
+        }
+
+        setVal(val => val + 1);
+
+        return () => {
+            if (!rendered.current) {
+                return;
+            }
+
+            if (destroyFn.current) {
+                destroyFn.current();
+            }
+        };
+    }, []);
+}

package/src/components/Alert/Alert.tsx

@@ -18,16 +18,6 @@ export interface iAlertButtonOptions {
     color: "default" | "primary" | "secondary" | "inherit" | "danger" | "info" | "success" | "warning" | undefined,
 }
 
-export function addAlert(props: iAlert) {
-
-    CarbonReact.instance.setState(previousState => ({
-        alertsWaiting: previousState.alertsWaiting.length === 0
-            ? [props]
-            : [...previousState.alertsWaiting, props]
-    }))
-
-}
-
 export interface iAlert {
     title: string,
     text: string,
@@ -38,11 +28,20 @@ export interface iAlert {
     then?: (value: string | undefined) => void,
     timeout?: number,
     footerText?: string,
-
     intercept?: boolean,
     backendThrowable?: { [key: string]: any },
 }
 
+export function addAlert(props: iAlert) {
+
+    CarbonReact.instance.setState(previousState => ({
+        alertsWaiting: previousState.alertsWaiting.length === 0
+            ? [props]
+            : [...previousState.alertsWaiting, props]
+    }))
+
+}
+
 export default function Alert() {
 
     const {alertsWaiting, backendThrowable} = CarbonReact.instance.state
@@ -73,7 +72,7 @@ export default function Alert() {
             title: "Oh no! An issue occurred!",
             text: backendThrowable?.['DropInGaming\\PHP\\Errors\\DropException'] ?? 'An unknown issue occurred. Please try again.',
             timeout: 0,
-            footerText: hideExpandInformation ? '' : 'These alert footer options are only shown to admins and in development environments. Click "Expand" to see more details.',
+            footerText: hideExpandInformation ? '' : 'These alert footer options are only shown in development environments. Click "Expand" to see more details.',
             buttons: buttons,
             // backendThrowable has its own custom component that can be expanded (called in the Bootstrap component)
             // our then function will be called when the user clicks on the button providing the option to expand or close

package/src/components/Errors/BackendThrowable.tsx

@@ -1,5 +1,5 @@
 import styles from './style.module.scss';
-//import OutsideClickHandler from 'react-outside-click-handler';
+import OutsideClickHandler from 'react-outside-click-handler';
 import CarbonReact from "../../CarbonReact";
 import {ReactElement} from "react";
 
@@ -13,7 +13,31 @@ export default () : ReactElement => {
 
     return <div className={styles.maintenanceHero}>
         <h1 className={styles.httpStatusCode}>{currentThrowable?.status || 500}</h1>
+        <OutsideClickHandler
+            onOutsideClick={() => bootstrap.setState(currentState => ({ backendThrowable: currentState.backendThrowable.slice(1) }))}>
+            <div className={styles.centeredContainer}>
+                {Object.keys(currentThrowable).map((key, index) => {
 
+                    const valueIsString = typeof currentThrowable[key] === 'string';
+
+                    const valueIsCode = 'THROWN NEAR' === key;
+
+                    return <div key={index}>
+                        <div className={styles.errorTextGeneral}> &gt; <span className={styles.errorKeys}>{key}</span>:
+                            {valueIsString
+                                ? (valueIsCode ? <div
+                                        style={{ backgroundColor: 'black', fontSize: 'xx-small' }}
+                                        dangerouslySetInnerHTML={{ __html: currentThrowable[key] }} /> :
+                                    <i className={styles.errorValues}>&quot;{currentThrowable[key]}&quot;</i>)
+                                : ''}
+                        </div>
+                        {valueIsString
+                            ? ''
+                            : <pre className={styles.errorPre}>{JSON.stringify(currentThrowable[key], undefined, 4)}</pre>}
+                    </div>;
+                })}
+            </div>
+        </OutsideClickHandler>
     </div>;
 
 }

package/src/components/WebSocket/CarbonWebSocket.tsx

@@ -0,0 +1,181 @@
+import CarbonReact, {isJsonString} from "CarbonReact";
+import {addAlert} from "../Alert/Alert";
+import {useEffectOnce} from "../../api/hoc/useEffectOnce";
+import {tC6Tables} from "@carbonorm/carbonnode";
+
+
+/**
+ * @function connect
+ * This function establishes a connection with the websocket and also ensures constant reconnection if connection closes
+ **/
+export function initiateWebsocket({TABLES = undefined}: {TABLES?: tC6Tables} = {}) {
+
+    const {websocket} = CarbonReact.instance.state;
+
+    if (!("WebSocket" in window)) {
+
+        // todo - store that this has been shown in the state
+        addAlert({
+            title: 'Browser does not support websockets, live updates will fail. You may need to refresh the page to see the newest content.',
+            text: 'Please use a modern browser.',
+            icon: 'warning',
+        })
+
+    }
+
+    if (false === (undefined === websocket || null === websocket)) {
+
+        return;
+
+    }
+
+
+    let connectInterval;
+
+    const connection = new WebSocket(CarbonReact.websocketUrl);
+
+    console.log("Connecting websocket url", CarbonReact.websocketUrl);
+
+    CarbonReact.instance.setState({
+        websocket: connection
+    }, () => {
+
+        connection.onopen = () => {
+
+            console.log('WebSocket Client Connected To :: ' + CarbonReact.websocketUrl);
+
+            clearTimeout(connectInterval); // clear Interval on open of websocket connection
+
+            function heartbeat() {
+
+                const {websocket} = CarbonReact.instance.state;
+
+                if (!websocket) return;
+
+                if (websocket.readyState !== 1) return;
+
+                websocket.send("ping");
+
+                setTimeout(heartbeat, CarbonReact.websocketHeartbeatSeconds * 1000);
+
+            }
+
+            heartbeat();
+
+        };
+
+        connection.onmessage = (message: MessageEvent<string> ) => {
+
+            const parsedData = isJsonString(message?.data) ? JSON.parse(message?.data) : message?.data;
+
+            CarbonReact.instance.setState((prevState: Readonly<any>) => ({
+                websocketEvents: prevState.websocketEvents.concat(message),
+                websocketData: prevState.websocketData.concat(parsedData), // JSON.parse no good - base64?
+            }));
+
+            console.log('going to impl TABLES', TABLES)
+
+            /*if (undefined !== TABLES) {
+
+                TABLES.
+
+
+            }*/
+
+        };
+
+        window.addEventListener("focus", () => initiateWebsocket());
+
+        // websocket onclose event listener
+        connection.addEventListener('close', event => {
+
+            let reason;
+
+            console.log(
+                `Socket is closed.`,
+                event.reason, event);
+
+            const retry = () => {
+
+                const retrySeconds = Math.min(5000, (CarbonReact.websocketTimeoutSeconds + CarbonReact.websocketTimeoutSeconds) * 1000)
+
+                CarbonReact.websocketTimeoutSeconds = retrySeconds;
+
+                console.log(`WebSocket reconnect will be attempted in ${retrySeconds} second(s).`)
+
+                connectInterval = setTimeout(() => initiateWebsocket(), retrySeconds);
+
+            }
+
+            // See https://www.rfc-editor.org/rfc/rfc6455#section-7.4.1
+            switch (event.code) {
+                case 1000:
+                    reason = "Normal closure, meaning that the purpose for which the connection was established has been fulfilled.";
+                    break;
+                case 1001:
+                    retry(); //call check function after timeout
+                    reason = "An endpoint is \"going away\", such as a server going down or a browser having navigated away from a page.";
+                    break;
+                case 1002:
+                    reason = "An endpoint is terminating the connection due to a protocol error";
+                    break;
+                case 1003:
+                    reason = "An endpoint is terminating the connection because it has received a type of data it cannot accept (e.g., an endpoint that understands only text data MAY send this if it receives a binary message).";
+                    break;
+                case 1004:
+                    reason = "Reserved. The specific meaning might be defined in the future.";
+                    break;
+                case 1005:
+                    reason = "No status code was actually present.";
+                    break;
+                case 1006:
+                    retry();
+                    reason = "The connection was closed abnormally, e.g., without sending or receiving a close control frame";
+                    break;
+                case 1007:
+                    reason = "An endpoint is terminating the connection because it has received data within a message that was not consistent with the type of the message (e.g., non-UTF-8 [https://www.rfc-editor.org/rfc/rfc3629] data within a text message).";
+                    break;
+                case 1008:
+                    reason = "An endpoint is terminating the connection because it has received a message that \"violates its policy\". This reason is given either if there is no other suitable reason, or if there is a need to hide specific details about the policy.";
+                    break;
+                case 1009:
+                    reason = "An endpoint is terminating the connection because it has received a message that is too big for it to process.";
+                    break;
+                case 1010:
+                    reason = "An endpoint (client) is terminating the connection because it has expected the server to negotiate one or more extension, but the server didn't return them in the response message of the WebSocket handshake. <br /> Specifically, the extensions that are needed are: " + event.reason;
+                    break;
+                case 1011:
+                    reason = "A server is terminating the connection because it encountered an un expected condition that prevented it from fulfilling the request.";
+                    break;
+                case 1015:
+                    reason = "The connection was closed due to a failure to perform a TLS handshake (e.g., the server certificate can't be verified).";
+                    break;
+                default:
+                    reason = "Unknown reason";
+            }
+
+            console.log("The connection was closed for reason: " + reason);
+
+        });
+
+        // websocket onerror event listener
+        connection.addEventListener('websocket error', (e: Event) => {
+            console.error("Socket encountered error: ", e, JSON.stringify(e));
+            connection.close();
+        });
+
+    });
+
+}
+
+export default function () {
+
+    useEffectOnce(() => {
+
+        initiateWebsocket()
+
+    })
+
+    return null
+
+}

package/src/index.ts

@@ -4,6 +4,7 @@
 
 export { default as CarbonReact } from "./CarbonReact";
 export * from "./CarbonReact";
+export * from "./api/hoc/useEffectOnce";
 export { default as Alert } from "./components/Alert/Alert";
 export * from "./components/Alert/Alert";
 export { default as AccessDenied } from "./components/Errors/AccessDenied";
@@ -20,6 +21,8 @@ export { default as Nest } from "./components/Nest/Nest";
 export * from "./components/Nest/Nest";
 export { default as Popup } from "./components/Popup/Popup";
 export * from "./components/Popup/Popup";
+export { default as CarbonWebSocket } from "./components/WebSocket/CarbonWebSocket";
+export * from "./components/WebSocket/CarbonWebSocket";
 export * from "./hoc/GlobalHistory";
 export * from "./hoc/KeysMatching";
 export { default as addValidSQL } from "./hoc/addValidSQL";