Skip to content

feat: use getPlatformProxy for cache population prefix vars #622

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
May 2, 2025
Merged

feat: use getPlatformProxy for cache population prefix vars #622

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a7423be
feat: use `getPlatformProxy` for cache population prefix vars
james-elicx Apr 30, 2025
8763cdd
add the var to e2es
james-elicx May 1, 2025
e05014c
Apply suggestions from code review
james-elicx May 2, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/thirty-camels-reflect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@opennextjs/cloudflare": patch
---

feat: use `getPlatformProxy` for cache population prefix vars
5 changes: 4 additions & 1 deletion examples/e2e/app-pages-router/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,5 +19,8 @@
"binding": "WORKER_SELF_REFERENCE",
"service": "app-pages-router"
}
]
],
"vars": {
"NEXT_INC_CACHE_R2_PREFIX": "custom_prefix"
}
}
3 changes: 2 additions & 1 deletion examples/playground14/wrangler.jsonc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
],
"vars": {
"hello": "Hello World from the cloudflare context!",
"PROCESS_ENV_VAR": "process.env"
"PROCESS_ENV_VAR": "process.env",
"NEXT_INC_CACHE_KV_PREFIX": "custom_prefix"
}
}
16 changes: 9 additions & 7 deletions packages/cloudflare/src/cli/commands/populate-cache.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ import type {
import type { IncrementalCache, TagCache } from "@opennextjs/aws/types/overrides.js";
import { globSync } from "glob";
import { tqdm } from "ts-tqdm";
import { unstable_readConfig } from "wrangler";
import { getPlatformProxy, unstable_readConfig } from "wrangler";

import {
BINDING_NAME as KV_CACHE_BINDING_NAME,
Expand Down Expand Up @@ -92,13 +92,14 @@ export function getCacheAssets(opts: BuildOptions): CacheAsset[] {
return assets;
}

function populateR2IncrementalCache(
async function populateR2IncrementalCache(
options: BuildOptions,
populateCacheOptions: { target: WranglerTarget; environment?: string }
) {
logger.info("\nPopulating R2 incremental cache...");

const config = unstable_readConfig({ env: populateCacheOptions.environment });
const proxy = await getPlatformProxy<Record<string, string | undefined>>(populateCacheOptions);

const binding = config.r2_buckets.find(({ binding }) => binding === R2_CACHE_BINDING_NAME);
if (!binding) {
Expand All @@ -114,7 +115,7 @@ function populateR2IncrementalCache(

for (const { fullPath, key, buildId, isFetch } of tqdm(assets)) {
const cacheKey = computeCacheKey(key, {
prefix: process.env[R2_CACHE_PREFIX_ENV_NAME],
prefix: proxy.env[R2_CACHE_PREFIX_ENV_NAME],
buildId,
cacheType: isFetch ? "fetch" : "cache",
});
Expand All @@ -130,13 +131,14 @@ function populateR2IncrementalCache(
logger.info(`Successfully populated cache with ${assets.length} assets`);
}

function populateKVIncrementalCache(
async function populateKVIncrementalCache(
options: BuildOptions,
populateCacheOptions: { target: WranglerTarget; environment?: string }
) {
logger.info("\nPopulating KV incremental cache...");

const config = unstable_readConfig({ env: populateCacheOptions.environment });
const proxy = await getPlatformProxy<Record<string, string | undefined>>(populateCacheOptions);

const binding = config.kv_namespaces.find(({ binding }) => binding === KV_CACHE_BINDING_NAME);
if (!binding) {
Expand All @@ -147,7 +149,7 @@ function populateKVIncrementalCache(

for (const { fullPath, key, buildId, isFetch } of tqdm(assets)) {
const cacheKey = computeCacheKey(key, {
prefix: process.env[KV_CACHE_PREFIX_ENV_NAME],
prefix: proxy.env[KV_CACHE_PREFIX_ENV_NAME],
buildId,
cacheType: isFetch ? "fetch" : "cache",
});
Expand Down Expand Up @@ -220,10 +222,10 @@ export async function populateCache(
const name = await resolveCacheName(incrementalCache);
switch (name) {
case R2_CACHE_NAME:
populateR2IncrementalCache(options, populateCacheOptions);
await populateR2IncrementalCache(options, populateCacheOptions);
break;
case KV_CACHE_NAME:
populateKVIncrementalCache(options, populateCacheOptions);
await populateKVIncrementalCache(options, populateCacheOptions);
break;
case STATIC_ASSETS_CACHE_NAME:
populateStaticAssetsIncrementalCache(options);
Expand Down