test: add comprehensive unit tests for OTEL traces flattening functionality.

[vkhinvasara]

Fixes ##1198.

Add Comprehensive Unit Tests for OTEL Traces Flattening

Primary Objective

Add extensive unit test coverage to validate and document the specialized flattening behavior for OpenTelemetry traces data in Parseable's log analytics platform.

Key Deliverables

• Complete test coverage for all flattening functions.
• Validation of data sanity across flattening operations.
• Ensuring nested data structure flattening.

TL;DR: Added basic unit tests for a good variety of flattening operations in traces.rs.

Summary by CodeRabbit

• Tests
  • Added comprehensive unit tests to verify the correctness of trace data flattening, including status codes, span kinds, flags, events, links, and field encodings. No changes were made to the app’s core functionality.

[coderabbitai]

Walkthrough

A comprehensive test module was added under a conditional compilation flag to verify the correctness of the flattening functions for OpenTelemetry trace data structures. The tests cover mapping, encoding, and flattening behaviors for various trace components. No changes were made to the core logic or public API; only new tests were introduced.

Changes

File(s)	Change Summary
src/otel/traces.rs	Added a test module with multiple unit tests for flattening functions, covering mapping, encoding, and structure validation. No production code changes.

Sequence Diagram(s)

sequenceDiagram
    participant Test as Test Module
    participant Flatten as Flatten Functions
    participant Output as JSON Map/Object

    Test->>Flatten: Call flattening function with sample trace data
    Flatten->>Output: Produce flattened JSON map/object
    Test->>Output: Assert expected fields, values, and encodings

Loading

Possibly related PRs

• fix: otel traces flattening fix #1196: Adds comprehensive tests for flattening functions in src/otel/traces.rs without changing core logic.
• fix: otel traces flattening fix #1196: Modifies flattening logic in the same file to fix handling of empty events or links, which the new tests likely cover.

Poem

In the warren of code, we test and we check,
Trace IDs and spans, all neat on the deck.
With every new case, our confidence grows,
Events and links, in tidy rows.
A rabbit’s delight: all fields in line—
Flattened and tested, everything’s fine! 🐇

---

📜 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 b93ae42 and 0c5af9f.

📒 Files selected for processing (1)

• src/otel/traces.rs (1 hunks)

🔇 Additional comments (6)

src/otel/traces.rs (6)

339-372: Excellent test module structure and helper functions.

The test module is well-organized with useful helper functions that create realistic test data. The conditional compilation flag ensures tests don't affect production code.

---

374-464: Comprehensive mapping function tests with good edge case coverage.

The tests for status codes, span kinds, and flags mappings are thorough and include both valid values and edge cases (unknown codes). The test structure is clear and assertions are specific.

---

466-552: Well-designed structure flattening tests.

The tests for events and links flattening properly validate all expected fields, attribute handling, and hex encoding. Good coverage of both populated and empty attribute cases.

---

554-663: Excellent span record flattening test coverage.

The tests cover both scenarios (with and without events/links) and properly validate that span-level information is preserved across all generated records. The assertions are comprehensive and meaningful.

---

665-713: Valuable hex encoding consistency validation.

This test ensures consistent lowercase hex encoding across all ID fields (trace_id, span_id, parent_span_id) and verifies the behavior in both span records and links. Using specific byte values provides deterministic test results.

---

715-819: Comprehensive integration test for complete flattening pipeline.

This test validates the entire flattening flow from TracesData down to individual field values, covering resource, scope, and span levels. Excellent end-to-end verification.

✨ 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

• 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.
  • Explain this complex logic.
  • 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 explain this code block.
  • @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 explain its main purpose.
  • @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.

[github-actions]

CLA Assistant Lite bot:
Thank you for your submission, we really appreciate it. Like many open-source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution. You can sign the CLA by just posting a Pull Request Comment same as the below format.

---

I have read the CLA Document and I hereby sign the CLA

---

_{You can retrigger this bot by commenting recheck in this Pull Request}