invoke-ai/InvokeAI

[enhancement]: Better Error Boundaries

Open

#4498 opened on Sep 9, 2023

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (20,358 stars) (2,164 forks)batch import
enhancementgood first issueweb ui

Description

Is there an existing issue for this?

  • I have searched the existing issues

Contact Details

No response

What should this feature add?

Currently we have one "global" error boundary, catching exceptions that bubble up to the root of the application.

We should implement much more granular error boundaries across the application.

This could be implemented in parts:

  • enhance the error boundary fallback component to be more descriptive and useful
    • scrollable area to display the full error?
    • probably should have a "refresh" button in addition to "reset", as often all that's needed is to refresh the page
    • make it configurable using AppConfig / configSlice so that eg commercial can provide their own components or URLs
  • utilize it in other areas - like one for canvas, one for nodes, one for gallery, etc

Alternatives

No response

Additional Content

No response

Contributor guide

Tech stack
typescriptreactcss
Domain
frontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
React error boundariesTypeScriptInvokeAI codebase structure
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65
Research direction
Start by examining the current global error boundary in the codebase (likely in src/). Identify the fallback component and how it's used. Look at AppConfig and configSlice to understand how to make the fallback configurable. Then propose implementing granular error boundaries for canvas, nodes, gallery etc. Check if there are any existing discussions or PRs (none found). Consider adding a refresh button and scrollable error display.