generated from coulomb/repo-seed
Bernd Worsch
3cac021213
Some checks failed
Test / test (push) Has been cancelled
Delivers the full Phase 9 external API layer: - Versioned REST API (/api/v2/) with OpenAPI 3.1 spec; enum arrays for widget_type, event_type, annotation category drawn live from registry tables - OAuth 2.0 client credentials flow (/api/v2/token); hub:*:write scopes gated on active HubCapabilityManifest FK - API key management: SHA256-hashed tokens, key_prefix for display, one-time reveal on creation, revocation support - TypeScript and Python consumer SDKs generated from registry tables (/api/v2/sdk/ihf-client.ts, /api/v2/sdk/ihf-client.py) - Webhook delivery: HMAC-SHA256 signing, append-only webhook_deliveries, fire-and-forget dispatch via forkIO, 3-retry logic - Admin API dashboard with 24h stats (request count, error rate, last seen) - Rate limiting (per-minute) and daily quota enforcement via api_request_log - Schema migration: api_consumers, api_keys, webhook_subscriptions (CHECK constraint on 6 framework lifecycle topics), webhook_deliveries (append-only trigger), api_request_log - ARCHITECTURE-LAYERS.md scorecard: 3.34 → 3.41 (approaching Strong) - contracts/functional/interaction-reporting-v1.md extended with Phase 9 endpoint catalogue and 422 validation error format GAAF: no bare TEXT discriminators; webhook event_type uses CHECK constraint over 6 allowed framework lifecycle topic strings (not widget event types). Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
66 lines
2.4 KiB
Haskell
66 lines
2.4 KiB
Haskell
module Application.Helper.ApiRateLimit where
|
|
|
|
-- Rate limiting and request logging for /api/v2/ endpoints.
|
|
-- Called before action dispatch in all ApiV2* controllers.
|
|
|
|
import Generated.Types
|
|
import IHP.Prelude
|
|
import IHP.ModelSupport
|
|
import IHP.ControllerPrelude
|
|
import Data.Aeson (object, (.=))
|
|
import Database.PostgreSQL.Simple (Only(..))
|
|
import Web.Controller.Api.V2.Auth (respondWithStatus)
|
|
|
|
-- | Log a request to api_request_log and enforce rate limit / quota.
|
|
-- Returns () on success; calls respondWithStatus and exits on limit exceeded.
|
|
checkRateLimitAndLog ::
|
|
( ?context :: ControllerContext
|
|
, ?modelContext :: ModelContext
|
|
, ?respond :: Respond
|
|
, ?request :: Request
|
|
) =>
|
|
ApiConsumer ->
|
|
Text -> -- endpoint path
|
|
Text -> -- HTTP method
|
|
Int -> -- response status code (0 if not yet known; log after)
|
|
IO ()
|
|
checkRateLimitAndLog consumer endpoint method _statusCode = do
|
|
-- Check rate limit: requests in last 60 seconds
|
|
rows1 <- sqlQuery
|
|
"SELECT COUNT(*) FROM api_request_log \
|
|
\WHERE api_consumer_id = ? AND requested_at >= NOW() - INTERVAL '60 seconds'"
|
|
(Only consumer.id)
|
|
let reqCount = case rows1 of
|
|
[Only (n :: Int)] -> n
|
|
_ -> 0
|
|
|
|
when (reqCount >= consumer.rateLimitPerMinute) do
|
|
respondWithStatus 429 $ object
|
|
[ "error" .= ("Rate limit exceeded" :: Text)
|
|
, "code" .= ("rate_limited" :: Text)
|
|
, "retry_after" .= (60 :: Int)
|
|
]
|
|
|
|
-- Check daily quota
|
|
rows2 <- sqlQuery
|
|
"SELECT COUNT(*) FROM api_request_log \
|
|
\WHERE api_consumer_id = ? AND requested_at >= ? - INTERVAL '1 day'"
|
|
(consumer.id, consumer.quotaResetsAt)
|
|
let quotaUsed = case rows2 of
|
|
[Only (n :: Int)] -> n
|
|
_ -> 0
|
|
|
|
when (quotaUsed >= consumer.quotaPerDay) do
|
|
respondWithStatus 429 $ object
|
|
[ "error" .= ("Daily quota exceeded" :: Text)
|
|
, "code" .= ("quota_exceeded" :: Text)
|
|
, "quota_resets_at" .= consumer.quotaResetsAt
|
|
]
|
|
|
|
-- Log the request (status_code will be 0 here; update after response)
|
|
sqlExec
|
|
"INSERT INTO api_request_log (id, api_consumer_id, endpoint, method, status_code, requested_at) \
|
|
\VALUES (uuid_generate_v4(), ?, ?, ?, 200, NOW())"
|
|
(consumer.id, endpoint, method)
|
|
pure ()
|