Abstract OAuth implementation in the SDK #13983

jverce · 2024-09-18T00:53:36Z

Changelog

Install simple-oauth2 to handle OAuth client requests
Rename some methods and types to reuse them
Abstract the HTTP requests so that it can be used for Connect and for normal API requests
Implement logic to fetch OAuth client credentials
Bump minor version of the SDK

WHY

So that we can make API requests using the OAuth credentials.

Summary by CodeRabbit

New Features
- Introduced support for OAuth 2.0 authentication in the SDK.
- Enhanced ServerClient functionality with new methods for handling API requests securely.
Improvements
- Updated SDK version to 0.1.0, reflecting new features and enhancements.
- Added new dependencies to support OAuth 2.0 functionality, including TypeScript definitions.

* Install `simple-oauth2` to handle OAuth client requests * Rename some methods and types to reuse them * Abstract the HTTP requests so that it can be used for Connect and for normal API requests * Implement logic to fetch OAuth client credentials * Bump minor version of the SDK

vercel · 2024-09-18T00:53:42Z

@jverce is attempting to deploy a commit to the Pipedreamers Team on Vercel.

A member of the Team first needs to authorize it.

coderabbitai · 2024-09-18T00:53:43Z

Walkthrough

The pull request introduces significant enhancements to the @pipedream/sdk package, primarily by adding support for OAuth 2.0 authentication. This includes updates to the package.json file, which now features a new dependency on simple-oauth2, and modifications to the ServerClient class in the index.ts file, where new properties and methods facilitate OAuth-based API interactions.

Changes

File	Change Summary
packages/sdk/package.json	Version bump from `0.0.13` to `0.1.0`. Added `simple-oauth2` as a dependency and `@types/simple-oauth2` as a dev dependency.
packages/sdk/src/server/index.ts	Enhanced `ServerClient` class with OAuth 2.0 support by adding `oauthClientId` and `oauthClientSecret` properties. Added new methods for handling OAuth requests and renamed existing methods for clarity.

Possibly related PRs

Je/connect sdk decouple app from token #13870: Introduces a new parameter oauthAppId to the connectAccount function, enhancing OAuth 2.0 support in the SDK.
Biz/dj 2450 add getprojectinfo function to the sdk #13968: Adds new types and a method related to the ServerClient class, directly relevant to the OAuth 2.0 changes in the main PR.

Suggested reviewers

@dylburger

Poem

🐰 In the meadow where bunnies play,
OAuth 2.0 has come to stay!
With tokens flying, oh what a sight,
Our SDK shines, oh so bright!
Hops and jumps, we celebrate,
New features here, oh how great! 🌼

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between e1e7efc and e8773e7.

Files selected for processing (1)

packages/sdk/src/server/index.ts (7 hunks)

Files skipped from review as they are similar to previous changes (1)

packages/sdk/src/server/index.ts

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
-- I pushed a fix in commit <commit_id>, please review it.
-- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
-- @coderabbitai generate unit testing code for this file.
-- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
-- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
-- @coderabbitai read src/utils.ts and generate unit testing code.
-- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
-- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

vercel · 2024-09-18T00:53:43Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Sep 19, 2024 4:18pm

dylburger · 2024-09-18T23:57:16Z

packages/sdk/src/server/index.ts

+  /**
+   * The client ID of your workspace's OAuth application.
+   */
+  oauthClientId: string;


We should make these optional for now, and handle that optionality in the rest of the code, since project keys alone can authorize Connect API requests and we don't yet want to force those customers to use OAuth clients. We may end up consolidating on OAuth for the Connect API, too, and just make people pass the dev / prod project ID (removing project secret entirely), but for now it's an either-or.

dylburger · 2024-09-18T23:57:59Z

packages/sdk/src/server/index.ts

@@ -358,6 +394,52 @@ class ServerClient {
    return result;
  }

+  /**
+   * Makes a request to the Connect API.


replace "Connect" with "Pipedream"

jverce added enhancement New feature or request dependencies Pull requests that update a dependency file pd-api Pipedream API requests javascript Pull requests that update Javascript code prioritized Prioritized issue strategic-app labels Sep 18, 2024

jverce self-assigned this Sep 18, 2024

jverce requested a review from dylburger September 18, 2024 00:53

Lazy token query

e1e7efc

dylburger reviewed Sep 18, 2024

View reviewed changes

Apply PR feedback

e8773e7

dylburger approved these changes Sep 19, 2024

View reviewed changes

jverce merged commit 3d38039 into PipedreamHQ:master Sep 19, 2024
6 of 8 checks passed

jverce deleted the jay/dj-2446-abstract-oauth-implementation-in-the-sdk branch September 19, 2024 20:52

This was referenced Sep 19, 2024

Invoke workflows via the SDK #14040

Merged

Small bug fixes, refactors in workflow invocation based on Danny's tests #14054

Merged

Fixes DJ-2470 #14106

Merged

coderabbitai bot mentioned this pull request Sep 27, 2024

(fix) Fixing getAccountsByExternalId function (route was incorrect before) #14135

Merged

coderabbitai bot mentioned this pull request Oct 16, 2024

Initial commit of workflow SDK / OAuth docs #14053

Merged

This was referenced Nov 13, 2024

Backend request improvements #14642

Merged

Retrieve credentials for a single account #14657

Merged

Require project environment in SDK #14679

Merged

This was referenced Nov 20, 2024

feat(sdk-package): call apis directly from client sdk #14699

Merged

Fix issues with rails/actioncable in the server sdk #14714

Merged

Fixing @pipedream/sdk imports #14715

Merged

This was referenced Dec 4, 2024

feat(sdk): add x-pd-sdk-version, triggerDeploy (1.0.9) #14836

Merged

Amend the Component API methods in the SDK #14883

Merged

coderabbitai bot mentioned this pull request Dec 11, 2024

Adolfo/money 1950 remove actioncable from sdk #14937

Merged

coderabbitai bot mentioned this pull request Jan 23, 2025

Update SDK with new endpoints for triggers #15385

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Abstract OAuth implementation in the SDK #13983

Abstract OAuth implementation in the SDK #13983

Uh oh!

jverce commented Sep 18, 2024 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Sep 18, 2024

Uh oh!

coderabbitai bot commented Sep 18, 2024 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

vercel bot commented Sep 18, 2024 •

edited

Loading

Uh oh!

dylburger Sep 18, 2024

Uh oh!

dylburger Sep 18, 2024

Uh oh!

Uh oh!

Uh oh!

Abstract OAuth implementation in the SDK #13983

Abstract OAuth implementation in the SDK #13983

Uh oh!

Conversation

jverce commented Sep 18, 2024 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changelog

WHY

Summary by CodeRabbit

Uh oh!

vercel bot commented Sep 18, 2024

Uh oh!

coderabbitai bot commented Sep 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Possibly related PRs

Suggested reviewers

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

vercel bot commented Sep 18, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dylburger Sep 18, 2024

Choose a reason for hiding this comment

Uh oh!

dylburger Sep 18, 2024

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

jverce commented Sep 18, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Sep 18, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

vercel bot commented Sep 18, 2024 •

edited

Loading