Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(efb): troubleshooting page #9747

Open
wants to merge 8 commits into
base: master
Choose a base branch
from

Conversation

tracernz
Copy link
Member

Fixes #[issue_no]

Summary of Changes

Adds a troubleshooting page under the about page in the EFB for advanced user support. The idea here is to log things that have user visible errors that don't provide enough info to determine the cause, e.g. "INTERNAL ERROR" in the FMS. It is not intended to be a general-purpose error log as it would lose it's usefulness when filled with lots of random messages like the debugger.

Hopefully we can figure out the recent spike in these INTERNAL ERRORs.

Needs #9559 merged first (for isMsfs2024 function).

Screenshots (if necessary)

image
image

References

Additional context

Discord username (if different from GitHub):

Testing instructions

Go to the about page on the EFB, and then click Troubleshooting.. check that the info displayed is accurate and the layout reasonable. If you know of a repro to cause an INTERNAL ERROR on the A32NX, you could also try it to see the message in the troubleshooting log.

How to download the PR for QA

Every new commit to this PR will cause new A32NX and A380X artifacts to be created, built, and uploaded.

  1. Make sure you are signed in to GitHub
  2. Click on the Checks tab on the PR
  3. On the left side, find and click on the PR Build tab
  4. Click on either flybywire-aircraft-a320-neo, flybywire-aircraft-a380-842 (4K) or flybywire-aircraft-a380-842 (8K) download link at the bottom of the page

export const TroubleshootingContextProvider: React.FC<TroubleshootingContextProps> = ({ eventBus, children }) => {
const [errorLog, setErrorLog] = useState([] as string[]);

eventBus
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This will leak subscriptions every time it renders.

You should place this in a useEffect (with an empty dependency array) whose cleanup function destroys the subscription.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: 🔴 Code Review: In progress
Development

Successfully merging this pull request may close these issues.

2 participants