Suppress popup error messages for Console in offline builds?

[robyer1]

Often I am running Needle Engine builds offline on tablet or touchscreen PC devices and in those builds if there is any exception or error, there is a popup warning onscreen, can I suppress these?

Obviously I test to avoid these errors but sometimes they come from some other warnings in Chrome or the web browser on specific Windows devices and I would like to suppress them outside of the development environment.

They usually pop up when the website is running on localhost or local IP address offline on device

[needle-assistant (Needle Engine Assistant)]

Hello Robyer1,

To suppress popup error messages in offline builds of Needle Engine, you can take advantage of certain configurations and functions already present in the Needle Engine setup.

Step-by-Step Solution:

1. Use Existing Suppression Parameters:

   • Needle Engine provides specific URL parameters that can help suppress errors:
     • noerrors: Passing this parameter in your URL or during your app initialization suppresses error messages.
     • nooverlaymessages: This parameter can similarly suppress any overlay messages that might show up.

2. Modify Console Error Handling:

   • Within your application, set the setAllowBalloonMessages(false) function to suppress error popups. This function is defined in the debug_overlay.ts file which manages error overlays in Needle Engine (see the documentation).

Implementation:

Here’s an example of how you might set this up in your code:

import { setAllowBalloonMessages } from "@needle-tools/engine/debug_overlay";

// Call this early in your initialization script
setAllowBalloonMessages(false);

Additional Tips:

• Testing Locally: Ensure that you test your application thoroughly in a local environment to minimize any unexpected issues that cause errors.
• Console Logs: Debugging information will still be available in the console logs even if the overlays are suppressed. Make sure to monitor these logs during your tests.

Document Resources:

• For more details, you might refer to Needle Engine Docs: Needle Engine Docs
• Check more on suppressing errors and configurations: Needle Engine API - DebugOverlay

If you want further guidance on handling specific errors, feel free to provide more details. If you’re facing issues setting the parameters, let me know, and I’d be glad to help!

---

Feel free to explore these options and let me know if there’s anything else you need.

24 replies left
thread_npwPaedfRLjLf9vnT8zfQOO6
Reply to this message to continue the conversation

[robyer1]

I tried that so in my index.html I am able to set this:

    import { setAllowBalloonMessages } from "@needle-tools/engine/src/engine/debug/debug_overlay.ts";

and it works in local server but when I export a production build I get this error:

[vite:load-fallback] Could not load C:\Unity_Projects\Needle_ModelViewer\Needle\ModelPreview\node_modules\@needle-tools\engine\src/../lib/engine/debug/debug_overlay.ts (imported by index.html?html-proxy&index=3.js): ENOENT: no such file or directory, open 'C:\Unity_Projects\Needle_ModelViewer\Needle\ModelPreview\node_modules\@needle-tools\engine\lib\engine\debug\debug_overlay.ts'
Open C:\Unity_Projects\Needle_ModelViewer\Needle\

[needle-assistant (Needle Engine Assistant)]

Hello Robyer1,

The issue you’re encountering occurs because the import statement you’ve used references the source files within the src directory, which are not included in the production build output. Instead, you should reference the compiled version of the module from the lib directory.

Update the Import Statement:

Change your import statement in the index.html to:

import { setAllowBalloonMessages } from "@needle-tools/engine/lib/engine/debug/debug_overlay";

Reason for the Change:

• The lib directory contains the compiled code that is suitable for production builds, while the src directory contains source code intended for development and would not be available in a production environment.

Implementation Example:

Here’s how you would set it in your index.html:

<script type="module">
    import { setAllowBalloonMessages } from "@needle-tools/engine/lib/engine/debug/debug_overlay";

    // Call to suppress messages
    setAllowBalloonMessages(false);
</script>

Additional Considerations:

• Ensure you have the correct dependency versions installed and that your build tools are set up correctly.
• After making these changes, you should be able to run your production build without encountering the file not found error.

If you run into further issues or need additional assistance, feel free to ask!

23 replies left
thread_npwPaedfRLjLf9vnT8zfQOO6
Reply to this message to continue the conversation

[marwie1 (marwi)]

Import it like this:

import { setAllowBalloonMessages } from "@needle-tools/engine";