ミドルウェアのサンプル: 論理削除

以下のサンプルでは、ミドルウェアを使用して論理削除を実行します。論理削除とは、実際にデータベースからレコードを削除するのではなく、deletedのようなフィールドをtrueに変更してレコードが削除済みとしてマークされることを意味します。論理削除を使用する理由には以下のものがあります。

• データを一定期間保持する必要がある規制要件
• ユーザーが削除されたコンテンツを復元できるようにする「ゴミ箱」機能

警告

注: このページは、ミドルウェアの使用例を示すものです。このサンプルは、完全に機能する論理削除機能として意図されたものではなく、すべてのエッジケースをカバーしているわけではありません。たとえば、このミドルウェアはネストされた書き込みには対応していないため、updateクエリなどでdeleteやdeleteManyをオプションとして使用する状況は捕捉されません。

このサンプルでは以下のスキーマを使用します。Postモデルのdeletedフィールドに注目してください。

datasource db {
  provider = "postgresql"
  url      = env("DATABASE_URL")
}

generator client {
  provider = "prisma-client-js"
}

model User {
  id        Int     @id @default(autoincrement())
  name      String?
  email     String  @unique
  posts     Post[]
  followers User[]  @relation("UserToUser")
  user      User?   @relation("UserToUser", fields: [userId], references: [id])
  userId    Int?
}

model Post {
  id      Int     @id @default(autoincrement())
  title   String
  content String?
  user    User?   @relation(fields: [userId], references: [id])
  userId  Int?
  tags    Tag[]
  views   Int     @default(0)
  deleted Boolean @default(false)
}

model Category {
  id             Int        @id @default(autoincrement())
  parentCategory Category?  @relation("CategoryToCategory", fields: [categoryId], references: [id])
  category       Category[] @relation("CategoryToCategory")
  categoryId     Int?
}

model Tag {
  tagName String @id // Must be unique
  posts   Post[]
}

ステップ1: レコードのステータスを保存

Postモデルにdeletedという名前のフィールドを追加します。要件に応じて、以下の2つのフィールド型から選択できます。

• デフォルト値がfalseのBoolean型

  model Post {
    id      Int     @id @default(autoincrement())
    ...
    deleted Boolean @default(false)
  }

• NULL許容のDateTimeフィールドを作成し、レコードがいつ削除済みとしてマークされたかを正確に把握できるようにします。NULLはレコードが削除されていないことを示します。場合によっては、レコードが削除された日時を保存することが規制要件となることがあります。

  model Post {
    id      Int       @id @default(autoincrement())
    ...
    deleted DateTime?
  }

注: isDeletedとdeletedDateの2つの別々のフィールドを使用すると、これら2つのフィールドが同期しなくなる可能性があります。たとえば、レコードが削除済みとしてマークされているにもかかわらず、関連する日付がない場合などです。)

このサンプルでは、簡潔にするためにBooleanフィールド型を使用しています。

ステップ2: 論理削除ミドルウェア

以下のタスクを実行するミドルウェアを追加します。

• Postモデルのdelete()およびdeleteMany()クエリをインターセプトします。
• params.actionをそれぞれupdateとupdateManyに変更します。
• data引数を導入し、{ deleted: true }を設定します。他のフィルター引数が存在する場合は、それらを保持します。

以下のサンプルを実行して、論理削除ミドルウェアをテストしてください。

import { PrismaClient } from '@prisma/client'

const prisma = new PrismaClient({})

