Skip to content

Commit

Permalink
Make Compat Matrix more comprehensive (#17303)
Browse files Browse the repository at this point in the history 
* Make Compat Matrix more comprehensive

Attempts to cover all the differences between Workers and Pages

* Apply suggestions from code review

Co-authored-by: Tanushree <87711021+tanushree-sharma@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Thomas Gauvin <35609369+thomasgauvin@users.noreply.github.com>
Co-authored-by: Denise Peña <75506267+dcpena@users.noreply.github.com>

* Update src/content/docs/workers/static-assets/compatibility-matrix.mdx

Co-authored-by: Denise Peña <75506267+dcpena@users.noreply.github.com>

---------

Co-authored-by: Tanushree <87711021+tanushree-sharma@users.noreply.github.com>
Co-authored-by: Thomas Gauvin <35609369+thomasgauvin@users.noreply.github.com>
Co-authored-by: Denise Peña <75506267+dcpena@users.noreply.github.com>
  • Loading branch information
@irvinebroque @tanushree-sharma
@thomasgauvin @dcpena
4 people authored Oct 18, 2024
1 parent 8c2e3ed commit 91e869f
Showing 1 changed file with 57 additions and 20 deletions.
77 changes: 57 additions & 20 deletions src/content/docs/workers/static-assets/compatibility-matrix.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,29 +17,42 @@ import {
Tabs,
} from "~/components";

Cloudflare [Workers with static assets](/workers/static-assets/) and [Pages](/pages/) both have the ability to host front-end and full-stack applications. The following compatibility matrix shows the features are available for each product to help you when choosing which product to start with.
You can deploy full-stack applications, including front-end static assets and back-end APIs and server-side rendered pages (SSR), to both Cloudflare [Workers](/workers/static-assets/) and [Pages](/pages/). The compatibility matrix below shows which features are available for each, to help you choose whether to build with Workers or Pages. Unless otherwise stated below, what works in Pages works in Workers, and what works in Workers works in Pages. Think something is missing from this list? [Open a pull request](https://github.com/cloudflare/cloudflare-docs/edit/production/src/content/docs/workers/static-assets/compatibility-matrix.mdx) or [create a GitHub issue](https://github.com/cloudflare/cloudflare-docs/issues/new).

We plan to bridge the gaps between Workers and Pages and provide ways to migrate your Pages projects to Workers.

| | Asset hosting on Workers | Pages |

| | Workers | Pages |
| ----------------------------------------------------------------------------------- | ------------------------ | ----- |
| **Features** | | |
| Middleware | ❌ <sup>1</sup> | ✅ |
| [Redirects](/pages/configuration/redirects/) | ❌ <sup>2</sup> | ✅ |
| [Smart Placement](/workers/configuration/smart-placement/) | ⏳ <sup>3</sup> | ✅ |
| **Writing, Testing, and Deploying Code** | | |
| [Rollbacks](/workers/configuration/versions-and-deployments/rollbacks/) | ✅ | ✅ |
| [Gradual Deployments](/workers/configuration/versions-and-deployments/) | ✅ | ❌ |
| [Preview URLs](/workers/configuration/previews) | ✅ | ✅ |
| [Testing tools](/workers/testing) | ✅ | ✅ |
| [Local Development](/workers/testing/local-development/) | ✅ | ✅ |
| [Remote Development (`--remote`)](/workers/wrangler/commands/) | ✅ <sup>1</sup> | ❌ |
| [Quick Editor in Dashboard](https://blog.cloudflare.com/improved-quick-edit) | ✅ | ❌ |
| **Static Assets** | | |
| [Early Hints](/pages/configuration/early-hints/) | ❌ | ✅ |
| [Custom HTTP headers for static assets](/pages/configuration/headers/) | 🟡 <sup>2</sup> | ✅ |
| [Middleware](/pages/functions/middleware/) | 🟡 <sup>3</sup> | ✅ |
| [Redirects](/pages/configuration/redirects/) | 🟡 <sup>4</sup> | ✅ |
| [Smart Placement](/workers/configuration/smart-placement/) | ⏳ <sup>5</sup> | ✅ |
| **Observability** | | |
| [Workers Logs](/workers/observability/) | ✅ | ❌ |
| [Logpush](/workers/observability/logs/logpush/) | ✅ | ❌ |
| [Tail Workers](/workers/observability/logs/tail-workers/) | ⏳ <sup>4</sup> | ❌ |
| [Real-time logs](/workers/observability/logs/real-time-logs/) | ✅ | ✅ |
| **Bindings** | | |
| [Logpush](/workers/observability/logs/logpush/) | ✅ | ❌ |
| [Tail Workers](/workers/observability/logs/tail-workers/) | ⏳ <sup>6</sup> | ❌ |
| [Real-time logs](/workers/observability/logs/real-time-logs/) | ✅ | ✅ |
| **Runtime APIs & Compute Models** | | |
| [Node.js Compatibility Mode](/workers/runtime-apis/nodejs/) | ✅ | ✅ |
| [Durable Objects](/durable-objects/api/) | ✅ | 🟡 <sup>7</sup> |
| [Cron Triggers](/workers/configuration/cron-triggers/) | ✅ | ❌ |
| **Bindings** | | |
| [AI](/workers-ai/get-started/workers-wrangler/#2-connect-your-worker-to-workers-ai) | ✅ | ✅ |
| [Analytics Engine](/analytics/analytics-engine) | ✅ | ✅ |
| [Assets](/workers/static-assets/binding/) | ✅ | ❌ |
| [Browser Rendering](/browser-rendering) | ✅ | ✅ |
| [D1](/d1/build-with-d1/d1-client-api/) | ✅ | ✅ |
| [Durable Objects](/durable-objects/api/) | ✅ | ❌ |
| [Environment Variables](/workers/configuration/environment-variables/) | ✅ | ✅ |
| [Hyperdrive](/hyperdrive/) | ✅ | ❌ |
| [KV](/kv/) | ✅ | ✅ |
Expand All @@ -51,22 +64,46 @@ We plan to bridge the gaps between Workers and Pages and provide ways to migrate
| [Secrets](/workers/configuration/secrets/) | ✅ | ✅ |
| [Service bindings](/workers/runtime-apis/bindings/service-bindings/) | ✅ | ✅ |
| [Vectorize](/vectorize/get-started/intro/#3-bind-your-worker-to-your-index) | ✅ | ✅ |
| **Builds (CI/CD)** | | |
| [Monorepos](/workers/ci-cd/builds/advanced-setups/) | ✅ | ✅ |
| [Build Watch Paths](/pages/configuration/build-watch-paths/) | ❌ | ✅ |
| [Deploy Hooks](/pages/configuration/deploy-hooks/) | ❌ | ✅ |
| [Build Caching](/pages/configuration/build-caching/) | ❌ | ✅ |
| [Custom Preview Branches](/pages/configuration/branch-build-controls/) | ❌ | ✅ |
| [Custom Branch Aliases](/pages/how-to/custom-branch-aliases/) | ❌ | ✅ |
| **Pages Functions** | | |
| [File-based Routing](/pages/functions/routing/) | ❌ <sup>8</sup> | ✅ |
| [Pages Plugins](/pages/functions/plugins/) | ❌ <sup>9</sup> | ✅ |


<sup>1</sup> If you need to run a Worker script ahead of serving static assets,
we currently recommend using [Service
<sup>1</sup> For more details on which bindings are supported in remote development, [refer to the docs](/workers/testing/local-development/#supported-resource-bindings-in-different-environments).

<sup>2</sup> Similar to <sup>1</sup>, to customize the HTTP headers that
are returned by static assets, you can use [Service
bindings](/workers/runtime-apis/bindings/service-bindings/) to connect a Worker
in front of the Worker with assets. We plan to explore additional configuration
in front of the Worker with assets.

<sup>3</sup> If you need to run a Worker before serving static assets,
you can create a separate Worker that acts as middleware, and then use [Service
bindings](/workers/runtime-apis/bindings/service-bindings/) to forward the request
to the Worker with assets. We plan to explore additional configuration
to support more complex routing in the future.

<sup>2</sup> You can handle redirects by adding code to your Worker (a
<sup>4</sup> You can handle redirects by adding code to your Worker (a
[community package](https://npmjs.com/package/redirects-in-workers) is available
for `_redirects` support), or you can use [Bulk
Redirects](/rules/url-forwarding/bulk-redirects/).

<sup>3</sup> You cannot yet enable [Smart
Placement](/workers/configuration/smart-placement/) projects with static assets.
This is a temporary limitation, we are working to remove it.
<sup>5</sup> You cannot yet enable [Smart
Placement](/workers/configuration/smart-placement/) for Workers with static assets.
This is a temporary limitation we are working to remove.

<sup>4</sup> You cannot yet add a [Tail
<sup>6</sup> You cannot yet add a [Tail
Worker](/workers/observability/logs/tail-workers/) to a project with assets.
This is a temporary limitation, we are working to remove it.
This is a temporary limitation we are working to remove.

<sup>7</sup> To [use Durable Objects with your Cloudflare Pages project](/pages/functions/bindings/#durable-objects), you must create a separate Worker with a Durable Object and then declare a binding to it in both your Production and Preview environments. Using Durable Objects with Workers is simpler and recommended.

<sup>8</sup> Workers [supports popular frameworks](/workers/frameworks/), many of which implement file-based routing.

<sup>9</sup> Everything that is possible with Pages Functions can also be achieved by adding code to your Worker or by using framework-specific plugins for relevant third party tools.

0 comments on commit 91e869f

Please sign in to comment.