feat(api): Add note to secret and variable

[rajdip-b]

User description

Description

Add an optional note field to variable and secret

---

Type

enhancement

---

Description

• Add getDefaultEnvironmentOfProject function that retrieves the default environment of a project based on its ID
• Add note field to the object passed to createEvent function
• Add note field to CreateSecret class
• Add note field to secret endpoints
• Add note field to the object passed to this.prisma.secret.create function in SecretService
• Add note field to the object passed to this.prisma.secret.update function in SecretService
• Add note field to CreateVariable class
• Add note field to variable endpoints
• Add note field to the object passed to this.prisma.variable.create function in VariableService
• Add note field to the object passed to this.prisma.variable.update function in VariableService
• Add SQL statements to alter the Secret and Variable tables to include a note column
• Add note field to the Secret model in the Prisma schema
• Add note field to the Variable model in the Prisma schema

---

Changes walkthrough

Relevant files

Enhancement

10 files get-default-project-environment.ts Add `getDefaultEnvironmentOfProject` function                        apps/api/src/common/get-default-project-environment.ts Import Environment, PrismaClient, and Project from @prisma/client Add getDefaultEnvironmentOfProject function that retrieves the default environment of a project based on its ID +14/-1    event.e2e.spec.ts Add `note` field to `createEvent` function                              apps/api/src/event/event.e2e.spec.ts Add note field to the object passed to createEvent function +2/-0      create.secret.ts Add `note` field to `CreateSecret` class                                  apps/api/src/secret/dto/create.secret/create.secret.ts Add note field to CreateSecret class +4/-0      secret.e2e.spec.ts Add `note` field to secret endpoints                                          apps/api/src/secret/secret.e2e.spec.ts Add note field to the object passed to /secret endpoint Add assertions for the note field in the response of /secret endpoint Add note field to the object passed to /secret/:id endpoint Add assertions for the note field in the response of /secret/:id endpoint Add note field to the object passed to /secret/:id endpoint for updating a secret Add assertions for the note field in the response of /secret/:id endpoint for updating a secret +8/-3      secret.service.ts Add `note` field to secret service                                              apps/api/src/secret/service/secret.service.ts Import getDefaultEnvironmentOfProject from @prisma/client Fix typo in import statement for getDefaultEnvironmentOfProject Add note field to the object passed to createEvent function Add note field to the object passed to this.prisma.secret.create function Add note field to the object passed to this.prisma.secret.update function +4/-1      create.variable.ts Add `note` field to `CreateVariable` class                              apps/api/src/variable/dto/create.variable/create.variable.ts Add note field to CreateVariable class +4/-0      variable.service.ts Add `note` field to variable service                                          apps/api/src/variable/service/variable.service.ts Import getDefaultEnvironmentOfProject from @prisma/client Fix typo in import statement for getDefaultEnvironmentOfProject Add note field to the object passed to createEvent function Add note field to the object passed to this.prisma.variable.create function Add note field to the object passed to this.prisma.variable.update function +4/-1      variable.e2e.spec.ts Add `note` field to variable endpoints                                      apps/api/src/variable/variable.e2e.spec.ts Add note field to the object passed to /variable endpoint Add assertions for the note field in the response of /variable endpoint Add note field to the object passed to /variable/:id endpoint Add assertions for the note field in the response of /variable/:id endpoint Add note field to the object passed to /variable/:id endpoint for updating a variable Add assertions for the note field in the response of /variable/:id endpoint for updating a variable +8/-2      migration.sql Add `note` column to `Secret` and `Variable` tables            apps/api/src/prisma/migrations/20240222062319_add_note_to_secret_and_variable/migration.sql Add SQL statements to alter the Secret and Variable tables to include a note column +5/-0      schema.prisma Add `note` field to `Secret` and `Variable` models              apps/api/src/prisma/schema.prisma Add note field to the Secret model Add note field to the Variable model +2/-0

---

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

[nx-cloud]

☁️ Nx Cloud Report

CI is running/has finished running commands for commit afb4506. 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 (e9c9ac2)

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (7bb3d21) 62.20% compared to head (e9c9ac2) 94.28%.
Report is 18 commits behind head on develop.

❗ Current head e9c9ac2 differs from pull request most recent head afb4506. Consider uploading reports for the commit afb4506 to get more accurate results

Additional details and impacted files

@@             Coverage Diff              @@
##           develop     #151       +/-   ##
============================================
+ Coverage    62.20%   94.28%   +32.07%     
============================================
  Files           76       83        +7     
  Lines         1503     1575       +72     
  Branches       260      260               
