Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

epic: Better Error Handing #2556

Closed
imtuyethan opened this issue Apr 1, 2024 · 2 comments
Closed

epic: Better Error Handing #2556

imtuyethan opened this issue Apr 1, 2024 · 2 comments
Labels
type: epic A major feature or initiative

Comments

@imtuyethan
Copy link
Contributor

imtuyethan commented Apr 1, 2024

Motivation

The current error handling system in Jan app has too many edge cases, which is challenging to maintain.
Our goal is to implement a simplified, standardized error format within the Jan app, focusing on improving maintainability, and providing better context for error handling.

Key Results

  • Less hassle: We'll save time by using a standard template instead of creating unique messages for each scenario.
  • Efficient troubleshooting: Standardized messages speed up troubleshooting for both users and platform.

Key User Stories

  • Users should see a clear & standardized error message
  • Users see inline error message in threads
  • Error message should be saved in threads so users can look back when they need to
  • Users can copy logs & file Github issue or send it to our Discord
  • Errors type:
    • For unclear errors, there’s no error code
    • For identified error, we map it with error code
  • All errors should be mapped out with recommended docs

Image

Screenshot 2024-04-16 at 4 36 56 PM

See error code numbering convention: https://www.notion.so/jan-ai/Error-Code-Numbering-Convention-a3a1e96a93254df3ace6dc93d4cc849e?pvs=4

Specs

Check Notions spec for more details
https://www.notion.so/jan-ai/Standardized-Error-Format-for-Jan-abea56d32d6648bb8c6835f9176f800c?pvs=4

Designs

Figma
Screenshot 2024-04-16 at 4 38 09 PM

@imtuyethan imtuyethan added the type: epic A major feature or initiative label Apr 1, 2024
@imtuyethan imtuyethan moved this to Planned in Menlo Apr 15, 2024
@louis-menlo louis-menlo assigned Inchoker and unassigned namchuai and louis-menlo Apr 16, 2024
@imtuyethan imtuyethan added the P1: important Important feature / fix label Apr 16, 2024
@urmauur urmauur assigned namchuai and unassigned urmauur Jun 2, 2024
@namchuai namchuai assigned Van-QA and unassigned namchuai Aug 19, 2024
@Van-QA Van-QA removed their assignment Aug 19, 2024
@Van-QA Van-QA added this to the v0.7.1 milestone Aug 19, 2024
@imtuyethan imtuyethan moved this from Planned to Icebox in Menlo Aug 28, 2024
@imtuyethan imtuyethan moved this from Icebox to Planned in Menlo Aug 28, 2024
@imtuyethan imtuyethan removed this from the v0.7.1 milestone Aug 28, 2024
@imtuyethan imtuyethan moved this from Planned to Icebox in Menlo Aug 28, 2024
@imtuyethan imtuyethan removed the P1: important Important feature / fix label Aug 28, 2024
@imtuyethan imtuyethan moved this from Icebox to Planning in Menlo Aug 30, 2024
@freelerobot freelerobot changed the title epic: Standardized Error Format epic: Standardized Error Formats in UI Sep 5, 2024
@dan-menlo dan-menlo moved this from Planning to Icebox in Menlo Sep 26, 2024
@imtuyethan imtuyethan changed the title epic: Standardized Error Formats in UI epic: Standardized & Better Error Handing Oct 14, 2024
@imtuyethan imtuyethan changed the title epic: Standardized & Better Error Handing epic: Better Error Handing Oct 14, 2024
@imtuyethan
Copy link
Contributor Author

imtuyethan commented Oct 14, 2024

Related issues that needs better error handing:

  1. Jan fails to load models when the file path contains special characters: https://discord.com/channels/1107178041848909847/1294680372264697907
  2. Missing Hardware Dependencies → Ask users to download dependencies to turn on GPU acceleration: feat: Implement UI for Better Hardware Settings  #3688
  3. feat: Graceful failure for model loading (not Something's Amiss Error) #3517

@freelerobot
Copy link
Contributor

Handled by cortex, this issue is a UI/design issue, which we need to rework

@github-project-automation github-project-automation bot moved this from Icebox to Review + QA in Menlo Oct 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: epic A major feature or initiative
Projects
Archived in project
Development

No branches or pull requests

7 participants