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

[NU-1893] Fix "Failed to get node validation" when opening fragment node details for referencing non-existing fragment #7190

Merged
merged 3 commits into from
Nov 21, 2024

Conversation

arkadius
Copy link
Member

@arkadius arkadius commented Nov 21, 2024

…ode details for referencing non-existing fragment

Describe your changes

Checklist before merge

  • Related issue ID is placed at the beginning of PR title in [brackets] (can be GH issue or Nu Jira issue)
  • Code is cleaned from temporary changes and commented out lines
  • Parts of the code that are not easy to understand are documented in the code
  • Changes are covered by automated tests
  • Showcase in dev-application.conf added to demonstrate the feature
  • Documentation added or updated
  • Added entry in Changelog.md describing the change from the perspective of a public distribution user
  • Added MigrationGuide.md entry in the appropriate subcategory if introducing a breaking change
  • Verify that PR will be squashed during merge

Summary by CodeRabbit

Release Notes

  • New Features

    • Introduced a new Activities panel consolidating scenario activities into a single list.
    • Added scenario labels for better organization and retrieval.
    • Enhanced SpEL with new navigation capabilities and conversion methods.
  • Bug Fixes

    • Improved error handling for non-existing fragments in the fetchLatestFragment method, returning None instead of throwing an error.
    • Added validation for fragment input nodes referencing non-existing fragments.
    • Enhanced validation for nodes and properties, including checks for invalid values.
    • Updated validation logic to return appropriate responses for non-existent fragments.
  • Documentation

    • Updated changelog to reflect new features, improvements, and security fixes.

…ode details for referencing non-existing fragment
@github-actions github-actions bot added the docs label Nov 21, 2024
Copy link

coderabbitai bot commented Nov 21, 2024

📝 Walkthrough
📝 Walkthrough

Walkthrough

The pull request introduces significant modifications to the FragmentRepository trait and its implementation in the DefaultFragmentRepository class, particularly focusing on the fetchLatestFragment method. The error handling mechanism has been updated to adopt a more functional programming style, replacing the previous exception-throwing approach with a method that utilizes flatMap and sequence. This change allows for a more idiomatic handling of the absence of a process ID without throwing an error. The method now maps the result of fetchProcessId to a call to fetchLatestProcessDetailsForProcessId, utilizing sequence to manage potential missing values.

Additionally, a new test case has been added to the FragmentRepositorySpec class to verify the behavior of fetchLatestFragment when a non-existing fragment is requested, ensuring that it returns None for such cases. The changelog has also been updated to reflect these changes along with other enhancements and fixes in version 1.18, including UI improvements and updates to various functionalities. The overall changes indicate a shift towards improved error handling and validation processes within the fragment management system.

Possibly related PRs

Suggested labels

ui, client

Suggested reviewers

  • mateuszkp96

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 1c7eac2 and f1b06d4.

📒 Files selected for processing (1)
  • docs/Changelog.md (1 hunks)
🔇 Additional comments (1)
docs/Changelog.md (1)

109-109: LGTM! Clear and well-formatted changelog entry.

The changelog entry accurately describes the bug fix and follows the standard format with proper PR reference.


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

@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

🧹 Outside diff range and nitpick comments (2)
designer/server/src/test/scala/pl/touk/nussknacker/ui/process/fragment/FragmentRepositorySpec.scala (1)

40-42: Consider adding more test cases for comprehensive coverage.

The test case effectively verifies the new behavior for non-existing fragments. However, consider adding these additional test cases to ensure robust error handling:

  1. Fragment name with special characters
  2. Empty fragment name
  3. Multiple concurrent requests for the same non-existing fragment

Example test case:

it should "handle fragment names with special characters" in {
  fragmentRepository
    .fetchLatestFragment(ProcessName("non/existing@fragment"))(adminUser)
    .futureValue shouldBe None
}
docs/Changelog.md (1)

106-106: LGTM! Consider adding more details about the fix.

The changelog entry correctly documents the fix for fragment node validation. However, consider expanding the description to provide more context about:

  • What caused the validation failure
  • How it was fixed
  • Impact on users who may be affected by this issue

Example of more detailed entry:

