@needle-tools/engine 4.7.0-next.968391f → 4.7.0-next.bbbc637

package/plugins/vite/logger.client.js

@@ -0,0 +1,149 @@
+
+/**
+ * Patches console methods to capture log messages and send them to the server.
+ * This is useful for debugging and logging in the client.
+ * @param {"log" | "warn" | "info" | "debug" | "error" | "internal"} level
+ * @param {any} message - The log message to capture.
+ */
+function sendLogToServer(level, ...message) {
+    if ("hot" in import.meta) {
+        // @ts-ignore
+        import.meta.hot.send("needle:client-log", { level, message: message });
+    }
+}
+
+
+if (import.meta && "hot" in import.meta) {
+
+    const originalLog = console.log;
+    const originalWarn = console.warn;
+    const originalInfo = console.info;
+    const originalDebug = console.debug;
+    const originalError = console.error;
+
+    console.log = (...args) => {
+        originalLog(...args);
+        sendLogToServer("log", ...args);
+    }
+    console.warn = (...args) => {
+        originalWarn(...args);
+        sendLogToServer("warn", ...args);
+    }
+    console.info = (...args) => {
+        originalInfo(...args);
+        sendLogToServer("info", ...args);
+    }
+    console.debug = (...args) => {
+        originalDebug(...args);
+        sendLogToServer("debug", ...args);
+    }
+    console.error = (...args) => {
+        originalError(...args);
+        sendLogToServer("error", ...args);
+    }
+
+    try {
+        sendLogToServer("internal", `Page loaded
+URL: ${window.location.href}
+UserAgent: ${navigator.userAgent}
+Screen: ${window.innerWidth} x ${window.innerHeight}px
+Device Pixel Ratio: ${window.devicePixelRatio}
+Device Memory: ${"deviceMemory" in navigator ? navigator.deviceMemory : "Not available"} GB
+Online: ${navigator.onLine}
+Language: ${navigator.language}
+Timezone: ${Intl.DateTimeFormat().resolvedOptions().timeZone}
+Connection: ${"connection" in navigator ? JSON.stringify(navigator.connection) : "Not available"}
+User Activation: ${"userActivation" in navigator ? JSON.stringify(navigator.userActivation) : "Not available"}
+`);
+
+        if ("gpu" in navigator) {
+
+            // @ts-ignore
+            navigator.gpu.requestAdapter()
+                .then(adapter => adapter ? adapter.requestDevice() : null)
+                .then(device => {
+                    if (device) {
+                        const adapterInfo = device.adapterInfo;
+                        if (adapterInfo) {
+                            sendLogToServer("internal", [`WebGPU adapter info`,
+                                [adapterInfo.vendor, adapterInfo.architecture, adapterInfo.device]
+                                    .filter(e => e.trim()?.length)
+                                    .join(", ")
+                            ]);
+                        }
+                    }
+                });
+        }
+    }
+    catch (e) {
+        // silently fail
+        sendLogToServer("error", `Error during initial log: ${e.message}`);
+    }
+
+    window.addEventListener('error', (event) => {
+        const errorMessage = event.error ? event.error.stack || event.error.message : event.message;
+        sendLogToServer("error", errorMessage);
+    });
+    window.addEventListener('unhandledrejection', (event) => {
+        const reason = event.reason ? event.reason.stack || event.reason.message : "Unhandled rejection without reason";
+        sendLogToServer("error", `Unhandled promise rejection: ${reason}`);
+    });
+    window.addEventListener('beforeunload', () => {
+        sendLogToServer("internal", "Page is unloading");
+    });
+    document.addEventListener('visibilitychange', () => {
+        console.log("Visibility changed:", document.visibilityState);
+        if (document.visibilityState === 'hidden') {
+            sendLogToServer("internal", "Page is hidden");
+        }
+        else if (document.visibilityState === 'visible') {
+            sendLogToServer("internal", "Page is visible again");
+        }
+        else {
+            sendLogToServer("internal", `Page visibility changed to ${document.visibilityState}`);
+        }
+    });
+    window.addEventListener("focus", () => {
+        sendLogToServer("internal", "Page gained focus");
+    });
+    window.addEventListener("blur", () => {
+        sendLogToServer("internal", "Page lost focus");
+    });
+    window.addEventListener('load', () => {
+        sendLogToServer("internal", "Page fully loaded");
+    });
+    window.addEventListener('DOMContentLoaded', () => {
+        sendLogToServer("internal", "DOM fully loaded and parsed");
+    });
+    window.addEventListener('online', () => {
+        sendLogToServer("internal", "Browser is online");
+    });
+    window.addEventListener('offline', () => {
+        sendLogToServer("warn", "Browser is offline");
+    });
+    window.addEventListener('resize', () => {
+        sendLogToServer("internal", `Window resized to ${window.innerWidth}x${window.innerHeight}px`);
+    });
+    window.addEventListener('orientationchange', () => {
+        sendLogToServer("internal", `Orientation changed to ${screen.orientation.type}`);
+    });
+    window.addEventListener('fullscreenchange', () => {
+        if (document.fullscreenElement) {
+            sendLogToServer("internal", "Entered fullscreen mode");
+        } else {
+            sendLogToServer("internal", "Exited fullscreen mode");
+        }
+    });
+
+
+    // url change event
+    window.addEventListener('hashchange', () => {
+        sendLogToServer("internal", `URL hash changed to ${location.hash}`);
+    });
+    window.addEventListener('popstate', () => {
+        sendLogToServer("internal", `History state changed: ${JSON.stringify(history.state)}`);
+    });
+
+
+
+}

