facebookarchive/prepack

Rewrite reportIntrospectionError calls

Open

#1,898 opened on May 8, 2018

View on GitHub
 (8 comments) (0 reactions) (0 assignees)JavaScript (520 forks)batch import
enhancementhelp wanted

Repository metrics

Stars
 (14,268 stars)
PR merge metrics
 (No merged PRs in 30d)

Description

Once upon a time, Prepack didn't have a real error-handling story besides just throwing an exception. From this time, there are still a ton of reportIntrospectionError calls in the code base.

They should all be rewritten, one by one (separate pull-requests, please) into something like the following.

    let error = new CompilerDiagnostic("appropriate error message", referenceToSourceLocation, "PPxxxx", "FatalError");
    realm.handleError(error);
    throw new FatalError();

Where PPxxxx should be the next currently unused error code; check https://github.com/facebook/prepack/wiki/Prepack-diagnostics for all currently defined error code.

  • Create a new wiki page with the PP error number as its name.
  • Add a link to it from the page that lists all error numbers.

Contributor guide

Research direction
Find the next unused PP error code from the Prepack diagnostics wiki, then locate a 'reportIntrospectionError' call in the source code and replace it with a new CompilerDiagnostic instance with the appropriate error message, source location, error code, and severity. Ensure to throw a FatalError after handling. Also create a new wiki page for the error code and add a link from the main error list.
Tech stack
javascript
Domain
backenddeveloper experience
Issue type
Refactor
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
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
GitJavaScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60