feat(client): optional account recovery #1546

fforbeck · 2024-09-06T18:41:30Z

Current Workflow (CLI)

`w3cli` Project

The space.create(name, options) function in space.js allows the user to pass the following options:

recovery: false (default)
caution: false (default)
customer: Email | false
account: string | false

If the account attribute is provided, the following steps are triggered:

space.createdRecovery is called.
Then, client.capabilities.access.delegate is executed.

This process occurs during space creation, not during provisioning.
Provisioning only happens when the customer attribute is provided in the options argument.

Issue (JS Client)

`w3up` Project

The client.createSpace(name) function in the w3up project currently does not accept any options, which means the recovery account must be created manually after space creation and provisioning. This introduces a risk of forgetting the manual step and potentially losing access to the space.

Expected Outcome

We propose a small modification to the client.createSpace(name) function to support optional parameters, allowing clients to pass an account directly, automating the recovery setup.

Solution:

Clients can now call client.createSpace(name, { account }) to include the account in the creation process.
This ensures that the recovery account is created immediately after the space is created, provisioned, and saved, eliminating the need for a manual step.

Benefits:

Backward Compatibility: The change does not break existing client implementations since the account parameter is optional, keeping calls like client.createSpace(name) intact.
Simplified Workflow: By simply passing the account when calling createSpace, the recovery account setup is handled automatically during space creation.
Flexibility: If needed in the future, the account attribute can be made required to enforce stricter recovery account management.

Signed-off-by: Felipe Forbeck <felipe.forbeck@gmail.com>

hannahhoward

This approach is fine, except I have one nit around using an account object rather than an email.

Also we should submit a PR to github.com/storacha-network/docs to update the docs for the JS client.

packages/w3up-client/src/client.js

packages/w3up-client/test/client.test.js

fforbeck · 2024-09-11T20:00:48Z

@hannahhoward

The last commit introduces a new test case to ensure that when Alice creates a space, her account is correctly set as the recovery account. The test verifies that Alice retains access to the space from another device by checking the space's accessibility.

In the client.js, I modified the createSpace function to provision and save the space before delegating access to the recovery account. This ensures that the necessary authorizations are in place for the delegation.

If that looks good to you I will update the documentation.

hannahhoward

Yea, this is obviously not ideal to have all this logic in creating a space, on the otherhand, with the chain of dependencies there's no way to seperate it. And it will make for a much shorter setup tutorial, which will be quite nice. We should definitely update docs for this.

hannahhoward

LGTM

alanshaw · 2024-09-13T08:18:22Z

@fforbeck how does this affect the space creation steps in the CLI?

alanshaw

This is a great but please could you try to keep non essential changes to a minimum? There's a lot of code formatting change in here that makes it harder for me to review. Just submit a separate PR in the future for code formatting changes 🙏.

packages/w3up-client/src/client.js

Co-authored-by: Alan Shaw <alan.shaw@protocol.ai>

fforbeck · 2024-09-13T12:17:58Z

This is a great but please could you try to keep non essential changes to a minimum? There's a lot of code formatting change in here that makes it harder for me to review. Just submit a separate PR in the future for code formatting changes 🙏.

Yeah, my bad. I will revert these formatting changes to simplify this PR.

fforbeck · 2024-09-13T12:27:09Z

@fforbeck how does this affect the space creation steps in the CLI?

The CLI should remain unaffected by this change because the account parameter is optional. The existing logic in the CLI already supports space creation without requiring an account, and it includes the necessary recovery logic (e.g., this line in the code).

In the future, we could create a separate PR to simplify the CLI code by leveraging the new version of the createSpace function. However, given the current implementation, there should be no impact on the CLI’s functionality.

.github/workflows/w3up-client.yml

fforbeck · 2024-09-13T13:10:29Z

@alanshaw
I've applied the suggested changes and reverted the formatting stuff. I just had to do a minor tweak in the GH Action to be able to run it on the CI - which was failing.

alanshaw

LGTM

alanshaw · 2024-09-13T14:58:46Z

