Print nested arrays for logged recognition output

[djak250]

JSON.stringify the loggedOutput object to keep helpful information like box and checks in the logs

Summary by CodeRabbit

• Bug Fixes
  • Improved logging readability by formatting nested structures in the output for better debugging insights.

[coderabbitai]

Walkthrough

The recent changes enhance the logging functionality in the recognize.controller.js file. By replacing direct logging of objects with a formatted JSON string, the output becomes significantly clearer and easier to read. This adjustment retains the method's original logic while improving the debugging experience, particularly for nested structures.

Changes

Files	Change Summary
api/src/controllers/recognize.controller.js	Improved logging in the start method by using JSON.stringify for better readability of nested structures.

Poem

🐰 In the code where rabbits roam,
A log now shines, a clearer home.
JSON strings, so neat and bright,
Help us see the data's light.
Hooray for changes, let them be,
Debugging joy for you and me! 🌟

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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 resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 0227b0c and ba66def.

Files selected for processing (1)

• api/src/controllers/recognize.controller.js (1 hunks)

Files skipped from review due to trivial changes (1)

• api/src/controllers/recognize.controller.js

[djak250]

At present, the logs are lacking some important information for events due to JS not deeply printing the object.
Ex:

info: {
  id: 'c28a...17',
  duration: 0.18,
  timestamp: '2024-08-05T18:20:08.803Z',
  attempts: 1,
  camera: 'manual',
  zones: [],
  counts: { person: 1, match: 0, miss: 0, unknown: 1 },
  matches: [],
  misses: [],
  unknowns: [
    {
      name: 'unknown',
      confidence: 0,
      match: false,
      box: [Object],         /// Here
      checks: [Array],      /// and Here
      type: 'manual',
      duration: 0.15,
      detector: 'aiserver',
      filename: '66c6..3b10.jpg'
    }
  ]
}

[djak250]

Logs after this change

info: {
  "id": "1722...du",
  "duration": 17.15,
  "timestamp": "2024-08-05T19:07:21.418Z",
  "attempts": 18,
  "camera": "south",
  "zones": [
    "garage"
  ],
  "counts": {
    "person": 0,
    "match": 0,
    "miss": 0,
    "unknown": 0
  },
  "matches": [],
  "misses": [],
  "unknowns": [
    {
      "name": "unknown",
      "confidence": 0,
      "match": false,
      "box": {                  /// Helpful information
        "top": 63,
        "left": 180,
        "width": 36,
        "height": 54
      },
      "checks": [
        "confidence too low: 0 < 40" /// Now I know why it didn't match
      ],
      "type": "snapshot",
      "duration": 0.13,
      "detector": "aiserver",
      "filename": "953e...fb00.jpg"
    }
  ]
}

[github-actions]

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.

[djak250]

@skrashevich Any thoughts about merging this?

[skrashevich]

@skrashevich Any thoughts about merging this?

Please, rebase to beta branch

[github-actions]

This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.