test(api): Improve coverage

[rajdip-b]

Type

enhancement, bug_fix

---

Description

• Simplified API endpoints by removing admin-specific paths and guards.
• Updated e2e tests to reflect the new API endpoint paths.
• Commented out or removed methods for admin-specific data retrieval across services.
• Enhanced security and maintainability by streamlining access to resources.

---

Changes walkthrough

Relevant files

Enhancement

14 files api-key.e2e.spec.ts Update API Endpoint in Api Key E2E Tests                                  apps/api/src/api-key/api-key.e2e.spec.ts Updated API endpoint in e2e tests from '/api-key/all/as-user' to '/api-key/all'. +2/-2      api-key.controller.ts Simplify Api Key Retrieval and Remove Admin Endpoint          apps/api/src/api-key/controller/api-key.controller.ts Removed 'AdminGuard' and updated API endpoint from '/api-key/all/as-user' to '/api-key/all'. Removed admin-specific API keys retrieval endpoint. +2/-16    api-key.service.ts Remove Admin-specific API Key Retrieval Method                      apps/api/src/api-key/service/api-key.service.ts Removed method for retrieving all API keys without user restriction. +0/-29    environment.controller.ts Comment Out Admin-specific Environment Retrieval Endpoint apps/api/src/environment/controller/environment.controller.ts Commented out admin-specific environment retrieval endpoint. +0/-18    environment.service.ts Comment Out Admin-specific Environment Retrieval Method    apps/api/src/environment/service/environment.service.ts Commented out method for retrieving all environments without user restriction. +0/-25    project.controller.ts Simplify Project Retrieval and Remove Admin Endpoints        apps/api/src/project/controller/project.controller.ts Removed 'AdminGuard' and admin-specific project retrieval endpoints. +1/-21    project.service.ts Remove Admin-specific Project Retrieval Methods                    apps/api/src/project/service/project.service.ts Removed methods for admin-specific project retrieval. +0/-43    secret.controller.ts Comment Out Admin-specific Secrets Retrieval Endpoint        apps/api/src/secret/controller/secret.controller.ts Commented out admin-specific secrets retrieval endpoint. +0/-18    secret.service.ts Comment Out Admin-specific Secrets Retrieval Method            apps/api/src/secret/service/secret.service.ts Commented out method for retrieving all secrets without user restriction. +0/-32    workspace-role.controller.ts Comment Out Admin-specific Workspace Roles Retrieval Endpoint apps/api/src/workspace-role/controller/workspace-role.controller.ts Commented out admin-specific workspace roles retrieval endpoint. +0/-18    workspace-role.service.ts Comment Out Admin-specific Workspace Roles Retrieval Method apps/api/src/workspace-role/service/workspace-role.service.ts Commented out method for retrieving all workspace roles without user restriction. +0/-21    workspace.controller.ts Simplify Workspace Retrieval and Remove Admin Endpoint      apps/api/src/workspace/controller/workspace.controller.ts Removed 'AdminGuard' and updated API endpoint from '/workspace/all/as-user' to '/workspace/all'. Removed admin-specific workspace retrieval endpoint. +2/-16    workspace.service.ts Remove Admin-specific Workspace Retrieval Method                  apps/api/src/workspace/service/workspace.service.ts Removed method for retrieving all workspaces without user restriction. +0/-30    workspace.e2e.spec.ts Update API Endpoint in Workspace E2E Tests                              apps/api/src/workspace/workspace.e2e.spec.ts Updated API endpoint in e2e tests from '/workspace/all/as-user' to '/workspace/all'. +1/-1

---

✨ 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 (8eec8dd)

[codiumai-pr-agent-free]

PR Review

PR feedback
⏱️ Estimated effort to review [1-5]	2, because the changes are mostly about removing admin-specific endpoints and guards, which is straightforward. The PR touches multiple files but the pattern of changes is consistent and easy to follow.
🧪 Relevant tests	Yes
🔍 Possible issues	Removing admin-specific endpoints without adding new authorization checks might inadvertently broaden access to sensitive operations. Ensure that the remaining endpoints enforce proper authorization. The removal of admin guards and admin-specific endpoints could impact existing functionalities or integrations that rely on these endpoints. It's important to verify that all use cases are still supported or properly migrated.
🔒 Security concerns	No

---

✨ 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
enhancement	Parameterize the API URL to enhance flexibility and maintainability.          Consider parameterizing the URL '/api-key/all' to support different environments or future changes in the API path. apps/api/src/api-key/api-key.e2e.spec.ts [133] -url: '/api-key/all', +url: `${API_BASE_URL}/api-key/all`, Update test URL to match the application's updated routing.                   Update the test to reflect the new URL path for workspace retrieval, ensuring consistency with the application's routing changes. apps/api/src/workspace/workspace.e2e.spec.ts [1020] -url: '/workspace/all' +url: '/workspace/all' // Ensure this URL matches the updated application routing.
security	Verify the removal of admin guards and ensure security integrity.             Ensure that the removal of @UseGuards(AdminGuard) and related admin functionality is intentional and that appropriate security checks are in place. apps/api/src/api-key/controller/api-key.controller.ts [50] +@UseGuards(AdminGuard) @Get('all')
possible issue	Confirm the removal of admin-specific endpoints meets business needs.         If removing admin-specific endpoints, ensure that equivalent functionality is provided elsewhere or that the removal aligns with business requirements. apps/api/src/project/controller/project.controller.ts [82] -@Get('admin/:projectId') +// Ensure equivalent functionality is provided if this admin-specific endpoint is removed. Confirm removal of getWorkspaces does not break dependent functionalities. If removing the getWorkspaces method, ensure that all references and dependent functionalities are updated or removed accordingly. apps/api/src/workspace/service/workspace.service.ts [864] -async getWorkspaces( +// Ensure all references to getWorkspaces are updated or removed.

---

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

[nx-cloud]

☁️ Nx Cloud Report

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

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7bb3d21) 62.20% compared to head (4608118) 94.26%.
Report is 15 commits behind head on develop.

Additional details and impacted files

@@             Coverage Diff              @@
##           develop     #150       +/-   ##
============================================
+ Coverage    62.20%   94.26%   +32.05%     
============================================
  Files           76       83        +7     
  Lines         1503     1570       +67     
  Branches       260      257        -3     
============================================
+ Hits           935     1480      +545     
+ Misses         568       90      -478     

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

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
13.2% Duplication on New Code

See analysis details on SonarCloud

[rajdip-b]

🎉 This PR is included in version 1.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