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

Make errors more structured #50

Open
fubuloubu opened this issue Sep 19, 2024 · 2 comments
Open

Make errors more structured #50

fubuloubu opened this issue Sep 19, 2024 · 2 comments
Labels
category: feature New feature or request

Comments

@fubuloubu
Copy link
Member

fubuloubu commented Sep 19, 2024

Describe

Downstream integrators want better support for displaying errors from this service, create a more structured way for displaying compiler errors so that they can be displayed

Specification

Remix's error structure is as follows:

interface CompilerError {
    status: string = "failed"; // NOTE: We don't really need to specify this as anything else
    message: string; // Use `e.message`
    column: number;
    line: number;
    errorType: string; // Use `e.__class__.__name__`
}

Not all errors would it make sense to change, but the result obtained from the /errors/{task_id} endpoint should be described this way, for any configuration or compile-time exceptions

Dependencies

n/a

@fubuloubu fubuloubu added the category: feature New feature or request label Sep 19, 2024
@joeizang
Copy link

errorType can be SyntaxError Exception, which I think was a type of error I saw when testing.

@fubuloubu
Copy link
Member Author

errorType can be SyntaxError Exception, which I think was a type of error I saw when testing.

right, but from your perspective it's just a string that gets printed right?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category: feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants