onivim/oni

Error Handling: Startup

Open

#1383 opened on Jan 28, 2018

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (11,389 stars) (336 forks)batch import
enhancementhelp wantedinsider

Description

This is tracking adding some better error-handling in startup, to give the user feedback when there is an issue on startup. Coming from @Akin909 's comments in #1381:

A solution to this is that the changeDir function should always check that the directory it is passed is valid before attempting to switch to it. A more general issue is that I think every function or rather main startup process should have a try/catch or some form of error handling so that oni doesn't end up hanging without any feedback given back to the user

We should do the following:

  • Wrap our 'start' call in a try/catch so that we can get errors
  • Have some UI affordance for showing an error UI (perhaps in Shell?). This could show any errors logged, as well as give the option for opening up a debug window. We could also potentially show an error notification once #1358 is in.

Contributor guide

Tech stack
typescriptreactelectron
Domain
frontenddesktop
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
TypeScript basicsOni startup codeReact/UI components
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Start by reviewing comments in issue #1381 for context on the changeDir function and error handling gaps. Look at the current 'start' function in the main process (likely in src/index.ts or similar). Examine the Shell component for potential error UI integration. Consider implementing a try/catch around the start call and displaying errors via a notification system similar to #1358.