chore: enable/specify http snippets with docs.yml setting #4024
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![seer-by-sentry[bot]](https://avatars.githubusercontent.com/in/801464?s=60&v=4){kind=small}
| const flags = await flagsPromise; | ||
| const settings = await getSettings(cacheConfig)(domainKey); | ||
| return await backfillSnippets({ | ||
| apiDefinition: cached, | ||
| dynamicIr, | ||
| httpSnippets: settings.httpSnippets ?? flags.isHttpSnippetsEnabled, | ||
| alwaysEnableJavaScriptFetch: flags.alwaysEnableJavaScriptFetch | ||
| }); | ||
| } | ||
| } | ||
| } catch (error) { |
There was a problem hiding this comment.
Potential bug: The revalidation route does not call backfillSnippets, unlike the fresh API load path, causing inconsistent HTTP snippet generation depending on cache state.
-
Description: The
createGetPrunedApiCachedfunction was updated to callbackfillSnippetsto enrich API definitions with HTTP snippets. However, the corresponding revalidation route was not updated and does not callbackfillSnippets. This creates a data inconsistency where API documentation will have HTTP snippets on a fresh load but will be missing them when served from a revalidated cache. This leads to an inconsistent user experience where snippets appear or disappear depending on the cache state, violating an explicit repository guideline to keep these two code paths in sync. -
Suggested fix: Update the revalidation route to also call
backfillSnippetswhen creating the pruned API definition. This will ensure that both the fresh load path and the revalidation path apply the same snippet enrichment logic, maintaining data consistency across cache states.
severity: 0.75, confidence: 0.95
Did we get this right? 👍 / 👎 to inform future reviews.
|
|
1 participant
we will be deprecating the edge config flag in favor of the docs setting soon