Skip to content

feat: document process for setting up service bindings between workers #35

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

Open
isakgustavsen wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat: document process for setting up service bindings between workers #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 32 additions & 5 deletions apps/user-application/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,33 @@ npm run dev

This will start the local development server at http://localhost:3000.

### Developing with the data-service Worker

By default the workers will be run in separate sandboxes

If you would like to use a service binding to call functions directly you need to add the worker as an auxiliary Worker entry as shown below

To enable that workflow, update `vite.config.ts` by replacing:

```typescript
cloudflare(),
```

with:

```typescript
cloudflare({
auxiliaryWorkers: [
{
configPath: "../data-service/wrangler.jsonc",
},
],
}),
```

This only controls local development startup. Add or update the actual service
binding in `wrangler.jsonc` separately, then regenerate Worker types.

## Cloudflare Worker Configuration

### Service Bindings and TypeScript
Expand All @@ -44,7 +71,7 @@ This template includes type definitions for Cloudflare Worker bindings. When add
1. Generate TypeScript types for your bindings:

```bash
npm run cf-typegen
pnpm --filter user-application run cf-typegen
```

This will create or update typings for your Cloudflare Worker environment.
Expand Down Expand Up @@ -93,21 +120,21 @@ To deploy your application to Cloudflare Workers:
1. Build the application:

```bash
npm run build
pnpm --filter user-application run build
```

2. Deploy to Cloudflare:

```bash
npm run deploy
pnpm --filter user-application run deploy
```


This will deploy your application to your Cloudflare Workers account. Make sure you have configured Wrangler with your Cloudflare account credentials.

### Configuration

You can customize your Cloudflare Worker deployment by editing the `wrangler.toml` file. Key configurations include:
You can customize your Cloudflare Worker deployment by editing the `wrangler.jsonc` file. Key configurations include:

- `name`: The name of your worker
- `compatibility_date`: The Cloudflare Workers compatibility date
Expand All @@ -130,7 +157,7 @@ You can customize your Cloudflare Worker deployment by editing the `wrangler.tom
│ └── routers/ # Individual tRPC route handlers
│
├── public/ # Static assets
└── wrangler.toml # Cloudflare Worker configuration
└── wrangler.jsonc # Cloudflare Worker configuration
```

## Additional Resources
Expand Down
13 changes: 12 additions & 1 deletion apps/user-application/vite.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,18 @@ export default defineConfig({
tanstackRouter({ autoCodeSplitting: true }),
viteReact(),
tailwindcss(),
cloudflare(),
cloudflare(
// When developing code that calls data-service through a Wrangler service
// binding, replace the cloudflare() call above with this so Vite starts the
// bound worker alongside user-application:
//{
// auxiliaryWorkers: [
// {
// configPath: "../data-service/wrangler.jsonc",
// },
// ],
// }
),
],
server: {
watch: {
Expand Down