Ongoing Monitoring

[tomer-shvadron]

Description

• Fixed unused projectIds in FilterRepository
• Added config column to Customer table
• Created new Webhook module, controller and service
• Added an endpoint for AML webhooks (supports entityType = 'individuals' only for now)
• Some boyscouting

[changeset-bot]

⚠️ No Changeset found

Latest commit: 09b4b49

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

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[github-actions]

PR Description updated to latest commit (1e8a6de)

[github-actions]

PR Review

⏱️ Estimated effort to review [1-5]	4, because the PR introduces a significant amount of new functionality across multiple areas of the application, including database schema changes, new modules, and services. The complexity and interdependencies of these changes require a thorough review to ensure quality and maintainability.
🧪 Relevant tests	No
🔍 Possible issues	The handleAmlHit method in WebhooksService does not handle exceptions that may occur during the database operations or the workflow service calls, which could lead to unhandled promise rejections.
	The findByIdUnscoped method in EndUserRepository introduces a new pattern that bypasses the existing scoping mechanisms, which could potentially lead to security concerns if not carefully managed.
	The WebhooksModule imports a large number of services and repositories, some of which may not be necessary for its operation. This could lead to tighter coupling and harder-to-maintain code.
🔒 Security concerns	No

Code feedback:

---

relevant file	services/workflows-service/src/webhooks/webhooks.service.ts
suggestion	Consider wrapping the database and service calls in handleAmlHit method with try-catch blocks to handle potential exceptions and prevent unhandled promise rejections. This will improve the reliability of the webhook handling. [important]
relevant line	async handleAmlHit({ entityId }: IndividualAmlWebhookInput) {

---

relevant file	services/workflows-service/src/end-user/end-user.repository.ts
suggestion	Evaluate the security implications of the findByIdUnscoped method to ensure it does not inadvertently expose sensitive user data. Consider implementing additional checks or using existing scoped methods where possible. [important]
relevant line	async findByIdUnscoped>(

---

relevant file	services/workflows-service/src/webhooks/webhooks.module.ts
suggestion	Review the dependencies imported by WebhooksModule to ensure that only necessary services and repositories are included. Removing unnecessary imports will reduce coupling and improve module isolation. [medium]
relevant line	import { AuthModule } from '@/auth/auth.module';

---

relevant file	services/workflows-service/src/webhooks/webhooks.controller.ts
suggestion	Implement input validation for the amlHook method to ensure that the received webhook data conforms to expected formats. This can prevent processing of invalid or malicious data. [important]
relevant line	async amlHook(

---

---

✨ Review tool usage guide:

---

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:

/review --pr_reviewer.some_config1=... --pr_reviewer.some_config2=...

With a configuration file, use the following template:

[pr_reviewer]
some_config1=...
some_config2=...

Utilizing extra instructions 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. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the review usage page for a comprehensive guide on using this tool.

[github-actions]

PR Code Suggestions

	Suggestions
bug	Correct the decorator for apiVersion to match its type.          The apiVersion property is decorated with @IsString() but it is defined as a Number type. You should use @IsNumber() decorator to ensure proper validation. services/workflows-service/src/webhooks/dtos/individual-aml-webhook-input.ts [16-17] @ApiProperty({ required: true, type: Number, }) -@IsString() +@IsNumber() apiVersion!: number;
best practice	Use global or controller-specific exception filters for error handling.       Consider implementing error handling in a more centralized manner rather than using try-catch in each controller method. NestJS provides filters like HttpExceptionFilter for this purpose. services/workflows-service/src/webhooks/webhooks.controller.ts [39-51] -try { - if (entityType === ENTITY_TYPES.INDIVIDUALS) { - const { eventName } = data; - if (eventName === WEBHOOKS.AML_HIT) { - await this.webhooksService.handleAmlHit(data as IndividualAmlWebhookInput); - } +if (entityType === ENTITY_TYPES.INDIVIDUALS) { + const { eventName } = data; + if (eventName === WEBHOOKS.AML_HIT) { + await this.webhooksService.handleAmlHit(data as IndividualAmlWebhookInput); } -} catch (error) { - console.error(error); - throw error; }
enhancement	Remove unnecessary await for cleaner code.                       Remove the unnecessary await keyword since findByLatestVersion is already returning a promise and there's no additional asynchronous operation being awaited inside getLatestVersion. services/workflows-service/src/workflow-defintion/workflow-definition.service.ts [84] -return await this.repository.findByLatestVersion(workflowDefinition.name, projectIds); +return this.repository.findByLatestVersion(workflowDefinition.name, projectIds);
maintainability	Remove unused commented-out code.                                             Consider removing the commented-out code related to ResubmissionReason and WorkflowData if it's no longer needed, to improve code readability and maintainability. services/workflows-service/src/workflow/workflow.service.ts [90-92] -// TODO: TEMP (STUB) const policies = {

---

✨ 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:

/improve --pr_code_suggestions.some_config1=... --pr_code_suggestions.some_config2=...

With a configuration file, use the following template:

[pr_code_suggestions]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the improve tool is: pr_commands = ["/improve --pr_code_suggestions.summarize=true", ...] 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. /improve [--extended]: Suggest code improvements. Extended mode provides a higher quality feedback. /ask <QUESTION>: Ask a question about the PR. /update_changelog: Update the changelog based on the PR's contents. /add_docs 💎: Generate docstring for new components introduced in the PR. /generate_labels 💎: Generate labels for the PR based on the PR's contents. /analyze 💎: Automatically analyzes the PR, and presents changes walkthrough for each component. See the tools guide for more details. To list the possible configuration parameters, add a /config comment.

See the improve usage page for a more comprehensive guide on using this tool.