amorphie / workflow

State Machine and flow chart orchestration workflow service
Apache License 2.0
0 stars 4 forks source link

F/instaceendpoint #577

Closed ikarakayali closed 1 month ago

ikarakayali commented 1 month ago

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The recent changes enhance the Amorphie workflow application by introducing new features for logging, encryption, and schema management, along with various refactorings for improved maintainability. Key updates include the addition of Elastic APM support, new utility classes like AesHelper for encryption, and improved logging strategies. The codebase is streamlined with clearer structure and formatting, ensuring better readability and organization across multiple namespaces.

Changes

Files Change Summary
amorphie.workflow.core/Constants/ElasticApmKeys.cs Introduced ElasticApmKeys class with a constant for TraceParent to standardize tracing keys.
amorphie.workflow.core/Dtos/... Removed NewStates from WorkflowCreateDto; added properties to PostStateDefinitionRequest and PostTransitionDefinitionRequest.
amorphie.workflow.core/Helper/AesHelper.cs Implemented encryption and decryption methods for strings and JSON using AES; added methods for key creation.
amorphie.workflow.core/Logging/... Introduced LoggingHelper and LoggingMiddleware for improved logging capabilities; updated logging options.
amorphie.workflow.service/... Added JsonSchemaService for handling JSON schemas; refactored service classes for clarity and efficiency.
amorphie.workflow.data/Migrations/... Introduced database migrations for adding TraceId to the Instances table; updated model snapshot accordingly.
amorphie.workflow.hub/MFATypeHub.cs Enhanced logging and transaction tracking in connection management methods.
amorphie.workflow.test/... Added unit tests for AesHelper and LoggingHelper, enhancing test coverage for encryption and data redaction functionalities.
workflow.sln Added a new test project configuration for improved testing capabilities within the solution.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant WorkflowAPI
    participant AesHelper

    Client->>WorkflowAPI: Request to encrypt data
    WorkflowAPI->>AesHelper: Call EncryptString with data
    AesHelper-->>WorkflowAPI: Return encrypted data
    WorkflowAPI-->>Client: Respond with encrypted data

Poem

πŸ‡ In the meadow, hops a rabbit bright,
With logs and keys, oh what a delight!
Encryption dances, tracing in stride,
In Amorphie’s world, we take pride.
From workflows to schemas, changes abound,
In this code garden, joy can be found! 🌼


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 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://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.
sonarcloud[bot] commented 1 month ago

Quality Gate Failed Quality Gate failed

Failed conditions
C Reliability Rating on New Code (required β‰₯ A)

See analysis details on SonarCloud

Catch issues before they fail your Quality Gate with our IDE extension SonarLint