WeChat Mini Program Issue Report

To quickly and accurately locate issues you encounter while developing or using WeChat Mini Programs that utilize EasyAR's capabilities (Mega or CRS), please refer to this guide to provide the necessary information and data before submitting feedback. This will significantly reduce the back-and-forth communication time for troubleshooting.

Pre-checking the issue

Before reporting an issue, you can try some basic methods or read the documentation to resolve it quickly.

Using the Mega plugin:

• Confirm that you are using the 2.x version of the Mini Program plugin (the 1.x version of the Mega Mini Program plugin is no longer maintained).
• Read Mega plugin known issues and limitations to confirm if it is a known issue.
• Refer to the implementation in Mega Sample or CRS Sample and verify that the issue persists.

Data required when reporting an issue

A complete issue report typically needs to include the following data to enable the EasyAR development team to conduct an accurate analysis.

Runtime environment data

• Device model: You can try to obtain it via wx.getDeviceInfo().model.
• WeChat client platform: Obtain it via wx.getDeviceInfo().system.
• WeChat version number: Obtain it via wx.getAppBaseInfo().version.
• WeChat Mini Program client base library version: Obtain it via wx.getAppBaseInfo().SDKVersion.
• (If using the Mega plugin) Mega plugin version used: Can be obtained from the version field in the plugins section of the project's app.json file.

[Mega] AR Session dump file (critical)

The AR Session dump file that can reproduce the issue is the most important data for analyzing localization and tracking issues in WeChat Mini Programs.

Refer to How to record an AR Session dump file with your Mini Program to implement the recording and forwarding of dump files.

Additionally, if the issue can be stably reproduced, you can also use the Mega Toolbox to record and forward this data. Refer to Using the WeChat Mini Program Mega Toolbox to record and forward session dump data.

Screen recording (recommended)

If using the Mega plugin, be sure to perform an AR Session dump while recording the screen. This allows us to align the visual phenomena in the video with the underlying algorithm data.

Runtime logs

If errors appear in vConsole, you need to submit detailed error information. For detailed methods, refer to Log analysis on WeChat Mini Programs.

Important

If you encounter localization or tracking-related issues (rather than program exceptions) when using Mega, be sure to provide the session dump file and screen recording file from that time. Log files alone can only provide indirect references; dump data and screen recordings are the core basis for troubleshooting.