Support query parameters in Get Time Entries action

[kazuya-shimatani]

Closes

Closes #16539

Changes

• Added props for each query parameter to components/toggl/actions/get-time-entries/get-time-entries.mjs
• Passes the provided parameters as params in the API request

Notes

• Implementation follows the Toggl Track API documentation

Summary by CodeRabbit

• New Features
  • Added new filtering options to the Toggl "Get Time Entries" action, allowing users to filter by start date, end date, modification time, and include meta or sharing details in the results.

[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)			May 2, 2025 11:16am

[vercel]

@kazuya-shimatani 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 Get Time Entries action in the Toggl integration was updated to accept additional optional input properties: startDate, endDate, since, before, meta, and includeSharing. These properties allow users to filter time entries by date range, modification time, and include extra metadata or sharing details. The action’s run method now dynamically constructs a parameters object based on the provided inputs and passes it to the Toggl API call, enabling more granular control over the data retrieved.

Changes

Files/Groups	Change Summary
components/toggl/actions/get-time-entries/get-time-entries.mjs	Added optional input properties (startDate, endDate, since, before, meta, includeSharing) to action props; updated run method to build and pass query parameters to the API call.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant GetTimeEntriesAction
    participant TogglAPI

    User->>GetTimeEntriesAction: Provide optional filters (startDate, endDate, etc.)
    GetTimeEntriesAction->>GetTimeEntriesAction: Build params object from inputs
    GetTimeEntriesAction->>TogglAPI: getTimeEntries(params)
    TogglAPI-->>GetTimeEntriesAction: Return filtered time entries
    GetTimeEntriesAction-->>User: Return response

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Support all available query parameters (start_date, end_date, since, before, meta, include_sharing) in the action (#16539)	✅

Poem

A hop and a skip, I filter with glee,
Now Toggl time entries come tailored to me!
With dates and with meta, and sharing galore,
I fetch just the data I’m truly looking for.
No more sifting through thousands, what a delight—
This bunny codes smarter, and gets it just right!
🐇✨

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

components/toggl/actions/get-time-entries/get-time-entries.mjs

Oops! Something went wrong! :(

ESLint: 8.57.1

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'jsonc-eslint-parser' imported from /eslint.config.mjs
at packageResolve (node:internal/modules/esm/resolve:839:9)
at moduleResolve (node:internal/modules/esm/resolve:908:18)
at defaultResolve (node:internal/modules/esm/resolve:1038:11)
at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:557:12)
at ModuleLoader.resolve (node:internal/modules/esm/loader:525:25)
at ModuleLoader.getModuleJob (node:internal/modules/esm/loader:246:38)
at ModuleJob._link (node:internal/modules/esm/module_job:126:49)

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

• 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.

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 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.

[pipedream-component-development]

Thank you so much for submitting this! We've added it to our backlog to review, and our team has been notified.

[pipedream-component-development]

Thanks for submitting this PR! When we review PRs, we follow the Pipedream component guidelines. If you're not familiar, here's a quick checklist:

• Create components to address specific use cases whenever possible
• Component keys should follow the format app_name_slug-slugified-component-name
• Components should follow the standard directory structure
• Prefer Node.js client libraries to REST APIs
• When making API requests, handle pagination to ensure all data / events are processed
• Use secret props to capture sensitive data
• Props and methods should be defined in app files whenever possible
• Document methods with JS Docs
• Use optional props whenever possible, and set a default value where you can
• Use async options to accept user input wherever possible

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

components/toggl/actions/get-time-entries/get-time-entries.mjs (2)

11-46: Good implementation of optional query parameters!

The addition of these optional properties aligns well with the Toggl Track API documentation. The properties are properly typed, labeled, and include clear descriptions explaining their purpose and format requirements.

One suggestion: Consider adding basic input validation for date formats and timestamp values to prevent API errors from malformed inputs. This would improve the user experience by catching errors early.

---

56-58: Properly implemented API call with parameters.

The parameters object is correctly passed to the getTimeEntries method. This implementation allows for flexible filtering of time entries based on user input.

Consider updating the action description at line 7 to mention the new filtering capabilities, as it currently only states "Get the last thousand time entries" without mentioning the available filtering options.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between a9f7999 and 1bd70bf.

📒 Files selected for processing (1)

• components/toggl/actions/get-time-entries/get-time-entries.mjs (1 hunks)

🔇 Additional comments (1)

components/toggl/actions/get-time-entries/get-time-entries.mjs (1)

49-55: Good parameter handling approach.

The implementation correctly:

1. Creates an empty params object
2. Conditionally adds parameters only when values are provided
3. Maps camelCase property names to snake_case parameter names for the API
4. Performs explicit type checking for boolean properties

This ensures the API only receives parameters that have actual values, matching the Toggl API expectations.