processing / processing/p5.js

CI Test Failing Around saveGif Documentation After Merging Markdown File

Open
#6,465 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Bug Discussion Unit Testing
Dominant language
JavaScript
Stars
24k
Forks
3.8k
Avg merge
3d 16h
Merged PRs (30d)
25

Description

Most appropriate sub-area of p5.js?
  • Accessibility
  • Color
  • Core/Environment/Rendering
  • Data
  • DOM
  • Events
  • Image
  • IO
  • Math
  • Typography
  • Utilities
  • WebGL
  • Build Process
  • Unit Testing
  • Internalization
  • Friendly Errors
  • Other (specify if possible)
p5.js version

n/a

Web browser and version

n/a

Operating System

n/a

Steps to reproduce this
Description

After merging This Markdown file, a CI test began failing. The issue seems to revolve around the saveGif documentation (see the log below).

Expected behavior

All CI checks should pass without errors after merging a Markdown file that is unrelated to codebase functionality.

CI Run Log
1 failing
  954 passing (39s)
  1) src/image/loading_displaying.js
       saveGif documentation
         example #1 works:
     TypeError: Cannot read properties of null (reading 'insertAdjacentHTML')
      at _main.default._describeHTML (http://localhost:9001/lib/p5.js:5[2184](https://github.com/processing/p5.js/actions/runs/6451897549/job/17513145355#step:5:2185):73)
      at _main.default.describe (http://localhost:9001/lib/p5.js:52034:18)
      at p5.draw (eval at <anonymous> (test-reference.html:36:11), <anonymous>:7:3)
      at p.<computed> (test-reference.html:153:27)
      at p.draw (test-reference.html:165:27)
      at _main.default.redraw (http://localhost:9001/lib/p5.js:70928:25)
      at _draw (http://localhost:9001/lib/p5.js:62374:23)

Warning: [object Object] Use --force to continue.

Aborted due to warnings.
Error: Process completed with exit code 3.

Full log: https://github.com/processing/p5.js/actions/runs/6451897549/job/17513145355

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the failing saveGif documentation example in src/image/loading_displaying.js and compare its CI traceback, especially the _describeHTML call and test-reference.html. Reproduce the unit-test failure and trace why the documentation example lacks the expected HTML context; done means the test passes and CI completes without errors.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
testing
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.