package/plugins/vite/logger.js

@@ -0,0 +1,85 @@
+import { existsSync, readFileSync } from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { captureLogMessage, patchConsoleLogs } from '../common/logger.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = path.dirname(__filename);
+
+
+/**
+ * write logs to local file
+ * @param {import('../types/userconfig.js').userSettings} userSettings
+ * @returns {import('vite').Plugin}
+ */
+export const needleLogger = (command, config, userSettings) => {
+
+    patchConsoleLogs();
+    captureLogMessage("server", "info", "Vite started with command \"" + command + "\" in " + __dirname);
+
+    return {
+        name: "needle:logger",
+        enforce: 'pre',
+        configureServer(server) {
+            logRequests(server);
+        },
+        configurePreviewServer(server) {
+            logRequests(server);
+        },
+        transformIndexHtml: {
+            order: 'pre',
+            handler(html, ctx) {
+                // inject client logger script during development
+                if (command === 'serve') {
+                    const file = path.join(__dirname, 'logger.client.js');
+                    if (existsSync(file)) {
+                        const scriptContent = readFileSync(file, 'utf8');
+                        return [
+                            {
+                                tag: 'script',
+                                attrs: {
+                                    type: 'module',
+                                },
+                                children: scriptContent,
+                                injectTo: 'head-prepend',
+                            },
+                        ];
+                    }
+                }
+            },
+        },
+    }
+}
+
+
+/**
+ * Logs HTTP requests to the console.
+ * This function is used in the Vite server to log incoming HTTP requests.
+ * @param {import('vite').PreviewServer | import('vite').ViteDevServer} server
+ */
+function logRequests(server, log_http_requests = false) {
+    if ("ws" in server) {
+        // Clent connections
+        server.ws.on('connection', (socket, request) => {
+            captureLogMessage("server", "connection", "New websocket connection established");
+            socket.on('close', () => {
+                captureLogMessage("server", "connection", "Websocket connection closed");
+            });
+        });
+        // Client log messages via websocket
+        server.ws.on('needle:client-log', async (data, client) => {
+            if (!data || !data.level || !data.message) {
+                console.warn("Received empty log data, ignoring");
+                return;
+            }
+            captureLogMessage("client", data.level, data.message);
+        });
+    }
+    // Log HTTP requests
+    if (log_http_requests) {
+        server.middlewares.use((req, res, next) => {
+            captureLogMessage("client-http", "info", [req.method, req.url]);
+            next();
+        });
+    }
+}

package/src/engine/engine_context.ts

