chore: add warnAt, readme

Author: jmikrut

README.md

@@ -1,8 +1,14 @@
-# blank
+# Recursion Prevention Plugin
 
-blank
+This repo contains a simple plugin to detect recursion caused by Payload hooks. For example, if you have a hook that updates a document, which in turn, fires another hook which again updates that same document, you could cause an infinite recursion.
 
-## Attributes
+This plugin detects those infinite recursions and will throw an error to short-circuit any faulty logic before the server crashes.
 
-- **Database**: mongodb
-- **Storage Adapter**: localDisk
+### Running locally
+
+To run this repository locally, perform the following steps.
+
+1. Clone the repo
+1. Run `cp .env.example .env` to create an environment variable file
+1. Run `pnpm i` to install dependencies
+1. Run `pnpm dev` and then create a post to watch the plugin detect and throw when the post is created

src/payload.config.ts

@@ -70,6 +70,7 @@ export default buildConfig({
     // defaults to 50
     opsCounterPlugin({
       max: 25,
+      warnAt: 10,
     }),
   ],
 })

src/plugins/OpsCounter.ts

@@ -1,20 +1,28 @@
 import { APIError, CollectionBeforeOperationHook, Plugin } from 'payload'
 
 type Args = {
-  max: number
+  max?: number
+  warnAt?: number
 }
 
 export const opsCounterPlugin =
   (args?: Args): Plugin =>
   (config) => {
     const max = args?.max || 50
+    const warnAt = args?.warnAt || 10
 
-    const beforeOperationHook: CollectionBeforeOperationHook = ({ req }) => {
+    const beforeOperationHook: CollectionBeforeOperationHook = ({ req, collection, operation }) => {
       const currentCount = req.context.opsCount
 
       if (typeof currentCount === 'number') {
         req.context.opsCount = currentCount + 1
 
+        if (warnAt && currentCount >= warnAt) {
+          req.payload.logger.error(
+            `Detected a ${operation} in the "${collection}" collection which has run ${warnAt} times or more.`,
+          )
+        }
+
         if (currentCount > max) {
           throw new APIError(`Maximum operations of ${max} detected.`)
         }