Invoke workflows via the SDK

[jverce]

Changelog

• Refactor _makeRequest to accept an optional baseURL argument, so that it can target URLs other than the API
• Implement invokeWorkflow to make a request to the HTTP interface of a workflow

WHY

To support authenticated workflow invocations via the SDK.

Summary by CodeRabbit

• New Features
  • Introduced an optional baseURL property in request options for enhanced flexibility in URL construction.
  • Added a new method to the ServerClient class for invoking workflows via HTTP POST requests, expanding interaction capabilities with external workflows.

[vercel]

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 11:44pm

[vercel]

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

A member of the Team first needs to authorize it.

[coderabbitai]

Walkthrough

The changes introduce a new optional baseURL property to the RequestOptions interface, enhancing request URL flexibility. The _makeRequest method now utilizes this property instead of a hardcoded baseURL. Additionally, a new invokeWorkflow method is added to the ServerClient class, allowing users to send HTTP POST requests to invoke workflows with a specified URL and body. These modifications expand the configurability of requests and the functionality of the ServerClient class.

Changes

Files	Change Summary
packages/sdk/src/server/index.ts	- Added baseURL?: string to RequestOptions interface.
	- Introduced async invokeWorkflow(url: string, body: unknown = null): Promise<unknown> method in ServerClient class.

Possibly related PRs

• Abstract OAuth implementation in the SDK #13983: This PR modifies the ServerClient class in the same index.ts file and introduces new methods related to authorization, which may interact with the new invokeWorkflow method added in the main PR.

Suggested labels

strategic-app

Poem

In the code where requests do play,
A new baseURL comes to stay.
With workflows now at your command,
Just send a POST, it’s all so grand!
Hopping through changes, we cheer and sway,
For flexibility brightens our day! 🐇✨

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 3eab26f and 1ebeef2.

Files selected for processing (1)

• packages/sdk/src/server/index.ts (3 hunks)

Additional comments not posted (2)

packages/sdk/src/server/index.ts (2)

261-265: LGTM!

The addition of the optional baseURL argument enhances the flexibility of the _makeRequest function by allowing it to target different base URLs. The default behavior remains the same when baseURL is not provided, ensuring backward compatibility.

Also applies to: 372-375

---

624-653: Excellent addition!

The invokeWorkflow function is a valuable addition to the ServerClient class. It enables invoking workflows by sending HTTP POST requests to their respective URLs, along with an optional request body. This functionality extends the capabilities of the SDK, allowing users to interact with workflows programmatically.

The implementation leverages the updated _makeRequest function with the custom baseURL argument to target the specified workflow URL. The function constructs the request appropriately, including the authorization header and stringified body.

Overall, this is a well-designed and useful feature that enhances the SDK's functionality without introducing any breaking changes.

---

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

• X
• Mastodon
• Reddit
• LinkedIn

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.