27 March 2013
Wednesday FAQs: Corona Bug Reports
It’s Wednesday and time for another frequently asked questions (FAQs) session. Here are some FAQs about submitting Corona Bug Reports.
1. The Corona Simulator not longer works, please fix it!
That was an actual bug report we received with no other information about the problem. We do like to know about bugs and try to fix them, but you need to supply information to help us do that. At the very minimum, we need the following items in your bug report:
- What platform are you having the problem on: Mac simulator, Windows, simulator, iOS, Android?
- If it’s failing only on a device, which ones have you tested and what version of the OS is it using?
- What Corona build are you using? If it’s a Daily Build, does it work with the Release Build? What build did it stop working on?
- Steps to reproduce the problem
- Project code to demonstrate the problem
If your project is failing when doing a build or installing on a device, try building and installing one of the Corona sample projects (e.g., HelloWorld). That will tell you if your system is set up to build and install your app.
When you’re filing a bug report, please think about what you would need to troubleshoot the problem if you were assigned this bug.
You will see the “Report A Bug” link at the top of the Corona website when you’re logged in. Please fill out the entire form and add any additional information to help reproduce your bug.
2. I posted my bug in the forums, so why do I need to submit a bug report?
A lot of bugs get posted in the Corona forums, and that’s a good thing. It makes users aware of the possible problem and others can help confirm the bug. We do monitor the forums and respond to reports, but just because we responded in the forums, doesn’t mean the bug is in our system to be fixed. You need to file a formal bug report with the information listed above. This adds it to our bug tracking system and allows us to assign a priority to the bug and route it to engineering for a fix. It also assigns a case number that can be used to track the bug.
3. My bug was rejected because I didn’t supply test code. Why?
We need test code in order to verify the bug. Just describing what you’re doing in your code is generally not enough. In many cases it’s the combination of all the code files and assets that factor into the bug. We have tried to reproduce many bug cases with only a code snippet and find that there wasn’t enough information to show the problem.
Supplying test code also helps us verify and assign your case faster. If there is a complete test project that we can run, it will be evaluated as soon as possible. Cases that require creating a new project with your code snippet, may be pushed aside until later.
4. My bug was rejected because I only supplied a main.lua file. Why?
Many cases come in with just a main.lua file attached. Sometimes this is enough to reproduce the problem but in many cases it’s not. I remember one case where only the main.lua file was supplied. I created a new project using the file and couldn’t reproduce the bug. It turned out that the bug only occurred in landscape mode. If they had supplied a complete set of project files, I would have seen the problem and saved time.
Sometimes you don’t know the exact cause of the problem so supplying an entire test project that demonstrates the issue, will help us confirm the bug and get it assigned to be fixed sooner.
5. My project is too big to submit, what can I do?
As mentioned in Question 4, we want project code that demonstrates the problem, but we don’t want your complete project. The reason is it takes to much time to go through the code and try to understand what it’s doing. Not all problems you encounter in your development will be Corona bugs so you need to debug and isolate problems you’re seeing. If in that process you find a bug, and know that it’s not something you’re doing wrong in your code, please try to create a short test case that demonstrates the problem. You can then zip up that project (with all its support files and assets) and attach it to the bug report.
We’ve had some users send us their complete project code and ask us to debug it for them. We don’t have the resources nor the time to do that and can only address bug reports where someone has taken the time to isolate and identify a Corona problem.
6 Why does the simulator crash when I run my app?
Simulator crashes occur with uncaught errors in the project code. We place a high priority on fixing errors that cause the simulators to crash, but sometimes there are errors in the project code that will crash the simulator.
If you’re running the Mac simulator, it will generate a “crash log.” Many users have sent us these crash logs after getting the crash. The crash logs give us an idea where the problem is, but don’t help us find and fix the cause of the crash.
To help solve this bug, we really need a small test project that can reproduce the simulator crash along with the steps to reproduce it.
That’s it for today’s questions. I hope you enjoyed them and even learned a few things.