[FEATURE] Please add the signup errors to the documentation

[silacs]

As of now I have to test for every possible value a user can input myself (too short name, too short password, too long, age too young, invalid phone number, etc..) and that is very time consuming so it would be really really useful to have the possible errors that could happen during signup (like errors.invalid_phone_number for example).
the rest of the endpoints would not be too hard to test myself but the signup endpoint takes in a lot of data and I have to test for each of them.

[KostaD02]

Thank you for your suggestion! This is a great idea, and I agree it would be a valuable addition to the project. However, at the moment, we don’t have the time to implement it ourselves.

If you're interested, we'd be happy to guide you through the process if you’d like to contribute it yourself. Otherwise, we’ll keep this issue open in case someone from the community wants to take it on.

For temporary solution, you could use swagger to easily test each endpoint.

[silacs]

yeah sure I'd be happy to do it myself, just couldn't figure it out where the signup validation code was in the repo

[KostaD02]

yeah sure I'd be happy to do it myself, just couldn't figure it out where the signup validation code was in the repo

Most validations (easy ones) are in dto files. For example sign up:

src/modules/user/dtos/sign-up.dto.ts

export class SignUpDto {
  @IsString({
    message: AuthExpectionKeys.FirstnameShouldBeString,
  })
  @MinLength(API_CONFIG.MIN_FIRSTNAME_LENGTH, {
    message: AuthExpectionKeys.FirstnameTooShort,
  })
  @MaxLength(API_CONFIG.MAX_FIRSTNAME_LENGTH, {
    message: AuthExpectionKeys.LastnameTooLong,
  })
  firstName: string;

  @IsString({
    message: AuthExpectionKeys.LastnameShouldBeString,
  })
  @MinLength(API_CONFIG.MIN_LASTNAME_LENGTH, {
    message: AuthExpectionKeys.LastnameTooShort,
  })
  @MaxLength(API_CONFIG.MAX_LASTNAME_LENGTH, {
    message: AuthExpectionKeys.LastnameTooLong,
  })
  lastName: string;

  @IsNumber({}, { message: AuthExpectionKeys.InvalidAge })
  @IsPositive({ message: AuthExpectionKeys.InvalidAge })
  age: number;

  @IsEmail({}, { message: AuthExpectionKeys.InvalidEmail })
  email: string;

  @IsString({ message: AuthExpectionKeys.InvalidPassword })
  @MinLength(API_CONFIG.MIN_PASSWORD_LENGTH, {
    message: AuthExpectionKeys.PasswordTooShort,
  })
  @MaxLength(API_CONFIG.MAX_PASSWORD_LENGTH, {
    message: AuthExpectionKeys.PasswordTooLong,
  })
  password: string;

  @IsString({ message: AuthExpectionKeys.InvalidAddress })
  address: string;

  @IsPhoneNumber(null, { message: AuthExpectionKeys.InvalidPhoneNumber })
  phone: string;

  @IsString({ message: AuthExpectionKeys.InvalidZipcode })
  zipcode: string;

  @IsUrl({}, { message: AuthExpectionKeys.InvalidAvatar })
  avatar: string;

  @IsEnum(Gender, { message: AuthExpectionKeys.InvalidGender })
  gender: Gender;
}

Here is listed all error messages based on dto property.

But there are some errors which could happen even if dto is correct, for exmaple when user is registering with already used email.

