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
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 involves changes across multiple files and layers of the application, including event data structure modifications, database interaction updates, and service logic enhancements. Understanding the implications of these changes requires a good grasp of the system's architecture and the workflow functionality.
🧪 Relevant tests
No
🔍 Possible issues
Possible Bug: The nullability of assignee in the event payload might not be handled properly in all consuming services or components. If any consumer expects assignee to always be present, this could lead to runtime errors.
Data Consistency: The changes include fetching assignee information and including it in various payloads. It's crucial to ensure that the assignee data is consistent across all instances where it's used, especially in asynchronous operations.
Consider validating the assignee object's properties (e.g., id, firstName, lastName, email) to ensure they are not null or undefined before adding them to the webhook payload. This can prevent potential issues with consumers of the webhook that may not handle missing properties well. [important]
When updating the workflow runtime data to include related entities like assignee, ensure that any changes to the assignee data model are reflected in the include parameter. This might require updating the type definition for Prisma.WorkflowRuntimeDataInclude to ensure type safety. [medium]
After updating the workflow state and potentially resolving it, consider adding a check to verify that the assignee information is correctly updated and included in the updatedResult. This can help catch any issues with the update operation or the inclusion of related entities early. [medium]
Ensure that the new assignee field in IWorkflowContextChangedEventData is properly documented and that all consumers of this interface are aware of the potential nullability of this field. This can help prevent null reference errors in parts of the application that consume this data. [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.
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.
Use a utility function to transform the assignee object.
Consider using a utility function to handle the transformation of the assignee object. This will improve code maintainability and readability by centralizing the logic for creating the assignee object structure.
Abstract fetching runtimeData with assignee into a separate method.
To enhance code readability and maintainability, consider abstracting the logic of fetching runtimeData with the assignee included into a separate method. This will make the code cleaner and easier to understand.
Ensure that the User type includes all necessary fields (id, firstName, lastName, email) as used in the document-changed-webhook-caller.ts file. This is to maintain consistency and avoid potential runtime errors due to missing fields.
-assignee: User | null;+// Ensure User type definition includes: id, firstName, lastName, email
Verify updateStateById correctly populates the assignee field.
When casting the result of updateStateById to include the assignee, ensure that the WorkflowRuntimeDataRepository method is correctly populating the assignee field to avoid potential runtime errors.
-const updatedResult = (await this.workflowRuntimeDataRepository.updateStateById(- runtimeData.id,- {- data: {- ...data,- resolvedAt: isResolved ? new Date().toISOString() : null,- },- include: { assignee: true },- },- transaction,-)) as WorkflowRuntimeData & { assignee: User | null };+// Ensure that updateStateById method correctly populates the assignee field
Best practice
Explicitly specify the return type of updateStateById.
Consider specifying the return type of updateStateById explicitly to improve code readability and ensure type safety. This will help developers understand what to expect from the method without diving into its implementation.
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.
Type
enhancement
Description
assigneeinformation to the document changed webhook payload, allowing for more detailed event data.assigneefield inIWorkflowContextChangedEventDatainterface to support this new data.updateStateByIdmethod inWorkflowRuntimeDataRepositoryto support inclusion of related entities, specificallyassignee.WorkflowServicemethods to includeassigneeinformation when emittingworkflow.context.changedevents and when fetching workflow runtime data.Changes walkthrough
document-changed-webhook-caller.ts
Add Assignee Information to Webhook Payloadservices/workflows-service/src/events/document-changed-webhook-caller.ts
assigneeinformation to the document changed webhook payload.index.ts
Extend Event Data Interface with Assignee Fieldservices/workflows-service/src/workflow/types/index.ts
assigneefield inIWorkflowContextChangedEventDatainterface.
workflow-runtime-data.repository.ts
Enhance Update Method to Support Related Entities Inclusionservices/workflows-service/src/workflow/workflow-runtime-data.repository.ts
updateStateByIdmethod to acceptincludeparameter.includeparameter.
workflow.service.ts
Update Workflow Service to Include Assignee in Eventsservices/workflows-service/src/workflow/workflow.service.ts
updateStateByIdcall to includeassigneedata.workflow.context.changedevent withassigneeinformation.assigneeinformation when fetchingruntime data.