Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: support type UUID from node's crypto package #2797

Merged
merged 1 commit into from
Feb 7, 2024

Conversation

TheSalarKhan
Copy link

@TheSalarKhan TheSalarKhan commented Jan 25, 2024

PR Checklist

Please check if your PR fulfills the following requirements:

PR Type

What kind of change does this PR introduce?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • CI related changes
  • Other... Please describe:

What is the current behavior?

Using the UUID type from node's crypto package with the @nestjs/swagger plugin enabled crashes nestjs start npm run start with a cryptic error message.

Error: A circular dependency has been detected (property key: "id"). Please, make sure that each side of a bidirectional relationships are using lazy resolvers ("type: () => ClassType").

Example dto

import { UUID } from 'crypto';

export class CreateUserDto {
  name: string;

  id: UUID;
}

This problem goes away when the IsUUID() decorator from class-validator package is used. But considering the fact that UUID is an alias type UUID = `${string}-${string}-${string}-${string}-${string}`; the inferred type without any help should be string

Issue Number: N/A

What is the new behavior?

After this change, if the plugin is enabled, and no decorator is used on a property of type crypto.UUID then its type gets inferred as string in the openapi spec.

Does this PR introduce a breaking change?

  • Yes
  • No

Other information

@kamilmysliwiec kamilmysliwiec merged commit 1d86dfd into nestjs:master Feb 7, 2024
1 check passed
@kamilmysliwiec
Copy link
Member

lgtm

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants