chore(api): Added type inference and runtime validation to process.env

[jamesfrye420]

User description

Feat: Added run time zod validation and type inference to Process.env
Chore: updated .env.example with REDIS Creds
Chore: added cross-env for cross compatibility between windows and linux env vars in package.json scripts.

Fixes #199 #179 #184

Dependencies

Zod - for runtime schema Validation
cross-env - for setting variables in package.json scripts across linux and windows.

Future Improvements

TODO: To add regex validation as indicated in the Schema File of Env.

Developer's checklist

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

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.

---

Type

enhancement, documentation

---

Description

• Integrated Zod for runtime validation of environment variables in app.module.ts, enhancing configuration robustness.
• Defined a comprehensive Zod schema in env.schema.ts for validating and documenting expected environment variables.
• Extended the ProcessEnv interface to type-check environment variables against the Zod schema.
• Updated .env.example and package.json to support new environment configurations and cross-platform compatibility.
• Added necessary dependencies (zod, cross-env) for the new features.

---

Changes walkthrough

	Relevant files
Enhancement	app.module.ts Integrate EnvSchema for Environment Variable Validation    apps/api/src/app/app.module.ts Integrated EnvSchema for runtime validation of environment variables in the configuration module. Added validation options to abort early and disallow unknown properties. +7/-1      env.schema.ts Define Zod Schema for Environment Variables                            apps/api/src/common/env/env.schema.ts Defined a new Zod schema for environment variables. Included optional and mandatory fields with detailed comments on handling empty strings and optional fields. +60/-0    env.d.ts Extend ProcessEnv with EnvSchema Types                                      apps/api/src/common/env/env.d.ts Extended ProcessEnv interface to include types defined in EnvSchema. +8/-0
Configuration changes	.env.example Update .env Example with Redis Variables                                  .env.example Added example environment variables for Redis. +3/-0
Dependencies	package.json Add Zod to API Package Dependencies                                            apps/api/package.json Added zod to dependencies for schema validation. +2/-1      package.json Integrate cross-env for Cross-Platform Compatibility          package.json Added cross-env to dependencies for cross-platform environment variable support. Updated scripts to use cross-env for setting environment variables. +4/-3      pnpm-lock.yaml Update Lock File with New Dependencies                                      pnpm-lock.yaml Updated lock file with new dependencies cross-env and zod. +18/-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 (0339e74)

[codiumai-pr-agent-free]

PR Review

⏱️ Estimated effort to review [1-5]	3, because the PR introduces significant changes including runtime validation of environment variables, updates to configuration files, and modifications to existing TypeScript code. The complexity of the changes, especially with the integration of Zod for schema validation, requires a thorough review to ensure everything is correctly implemented and no regressions are introduced.
🧪 Relevant tests	Yes
🔍 Possible issues	Possible Bug: The Zod schema validation in env.schema.ts might not properly handle cases where environment variables are set to empty strings, which could lead to unexpected behavior if not managed correctly.
	Code Consistency: The removal of semicolons in some TypeScript files might lead to inconsistencies in coding style, which could affect maintainability.
🔒 Security concerns	No

---

✨ Review tool usage guide:

---

Overview:
The review tool scans the PR code changes, and generates a PR review which includes several types of feedbacks, such as possible PR issues, security threats and relevant test in the PR. More feedbacks can be added by configuring the tool.

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

See the review usage page for a comprehensive guide on using this tool.

[codiumai-pr-agent-free]

PR Code Suggestions

Category	Suggestions
Enhancement	Add a custom error message for environment variable validation failures. Consider adding a custom error message for the validation failure in the ConfigModule configuration. This will help developers understand what went wrong when the environment variables do not meet the expected schema. apps/api/src/app/app.module.ts [31-35] -validate: EnvSchema.parse, +validate: (config) => { + try { + return EnvSchema.parse(config); + } catch (e) { + throw new Error(`Validation error: ${e.message}`); + } +}, validationOptions: { allowUnknown: false, abortEarly: true }
	Add a test case for strings with leading or trailing spaces in the validation pipe tests. Add a test case to specifically check for strings that contain leading or trailing spaces, ensuring the AlphanumericReasonValidationPipe handles them correctly. apps/api/src/common/alphanumeric-reason-pipe.spec.ts [16-18] -it('should not allow strings with only spaces', () => { - expect(() => pipe.transform(' ')).toThrow(BadRequestException) +it('should not allow strings with leading or trailing spaces', () => { + expect(() => pipe.transform(' Test123 ')).toThrow(BadRequestException) })
Bug	Ensure no leading or trailing spaces are allowed by trimming the input in the validation pipe. Refactor the regular expression to ensure it does not allow leading or trailing spaces in the AlphanumericReasonValidationPipe. The current implementation might not fully enforce this requirement. apps/api/src/common/alphanumeric-reason-pipe.ts [6-11] -if (/^[a-zA-Z0-9]+(?: [a-zA-Z0-9]+)*$/.test(value)) { - return value +if (/^[a-zA-Z0-9]+(?: [a-zA-Z0-9]+)*$/.test(value.trim())) { + return value.trim() } else { throw new BadRequestException( 'Reason must contain only alphanumeric characters and no leading or trailing spaces.' ) }
Security	Enforce a minimum length for the REDIS_PASSWORD to prevent empty values. Add a minimum length requirement to the REDIS_PASSWORD field in the EnvSchema to ensure it is not empty, addressing the issue noted in the comments about Zod's behavior with empty strings. apps/api/src/common/env/env.schema.ts [26] -REDIS_PASSWORD: z.string().optional(), +REDIS_PASSWORD: z.string().min(1).optional(),
Best practice	Use specific Zod validators for email and URL fields to ensure proper formats. Consider using more specific Zod validators for email and URL fields in EnvSchema to ensure the values conform to expected formats. apps/api/src/common/env/env.schema.ts [23-59] -ADMIN_EMAIL: z.string(), +ADMIN_EMAIL: z.string().email(), WEB_FRONTEND_URL: z.string().url(),

---

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

See the improve usage page for a comprehensive guide on using this tool.

[rajdip-b]

@jamesfrye420 could you please make the 2 required changes? We can merge it asap!

[rajdip-b]

/review

[sonarqubecloud]

Quality Gate passed

Issues
3 New issues
0 Accepted 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.3.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