Skip to content

Spike: Investigate SDK graph output for diagram model #48

@lornakelly

Description

@lornakelly

Description

Spike to investigate what the SDK's buildGraph function returns and evaluate whether it can be used as the foundation for the graph structure needed to build the diagram, or whether a custom graph needs to be built from scratch.

Motivation

Before building the diagram with react flow nodes and edges types, we need to understand what the SDK already provides that can leverage it. Using the SDK graph output where possible avoids duplicating work and keeps the implementation closer to the spec. The outcome of this spike will inform what direction we will go.

Proposed Implementation

  • Inspect the output of buildGraph against some workflow examples covering the 12 task types and analyze if the graph structure covers nodes and edges relationships, hierarchy and containment (parent – child node relationship)
  • Evaluate whether the output contains sufficient information to build React Flow nodes and edges
  • Document findings and propose a direction - extend SDK output or build custom model
  • Add new ticket to implement work

Definition of Done

  • Implementation: Fully implemented according to the Serverless 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

Projects

Status

Backlog

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions