New Components - alerty

[luancazarine]

Resolves #13848.

Summary by CodeRabbit

• New Features

  • Introduced a notification action for sending alerts to active devices via the Alerty service.
  • Added predefined urgency levels for notifications.
  • Implemented a utility function for parsing JSON strings within objects or arrays.

• Bug Fixes

  • Improved the structure and readability of API request handling.

• Chores

  • Updated package version and added dependencies for enhanced functionality.

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
pipedream	❌ Failed (Inspect)			Sep 11, 2024 9:10pm

3 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
docs-v2	⬜️ Ignored (Inspect)	Visit Preview		Sep 11, 2024 9:10pm
pipedream-docs	⬜️ Ignored (Inspect)			Sep 11, 2024 9:10pm
pipedream-docs-redirect-do-not-edit	⬜️ Ignored (Inspect)			Sep 11, 2024 9:10pm

[coderabbitai]

Walkthrough

The pull request introduces a new action for sending notifications to active devices using the Alerty service, encapsulated in a new file. It enhances the alerty application component with private methods for constructing API requests. Additionally, a constants file is added for standardizing urgency levels, and a utility function for parsing JSON strings is introduced. The package.json is updated to reflect a new version and added dependencies.

Changes

Files	Change Summary
components/alerty/actions/notify-devices/notify-devices.mjs	Added a new action to send notifications to devices, including properties for message, title, deviceId, urgency, and actions.
components/alerty/alerty.app.mjs	Introduced _baseUrl() and _headers() methods for API request construction, modified makeRequest() to utilize these methods, and removed authKeys().
components/alerty/common/constants.mjs	Added a constant URGENCY_OPTIONS defining urgency levels for notifications.
components/alerty/common/utils.mjs	Introduced parseObject function for parsing JSON strings within objects or arrays.
components/alerty/package.json	Updated version from 0.0.1 to 0.1.0 and added a dependency on @pipedream/platform.

Assessment against linked issues

Objective	Addressed	Explanation
Sends a notification to active devices (13848)	✅
Requires 'message' and optional props (13848)	✅
Standardizes urgency levels (13848)	✅

🐇 In the meadow, I hop with glee,
New notifications, oh what a spree!
With urgency set, and messages clear,
Alerty shines bright, bringing us cheer!
Let's send our thoughts, to devices near! 🌼✨

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

[jcortes]

Hi @luancazarine lgtm! Ready for QA!

[coderabbitai]

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 70a226a and 818c775.

Files ignored due to path filters (1)

• pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml

Files selected for processing (5)

• components/alerty/actions/notify-devices/notify-devices.mjs (1 hunks)
• components/alerty/alerty.app.mjs (1 hunks)
• components/alerty/common/constants.mjs (1 hunks)
• components/alerty/common/utils.mjs (1 hunks)
• components/alerty/package.json (2 hunks)

Files skipped from review due to trivial changes (1)

• components/alerty/common/constants.mjs

Additional comments not posted (8)

components/alerty/package.json (2)

3-3: Version update looks good!

Incrementing the minor version from 0.0.1 to 0.1.0 aligns with semantic versioning conventions, given the addition of new functionality in a backwards-compatible manner. This change reflects the introduction of the new alerty component.

---

15-17: The new dependency looks good!

The addition of the @pipedream/platform dependency with version ^3.0.1 is appropriate, as it suggests that the alerty component relies on functionality provided by the Pipedream platform. The caret (^) in the version specifier allows for flexibility in future updates to the @pipedream/platform package, while ensuring compatibility with the current implementation.

components/alerty/alerty.app.mjs (3)

7-9: LGTM!

The code changes are approved.

---

10-14: LGTM!

The code changes are approved.

---

15-23: LGTM!

The code changes are approved. The changes improve the structure and readability of the code, while also enhancing its functionality by centralizing the logic for constructing API requests.

components/alerty/actions/notify-devices/notify-devices.mjs (3)

1-3: Imports look good!

The file correctly imports the required dependencies from other modules within the alerty component.

---

5-55: Action definition and properties look good!

The action is properly defined with relevant metadata properties. The props cover the necessary parameters for sending notifications, with appropriate types, labels, and descriptions. Making some props optional provides flexibility to the users. Using predefined URGENCY_OPTIONS for the urgency prop is a good practice.

---

56-72: run method implementation looks good!

The async run method is implemented correctly:

• It calls this.alerty.makeRequest with the necessary data, constructed from the action's props.
• Parsing deviceId and actions using the parseObject utility is a good practice.
• Awaiting the response ensures proper async handling.
• Exporting a $summary using the message prop is helpful for logging.

Assuming this.alerty.makeRequest is implemented correctly and returns a promise that resolves to the expected response, this implementation should work as intended.