feat(api): Add requireRestart parameter

[yogesh1801]

User description

Description

Added requireRestart param

Fixes #283

Developer's checklist

• My PR follows the style guidelines of this project
• I have performed a self-check on my work

If changes are made in the code:

• I have followed the coding guidelines
• My changes in code generate no new warnings
• My changes are breaking another fix/feature of the project
• I have added test cases to show that my feature works
• I have added relevant screenshots in my PR
• There are no UI/UX issues

Documentation Update

• This PR requires an update to the documentation at docs.keyshade.xyz
• I have made the necessary updates to the documentation, or no documentation changes are required.

---

PR Type

Enhancement, Documentation

---

Description

• Added requireRestart boolean property to CreateSecret and CreateVariable classes.
• Integrated requireRestart in secret and variable service operations, including creation, update, and rollback.
• Updated Prisma schema and migration scripts to include requireRestart field in Secret and Variable models.
• Added missing newline at the end of workspace-storage.ts file.

---

Changes walkthrough 📝

	Relevant files
Enhancement	create.secret.ts Add `requireRestart` property to `CreateSecret` class        apps/api/src/secret/dto/create.secret/create.secret.ts Added requireRestart boolean property to CreateSecret class. Marked requireRestart as optional. +5/-0      secret.service.ts Integrate `requireRestart` in secret service operations    apps/api/src/secret/service/secret.service.ts Included requireRestart in secret creation and update logic. Added requireRestart to the payload for secret rollback. +4/-0      create.variable.ts Add `requireRestart` property to `CreateVariable` class    apps/api/src/variable/dto/create.variable/create.variable.ts Added requireRestart boolean property to CreateVariable class. Marked requireRestart as optional. +5/-0      variable.service.ts Integrate `requireRestart` in variable service operations apps/api/src/variable/service/variable.service.ts Included requireRestart in variable creation and update logic. Added requireRestart to the payload for variable rollback. +4/-0      migration.sql Add `requireRestart` column to database schema                      apps/api/src/prisma/migrations/20240625190757_new/migration.sql Added requireRestart column to Secret and Variable tables with default value false. +5/-0      schema.prisma Update Prisma schema with `requireRestart` field                  apps/api/src/prisma/schema.prisma Added requireRestart boolean field to Secret and Variable models with default value false. +2/-0
Formatting	workspace-storage.ts Add newline at end of workspace storage file                          apps/platform/src/lib/workspace-storage.ts Added missing newline at the end of the file. +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 Reviewer Guide 🔍

⏱️ Estimated effort to review [1-5]	3
🧪 Relevant tests	No
🔒 Security concerns	No
⚡ Key issues to review	Possible Bug: The requireRestart field is optional in DTOs but not nullable in the Prisma schema for the Variable model. This inconsistency could lead to runtime errors when requireRestart is not provided.
	Data Integrity: The default behavior for requireRestart in the Secret model is nullable with a default of false, which is inconsistent with the Variable model where it is non-nullable. Consider aligning these behaviors to maintain consistency across similar features.

[codiumai-pr-agent-free]

PR Code Suggestions ✨

Category	Suggestion	Score
Possible bug	Add a null check for requireRestart to prevent runtime errors Add a null check for dto.requireRestart before using it in the create method to prevent potential runtime errors if the field is not provided in the DTO. apps/api/src/secret/service/secret.service.ts [91] -requireRestart: dto.requireRestart, +requireRestart: dto.requireRestart ?? false, Suggestion importance[1-10]: 10 Why: Adding a null check for requireRestart before using it in the create method is crucial to prevent potential runtime errors if the field is not provided. This is an important fix for ensuring the stability of the application.	10
Possible issue	Make the requireRestart field optional in the Variable model Ensure consistency in the database schema by making the requireRestart field optional in the Variable model, similar to its definition in the Secret model. This change will help maintain uniformity and potentially avoid runtime errors due to null values. apps/api/src/prisma/schema.prisma [404] -requireRestart Boolean @default(false) +requireRestart Boolean? @default(false) Suggestion importance[1-10]: 9 Why: Ensuring consistency between the Secret and Variable models by making the requireRestart field optional helps maintain uniformity and prevents potential runtime errors due to null values. This is a significant improvement for consistency and reliability.	9
Enhancement	Initialize the requireRestart field with a default value Consider initializing the requireRestart field with a default value to ensure consistent behavior across different parts of the application where this DTO might be used without explicitly setting this field. apps/api/src/secret/dto/create.secret/create.secret.ts [27] @IsOptional() -requireRestart?: boolean +requireRestart?: boolean = false Suggestion importance[1-10]: 8 Why: Initializing the requireRestart field with a default value ensures consistent behavior and avoids potential issues when the field is not explicitly set. This is a good enhancement for robustness.	8

[rajdip-b]

Hey bro! Glad that you put up the PR. Are you attempting this for FOSS hack? If so, the PR will need to wait. If not, we can start reviewing it asap!

[yogesh1801]

@rajdip-b this PR is my attempt to get familiar with the codebase, will attempt fosshack later, you can review this PR

[rajdip-b]

Could you also add these few test cases?

• Creating a secret with requireRestart set to true
• Creating a variable with requireRestart set to true
• Updating a secret with requireRestart set to true
• Updating a variable with requireRestart set to true

[rajdip-b]

Update the interface over here