How to use the class-validator conditional validation decorator (@ValidateIf) based on environment variable value

When performing data validation with class-validator, it is often necessary to conditionally apply validation rules based on the values of environment variables. In such cases, we can utilize the @ValidateIf decorator from the class-validator library to implement conditional validation. The @ValidateIf decorator allows us to define a function that returns a boolean value, determining whether validation should be applied to a specific field.

Example Scenario

Suppose we have a Node.js application with a user-configurable environment variable NODE_ENV, which identifies the current runtime environment (e.g., development, production). We need to validate the user's email address for validity in production environments, but in development environments, we can skip strict validation to facilitate testing.

Code Implementation

First, ensure that class-validator and class-transformer are installed:

bash
npm install class-validator class-transformer

Then, we can create a User class and use the @ValidateIf decorator to decide whether to perform email validation based on the environment variable:

typescript
import { validateOrReject, IsEmail, ValidateIf } from 'class-validator';

class User {
  @ValidateIf(o => process.env.NODE_ENV === 'production')
  @IsEmail({}, { message: 'Invalid email format' })
  email?: string;

  constructor(email?: string) {
    this.email = email;
  }
}

async function validateUser(user: User) {
  try {
    await validateOrReject(user);
    console.log('Validation successful!');
  } catch (errors) {
    console.log('Validation failed:', errors);
  }
}

// Example test
// Assume you are running in development environment, NODE_ENV=development
const userDev = new User('test@');
validateUser(userDev);  // Should pass validation since we are not in production

// Assume you are running in production environment, NODE_ENV=production
const userProd = new User('test@');
validateUser(userProd);  // Should fail validation due to invalid email format

Important Notes

1. Environment Variable Management: In actual applications, environment variables are typically managed via .env files and loaded using libraries like dotenv.
2. Asynchronous Validation: The validateOrReject function is asynchronous, so appropriate asynchronous logic must be handled.
3. Error Handling: The example simply prints error messages; in real applications, more detailed error handling strategies may be required.

By implementing the above, we can flexibly apply validation rules based on different environmental requirements, ensuring the application works as expected in both development and production environments.