HubSpot (patch) cache properties per HubSpot portal

[jirihofman]

Followup to #449

• cache properties per hub_id. The same way as we differentiate trigger subscriptions.

Summary by CodeRabbit

• New Features

  • Added support for custom and additional properties when creating or updating contacts and deals.
  • Introduced caching for contact and deal properties, with configuration options available in connector settings.

• Improvements

  • Output variables for contact retrieval now align with selected input properties, providing more accurate results.
  • Enhanced cache handling to segregate property data per HubSpot portal for improved data accuracy.

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

"""

Walkthrough

This change updates the HubSpot connector bundle version and its changelog to document recent enhancements. The internal caching mechanism for HubSpot object properties now incorporates the user's HubSpot portal ID into cache keys, ensuring cache segregation per portal. Corresponding tests have been updated to simulate and verify this behavior by including the portal ID in the context and asserting the correct cache key format.

Changes

Files/Paths	Change Summary
src/appmixer/hubspot/bundle.json	Incremented bundle version to 4.1.2 and updated changelog to describe support for custom properties, caching improvements, and output variable enhancements.
src/appmixer/hubspot/commons.js	Modified cache key construction in property caching to include the HubSpot portal ID for per-portal cache segregation.
test/hubspot/commons.test.js	Updated test setup to include portal ID in context and added assertions to verify cache key includes portal ID.

Possibly related PRs

• HubSpot (patch) - Add properties field for some triggers #425: Adds a properties field to triggers for contact and deal components to specify which properties to fetch, related to property handling in HubSpot components.

Suggested reviewers

• vtalas
  """

---

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.

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

[coderabbitai]

Actionable comments posted: 1

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6d6c6db and 006af04.

📒 Files selected for processing (3)

• src/appmixer/hubspot/bundle.json (2 hunks)
• src/appmixer/hubspot/commons.js (1 hunks)
• test/hubspot/commons.test.js (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*/bundle.json`: Every pull request should include changes to the related `bundle.json` file. This file contains version information, so all changes must also include a version ...

**/*/bundle.json: Every pull request should include changes to the related bundle.json file. This file contains version information, so all changes must also include a version update.

• src/appmixer/hubspot/bundle.json

🔇 Additional comments (4)

test/hubspot/commons.test.js (2)

15-15: Appropriate test context setup

Good addition of the HubSpot portal ID to the test context, which properly simulates the authentication context with a hub_id value.

---

62-64: Good test assertion for cache key

This assertion correctly verifies that the cache key includes the HubSpot portal ID, ensuring proper cache segregation per portal. The test is well-designed to validate the key functionality added in this PR.

src/appmixer/hubspot/bundle.json (2)

3-3: Version increment follows semantic versioning

The version change from 4.1.1 to 4.1.2 correctly follows semantic versioning for a patch release, which is appropriate for the improvements made.

---

64-68: Comprehensive changelog entry

The changelog entry effectively communicates the improvements made in this version, including the caching enhancement for Contact and Deal properties with configurability in connector settings.