You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Blokh
merged 3 commits into
sb
from
devMar 14, 2024
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.
This PR includes no changesets
When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types
3, because the PR encompasses multiple files across different packages, including schema changes, UI updates, and core functionality enhancements. The complexity is moderate, involving both frontend and backend changes, and requires a thorough understanding of the system's architecture.
🧪 Relevant tests
Yes
🔍 Possible issues
Possible Bug: The setTimeToRecordUTC method in helpers-transformer.ts returns new Date().getUTCDate(), which only provides the day of the month in UTC. This might not be the intended functionality, as the method name suggests setting the time to UTC. It should likely use new Date().getTime() or a similar approach to get the full date and time in UTC.
Data Consistency: The addition of the displayName field to WorkflowDefinition in the database schema without a corresponding migration script to handle existing records might lead to inconsistencies. Consider adding a migration script that populates this new field for existing records.
Consider using new Date().getTime() instead of new Date().getUTCDate() in the setTimeToRecordUTC method to capture the full UTC date and time, not just the day of the month. This change ensures the method's functionality aligns with its name and intended purpose. [important]
Ensure there's a corresponding data migration script that populates the displayName field for existing WorkflowDefinition records to maintain data consistency and prevent potential issues with records missing this new field. [important]
Use a utility function to ensure workflowDefinitionName is always displayed in a user-friendly format. This approach improves code readability and maintainability. Consider refactoring the repeated logic for setting workflowDefinitionName into a separate utility function. [medium]
Ensure the displayName field is adequately validated, especially since it's nullable. Consider adding more specific validation rules if necessary to ensure data integrity. [medium]
Overview:
The review tool scans the PR code changes, and generates a PR review. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on any PR.
When commenting, to edit configurations related to the review tool (pr_reviewer section), use the following template:
The review tool can be configured with extra instructions, which can be used to guide the model to a feedback tailored to the needs of your project.
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify the relevant sub-tool, and the relevant aspects of the PR that you want to emphasize.
Examples for extra instructions:
[pr_reviewer] # /review #
extra_instructions="""
In the 'possible issues' section, emphasize the following:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
How to enable\disable automation
When you first install PR-Agent app, the default mode for the review tool is:
pr_commands = ["/review", ...]
meaning the review tool will run automatically on every PR, with the default configuration.
Edit this field to enable/disable the tool, or to change the used configurations
Auto-labels
The review tool can auto-generate two specific types of labels for a PR:
a possible security issue label, that detects possible security issues (enable_review_labels_security flag)
a Review effort [1-5]: x label, where x is the estimated effort to review the PR (enable_review_labels_effort flag)
Extra sub-tools
The review tool provides a collection of possible feedbacks about a PR.
It is recommended to review the possible options, and choose the ones relevant for your use case.
Some of the feature that are disabled by default are quite useful, and should be considered for enabling. For example: require_score_review, require_soc2_ticket, and more.
Auto-approve PRs
By invoking:
/review auto_approve
The tool will automatically approve the PR, and add a comment with the approval.
To ensure safety, the auto-approval feature is disabled by default. To enable auto-approval, you need to actively set in a pre-defined configuration file the following:
[pr_reviewer]
enable_auto_approval = true
(this specific flag cannot be set with a command line argument, only in the configuration file, committed to the repository)
You can also enable auto-approval only if the PR meets certain requirements, such as that the estimated_review_effort is equal or below a certain threshold, by adjusting the flag:
[pr_reviewer]
maximal_review_effort = 5
More PR-Agent commands
To invoke the PR-Agent, add a comment using one of the following commands:
/review: Request a review of your Pull Request.
/describe: Update the PR title and description based on the contents of the PR.
Make displayName an optional property instead of nullable.
Consider making displayName optional instead of nullable for better type safety and to avoid dealing with null values. If displayName is not required and can be absent, using optional properties can simplify the usage.
Ensure workflowDefinition?.name is defined before applying titleCase.
Instead of using titleCase directly on potentially undefined values, ensure that workflowDefinition?.name is defined before applying titleCase. This prevents unnecessary function calls and potential errors with undefined values.
Rename isManualCaseCreationEnabled for better clarity and consistency.
To ensure consistency and avoid potential bugs, consider renaming isManualCaseCreationEnabled to match the naming convention of similar properties or to better reflect its purpose. For example, if it controls the visibility of case creation, a name like isCaseCreationVisible might be more descriptive.
Consider enforcing a non-nullable constraint on the displayName field.
Consider enforcing a non-nullable constraint on the displayName field if it's expected to be present for every WorkflowDefinition. Allowing it to be nullable could lead to inconsistencies in your data model, especially if this field is used frequently in your application logic. If displayName is intended to be optional, then this suggestion can be disregarded.
Simplify conditional class assignment with a single ternary operator.
To improve readability and maintainability, consider using a single ternary operator or a function to determine the height class instead of two separate conditions. This will make the code cleaner and easier to understand.
Correct the return value of setTimeToRecordUTC to return a UTC timestamp.
The setTimeToRecordUTC method currently returns the day of the month (from 1 to 31) instead of a UTC timestamp. To fix this, change the method to return a proper UTC timestamp.
-return new Date().getUTCDate();+return Date.now();
✨ Improve tool usage guide:
Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:
meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.
Utilizing extra instructions
Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.
Examples for extra instructions:
[pr_code_suggestions] # /improve #
extra_instructions="""
Emphasize the following aspects:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
A note on code suggestions quality
While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
With large PRs, best quality will be obtained by using 'improve --extended' mode.
More PR-Agent commands
To invoke the PR-Agent, add a comment using one of the following commands:
/review: Request a review of your Pull Request.
/describe: Update the PR title and description based on the contents of the PR.
Consider providing a default value for displayName in WorkflowDefinitionByIdSchema to ensure consistency and potentially avoid unnecessary null checks.
-return new Date().getUTCDate();+return Date.now();
Best practice
Destructure workflowDefinition.config for clarity.
To improve the readability and maintainability of the useEntities hook, consider destructuring workflowDefinition?.config at the beginning of the function.
Enforce non-nullable constraint on displayName if it's expected to be always present.
Consider enforcing a non-nullable constraint on displayName if this field is expected to be present for all WorkflowDefinition records. Allowing it to be nullable could lead to inconsistent data quality and complicate data handling in the application logic.
Overview:
The improve tool scans the PR code changes, and automatically generates suggestions for improving the PR code. The tool can be triggered automatically every time a new PR is opened, or can be invoked manually by commenting on a PR.
When commenting, to edit configurations related to the improve tool (pr_code_suggestions section), use the following template:
meaning the improve tool will run automatically on every PR, with summarization enabled. Delete this line to disable the tool from running automatically.
Utilizing extra instructions
Extra instructions are very important for the improve tool, since they enable to guide the model to suggestions that are more relevant to the specific needs of the project.
Be specific, clear, and concise in the instructions. With extra instructions, you are the prompter. Specify relevant aspects that you want the model to focus on.
Examples for extra instructions:
[pr_code_suggestions] # /improve #
extra_instructions="""
Emphasize the following aspects:
- Does the code logic cover relevant edge cases?
- Is the code logic clear and easy to understand?
- Is the code logic efficient?
...
"""
Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.
A note on code suggestions quality
While the current AI for code is getting better and better (GPT-4), it's not flawless. Not all the suggestions will be perfect, and a user should not accept all of them automatically.
Suggestions are not meant to be simplistic. Instead, they aim to give deep feedback and raise questions, ideas and thoughts to the user, who can then use his judgment, experience, and understanding of the code base.
Recommended to use the 'extra_instructions' field to guide the model to suggestions that are more relevant to the specific needs of the project, or use the custom suggestions 💎 tool
With large PRs, best quality will be obtained by using 'improve --extended' mode.
More PR-Agent commands
To invoke the PR-Agent, add a comment using one of the following commands:
/review: Request a review of your Pull Request.
/describe: Update the PR title and description based on the contents of the PR.
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
github-actions
bot
added
Review effort [1-5]: 3
and removed
Review effort [1-5]: 4
labels
User description
fixation of invokedAt over plugins
Type
enhancement, bug_fix
Description
displayNamefield toWorkflowDefinitionByIdSchemaand related UI enhancements.setTimeToRecordUTCmethod inHelpersTransformer.setTimeToRecordUTChelper method.Changes walkthrough
7 files
fetchers.ts
Add Display Name to Workflow Definition Schemaapps/backoffice-v2/src/domains/workflow-definitions/fetchers.ts
displayNamefield toWorkflowDefinitionByIdSchema.Entities.page.tsx
Refactor Case Creation Toggle and Renderingapps/backoffice-v2/src/pages/Entities/Entities.page.tsx
showCaseCreationtoisManualCaseCreationEnabled.CaseCreationbased onisManualCaseCreationEnabled.CaseCreation.tsx
Enhance Case Creation UI with Display Nameapps/backoffice-v2/src/pages/Entities/components/CaseCreation/CaseCreation.tsx
displayNameor formattednamefor workflow definition in UI.application.
useEntities.tsx
Update Entities Hook for Manual Case Creation Flagapps/backoffice-v2/src/pages/Entities/hooks/useEntities/useEntities.tsx
showCaseCreationwithisManualCaseCreationEnabled.helpers-transformer.ts
Implement setTimeToRecordUTC Methodpackages/workflow-core/src/lib/utils/context-transformers/helpers-transformer.ts
setTimeToRecordUTCmethod inHelpersTransformer.migration.sql
Add Display Name Column to WorkflowDefinition Tableservices/workflows-service/prisma/migrations/20240314123948_definition_display_name/migration.sql
displayNamecolumn toWorkflowDefinitiontable.schema.prisma
Add Display Name Field to WorkflowDefinition Modelservices/workflows-service/prisma/schema.prisma
displayNamefield toWorkflowDefinitionmodel.1 files
helpers-transformer.test.ts
Add Tests for setTimeToRecordUTC Helper Methodpackages/workflow-core/src/lib/utils/context-transformers/helpers-transformer.test.ts
setTimeToRecordUTChelper method.7 files
CHANGELOG.md
Update Changelog for Backoffice-v2apps/backoffice-v2/CHANGELOG.md
CHANGELOG.md
Update Changelog for KYB Appapps/kyb-app/CHANGELOG.md
CHANGELOG.md
Update Changelog for Headless Exampleexamples/headless-example/CHANGELOG.md
CHANGELOG.md
Update Changelog for Workflow-Corepackages/workflow-core/CHANGELOG.md
CHANGELOG.md
Update Changelog for Workflow-Browser-SDKsdks/workflow-browser-sdk/CHANGELOG.md
CHANGELOG.md
Update Changelog for Workflow-Node-SDKsdks/workflow-node-sdk/CHANGELOG.md
CHANGELOG.md
Update Changelog for Workflows-Serviceservices/workflows-service/CHANGELOG.md
7 files
package.json
Bump Backoffice-v2 Version and Update Dependenciesapps/backoffice-v2/package.json
package.json
Bump KYB App Version and Update Dependencyapps/kyb-app/package.json
package.json
Bump Headless Example Version and Update Dependencyexamples/headless-example/package.json
package.json
Bump Workflow-Core Versionpackages/workflow-core/package.json
package.json
Bump Workflow-Browser-SDK Version and Update Dependencysdks/workflow-browser-sdk/package.json
package.json
Bump Workflow-Node-SDK Version and Update Dependencysdks/workflow-node-sdk/package.json
package.json
Bump Workflows-Service Version and Update Dependenciesservices/workflows-service/package.json