async function main() {
  /***********************************/
  /* SOFT DELETE MIDDLEWARE */
  /***********************************/

  prisma.$use(async (params, next) => {
    // Check incoming query type
    if (params.model == 'Post') {
      if (params.action == 'delete') {
        // Delete queries
        // Change action to an update
        params.action = 'update'
        params.args['data'] = { deleted: true }
      }
      if (params.action == 'deleteMany') {
        // Delete many queries
        params.action = 'updateMany'
        if (params.args.data != undefined) {
          params.args.data['deleted'] = true
        } else {
          params.args['data'] = { deleted: true }
        }
      }
    }
    return next(params)
  })

  /***********************************/
  /* TEST */
  /***********************************/

  const titles = [
    { title: 'How to create soft delete middleware' },
    { title: 'How to install Prisma' },
    { title: 'How to update a record' },
  ]

  console.log('\u001b[1;34mSTARTING SOFT DELETE TEST \u001b[0m')
  console.log('\u001b[1;34m#################################### \u001b[0m')

  let i = 0
  let posts = new Array()

  // Create 3 new posts with a randomly assigned title each time
  for (i == 0; i < 3; i++) {
    const createPostOperation = prisma.post.create({
      data: titles[Math.floor(Math.random() * titles.length)],
    })
    posts.push(createPostOperation)
  }

  var postsCreated = await prisma.$transaction(posts)

  console.log(
    'Posts created with IDs: ' +
      '\u001b[1;32m' +
      postsCreated.map((x) => x.id) +
      '\u001b[0m'
  )

  // Delete the first post from the array
  const deletePost = await prisma.post.delete({
    where: {
      id: postsCreated[0].id, // Random ID
    },
  })

  // Delete the 2nd two posts
  const deleteManyPosts = await prisma.post.deleteMany({
    where: {
      id: {
        in: [postsCreated[1].id, postsCreated[2].id],
      },
    },
  })

  const getPosts = await prisma.post.findMany({
    where: {
      id: {
        in: postsCreated.map((x) => x.id),
      },
    },
  })

  console.log()

  console.log(
    'Deleted post with ID: ' + '\u001b[1;32m' + deletePost.id + '\u001b[0m'
  )
  console.log(
    'Deleted posts with IDs: ' +
      '\u001b[1;32m' +
      [postsCreated[1].id + ',' + postsCreated[2].id] +
      '\u001b[0m'
  )
  console.log()
  console.log(
    'Are the posts still available?: ' +
      (getPosts.length == 3
        ? '\u001b[1;32m' + 'Yes!' + '\u001b[0m'
        : '\u001b[1;31m' + 'No!' + '\u001b[0m')
  )
  console.log()
  console.log('\u001b[1;34m#################################### \u001b[0m')
  // 4. Count ALL posts
  const f = await prisma.post.findMany({})
  console.log('Number of posts: ' + '\u001b[1;32m' + f.length + '\u001b[0m')

  // 5. Count DELETED posts
  const r = await prisma.post.findMany({
    where: {
      deleted: true,
    },
  })
  console.log(
    'Number of SOFT deleted posts: ' + '\u001b[1;32m' + r.length + '\u001b[0m'
  )
}

main()

サンプルは以下の内容を出力します。

STARTING SOFT DELETE TEST
####################################
Posts created with IDs: 587,588,589

Deleted post with ID: 587
Deleted posts with IDs: 588,589

Are the posts still available?: Yes!

####################################

ヒント

ミドルウェアをコメントアウトして、メッセージの変化を確認してください。

✔ この論理削除アプローチの利点は以下の通りです。

• 論理削除がデータアクセスレベルで実行されるため、生のSQLを使用しない限りレコードを削除することはできません。

✘ この論理削除アプローチの欠点は以下の通りです。

• where: { deleted: false }で明示的にフィルタリングしない限り、コンテンツは依然として読み取り・更新が可能です。多数のクエリがある大規模プロジェクトでは、論理削除されたコンテンツが依然として表示されるリスクがあります。
• 生のSQLを使用してレコードを削除することは依然として可能です。

ヒント

レコードが削除されるのを防ぐために、データベースレベルでルールやトリガー（MySQLおよびPostgreSQL）を作成できます。

ステップ3: オプション: 論理削除されたレコードの読み取り/更新を防止

ステップ2では、Postレコードが削除されるのを防ぐミドルウェアを実装しました。しかし、削除されたレコードを依然として読み取り・更新することができます。このステップでは、削除されたレコードの読み取りと更新を防止する2つの方法を探ります。

注: これらのオプションは長所と短所がある単なるアイデアであり、まったく異なる方法を選択することもできます。

オプション1: 独自のアプリケーションコードでフィルターを実装

このオプションでは

• Prisma Clientミドルウェアは、レコードが削除されるのを防ぐ責任を負います。
• 独自のアプリケーションコード（GraphQL API、REST API、モジュールなど）は、データの読み取りおよび更新時に、必要に応じて削除された投稿をフィルタリングする責任を負います（例: { where: { deleted: false } }）。たとえば、getPost GraphQLリゾルバは、削除された投稿を返すことはありません。

✔ この論理削除アプローチの利点は以下の通りです。

• Prisma Clientの作成/更新クエリに変更はありません。必要に応じて削除されたレコードを簡単にリクエストできます。
• ミドルウェアでクエリを変更すると、クエリの戻り値の型が変わるなど、意図しない結果が生じる可能性があります（オプション2を参照）。

✘ この論理削除アプローチの欠点は以下の通りです。

• 論理削除に関するロジックが2つの異なる場所で管理されます。
• APIサーフェスが非常に大規模で、複数のコントリビューターによって管理されている場合、特定のビジネスルール（例: 削除されたレコードの更新を許可しない）を強制することが難しい場合があります。

オプション2: ミドルウェアを使用して、削除されたレコードの読み取り/更新クエリの動作を決定する

オプション2では、Prisma Clientミドルウェアを使用して、論理削除されたレコードが返されるのを防ぎます。以下の表は、ミドルウェアが各クエリにどのように影響するかを説明しています。

クエリ	ミドルウェアロジック	戻り値の型の変更
findUnique()	🔧 クエリをfindFirstに変更します（findUnique()にdeleted: falseフィルターを適用できないため）。 🔧 論理削除された投稿を除外するために、where: { deleted: false }フィルターを追加します。 🔧 バージョン5.0.0以降、非一意なフィールドが公開されたため、findUnique()を使用してdelete: falseフィルターを適用できます。	変更なし
findMany	🔧 デフォルトで論理削除された投稿を除外するために、where: { deleted: false }フィルターを追加します。 🔧 開発者がdeleted: trueを指定することで、論理削除された投稿を明示的にリクエストできるようにします。	変更なし
update	🔧 クエリをupdateManyに変更します（updateにdeleted: falseフィルターを適用できないため）。 🔧 論理削除された投稿を除外するために、where: { deleted: false }フィルターを追加します。	Postの代わりに{ count: n }
updateMany	🔧 論理削除された投稿を除外するために、where: { deleted: false }フィルターを追加します。	変更なし

• findFirstOrThrow()またはfindUniqueOrThrow()で論理削除を利用することはできませんか？
  バージョン5.1.0以降、ミドルウェアを使用することで、findFirstOrThrow()またはfindUniqueOrThrow()に論理削除を適用できます。
• findMany()で{ where: { deleted: true } }フィルターを使用できるようにしているのに、updateMany()ではそうではないのはなぜですか？
  この特定のサンプルは、ユーザーが削除されたブログ投稿を復元できる（論理削除された投稿のリストが必要となる）シナリオをサポートするために書かれました。しかし、ユーザーは削除された投稿を編集できないようにすべきです。
• 削除された投稿をconnectまたはconnectOrCreateすることはできますか？
  このサンプルでは - はい。ミドルウェアは、既存の論理削除された投稿をユーザーに接続することを妨げません。

以下のサンプルを実行して、ミドルウェアが各クエリにどのように影響するかを確認してください。

import { PrismaClient, Prisma } from '@prisma/client'

const prisma = new PrismaClient({})

async function main() {
  /***********************************/
  /* SOFT DELETE MIDDLEWARE */
  /***********************************/

  prisma.$use(async (params, next) => {
    if (params.model == 'Post') {
      if (params.action === 'findUnique' || params.action === 'findFirst') {
        // Change to findFirst - you cannot filter
        // by anything except ID / unique with findUnique()
        params.action = 'findFirst'
        // Add 'deleted' filter
        // ID filter maintained
        params.args.where['deleted'] = false
      }
      if (
        params.action === 'findFirstOrThrow' ||
        params.action === 'findUniqueOrThrow'
      ) {
        if (params.args.where) {
          if (params.args.where.deleted == undefined) {
            // Exclude deleted records if they have not been explicitly requested
            params.args.where['deleted'] = false
          }
        } else {
          params.args['where'] = { deleted: false }
        }
      }
      if (params.action === 'findMany') {
        // Find many queries
        if (params.args.where) {
          if (params.args.where.deleted == undefined) {
            params.args.where['deleted'] = false
          }
        } else {
          params.args['where'] = { deleted: false }
        }
      }
    }
    return next(params)
  })

  prisma.$use(async (params, next) => {
    if (params.model == 'Post') {
      if (params.action == 'update') {
        // Change to updateMany - you cannot filter
        // by anything except ID / unique with findUnique()
        params.action = 'updateMany'
        // Add 'deleted' filter
        // ID filter maintained
        params.args.where['deleted'] = false
      }
      if (params.action == 'updateMany') {
        if (params.args.where != undefined) {
          params.args.where['deleted'] = false
        } else {
          params.args['where'] = { deleted: false }
        }
      }
    }
    return next(params)
  })

  prisma.$use(async (params, next) => {
    // Check incoming query type
    if (params.model == 'Post') {
      if (params.action == 'delete') {
        // Delete queries
        // Change action to an update
        params.action = 'update'
        params.args['data'] = { deleted: true }
      }
      if (params.action == 'deleteMany') {
        // Delete many queries
        params.action = 'updateMany'
        if (params.args.data != undefined) {
          params.args.data['deleted'] = true
        } else {
          params.args['data'] = { deleted: true }
        }
      }
    }
    return next(params)
  })

  /***********************************/
  /* TEST */
  /***********************************/

  const titles = [
    { title: 'How to create soft delete middleware' },
    { title: 'How to install Prisma' },
    { title: 'How to update a record' },
  ]

  console.log('\u001b[1;34mSTARTING SOFT DELETE TEST \u001b[0m')
  console.log('\u001b[1;34m#################################### \u001b[0m')

  let i = 0
  let posts = new Array()

  // Create 3 new posts with a randomly assigned title each time
  for (i == 0; i < 3; i++) {
    const createPostOperation = prisma.post.create({
      data: titles[Math.floor(Math.random() * titles.length)],
    })
    posts.push(createPostOperation)
  }

  var postsCreated = await prisma.$transaction(posts)

  console.log(
    'Posts created with IDs: ' +
      '\u001b[1;32m' +
      postsCreated.map((x) => x.id) +
      '\u001b[0m'
  )

  // Delete the first post from the array
  const deletePost = await prisma.post.delete({
    where: {
      id: postsCreated[0].id, // Random ID
    },
  })

  // Delete the 2nd two posts
  const deleteManyPosts = await prisma.post.deleteMany({
    where: {
      id: {
        in: [postsCreated[1].id, postsCreated[2].id],
      },
    },
  })

  const getOnePost = await prisma.post.findUnique({
    where: {
      id: postsCreated[0].id,
    },
  })

  const getOneUniquePostOrThrow = async () =>
    await prisma.post.findUniqueOrThrow({
      where: {
        id: postsCreated[0].id,
      },
    })

  const getOneFirstPostOrThrow = async () =>
    await prisma.post.findFirstOrThrow({
      where: {
        id: postsCreated[0].id,
      },
    })

  const getPosts = await prisma.post.findMany({
    where: {
      id: {
        in: postsCreated.map((x) => x.id),
      },
    },
  })

  const getPostsAnDeletedPosts = await prisma.post.findMany({
    where: {
      id: {
        in: postsCreated.map((x) => x.id),
      },
      deleted: true,
    },
  })

  const updatePost = await prisma.post.update({
    where: {
      id: postsCreated[1].id,
    },
    data: {
      title: 'This is an updated title (update)',
    },
  })

  const updateManyDeletedPosts = await prisma.post.updateMany({
    where: {
      deleted: true,
      id: {
        in: postsCreated.map((x) => x.id),
      },
    },
    data: {
      title: 'This is an updated title (updateMany)',
    },
  })

  console.log()

  console.log(
    'Deleted post (delete) with ID: ' +
      '\u001b[1;32m' +
      deletePost.id +
      '\u001b[0m'
  )
  console.log(
    'Deleted posts (deleteMany) with IDs: ' +
      '\u001b[1;32m' +
      [postsCreated[1].id + ',' + postsCreated[2].id] +
      '\u001b[0m'
  )
  console.log()
  console.log(
    'findUnique: ' +
      (getOnePost?.id != undefined
        ? '\u001b[1;32m' + 'Posts returned!' + '\u001b[0m'
        : '\u001b[1;31m' +
          'Post not returned!' +
          '(Value is: ' +
          JSON.stringify(getOnePost) +
          ')' +
          '\u001b[0m')
  )
  try {
    console.log('findUniqueOrThrow: ')
    await getOneUniquePostOrThrow()
  } catch (error) {
    if (
      error instanceof Prisma.PrismaClientKnownRequestError &&
      error.code == 'P2025'
    )
      console.log(
        '\u001b[1;31m' +
          'PrismaClientKnownRequestError is catched' +
          '(Error name: ' +
          error.name +
          ')' +
          '\u001b[0m'
      )
  }
  try {
    console.log('findFirstOrThrow: ')
    await getOneFirstPostOrThrow()
  } catch (error) {
    if (
      error instanceof Prisma.PrismaClientKnownRequestError &&
      error.code == 'P2025'
    )
      console.log(
        '\u001b[1;31m' +
          'PrismaClientKnownRequestError is catched' +
          '(Error name: ' +
          error.name +
          ')' +
          '\u001b[0m'
      )
  }
  console.log()
  console.log(
    'findMany: ' +
      (getPosts.length == 3
        ? '\u001b[1;32m' + 'Posts returned!' + '\u001b[0m'
        : '\u001b[1;31m' + 'Posts not returned!' + '\u001b[0m')
  )
  console.log(
    'findMany ( delete: true ): ' +
      (getPostsAnDeletedPosts.length == 3
        ? '\u001b[1;32m' + 'Posts returned!' + '\u001b[0m'
        : '\u001b[1;31m' + 'Posts not returned!' + '\u001b[0m')
  )
  console.log()
  console.log(
    'update: ' +
      (updatePost.id != undefined
        ? '\u001b[1;32m' + 'Post updated!' + '\u001b[0m'
        : '\u001b[1;31m' +
          'Post not updated!' +
          '(Value is: ' +
          JSON.stringify(updatePost) +
          ')' +
          '\u001b[0m')
  )
  console.log(
    'updateMany ( delete: true ): ' +
      (updateManyDeletedPosts.count == 3
        ? '\u001b[1;32m' + 'Posts updated!' + '\u001b[0m'
        : '\u001b[1;31m' + 'Posts not updated!' + '\u001b[0m')
  )
  console.log()
  console.log('\u001b[1;34m#################################### \u001b[0m')
  // 4. Count ALL posts
  const f = await prisma.post.findMany({})
  console.log(
    'Number of active posts: ' + '\u001b[1;32m' + f.length + '\u001b[0m'
  )

  // 5. Count DELETED posts
  const r = await prisma.post.findMany({
    where: {
      deleted: true,
    },
  })
  console.log(
    'Number of SOFT deleted posts: ' + '\u001b[1;32m' + r.length + '\u001b[0m'
  )
}

main()

サンプルは以下の内容を出力します。

STARTING SOFT DELETE TEST
####################################
Posts created with IDs: 680,681,682

Deleted post (delete) with ID: 680
Deleted posts (deleteMany) with IDs: 681,682

findUnique: Post not returned!(Value is: [])
findMany: Posts not returned!
findMany ( delete: true ): Posts returned!

update: Post not updated!(Value is: {"count":0})
updateMany ( delete: true ): Posts not updated!

####################################
Number of active posts: 0
Number of SOFT deleted posts: 95

✔ このアプローチの利点

• 開発者は、findManyで削除されたレコードを含めることを意識的に選択できます。
• 誤って削除されたレコードを読み取ったり更新したりすることはありません。

✖ このアプローチの欠点

• すべてのレコードを取得しているわけではなく、{ where: { deleted: false } }がデフォルトクエリの一部であることがAPIから明白ではありません。
• ミドルウェアがクエリをupdateManyに変更するため、updateの戻り値の型が影響を受けます。
• AND、OR、everyなどを含む複雑なクエリには対応していません。
• 別のモデルからincludeを使用する際のフィルタリングには対応していません。

よくある質問

PostモデルにグローバルなincludeDeletedを追加できますか？

PostモデルにincludeDeletedプロパティを追加してAPIを「ハック」し、以下のクエリを可能にしたくなるかもしれません。

prisma.post.findMany({ where: { includeDeleted: true } })

注: 依然としてミドルウェアを記述する必要があります。

このアプローチは、実際のデータを表さないフィールドでスキーマを汚染するため、✘お勧めしません。