fix(common): mark parse date pipe options as optional (#17780)

`ParseDatePipe` is the only built-in pipe whose constructor argument is not
decorated with `@Optional()`. The `= {}` default does not cover this, because
the injector never calls the constructor with a missing argument: it resolves
parameters from `design:paramtypes`, which is `Object` for an interface, and
then fails to find a provider for it.

As a result, passing the pipe by class — the form used throughout the docs for
every other pipe — throws at bootstrap:

    @get()
    find(@query('v', ParseDatePipe) v: Date) {}

    Nest can't resolve dependencies of the ParseDatePipe (?). Please make sure
    that the argument at index [0] is available in the current module.

`@Query('v', ParseBoolPipe)` works, so the failure looks arbitrary and the only
workaround is to instantiate the pipe manually (`new ParseDatePipe()`).

Decorate the argument with `@Optional()` so the injector passes `undefined` and
the existing default value applies. Also widen `private` to `protected` to match
every other pipe and this class's own `exceptionFactory`.

Author: Chy-Zaber-Bin-Zahid

packages/common/pipes/parse-date.pipe.ts

@@ -1,4 +1,5 @@
 import { Injectable } from '../decorators/core/injectable.decorator.js';
+import { Optional } from '../decorators/core/optional.decorator.js';
 import { HttpStatus } from '../enums/http-status.enum.js';
 import { PipeTransform } from '../interfaces/features/pipe-transform.interface.js';
 import {
@@ -40,7 +41,9 @@ export interface ParseDatePipeOptions {
 export class ParseDatePipe implements PipeTransform {
   protected exceptionFactory: (error: string) => any;
 
-  constructor(private readonly options: ParseDatePipeOptions = {}) {
+  constructor(
+    @Optional() protected readonly options: ParseDatePipeOptions = {},
+  ) {
     const { exceptionFactory, errorHttpStatusCode = HttpStatus.BAD_REQUEST } =
       options;
 

packages/common/test/pipes/parse-date.pipe.spec.ts

@@ -1,3 +1,4 @@
+import { OPTIONAL_DEPS_METADATA } from '../../constants.js';
 import { BadRequestException } from '../../exceptions/index.js';
 import { ParseDatePipe } from '../../pipes/parse-date.pipe.js';
 
@@ -58,4 +59,21 @@ describe('ParseDatePipe', () => {
       });
     });
   });
+
+  describe('dependency injection', () => {
+    it('should mark the options argument as optional', () => {
+      // Without this metadata the injector cannot instantiate the pipe when it
+      // is passed by class, e.g. `@Query('date', ParseDatePipe)`.
+      const metadata = Reflect.getMetadata(
+        OPTIONAL_DEPS_METADATA,
+        ParseDatePipe,
+      );
+      expect(metadata).toEqual([0]);
+    });
+
+    it('should fall back to the default options when none are injected', () => {
+      const target = new ParseDatePipe(undefined as any);
+      expect(() => target.transform('')).toThrow(BadRequestException);
+    });
+  });
 });