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 when Document:close is called.
Player joins the server and Document:load is called which returns a promise that is cached.
Player leaves and rejoins that same server.
Document:load is called again, the promise from the first load never finished (meaning Document:close hasn't been called yet), so the cached promise from the first load is returned.
The promise resolves, the original load calls Document:close because that Player instance is no longer in the game.
The new load now has a closed document and none of their data will be saved at this point.
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.
The Issue
The
Example Usagepage in the docs contains an edge that can result in data loss. Here's an explanation of the edge case:Collection:loadcaches load promises for each document. The promise is removed from the cache whenDocument:closeis called.Document:loadis called which returns a promise that is cached.Document:loadis called again, the promise from the first load never finished (meaningDocument:closehasn't been called yet), so the cached promise from the first load is returned.Document:closebecause thatPlayerinstance 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.