realuptime-errors 0.1.0

data/scrub-vectors.json

@@ -0,0 +1,506 @@
+{
+  "comment": "Shared PII-scrub test vectors for the Errors SDKs and the server-side second net (docs/errors-plan.md, 'The SDKs: two languages, one contract'). Consumed by packages/errors-js/scrub.test.ts, packages/errors-py/tests/test_scrub.py, and packages/db/error-scrub.test.ts. All three implementations must produce byte-identical output for every vector; a semantic change here is a wire-contract change and needs all three updated in one PR. The server's second net applies the PATTERN rules only: FIELD REMOVAL (removed headers, and v2's user.email / user.username) and allowFields are client-side duties -- a field that reaches the server was either never in the removal set or was deliberately opted back in, and the server cannot tell which. Vectors where the server's output therefore differs carry expectedServer; absent it, the server expects `expected`. Vectors named 'v2 ...' cover the REA-182 additions (identity, tags, custom context, device metadata, matched route, frame locals); every v1 vector above them is unchanged, which is itself part of the additive guarantee.",
+  "version": 2,
+  "vectors": [
+    {
+      "name": "card number, plain, Luhn-valid",
+      "event": { "message": "Payment failed for 4242424242424242" },
+      "expected": { "message": "Payment failed for [scrubbed]" }
+    },
+    {
+      "name": "card number with separators, Luhn-valid",
+      "event": { "message": "card 4111 1111 1111 1111 declined" },
+      "expected": { "message": "card [scrubbed] declined" }
+    },
+    {
+      "name": "16 digits failing Luhn stay (an order id is not a card)",
+      "event": { "message": "order 4242424242424241 not found" },
+      "expected": { "message": "order 4242424242424241 not found" }
+    },
+    {
+      "name": "short digit runs stay",
+      "event": { "message": "HTTP 502 after 12345 ms" },
+      "expected": { "message": "HTTP 502 after 12345 ms" }
+    },
+    {
+      "name": "amex-length card, Luhn-valid",
+      "event": { "message": "378282246310005 charged twice" },
+      "expected": { "message": "[scrubbed] charged twice" }
+    },
+    {
+      "name": "JWT three-dot shape",
+      "event": { "message": "token eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjMifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJVadQssw5c expired" },
+      "expected": { "message": "token [scrubbed] expired" }
+    },
+    {
+      "name": "prefixed secret key (sk_)",
+      "event": { "message": "sk_live_abcdef1234567890 rejected" },
+      "expected": { "message": "[scrubbed] rejected" }
+    },
+    {
+      "name": "prefixed token (ghp_)",
+      "event": { "message": "push denied for ghp_AbCdEf1234567890abcdef" },
+      "expected": { "message": "push denied for [scrubbed]" }
+    },
+    {
+      "name": "realuptime agent token (rua_)",
+      "event": { "message": "agent auth failed: rua_0123456789abcdef0123456789abcdef" },
+      "expected": { "message": "agent auth failed: [scrubbed]" }
+    },
+    {
+      "name": "long hex run (32+)",
+      "event": { "message": "session deadbeefdeadbeefdeadbeefdeadbeef invalid" },
+      "expected": { "message": "session [scrubbed] invalid" }
+    },
+    {
+      "name": "short hex run stays (16)",
+      "event": { "message": "trace deadbeefdeadbeef sampled" },
+      "expected": { "message": "trace deadbeefdeadbeef sampled" }
+    },
+    {
+      "name": "long base64-ish run (40+)",
+      "event": { "message": "blob QUJDREVGR0hJSktMTU5PUFFSU1RVVldYWVphYmNkZWZnaGlq= rejected" },
+      "expected": { "message": "blob [scrubbed] rejected" }
+    },
+    {
+      "name": "authorization header removed, benign header kept",
+      "event": {
+        "message": "request failed",
+        "request": {
+          "method": "GET",
+          "path": "/orders",
+          "status": 500,
+          "headers": { "authorization": "Bearer some-session-value", "x-request-id": "req-42" }
+        }
+      },
+      "expected": {
+        "message": "request failed",
+        "request": {
+          "method": "GET",
+          "path": "/orders",
+          "status": 500,
+          "headers": { "authorization": "[scrubbed]", "x-request-id": "req-42" }
+        }
+      },
+      "expectedServer": {
+        "message": "request failed",
+        "request": {
+          "method": "GET",
+          "path": "/orders",
+          "status": 500,
+          "headers": { "authorization": "Bearer some-session-value", "x-request-id": "req-42" }
+        }
+      }
+    },
+    {
+      "name": "cookie and set-cookie removed, any casing",
+      "event": {
+        "message": "boom",
+        "request": {
+          "method": "POST",
+          "path": "/login",
+          "status": 500,
+          "headers": { "Cookie": "sid=abc", "Set-Cookie": "sid=def", "Proxy-Authorization": "Basic xyz" }
+        }
+      },
+      "expected": {
+        "message": "boom",
+        "request": {
+          "method": "POST",
+          "path": "/login",
+          "status": 500,
+          "headers": { "Cookie": "[scrubbed]", "Set-Cookie": "[scrubbed]", "Proxy-Authorization": "[scrubbed]" }
+        }
+      },
+      "expectedServer": {
+        "message": "boom",
+        "request": {
+          "method": "POST",
+          "path": "/login",
+          "status": 500,
+          "headers": { "Cookie": "sid=abc", "Set-Cookie": "sid=def", "Proxy-Authorization": "Basic xyz" }
+        }
+      }
+    },
+    {
+      "name": "kept header values still pass the pattern scrub",
+      "event": {
+        "message": "boom",
+        "request": {
+          "method": "GET",
+          "path": "/v1/charge",
+          "status": 500,
+          "headers": { "x-api-key": "sk_test_abcdefgh12345678" }
+        }
+      },
+      "expected": {
+        "message": "boom",
+        "request": {
+          "method": "GET",
+          "path": "/v1/charge",
+          "status": 500,
+          "headers": { "x-api-key": "[scrubbed]" }
+        }
+      }
+    },
+    {
+      "name": "allowFields opts one header back in, by lowercased name",
+      "allowFields": ["authorization"],
+      "event": {
+        "message": "boom",
+        "request": {
+          "method": "GET",
+          "path": "/me",
+          "status": 401,
+          "headers": { "Authorization": "Digest username=alice" }
+        }
+      },
+      "expected": {
+        "message": "boom",
+        "request": {
+          "method": "GET",
+          "path": "/me",
+          "status": 401,
+          "headers": { "Authorization": "Digest username=alice" }
+        }
+      }
+    },
+    {
+      "name": "allowFields never disables the pattern scrub on the kept value",
+      "allowFields": ["authorization"],
+      "event": {
+        "message": "boom",
+        "request": {
+          "method": "GET",
+          "path": "/me",
+          "status": 401,
+          "headers": { "authorization": "Bearer eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjMifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJVadQssw5c" }
+        }
+      },
+      "expected": {
+        "message": "boom",
+        "request": {
+          "method": "GET",
+          "path": "/me",
+          "status": 401,
+          "headers": { "authorization": "Bearer [scrubbed]" }
+        }
+      }
+    },
+    {
+      "name": "token in the request path is scrubbed",
+      "event": {
+        "message": "boom",
+        "request": {
+          "method": "GET",
+          "path": "/reset/eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjMifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJVadQssw5c",
+          "status": 404
+        }
+      },
+      "expected": {
+        "message": "boom",
+        "request": { "method": "GET", "path": "/reset/[scrubbed]", "status": 404 }
+      }
+    },
+    {
+      "name": "frames and tags are left alone; only message and request are scrubbed",
+      "event": {
+        "message": "TypeError: x is undefined",
+        "exceptionType": "TypeError",
+        "release": "deadbeefdeadbeefdeadbeefdeadbeef",
+        "environment": "production",
+        "frames": [
+          { "file": "src/checkout.ts", "function": "processOrder", "line": 42, "inApp": true }
+        ]
+      },
+      "expected": {
+        "message": "TypeError: x is undefined",
+        "exceptionType": "TypeError",
+        "release": "deadbeefdeadbeefdeadbeefdeadbeef",
+        "environment": "production",
+        "frames": [
+          { "file": "src/checkout.ts", "function": "processOrder", "line": 42, "inApp": true }
+        ]
+      }
+    },
+    {
+      "name": "multiple secrets in one message are each scrubbed",
+      "event": { "message": "retry with sk_live_abcdefgh12345678 after 4242424242424242 failed" },
+      "expected": { "message": "retry with [scrubbed] after [scrubbed] failed" }
+    },
+    {
+      "name": "breadcrumb messages pass the pattern scrub (Phase 3)",
+      "event": {
+        "message": "boom",
+        "breadcrumbs": [
+          { "timestamp": null, "category": "http", "message": "POST /charge with sk_live_abcdefgh12345678", "data": null }
+        ]
+      },
+      "expected": {
+        "message": "boom",
+        "breadcrumbs": [
+          { "timestamp": null, "category": "http", "message": "POST /charge with [scrubbed]", "data": null }
+        ]
+      }
+    },
+    {
+      "name": "breadcrumb data values pass the pattern scrub; benign values stay",
+      "event": {
+        "message": "boom",
+        "breadcrumbs": [
+          {
+            "timestamp": null,
+            "category": "payment",
+            "message": "charging card",
+            "data": { "card": "4242424242424242", "order": "ord-42" }
+          }
+        ]
+      },
+      "expected": {
+        "message": "boom",
+        "breadcrumbs": [
+          {
+            "timestamp": null,
+            "category": "payment",
+            "message": "charging card",
+            "data": { "card": "[scrubbed]", "order": "ord-42" }
+          }
+        ]
+      }
+    },
+    {
+      "name": "frame source-context lines pass the pattern scrub; file, function and line stay",
+      "event": {
+        "message": "boom",
+        "frames": [
+          {
+            "file": "app/billing.py",
+            "function": "charge",
+            "line": 12,
+            "inApp": true,
+            "contextLine": "API_KEY = \"sk_live_abcdefgh12345678\"",
+            "preContext": ["import stripe"],
+            "postContext": ["charge(API_KEY)"]
+          }
+        ]
+      },
+      "expected": {
+        "message": "boom",
+        "frames": [
+          {
+            "file": "app/billing.py",
+            "function": "charge",
+            "line": 12,
+            "inApp": true,
+            "contextLine": "API_KEY = \"[scrubbed]\"",
+            "preContext": ["import stripe"],
+            "postContext": ["charge(API_KEY)"]
+          }
+        ]
+      }
+    },
+    {
+      "name": "Django-style request path with a card number segment is scrubbed (REA-184 Django middleware)",
+      "event": {
+        "message": "boom",
+        "request": { "method": "GET", "path": "/orders/4111111111111111/receipt", "status": 500 }
+      },
+      "expected": {
+        "message": "boom",
+        "request": { "method": "GET", "path": "/orders/[scrubbed]/receipt", "status": 500 }
+      }
+    },
+    {
+      "name": "FastAPI/Starlette route-template path carrying a prefixed key param is scrubbed (REA-184 FastAPI middleware)",
+      "event": {
+        "message": "webhook delivery failed",
+        "request": { "method": "POST", "path": "/webhooks/sk_live_abcdefgh12345678/deliver", "status": 500 }
+      },
+      "expected": {
+        "message": "webhook delivery failed",
+        "request": { "method": "POST", "path": "/webhooks/[scrubbed]/deliver", "status": 500 }
+      }
+    },
+    {
+      "name": "Celery task-failure message embedding a card number is scrubbed (REA-184 Celery signal hook)",
+      "event": {
+        "message": "charge 4242424242424242 failed in task process_payment",
+        "fingerprint": ["celery", "app.tasks.process_payment", "ValueError"]
+      },
+      "expected": {
+        "message": "charge [scrubbed] failed in task process_payment",
+        "fingerprint": ["celery", "app.tasks.process_payment", "ValueError"]
+      }
+    },
+    {
+      "name": "Express default capture has no headers at all; a benign path with a short digit run stays untouched (REA-184 Express middleware)",
+      "event": {
+        "message": "checkout failed",
+        "request": { "method": "POST", "path": "/checkout/session/8842", "status": 500 }
+      },
+      "expected": {
+        "message": "checkout failed",
+        "request": { "method": "POST", "path": "/checkout/session/8842", "status": 500 }
+      }
+    },
+
+    {
+      "name": "v2 identity: user.id rides as-is, email and username are removed by default (REA-182)",
+      "event": {
+        "message": "checkout failed",
+        "user": { "id": "acct_9182", "email": "alice@example.com", "username": "alice" }
+      },
+      "expected": {
+        "message": "checkout failed",
+        "user": { "id": "acct_9182", "email": "[scrubbed]", "username": "[scrubbed]" }
+      },
+      "expectedServer": {
+        "message": "checkout failed",
+        "user": { "id": "acct_9182", "email": "alice@example.com", "username": "alice" }
+      }
+    },
+    {
+      "name": "v2 identity: allowFields opts user.email back in by exact dotted name; username stays removed",
+      "allowFields": ["user.email"],
+      "event": {
+        "message": "checkout failed",
+        "user": { "id": "acct_9182", "email": "alice@example.com", "username": "alice" }
+      },
+      "expected": {
+        "message": "checkout failed",
+        "user": { "id": "acct_9182", "email": "alice@example.com", "username": "[scrubbed]" }
+      },
+      "expectedServer": {
+        "message": "checkout failed",
+        "user": { "id": "acct_9182", "email": "alice@example.com", "username": "alice" }
+      }
+    },
+    {
+      "name": "v2 identity: an opted-in user.email still passes the pattern scrub",
+      "allowFields": ["user.email"],
+      "event": {
+        "message": "boom",
+        "user": { "email": "alice+eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjMifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJVadQssw5c@example.com" }
+      },
+      "expected": {
+        "message": "boom",
+        "user": { "email": "alice+[scrubbed]@example.com" }
+      }
+    },
+    {
+      "name": "v2 identity: a token-shaped user.id is pattern-scrubbed like any other string",
+      "event": { "message": "boom", "user": { "id": "sk_live_abcdefgh12345678" } },
+      "expected": { "message": "boom", "user": { "id": "[scrubbed]" } }
+    },
+    {
+      "name": "v2 tags: values pass the pattern scrub, keys and benign values stay",
+      "event": {
+        "message": "charge failed",
+        "tags": { "tenant": "acme", "plan": "growth", "card": "4242424242424242" }
+      },
+      "expected": {
+        "message": "charge failed",
+        "tags": { "tenant": "acme", "plan": "growth", "card": "[scrubbed]" }
+      }
+    },
+    {
+      "name": "v2 custom context: values pass the pattern scrub",
+      "event": {
+        "message": "boom",
+        "context": {
+          "cartTotal": "49.99",
+          "sessionToken": "eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiIxMjMifQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJVadQssw5c"
+        }
+      },
+      "expected": {
+        "message": "boom",
+        "context": { "cartTotal": "49.99", "sessionToken": "[scrubbed]" }
+      }
+    },
+    {
+      "name": "v2 device: runtime metadata is left intact (it carries no customer data)",
+      "event": {
+        "message": "boom",
+        "device": { "runtime": "node", "runtimeVersion": "22.4.0", "platform": "linux", "arch": "arm64" }
+      },
+      "expected": {
+        "message": "boom",
+        "device": { "runtime": "node", "runtimeVersion": "22.4.0", "platform": "linux", "arch": "arm64" }
+      }
+    },
+    {
+      "name": "v2 route: the matched route template is pattern-scrubbed like the path",
+      "event": {
+        "message": "boom",
+        "request": {
+          "method": "POST",
+          "path": "/webhooks/sk_live_abcdefgh12345678/deliver",
+          "route": "/webhooks/sk_live_abcdefgh12345678/deliver",
+          "status": 500
+        }
+      },
+      "expected": {
+        "message": "boom",
+        "request": {
+          "method": "POST",
+          "path": "/webhooks/[scrubbed]/deliver",
+          "route": "/webhooks/[scrubbed]/deliver",
+          "status": 500
+        }
+      }
+    },
+    {
+      "name": "v2 route: a parameterised route template survives untouched (it is the grouping key)",
+      "event": {
+        "message": "boom",
+        "request": { "method": "GET", "path": "/orders/8842", "route": "/orders/:id", "status": 500 }
+      },
+      "expected": {
+        "message": "boom",
+        "request": { "method": "GET", "path": "/orders/8842", "route": "/orders/:id", "status": 500 }
+      }
+    },
+    {
+      "name": "v2 local variables: captured frame locals pass the pattern scrub",
+      "event": {
+        "message": "boom",
+        "frames": [
+          {
+            "file": "app/billing.py",
+            "function": "charge",
+            "line": 12,
+            "inApp": true,
+            "vars": { "attempt": "3", "card": "4242424242424242", "api_key": "sk_live_abcdefgh12345678" }
+          }
+        ]
+      },
+      "expected": {
+        "message": "boom",
+        "frames": [
+          {
+            "file": "app/billing.py",
+            "function": "charge",
+            "line": 12,
+            "inApp": true,
+            "vars": { "attempt": "3", "card": "[scrubbed]", "api_key": "[scrubbed]" }
+          }
+        ]
+      }
+    },
+    {
+      "name": "v2 adapter forwarding: a framework tag and a route ride together, neither leaking headers (REA-182)",
+      "event": {
+        "message": "TypeError: undefined is not a function",
+        "tags": { "framework": "express" },
+        "request": { "method": "GET", "path": "/orders/8842", "route": "/orders/:id", "status": 500 },
+        "device": { "runtime": "node", "runtimeVersion": "22.4.0" }
+      },
+      "expected": {
+        "message": "TypeError: undefined is not a function",
+        "tags": { "framework": "express" },
+        "request": { "method": "GET", "path": "/orders/8842", "route": "/orders/:id", "status": 500 },
+        "device": { "runtime": "node", "runtimeVersion": "22.4.0" }
+      }
+    }
+  ]
+}

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: realuptime-errors
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- RealUptime
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-08-24 00:00:00.000000000 Z
+dependencies: []
+description: Captures exceptions with scrub-by-default PII handling, bounded buffering
+  with honest drop counters, and framework integrations for Rails, Rack and Sidekiq.
+  Standard library only.
+email:
+- support@realuptime.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/realuptime/errors.rb
+- lib/realuptime/errors/rack.rb
+- lib/realuptime/errors/rails.rb
+- lib/realuptime/errors/scrub.rb
+- lib/realuptime/errors/sidekiq.rb
+- lib/realuptime/errors/transport.rb
+- lib/realuptime/errors/version.rb
+- scrub-vectors.json
+homepage: https://realuptime.io/error-tracking
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://realuptime.io/error-tracking
+  source_code_uri: https://github.com/RealUptimeHQ/realuptime-errors-ruby
+  bug_tracker_uri: https://github.com/RealUptimeHQ/realuptime-errors-ruby/issues
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Zero-dependency error tracking SDK for Ruby, Rails, Rack and Sidekiq (RealUptime
+  Errors).
+test_files: []