do you guys use the `satisfies` in your workers?

L

LordSilverOP•5/21/24, 4:01 PM

i see it's present in some parts of the docs and not present in others

L

LordSilverOP•5/21/24, 4:01 PM

in other parts they use the types on the parameters instead

LLordSilver do you guys use the `satisfies` in your workers?

J

James•5/21/24, 6:01 PM

short answer: a combo of both provides the best DX.

export default {
    async fetch(request, env, ctx): Promise<Response> {
        // do things
    },
} satisfies ExportedHandler<Env>;

export default {
    async fetch(request, env, ctx): Promise<Response> {
        // do things
    },
} satisfies ExportedHandler<Env>;

export default {
    async fetch(request, env, ctx): Promise<Response> {
        // do things
    },
} satisfies ExportedHandler<Env>;

export default {
    async fetch(request, env, ctx): Promise<Response> {
        // do things
    },
} satisfies ExportedHandler<Env>;

long answer: https://github.com/cloudflare/cloudflare-docs/pull/14007

JJames short answer: a combo of both provides the best DX. ```ts export default { ...

L

LordSilverOP•5/21/24, 6:11 PM

the one you are using misses stuff

L

LordSilverOP•5/21/24, 6:12 PM

You could use

request: Request

request: Request

request: Request

request: Request,

env: Env

env: Env

env: Env

env: Env

J

James•5/21/24, 6:12 PM

You don't need those with

satisfies ExportedHandler<Env>

satisfies ExportedHandler<Env>

satisfies ExportedHandler<Env>

satisfies ExportedHandler<Env>

the arguments are already typed

L

LordSilverOP•5/21/24, 6:12 PM

in some cases you also have extra stuff like here message batch

L

LordSilverOP•5/21/24, 6:13 PM

also this is not needed?

J

James•5/21/24, 6:13 PM

That could be refactored to use

ExportedHandler

ExportedHandler

ExportedHandler

ExportedHandler

return type annotation too, yes

L

LordSilverOP•5/21/24, 6:13 PM

return type annotation?

L

LordSilverOP•5/21/24, 6:13 PM

promise void u mean?

J

James•5/21/24, 6:13 PM

All you need is the return type like

: Promise<Response>

: Promise<Response>

: Promise<Response>

: Promise<Response> for better DX, and then

satisfies ExportedHandler<Env>;

satisfies ExportedHandler<Env>;

satisfies ExportedHandler<Env>;

satisfies ExportedHandler<Env>;

J

James•5/21/24, 6:14 PM

Yeah,

queue

queue

queue

queue handlers don't need to return anything so:

Promise<void>

Promise<void>

Promise<void>

Promise<void> works well

L

LordSilverOP•5/21/24, 6:15 PM

but

satisfies

satisfies

operatore introduced in TypeScript 4.9 shouldn't just check that the function matches expect class?

JJames Yeah, `queue` handlers don't need to return anything so: `Promise<void>` works w...

L

LordSilverOP•5/21/24, 6:15 PM

ok but how does it make sure that

batch

batch

batch

batch is of type

MessageBatch

MessageBatch

MessageBatch

MessageBatch?

L

LordSilverOP•5/21/24, 6:16 PM

inside the code i think you would miss some stuff

J

James•5/21/24, 6:16 PM

ExportedHandler

ExportedHandler

ExportedHandler

ExportedHandler takes other generic types, included one for

MessageBatch

MessageBatch

MessageBatch

MessageBatch

J

James•5/21/24, 6:16 PM

satisfies

satisfies

covers most of the function. But the return type being explicit creates better errors for DX.

J

James•5/21/24, 6:16 PM

That github PR I linked above and discussion that follows is a good reference.

J

James•5/21/24, 6:17 PM

As for MessageBatch: https://github.com/Cloudflare-Mining/Cloudflare-Datamining/blob/b7da71b1db954d604955d62c702b955d5e612173/data/workers-types/experimental/index.ts#L409

J

James•5/21/24, 6:17 PM

ExportedHandler<Env, MessageBatch>

ExportedHandler<Env, MessageBatch>

ExportedHandler<Env, MessageBatch>

ExportedHandler<Env, MessageBatch> for example

L

LordSilverOP•5/21/24, 6:17 PM

docs are messy

L

LordSilverOP•5/21/24, 6:17 PM

they use half in one way, half in another way, another portion without anything lol

J

James•5/21/24, 6:17 PM

File an issue if you find any

Many won't have type arguments though - they're JavaScript (not TypeScript) examples

L

LordSilverOP•5/21/24, 6:18 PM

okok so that's the new best way i see

J

James•5/21/24, 6:19 PM

Yes, the "best" and recommended way now is

satisfies

satisfies

return type annotation. Like this: https://canary.discord.com/channels/595317990191398933/799437470004412476/1242537864642822245

L

LordSilverOP•5/21/24, 6:19 PM

i see many docs also still explicitly put the

Env

Env

Env

Env in the

index.ts

index.ts

index.ts

index.ts even tho now that's automatically generated in

worker-configuration.d.ts

worker-configuration.d.ts

worker-configuration.d.ts

worker-configuration.d.ts

L

LordSilverOP•5/21/24, 6:19 PM

i guess that was also recent addition

J

James•5/21/24, 6:20 PM

Yeah that's super new, and not something I'm personally a fan of, but hey

J

James•5/21/24, 6:20 PM

It allows for good types generation via

wrangler types

wrangler types

wrangler types

wrangler types tho

L

LordSilverOP•5/21/24, 6:22 PM

is there a way to further improve this too?

J

James•5/21/24, 6:23 PM

I'd add an explicit return type annotation on

fetch

fetch

fetch

fetch as

: Promise<Response>

: Promise<Response>

: Promise<Response>

: Promise<Response> so ts will catch if you ever accidentally return something else

J

James•5/21/24, 6:23 PM

otherwise seems good

L

LordSilverOP•5/21/24, 6:24 PM

ok

JJames I'd add an explicit return type annotation on `fetch` as `: Promise<Response>` s...

D

DaniFoldi•5/22/24, 8:31 AM

fun fact

Response | Promise<Response>

Response | Promise<Response>

Response | Promise<Response>

Response | Promise<Response> is implied from

implements DurableObject

implements DurableObject

implements DurableObject

implements DurableObject

V

Varna•5/22/24, 10:50 AM

Is it possible to mimic worker routes in localhost with wrangler?

# wrangler.toml
# ...

routes = [
  { pattern = "example.test/api*", zone_name = "example.test" },
  { pattern = "localhost:4321/api*", zone_name = "localhost" },
]

# wrangler.toml
# ...

routes = [
  { pattern = "example.test/api*", zone_name = "example.test" },
  { pattern = "localhost:4321/api*", zone_name = "localhost" },
]

# wrangler.toml
# ...

routes = [
  { pattern = "example.test/api*", zone_name = "example.test" },
  { pattern = "localhost:4321/api*", zone_name = "localhost" },
]

# wrangler.toml
# ...

routes = [
  { pattern = "example.test/api*", zone_name = "example.test" },
  { pattern = "localhost:4321/api*", zone_name = "localhost" },
]

VVarna Is it possible to mimic worker routes in localhost with wrangler? ```toml # wran...

