test(common): Fix isEmptyArray behavior and update tests

BrahimAbdelli · BrahimAbdelli · commit 400f6e8c59fe · 2025-04-11T07:04:53.000+02:00
- Fix isEmptyArray to return false for non-array values and array-like objects

- Update tests to align with the new behavior

- Add comprehensive test coverage for edge cases
diff --git a/packages/common/pipes/file/parse-file.pipe.ts b/packages/common/pipes/file/parse-file.pipe.ts
@@ -2,7 +2,7 @@ import { Injectable, Optional } from '../../decorators/core';
 import { HttpStatus } from '../../enums';
 import { PipeTransform } from '../../interfaces/features/pipe-transform.interface';
 import { HttpErrorByCode } from '../../utils/http-error-by-code.util';
-import { isEmpty, isObject, isUndefined } from '../../utils/shared.utils';
+import { isEmptyArray, isObject, isUndefined } from '../../utils/shared.utils';
 import { FileValidator } from './file-validator.interface';
 import { ParseFileOptions } from './parse-file-options.interface';
 
@@ -60,9 +60,8 @@ export class ParseFilePipe implements PipeTransform<any> {
   }
 
   private thereAreNoFilesIn(value: any): boolean {
-    const isEmptyArray = Array.isArray(value) && isEmpty(value);
-    const isEmptyObject = isObject(value) && isEmpty(Object.keys(value));
-    return isUndefined(value) || isEmptyArray || isEmptyObject;
+    const isEmptyObject = isObject(value) && isEmptyArray(Object.keys(value));
+    return isUndefined(value) || isEmptyArray(value) || isEmptyObject;
   }
 
   protected async validate(file: any): Promise<any> {
diff --git a/packages/common/test/utils/shared.utils.spec.ts b/packages/common/test/utils/shared.utils.spec.ts
@@ -2,7 +2,7 @@ import { expect } from 'chai';
 import {
   addLeadingSlash,
   isConstructor,
-  isEmpty,
+  isEmptyArray,
   isFunction,
   isNil,
   isNumber,
@@ -199,20 +199,43 @@ describe('Shared utils', () => {
     });
   });
 
