Skip to content
This repository was archived by the owner on Mar 13, 2025. It is now read-only.

Commit 8915db5

Browse files
committed
Bump versions to 2.5.0, update CHANGELOG.md and docs
1 parent eb9778d commit 8915db5

File tree

27 files changed

+388
-300
lines changed

27 files changed

+388
-300
lines changed

docs/CHANGELOG.md

Lines changed: 84 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,89 @@
11
# 🚧 Changelog
22

3+
## 2.5.0
4+
5+
### Features
6+
7+
- ⏰ Add support for
8+
[**Durable Object alarms**](https://developers.cloudflare.com/workers/learning/using-durable-objects/#alarms-in-durable-objects).
9+
Thanks [@CraigglesO](https://github.com/CraigglesO) for [the PR](#257).
10+
- Add support for `URLPattern`. Closes
11+
[issue #199](https://github.com/cloudflare/miniflare/issues/199), thanks
12+
[@Electroid](https://github.com/Electroid) and
13+
[@tom-sherman](https://github.com/tom-sherman) for
14+
[the PR](https://github.com/cloudflare/miniflare/pull/260).
15+
- Add support for the
16+
[`Response.json()`](https://community.cloudflare.com/t/2022-5-26-workers-runtime-release-notes/386584)
17+
static method. Closes
18+
[issue #272](https://github.com/cloudflare/miniflare/issues/272), thanks
19+
[@Cherry](https://github.com/Cherry).
20+
- Add support for the
21+
[`startAfter`](https://developers.cloudflare.com/workers/runtime-apis/durable-objects#methods)
22+
Durable Object `list()` option. Closes
23+
[issue #266](https://github.com/cloudflare/miniflare/issues/266), thanks
24+
[@vlovich](https://github.com/vlovich).
25+
- Add support for Jest 28 and custom
26+
[export conditions](https://nodejs.org/api/packages.html#conditional-exports).
27+
By default, the Miniflare Jest environment will use the `worker` condition,
28+
followed by `browser`. Closes issues
29+
[#249](https://github.com/cloudflare/miniflare/issues/249) and
30+
[#255](https://github.com/cloudflare/miniflare/issues/255), thanks
31+
[@awwong1](https://github.com/awwong1) and
32+
[@SupremeTechnopriest](https://github.com/SupremeTechnopriest).
33+
34+
### Fixes
35+
36+
- Fixed issue where `403 Forbidden` responses were returned when a site behind
37+
Cloudflare was set as the upstream. Closes
38+
[issue #237](https://github.com/cloudflare/miniflare/issues/237), thanks
39+
[@james-maher](https://github.com/james-maher) for
40+
[the PR](https://github.com/cloudflare/miniflare/pull/238).
41+
- Respect `env_path` option in `wrangler.toml` when using mounts or the
42+
Miniflare Jest environment. Closes
43+
[issue #240](https://github.com/cloudflare/miniflare/issues/240), thanks
44+
[@bkniffler](https://github.com/bkniffler).
45+
- Fix cases where BYOB readers didn't notice the end of the stream. Closes
46+
[issue #192](https://github.com/cloudflare/miniflare/issues/192), thanks
47+
[@vlovich](https://github.com/vlovich) for
48+
[the PR](https://github.com/cloudflare/miniflare/pull/194).
49+
- Wait for unawaited writes within a Durable Object transaction before
50+
attempting to commit. Closes
51+
[issue #250](https://github.com/cloudflare/miniflare/issues/250), thanks
52+
[@vlovich](https://github.com/vlovich).
53+
- Correctly bind `this` in `crypto` and `crypto.subtle`. Closes
54+
[issue #256](https://github.com/cloudflare/miniflare/issues/256), thanks
55+
[@lmcarreiro](https://github.com/lmcarreiro) and
56+
[@awwong1](https://github.com/awwong1) for
57+
[the PR](https://github.com/cloudflare/miniflare/pull/259/).
58+
- Bump `busboy` to resolve a
59+
[security issue](https://github.com/advisories/GHSA-wm7h-9275-46v2). Closes
60+
[issue #267](https://github.com/cloudflare/miniflare/issues/267), thanks
61+
[@grempe](https://github.com/grempe) and [@Cherry](https://github.com/Cherry)
62+
for [the PR](https://github.com/cloudflare/miniflare/pull/269/).
63+
- Set incoming `Accept-Encoding` headers to `gzip` and put actual client
64+
encodings in `request.cf.clientAcceptEncoding` to match the behaviour of the
65+
Workers runtime. Closes
66+
[issue #180](https://github.com/cloudflare/miniflare/issues/180), thanks
67+
[@evanderkoogh](https://github.com/evanderkoogh) and
68+
[@leader22](https://github.com/leader22) for
69+
[the PR](https://github.com/cloudflare/miniflare/pull/213/).
70+
- [Remove restriction](https://community.cloudflare.com/t/2022-2-25-workers-runtime-release-notes/360450)
71+
on supported `TextDecoder` encodings. Closes
72+
[issue #212](https://github.com/cloudflare/miniflare/issues/212).
73+
- Make `headers` on returned `fetch` `Response`s immutable. Closes
74+
[issue #242](https://github.com/cloudflare/miniflare/issues/242), thanks
75+
[@nickreese](https://github.com/nickreese)
76+
- Use lexicographic ordering for KV/Durable Object `list()`s. Closes
77+
[issue #235](https://github.com/cloudflare/miniflare/issues/235), thanks
78+
[@vlovich](https://github.com/vlovich).
79+
- Re-export `Request`, `RequestInfo`, `RequestInit` and `Response` from
80+
`miniflare`. Closes
81+
[issue #258](https://github.com/cloudflare/miniflare/issues/258), thanks
82+
[@ajwootto](https://github.com/ajwootto).
83+
- Add `jest-environment-miniflare`'s missing `dependencies`. Thanks
84+
[@BasixKOR](https://github.com/BasixKOR) for
85+
[the PR](https://github.com/cloudflare/miniflare/pull/195).
86+
387
## 2.4.0
488

589
### Features

docs/src/content/core/standards.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ Miniflare supports the following Web Standards in its sandbox:
2525
- **Encoding:** `TextEncoder`, `TextDecoder`
2626
- **Fetch:** `fetch`, `Headers` (including
2727
[non-standard `getAll` method](https://developers.cloudflare.com/workers/runtime-apis/headers#differences)),
28-
`Request`, `Response`, `FormData`, `Blob`, `File`, `URL`, `URLSearchParams`
29-
(powered by [`undici`](https://github.com/nodejs/undici/))
28+
`Request`, `Response`, `FormData`, `Blob`, `File`, `URL`, `URLPattern`,
29+
`URLSearchParams` (powered by [`undici`](https://github.com/nodejs/undici/))
3030
- **Streams:** `ByteLengthQueuingStrategy`, `CountQueuingStrategy`,
3131
`ReadableByteStreamController`, `ReadableStream`, `ReadableStreamBYOBReader`
3232
(including non-standard `readAtLeast` method), `ReadableStreamBYOBRequest`,

docs/src/content/get-started/api.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -453,6 +453,7 @@ const mf = new Miniflare({
453453
API_OBJECT: { className: "ApiObject", scriptName: "api" },
454454
},
455455
durableObjectsPersist: "./durable-objects-data", // Persist Durable Object data (to optional path)
456+
durableObjectsAlarms: false, // Enable default/named Durable Object alarms (enabled by default)
456457

457458
cache: false, // Enable default/named caches (enabled by default)
458459
cachePersist: "./cache-data", // Persist cached data (to optional path)

docs/src/content/get-started/cli.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -279,8 +279,8 @@ Durable Objects Options:
279279
-o, --do Durable Object to bind [array:NAME=CLASS[@MOUNT]]
280280
--do-persist Persist Durable Object data (to [boolean/string]
281281
optional path)
282-
--(no-)do-alarms Enable Durable Object alarms (enabled [boolean]
283-
by default)
282+
--(no-)do-alarms Enable Durable Object alarms (enabled by [boolean]
283+
default)
284284
285285
Cache Options:
286286
--(no-)cache Enable default/named caches (enabled by [boolean]
@@ -369,6 +369,7 @@ kv_persist = true # --kv-persist
369369
cache_persist = "./cache" # --cache-persist
370370
cache = false # --no-cache
371371
durable_objects_persist = true # --do-persist
372+
durable_objects_alarms = false # --no-do-alarms
372373
update_check = false # --no-update-check
373374
cf_fetch = "./cf.json" # --cf-fetch ./cf.json
374375
cf_fetch = false # --no-cf-fetch

docs/src/content/storage/durable-objects.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,7 @@ Like the real Workers runtime, Miniflare will throw errors when:
124124
- Attempting to modify more than `128` keys in a transaction
125125
- Attempting to `put` an `undefined` value
126126
- Attempting to list keys with a negative `limit`
127+
- Attempting to list keys with both `start` and `startAfter` set
127128
- Attempting to perform an operation in a rolledback transaction or in a
128129
transaction that has already committed
129130
- Attempting to call `deleteAll()` in a transaction

0 commit comments

Comments
 (0)