Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Sequence type indirection support #1047

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

xor2003
Copy link

@xor2003 xor2003 commented Feb 27, 2020

In CORBA standard there is no any limitation to support indirection for sequence type.
Our customer's unknown ORB sends sequence type with indirection.
So I have implemented support indirection for sequence type.
This code is already working in production and
it is related to issue: During demarshaling CORBA sequence type indirection is not supported #879

Summary by CodeRabbit

  • New Features

    • Enhanced handling of recursive data types by supporting sequence and array types during extraction.
    • Expanded event-related data structures with additional types and an exception for improved error reporting.
  • Tests

    • Incorporated new tests to verify indirected sequence demarshaling.
    • Added supplemental binary test data for validating the updated functionality.

@jwillemsen jwillemsen added the needs review Needs to be reviewed label May 7, 2020
@xor2003 xor2003 force-pushed the indirect-sequence branch from be98f81 to f540208 Compare July 2, 2020 13:15
@xor2003 xor2003 force-pushed the indirect-sequence branch from f540208 to 04c9b18 Compare July 31, 2020 11:48
Copy link
Contributor

coderabbitai bot commented Feb 1, 2025

Walkthrough

The changes enhance the handling of recursive TypeCodes during demarshaling by adding support for sequence types. In the C++ extraction file, the tc_demarshal_indirection function now checks for both tk_sequence and tk_array, invoking the sequence factory when applicable. Additionally, the test suite has been expanded to include a new test for indirected sequences. This involves adding a binary data header, updating the client test to use a new stream setup, and extending the IDL with new types, structures, and an exception to support structured event processing.

Changes

File(s) Change Summary
TAO/tao/AnyTypeCode/TypeCode_CDR_Extraction.cpp Modified tc_demarshal_indirection to check for CORBA::tk_sequence (in addition to tk_array) and call tc_sequence_factory for proper sequence handling; updated comments regarding recursion and complex type checks.
TAO/tests/Any/Indirected/client.cpp,
TAO/tests/Any/Indirected/seq_indirection_bin.h,
TAO/tests/Any/Indirected/test.idl
Added a test for indirected sequence demarshaling: the client test now includes a new header and code block to demarshal a structured event from a binary stream; introduced a binary data constant and new IDL types, structures, and an exception.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Test Client
    participant Input as TAO_InputCDR
    participant Demarshal as tc_demarshal_indirection
    participant Factory as tc_sequence_factory
    participant Event as StructuredEvent

    Client->>Input: Initialize stream (big-endian, IIOP 1.2)
    Input->>Demarshal: Send binary data for demarshaling
    alt Type is tk_sequence or tk_array
        Demarshal->>Factory: Call tc_sequence_factory
        Factory-->>Demarshal: Return processed sequence data
    else Other types
        Demarshal-->>Demarshal: Process normally
    end
    Demarshal-->>Event: Return StructuredEvent object
    Event-->>Client: Event received successfully
Loading

Poem

I'm a rabbit hopping through code so neat,
Nibbling on sequences with a joyful beat,
Fields and factories dance in my burrow of bytes,
New tests and structures filling my nights,
Carrots and constants—oh, the coding delight!
🐇💻

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

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

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
TAO/tao/AnyTypeCode/TypeCode_CDR_Extraction.cpp (1)

1404-1411: Consider enhancing recursion handling and complex type support.

The TODO comment indicates areas for improvement:

  1. Verify if recursion is properly handled for sequences
  2. Evaluate the need for handling other complex types

Consider:

  1. Adding explicit recursion detection for sequences
  2. Documenting which other complex types might need similar handling
  3. Adding test cases for recursive sequences
TAO/tests/Any/Indirected/client.cpp (1)

235-244: Consider enhancing error reporting.

While the error handling is correct, the error message could be more descriptive.

Consider enhancing the error message to include more details:

-         "ERROR: Failed to demarshal indirected sequence\n"));
+         "ERROR: Failed to demarshal indirected sequence. Stream position: %d\n"),
+         strm.length()));
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6c3ca3f and 08d7e89.

📒 Files selected for processing (4)
  • TAO/tao/AnyTypeCode/TypeCode_CDR_Extraction.cpp (2 hunks)
  • TAO/tests/Any/Indirected/client.cpp (2 hunks)
  • TAO/tests/Any/Indirected/seq_indirection_bin.h (1 hunks)
  • TAO/tests/Any/Indirected/test.idl (1 hunks)
🔇 Additional comments (5)
TAO/tests/Any/Indirected/test.idl (2)

18-19: LGTM! Well-defined exception for sequence indirection testing.

The exception Sequence_Indirection_Test_Failed is appropriately defined for error handling during sequence indirection tests.


21-54: LGTM! Well-structured event definitions with proper sequence usage.

The event-related structures are well-designed with:

  • Clear type aliases for property names and values
  • Proper sequence definitions (PropertySeq, OptionalHeaderFields)
  • Comprehensive event structure with header and body
TAO/tao/AnyTypeCode/TypeCode_CDR_Extraction.cpp (1)

1395-1395: LGTM! Added sequence type support in kind checking.

The addition of tk_sequence to the kind check properly enables sequence type indirection support.

TAO/tests/Any/Indirected/seq_indirection_bin.h (1)

1-431: LGTM! Well-structured binary test data.

The binary test data is:

  • Well-commented with hex values for readability
  • Properly formatted for CORBA CDR encoding
  • Correctly sized with accurate length calculation
TAO/tests/Any/Indirected/client.cpp (1)

231-234: LGTM! Clear test section for sequence indirection.

The test setup is well-documented and properly separated from other tests.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs review Needs to be reviewed
Development

Successfully merging this pull request may close these issues.

2 participants