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
2, because the changes are straightforward, involving the addition of a new TypeScript reset package across multiple applications and services. The modifications are mostly imports and package.json updates, with a few specific TypeScript error handling adjustments.
🧪 Relevant tests
No
🔍 Possible issues
The use of @ts-expect-error comments in services/workflows-service/src/workflow/hook-callback-handler.service.ts might suppress important TypeScript errors. It's crucial to ensure that these suppressions are absolutely necessary and that the potential issues they might hide are well understood and documented.
Consider validating context to ensure it's an object before accessing its properties. This can prevent runtime errors and eliminate the need for @ts-expect-error comments. For example, you could use a type guard function to check if context is an object with the expected structure. [important]
Instead of using multiple @ts-expect-error comments, consider creating a more precise type definition for context. This approach can improve code readability and maintainability by making the expected structure of context explicit. [important]
It appears the @ts-expect-error comment was removed without a corresponding code change to address the potential TypeScript error. Ensure that the removal is intentional and that the TypeScript compiler does not raise any errors here. If necessary, adjust the code to handle the TypeScript error appropriately. [medium]
Ensure that the version 0.5.1 of @total-typescript/ts-reset is compatible with the rest of your project dependencies. Dependency updates can sometimes introduce breaking changes or compatibility issues, so it's important to test thoroughly after adding or updating dependencies. [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.
-// @ts-expect-error - we don't validate `context` is an object1-context.entity.id || context.entity.ballerineEntityId,+if (typeof context === 'object' && context !== null) {+ context.entity.id || context.entity.ballerineEntityId,+}
Pin dependency versions to ensure consistent builds.
Pin the version of @total-typescript/ts-reset to 0.5.1 instead of using ^0.5.1 to ensure consistent builds and avoid potential breaking changes in minor versions.
-// @ts-expect-error - we don't validate `context` is an object-this.setNestedProperty(context, attributePath, result);+if ('entity' in context && 'id' in context.entity) {+ this.setNestedProperty(context, attributePath, result);+}
✨ 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.
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.
User description
Description
https://www.totaltypescript.com/ts-reset
Type
enhancement, dependencies
Description
@total-typescript/ts-reset
across various applications and services to standardize TypeScript resets.@ts-expect-error
comments and added where necessary for better TypeScript error handling.package.json
andpnpm-lock.yaml
to include the new@total-typescript/ts-reset
dependency.Changes walkthrough
5 files
main.tsx
Import `ts-reset` in Backoffice v2 Main File
apps/backoffice-v2/src/main.tsx
@total-typescript/ts-reset
at the top of the file.main.tsx
Import `ts-reset` in KYB App Main File
apps/kyb-app/src/main.tsx
@total-typescript/ts-reset
at the top of the file.main.ts
Import `ts-reset` in Workflows Service Main File
services/workflows-service/src/main.ts
@total-typescript/ts-reset
at the top of the file.find-workflows-list.dto.ts
Cleanup TypeScript Expect Error Comments
services/workflows-service/src/workflow/dtos/find-workflows-list.dto.ts
@ts-expect-error
comment above the direction validation check.hook-callback-handler.service.ts
Add TypeScript Expect Error Comments for Context Validation
services/workflows-service/src/workflow/hook-callback-handler.service.ts
@ts-expect-error
comments for unvalidatedcontext
object.4 files
package.json
Add `ts-reset` Dependency to Backoffice v2
apps/backoffice-v2/package.json
@total-typescript/ts-reset
dependency.package.json
Add `ts-reset` Dependency to KYB App
apps/kyb-app/package.json
@total-typescript/ts-reset
dependency.pnpm-lock.yaml
Update Dependencies in pnpm-lock.yaml
pnpm-lock.yaml
@total-typescript/ts-reset
dependency across multiple importers.package.json
Add `ts-reset` Dependency to Workflows Service
services/workflows-service/package.json
@total-typescript/ts-reset
dependency.