test: Add event E2E tests

[rajdip-b]

User description

Description

Add E2E test suite for event controller

---

Type

enhancement, tests

---

Description

• Introduced a centralized cleanUp utility function for database cleanup in tests.
• Simplified the createEvent function logic and improved error logging.
• Added comprehensive E2E tests for the event controller.
• Streamlined event fetching logic by removing workspaceMemberId handling and refining workspace role-related logic.
• Renamed add-users endpoint to invite-users in the workspace controller to better reflect its functionality.
• Enhanced workspace user invitation logic and updated related event creation.
• Simplified the EventSource enum in the Prisma schema by removing WORKSPACE_MEMBER.
• Updated TypeScript configuration files to include new E2E test file.
• Modified the E2E test script in package.json to use the --skip-nx-cache flag.

---

Changes walkthrough

	Relevant files
Enhancement	9 files api-key.e2e.spec.ts Refactor Cleanup Logic in Api Key E2E Tests                            apps/api/src/api-key/api-key.e2e.spec.ts Replaced manual cleanup logic with a call to the cleanUp utility function in afterAll hook. +2/-5      cleanup.ts Introduce Cleanup Utility Function                                              apps/api/src/common/cleanup.ts Introduced a new cleanUp utility function to centralize the cleanup logic for database entities. +16/-0    create-event.ts Simplify Event Creation Logic                                                        apps/api/src/common/create-event.ts Simplified the createEvent function by removing specific entity handling and using a more generic approach. Improved error logging by including event data in the log output. +32/-95  event.controller.ts Streamline Event Controller Query Parameters                          apps/api/src/event/controller/event.controller.ts Removed handling for workspaceMemberId query parameter in event fetching endpoint. +2/-4      event.service.ts Refine Event Fetching Logic                                                            apps/api/src/event/service/event.service.ts Removed handling for workspaceMemberId in event fetching logic. Added logic to fetch workspace role information when filtering events by workspaceRoleId. +11/-10  workspace-role.e2e.spec.ts Refactor Cleanup Logic in Workspace Role E2E Tests              apps/api/src/workspace-role/workspace-role.e2e.spec.ts Replaced manual cleanup logic with a call to the cleanUp utility function in afterAll hook. +3/-17    workspace.controller.ts Rename Workspace User Addition Endpoint                                    apps/api/src/workspace/controller/workspace.controller.ts Renamed add-users endpoint to invite-users to better reflect its functionality. +6/-2      workspace.service.ts Enhance Workspace User Invitation Logic                                    apps/api/src/workspace/service/workspace.service.ts Renamed addUsersToWorkspace to inviteUsersToWorkspace and updated its logic to support user invitations. Updated workspace deletion event creation to remove the direct workspace entity reference. +28/-20  schema.prisma Simplify Event Source Enum in Prisma Schema                            apps/api/src/prisma/schema.prisma Removed WORKSPACE_MEMBER from EventSource enum, simplifying event source options. +0/-1
Tests	1 files event.e2e.spec.ts Add Event Controller E2E Tests                                                      apps/api/src/event/event.e2e.spec.ts Added comprehensive E2E tests for the event controller, covering various event types and scenarios. +352/-0
Configuration changes	3 files tsconfig.app.json Update TypeScript App Configuration                                            apps/api/tsconfig.app.json Included src/event/event.e2e.spec.ts in the TypeScript compilation context for the application. +1/-1      tsconfig.spec.json Update TypeScript Test Configuration                                          apps/api/tsconfig.spec.json Included src/event/event.e2e.spec.ts in the TypeScript compilation context for tests. +2/-1      package.json Modify E2E Test Script in Package.json                                      package.json Modified the e2e:api script to include the --skip-nx-cache flag for E2E tests. +1/-1

---

✨ Usage guide:

---

Overview:
The describe tool scans the PR code changes, and generates a description for the PR - title, type, summary, walkthrough and labels. 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 describe tool (pr_description section), use the following template:

/describe --pr_description.some_config1=... --pr_description.some_config2=...

With a configuration file, use the following template:

[pr_description]
some_config1=...
some_config2=...

Enabling\disabling automation When you first install the app, the default mode for the describe tool is: pr_commands = ["/describe --pr_description.add_original_user_description=true" "--pr_description.keep_original_user_title=true", ...] meaning the describe tool will run automatically on every PR, will keep the original title, and will add the original user description above the generated description. Markers are an alternative way to control the generated description, to give maximal control to the user. If you set: pr_commands = ["/describe --pr_description.use_description_markers=true", ...] the tool will replace every marker of the form pr_agent:marker_name in the PR description with the relevant content, where marker_name is one of the following: type: the PR type. summary: the PR summary. walkthrough: the PR walkthrough. Note that when markers are enabled, if the original PR description does not contain any markers, the tool will not alter the description at all.

Custom labels The default labels of the describe tool are quite generic: [Bug fix, Tests, Enhancement, Documentation, Other]. If you specify custom labels in the repo's labels page or via configuration file, you can get tailored labels for your use cases. Examples for custom labels: Main topic:performance - pr_agent:The main topic of this PR is performance New endpoint - pr_agent:A new endpoint was added in this PR SQL query - pr_agent:A new SQL query was added in this PR Dockerfile changes - pr_agent:The PR contains changes in the Dockerfile ... The list above is eclectic, and aims to give an idea of different possibilities. Define custom labels that are relevant for your repo and use cases. Note that Labels are not mutually exclusive, so you can add multiple label categories. Make sure to provide proper title, and a detailed and well-phrased description for each label, so the tool will know when to suggest it.

Inline File Walkthrough 💎 For enhanced user experience, the describe tool can add file summaries directly to the "Files changed" tab in the PR page. This will enable you to quickly understand the changes in each file, while reviewing the code changes (diffs). To enable inline file summary, set pr_description.inline_file_summary in the configuration file, possible values are: 'table': File changes walkthrough table will be displayed on the top of the "Files changed" tab, in addition to the "Conversation" tab. true: A collapsable file comment with changes title and a changes summary for each file in the PR. false (default): File changes walkthrough will be added only to the "Conversation" tab.

Utilizing extra instructions The describe tool can be configured with extra instructions, 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. Notice that the general structure of the description is fixed, and cannot be changed. Extra instructions can change the content or style of each sub-section of the PR description. Examples for extra instructions: [pr_description] extra_instructions=""" - The PR title should be in the format: '<PR type>: <title>' - The title should be short and concise (up to 10 words) - ... """ Use triple quotes to write multi-line instructions. Use bullet points to make the instructions more readable.

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 describe usage page for a comprehensive guide on using this tool.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit ab232ee. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this CI Pipeline Execution

---

✅ Successfully ran 3 targets

• nx run api:test
• nx run api:prisma:generate
• nx run api:lint

---

Sent with 💌 from NxCloud.

[codiumai-pr-agent-free]

PR Description updated to latest commit (cd33a8c)

[codiumai-pr-agent-free]

PR Review

PR feedback
⏱️ Estimated effort to review [1-5]	4, because the PR introduces a significant amount of changes across multiple files, including refactoring, feature enhancements, and the addition of comprehensive E2E tests. Reviewing this PR requires a thorough understanding of the existing codebase, the changes made, and ensuring that the new tests cover all the critical paths. The complexity and interdependencies of the changes increase the effort required for a thorough review.
🧪 Relevant tests	Yes
🔍 Possible issues	The removal of workspaceMemberId handling in event fetching logic might affect existing functionalities that rely on this query parameter. It's important to ensure that this change does not unintentionally break features that expect workspaceMemberId to be considered. The refactoring of the createEvent function simplifies the logic but introduces a generic any type for baseData. Using any can potentially lead to runtime errors due to the lack of type safety. It would be beneficial to define a more specific type or interface for baseData. The change in the endpoint from add-users to invite-users in the workspace controller might require updates in the frontend or other clients that consume this API. It's crucial to coordinate this change to ensure that all clients are updated accordingly to avoid breaking the user flow. The introduction of the cleanUp utility function for database cleanup in tests is a positive change. However, it's important to ensure that this function is robust and handles all necessary cleanup to avoid flaky tests due to leftover data.
🔒 Security concerns	No

---

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

[codiumai-pr-agent-free]

PR Code Suggestions

	Suggestions
