search

vercel / next.js

The React Framework
https://nextjs.org
MIT License
125.24k stars 26.77k forks source link

Using `revalidateTag()` inside dynamic route handler is unstable #69063

Closed younes101020 closed 1 month ago

younes101020 commented 1 month ago

Link to the code that reproduces this issue

github.com/younes101020/electra-v2

To Reproduce

  1. Clone the repository

    youyou@youyou:~/electra$ git clone git@github.com:younes101020/Electra-v2.git

  2. create .env.development file in root directory and past .env.example into it and for TMDB_API_KEY + TMDB_ACCESS_TOKEN env you can retrieve them from https://www.themoviedb.org/settings/api

  3. Install dependencies and start dev environment (you need docker compose)

    youyou@youyou:~/electra$ yarn
youyou@youyou:~/electra$ yarn dev

  4. go to /src/app/api/movie/[sessionid]/[accountid]/[movieid]/rating/route.ts file and replace:

    // Replace this (this code is the only way I've found to fix the initial issue)
await new Promise((resolve) => {
  setTimeout(() => {
    resolve(revalidateTag(`rated:${params.accountid}`));
  }, 3000);
});
// By this
revalidateTag(`rated:${params.accountid}`)

Current vs. Expected behavior

I expect the cache initiated by the unstable_cache() method to be revalidated each time a movie's score is assigned.

the issue is that on-demand cache revalidation is unstable, i.e. sometimes the cache isn't revalidated while the route that executes revalidateTag() is called. I have the impression that the route handler returns a response even before letting revalidateTag() finish the job properly, so I've temporarily wrapped this function in a promise with a fairly long delay.

I think it would be good to return a promise to revalidateTag() instead of nothing once the cache has been revalidated or to run this function in a worker, it wouldn't bother me personally, I would only have to manage the UI with useOptimistic

Provide environment information

Operating System:
  Platform: linux
  Arch: x64
  Version: #1 SMP Thu Oct 5 21:02:42 UTC 2023
  Available memory (MB): 7908
  Available CPU cores: 12
Binaries:
  Node: 21.6.0
  npm: 10.8.1
  Yarn: 1.22.21
  pnpm: 9.1.2
Relevant Packages:
  next: 14.2.3 // There is a newer version (14.2.5) available, upgrade recommended! 
  eslint-config-next: 14.2.3
  react: 18.3.1
  react-dom: 18.3.1
  typescript: 5.4.5
Next.js Config:
  output: standalone

Which area(s) are affected? (Select all that apply)

Runtime

Which stage(s) are affected? (Select all that apply)

next dev (local), next build (local), next start (local)

Additional context

No response

github-actions[bot] commented 1 month ago

We could not detect a valid reproduction link. Make sure to follow the bug report template carefully.

Why was this issue closed?

To be able to investigate, we need access to a reproduction to identify what triggered the issue. We need a link to a public GitHub repository (template for App Router, template for Pages Router), but you can also use these templates: CodeSandbox: App Router or CodeSandbox: Pages Router.

The bug template that you filled out has a section called "Link to the code that reproduces this issue", which is where you should provide the link to the reproduction.

What should I do?

Depending on the reason the issue was closed, you can do the following:

In general, assume that we should not go through a lengthy onboarding process at your company code only to be able to verify an issue.

My repository is private and cannot make it public

In most cases, a private repo will not be a sufficient minimal reproduction, as this codebase might contain a lot of unrelated parts that would make our investigation take longer. Please do not make it public. Instead, create a new repository using the templates above, adding the relevant code to reproduce the issue. Common things to look out for:

I did not open this issue, but it is relevant to me, what can I do to help?

Anyone experiencing the same issue is welcome to provide a minimal reproduction following the above steps by opening a new issue.

I think my reproduction is good enough, why aren't you looking into it quickly?

We look into every Next.js issue and constantly monitor open issues for new comments.

However, sometimes we might miss one or two due to the popularity/high traffic of the repository. We apologize, and kindly ask you to refrain from tagging core maintainers, as that will usually not result in increased priority.

Upvoting issues to show your interest will help us prioritize and address them as quickly as possible. That said, every issue is important to us, and if an issue gets closed by accident, we encourage you to open a new one linking to the old issue and we will look into it.

Useful Resources