WeChat Mini Program issue report

To quickly and accurately locate issues you encounter when developing or using a WeChat Mini Program that uses EasyAR capabilities, such as Mega or CRS, refer to this guide before submitting feedback and provide the necessary information and data. This can significantly reduce back-and-forth communication time during troubleshooting.

Issue precheck

Before reporting an issue, you can first try to solve it quickly through some basic methods or by reading the documentation.

Using the Mega plugin:

• Confirm that you are using the 2.x Mini Program plugin. The 1.x Mega Mini Program plugin is no longer maintained
• Read Known issues and limitations of the Mega plugin to confirm whether it is a known issue.
• Refer to and modify your implementation according to Mega Sample or CRS Sample, and confirm that the issue still exists.

Data required when giving feedback

A complete issue report usually needs to include the following data so that the EasyAR development team can perform accurate analysis.

Runtime environment data

• Device model: You can try to obtain it with wx.getDeviceInfo().model.
• WeChat client platform: Obtain it with wx.getDeviceInfo().system.
• WeChat version: Obtain it with wx.getAppBaseInfo().version.
• WeChat Mini Program client base library version: Obtain it with wx.getAppBaseInfo().SDKVersion.
• Mega plugin version used, if using the Mega plugin: It can be obtained from the version field in the plugins field of the project app.json file.

[Mega] AR Session dump file (critical)

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

Refer to How to use your Mini Program to record AR Session dump files to implement dump file recording and forwarding.

In addition, if the localization issue can be stably reproduced, you can also use Mega toolbox to record this data and forward it. Refer to Use WeChat Mini Program Mega Toolbox to record and forward session dump data.

Screen recording (recommended)

If you use the Mega plugin, be sure to perform 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 issues when using Mega, rather than program exceptions, be sure to provide the session dump file and screen recording file at that time. Plain log files can only provide side references. Dump data and screen recording are the core evidence for troubleshooting.