Skip to content
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

Jump to bottom

Adds timeout and docstrings to identity SDK #10131

Merged
merged 5 commits into from
Jan 27, 2023
Merged

Adds timeout and docstrings to identity SDK #10131

merged 5 commits into from
Jan 27, 2023

Conversation

alecps
Copy link
Contributor

@alecps alecps commented Jan 26, 2023 •
edited
Loading

Description

  • allows an AbortController to be passed into ODIS PNP requests to enable clients to timeout cleanly
  • Adds detailed docstrings to the identity SDK where they were missing

Other changes

  • Adds more identifier prefixes per the request of a partner wallet
  • Makes small updates to the ODIS load test code that were useful for testing

Tested

Load tests run against alfajores showed that timeouts (even in large volumes) do not introduce problems in ODIS server-side

Related issues

Backwards compatibility

Yes

Documentation

ASv2 docs will be updated to reflect the AbortController parameter

@alecps alecps requested a review from a team January 26, 2023 21:57
@alecps alecps requested a review from a team as a code owner January 26, 2023 21:57
@alecps alecps requested a review from isabellewei January 26, 2023 21:58
@alecps alecps enabled auto-merge (squash) January 26, 2023 21:58
isabellewei
isabellewei approved these changes Jan 26, 2023
View reviewed changes
Copy link
Contributor

@isabellewei isabellewei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

woohooo thanks for adding the tests and docstrings

packages/sdk/identity/src/odis/identifier.ts Outdated Show resolved Hide resolved
packages/sdk/identity/src/odis/identifier.ts Outdated Show resolved Hide resolved
@alecps alecps merged commit 2ef34ba into master Jan 27, 2023
martinvol pushed a commit that referenced this pull request Feb 9, 2023
@alecps @martinvol
Adds timeout and docstrings to identity SDK (#10131)
ced6a34 
* add AbortController to odis queries

* add docstrings to ODIS sdk
@lvpeschke lvpeschke deleted the alecps/identityTimeout branch November 9, 2023 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@aaronmgdr aaronmgdr aaronmgdr left review comments

@isabellewei isabellewei isabellewei approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add docstrings to identity SDK Update identity SDK to abort hanging Promises
3 participants
@alecps @aaronmgdr @isabellewei