chore: add more logging

[ashleyww93]

No description provided.

[coderabbitai]

Walkthrough

The pull request introduces modifications to two TypeScript files: product.job.utils.ts and tools.resolver.ts. The changes primarily focus on enhancing the logging and job scheduling mechanisms within the ProductJobUtils and ToolsResolver classes. The modifications involve updating the scheduleTriggerJob method with improved object structuring and adding logging configuration to provide more detailed insights during job execution.

Changes

File	Change Summary
src/modules/data-ingestion/product.job.utils.ts	Updated scheduleTriggerJob method with explicit object structure for pendingRuns array and enhanced console logging
src/modules/tools/tools.resolver.ts	Modified forceSync method to include logging configuration when calling ProductJobUtils.scheduleTriggerJob

Sequence Diagram

sequenceDiagram
    participant Resolver as ToolsResolver
    participant JobUtils as ProductJobUtils
    participant Logger as Console Logger

    Resolver->>JobUtils: scheduleTriggerJob()
    JobUtils->>Logger: Log info/warn/error
    JobUtils-->>Resolver: Job scheduling result

Loading

The sequence diagram illustrates the interaction between ToolsResolver, ProductJobUtils, and the logging mechanism, showing how the logging configuration is passed and used during job scheduling.

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
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (3)

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

44-49: Consider utilising the logger instead of console.log.
Whilst this block is functionally correct, using console.log for production logging can clutter outputs and make logs harder to manage. You might want to rely on the provided LogsInterface or a unified logging mechanism for consistency and enhanced maintainability.

src/modules/tools/tools.resolver.ts (2)

90-94: Abstract repeated inline logging.
Defining these arrow functions directly here is acceptable; however, they appear again below, essentially duplicating the same logic. You could consider creating a helper function or reusing an existing logger interface to reduce duplication and improve maintainability.

---

96-100: Revisit duplicated logging code.
Similarly to the previous lines, you are repeating the same arrow functions for info, warn, and error. If you plan to incorporate further logging enhancements, centralising or abstracting this logger configuration could simplify future changes.

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 8ef2142 and bd65b18.

📒 Files selected for processing (2)

• src/modules/data-ingestion/product.job.utils.ts (1 hunks)
• src/modules/tools/tools.resolver.ts (1 hunks)