Skip to content

Conversation

@michelle0927
Copy link
Collaborator

@michelle0927 michelle0927 commented Aug 1, 2025

Resolves #17794

Summary by CodeRabbit

  • New Features

    • Added an action to list stories and comments for a specified Asana task, with options to filter comments, include extra fields, and limit results.
  • Chores

    • Updated the Asana integration version to 0.8.0.

@vercel
Copy link

vercel bot commented Aug 1, 2025

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

3 Skipped Deployments
Name Status Preview Comments Updated (UTC)
docs-v2 ⬜️ Ignored (Inspect) Visit Preview Aug 1, 2025 8:19pm
pipedream-docs ⬜️ Ignored (Inspect) Aug 1, 2025 8:19pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) Aug 1, 2025 8:19pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented Aug 1, 2025

Walkthrough

A new Asana action module was added to list stories for a given task, supporting optional filtering for comments, field selection, and result limits. The action uses Asana's API with pagination and accumulates results as specified. The package version was incremented to 0.8.0 to reflect this addition.

Changes

Cohort / File(s) Change Summary
New Asana Action: List Task Stories
components/asana/actions/list-task-stories/list-task-stories.mjs
Introduced a new action to fetch stories for a specified Asana task, with options for comment-only filtering, field selection, and pagination.
Package Version Update
components/asana/package.json
Updated the package version from 0.7.4 to 0.8.0.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ListTaskStoriesAction
    participant AsanaAPI

    User->>ListTaskStoriesAction: Provide taskId, options
    loop Until maxResults or no more pages
        ListTaskStoriesAction->>AsanaAPI: Fetch stories for taskId (with pagination)
        AsanaAPI-->>ListTaskStoriesAction: Return stories, next_page token
        alt commentsOnly enabled
            ListTaskStoriesAction->>ListTaskStoriesAction: Filter stories by type "comment"
        end
        ListTaskStoriesAction->>ListTaskStoriesAction: Accumulate results
    end
    ListTaskStoriesAction-->>User: Return collected stories and summary
Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Assessment against linked issues

Objective Addressed Explanation
Implement an Asana action to retrieve task stories via /tasks/{task_gid}/stories (17794)
Support filtering for comments only in the returned stories (17794)
Allow passing optional fields and limiting the number of results (17794)

Poem

In Asana’s fields, the stories grow,
Rabbits fetch comments, swift and low.
With tasks and tales, and filters bright,
The code now hops from page to byte.
A version bump, a cheerful cheer—
New features bloom, the path is clear!
🐇✨

Note

⚡️ Unit Test Generation is now available in beta!

Learn more here, or try it out under "Finishing Touches" below.


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7751796 and b634ddc.

📒 Files selected for processing (1)
  • components/asana/actions/list-task-stories/list-task-stories.mjs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • components/asana/actions/list-task-stories/list-task-stories.mjs
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (3)
  • GitHub Check: Publish TypeScript components
  • GitHub Check: Lint Code Base
  • GitHub Check: Verify TypeScript components
✨ Finishing Touches
  • 📝 Generate Docstrings
🧪 Generate unit tests
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch issue-17794

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai generate unit tests to generate unit tests for this 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.

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Actionable comments posted: 1

🧹 Nitpick comments (1)
components/asana/actions/list-task-stories/list-task-stories.mjs (1)

56-61: Consider API rate limits and input validation.

Setting limit directly to maxResults could cause issues if maxResults is very large, potentially hitting Asana API rate limits. Consider capping the limit to a reasonable page size (e.g., 100) and using the existing pagination logic.

     const params = {
-      limit: this.maxResults,
+      limit: Math.min(this.maxResults || 100, 100),
       opt_fields: this.optFields
         ? this.optFields?.join(",")
         : undefined,
     };
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e53351b and 7751796.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (2)
  • components/asana/actions/list-task-stories/list-task-stories.mjs (1 hunks)
  • components/asana/package.json (1 hunks)
🧰 Additional context used
🧠 Learnings (1)
📚 Learning: when developing pipedream components, do not add built-in node.js modules like `fs` to `package.json...
Learnt from: jcortes
PR: PipedreamHQ/pipedream#14935
File: components/sailpoint/package.json:15-18
Timestamp: 2024-12-12T19:23:09.039Z
Learning: When developing Pipedream components, do not add built-in Node.js modules like `fs` to `package.json` dependencies, as they are native modules provided by the Node.js runtime.

Applied to files:

  • components/asana/package.json
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (4)
  • GitHub Check: pnpm publish
  • GitHub Check: Publish TypeScript components
  • GitHub Check: Verify TypeScript components
  • GitHub Check: Lint Code Base
🔇 Additional comments (6)
components/asana/package.json (1)

3-3: LGTM! Appropriate version bump for new functionality.

The minor version increment from 0.7.4 to 0.8.0 correctly follows semantic versioning conventions for adding new backward-compatible functionality.

components/asana/actions/list-task-stories/list-task-stories.mjs (5)

1-8: LGTM! Well-structured module definition.

The import, module metadata, and documentation reference are properly configured for a new Pipedream action.


23-42: LGTM! Props are well-configured.

The remaining props (commentsOnly, optFields, maxResults) are properly typed with appropriate defaults and clear descriptions.


43-52: LGTM! Clean API method implementation.

The getStoriesForTask method correctly constructs the Asana API path and passes through options appropriately.


65-91: LGTM! Solid pagination and filtering implementation.

The pagination logic correctly handles the Asana API's next_page token, and the filtering logic properly identifies comments by checking story.type !== "comment". The count tracking efficiently stops processing when maxResults is reached.


93-96: LGTM! Proper result handling and summary.

The summary export and return statement correctly provide feedback and results to the user, following Pipedream action conventions.

Copy link
Collaborator

@jcortes jcortes left a comment

Choose a reason for hiding this comment

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

Hi @michelle0927 lgtm! Ready for QA!

@vunguyenhung vunguyenhung merged commit fc93582 into master Aug 4, 2025
11 checks passed
@vunguyenhung vunguyenhung deleted the issue-17794 branch August 4, 2025 01:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Asana] Get-Task-Strories

4 participants