BYO (Bring Your Own) Troubleshooting and Bug Reporting

Learn about Unqork’s Shared Responsibility Model, how to troubleshoot BYO (Bring Your Own) elements, and report platform-level bugs to Unqork.

Discover the BYO interface and functionality in our Introduction to Bring Your Own (BYO) Framework article.

Shared Responsibility Model

The BYO framework empowers Creators to extend Unqork’s no-code platform with custom code. To maintain the stability and performance of Unqork applications, Creators must distinguish between issues in their custom logic and issues in the Unqork BYO interface. This separation of responsibility between custom code and Unqork’s platform is known as the Shared Responsibility Model:

• Creator Responsibility: Creators are responsible for the development, maintenance, security, and debugging of any custom JavaScript or external libraries brought into the platform using BYO.

• Unqork’s Responsibility: Unqork is responsible for the BYO utilities, JavaScript interface, and APIs that connect custom code to the Unqork ecosystem. Unqork ensures the connection between the Unqork platform and a Creator’s code functions as expected.

Troubleshooting and Bug Reporting

Use the following steps to troubleshoot custom code and, if needed, report a platform bug to Unqork:

1. Debug Custom Code
   Before contacting Unqork Support, perform a thorough internal code review. Most issues encountered using BYO components are related to logic errors, scoping issues, or library conflicts in the custom code.
   Test your code in a standalone environment outside of Unqork. If the issue persists, the bug likely resides in the custom logic instead of the BYO interface.

2. Identify the BYO Bug

   If your code works perfectly in a standalone environment but fails specifically when interacting with Unqork, you might have discovered a platform-level bug.

   Examples of BYO-specific issues include:

   • Interface Failures: A specific BYO API method, like set, currentState, resolveByKey is not behaving as documented.

   • Rendering Discrepancies: The component renders correctly in a local environment but fails to mount. Or it displays inconsistently when in the Unqork frame.

   • Lifecycle Issues: Event listeners or life cycle hooks provided by the BYO interface are not triggering correctly.

3. Create an Isolated Proof of Concept (POC)
   Help Unqork identify and fix a BYO bug by providing a reproducible example in an isolated environment. To ensure clarity, Unqork asks that you leverage the Official BYO Example Implementations as your baseline.

   When opening a bug report with https://support.unqork.com/, please provide the following:

   • The Base Example: Identify which implementation from our documentation you used as a starting point.

   • Isolated POC: Provide the custom package and an example module definition to Unqork. Avoid sending your entire implementation. Instead, isolate the specific BYO functionality that is failing.

   • Documented Changes: If you modified the example implementation to demonstrate the bug, please provide the specific code snippets used and clearly highlight where the example code was changed in a comment.

   • Behavior Description: Describe the expected behavior versus the actual behavior observed, for example, The onChange event triggers in the standalone example but does not update the Unqork state in the BYO environment..

   • Provide the Package Used: Provide the package with the code and manifest when opening a bug ticket.

Bug reports that do not include an isolated POC using a documentation example might be returned for further clarification to ensure our team can accurately replicate the issue without the noise of custom business logic.

Comparison of Support Scope

Use the following table to determine whether a feature or issue falls under the Creator’s or Unqork’s responsibility, and the recommended action for each scenario.

Found a bug in BYO’s utilities, JavaScript interface, or APIs? Please Unqork’s contact customer support at https://support.unqork.com/.