RFC 032: Calm deletion watcher
Last updated
Last updated
This RFC describes a proposal for a Calm deletion watcher, which will allow us to detect deleted Calm records and update the VHS accordingly.
Last modified: 2021-02-09T17:03:48+00:00
We've realised that the pipeline does not pick up deleted Calm records - once they're deleted there is no trace of them in the Calm API, but they remain in the source VHS tables. Especially because a cleanup project at the end of last year was responsible for a very large number of deletions, this needs to be resolved.
So far as we can tell, there is no way to find deleted records other than checking for their absence. This means that our solution needs to take some sort of polling-based approach: going through the source table and checking for the continued presence of each record in the Calm API.
The deletion watcher will consist of:
A worker task in the calm adapter cluster
A lambda
The existing reindexer
The lambda will place a message on the reindexer queue requesting a "reindex" of Calm records to be sent to the worker. It will be triggered by a scheduled Cloudwatch event or manually. By default it will request the full source scan but in the case of a manual trigger it will be possible to request specific IDs, which will be useful in the case of expediting known deletions.
The worker will consume records, filter out those that are already flagged as deleted, and check for the existence of the rest in the Calm API. If the record has been deleted (is no longer present) then it will update the VHS entry to flag the deletion. The deletion flag will live in the DynamoDB record so that the flag can be checked without fetching the object from S3. After updating a record, the worker will notify the transformer topic.
The calm transformer will check for the presence of the deletion flag in the source data and create Deleted works as appropriate.
This architecture is illustrated below (arrows indicate the direction of data flow):
Checking for the existence of the records can be done naïvely by performing a search (the only relevant action available to us in the current API version) for a given record ID and confirming that the returned SearchResult number is equal to 1. Obviously, this requires 1 request per record.
We can, however, do better than this. Consider that we have a large population of records with a fairly low prevalence of deletions. In one query, we can search for a set of N records, and know that the difference between N and the number of results is the number of deleted records d in that set. If there is no difference, we can move on immediately.
At this point we could iterate through either the results or the record IDs to find which are missing, or we could find the missing records via binary search - but the former means that we only reduce the number of queries if there are no records missing among the set, and the latter is both poorly suited for finding multiple occurrences, and does not take advantage of our knowledge of d.
Note: I have verified that the Calm API is happy to take requests for batches of IDs up to (and probably beyond) a size of 1000.
Are we really 100% sure that polling for deletions is the only way to detect them?
Might we want to be continually checking (more like crawling) for deletions rather than doing it all at once?
Perhaps unsurprisingly, this is a problem that has been considered in the literature and indeed is particularly relevant at the moment - for example, in October described a strategy for finding positive SARS-CoV-2 tests in individuals by pooled testing across a population. Our testing tool can tell us how many deleted items there are in a given set, so is an instance of the specific problem of quantitative group testing.
Although optimal or near-optimal strategies for solving this problem do , their implementations are quite involved compared to others, so as a compromise we can use the result from which has a very elegant implementation and reasonably competitive performance.