H

Hello, I’m Allie!•5/22/24, 10:54 AM

Afaik no

T

tstststs•5/22/24, 2:54 PM

Hello.
I'm developing a worker that uploads files to R2. For local dev, is there a way to emulate S3 compatible endpoint that would serve/upload the files stored in the --persist-to dir that my worker is using?

Ttstststs Hello. I'm developing a worker that uploads files to R2. For local dev, is there...

H

Hello, I’m Allie!•5/22/24, 3:08 PM

Not at the moment, no

T

tstststs•5/22/24, 3:08 PM

thanks

K

kingmesal•5/22/24, 11:10 PM

I ran into a really ODD problem that I don't think should happen. with the following wrangler toml

d1_databases = [
  { binding = "DB", database_name = "mydb", database_id = "id1", preview_database_id = "id2" },
]

d1_databases = [
  { binding = "DB", database_name = "mydb", database_id = "id1", preview_database_id = "id2" },
]

d1_databases = [
  { binding = "DB", database_name = "mydb", database_id = "id1", preview_database_id = "id2" },
]

d1_databases = [
  { binding = "DB", database_name = "mydb", database_id = "id1", preview_database_id = "id2" },
]

When running

wrangler dev --remote

wrangler dev --remote

the preview_database_id is used. Perfect! However, when running

wrangler dev

wrangler dev

the preview_database_id is used.

If I change to:

d1_databases = [
  { binding = "DB", database_name = "mydb", database_id = "id1" },
]

d1_databases = [
  { binding = "DB", database_name = "mydb", database_id = "id1" },
]

d1_databases = [
  { binding = "DB", database_name = "mydb", database_id = "id1" },
]

d1_databases = [
  { binding = "DB", database_name = "mydb", database_id = "id1" },
]

When running

wrangler dev

wrangler dev

the database_id is used.

I thought the whole point of preview_database_id was for the remote use. Is this officially a bug? This seems very illogical.

K

kian•5/22/24, 11:20 PM

preview is just for development in general, not specifically remote

Kkian preview is just for development in general, not specifically remote

K

kingmesal•5/23/24, 3:27 PM

this is kind of terrible for DEV mode though ... i have two workers, one I run --remote and the other not, but if I use the same database spec, they will not use the same local D1 when i run them both remote

R

richtera•5/23/24, 4:43 PM

Asking about roles again. I am really struggling with integrating wrangler stuff with our infrastructure using git or cloudflare builds, because I cannot give access to a developer on a pages or wrangler project level. I cannot give them access to logs on cloudflare builds and I cannot lock down which project they deploy on using git ops builds. Will this be fixed soon?

M

Mitya•5/24/24, 2:57 PM

Getting Wrangler errors on some CI deployments via GH action. Normally they go through fine, but sometimes they fail with

Error: The process '/usr/local/bin/npx' failed with exit code 1

Error: The process '/usr/local/bin/npx' failed with exit code 1

Error: The process '/usr/local/bin/npx' failed with exit code 1

Error: The process '/usr/local/bin/npx' failed with exit code 1. Despite that, on the CF side, it seems to show that the deployments were successful - it shows that the active deployment was made "a few seconds ago". Any thoughts?

M

Mitya•5/24/24, 3:47 PM

Anyone from CF around? ^^

MMitya Getting Wrangler errors on some CI deployments via GH action. Normally they go t...

I

Ian•5/27/24, 1:27 AM

What is the actual error? npx is the caller but it's at the top of the chain so saying it failed isn't very helpful.

R

renox•6/1/24, 3:41 AM

How can i do wrangler login without the browser? i want to create r2 buckets from the cli but i need the login process automated without a browser

Rrenox How can i do wrangler login without the browser? i want to create r2 buckets fro...

E

Erisa•6/1/24, 11:42 AM

Create an API token and set

CLOUDFLARE_API_TOKEN

CLOUDFLARE_API_TOKEN

CLOUDFLARE_API_TOKEN

CLOUDFLARE_API_TOKEN and

CLOUDFLARE_ACCOUNT_ID

CLOUDFLARE_ACCOUNT_ID

CLOUDFLARE_ACCOUNT_ID

CLOUDFLARE_ACCOUNT_ID environment variables

do you guys use the `satisfies` in your workers?

Similar Threads

Similar Threads

Similar Threads