fix: idempotencyKey fixes

[ashleyww93]

No description provided.

[coderabbitai]

Walkthrough

The pull request introduces modifications to two utility classes in the data ingestion module: CollectionJobUtils and ProductJobUtils. The primary changes involve updating the handling of idempotency keys by using the idempotencyKeys.create() method from the Trigger.dev SDK. This approach replaces direct assignment of bulk operation IDs with an asynchronous key creation process. Additionally, logging improvements and task ID capturing have been implemented in the ProductJobUtils class.

Changes

File	Change Summary
src/modules/data-ingestion/collection.job.utils.ts	- Added import for idempotencyKeys from @trigger.dev/sdk/v3 - Modified scheduleConsumerJob method to use idempotencyKeys.create() for generating idempotency keys
src/modules/data-ingestion/product.job.utils.ts	- Added import for idempotencyKeys from @trigger.dev/sdk/v3 - Corrected logging typo from "schhedule" to "schedule" - Updated ProcessProductsTask.trigger() to capture task ID - Added new log statement to output task ID - Modified idempotency key generation using idempotencyKeys.create()

Possibly related PRs

• Logging fixes #93: Modifications to the scheduleConsumerJob method in the CollectionJobUtils class, involving similar idempotency key handling and logging enhancements.

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

🪧 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. (Beta)
• @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.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
12.5% Duplication on New Code

See analysis details on SonarQube Cloud

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (4)

src/modules/data-ingestion/collection.job.utils.ts (1)

65-65: Asynchronous creation of the idempotencyKey is sensible.
Using await idempotencyKeys.create(...) should help avoid collisions and enhance data integrity. Consider whether any fallback or error handling is needed if key creation fails.

src/modules/data-ingestion/product.job.utils.ts (3)

108-108: Corrected log wording.
Changing “schhedule” to “schedule” refines clarity. This minor fix improves readability without altering functionality.

---

123-123: Asynchronous idempotency key creation is consistent with best practices.
Awaiting key creation should help ensure uniqueness. Consider adding a fallback strategy if key generation fails or returns unexpected data.

---

127-127: Logging the returned task ID aids troubleshooting.
This new log statement provides valuable insights during debugging and monitoring. Consider masking it if it reveals sensitive information.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between e0f672c and 78b510b.

📒 Files selected for processing (2)

• src/modules/data-ingestion/collection.job.utils.ts (2 hunks)
• src/modules/data-ingestion/product.job.utils.ts (3 hunks)

🔇 Additional comments (3)

src/modules/data-ingestion/collection.job.utils.ts (1)

6-6: Import of idempotencyKeys is well-integrated.
No issues identified with adding this import statement, as it cleanly supports your new key creation approach.

src/modules/data-ingestion/product.job.utils.ts (2)

6-6: Additional imports successfully introduced.
The inclusion of idempotencyKeys and runs from @trigger.dev/sdk/v3 aligns with the new usage for asynchronous key generation and run management.

---

110-110: Capturing the task ID is a beneficial addition.
Storing the result in newTaskID allows for future reference, logging, or error handling opportunities.