fix:[CUS-297] Resource Id migration to _docid

santhosh-challa commented 3 weeks ago

Description

Problem

Currently, data is being fetched from Elastic using _resourceid. As _resourceid is not unique for assets globally, this causes data integrity issues

Solution

Migrated the data fetching mechanism to use _docid instead, which is globally unique for assets. This ensures that each asset is uniquely identified and resolves the data integrity issues.

Issues fixed in this PR:

Updated the Filters for Asset Id to start using _docid
Updated the Asset Id link for notification request
Added _docid for recommendations asset type
Fixed the duplicate data being inserted into Global Search seed table.

Type of change

[X] Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

It was tested in the saasdev by copying the jars. All the UI screens look good to me.

Checklist:

[X] My code follows the style guidelines of this project
[X] My commit message/PR follows the contribution guidelines of this project
[X] I have performed a self-review of my code
[X] I have commented my code, particularly in hard-to-understand areas
[ ] I have added tests that prove my fix is effective or that my feature works
[ ] New and existing unit tests pass locally with my changes

Other Information:

List any documentation updates that are needed for the Wiki

Summary by CodeRabbit

New Features
- Enhanced search and linking capabilities with the introduction of _docid.
Improvements
- Updated asset and recommendation uploads now use _docid for better consistency and tracking.
- Refactored variable names and logging messages for improved clarity and maintainability.
Bug Fixes
- Fixed inconsistencies in pac_v2_ui_options by updating it based on flag status.
Chores
- Added new constants and adjusted method implementations to align with _docid changes.

coderabbitai[bot] commented 3 weeks ago

Walkthrough

Significant updates have been made to the database schema and Java code used in the PacBot application. The primary change involves replacing the usage of RESOURCE_ID with DOC_ID across various components for consistency and improved functionality. New constants were introduced, method implementations were improved for clarity, and a new procedure for updating flags was created.

Changes

File Path	Change Summary
`installer/resources/pacbot_app/files/DB.sql`	Added `_docid` to `cf_pac_updatable_fields`, `OmniSearch_Config`, and `pac_v2_ui_options`. Created `cf_UpdateFlag` table and a procedure for updating based on flags.
`jobs/pacman-rule-engine-2.0/src/main/.../NotificationUtils.java`	Changed `setResourceIdLink` method to use `DOC_ID` instead of `RESOURCE_ID`.
`jobs/recommendation-enricher/src/main/java/.../RecommendationCollector.java`	Added new constants, refactored variable names, and made minor adjustments to method implementations for better readability and maintainability.

Sequence Diagram(s)

sequenceDiagram
    participant DB as Database
    participant App as PacBot Application
    participant Notify as NotificationUtils
    participant Rec as RecommendationCollector

    Note over DB, App: Initialization and Setup
    DB->>DB: Update `cf_pac_updatable_fields` with `_docid`
    DB->>DB: Update `OmniSearch_Config` and `pac_v2_ui_options` with `_docid`
    DB->>DB: Create `cf_UpdateFlag` table & procedure

    Note over App: Notification Process
    Notify->>App: Construct resource link with `DOC_ID`

    Note over Rec: Recommendation Process
    Rec->>App: Use constants for IDs and doc types
    Rec->>App: Improved logging and refactored variable names

Poem

Amidst the code where devs abide,
A bunny hops with joy and pride.
DOC_ID reigns over RESOURCE_ID's land,
To make PacBot’s queries ever so grand.
Tables are updated, flags are set,
Code now reads clearer, on that you can bet!

[!TIP]

AI model upgrade
## `gpt-4o` model for reviews and chat is now live OpenAI claims that this model is better at understanding and generating code than the previous models. Please join our [Discord Community](https://discord.com/invite/GsXnASn26c) to provide any feedback or to report any issues.

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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.