Skip to content

fix: correct criteria format for nlp value update #940

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Apr 25, 2025
Merged

fix: correct criteria format for nlp value update #940

merged 2 commits into from
Apr 25, 2025

Conversation

MohamedAliBouhaouala
Copy link
Contributor

@MohamedAliBouhaouala MohamedAliBouhaouala commented Apr 17, 2025 •
edited
Loading

Motivation

The handleValueCreate method in NlpService was attempting to update an NlpValue using:

await this.nlpValueService.updateOne(value._id, { foreign_id });

This resulted in the following runtime error:

Error: Unable to update NlpValue with criteria "6800e0d8ed7525d44ffd1e7e"

The updateOne method in the base repository expects a filter object, such as: { _id: value._id }
However, the code was incorrectly passing only the document's ID directly, not wrapped in an object.
Additionally, since value is a Mongoose document (NlpValueDocument), passing it without converting or wrapping can lead to unexpected behavior when matching criteria, especially if the repository expects plain JavaScript objects.

Moreover, the same thing is valid for the handleEntityCreate method in NlpService. Furthermore, post-create is never triggered in the NlpEntityRepository because of an invalid condition that is never true.

async postCreate(_created: NlpEntityDocument): Promise<void> {
    if (!_created) {
      // Bypass builtin entities (probably fixtures)
      this.eventEmitter.emit('hook:nlpEntity:create', _created);
    }
  }

Fixes # (934, 942)

Type of change:

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added unit tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

Summary by CodeRabbit

  • Bug Fixes

    • Improved handling of entity and value updates to ensure correct data matching.
    • Adjusted logic to emit creation events only for non-built-in entities, preventing unnecessary event emissions for built-in types.

  • Chores

    • Updated copyright year to 2025.

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Apr 17, 2025 •
edited
Loading

Walkthrough

The update modifies the handleEntityCreate and handleValueCreate methods within the NlpService class to change the updateOne calls by passing an object filter { _id: entity._id } or { _id: value._id } instead of just the ID. In the NlpEntityRepository class, the postCreate method's condition was changed to emit creation events only for non-built-in entities by checking if (!_created.builtin) instead of if (!_created). The copyright year in the nlp.service.ts file header was updated from 2024 to 2025. No changes were made to exported or public entity signatures.

Changes

File(s) Change Summary
api/src/nlp/services/nlp.service.ts Updated copyright year to 2025; changed updateOne calls in handleEntityCreate and handleValueCreate to use object filters.
api/src/nlp/repositories/nlp-entity.repository.ts Modified postCreate method to emit creation event only for non-built-in entities by checking _created.builtin.

Poem

A hop and a skip, a filter anew,
The year hops forward—twenty twenty-five too!
With object in hand, the update is neat,
For values and IDs now properly meet.
The code is refreshed, the logic precise—
Another small change, another byte of nice!
🐇✨

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 UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b04673f and 7632866.

📒 Files selected for processing (2)
  • api/src/nlp/repositories/nlp-entity.repository.ts (1 hunks)
  • api/src/nlp/services/nlp.service.ts (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • api/src/nlp/services/nlp.service.ts
⏰ Context from checks skipped due to timeout of 90000ms (3)
  • GitHub Check: API-Tests
  • GitHub Check: Frontend Tests
  • GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (1)
api/src/nlp/repositories/nlp-entity.repository.ts (1)

50-55: Good fix - correctly implementing the documented behavior for built-in entities.

The change from if (!_created) to if (!_created.builtin) properly aligns the implementation with both the method documentation and the behavior of other methods in this class. Now the postCreate method correctly bypasses event emission for built-in entities instead of checking if the document exists (which wouldn't make sense in a post-create hook).

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

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.

This was linked to issues Apr 17, 2025
🤔 [ISSUE] - Nlp Service: Error Syncing Deleted NLP Entity #942
Closed
[ISSUE] NlpService : Error Syncing New NLP Intent Value #934
Closed
@yassinedorbozgithub yassinedorbozgithub merged commit f20fed6 into main Apr 25, 2025
6 checks passed
@medchedli medchedli added this to the v2.2.6 milestone Apr 25, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@medchedli medchedli medchedli approved these changes

@abdou6666 abdou6666 abdou6666 approved these changes

@IkbelTalebHssan IkbelTalebHssan IkbelTalebHssan approved these changes

@yassinedorbozgithub yassinedorbozgithub yassinedorbozgithub approved these changes

Assignees
No one assigned
Labels
needs-review v2.2.6
Projects
None yet
Milestone
v2.2.6
5 participants
@MohamedAliBouhaouala @medchedli @abdou6666 @IkbelTalebHssan @yassinedorbozgithub