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

Re-arrange slightly to prevent refactor hazard #16743

Merged
merged 11 commits into from
Sep 11, 2019

Commits on Sep 5, 2019

  1. Track "pending" and "suspended" ranges

    A FiberRoot can have pending work at many distinct priorities. (Note: we
    refer to these levels as "expiration times" to distinguish the concept
    from Scheduler's notion of priority levels, which represent broad
    categories of work. React expiration times are more granualar. They're
    more like a concurrent thread ID, which also happens to correspond to a
    moment on a timeline. It's an overloaded concept and I'm handwaving over
    some of the details.)
    
    Given a root, there's no convenient way to read all the pending levels
    in the entire tree, i.e. there's no single queue-like structure that
    tracks all the levels, because that granularity of information is not
    needed by our algorithms. Instead we track the subset of information
    that we actually need — most importantly, the highest priority level
    that exists in the entire tree.
    
    Aside from that, the other information we track includes the range of
    pending levels that are known to be suspended, and therefore should not
    be worked on.
    
    This is a refactor of how that information is tracked, and what each
    field represents:
    
    - A *pending* level is work that is unfinished, or not yet committed.
      This includes work that is suspended from committing.
      `firstPendingTime` and `lastPendingTime` represent the range of
      pending work. (Previously, "pending" was the same as "not suspended.")
    - A *suspended* level is work that did not complete because data was
      missing. `firstSuspendedTime` and `lastSuspendedTime` represent the
      range of suspended work. It is a subset of the pending range. (These
      fields are new to this commit.)
    - `nextAfterSuspendedTime` represents the next known level that comes
      after the suspended range.
    
    This commit doesn't change much in terms of observable behavior. The one
    change is that, when a level is suspended, React will continue working
    on the next known level instead of jumping straight to the last pending
    level. Subsequent commits will use this new structure for a more
    substantial refactor for how tasks are scheduled per root.
    acdlite committed Sep 5, 2019
    Configuration menu
    Copy the full SHA
    100945b View commit details
    Browse the repository at this point in the history

Commits on Sep 6, 2019

  1. Get next expiration time from FiberRoot

    Given a FiberRoot, we should be able to determine the next expiration
    time that needs to be worked on, taking into account the levels that
    are pending, suspended, pinged, and so on.
    
    This removes the `expirationTime` argument from
    `scheduleCallbackForRoot`, and renames it to `ensureRootIsScheduled` to
    reflect the new signature. The expiration time is instead read from the
    root using a new function, `getNextExpirationTimeToWorkOn`.
    
    The next step will be to remove the `expirationTime` argument from
    `renderRoot`, too.
    acdlite committed Sep 6, 2019
    Configuration menu
    Copy the full SHA
    6ace553 View commit details
    Browse the repository at this point in the history

Commits on Sep 9, 2019

  1. Don't bind expiration time to render callback

    This is a fragile pattern because there's only meant to be a single
    task per root, running at a single expiration time. Instead of binding
    the expiration time to the render task, or closing over it, we should
    determine the correct expiration time to work on using fields we
    store on the root object itself.
    
    This removes the "return a continuation" pattern from the
    `renderRoot` function. Continuation handling is now handled by
    the wrapper function, which I've renamed from `runRootCallback` to
    `performWorkOnRoot`. That function is merely an entry point to
    `renderRoot`, so I've also removed the callback argument.
    
    So to sum up, at at the beginning of each task, `performWorkOnRoot`
    determines which expiration time to work on, then calls `renderRoot`.
    And before exiting, it checks if it needs to schedule another task.
    acdlite committed Sep 9, 2019
    Configuration menu
    Copy the full SHA
    fd253c9 View commit details
    Browse the repository at this point in the history

Commits on Sep 10, 2019

  1. Configuration menu
    Copy the full SHA
    052ee96 View commit details
    Browse the repository at this point in the history
  2. Remove lastPendingTime field

    It's no longer used anywhere
    acdlite committed Sep 10, 2019
    Configuration menu
    Copy the full SHA
    9a54113 View commit details
    Browse the repository at this point in the history
  3. Restart on update to already suspended root

    If the work-in-progress root already suspended with a delay, then the
    current render definitely won't finish. We should interrupt the render
    and switch to the incoming update.
    acdlite committed Sep 10, 2019
    Configuration menu
    Copy the full SHA
    b4ff414 View commit details
    Browse the repository at this point in the history
  4. Restart on suspend if return path has an update

    Similar to the previous commit, if we suspend with a delay, and
    something in the return path has a pending update, we should abort
    the current render and switch to the update instead.
    acdlite committed Sep 10, 2019
    Configuration menu
    Copy the full SHA
    2d93c7e View commit details
    Browse the repository at this point in the history
  5. Track the next unprocessed level globally

    Instead of backtracking the return path. The main advantage over the
    backtracking approach is that we don't have to backtrack from the source
    fiber. (The main disadvantages are that it requires another module-level
    variable, and that it could include updates from unrelated
    sibling paths.)
    acdlite committed Sep 10, 2019
    Configuration menu
    Copy the full SHA
    09461dc View commit details
    Browse the repository at this point in the history
  6. Re-arrange slightly to prevent refactor hazard

    It should not be possible to perform any work on a root without
    calling `ensureRootIsScheduled` before exiting. Otherwise, we could
    fail to schedule a callback for pending work and the app could freeze.
    
    To help prevent a future refactor from introducing such a bug, this
    change makes it so that `renderRoot` is always wrapped in try-finally,
    and the `finally` block calls `ensureRootIsScheduled`.
    acdlite committed Sep 10, 2019
    Configuration menu
    Copy the full SHA
    628d185 View commit details
    Browse the repository at this point in the history

Commits on Sep 11, 2019

  1. Remove recursive calls to renderRoot.

    There are a few leftover cases where `renderRoot` is called recursively.
    All of them are related to synchronously flushing work before its
    expiration time.
    
    We can remove these calls by tracking the last expired level on the
    root, similar to what we do for other types of pending work, like pings.
    acdlite committed Sep 11, 2019
    Configuration menu
    Copy the full SHA
    2ca796b View commit details
    Browse the repository at this point in the history
  2. Remove argument from performSyncWorkOnRoot

    Read the expiration time from the root, like we do
    in performConcurrentWorkOnRoot.
    acdlite committed Sep 11, 2019
    Configuration menu
    Copy the full SHA
    8b5dcd3 View commit details
    Browse the repository at this point in the history