1.18 ports4

[arkadius]

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

• New Features
  • Enhanced comment handling across various components, introducing a more structured representation of comments.
  • Added robust error handling for comment-related operations and improved validation processes.
• Improvements
  • Streamlined comment creation logic using a unified method, ScenarioComment.from, across multiple classes.
  • Introduced new metadata for scheduled executions in the periodic process service.
• Bug Fixes
  • Improved clarity in error messages and validation feedback for comment management.
• Documentation
  • Updated changelog and designer tips for clarity and accuracy.

[coderabbitai[bot]]

Walkthrough

The changes in this pull request encompass modifications across multiple files, primarily focusing on the handling of comments and their integration within various components of the Nussknacker application. Key updates include the introduction of a new method for creating comments, enhancements to error handling and validation processes, and adjustments to the migration logic for actions and comments. The overall structure of the affected classes and methods remains intact, but the logic has been refined to improve clarity, type safety, and consistency in comment management.

Changes

File	Change Summary
common-api/src/main/scala/pl/touk/nussknacker/engine/api/Comment.scala	Updated from method to trim input content before checking for emptiness.
designer/server/src/main/scala/pl/touk/nussknacker/ui/api/ScenarioActivityApiHttpService.scala	Refined toDto method for ScenarioComment, enhanced error handling in editComment and deleteComment, introduced validateComment method.
designer/server/src/main/scala/pl/touk/nussknacker/ui/initialization/Initialization.scala	Modified migrateOne method to use for-comprehension for automaticUpdateAction.
designer/server/src/main/scala/pl/touk/nussknacker/ui/process/ScenarioActivityAuditLog.scala	Updated stringify method to access content property of ScenarioComment.
designer/server/src/main/scala/pl/touk/nussknacker/ui/process/migrate/ProcessModelMigrator.scala	Changed toAutomaticProcessUpdateAction to return Option[AutomaticProcessUpdateAction] using NonEmptyList.
designer/server/src/main/scala/pl/touk/nussknacker/ui/process/newactivity/ActivityService.scala	Replaced comment creation logic with ScenarioComment.from method.
designer/server/src/main/scala/pl/touk/nussknacker/ui/process/repository/ProcessRepository.scala	Renamed migrationsApplies to migrationsApplied, updated comment handling in updateProcess.
designer/server/src/main/scala/pl/touk/nussknacker/ui/process/repository/activities/DbScenarioActivityRepository.scala	Updated toComment and commentFromEntity methods to use ScenarioComment.from.
designer/server/src/main/scala/pl/touk/nussknacker/ui/process/repository/activities/ScenarioActivityRepository.scala	Modified addComment method to utilize ScenarioComment.from.
designer/server/src/main/scala/pl/touk/nussknacker/ui/util/PdfExporter.scala	Changed visibility of prepareFopXml method and refined parameter handling in nodeDetails.
designer/server/src/test/scala/db/migration/V1_057__MigrateActionsAndCommentsToScenarioActivities.scala	Updated migration logic to use ScenarioComment.from for comment creation.
designer/server/src/test/scala/db/migration/V1_058__UpdateAndAddMissingScenarioActivitiesSpec.scala	Modified test cases to use ScenarioComment.from for comment creation.
designer/server/src/test/scala/pl/touk/nussknacker/test/mock/MockDeploymentManager.scala	Updated comment construction in runDeployment method to use ScenarioComment.from.
designer/server/src/test/scala/pl/touk/nussknacker/ui/api/ScenarioActivityApiHttpServiceBusinessSpec.scala	Refactored comment handling logic to use ScenarioComment.from, refined error handling for comment deletion.
designer/server/src/test/scala/pl/touk/nussknacker/ui/process/deployment/DeploymentServiceSpec.scala	Enhanced comment handling in tests, introduced new variables for comment content.
designer/server/src/test/scala/pl/touk/nussknacker/ui/process/migrate/ProcessModelMigratorSpec.scala	Updated assertions related to migrationsApplied in tests.
designer/server/src/test/scala/pl/touk/nussknacker/ui/util/PdfExporterSpec.scala	Added new test case for validating parameter names in XML output.
docs/Changelog.md	Updated changelog to reflect new features and improvements across versions.
docs/scenarios_authoring/DesignerTipsAndTricks.md	Corrected typographical errors and improved clarity in documentation.
engine/flink/management/periodic/src/main/scala/pl/touk/nussknacker/engine/management/periodic/PeriodicProcessService.scala	Introduced FinishedScheduledExecutionMetadata class and updated methods to handle new metadata structure.
engine/flink/management/periodic/src/test/scala/pl/touk/nussknacker/engine/management/periodic/PeriodicDeploymentManagerTest.scala	Streamlined tests for periodic deployment manager, removed unnecessary assertions.
engine/flink/management/periodic/src/test/scala/pl/touk/nussknacker/engine/management/periodic/PeriodicProcessServiceIntegrationTest.scala	Enhanced integration tests to cover scenario activities and deployment behaviors.
extensions-api/src/main/scala/pl/touk/nussknacker/engine/api/deployment/ScenarioActivity.scala	Updated ScenarioComment handling, added new overloaded from methods.
scenario-compiler/src/main/scala/pl/touk/nussknacker/engine/definition/test/ModelDataTestInfoProvider.scala	Enhanced error handling and validation logic using Validated.
scenario-compiler/src/main/scala/pl/touk/nussknacker/engine/extension/ToMapConversionExt.scala	Improved type checking and error handling in map conversion logic.
scenario-compiler/src/test/scala/pl/touk/nussknacker/engine/spel/SpelExpressionSpec.scala	Introduced new case class ContainerOfGenericMap and updated test cases accordingly.

Poem

In the garden of code, where comments bloom,
A rabbit hops by, dispelling the gloom.
With from now in charge, the whitespace is gone,
Clean comments emerge, like the bright morning dawn.
So let’s celebrate changes, both big and small,
For clarity reigns, and we’re grateful for all! 🐇✨

---

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 , 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](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://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.