7.0.0

[BrunnerLivio]

PR Checklist

Please check if your PR fulfills the following requirements:

• The commit message follows our guidelines: https://github.com/nestjs/nest/blob/master/CONTRIBUTING.md
• Tests for the changes have been added (for bug fixes / features)
• Docs have been added / updated (for bug fixes / features)

PR Type

What kind of change does this PR introduce?

[x] Bugfix
[x] Feature
[x] Code style update (formatting, local variables)
[x] Refactoring (no functional changes, no api changes)
[x] Build related changes
[x] CI related changes
[x] Release, baby

What is the current behavior?

Issue Number: #9 #32 #33 #312 #340 #561 #569 #580

What is the new behavior?

One of the main goals I want to tackle is the very complicated JSON object for the TerminusModule.forRootAsync.

v6

@Module({
  imports: [
    TerminusModule.forRootAsync({
      useFactory: (disk: DiskHealthIndicator) => {
        return {
          endpoints: [
            {
              url: '/health',
              healthIndicators: [
                async () =>
                  disk.checkStorage('disk', {
                    path: '/',
                    thresholdPercent: 0.5,
                  }),
              ],
            },
          ],
        };
      },
      inject: [DiskHealthIndicator],
    }),
  ],
})
export class AppModule {}

v7

@Controller('health')
export class HealthController {
  constructor(
    private healthService: HealthService,
    private disk: DiskHealthIndicator,
  ) {}

  @Get()
  @HealthCheck()
  readiness() {
    return this.healthService.check([
      () => this.disk.checkStorage('disk', { path: '/', thresholdPercent: 0.5 }),
    ]);
  }
}

The v6 way of registering health checks will mostly stay in the package without any further action needed for most users. It will get completely removed in v8.

Does this PR introduce a breaking change?

[x] Yes
[ ] No

Todo @BrunnerLivio

[tristan957]

@BrunnerLivio thanks for your work on this. Cannot wait to include it in my application.

[BrunnerLivio]

@neverson-silva hopefully sometime this week. You can already opt-in to use the prerelease though

npm i -s @nestjs/terminus@7.0.0-pre.2

See migration guide (work in progress). Though before you migrate, can you check whether everything works fine just by upgrading the dependency? It should be backward-compatible and only print a deprecation warning.

[neverson-silva]

@BrunnerLivio thanks for your reply, everything worked very well. I'll read the migration guide.

[geekflyer]

Hey, I noticed an issue with the new v7 syntax.
In our app we've set a global prefix via app.setGlobalPrefix("api/v1");. With the previous syntax the health endpoint was available under /health but with the new syntax that endpoint moved to /api/v1/health which is kinda unintentional. I didn't find a way to prevent the health check from picking up the global prefix. Is there a way to get the old behaviour?

[BrunnerLivio]

@geekflyer Great catch, I will need to add this as a note to the migration guide!

Unfortunately, I can’t. Though you can:

• Use the legacy API until nestjs/nest#963 is resolved (the legacy API will not break in terminus v7, it will be removed in v8)

• Don’t let NestJS handle global prefix and instead use a simple static variable which you prepend for each controller.

• Use a rather hacky workaround like this:

// my-health.service.ts
@Injectable()
export class MyHealthService {
  constructor(
    private health: HealthCheckService,
    private dns: DNSHealthIndicator,
  ) {}
  healthcheck() {
    return this.health.check([
      () => this.dns.pingCheck('nestjs', 'https://nestjs.com'),
    ]);
  }
}

// main.ts
async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  app.enableShutdownHooks();

  const myHealthService = app.get(MyHealthService);
  app.getHttpAdapter().get('/health', async (_, res) => {
    try {
      const result = await myHealthService.healthcheck();
      return res.status(200).json(result);
    } catch (error) {
      return res.status(500).json(error.response);
    }
  });

  await app.listen(3000);
}
bootstrap();

[geekflyer]

ok, let's say i wanna continue using the old syntax, is there a way to disable the deprecation warning?

[BrunnerLivio]

@geekflyer added an environment variable TERMINUS_IGNORE_DEPRECATED=true to disable the deprecation warnings in @nestjs/terminus@7.0.0-pre.3

[geekflyer]

@BrunnerLivio , thanks, but I wonder could you rather make this a parameter of the forRootAsync method? something like:

 TerminusModule.forRootAsync({
      ignoreDeprecationWarning: true,
      useFactory: (disk: DiskHealthIndicator) => {
        return {
          endpoints: [
            {
              url: '/health',
              healthIndicators: [
                async () =>
                  disk.checkStorage('disk', {
                    path: '/',
                    thresholdPercent: 0.5,
                  }),
              ],
            },
          ],
        };
      },
      inject: [DiskHealthIndicator],
    }),

or

 TerminusModule.forRootAsync({
      useFactory: (disk: DiskHealthIndicator) => {
        return {
          ignoreDeprecationWarning: true,
          endpoints: [
            {
              url: '/health',
              healthIndicators: [
                async () =>
                  disk.checkStorage('disk', {
                    path: '/',
                    thresholdPercent: 0.5,
                  }),
              ],
            },
          ],
        };
      },
      inject: [DiskHealthIndicator],
    }),

I think using an environment variable to suppress the deprecation warning seems a bit heavy handed :)

[BrunnerLivio]

@geekflyer personally I don’t really like that (seems to me a little bit unintuitive design), but I can’t come up with a strong unopinionated counter argument either haha. Since these options will anyway get removed in v8 I don’t really care. Therefore I’ll refactor the env variable asap

[geekflyer]

awesome thanks!

[BrunnerLivio]

@geekflyer disableDeprecationWarnings has been added to the TerminusOptions.

---

@ everyone: The PR is almost done. If you are able to check out the pre-release npm install @nestjs/terminus@7.0.0-pre.4, please do so, and give me more feedback!

[BrunnerLivio]

Terminus v7 has been released! Migration guide to be followed asap.
Thanks, everyone for your patience and really helpful support! ❤️