Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The Issue
The
Example Usage
page in the docs contains an edge that can result in data loss. Here's an explanation of the edge case:Collection:load
caches load promises for each document. The promise is removed from the cache whenDocument:close
is called.Document:load
is called which returns a promise that is cached.Document:load
is called again, the promise from the first load never finished (meaningDocument:close
hasn't been called yet), so the cached promise from the first load is returned.Document:close
because thatPlayer
instance is no longer in the game.This edge case probably has not happened in practice because it would require a player rejoining the same server before their document loads. Nonetheless, it should absolutely be fixed. It could be fixed by modifying the example but I think changing Lapis makes more sense.
The Fix
Lapis no longer caches load promises. This is a breaking change, though I don't know if anyone relies on this behavior.