src/modules/user/auth/auth.service.ts

 async verifyEmail(email: string, isFromSignUp = false) {
    const user = await this.userModel.findOne({ email });

    if (user) {
      if (user.verified) {
        this.exceptionService.throwError(
          ExceptionStatusKeys.BadRequest,
          `User with this '${email}' already verified`,
          AuthExpectionKeys.AlreadyVerified,
        );
      }
    ...

Would be great if you keep following the code and list all error 🚀

[silacs]

All right, will try but where's the code for the docs
I should just send a pull request afterward right?

[silacs]

Oh the docs are in docs lmao, I was looking in src

[KostaD02]

Yeah, PR should work

[silacs]

firstName shouldn't have lastnametoolong right?

[silacs]

any suggestions on styling? (both markdown and how the error cases should be written)

[silacs]

npm install doesn't work because of the canvas module, I think node is trying to build it manually, anything I found online was either about linux or macos, what os are yall using?

[CondensedMilk7]

I think a table might be a better format for describing these.

As for the npm install issue, could you post the error message you get?

[silacs]

yeah will table it tomorrow

npm warn deprecated vm2@3.9.19: The library contains critical security issues and should not be used for production! The maintenance of the project has been discontinued. Consider migrating your code to isolated-vm.
npm warn cleanup Failed to remove some directories [
npm warn cleanup   [
npm warn cleanup     '\\\\?\\E:\\Symtax\\Desktop\\everrest\\node_modules',
npm warn cleanup     [Error: EPERM: operation not permitted, rmdir 'E:\Symtax\Desktop\everrest\node_modules\@nestjs\cli\test\lib\compiler\hooks\fixtures\aliased-imports'] {
npm warn cleanup       errno: -4048,
npm warn cleanup       code: 'EPERM',
npm warn cleanup       syscall: 'rmdir',
npm warn cleanup       path: 'E:\\Symtax\\Desktop\\everrest\\node_modules\\@nestjs\\cli\\test\\lib\\compiler\\hooks\\fixtures\\aliased-imports'
npm warn cleanup     }
npm warn cleanup   ]
npm warn cleanup ]
npm error code 1
npm error path E:\Symtax\Desktop\everrest\node_modules\canvas
npm error command failed
npm error command C:\WINDOWS\system32\cmd.exe /d /s /c node-pre-gyp install --fallback-to-build --update-binary
npm error Warning: Missing input files:
npm error C:\GTK\bin\zlib1.dll
npm error C:\GTK\bin\libpangocairo-1.0-0.dll
npm error C:\GTK\bin\libexpat-1.dll
npm error C:\GTK\bin\libgobject-2.0-0.dll
npm error C:\GTK\bin\libpangoft2-1.0-0.dll
npm error C:\GTK\bin\libglib-2.0-0.dll
npm error C:\GTK\bin\libgthread-2.0-0.dll
npm error C:\GTK\bin\libpng14-14.dll
npm error C:\GTK\bin\libpango-1.0-0.dll
npm error C:\GTK\bin\libcairo-2.dll
npm error C:\GTK\bin\libfreetype-6.dll
npm error C:\GTK\bin\libpangowin32-1.0-0.dll
npm error C:\GTK\bin\libfontconfig-1.dll
npm error C:\GTK\bin\libintl-8.dll
npm error C:\GTK\bin\libgmodule-2.0-0.dll
npm error
npm error   Backend.cc
npm error E:\Symtax\Desktop\everrest\node_modules\canvas\src\backend\Backend.h(3,10): error C1083: Cannot open include file: 'cairo.h': No such file or directory [E:\Symtax\Desktop\everrest\node_modules\canvas\build\canvas.vcxproj]
npm error   (compiling source file '../src/backend/Backend.cc')
npm error
npm error Failed to execute 'E:\Programs\nodejs\node.exe C:\Users\Symtax\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\bin\node-gyp.js build --fallback-to-build --update-binary --module=E:\Symtax\Desktop\everrest\node_modules\canvas\build\Release\canvas.node --module_name=canvas --module_path=E:\Symtax\Desktop\everrest\node_modules\canvas\build\Release --napi_version=9 --node_abi_napi=napi --napi_build_version=0 --node_napi_label=node-v127' (1)
npm error node-pre-gyp info it worked if it ends with ok
npm error node-pre-gyp info using node-pre-gyp@1.0.11
npm error node-pre-gyp info using node@22.11.0 | win32 | x64
npm error (node:360) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
npm error (Use `node --trace-deprecation ...` to show where the warning was created)
npm error node-pre-gyp http GET https://github.com/Automattic/node-canvas/releases/download/v2.11.2/canvas-v2.11.2-node-v127-win32-unknown-x64.tar.gz
npm error node-pre-gyp ERR! install response status 404 Not Found on https://github.com/Automattic/node-canvas/releases/download/v2.11.2/canvas-v2.11.2-node-v127-win32-unknown-x64.tar.gz
npm error node-pre-gyp WARN Pre-built binaries not installable for canvas@2.11.2 and node@22.11.0 (node-v127 ABI, unknown) (falling back to source compile with node-gyp)
npm error node-pre-gyp WARN Hit error response status 404 Not Found on https://github.com/Automattic/node-canvas/releases/download/v2.11.2/canvas-v2.11.2-node-v127-win32-unknown-x64.tar.gz
npm error gyp info it worked if it ends with ok
npm error gyp info using node-gyp@11.0.0
npm error gyp info using node@22.11.0 | win32 | x64
npm error gyp info ok
npm error gyp info it worked if it ends with ok
npm error gyp info using node-gyp@11.0.0
npm error gyp info using node@22.11.0 | win32 | x64
npm error gyp info find Python using Python version 3.13.0 found at "C:\Program Files\Python\313\python.exe"
npm error gyp info find VS using VS2022 (17.12.35506.116) found at:
npm error gyp info find VS "E:\Programs\Microsoft Visual Studio\2022\Community"
npm error gyp info find VS run with --verbose for detailed information
npm error gyp info spawn C:\Program Files\Python\313\python.exe
npm error gyp info spawn args [
npm error gyp info spawn args 'C:\\Users\\Symtax\\AppData\\Roaming\\npm\\node_modules\\npm\\node_modules\\node-gyp\\gyp\\gyp_main.py',
npm error gyp info spawn args 'binding.gyp',
npm error gyp info spawn args '-f',
npm error gyp info spawn args 'msvs',
npm error gyp info spawn args '-I',
npm error gyp info spawn args 'E:\\Symtax\\Desktop\\everrest\\node_modules\\canvas\\build\\config.gypi',
npm error gyp info spawn args '-I',
npm error gyp info spawn args 'C:\\Users\\Symtax\\AppData\\Roaming\\npm\\node_modules\\npm\\node_modules\\node-gyp\\addon.gypi',
npm error gyp info spawn args '-I',
npm error gyp info spawn args 'C:\\Users\\Symtax\\AppData\\Local\\node-gyp\\Cache\\22.11.0\\include\\node\\common.gypi',
npm error gyp info spawn args '-Dlibrary=shared_library',
npm error gyp info spawn args '-Dvisibility=default',
npm error gyp info spawn args '-Dnode_root_dir=C:\\Users\\Symtax\\AppData\\Local\\node-gyp\\Cache\\22.11.0',
npm error gyp info spawn args '-Dnode_gyp_dir=C:\\Users\\Symtax\\AppData\\Roaming\\npm\\node_modules\\npm\\node_modules\\node-gyp',
npm error gyp info spawn args '-Dnode_lib_file=C:\\\\Users\\\\Symtax\\\\AppData\\\\Local\\\\node-gyp\\\\Cache\\\\22.11.0\\\\<(target_arch)\\\\node.lib',
npm error gyp info spawn args '-Dmodule_root_dir=E:\\Symtax\\Desktop\\everrest\\node_modules\\canvas',
npm error gyp info spawn args '-Dnode_engine=v8',
npm error gyp info spawn args '--depth=.',
npm error gyp info spawn args '--no-parallel',
npm error gyp info spawn args '--generator-output',
npm error gyp info spawn args 'E:\\Symtax\\Desktop\\everrest\\node_modules\\canvas\\build',
npm error gyp info spawn args '-Goutput_dir=.'
npm error gyp info spawn args ]
npm error gyp info ok
npm error gyp info it worked if it ends with ok
npm error gyp info using node-gyp@11.0.0
npm error gyp info using node@22.11.0 | win32 | x64
npm error gyp info spawn E:\Programs\Microsoft Visual Studio\2022\Community\MSBuild\Current\Bin\MSBuild.exe
npm error gyp info spawn args [
npm error gyp info spawn args 'build\\binding.sln',
npm error gyp info spawn args '/clp:Verbosity=minimal',
npm error gyp info spawn args '/nologo',
npm error gyp info spawn args '/p:Configuration=Release;Platform=x64'
npm error gyp info spawn args ]
npm error gyp ERR! build error
npm error gyp ERR! stack Error: `E:\Programs\Microsoft Visual Studio\2022\Community\MSBuild\Current\Bin\MSBuild.exe` failed with exit code: 1
npm error gyp ERR! stack at ChildProcess.<anonymous> (C:\Users\Symtax\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\lib\build.js:216:23)
npm error gyp ERR! stack at ChildProcess.emit (node:events:518:28)
npm error gyp ERR! stack at ChildProcess._handle.onexit (node:internal/child_process:293:12)
npm error gyp ERR! System Windows_NT 10.0.26100
npm error gyp ERR! command "E:\\Programs\\nodejs\\node.exe" "C:\\Users\\Symtax\\AppData\\Roaming\\npm\\node_modules\\npm\\node_modules\\node-gyp\\bin\\node-gyp.js" "build" "--fallback-to-build" "--update-binary" "--module=E:\\Symtax\\Desktop\\everrest\\node_modules\\canvas\\build\\Release\\canvas.node" "--module_name=canvas" "--module_path=E:\\Symtax\\Desktop\\everrest\\node_modules\\canvas\\build\\Release" "--napi_version=9" "--node_abi_napi=napi" "--napi_build_version=0" "--node_napi_label=node-v127"
npm error gyp ERR! cwd E:\Symtax\Desktop\everrest\node_modules\canvas
npm error gyp ERR! node -v v22.11.0
npm error gyp ERR! node-gyp -v v11.0.0
npm error gyp ERR! not ok
npm error node-pre-gyp ERR! build error
npm error node-pre-gyp ERR! stack Error: Failed to execute 'E:\Programs\nodejs\node.exe C:\Users\Symtax\AppData\Roaming\npm\node_modules\npm\node_modules\node-gyp\bin\node-gyp.js build --fallback-to-build --update-binary --module=E:\Symtax\Desktop\everrest\node_modules\canvas\build\Release\canvas.node --module_name=canvas --module_path=E:\Symtax\Desktop\everrest\node_modules\canvas\build\Release --napi_version=9 --node_abi_napi=napi --napi_build_version=0 --node_napi_label=node-v127' (1)
npm error node-pre-gyp ERR! stack     at ChildProcess.<anonymous> (E:\Symtax\Desktop\everrest\node_modules\@mapbox\node-pre-gyp\lib\util\compile.js:89:23)
npm error node-pre-gyp ERR! stack     at ChildProcess.emit (node:events:518:28)
npm error node-pre-gyp ERR! stack     at maybeClose (node:internal/child_process:1104:16)
npm error node-pre-gyp ERR! stack     at ChildProcess._handle.onexit (node:internal/child_process:304:5)
npm error node-pre-gyp ERR! System Windows_NT 10.0.26100
npm error node-pre-gyp ERR! command "E:\\Programs\\nodejs\\node.exe" "E:\\Symtax\\Desktop\\everrest\\node_modules\\@mapbox\\node-pre-gyp\\bin\\node-pre-gyp" "install" "--fallback-to-build" "--update-binary"
npm error node-pre-gyp ERR! cwd E:\Symtax\Desktop\everrest\node_modules\canvas
npm error node-pre-gyp ERR! node -v v22.11.0
npm error node-pre-gyp ERR! node-pre-gyp -v v1.0.11
npm error node-pre-gyp ERR! not ok
npm error A complete log of this run can be found in: C:\Users\Symtax\AppData\Local\npm-cache\_logs\2025-02-05T21_17_08_773Z-debug-0.log```