JSONAPI-Resources / JSONAPI-Resources/jsonapi-resources

Caching keys lack sub second precision

Open
#1,216 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
2.3k
Forks
546
PR merge metrics
No merged PRs in 30d

Description

This issue is a (choose one):

  • Problem/bug report.
  • Feature request.
  • Request for support. Note: Please try to avoid submitting issues for support requests. Use Gitter instead.

Checklist before submitting:

  • I've searched for an existing issue.
  • I've asked my question on Gitter and have not received a satisfactory answer.
  • I've included a complete bug report template. This step helps us and allows us to see the bug without trying to reproduce the problem from your description. It helps you because you will frequently detect if it's a problem specific to your project.
  • The feature I'm asking for is compliant with the JSON:API spec.

Description

Choose one section below and delete the other:

Bug reports:

The mechanism for building a cache key by default uses the rails updated_at field, which when stringified truncates the millisecond precision, which means that if two requests arrive and mutate a record in less than a second, the first write will win - which is the exact opposite of what you would want.

This is the monkey patched fix we've deployed

    keys = cache_ids.map do |(id, cache_key)|
      # If the cache key is a time object make it a high precision time object
      if cache_key.is_a? Time
        cache_key = cache_key.iso8601(4)
      end
      [type, id, cache_key, serializer_config_key, context_key]
    end

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the default cache-key builder and the handling of Rails updated_at values. Reproduce two record mutations less than a second apart, then verify that the resulting cache keys preserve sub-second precision and that the regression is covered by a test.

Written by the indexing model from the issue text.

Assessment

Tech stack
rails, ruby
Domain
backend
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.