Skip to content

feat: Reduce warnings in build and test logs #283

Description

@fantonangeli

Description

The open-workflow-diagram-editor build currently produces a large number of warnings, like for React act(...), accessibility, and lint warnings.

Example job: https://github.com/open-workflow-specification/editor/actions/runs/30353445942/job/90256050921?pr=282

Log snippet:

packages/open-workflow-diagram-editor build:prod: This ensures that you're testing the behavior the user would see in the browser. Learn more at https://react.dev/link/wrap-tests-with-act
packages/open-workflow-diagram-editor build:prod: stderr | stories/examples/Examples.stories.tsx > Accumulate Room Readings
packages/open-workflow-diagram-editor build:prod: An update to DiagramEditorContextProvider inside a test was not wrapped in act(...).
packages/open-workflow-diagram-editor build:prod: When testing, code that causes React state updates should be wrapped into act(...):
packages/open-workflow-diagram-editor build:prod: act(() => {
packages/open-workflow-diagram-editor build:prod:   /* fire events that update state */
packages/open-workflow-diagram-editor build:prod: });

Steps to replicate

  • pnpm build:prod
  • Read the long list of messages

Motivation

Reducing the existing warnings would make CI logs easier to review and help new warnings to be discovered.

Proposed Implementation

Review the warnings and address them where possible.

Definition of Done

  • Implementation: Fully implemented according to the Open Workflow spec.
  • Unit Tests: Comprehensive unit tests are included and passing.
  • Integration Tests: Verified within the monorepo and target environments (Web/VS Code).
  • Documentation: Updated README.md, ADRs, or official docs.
  • Performance: No significant regression in editor responsiveness.
  • Accessibility: UI changes comply with accessibility standards.

Metadata

Metadata

Assignees

Labels

enhancementNew feature or request

Type

No type

Projects

Status
Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions