<h2 id="h9707d3a59a">概要</h2><p><a href="https://github.com/nestjs/nest" target="_blank" rel="noopener noreferrer">NestJS</a> のログにスタック情報を追加します。<br><br>デバック時にどこで落ちているか確認をする際、ログからスタック情報を参照出来るのと便利です。<br><br>なお、今回は<a style="background-color:#ffffff" href="https://github.com/nestjs/nest" target="_blank" rel="noopener noreferrer">NestJS</a> の環境が構築されている前提でご説明します。<br></p><h2 id="hf031c5e696">実装方法</h2><h3 id="h3ce1a51dc0">HttpExceptionsFilter を実装</h3><p>NestJSの <a href="https://docs.nestjs.com/exception-filters" target="_blank" rel="noopener noreferrer">Exception filters</a><span style="color:#222222">は例外処理をキャッチし、その例外処理にカスタムの機能を追加することができます。</span><br><br>今回は その <a style="background-color:#ffffff" href="unsafe:[object Object]" target="_blank" rel="noopener noreferrer">Exception filters</a>を用いて、例外が発生する度にスタック情報をログに出力するようにします。<br></p><pre><code>import { ArgumentsHost, Catch, HttpException, Logger } from '@nestjs/common';
import { BaseExceptionFilter } from '@nestjs/core';

@Catch(HttpException)
export class HttpExceptionsFilter extends BaseExceptionFilter {
  private readonly logger = new Logger(HttpExceptionsFilter.name);

  catch(exception: HttpException, host: ArgumentsHost): void {
    super.catch(exception, host);
    const status = exception.getStatus();

    if (status &gt;= 500) {
      this.logger.error(exception.stack);
    } else {
      this.logger.warn(exception.stack);
    }
  }
}</code></pre><p><br>exceptionにはエラー情報が含まれます。その情報にスタックが含まれるので、それをログに出力するようにしています。ステータスが500以下は重要度的にも<span style="color:#303030">LogLevelを</span><code>warn</code>にしています。<br></p><h3 id="h012d97d4c5">MainにHttpExceptionsFilterを設定</h3><p>HttpExceptionsFilter をグローバルに適用するようにします。<br></p><pre><code>const { httpAdapter } = app.get(HttpAdapterHost);
app.useGlobalFilters(new HttpExceptionsFilter(httpAdapter));</code></pre><p><br></p><h3 id="h45437cb5d5">実行結果</h3><p>以下のようにエラー発生すると以下のログが出力されていれば成功です！</p><pre><code>[Nest] 2513&nbsp; - 2021/10/31 14:31:08&nbsp; &nbsp; WARN [HttpExceptionsFilter] UnauthorizedException: Unauthorized
... エラー箇所のスタック</code></pre><p><br></p><h2 id="ha214098e44">まとめ</h2><p><a style="background-color:#ffffff" href="https://github.com/nestjs/nest" target="_blank" rel="noopener noreferrer">NestJS</a> のログにスタック情報を追加する方法をご紹介しました。デバックが楽になるので良かったら追加してみてください。<br></p>

NestJS で LogにStack情報を追加する

<h2 id="h9707d3a59a">概要</h2><p><a href="https://github.com/nestjs/nest" target="_blank" rel="noopener noreferrer">NestJS</a> のログにリクエスト情報を追加します。<br><br>デバック時にどんなクエリで不具合が起きているのか確認をする際、ログからリクエスト情報を参照出来るので便利です。<br><br>なお、今回は<a style="background-color:#ffffff" href="https://github.com/nestjs/nest" target="_blank" rel="noopener noreferrer">NestJS</a> の環境が構築されている前提でご説明します。<br></p><h2 id="hf031c5e696">実装方法</h2><h3 id="he47cc28ec8">LoggerMiddleware を実装</h3><p>NestJSの <a style="background-color:#ffffff" href="https://docs.nestjs.com/middleware" target="_blank" rel="noopener noreferrer">Middleware</a><span style="color:#222222">はルートハンドラーの前に呼び出される関数です。コントローラーのエンドポイントへの処理前に特定の処理を挟めます。</span><br><br>今回は その<a style="background-color:#ffffff" href="https://docs.nestjs.com/middleware" target="_blank" rel="noopener noreferrer">Middleware</a>を用いて、リクエスト毎にリクエスト情報をログに出力するようにします。<br></p><pre><code>import { Injectable, Logger, NestMiddleware } from '@nestjs/common';
import { Request, Response } from 'express';

@Injectable()
export class LoggerMiddleware implements NestMiddleware {
  private readonly logger = new Logger(LoggerMiddleware.name);

  use(req: Request, _: Response, next: () =&gt; void): void {
    this.logger.log(this.createMessage(req));
    next();
  }

  private createMessage(req: Request): string {
    const { body } = req;
  
    const msg = `api request [url=${req.url}, method=${
      req.method
    }, body=${JSON.stringify(body)}, ip=${req.ip}]`;
    return msg;
  }
}</code></pre><p><br>NestJSの <a style="background-color:#ffffff" href="https://docs.nestjs.com/middleware" target="_blank" rel="noopener noreferrer">Middleware</a>はRequestを取得出来るので、その情報を元に今回は<code>method</code>, <code>body</code>, <code>clientIp</code> を出力するようにしています。<br></p><h3 id="hd6aa6878c1">AppModuleにLoggerMiddlewareを設定</h3><p><code>AppModule</code>に先ほど実装した <code>LoogerMiddleware</code>を設定します。これでリクエストの度に<code>LoogerMiddleware</code>が呼び出されるはずです。<br></p><pre><code>export class AppModule {
  configure(consumer: MiddlewareConsumer): void {
    consumer.apply(LoggerMiddleware).forRoutes('');
  }
}</code></pre><p><br></p><h3 id="h45437cb5d5">実行結果</h3><p>以下のようにエンドポイントを叩くと、<code>method</code>, <code>body</code>, <code>clientIp</code> が出力されていれば成功です！</p><pre><code>[Nest] 98030&nbsp; - 2021/10/30 22:23:55&nbsp; &nbsp; &nbsp;LOG [LoggerMiddleware] api request [url=/sample, method=GET, body={}, ip=::1]</code></pre><p><br></p><h2 id="ha214098e44">まとめ</h2><p><a style="background-color:#ffffff" href="https://github.com/nestjs/nest" target="_blank" rel="noopener noreferrer">NestJS</a> のログにリクエスト情報を追加する方法をご紹介しました。デバックが楽になるかもなので良かったら追加してみてください。<br><br>ただ、本番環境で上記ログを出すとパスワードといった情報も出てしまうので、以下のようにマスクをする処理を挟む必要があるかもです。（もう少し良いやり方ありそう）</p><pre><code>const { body } = req;
const nextBody = { ...body };
if ('password' in nextBody) {
  nextBody.password = '********';
}</code></pre><p><br></p>

NestJS で LogにRequest情報を追加する

NestJSにMikroORMの導入手順。CRUDのAPIを実装するまで。

<p><span style="color:#24292e">おはこんにちばんは。最近は </span>Node.js / TypeScript で使用出来る ORM のPrismaを触っています。<br>そこでハマった、<span style="color:#454545">一対多</span> や 多対多 のようなリレーションをしているテーブルのレコードの削除について、どのような対応したのかを紹介しようと思います。<br></p><h2 id="hfe5a8eaaf7">実行環境</h2><ul><li>Prisma 2.14.0</li></ul><p><br></p><h2 id="h68b09e605a">事象内容</h2><p>リレーションしているテーブルのレコードに対して、<a href="https://www.prisma.io/" target="_blank" rel="noopener noreferrer">Prisma</a> のDeleteを使うと以下のエラーが発生しました。</p><pre><code>The change you are trying to make would violate the required relation 'XXXX' between the 'XXXX' and 'XXXX' models.</code></pre><p><br>あれ？何か設定漏れてたかなっと思い色々調べた結果、カスケードの削除（<span style="color:#333333">参照先が無くなると同時に削除される</span>）が<a href="https://github.com/prisma/prisma/issues/2810" target="_blank" rel="noopener noreferrer">非対応</a>のようでした...<br>一応、ロードマップ上では対応するよう進んでいるようです。優先度高くないっぽいけど。<br>更に調べてみると、<a href="https://paljs.com/plugins/delete/" target="_blank" rel="noopener noreferrer">Pal.js</a> を使うと対応できるよっという<a href="https://github.com/prisma/prisma/issues/2057#issuecomment-718060880" target="_blank" rel="noopener noreferrer">コメント</a>があったので実際に試してみました。<br></p><h2 id="hc2e1b5db24">packageを追加</h2><p><a style="background-color:#ffffff" href="https://paljs.com/plugins/delete/" target="_blank" rel="noopener noreferrer">Pal.js</a> を追加していきます。（何故かgraphql入れないと動かんかった。闇）</p><pre><code>yarn add paljs/plugins graphql</code></pre><p><br></p><h2 id="ha7f8f59999">事前設定</h2><p>参照先のレコードをどう扱うか設定していきます。以下の二つが設定可能です。</p><ul><li><code>SET_NULL</code>：関連するレコードをに<code>null</code>に設定します。</li><li><code>CASCADE</code>：関連するレコードを削除します。</li></ul><p><br><code>/// @onDelete(CASCADE)</code>のように設定します。以下は適当な例です。</p><pre><code>schema.prisma

model User {
  id　Int　@id @default(autoincrement())
  /// @onDelete(CASCADE)
  userDetail UserDetail?
}

model UserDetail {
  id　Int　@id @default(autoincrement())
  user  User @relation(fields: [userId], references: [id])
  userId  Int 
  displayName String
}</code></pre><p><br></p><h2 id="h597fa8c079">削除処理</h2><p>以下のように<a style="background-color:#ffffff" href="https://paljs.com/plugins/delete/" target="_blank" rel="noopener noreferrer">Pal.js</a> のDelete処理を行えば、リレーションをしているテーブルのレコードも含めて削除できます。</p><pre><code>export const deleteUser = async (id: User['id']) =&gt; {
  const prismaDelete = new PrismaDelete(prisma)
  return await prismaDelete.onDelete({
    model: 'User',
    where: { id },
    deleteParent: true
  })
}</code></pre><p><br></p><h2 id="h3bcda3e6b0">最後に</h2><p>暫定対応をご紹介しましたが、<a href="https://www.prisma.io/" target="_blank" rel="noopener noreferrer">Prisma</a> が対応してくれると良いですね。同じようにハマった人の参考になれば幸いです。</p>

バックエンド

NestJS で LogにStack情報を追加する

NestJS で LogにRequest情報を追加する

NestJSにMikroORMの導入手順。CRUDのAPIを実装するまで。

Prismaで参照先のレコード削除にハマった話