packages/w3up-client/README.md


 ```js
 // wait for payment plan to be selected
 while (true) {
  const res = await account.plan.get()
  if (res.ok) break
  console.log('Waiting for payment plan to be selected...')
-  await new Promise(resolve => setTimeout(resolve, 1000))
+  await new Promise((resolve) => setTimeout(resolve, 1000))
 }


It would be rad if this was a method of the client? Would you be up for adding something like that quickly?

Good idea. I will add that.

packages/w3up-client/src/client.js

alanshaw · 2024-09-16T12:21:38Z

packages/w3up-client/README.md

-  await new Promise((resolve) => setTimeout(resolve, 1000))
-}
+// Wait for a payment plan with a 1-second polling interval and 60-second timeout
+await client.waitForPaymentPlan(account, 1000, 60000)


🙏 can we land as a separate PR? Apologies - I should have asked...

I think it might be better for this to be an instance method of AccountPlan rather than the top level? WDYT?

await account.plan.wait()

In the docs I think it's simplier to just use the defaults (i.e. don't specify the interval/timeout).

alanshaw · 2024-09-16T12:22:40Z

packages/w3up-client/src/client.js

+   * @param {Account.Account} account - The account object to check the payment plan for.
+   * @param {number} [interval=1000] - The polling interval in milliseconds (default is 1000ms).
+   * @param {number} [timeout=180000] - The maximum time to wait in milliseconds before throwing a timeout error (default is 3 minutes).
+   * @returns {Promise<void>} - Resolves once a payment plan is selected within the timeout.


I would return the plan information when it is available.

alanshaw · 2024-09-16T12:23:36Z

packages/w3up-client/src/client.js

+   * at a specified interval until a valid plan is selected or the timeout is reached.
+   *
+   * @param {Account.Account} account - The account object to check the payment plan for.
+   * @param {number} [interval=1000] - The polling interval in milliseconds (default is 1000ms).


I'd pass an options object with these two properties.

alanshaw · 2024-09-16T12:26:33Z

packages/w3up-client/src/client.js

+   *
+   * @param {Account.Account} account - The account object to check the payment plan for.
+   * @param {number} [interval=1000] - The polling interval in milliseconds (default is 1000ms).
+   * @param {number} [timeout=180000] - The maximum time to wait in milliseconds before throwing a timeout error (default is 3 minutes).


Might be better to pass an AbortSignal instead so that if folks are using this in a UI they can have a cancel button. Another reason is that it could take longer than 3 minutes, considering you have to log into your email, click the link, add credit card details etc.

alanshaw · 2024-09-16T12:26:56Z

packages/w3up-client/test/client.test.js

+          message: 'Timeout: Payment plan selection took too long.',
+        })
+      },
+  },


🤖 I have created a release *beep* *boop* --- ## [16.1.0](w3up-client-v16.0.0...w3up-client-v16.1.0) (2024-09-16) ### Features * **client:** optional account recovery ([#1546](#1546)) ([ea02adb](ea02adb)) * wait for plan selection ([#1547](#1547)) ([7fdee77](7fdee77)) ### Other Changes * Add `pnpm dev` to watch-build all packages ([#1533](#1533)) ([07970ef](07970ef)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

### Changes The `createSpace` function in `client.js` has been enhanced to streamline the space creation process. The new workflow now automatically handles the following steps: - Provisions the space. - Saves the space. - Creates a recovery account. - Delegates access to the recovery account. This update removes the need for manual steps, ensuring the recovery account is set up as part of the space creation process. > **Note:** This PR should only be merged after [storacha/w3up#1546](storacha/w3up#1546) has been merged and released.

feat(client): optional email recovery

445e52d

Signed-off-by: Felipe Forbeck <felipe.forbeck@gmail.com>

fforbeck requested review from Peeja, alanshaw and hannahhoward September 6, 2024 19:30

hannahhoward requested changes Sep 6, 2024

View reviewed changes

packages/w3up-client/src/client.js Show resolved Hide resolved

applied changes suggested in the PR + tests: wip

f45288a

fforbeck commented Sep 9, 2024

View reviewed changes

packages/w3up-client/test/client.test.js Outdated Show resolved Hide resolved

fix test: client.test.js account recovery

3dfe60e

fforbeck requested a review from hannahhoward September 11, 2024 20:00

hannahhoward approved these changes Sep 12, 2024

View reviewed changes

fforbeck added 2 commits September 12, 2024 14:16

new test cases

3cd04f9

docs: update space creation steps

a01012c

fforbeck force-pushed the add-opt-email-recovery branch from f7dadb8 to a01012c Compare September 12, 2024 18:00

fforbeck mentioned this pull request Sep 12, 2024

fix: update space creation steps storacha/docs#1

Merged

fforbeck marked this pull request as ready for review September 12, 2024 18:26

fforbeck mentioned this pull request Sep 12, 2024

Spaces are always available in the Console storacha/project-tracking#124

Closed

chore: match pnpm version

eed9693

fforbeck force-pushed the add-opt-email-recovery branch from 9531e3b to eed9693 Compare September 12, 2024 19:06

alanshaw requested changes Sep 13, 2024

View reviewed changes

packages/w3up-client/src/client.js Outdated Show resolved Hide resolved

packages/w3up-client/src/client.js Outdated Show resolved Hide resolved

packages/w3up-client/src/client.js Show resolved Hide resolved

fforbeck and others added 2 commits September 13, 2024 09:13

Update packages/w3up-client/src/client.js

33a754b

Co-authored-by: Alan Shaw <alan.shaw@protocol.ai>

Update packages/w3up-client/src/client.js

d7422d6

Co-authored-by: Alan Shaw <alan.shaw@protocol.ai>

fforbeck force-pushed the add-opt-email-recovery branch from 60dcbc9 to f38507b Compare September 13, 2024 12:44

chore: revert formatting changes

0e6d683

fforbeck force-pushed the add-opt-email-recovery branch from f38507b to 0e6d683 Compare September 13, 2024 12:45

fix client tests

b0bd02e

fforbeck added 2 commits September 13, 2024 09:55

update createSpace jsdocs

6f05cdf

chore: version is optional if defined in pkg.json

a46d59d

fforbeck requested a review from alanshaw September 13, 2024 13:02

fforbeck commented Sep 13, 2024

View reviewed changes

.github/workflows/w3up-client.yml Show resolved Hide resolved

fforbeck changed the title ~~feat(client): optional email recovery~~ feat(client): optional account recovery Sep 13, 2024

alanshaw approved these changes Sep 13, 2024

View reviewed changes

fforbeck commented Sep 13, 2024

View reviewed changes

packages/w3up-client/src/client.js Outdated Show resolved Hide resolved

alanshaw requested changes Sep 16, 2024

View reviewed changes

fforbeck force-pushed the add-opt-email-recovery branch from 7d268e5 to a46d59d Compare September 16, 2024 12:40

fforbeck enabled auto-merge (squash) September 16, 2024 12:50

fforbeck requested a review from alanshaw September 16, 2024 12:50

alanshaw approved these changes Sep 16, 2024

View reviewed changes

fforbeck merged commit ea02adb into main Sep 16, 2024
7 checks passed

fforbeck deleted the add-opt-email-recovery branch September 16, 2024 12:52

github-actions bot mentioned this pull request Sep 16, 2024

chore(main): release w3up-client 16.1.0 #1538

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(client): optional account recovery #1546

feat(client): optional account recovery #1546

fforbeck commented Sep 6, 2024 •

edited

Loading

hannahhoward left a comment

fforbeck commented Sep 11, 2024

hannahhoward left a comment

hannahhoward left a comment

alanshaw commented Sep 13, 2024

alanshaw left a comment

fforbeck commented Sep 13, 2024

fforbeck commented Sep 13, 2024

fforbeck commented Sep 13, 2024

alanshaw left a comment

alanshaw Sep 13, 2024

fforbeck Sep 13, 2024

alanshaw Sep 16, 2024

alanshaw Sep 16, 2024

alanshaw Sep 16, 2024

alanshaw Sep 16, 2024

alanshaw Sep 16, 2024

feat(client): optional account recovery #1546

feat(client): optional account recovery #1546

Conversation

fforbeck commented Sep 6, 2024 • edited Loading

Current Workflow (CLI)

w3cli Project

Issue (JS Client)

w3up Project

Expected Outcome

Solution:

Benefits:

hannahhoward left a comment

Choose a reason for hiding this comment

fforbeck commented Sep 11, 2024

hannahhoward left a comment

Choose a reason for hiding this comment

hannahhoward left a comment

Choose a reason for hiding this comment

alanshaw commented Sep 13, 2024

alanshaw left a comment

Choose a reason for hiding this comment

fforbeck commented Sep 13, 2024

fforbeck commented Sep 13, 2024

fforbeck commented Sep 13, 2024

alanshaw left a comment

Choose a reason for hiding this comment

alanshaw Sep 13, 2024

Choose a reason for hiding this comment

fforbeck Sep 13, 2024

Choose a reason for hiding this comment

alanshaw Sep 16, 2024

Choose a reason for hiding this comment

alanshaw Sep 16, 2024

Choose a reason for hiding this comment

alanshaw Sep 16, 2024

Choose a reason for hiding this comment

alanshaw Sep 16, 2024

Choose a reason for hiding this comment

alanshaw Sep 16, 2024

Choose a reason for hiding this comment

fforbeck commented Sep 6, 2024 •

edited

Loading

`w3cli` Project

`w3up` Project