Skip to content

Commit 5037f57

Browse files
vicbvicb
authored
refactor: update naming and layout (#499)
1 parent 958f322 commit 5037f57

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+213
-215
lines changed

‎.changeset/cyan-donuts-perform.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
---
2+
"@opennextjs/cloudflare": minor
3+
---
4+
5+
Refactor the codebase for consistency
6+
7+
BREAKING CHANGE
8+
9+
Overrides:
10+
11+
Overrides now live in `@opennextjs/cloudflare/overrides` and some files have been renamed.
12+
13+
- Incremental cache overrides: `@opennextjs/cloudflare/overrides/incremental-cache/...`
14+
- Tag cache overrides: `@opennextjs/cloudflare/overrides/tag-cache/...`
15+
- Queue overrides: `@opennextjs/cloudflare/overrides/queue/...`
16+
17+
For example the KV incremental cache override can be imported as `@opennextjs/cloudflare/overrides/incremental-cache/kv-incremental-cache`.
18+
19+
Environment variables and bindings name changes:
20+
21+
- `NEXT_CACHE_WORKERS_KV` -> `NEXT_INC_CACHE_KV`
22+
- `NEXT_CACHE_R2_...` -> `NEXT_INC_CACHE_R2_...`
23+
- `NEXT_CACHE_D1` -> `NEXT_TAG_CACHE_D1`
24+
- `NEXT_CACHE_DO_...` -> `NEXT_TAG_CACHE_DO_...`
25+
- `NEXT_CACHE_DO_REVALIDATION` -> `NEXT_CACHE_DO_QUEUE`
26+
- `NEXT_CACHE_REVALIDATION_WORKER` -> `WORKER_SELF_REFERENCE`
27+
28+
Other:
29+
30+
`NEXT_CACHE_D1_TAGS_TABLE` and `NEXT_CACHE_D1_REVALIDATIONS_TABLE` have been dropped.
31+
The tables have a fixed names `tags` and `revalidations`.

‎examples/e2e/app-pages-router/open-next.config.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { defineCloudflareConfig } from "@opennextjs/cloudflare";
2-
import kvIncrementalCache from "@opennextjs/cloudflare/kv-cache";
3-
import memoryQueue from "@opennextjs/cloudflare/memory-queue";
2+
import kvIncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/kv-incremental-cache";
3+
import memoryQueue from "@opennextjs/cloudflare/overrides/queue/memory-queue";
44

55
export default defineCloudflareConfig({
66
incrementalCache: kvIncrementalCache,

‎examples/e2e/app-pages-router/wrangler.jsonc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010
},
1111
"kv_namespaces": [
1212
{
13-
"binding": "NEXT_CACHE_WORKERS_KV",
13+
"binding": "NEXT_INC_CACHE_KV",
1414
"id": "<BINDING_ID>"
1515
}
1616
],
1717
"services": [
1818
{
19-
"binding": "NEXT_CACHE_REVALIDATION_WORKER",
19+
"binding": "WORKER_SELF_REFERENCE",
2020
"service": "app-pages-router"
2121
}
2222
]

‎examples/e2e/app-router/open-next.config.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
import { defineCloudflareConfig } from "@opennextjs/cloudflare";
2-
import kvIncrementalCache from "@opennextjs/cloudflare/kv-cache";
3-
import shardedTagCache from "@opennextjs/cloudflare/do-sharded-tag-cache";
4-
import doQueue from "@opennextjs/cloudflare/durable-queue";
2+
import kvIncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/kv-incremental-cache";
3+
import shardedTagCache from "@opennextjs/cloudflare/overrides/tag-cache/do-sharded-tag-cache";
4+
import doQueue from "@opennextjs/cloudflare/overrides/queue/do-queue";
55

66
export default defineCloudflareConfig({
77
incrementalCache: kvIncrementalCache,
88
// With such a configuration, we could have up to 12 * (8 + 2) = 120 Durable Objects instances
99
tagCache: shardedTagCache({
10-
numberOfShards: 12,
10+
baseShardSize: 12,
1111
enableShardReplication: true,
1212
shardReplicationOptions: {
1313
numberOfSoftReplicas: 8,

‎examples/e2e/app-router/wrangler.jsonc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,11 @@
1111
"durable_objects": {
1212
"bindings": [
1313
{
14-
"name": "NEXT_CACHE_REVALIDATION_DURABLE_OBJECT",
14+
"name": "NEXT_CACHE_DO_QUEUE",
1515
"class_name": "DurableObjectQueueHandler"
1616
},
1717
{
18-
"name": "NEXT_CACHE_DO_SHARDED",
18+
"name": "NEXT_TAG_CACHE_DO_SHARDED",
1919
"class_name": "DOShardedTagCache"
2020
}
2121
]
@@ -28,13 +28,13 @@
2828
],
2929
"kv_namespaces": [
3030
{
31-
"binding": "NEXT_CACHE_WORKERS_KV",
31+
"binding": "NEXT_INC_CACHE_KV",
3232
"id": "<BINDING_ID>"
3333
}
3434
],
3535
"services": [
3636
{
37-
"binding": "NEXT_CACHE_REVALIDATION_WORKER",
37+
"binding": "WORKER_SELF_REFERENCE",
3838
"service": "app-router"
3939
}
4040
]

‎examples/e2e/pages-router/open-next.config.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { defineCloudflareConfig } from "@opennextjs/cloudflare";
2-
import kvIncrementalCache from "@opennextjs/cloudflare/kv-cache";
3-
import memoryQueue from "@opennextjs/cloudflare/memory-queue";
2+
import kvIncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/kv-incremental-cache";
3+
import memoryQueue from "@opennextjs/cloudflare/overrides/queue/memory-queue";
44

55
export default defineCloudflareConfig({
66
incrementalCache: kvIncrementalCache,

‎examples/e2e/pages-router/wrangler.jsonc‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,13 @@
1010
},
1111
"kv_namespaces": [
1212
{
13-
"binding": "NEXT_CACHE_WORKERS_KV",
13+
"binding": "NEXT_INC_CACHE_KV",
1414
"id": "<BINDING_ID>"
1515
}
1616
],
1717
"services": [
1818
{
19-
"binding": "NEXT_CACHE_REVALIDATION_WORKER",
19+
"binding": "WORKER_SELF_REFERENCE",
2020
"service": "pages-router"
2121
}
2222
]

‎examples/overrides/d1-tag-next/open-next.config.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { defineCloudflareConfig } from "@opennextjs/cloudflare";
2-
import kvIncrementalCache from "@opennextjs/cloudflare/kv-cache";
3-
import d1NextTagCache from "@opennextjs/cloudflare/d1-next-tag-cache";
2+
import kvIncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/kv-incremental-cache";
3+
import d1NextTagCache from "@opennextjs/cloudflare/overrides/tag-cache/d1-next-tag-cache";
44

55
export default defineCloudflareConfig({
66
incrementalCache: kvIncrementalCache,

‎examples/overrides/d1-tag-next/wrangler.jsonc‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,15 @@
1313
},
1414
"kv_namespaces": [
1515
{
16-
"binding": "NEXT_CACHE_WORKERS_KV",
16+
"binding": "NEXT_INC_CACHE_KV",
1717
"id": "<BINDING_ID>"
1818
}
1919
],
2020
"d1_databases": [
2121
{
22-
"binding": "NEXT_CACHE_D1",
23-
"database_id": "NEXT_CACHE_D1",
24-
"database_name": "NEXT_CACHE_D1"
22+
"binding": "NEXT_TAG_CACHE_D1",
23+
"database_id": "NEXT_TAG_CACHE_D1",
24+
"database_name": "NEXT_TAG_CACHE_D1"
2525
}
2626
]
2727
}

‎examples/overrides/memory-queue/open-next.config.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { defineCloudflareConfig } from "@opennextjs/cloudflare";
2-
import kvIncrementalCache from "@opennextjs/cloudflare/kv-cache";
3-
import memoryQueue from "@opennextjs/cloudflare/memory-queue";
2+
import kvIncrementalCache from "@opennextjs/cloudflare/overrides/incremental-cache/kv-incremental-cache";
3+
import memoryQueue from "@opennextjs/cloudflare/overrides/queue/memory-queue";
44

55
export default defineCloudflareConfig({
66
incrementalCache: kvIncrementalCache,

0 commit comments

Comments
 (0)