Resolve Database Inconsistency for APP_ATTRIBUTE in Oracle 19c

[ShakyaPr]

Purpose

This PR addresses a JWTTest failure encountered during integration testing when using Oracle 19c as the database. The failure occurs due to a discrepancy in how Oracle 19c handles empty values compared to other databases.

• Resolves: wso2/api-manager/issues/3846

Approach

• Issue with Oracle 19c: In Oracle, when an optional attribute has an empty value, the APP_ATTRIBUTE column is stored as NULL. This contrasts with other databases, which return an empty string ("") when the value is empty.

• Impact: The difference in handling empty values between Oracle and other databases causes inconsistencies in the returned response, leading to test failures during integration.

• Solution:

  • A validation step was added to check if the APP_ATTRIBUTE value is NULL. If so, it is set to an empty string ("").
  • This ensures consistent behavior across different database types and resolves the issue by standardizing the response.

By implementing this change, we can ensure database consistency and eliminate the discrepancies between Oracle and other databases.

Test Cases

• The issue has been validated and resolved for Oracle 19c, and failed integration tests have passed successfully after the fix.

Conclusion

This change improves database consistency across different database platforms (Oracle and others), ensuring a stable and predictable response during JWT tests.

[coderabbitai]

📝 Walkthrough

"""

Walkthrough

The changes update the getApplicationAttributes method in the ApiMgtDAO class to handle null values for the "APP_ATTRIBUTE" column by assigning an empty string when the retrieved value is null. Additionally, the OAS2Parser and OAS3Parser classes are modified to add null checks and fallback logic for the Swagger/OpenAPI Info object during API definition generation and validation. When the Info object is missing, new Info instances with default or randomly generated metadata values are created to prevent null pointer exceptions and ensure valid metadata downstream.

Changes

File	Change Summary
components/apimgt/org.wso2.carbon.apimgt.impl/.../ApiMgtDAO.java	Updated getApplicationAttributes to check for a null APP_ATTRIBUTE value and assign an empty string instead of a null value in the attributes map.
components/apimgt/org.wso2.carbon.apimgt.impl/.../OAS2Parser.java	Added null checks and fallback logic for missing Swagger Info object in generateAPIDefinition and validateAPIDefinition methods to avoid NPEs.
components/apimgt/org.wso2.carbon.apimgt.impl/.../OAS3Parser.java	Added null checks and fallback logic for missing OpenAPI Info object in generateAPIDefinition and validateAPIDefinition methods; added UUID import.

Sequence Diagram(s)

sequenceDiagram
    participant C as Caller
    participant DAO as ApiMgtDAO.getApplicationAttributes
    participant RS as ResultSet

    C->>+DAO: Call getApplicationAttributes()
    DAO->>+RS: Execute query to retrieve APP_ATTRIBUTE
    RS-->>-DAO: Return APP_ATTRIBUTE value
    alt APP_ATTRIBUTE is not null
        DAO->>DAO: Use the returned value
    else APP_ATTRIBUTE is null
        DAO->>DAO: Set empty string for APP_ATTRIBUTE
    end
    DAO-->>-C: Return application attributes map

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Ensure APP_ATTRIBUTE returns an empty string instead of null for Oracle 19c (issue #3846)	✅
"""

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between afc2563 and 8589de3.

📒 Files selected for processing (2)

• components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/definitions/OAS2Parser.java (3 hunks)
• components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/definitions/OAS3Parser.java (3 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (1)

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/definitions/OAS3Parser.java (1)

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/definitions/OASParserUtil.java (1)

• OASParserUtil (132-2339)

⏰ Context from checks skipped due to timeout of 90000ms (6)

• GitHub Check: build-product (3, group3)
• GitHub Check: build-product (4, group4)
• GitHub Check: build-product (2, group2)
• GitHub Check: run-benchmark-test
• GitHub Check: build-product (1, group1)
• GitHub Check: build-carbon

🔇 Additional comments (6)

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/definitions/OAS3Parser.java (3)

94-94: Added UUID import for new fallback logic.

This import supports the newly added fallback pattern where random UUIDs are generated as placeholder values when the OpenAPI Info object is missing.

---

727-735: Added null check for OpenAPI Info object with proper fallback mechanism.

This defensive coding addition prevents NullPointerExceptions when an OpenAPI definition doesn't contain an Info section. When null is detected, a new Info object is created with title and version from swaggerData, ensuring downstream code has valid metadata to work with.

---

861-874: Added robust null handling for Info object during validation.

This change adds fallback logic to handle cases where the Info object is null during API definition validation. When relaxed validation is enabled, it generates random placeholder values for title, context, version, and description using UUIDs. This prevents NullPointerExceptions and ensures that valid metadata is always available downstream.

components/apimgt/org.wso2.carbon.apimgt.impl/src/main/java/org/wso2/carbon/apimgt/impl/definitions/OAS2Parser.java (3)

99-99: Adding import for UUID generation for null metadata handling.

The UUID import is appropriately added to support random placeholder generation for Swagger metadata when Info object is null.

---

628-636: Improved error handling for null Info object in generateAPIDefinition.

This change properly handles cases where the Swagger Info object is null by creating a new Info instance with title and version from swaggerData. This prevents potential NullPointerExceptions in downstream processing.

---

731-747: Enhanced null handling for metadata during API definition validation.

This enhancement improves the robustness of the validation process by generating random placeholder values when the Info object is null. The added fallback logic prevents null assignments and ensures downstream components receive valid response attributes, which is particularly important when handling database inconsistencies like those observed with Oracle 19c.

The generated metadata is appropriately prefixed with identifiers (e.g., "API-Title-") to make it clear these are placeholder values rather than actual content.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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

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.