@@ -751,7 +751,7 @@ export class Context implements IContext {
 		ContextRegistry.dispatchCallback(ContextEvent.ContextClearing, this);
 		invokeLifecycleFunctions(this, ContextEvent.ContextClearing);
 		// NOTE: this does dispose the environment/background image too
-		// which is probably not desired if it is set via the skybox-image attribute
+		// which is probably not desired if it is set via the background-image attribute
 		destroy(this.scene, true, true);
 		this.scene = new Scene();
 		this.addressables?.dispose();

package/src/engine/engine_three_utils.ts

@@ -734,6 +734,9 @@ export function getBoundingBox(objects: Object3D | Object3D[], ignore: ((obj: Ob
                 console.warn(`Object \"${obj.name}\" has NaN values in position or scale.... will ignore it`, pos, scale);
                 return;
             }
+            // Sanitize for the three.js method that only checks for undefined here
+            // @ts-ignore
+            if (obj.geometry === null) obj.geometry = undefined;
             box.expandByObject(obj, true);
             obj.children = children;
         }

package/src/engine/webcomponents/needle-engine.attributes.ts

@@ -44,7 +44,7 @@ type LoadingAttributes = {
 }
 
 type SkyboxAttributes = {
-    /** use background-image instead - URL to .exr, .hdr, .png, .jpg to be used as skybox */
+    /** @deprecated. Use background-image instead - URL to .exr, .hdr, .png, .jpg to be used as skybox */
     "skybox-image"?: string,
     /** URL to .exr, .hdr, .png, .jpg to be used as skybox */
     "background-image"?: string, 

package/src/engine-components/Camera.ts

@@ -560,7 +560,7 @@ export class Camera extends Behaviour implements ICamera {
             console.debug(msg);
         }
 
-        const hasBackgroundImageOrColorAttribute = this.context.domElement.getAttribute("background-image") || this.context.domElement.getAttribute("background-color") || this.context.domElement.getAttribute("skybox-image");
+        const hasBackgroundImageOrColorAttribute = this.context.domElement.getAttribute("background-image") || this.context.domElement.getAttribute("background-color");
 
         switch (this._clearFlags) {
             case ClearFlags.None:

package/src/engine-components/CameraUtils.ts

@@ -36,12 +36,14 @@ ContextRegistry.registerCallback(ContextEvent.MissingCamera, (evt) => {
     if (transparentAttribute != undefined) {
         camInstance.clearFlags = ClearFlags.Uninitialized;
     }
-    // Set the clearFlags to a skybox if we have one OR if the user set a skybox image attribute
-    else if (evt.context.domElement.getAttribute("skybox-image")?.length || evt.context.domElement.getAttribute("background-image")?.length || (evt.context as Context).lightmaps.tryGetSkybox(camInstance.sourceId)) {
+    // Set the clearFlags to a skybox if we have one OR if the user set a background-image attribute
+    else if (evt.context.domElement.getAttribute("background-image")?.length || (evt.context as Context).lightmaps.tryGetSkybox(camInstance.sourceId)) {
         camInstance.clearFlags = ClearFlags.Skybox;
         // TODO: can we store the backgroundBlurriness in the gltf file somewhere except inside the camera?
         // e.g. when we export a scene from blender without a camera in the scene
-        camInstance.backgroundBlurriness = .2; // same as in blender 0.5
+        if (evt.context.domElement.getAttribute("background-blurriness") === null) {
+            evt.context.scene.backgroundBlurriness = 0.2; // default value, same as in Blender
+        }
     }
     else {
         camInstance.clearFlags = ClearFlags.SolidColor;

package/src/engine-components/Skybox.ts

@@ -16,10 +16,10 @@ import { Behaviour, GameObject } from "./Component.js";
 
 const debug = getParam("debugskybox");
 
-registerObservableAttribute("skybox-image");
+registerObservableAttribute("background-image");
 registerObservableAttribute("environment-image");
 
-function createRemoteSkyboxComponent(context: IContext, url: string, skybox: boolean, environment: boolean, attribute: "skybox-image" | "environment-image") {
+function createRemoteSkyboxComponent(context: IContext, url: string, skybox: boolean, environment: boolean, attribute: "background-image" | "environment-image") {
     const remote = new RemoteSkybox();
     remote.allowDrop = false;
     remote.allowNetworking = false;
@@ -42,7 +42,7 @@ function createRemoteSkyboxComponent(context: IContext, url: string, skybox: boo
 const promises = new Array<Promise<any>>();
 ContextRegistry.registerCallback(ContextEvent.ContextCreationStart, (args) => {
     const context = args.context;
-    const skyboxImage = context.domElement.getAttribute("skybox-image") || context.domElement.getAttribute("background-image");
+    const skyboxImage = context.domElement.getAttribute("background-image");
     const environmentImage = context.domElement.getAttribute("environment-image");
     if (skyboxImage) {
         if (debug)
@@ -50,8 +50,8 @@ ContextRegistry.registerCallback(ContextEvent.ContextCreationStart, (args) => {
         // if the user is loading a GLB without a camera then the CameraUtils (which creates the default camera)
         // checks if we have this attribute set and then sets the skybox clearflags accordingly
         // if the user has a GLB with a camera but set to solid color then the skybox image is not visible -> we will just warn then and not override the camera settings
-        if (context.mainCameraComponent?.clearFlags !== ClearFlags.Skybox) console.warn("\"skybox-image\"/\"background-image\" attribute has no effect: camera clearflags are not set to \"Skybox\"");
-        const promise = createRemoteSkyboxComponent(context, skyboxImage, true, false, "skybox-image");
+        if (context.mainCameraComponent?.clearFlags !== ClearFlags.Skybox) console.warn("\"background-image\" attribute has no effect: camera clear flags are not set to \"Skybox\"");
+        const promise = createRemoteSkyboxComponent(context, skyboxImage, true, false, "background-image");
         promises.push(promise);
     }
     if (environmentImage) {