Skip to content

# Sequence diagram for AuthCodeHandler OAuth URL construction for Apple vs non-Apple #200

@Dargon789

Description

@Dargon789

Reviewer's Guide

Introduces Apple authentication-specific behavior across the wallet WDK and related services, bumps multiple packages from 3.0.0-beta.6 to 3.0.0-beta.8 with corresponding changelog and changeset entries, and slightly extends the dapp-client public API exports.

Sequence diagram for AuthCodeHandler OAuth URL construction for Apple vs non-Apple

sequenceDiagram
  actor User
  participant DappClient
  participant AuthCodeHandler
  participant OAuthProvider

  User->>DappClient: initiateSignup(signupKind)
  DappClient->>AuthCodeHandler: buildAuthUrl(signupKind, state)
  AuthCodeHandler->>AuthCodeHandler: createSearchParams(audience, redirectUri, responseType)
  alt signupKind_is_apple
    AuthCodeHandler->>AuthCodeHandler: omit_scope_parameter
  else signupKind_is_not_apple
    AuthCodeHandler->>AuthCodeHandler: add_scope_openid_profile_email
  end
  AuthCodeHandler->>DappClient: return_oauthUrl_with_query
  DappClient->>User: redirect_to_oauthUrl
  User->>OAuthProvider: authenticate
  OAuthProvider-->>DappClient: redirect_back_with_auth_code
Loading

Flow diagram for conditional scope parameter in AuthCodeHandler

flowchart TD
  A[Start buildAuthUrl] --> B[Set base params client_id, redirect_uri, response_type, state]
  B --> C{Is signupKind apple}
  C -->|Yes| D[Do not include scope parameter]
  C -->|No| E[Add scope openid profile email]
  D --> F[Build OAuth URL with current params]
  E --> F[Build OAuth URL with current params]
  F --> G[Return OAuth URL]
Loading

File-Level Changes

Change Details Files
Adjust OAuth authorization URL construction to omit scope for Apple signups and update associated tests.
  • Modify AuthCodeHandler to conditionally exclude the scope parameter when signupKind is 'apple' while preserving it for other providers.
  • Update authcode handler tests to assert that Apple authorization URLs do not include a scope query parameter.
packages/wallet/wdk/src/sequence/handlers/authcode.ts
packages/wallet/wdk/test/authcode.test.ts
Expand the dapp-client public API surface to include additional transport-related types and enums.
  • Re-export TransportMessage type from dapp-client types index through the main entrypoint.
  • Expose MessageType enum alongside RequestActionType and TransportMode from the main dapp-client index.
packages/wallet/dapp-client/src/index.ts
Version bump multiple packages to 3.0.0-beta.8 and document Apple auth fixes and dependency updates in changelogs and changesets.
  • Update package.json versions for services, wallet, and utils packages from 3.0.0-beta.6 to 3.0.0-beta.8.
  • Add 3.0.0-beta.7 and 3.0.0-beta.8 sections to multiple package changelogs describing Apple auth fixes and updated internal dependencies.
  • Add two new changeset files describing Apple auth fix/fixes across affected packages.
  • Adjust pre-release changeset metadata as part of the versioning flow.
packages/wallet/wdk/CHANGELOG.md
packages/wallet/dapp-client/CHANGELOG.md
packages/wallet/core/CHANGELOG.md
packages/services/relayer/CHANGELOG.md
packages/services/api/CHANGELOG.md
packages/services/builder/CHANGELOG.md
packages/services/guard/CHANGELOG.md
packages/services/identity-instrument/CHANGELOG.md
packages/services/indexer/CHANGELOG.md
packages/services/marketplace/CHANGELOG.md
packages/services/metadata/CHANGELOG.md
packages/services/userdata/CHANGELOG.md
packages/utils/abi/CHANGELOG.md
packages/wallet/primitives/CHANGELOG.md
packages/services/api/package.json
packages/services/builder/package.json
packages/services/guard/package.json
packages/services/identity-instrument/package.json
packages/services/indexer/package.json
packages/services/marketplace/package.json
packages/services/metadata/package.json
packages/services/relayer/package.json
packages/services/userdata/package.json
packages/utils/abi/package.json
packages/wallet/core/package.json
packages/wallet/dapp-client/package.json
packages/wallet/primitives/package.json
packages/wallet/wdk/package.json
.changeset/new-turkeys-double.md
.changeset/nice-tips-slide.md
.changeset/pre.json

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Originally posted by @sourcery-ai[bot] in #199 (comment)

Metadata

Metadata

Assignees

Labels

dependenciesPull requests that update a dependency filedocumentationImprovements or additions to documentationduplicateThis issue or pull request already existsenhancementNew feature or requestgood first issueGood for newcomershelp wantedExtra attention is neededinvalidThis doesn't seem rightjavascriptPull requests that update javascript codequestionFurther information is requested

Projects

Status

Done

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions