feat(api): Add feature to export data of a workspace

[rajdip-b]

User description

Fixes #128

---

Type

enhancement, tests

---

Description

• Added functionality to export data of a workspace including details, roles, projects, environments, variables, and secrets.
• Refactored environmentId field in CreateSecret and CreateVariable DTOs from number to string.
• Introduced a new endpoint :workspaceId/export-data in WorkspaceController with WORKSPACE_ADMIN authority requirement.
• Implemented exportData method in WorkspaceService to support the data export feature.
• Added comprehensive e2e tests to validate the new export data functionality, including checks for unauthorized access and successful data export.

---

Changes walkthrough

	Relevant files
Enhancement	create.secret.ts Refactor environmentId to Use String Validator in CreateSecret DTO apps/api/src/secret/dto/create.secret/create.secret.ts Removed IsNumber import and validator from environmentId. Changed environmentId validator from IsNumber to IsString. +2/-2      create.variable.ts Refactor environmentId to Use String Validator in CreateVariable DTO apps/api/src/variable/dto/create.variable/create.variable.ts Removed IsNumber import and validator from environmentId. Changed environmentId validator from IsNumber to IsString. +2/-2      workspace.controller.ts Add Export Data Endpoint to Workspace Controller                  apps/api/src/workspace/controller/workspace.controller.ts Added a new endpoint :workspaceId/export-data to export data of a workspace. Required WORKSPACE_ADMIN authority for accessing the export data endpoint. +9/-0      workspace.service.ts Implement Export Data Functionality in Workspace Service  apps/api/src/workspace/service/workspace.service.ts Implemented exportData method to gather and return workspace data. Data includes workspace details, roles, projects, environments, variables, and secrets. +83/-0
Tests	workspace.e2e.spec.ts Add E2E Tests for Workspace Data Export Functionality        apps/api/src/workspace/workspace.e2e.spec.ts Added e2e tests for the new export data functionality. Tests cover unauthorized access, non-existing workspace, and successful data export. +53/-0

---

✨ PR-Agent usage:
Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

[codiumai-pr-agent-free]

PR Description updated to latest commit (9d52280)

[codiumai-pr-agent-free]

PR Review

PR feedback
⏱️ Estimated effort to review [1-5]	2, because the changes are straightforward and well-defined across a few files. The refactor of environmentId from number to string is clear, and the addition of the export data functionality is encapsulated within its own method, making it easier to review. The e2e tests provide good coverage for the new functionality.
🧪 Relevant tests	Yes
🔍 Possible issues	The exportData method in workspace.service.ts does not seem to handle potential exceptions that could occur while fetching data from the database. It might be beneficial to add try-catch blocks or checks to ensure the stability of the export feature. The data export functionality includes sensitive information such as privateKey for projects. Ensure that this does not pose a security risk or consider excluding such sensitive information from the export.
🔒 Security concerns	Yes, because the export includes potentially sensitive information such as project privateKeys. It's crucial to ensure that this data is handled securely and that the export feature cannot be exploited to gain unauthorized access to sensitive data. Consider implementing additional security measures such as data encryption or limiting the scope of exported data.

---

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

[codiumai-pr-agent-free]

PR Code Suggestions

	Suggestions
maintainability	Remove unused imports to clean up the code.                                   Consider removing the IsOptional import if it's no longer used in this file. apps/api/src/secret/dto/create.secret/create.secret.ts [1] -import { IsOptional, IsString, Length } from 'class-validator' +import { IsString, Length } from 'class-validator' Abstract common test setup to improve maintainability.                        Consider abstracting common setup code for tests into a beforeEach block to improve test maintainability and reduce redundancy. apps/api/src/workspace/workspace.e2e.spec.ts [1134-1140] -const response = await app.inject({ - method: 'GET', - headers: { - 'x-e2e-user-email': user1.email - }, - url: `/workspace/abc/export-data` -}) +let response; +beforeEach(async () => { + response = await app.inject({ + method: 'GET', + headers: { + 'x-e2e-user-email': user1.email + }, + url: `/workspace/${workspaceId}/export-data` // Use a variable for workspaceId + }); +});
possible issue	Verify and possibly adjust the order of decorators for correct validation behavior. Ensure the order of decorators @IsString() and @IsOptional() is intentional, as it might affect validation behavior. apps/api/src/variable/dto/create.variable/create.variable.ts [15-16] +@IsOptional() @IsString() -@IsOptional()
enhancement	Add API documentation for clarity and maintainability.                        Add API documentation comments for the exportData method to describe its purpose, parameters, and return type. apps/api/src/workspace/controller/workspace.controller.ts [186-192] +/** + * Exports the data of a workspace. + * @param user The current user. + * @param workspaceId The ID of the workspace to export data from. + * @returns The exported data of the workspace. + */ @Get(':workspaceId/export-data') @RequiredApiKeyAuthorities(Authority.WORKSPACE_ADMIN) async exportData( @CurrentUser() user: User, @Param('workspaceId') workspaceId: Workspace['id'] ) { return this.workspaceService.exportData(user, workspaceId) }
best practice	Use specific types instead of any for better type safety.        Replace the usage of any with a more specific type or interface for data to improve type safety. apps/api/src/workspace/service/workspace.service.ts [876] -// eslint-disable-next-line @typescript-eslint/no-explicit-any -const data: any = {} +interface WorkspaceData { + name: string; + description: string; + workspaceRoles: Array<object>; // Define a more specific type + projects: Array<object>; // Define a more specific type +} +const data: WorkspaceData = {}

---

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

[sonarcloud]

Quality Gate passed

Issues
0 New issues

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

See analysis details on SonarCloud

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7bb3d21) 62.20% compared to head (9d52280) 94.24%.
Report is 19 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff              @@
##           develop     #152       +/-   ##
============================================
+ Coverage    62.20%   94.24%   +32.03%     
============================================
  Files           76       83        +7     
  Lines         1503     1582       +79     
  Branches       260      256        -4     
============================================
+ Hits           935     1491      +556     
+ Misses         568       91      -477     

Flag	Coverage Δ
api-e2e-tests	94.24% <100.00%> (+32.03%)	⬆️

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.

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 9d52280. 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.

[rajdip-b]

🎉 This PR is included in version 1.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