enhancement	Wrap deletion operations in a try-catch block for error handling.             Consider wrapping the deletion operations in a try-catch block to handle potential errors gracefully. Log the error for debugging purposes. apps/api/src/common/cleanup.ts [4-14] -await prisma.$transaction([ - prisma.workspaceMemberRoleAssociation.deleteMany(), - ... - prisma.apiKey.deleteMany() -]) +try { + await prisma.$transaction([ + prisma.workspaceMemberRoleAssociation.deleteMany(), + ... + prisma.apiKey.deleteMany() + ]) +} catch (error) { + console.error('Cleanup error:', error) +} Use a custom error class for more descriptive errors.                         Use a more specific error type or create a custom error class to throw more descriptive errors. apps/api/src/common/create-event.ts [92] -throw new Error('Invalid event source') +class InvalidEventSourceError extends Error { + constructor(message: string) { + super(message); + this.name = "InvalidEventSourceError"; + } +} +throw new InvalidEventSourceError('Invalid event source') Add validation for the members parameter in the addUsers method.              Consider validating the members parameter in the addUsers method to ensure it contains valid data before proceeding with the invitation process. This can help prevent issues related to invalid or malicious data being processed. apps/api/src/workspace/controller/workspace.controller.ts [64-67] async addUsers( @CurrentUser() user: User, @Param('workspaceId') workspaceId: Workspace['id'], @Body() members: WorkspaceMemberDTO[] ) { + // Add validation logic here +} Handle existing workspace member case more explicitly in inviteUsersToWorkspace. Instead of logging a warning and returning when a user is already a member of the workspace, consider throwing an exception or handling this case more explicitly to inform the caller of the inviteUsersToWorkspace method about the situation. apps/api/src/workspace/service/workspace.service.ts [918-930] if ( memberUser && (await this.memberExistsInWorkspace(workspace.id, userId)) ) { - this.log.warn( - `User ${ - memberUser.name ?? 'NO_NAME_YET' - } (${userId}) is already a member of workspace ${workspace.name} (${ - workspace.id - }). Skipping.` - ) - return + throw new Error(`User ${memberUser.name ?? 'NO_NAME_YET'} (${userId}) is already a member of workspace ${workspace.name} (${workspace.id}).`); }
best practice	Use a specific type instead of any for baseData.    Replace the any type with a more specific type for baseData to improve type safety. apps/api/src/common/create-event.ts [35-36] -// eslint-disable-next-line @typescript-eslint/no-explicit-any -const baseData: any = { +interface BaseData { + triggerer: EventTriggerer; + severity: EventSeverity; + type: EventType; + source: EventSource; + title: string; + description: string; + metadata: JsonObject; + sourceUserId?: string; + [key: string]: any; +} +const baseData: BaseData = {
maintainability	Reduce code duplication by extracting entity creation logic into helper functions. Extract repeated logic for creating entities (user, workspace, project, etc.) into helper functions to reduce code duplication. apps/api/src/event/event.e2e.spec.ts [105-110] -user = await prisma.user.create({ - data: { - email: '[email protected]', - name: 'John Doe' - } -}) +async function createUser(email: string, name: string): Promise<User> { + return await prisma.user.create({ + data: { + email, + name + } + }); +} +user = await createUser('[email protected]', 'John Doe'); Use a more descriptive variable name than userId.                Consider using a more descriptive variable name than userId for the generated or existing user ID to enhance code readability, especially since it's used in multiple contexts (existing users and newly created users). apps/api/src/workspace/service/workspace.service.ts [916] -const userId = memberUser?.id ?? v4() +const generatedOrExistingUserId = memberUser?.id ?? v4()
possible issue	Add error handling for null workspaceRole to avoid runtime errors. Add error handling for the case where workspaceRole is null after querying with context.workspaceRoleId to avoid potential runtime errors. apps/api/src/event/service/event.service.ts [75-82] const workspaceRole = await this.prisma.workspaceRole.findUnique({ where: { id: context.workspaceRoleId }, include: { workspace: true } }) +if (!workspaceRole) { + throw new Error(`WorkspaceRole with ID ${context.workspaceRoleId} not found.`); +} Review inclusion of test files in tsconfig.app.json.                          Ensure that the inclusion of src/event/event.e2e.spec.ts in the include array of tsconfig.app.json is intentional. If this is a test file, it might be more appropriate to include it in tsconfig.spec.json instead, to separate source code from test code. apps/api/tsconfig.app.json [11] -"include": ["src/**/*.ts", "src/event/event.e2e.spec.ts"] +"include": ["src/**/*.ts"]

---

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

[codecov]

Codecov Report

Attention: 90 lines in your changes are missing coverage. Please review.

Comparison is base (ae73e7a) 31.22% compared to head (ab232ee) 62.20%.
Report is 20 commits behind head on develop.

Files	Patch %	Lines
...pps/api/src/workspace/service/workspace.service.ts	11.76%	30 Missing ⚠️
apps/api/src/secret/service/secret.service.ts	28.00%	18 Missing ⚠️
apps/api/src/auth/guard/auth/auth.guard.ts	65.78%	13 Missing ⚠️
apps/api/src/common/decrypt.ts	28.57%	5 Missing ⚠️
...api/src/environment/service/environment.service.ts	54.54%	5 Missing ⚠️
apps/api/src/auth/controller/auth.controller.ts	57.14%	3 Missing ⚠️
apps/api/src/auth/service/auth.service.ts	0.00%	3 Missing ⚠️
...c/config/factory/github/github-strategy.factory.ts	81.25%	3 Missing ⚠️
apps/api/src/api-key/service/api-key.service.ts	80.00%	2 Missing ⚠️
apps/api/src/auth/guard/api-key/api-key.guard.ts	92.30%	2 Missing ⚠️
... and 4 more

Additional details and impacted files

@@             Coverage Diff              @@
##           develop     #140       +/-   ##
============================================
+ Coverage    31.22%   62.20%   +30.98%     
============================================
  Files           54       76       +22     
  Lines         1156     1503      +347     
  Branches       210      260       +50     
============================================
+ Hits           361      935      +574     
+ Misses         795      568      -227     

Flag	Coverage Δ
api-e2e-tests	62.20% <74.71%> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

[rajdip-b]

🎉 This PR is included in version 1.1.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