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

XLSX output of Accessibility Checker API is not flushed to disk #2124

Open
8 tasks
jamalmazrui opened this issue Dec 10, 2024 · 3 comments
Open
8 tasks

XLSX output of Accessibility Checker API is not flushed to disk #2124

jamalmazrui opened this issue Dec 10, 2024 · 3 comments
Assignees
Labels
node-accessibility-checker Issues in the accessibility-checker component user-reported Issues identified outside of the core team

Comments

@jamalmazrui
Copy link

Using the Node.js accessibility-checker package, I am writing a program that saves test results in multiple formats, including .xlsx. My program tries to rename the output from results.xlsx to something more meaningful, such as the title of the web page that was tested (sanitized for the file system). Even though the checker object is closed before the rename attempt, however, this fails. After the program exits, results.xlsx is present, so I know it is being created. How can I ensure that all output files produced by the checker.getCompliance method are flushed to disk? is Describe the bug
A clear and concise description of what the bug is.

To Reproduce
Steps to reproduce the behavior:

  1. Go to '...'
  2. Click on '....'
  3. Scroll down to '....'
  4. See error

Expected behavior
A clear and concise description of what you expected to happen.

Screenshots
If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

  • OS: [e.g. iOS]
  • Browser [e.g. chrome, safari]
  • Version [e.g. 22]

Smartphone (please complete the following information):

  • Device: [e.g. iPhone6]
  • OS: [e.g. iOS8.1]
  • Browser [e.g. stock browser, safari]
  • Version [e.g. 22]

Additional context
Add any other context about the problem here.

Definition of Done

  • Design artifacts reviewed
  • Work item implemented
  • Automated test case created (when applicable)
  • Unit test completed
  • Run Checker (when applicable)
  • Manual and Screen Reader Testing (when applicable)
  • Video recording of user experience walkthrough (if impact to UX)
  • PR created
@tombrunet
Copy link
Member

results.xlsx is not created until the tests are complete since it contains summaries of the results of all tests.

You should be able to generate the summary files by calling the close function to indicate that you're done, but, looking at the code, it looks like that was removed. I'll have to do some digging to determine when and why that happened.

@MHoov MHoov added node-accessibility-checker Issues in the accessibility-checker component user-reported Issues identified outside of the core team labels Dec 10, 2024
@tombrunet
Copy link
Member

I think this may be a dupe of #2120

@jamalmazrui
Copy link
Author

My code is calling a close() method of the checker object, but it does not assure that all output files, including results.xlsx, are fully written to disk (I am calling it synchronously).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
node-accessibility-checker Issues in the accessibility-checker component user-reported Issues identified outside of the core team
Projects
None yet
Development

No branches or pull requests

3 participants