============================================
+ Hits           935     1485      +550     
+ Misses         568       90      -478     

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

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.

[codiumai-pr-agent-free]

PR Review

(Review updated until commit afb4506)

PR feedback
⏱️ Estimated effort to review [1-5]	3, because the PR involves multiple files across different layers of the application (database schema, DTOs, service layer, and tests). The changes are straightforward but require careful review to ensure consistency and correct implementation of the new note field across all affected components.
🧪 Relevant tests	Yes
🔍 Possible issues	In secret.service.ts and variable.service.ts, when updating a secret or variable, the code does not check if the note field is provided before updating it. This could unintentionally overwrite existing notes with undefined if the note field is not included in the update request. The @Length(0, 100) validator is used for the note field in DTOs, but there is no corresponding database constraint to enforce this limit at the database level, potentially leading to data inconsistency.
🔒 Security concerns	No

Code feedback:

---

relevant file	apps/api/src/secret/dto/create.secret/create.secret.ts
suggestion	Consider adding a database constraint for the note field to enforce the maximum length of 100 characters, ensuring data integrity and consistency with the DTO validation. [important]
relevant line	@Length(0, 100)

---

relevant file	apps/api/src/secret/service/secret.service.ts
suggestion	Ensure the note field is only updated if provided in the DTO to prevent overwriting existing notes with undefined. Use conditional logic or a partial update pattern. [important]
relevant line	note: dto.note,

---

relevant file	apps/api/src/prisma/migrations/20240222062319_add_note_to_secret_and_variable/migration.sql
suggestion	Add a CHECK constraint to the note column in both Secret and Variable tables to enforce the maximum length of 100 characters, aligning with the DTO validation. [important]
relevant line	ALTER TABLE "Secret" ADD COLUMN "note" TEXT;

---

relevant file	apps/api/src/variable/service/variable.service.ts
suggestion	Similar to the secret service, ensure the note field in the variable service is only updated if provided to avoid unintentional data loss. Implement conditional updating logic. [important]
relevant line	note: dto.note,

---

---

✨ 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	Ensure the 'note' field is always treated as a string using the '@type' decorator. For the note field in the CreateSecret class, consider using @Type(() => String) decorator to ensure the value is always treated as a string, especially if there's a possibility of receiving non-string inputs. This can help avoid potential runtime errors or unexpected behavior. apps/api/src/secret/dto/create.secret/create.secret.ts [10-12] @IsString() @IsOptional() +@Type(() => String) note: string Use the '@type' decorator to ensure the 'note' field is treated as a string.  Similar to the CreateSecret class, for the note field in the CreateVariable class, it's advisable to use the @Type(() => String) decorator to ensure consistent treatment of the field as a string. apps/api/src/variable/dto/create.variable/create.variable.ts [10-12] @IsString() @IsOptional() +@Type(() => String) note: string Improve update logic to allow intentional setting of 'null' for the 'note' field. To avoid potential issues with updating a variable's note to null when not intended, explicitly check for undefined in the update logic instead of using the nullish coalescing operator (??). This ensures that null values can be intentionally set if needed. apps/api/src/variable/service/variable.service.ts [197] -note: dto.note ?? variable.note, +note: dto.note !== undefined ? dto.note : variable.note, Add a default value for the 'note' column to improve database consistency.    Consider adding a default value for the note column in both Secret and Variable tables to ensure consistency in the database. For instance, setting it to an empty string by default could avoid potential issues with NULL values. apps/api/src/prisma/migrations/20240222062319_add_note_to_secret_and_variable/migration.sql [2-5] -ALTER TABLE "Secret" ADD COLUMN "note" TEXT; -ALTER TABLE "Variable" ADD COLUMN "note" TEXT; +ALTER TABLE "Secret" ADD COLUMN "note" TEXT DEFAULT ''; +ALTER TABLE "Variable" ADD COLUMN "note" TEXT DEFAULT '';
bug	Prevent unintentional overwriting of notes by checking for 'undefined'.       When updating a secret's note, it's important to check if the note field is actually provided in the DTO to avoid unintentionally overwriting existing notes with null or undefined. Consider explicitly checking for undefined before assigning the new note value. apps/api/src/secret/service/secret.service.ts [173] -note: dto.note ?? secret.note, +note: dto.note !== undefined ? dto.note : secret.note,

---

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

[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]

/review

[codiumai-pr-agent-free]

Persistent review updated to latest commit afb4506

[rajdip-b]

🎉 This PR is included in version 1.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