Improved Durable Objects macro

[kanarus]

Problem

Currently, this crate's support for Durable Objects works, but its developer experience can be better:

use worker::{durable_object, DurableObject};
// 1. We MUST introduce them into the scope for this code to compile.
use worker::{async_trait, wasm_bindgen};

#[durable_object]
struct MyObject {
    state: worker::State,
}

// 2. This attribute to impl-block prevents editor's completions of trait methods.
// 3. And this uses `async_trait` which is unnecessary, bothering layer now.
#[durable_object]
// 4. Due to current implementation of the attribute, hover and code jump on
// this ↓ `DurableObject` doesn't work.
impl DurableObject for MyObject {
    //...
}

// 5. Defining multiple Durable Objects causes compile error due to the wrong design of Durable Objects support
#[durable_object]
struct AnotherObject;

#[durable_object]
impl DurableObject for AnotherObject { /* ... */ }

Details with Pictures

• 5 is reported in Using #[durable_object] more than once causes a compile error #432

• 1 makes error messages difficult to understand for those who avoid use worker::*;:

  • worker exports a lot of items from the top-level, so *-import causes serious namespace pollution and many developer will like to avoid it

• 3 leads to very unfriendly error messages for unexpected usage like:

• 2, 4: completion or hover doesn't work:

Solution

This PR resolves all of them by re-designing Durable Objects support. See worker-macros/src/durable_object.rs for how new #[DurableObject] works internally.

usage:

// 1. We only have to import `durable_object` and `DurableObject`.
use worker::{durable_object, DurableObject};

#[durable_object]
struct MyObject {
    state: worker::State,
}

// 2,3,4. Now we don't need annoying attribute on impl-block.
// Of course, hover and code jump and completion works perfectly.
impl DurableObject for MyObject {
    //...
}

// 5. This compiles. No problem.
#[DurableObject]
pub struct AnotherObject;

impl DurableObject for AnotherObject {
    //...
}

Details with Pictures

• ( 1, 2, 3, 4 ) Of course, completion, hover and code jump work perfectly

• ( 5 ) More than one Durable Objects don't cause problem ( so closes Using #[durable_object] more than once causes a compile error #432 ).

• Very clear error message for unexpected usage:

if attribute is missing:

if trait impl is missing:

Additionally, even if we merge this PR immediately, current codes still compile and work, just with "deprecated" warnings, due to some effort for backward compatibility: Merge note: this was converted into a backwards incompatible change to avoid introducing non-idiomatic camel-casing convention.

[adhami3310]

I also ran into the multiple durable objects problem, would be great if this can get merged o7

[guybedford]

This is fantastic, thanks for working on it.

I've gone ahead and pushed up a rebase here and also update it to be a breaking change with a clear compile error if the impl attribute is not removed.

Further feedback welcome, otherwise I will aim to go ahead and get this one release with the 0.6 update.