Skip to content

Conversation

@michelle0927
Copy link
Collaborator

@michelle0927 michelle0927 commented May 5, 2025

Resolves #16533

Summary by CodeRabbit

  • New Features

    • Added actions to retrieve persons, cohorts, and surveys from PostHog.
    • Introduced an action to create and execute HogQL queries on PostHog projects.
  • Improvements

    • Enhanced integration with options to limit the number of results returned.
    • Improved handling of paginated data for persons, cohorts, and surveys.
  • Chores

    • Updated package and component versions for improved compatibility and maintenance.

@vercel
Copy link

vercel bot commented May 5, 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 May 5, 2025 8:03pm
pipedream-docs ⬜️ Ignored (Inspect) May 5, 2025 8:03pm
pipedream-docs-redirect-do-not-edit ⬜️ Ignored (Inspect) May 5, 2025 8:03pm

@coderabbitai
Copy link
Contributor

coderabbitai bot commented May 5, 2025

"""

Walkthrough

This update introduces four new PostHog action modules for creating queries, retrieving persons, cohorts, and surveys, each leveraging new helper methods for paginated API access in the PostHog app integration. It also increments versions for existing actions and updates dependencies in the package manifest.

Changes

File(s) Change Summary
components/posthog/actions/create-query/create-query.mjs Added new "Create Query" action module to run HogQL queries via the PostHog API.
components/posthog/actions/get-cohorts/get-cohorts.mjs
components/posthog/actions/get-persons/get-persons.mjs
components/posthog/actions/get-surveys/get-surveys.mjs
Added new action modules for retrieving cohorts, persons, and surveys from PostHog, each supporting pagination and filtering.
components/posthog/posthog.app.mjs Added maxResults prop, and new methods listPersons, listCohorts, listSurveys, paginate, and iterateResults to support paginated fetching of resources from PostHog API.
components/posthog/actions/capture-event/capture-event.mjs
components/posthog/sources/new-action-performed/new-action-performed.mjs
Incremented version numbers in metadata for the "Capture Event" action and "New Action Performed" source.
components/posthog/package.json Bumped package version to 0.2.0 and updated @pipedream/platform dependency version.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant ActionModule
    participant PostHogApp
    participant PostHogAPI

    User->>ActionModule: Provide input parameters
    ActionModule->>PostHogApp: Call helper method (e.g., iterateResults or createQuery)
    PostHogApp->>PostHogAPI: Make API request (e.g., /queries, /persons, /cohorts, /surveys)
    PostHogAPI-->>PostHogApp: Return API response (possibly paginated)
    PostHogApp-->>ActionModule: Return processed results
    ActionModule-->>User: Return action output and summary
Loading

Assessment against linked issues

Objective Addressed Explanation
Add PostHog action for running queries via API (#16533)
Add actions for retrieving persons, cohorts, and surveys via PostHog API (#16533)
Use correct API endpoints and support pagination/filters as per PostHog API docs (#16533)

Suggested labels

action

Poem

A bunny with code on its mind,
Hopped through PostHog, new actions to find.
Persons, cohorts, surveys—oh my!
Queries now run with a hop and a try.
Version bumps and helpers galore,
This rabbit’s updates you can’t ignore!
🐇✨
"""

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/posthog/actions/get-cohorts/get-cohorts.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)

components/posthog/actions/get-persons/get-persons.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)

components/posthog/actions/get-surveys/get-surveys.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)


📜 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 031e534 and 9defd8d.

📒 Files selected for processing (3)
  • components/posthog/actions/get-cohorts/get-cohorts.mjs (1 hunks)
  • components/posthog/actions/get-persons/get-persons.mjs (1 hunks)
  • components/posthog/actions/get-surveys/get-surveys.mjs (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (3)
  • components/posthog/actions/get-surveys/get-surveys.mjs
  • components/posthog/actions/get-cohorts/get-cohorts.mjs
  • components/posthog/actions/get-persons/get-persons.mjs
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Verify TypeScript components
  • GitHub Check: Publish TypeScript components
✨ 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
🪧 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.

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: 3

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 5637c92 and 031e534.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (8)
  • components/posthog/actions/capture-event/capture-event.mjs (1 hunks)
  • components/posthog/actions/create-query/create-query.mjs (1 hunks)
  • components/posthog/actions/get-cohorts/get-cohorts.mjs (1 hunks)
  • components/posthog/actions/get-persons/get-persons.mjs (1 hunks)
  • components/posthog/actions/get-surveys/get-surveys.mjs (1 hunks)
  • components/posthog/package.json (2 hunks)
  • components/posthog/posthog.app.mjs (3 hunks)
  • components/posthog/sources/new-action-performed/new-action-performed.mjs (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: pnpm publish
  • GitHub Check: Verify TypeScript components
  • GitHub Check: Publish TypeScript components
🔇 Additional comments (11)
components/posthog/package.json (2)

3-3: Version update reflects the addition of new actions

The package version increment from 0.1.0 to 0.2.0 is appropriate since this PR introduces multiple new PostHog actions.


16-16: Platform dependency updated to latest version

The update to @pipedream/platform from ^1.6.4 to ^3.0.3 indicates a significant platform update. This is appropriate, especially if the new actions utilize newer platform capabilities.

components/posthog/actions/capture-event/capture-event.mjs (1)

7-7: Version increment for consistency

The minor version bump from 0.0.1 to 0.0.2 maintains versioning consistency with the other PostHog components being updated in this PR.

components/posthog/sources/new-action-performed/new-action-performed.mjs (1)

8-8: Version increment for consistency

The minor version bump from 0.0.1 to 0.0.2 maintains versioning consistency with the other PostHog components being updated in this PR.

components/posthog/actions/get-surveys/get-surveys.mjs (2)

1-38: Well-structured PostHog action component

The component follows Pipedream's standard structure with proper organization of imports, metadata, and props. The dependency injection of the PostHog app and the hierarchical relationship between organizationId and projectId are correctly implemented.


40-50: Good use of pagination helpers

The use of the iterateResults helper with the listSurveys function demonstrates good practice for handling paginated API responses, ensuring all results are collected while respecting the maxResults limit.

components/posthog/actions/create-query/create-query.mjs (1)

1-53: Well-structured new PostHog action for creating queries

The implementation follows Pipedream's action component best practices with clear prop definitions and proper API integration. The component handles the creation of HogQL queries with appropriate project context and optional naming.

components/posthog/posthog.app.mjs (4)

63-69: LGTM: Well-defined maxResults property

The addition of a standard maxResults property with appropriate defaults will help maintain consistency across actions.


111-134: LGTM: Well-implemented API methods for listing resources

The new methods for listing persons, cohorts, and surveys follow the established pattern and will provide consistent access to PostHog resources.


151-176: LGTM: Efficient pagination implementation

The pagination implementation correctly handles offset-based pagination and respects the maximum results limit.


177-184: LGTM: Helper method for collecting paginated results

The iterateResults method provides a convenient way to collect all paginated items into a single array.

Copy link
Collaborator

@GTFalcao GTFalcao left a comment

Choose a reason for hiding this comment

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

LGTM!

@michelle0927 michelle0927 merged commit d9950a6 into master May 7, 2025
11 checks passed
@michelle0927 michelle0927 deleted the issue-16533 branch May 7, 2025 14:37
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.

[ACTION] Posthog Query

3 participants