-* [#7190](https://github.com/TouK/nussknacker/pull/7190) Fix "Failed to get node validation" when opening fragment node details for referencing non-existing fragment 
+* [#7190](https://github.com/TouK/nussknacker/pull/7190) Fix "Failed to get node validation" error that occurred when opening fragment node details that referenced a non-existing fragment. The validation now properly handles missing fragment references and provides a clear error message to users.
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 2a4713b and 668543e.

📒 Files selected for processing (4)
  • designer/server/src/main/scala/pl/touk/nussknacker/ui/process/fragment/FragmentRepository.scala (2 hunks)
  • designer/server/src/test/scala/pl/touk/nussknacker/ui/process/fragment/FragmentRepositorySpec.scala (2 hunks)
  • docs/Changelog.md (1 hunks)
  • scenario-compiler/src/test/scala/pl/touk/nussknacker/engine/compile/NodeDataValidatorSpec.scala (1 hunks)
🔇 Additional comments (4)
designer/server/src/test/scala/pl/touk/nussknacker/ui/process/fragment/FragmentRepositorySpec.scala (1)

8-8: LGTM!

The import is correctly placed and necessary for the new test case.

designer/server/src/main/scala/pl/touk/nussknacker/ui/process/fragment/FragmentRepository.scala (2)

3-3: LGTM: Appropriate addition of cats traverse operations

The addition of cats traverse operations aligns well with the shift towards more functional error handling.


48-50: LGTM: Improved error handling with functional approach

The new implementation elegantly handles non-existing fragments using functional programming constructs. This fixes the validation failure issue by properly propagating None instead of throwing exceptions.

Consider adding a comment explaining the transformation chain for better maintainability:

 override def fetchLatestFragment(
     fragmentName: ProcessName
 )(implicit user: LoggedUser): Future[Option[CanonicalProcess]] = {
   processRepository
     .fetchProcessId(fragmentName)
+    // Transform Future[Option[ProcessId]] to Future[Option[CanonicalProcess]] by:
+    // 1. For each ProcessId, fetch process details
+    // 2. Sequence the nested Option to handle missing processes
+    // 3. Flatten the result to remove unnecessary nesting
     .flatMap(_.map(processRepository.fetchLatestProcessDetailsForProcessId[CanonicalProcess]).sequence.map(_.flatten))
     .map(_.map(_.json))
 }

Let's verify the return types of the repository methods to ensure our assumptions are correct:

✅ Verification successful

Verified: Return types match the implementation assumptions

The search results confirm that both methods return Future[Option[_]]:

  • fetchProcessId returns Future[Option[ProcessId]] (see FetchingProcessRepository trait)
  • fetchLatestProcessDetailsForProcessId returns Future[Option[ScenarioWithDetailsEntity[PS]]] (see FetchingProcessRepository trait)

This validates that the functional transformation chain in the implementation is correct and properly handles the Option monad through the sequence operation.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Search for the method declarations in the repository
ast-grep --pattern 'def fetchProcessId($_): Future[Option[$_]]'
ast-grep --pattern 'def fetchLatestProcessDetailsForProcessId[$_]($_): Future[Option[$_]]'

Length of output: 158


Script:

#!/bin/bash
# Let's try a broader search for these method signatures
rg -A 2 "def fetchProcessId" 
rg -A 2 "def fetchLatestProcessDetailsForProcessId"

# Also search for trait/class definitions containing these methods
ast-grep --pattern 'trait ProcessRepository {
  $$$
}'

ast-grep --pattern 'class $_ extends ProcessRepository {
  $$$
}'

Length of output: 4819

scenario-compiler/src/test/scala/pl/touk/nussknacker/engine/compile/NodeDataValidatorSpec.scala (1)

500-519: Well-structured test case that addresses the core issue!

The test effectively verifies the handling of non-existing fragment references, ensuring that:

  1. A proper business error (UnknownFragment) is returned instead of a technical failure
  2. The error contains both the fragment ID and the node ID for clear error reporting

This aligns perfectly with the PR's objective of fixing the "Failed to get node validation" error.

Copy link
Contributor

created: #7191
⚠️ Be careful! Snapshot changes are not necessarily the cause of the error. Check the logs.

@arkadius arkadius requested a review from mslabek November 21, 2024 13:37
@arkadius arkadius merged commit 17b806a into release/1.18 Nov 21, 2024
18 checks passed
@arkadius arkadius deleted the nu-1893-missing-fragment-fix branch November 21, 2024 15:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants