• 
      

    Cache the review request's draft on the instance.

    Review Request #14376 — Created March 19, 2025 and submitted

    Information

    Review Board
    release-7.1.x

    Reviewers

    ReviewRequest.get_draft() fetched the draft every time it was called.
    This was somewhat acceptable once, but with the introduction of actions
    and some fields, we ended up calling this a lot, leading to an excess
    of database queries on the review request pages. This also meant that
    all the callers got separate instances, which could in theory cause some
    problems with state synchronization and data loss during mutation.

    We now cache this on the ReviewRequest object, so that repeated
    calls will return the same draft instance. We clear this when calling
    ReviewRequest.clear_local_caches(), which includes when the draft is
    deleted or published.

    The codebase was audited to make sure this wouldn't result in any
    obvious problems, though it does mean that callers that may be working
    with multiple instances of the same review request (such as API unit
    tests) must be careful to clear caches if re-querying for a draft.

    All unit tests pass.

    Spent some time running with this patch locally, testing the typical
    functionality of posting changes, updating changes, publishing, deleting.
    Never hit any issues. It will need more production testing before
    release.

    Summary ID
    Cache the review request's draft on the instance.
    `ReviewRequest.get_draft()` fetched the draft every time it was called. This was somewhat acceptable once, but with the introduction of actions and some fields, we ended up calling this a lot, leading to an excess of database queries on the review request pages. This also meant that all the callers got separate instances, which could in theory cause some problems with state synchronization and data loss during mutation. We now cache this on the `ReviewRequest` object, so that repeated calls will return the same draft instance. We clear this when calling `ReviewRequest.clear_local_caches()`, which includes when the draft is deleted or published. The codebase was audited to make sure this wouldn't result in any obvious problems, though it does mean that callers that may be working with multiple instances of the same review request (such as API unit tests) must be careful to clear caches if re-querying for a draft.
    6e538a18c7cf6af0918224b285ebea775cd7cdda
    Description From Last Updated

    'django.db.models.QuerySet' imported but unused Column: 1 Error code: F401

    reviewbot reviewbot

    redefinition of unused 'User' from line 9 Column: 5 Error code: F811

    reviewbot reviewbot
    Checks run (1 failed, 1 succeeded)
    flake8 failed.
    JSHint passed.

    flake8

    chipx86
    david
    1. Ship It!
    2. 
        
    maubin
    1. Ship It!
    2. 
        
    chipx86
    david
    1. Ship It!
    2. 
        
    chipx86
    Review request changed
    Status:
    Completed
    Change Summary:
    Pushed to release-7.1.x (710d72e)