Skip to content

Commit dcb5dca

Browse files
authored
add warning for Service Worker examples (#22100)
1 parent f519040 commit dcb5dca

File tree

9 files changed

+102
-1
lines changed

9 files changed

+102
-1
lines changed

src/content/docs/learning-paths/mtls/mtls-workers/index.mdx

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ sidebar:
55
order: 4
66
---
77

8+
import { Tabs, TabItem } from "~/components";
9+
810
:::note
911
Cloudflare Workers runs after the Cloudflare WAF and Cloudflare Access. Review the [Traffic Sequence](https://blog.cloudflare.com/traffic-sequence-which-product-runs-first/) visible on the Cloudflare dashboard.
1012
:::
@@ -17,6 +19,42 @@ All Client Certificate details can be found in the [tlsClientAuth](/workers/runt
1719

1820
Example Cloudflare Workers code to return all headers and gain visibility, including [Client Certificate headers](/ssl/client-certificates/enable-mtls/#cloudflare-workers):
1921

22+
<Tabs> <TabItem label="Module Worker" icon="seti:javascript">
23+
```js
24+
export default {
25+
async fetch(request, env, ctx) {
26+
const { tlsClientAuth = {} } = request.cf || {};
27+
const tlsHeaders = {
28+
'X-CERT-ISSUER-DN': tlsClientAuth.certIssuerDN,
29+
'X-CERT-SUBJECT-DN': tlsClientAuth.certSubjectDN,
30+
'X-CERT-ISSUER-DN-L': tlsClientAuth.certIssuerDNLegacy,
31+
'X-CERT-SUBJECT-DN-L': tlsClientAuth.certSubjectDNLegacy,
32+
'X-CERT-SERIAL': tlsClientAuth.certSerial,
33+
'X-CERT-FINGER': tlsClientAuth.certFingerprintSHA1,
34+
'X-CERT-VERIFY': tlsClientAuth.certVerify,
35+
'X-CERT-NOTBE': tlsClientAuth.certNotBefore,
36+
'X-CERT-NOTAF': tlsClientAuth.certNotAfter
37+
};
38+
39+
const headers = Object.fromEntries(request.headers);
40+
return new Response(JSON.stringify({ ...headers, ...tlsHeaders }, null, 2), {
41+
headers: { 'Content-Type': 'application/json' }
42+
});
43+
44+
}
45+
}
46+
47+
````
48+
49+
</TabItem>
50+
<TabItem label="Service Worker" icon="seti:javascript">
51+
52+
:::caution[Service Workers are deprecated]
53+
54+
Service Workers are deprecated, but still supported. We recommend using [Module Workers](/workers/reference/migrate-to-module-workers/) instead. New features may not be supported for Service Workers.
55+
56+
:::
57+
2058
```js
2159
addEventListener('fetch', event => {
2260
event.respondWith(
@@ -41,7 +79,10 @@ addEventListener('fetch', event => {
4179
})(event.request)
4280
);
4381
});
44-
```
82+
````
83+
84+
</TabItem>
85+
</Tabs>
4586
4687
The response when using the browser with a P12 Certificate to visit the mTLS hostname would look similar to this example:
4788

src/content/docs/workers/configuration/sites/start-from-existing.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,12 @@ export default {
9595

9696
</TabItem> <TabItem label="Service Worker" icon="seti:javascript">
9797

98+
:::caution[Service Workers are deprecated]
99+
100+
Service Workers are deprecated, but still supported. We recommend using [Module Workers](/workers/reference/migrate-to-module-workers/) instead. New features may not be supported for Service Workers.
101+
102+
:::
103+
98104
```js
99105
import { getAssetFromKV } from "@cloudflare/kv-asset-handler";
100106

src/content/docs/workers/examples/cache-using-fetch.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -435,6 +435,12 @@ export default {
435435
436436
</TabItem> <TabItem label="Service Worker" icon="seti:javascript">
437437
438+
:::caution[Service Workers are deprecated]
439+
440+
Service Workers are deprecated, but still supported. We recommend using [Module Workers](/workers/reference/migrate-to-module-workers/) instead. New features may not be supported for Service Workers.
441+
442+
:::
443+
438444
```js title="index.js"
439445
addEventListener("fetch", (event) => {
440446
return event.respondWith(handleRequest(event.request));

src/content/docs/workers/observability/errors.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,12 @@ export default {
301301

302302
</TabItem> <TabItem label="Service Worker" icon="seti:javascript">
303303

304+
:::caution[Service Workers are deprecated]
305+
306+
Service Workers are deprecated, but still supported. We recommend using [Module Workers](/workers/reference/migrate-to-module-workers/) instead. New features may not be supported for Service Workers.
307+
308+
:::
309+
304310
```js
305311
addEventListener("fetch", (event) => {
306312
event.respondWith(handleEvent(event));
@@ -342,6 +348,12 @@ export default {
342348

343349
</TabItem> <TabItem label="Service Worker" icon="seti:javascript">
344350

351+
:::caution[Service Workers are deprecated]
352+
353+
Service Workers are deprecated, but still supported. We recommend using [Module Workers](/workers/reference/migrate-to-module-workers/) instead. New features may not be supported for Service Workers.
354+
355+
:::
356+
345357
```js
346358
addEventListener("fetch", (event) => {
347359
event.passThroughOnException();

src/content/docs/workers/observability/logs/workers-logs.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,12 @@ export default {
139139

140140
</TabItem> <TabItem label="Service Worker" icon="seti:javascript">
141141

142+
:::caution[Service Workers are deprecated]
143+
144+
Service Workers are deprecated, but still supported. We recommend using [Module Workers](/workers/reference/migrate-to-module-workers/) instead. New features may not be supported for Service Workers.
145+
146+
:::
147+
142148
```js
143149
addEventListener("fetch", (event) => {
144150
event.respondWith(handleRequest(event.request));

src/content/docs/workers/reference/migrate-to-module-workers.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,12 @@ There are several reasons to migrate your Workers to the ES modules format:
2424

2525
The following example demonstrates a Worker that redirects all incoming requests to a URL with a `301` status code.
2626

27+
:::caution[Service Workers are deprecated]
28+
29+
Service Workers are deprecated, but still supported. We recommend using [Module Workers](/workers/reference/migrate-to-module-workers/) instead. New features may not be supported for Service Workers.
30+
31+
:::
32+
2733
With the Service Worker syntax, the example Worker looks like:
2834

2935
```js

src/content/docs/workers/runtime-apis/fetch.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,12 @@ export default {
4040

4141
</TabItem> <TabItem label="Service Worker" icon="seti:javascript">
4242

43+
:::caution[Service Workers are deprecated]
44+
45+
Service Workers are deprecated, but still supported. We recommend using [Module Workers](/workers/reference/migrate-to-module-workers/) instead. New features may not be supported for Service Workers.
46+
47+
:::
48+
4349
```js null {8}
4450
addEventListener("fetch", (event) => {
4551
// NOTE: can’t use fetch here, as we’re not in an async scope yet

src/content/docs/workers/runtime-apis/streams/index.mdx

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,12 @@ export default {
4646

4747
</TabItem> <TabItem label="Service Worker" icon="seti:javascript">
4848

49+
:::caution[Service Workers are deprecated]
50+
51+
Service Workers are deprecated, but still supported. We recommend using [Module Workers](/workers/reference/migrate-to-module-workers/) instead. New features may not be supported for Service Workers.
52+
53+
:::
54+
4955
```js
5056
addEventListener("fetch", (event) => {
5157
event.respondWith(fetchAndStream(event.request));
@@ -89,6 +95,12 @@ export default {
8995

9096
</TabItem> <TabItem label="Service Worker" icon="seti:javascript">
9197

98+
:::caution[Service Workers are deprecated]
99+
100+
Service Workers are deprecated, but still supported. We recommend using [Module Workers](/workers/reference/migrate-to-module-workers/) instead. New features may not be supported for Service Workers.
101+
102+
:::
103+
92104
```js
93105
addEventListener("fetch", (event) => {
94106
event.respondWith(fetchAndStream(event.request));

src/content/docs/workers/wrangler/migration/v1-to-v2/wrangler-legacy/configuration.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -484,6 +484,12 @@ A custom build command for your project. There are two configurations based on t
484484

485485
#### Service Workers
486486

487+
:::caution[Service Workers are deprecated]
488+
489+
Service Workers are deprecated, but still supported. We recommend using [Module Workers](/workers/reference/migrate-to-module-workers/) instead. New features may not be supported for Service Workers.
490+
491+
:::
492+
487493
This section is for customizing Workers with the `service-worker` format. These Workers use `addEventListener` and look like the following:
488494

489495
```js

0 commit comments

Comments
 (0)