-  describe('isEmpty', () => {
-    it('should return true when array is empty or not exists', () => {
-      expect(isEmpty([])).to.be.true;
-      expect(isEmpty(null)).to.be.true;
-      expect(isEmpty(undefined)).to.be.true;
+  describe('isEmptyArray', () => {
+    it('should return true when array is empty', () => {
+      expect(isEmptyArray([])).to.be.true;
     });
+
     it('should return false when array is not empty', () => {
-      expect(isEmpty([1, 2])).to.be.false;
+      expect(isEmptyArray([1, 2])).to.be.false;
+      expect(isEmptyArray(['a', 'b', 'c'])).to.be.false;
+      expect(isEmptyArray([{}])).to.be.false;
+    });
+
+    it('should return false for non-array values', () => {
+      expect(isEmptyArray(null)).to.be.false;
+      expect(isEmptyArray(undefined)).to.be.false;
+      expect(isEmptyArray({})).to.be.false;
+      expect(isEmptyArray('')).to.be.false;
+      expect(isEmptyArray(0)).to.be.false;
+      expect(isEmptyArray(false)).to.be.false;
+      expect(isEmptyArray(Symbol())).to.be.false;
+      expect(isEmptyArray(() => {})).to.be.false;
+    });
+
+    it('should return false for array-like objects', () => {
+      expect(isEmptyArray({ length: 0 })).to.be.false;
+      expect(isEmptyArray({ length: 1 })).to.be.false;
+    });
+
+    it('should return false for sparse arrays', () => {
+      const sparseArray = new Array(3);
+      expect(isEmptyArray(sparseArray)).to.be.false;
     });
-    it('should return true for non-array values', () => {
-      expect(isEmpty({})).to.be.true;
-      expect(isEmpty('')).to.be.true;
-      expect(isEmpty(0)).to.be.true;
-      expect(isEmpty(false)).to.be.true;
+  });
+
+  describe('stripEndSlash', () => {
+    it('should strip end slash if present', () => {
+      expect(stripEndSlash('/cats/')).to.equal('/cats');
+      expect(stripEndSlash('/cats')).to.equal('/cats');
     });
   });
 
diff --git a/packages/common/utils/shared.utils.ts b/packages/common/utils/shared.utils.ts
@@ -54,8 +54,12 @@ export const isConstructor = (val: unknown): boolean => val === 'constructor';
 export const isNil = (val: unknown): val is null | undefined =>
   isUndefined(val) || val === null;
 
-export const isEmpty = (array: unknown): boolean =>
-  !(Array.isArray(array) && array.length > 0);
+export const isEmptyArray = (array: unknown): boolean => {
+  if (!Array.isArray(array)) {
+    return false;
+  }
+  return array.length === 0;
+};
 
 export const isSymbol = (val: unknown): val is symbol =>
   typeof val === 'symbol';
diff --git a/packages/core/exceptions/base-exception-filter-context.ts b/packages/core/exceptions/base-exception-filter-context.ts
@@ -1,7 +1,7 @@
 import { FILTER_CATCH_EXCEPTIONS } from '@nestjs/common/constants';
 import { Type } from '@nestjs/common/interfaces';
 import { ExceptionFilter } from '@nestjs/common/interfaces/exceptions/exception-filter.interface';
-import { isEmpty, isFunction } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray, isFunction } from '@nestjs/common/utils/shared.utils';
 import { iterate } from 'iterare';
 import { ContextCreator } from '../helpers/context-creator';
 import { STATIC_CONTEXT } from '../injector/constants';
@@ -20,7 +20,7 @@ export class BaseExceptionFilterContext extends ContextCreator {
     contextId = STATIC_CONTEXT,
     inquirerId?: string,
   ): R {
-    if (isEmpty(metadata)) {
+    if (isEmptyArray(metadata)) {
       return [] as any[] as R;
     }
     return iterate(metadata)
diff --git a/packages/core/exceptions/exceptions-handler.ts b/packages/core/exceptions/exceptions-handler.ts
@@ -2,7 +2,7 @@ import { HttpException } from '@nestjs/common';
 import { ExceptionFilterMetadata } from '@nestjs/common/interfaces/exceptions/exception-filter-metadata.interface';
 import { ArgumentsHost } from '@nestjs/common/interfaces/features/arguments-host.interface';
 import { selectExceptionFilterMetadata } from '@nestjs/common/utils/select-exception-filter-metadata.util';
-import { isEmpty } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray } from '@nestjs/common/utils/shared.utils';
 import { InvalidExceptionFilterException } from '../errors/exceptions/invalid-exception-filter.exception';
 import { BaseExceptionFilter } from './base-exception-filter';
 
@@ -27,7 +27,7 @@ export class ExceptionsHandler extends BaseExceptionFilter {
     exception: T,
     ctx: ArgumentsHost,
   ): boolean {
-    if (isEmpty(this.filters)) {
+    if (isEmptyArray(this.filters)) {
       return false;
     }
 
diff --git a/packages/core/exceptions/external-exception-filter-context.ts b/packages/core/exceptions/external-exception-filter-context.ts
@@ -1,7 +1,7 @@
 import { EXCEPTION_FILTERS_METADATA } from '@nestjs/common/constants';
 import { Controller } from '@nestjs/common/interfaces';
 import { ExceptionFilterMetadata } from '@nestjs/common/interfaces/exceptions';
-import { isEmpty } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray } from '@nestjs/common/utils/shared.utils';
 import { iterate } from 'iterare';
 import { ApplicationConfig } from '../application-config';
 import { STATIC_CONTEXT } from '../injector/constants';
@@ -36,7 +36,7 @@ export class ExternalExceptionFilterContext extends BaseExceptionFilterContext {
       contextId,
       inquirerId,
     );
-    if (isEmpty(filters)) {
+    if (isEmptyArray(filters)) {
       return exceptionHandler;
     }
     exceptionHandler.setCustomFilters(filters.reverse());
diff --git a/packages/core/exceptions/external-exceptions-handler.ts b/packages/core/exceptions/external-exceptions-handler.ts
@@ -1,7 +1,7 @@
 import { ExceptionFilterMetadata } from '@nestjs/common/interfaces/exceptions';
 import { ArgumentsHost } from '@nestjs/common/interfaces/features/arguments-host.interface';
 import { selectExceptionFilterMetadata } from '@nestjs/common/utils/select-exception-filter-metadata.util';
-import { isEmpty } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray } from '@nestjs/common/utils/shared.utils';
 import { InvalidExceptionFilterException } from '../errors/exceptions/invalid-exception-filter.exception';
 import { ExternalExceptionFilter } from './external-exception-filter';
 
@@ -27,7 +27,7 @@ export class ExternalExceptionsHandler extends ExternalExceptionFilter {
     exception: T,
     host: ArgumentsHost,
   ): Promise<any> | null {
-    if (isEmpty(this.filters)) {
+    if (isEmptyArray(this.filters)) {
       return null;
     }
 
diff --git a/packages/core/guards/guards-consumer.ts b/packages/core/guards/guards-consumer.ts
@@ -1,6 +1,6 @@
 import { CanActivate } from '@nestjs/common';
 import { ContextType, Controller } from '@nestjs/common/interfaces';
-import { isEmpty } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray } from '@nestjs/common/utils/shared.utils';
 import { lastValueFrom, Observable } from 'rxjs';
 import { ExecutionContextHost } from '../helpers/execution-context-host';
 
@@ -12,7 +12,7 @@ export class GuardsConsumer {
     callback: (...args: unknown[]) => unknown,
     type?: TContext,
   ): Promise<boolean> {
-    if (!guards || isEmpty(guards)) {
+    if (!guards || isEmptyArray(guards)) {
       return true;
     }
     const context = this.createContext(args, instance, callback);
diff --git a/packages/core/guards/guards-context-creator.ts b/packages/core/guards/guards-context-creator.ts
@@ -1,7 +1,7 @@
 import { CanActivate } from '@nestjs/common';
 import { GUARDS_METADATA } from '@nestjs/common/constants';
 import { Controller, Type } from '@nestjs/common/interfaces';
-import { isEmpty, isFunction } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray, isFunction } from '@nestjs/common/utils/shared.utils';
 import { iterate } from 'iterare';
 import { ApplicationConfig } from '../application-config';
 import { ContextCreator } from '../helpers/context-creator';
@@ -41,7 +41,7 @@ export class GuardsContextCreator extends ContextCreator {
     contextId = STATIC_CONTEXT,
     inquirerId?: string,
   ): R {
-    if (isEmpty(metadata)) {
+    if (isEmptyArray(metadata)) {
       return [] as unknown[] as R;
     }
     return iterate(metadata)
diff --git a/packages/core/helpers/external-context-creator.ts b/packages/core/helpers/external-context-creator.ts
@@ -5,7 +5,7 @@ import {
   Controller,
   PipeTransform,
 } from '@nestjs/common/interfaces';
-import { isEmpty } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray } from '@nestjs/common/utils/shared.utils';
 import { isObservable, lastValueFrom } from 'rxjs';
 import { ExternalExceptionFilterContext } from '../exceptions/external-exception-filter-context';
 import { GuardsConsumer, GuardsContextCreator } from '../guards';
@@ -323,7 +323,7 @@ export class ExternalContextCreator {
     { metatype, type, data }: { metatype: any; type: any; data: any },
     pipes: PipeTransform[],
   ): Promise<any> {
-    return isEmpty(pipes)
+    return isEmptyArray(pipes)
       ? value
       : this.pipesConsumer.apply(value, { metatype, type, data }, pipes);
   }
diff --git a/packages/core/interceptors/interceptors-consumer.ts b/packages/core/interceptors/interceptors-consumer.ts
@@ -4,7 +4,7 @@ import {
   ContextType,
   Controller,
 } from '@nestjs/common/interfaces';
-import { isEmpty } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray } from '@nestjs/common/utils/shared.utils';
 import { AsyncResource } from 'async_hooks';
 import { Observable, defer, from as fromPromise } from 'rxjs';
 import { mergeAll, switchMap } from 'rxjs/operators';
@@ -19,7 +19,7 @@ export class InterceptorsConsumer {
     next: () => Promise<unknown>,
     type?: TContext,
   ): Promise<unknown> {
-    if (isEmpty(interceptors)) {
+    if (isEmptyArray(interceptors)) {
       return next();
     }
     const context = this.createContext(args, instance, callback);
diff --git a/packages/core/interceptors/interceptors-context-creator.ts b/packages/core/interceptors/interceptors-context-creator.ts
@@ -1,6 +1,6 @@
 import { INTERCEPTORS_METADATA } from '@nestjs/common/constants';
 import { Controller, NestInterceptor, Type } from '@nestjs/common/interfaces';
-import { isEmpty, isFunction } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray, isFunction } from '@nestjs/common/utils/shared.utils';
 import { iterate } from 'iterare';
 import { ApplicationConfig } from '../application-config';
 import { ContextCreator } from '../helpers/context-creator';
@@ -40,7 +40,7 @@ export class InterceptorsContextCreator extends ContextCreator {
     contextId = STATIC_CONTEXT,
     inquirerId?: string,
   ): R {
-    if (isEmpty(metadata)) {
+    if (isEmptyArray(metadata)) {
       return [] as any[] as R;
     }
     return iterate(metadata)
diff --git a/packages/core/nest-application-context.ts b/packages/core/nest-application-context.ts
@@ -13,7 +13,7 @@ import {
   Type,
 } from '@nestjs/common/interfaces';
 import { NestApplicationContextOptions } from '@nestjs/common/interfaces/nest-application-context-options.interface';
-import { isEmpty } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray } from '@nestjs/common/utils/shared.utils';
 import { iterate } from 'iterare';
 import { MESSAGES } from './constants';
 import { UnknownModuleException } from './errors/exceptions';
@@ -320,7 +320,7 @@ export class NestApplicationContext<
    * @returns {this} The Nest application context instance
    */
   public enableShutdownHooks(signals: (ShutdownSignal | string)[] = []): this {
-    if (isEmpty(signals)) {
+    if (isEmptyArray(signals)) {
       signals = Object.keys(ShutdownSignal).map(
         (key: string) => ShutdownSignal[key],
       );
diff --git a/packages/core/pipes/pipes-context-creator.ts b/packages/core/pipes/pipes-context-creator.ts
@@ -1,6 +1,6 @@
 import { PIPES_METADATA } from '@nestjs/common/constants';
 import { Controller, PipeTransform, Type } from '@nestjs/common/interfaces';
-import { isEmpty, isFunction } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray, isFunction } from '@nestjs/common/utils/shared.utils';
 import { iterate } from 'iterare';
 import { ApplicationConfig } from '../application-config';
 import { ContextCreator } from '../helpers/context-creator';
@@ -40,7 +40,7 @@ export class PipesContextCreator extends ContextCreator {
     contextId = STATIC_CONTEXT,
     inquirerId?: string,
   ): R {
-    if (isEmpty(metadata)) {
+    if (isEmptyArray(metadata)) {
       return [] as any[] as R;
     }
     return iterate(metadata)
diff --git a/packages/core/router/router-exception-filters.ts b/packages/core/router/router-exception-filters.ts
@@ -1,7 +1,7 @@
 import { HttpServer } from '@nestjs/common';
 import { EXCEPTION_FILTERS_METADATA } from '@nestjs/common/constants';
 import { Controller } from '@nestjs/common/interfaces/controllers/controller.interface';
-import { isEmpty } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray } from '@nestjs/common/utils/shared.utils';
 import { iterate } from 'iterare';
 import { ApplicationConfig } from '../application-config';
 import { BaseExceptionFilterContext } from '../exceptions/base-exception-filter-context';
@@ -37,7 +37,7 @@ export class RouterExceptionFilters extends BaseExceptionFilterContext {
       contextId,
       inquirerId,
     );
-    if (isEmpty(filters)) {
+    if (isEmptyArray(filters)) {
       return exceptionHandler;
     }
     exceptionHandler.setCustomFilters(filters.reverse());
diff --git a/packages/core/router/router-execution-context.ts b/packages/core/router/router-execution-context.ts
@@ -18,7 +18,7 @@ import {
 import { RouteParamMetadata } from '@nestjs/common/decorators';
 import { RouteParamtypes } from '@nestjs/common/enums/route-paramtypes.enum';
 import { ContextType, Controller } from '@nestjs/common/interfaces';
-import { isEmpty, isString } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray, isString } from '@nestjs/common/utils/shared.utils';
 import { IncomingMessage } from 'http';
 import { Observable } from 'rxjs';
 import {
@@ -238,7 +238,7 @@ export class RouterExecutionContext {
       : this.responseController.getStatusByMethod(requestMethod);
 
     const responseHeaders = this.reflectResponseHeaders(callback);
-    const hasCustomHeaders = !isEmpty(responseHeaders);
+    const hasCustomHeaders = !isEmptyArray(responseHeaders);
     const handlerMetadata: HandlerMetadata = {
       argsLength,
       fnHandleResponse,
@@ -332,7 +332,7 @@ export class RouterExecutionContext {
     }: { metatype: unknown; type: RouteParamtypes; data: unknown },
     pipes: PipeTransform[],
   ): Promise<unknown> {
-    if (!isEmpty(pipes)) {
+    if (!isEmptyArray(pipes)) {
       return this.pipesConsumer.apply(
         value,
         { metatype, type, data } as any,
diff --git a/packages/core/services/reflector.service.ts b/packages/core/services/reflector.service.ts
@@ -1,5 +1,5 @@
 import { CustomDecorator, SetMetadata, Type } from '@nestjs/common';
-import { isEmpty, isObject } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray, isObject } from '@nestjs/common/utils/shared.utils';
 import { uid } from 'uid';
 
 /**
@@ -200,7 +200,7 @@ export class Reflector {
       targets,
     ).filter(item => item !== undefined);
 
-    if (isEmpty(metadataCollection)) {
+    if (isEmptyArray(metadataCollection)) {
       return metadataCollection as TResult;
     }
     if (metadataCollection.length === 1) {
diff --git a/packages/microservices/context/exception-filters-context.ts b/packages/microservices/context/exception-filters-context.ts
@@ -1,6 +1,6 @@
 import { EXCEPTION_FILTERS_METADATA } from '@nestjs/common/constants';
 import { Controller } from '@nestjs/common/interfaces/controllers/controller.interface';
-import { isEmpty } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray } from '@nestjs/common/utils/shared.utils';
 import { ApplicationConfig } from '@nestjs/core/application-config';
 import { BaseExceptionFilterContext } from '@nestjs/core/exceptions/base-exception-filter-context';
 import { STATIC_CONTEXT } from '@nestjs/core/injector/constants';
@@ -38,7 +38,7 @@ export class ExceptionFiltersContext extends BaseExceptionFilterContext {
       contextId,
       inquirerId,
     );
-    if (isEmpty(filters)) {
+    if (isEmptyArray(filters)) {
       return exceptionHandler;
     }
     exceptionHandler.setCustomFilters(filters.reverse());
diff --git a/packages/microservices/context/rpc-context-creator.ts b/packages/microservices/context/rpc-context-creator.ts
@@ -7,7 +7,7 @@ import {
   Controller,
   PipeTransform,
 } from '@nestjs/common/interfaces';
-import { isEmpty } from '@nestjs/common/utils/shared.utils';
+import { isEmptyArray } from '@nestjs/common/utils/shared.utils';
 import { FORBIDDEN_MESSAGE } from '@nestjs/core/guards/constants';
 import { GuardsConsumer } from '@nestjs/core/guards/guards-consumer';
 import { GuardsContextCreator } from '@nestjs/core/guards/guards-context-creator';
@@ -276,7 +276,7 @@ export class RpcContextCreator {
     { metatype, type, data }: { metatype: any; type: any; data: any },
     pipes: PipeTransform[],
   ): Promise<any> {
-    return isEmpty(pipes)
+    return isEmptyArray(pipes)
       ? value
       : this.pipesConsumer.apply(value, { metatype, type, data }, pipes);
   }
diff --git a/packages/microservices/exceptions/rpc-exceptions-handler.ts b/packages/microservices/exceptions/rpc-exceptions-handler.ts
diff --git a/packages/websockets/context/exception-filters-context.ts b/packages/websockets/context/exception-filters-context.ts
diff --git a/packages/websockets/context/ws-context-creator.ts b/packages/websockets/context/ws-context-creator.ts
diff --git a/packages/websockets/exceptions/ws-exceptions-handler.ts b/packages/websockets/exceptions/ws-exceptions-handler.ts
