Merge pull request #19 from aibtcdev/fix/better-error-handling

Add logging / improve error handling

Author: whoabuddy

src/config.ts

@@ -1,8 +1,10 @@
 import { Env } from '../worker-configuration';
+import { ApiError } from './utils/api-error';
+import { ErrorCode } from './utils/error-catalog';
 
 /**
  * Singleton configuration class for the application
- * 
+ *
  * Provides centralized access to configuration settings and environment variables
  */
 export class AppConfig {
@@ -11,7 +13,7 @@ export class AppConfig {
 
 	/**
 	 * Private constructor to enforce singleton pattern
-	 * 
+	 *
 	 * @param env - The Cloudflare Worker environment
 	 */
 	private constructor(env: Env) {
@@ -20,7 +22,7 @@ export class AppConfig {
 
 	/**
 	 * Gets the singleton instance of AppConfig
-	 * 
+	 *
 	 * @param env - The Cloudflare Worker environment (required on first call)
 	 * @returns The AppConfig singleton instance
 	 * @throws Error if called without env before initialization
@@ -29,17 +31,22 @@ export class AppConfig {
 		if (!AppConfig.instance && env) {
 			AppConfig.instance = new AppConfig(env);
 		} else if (!AppConfig.instance) {
-			throw new Error('AppConfig must be initialized with environment variables first');
+			throw new ApiError(ErrorCode.CONFIG_ERROR, {
+				reason: 'AppConfig must be initialized with environment variables first',
+			});
 		}
 		return AppConfig.instance;
 	}
 
 	/**
 	 * Returns the application configuration settings
-	 * 
+	 *
 	 * @returns Configuration object with all application settings
 	 */
 	public getConfig() {
+		// Check if Hiro API key is available
+		const hasHiroApiKey = !!this.env.HIRO_API_KEY;
+
 		return {
 			// supported services for API caching
 			// each entry is a durable object that handles requests
@@ -54,9 +61,21 @@ export class AppConfig {
 			RETRY_DELAY: 1000, // multiplied by retry attempt number
 			// how often to warm the cache, should be shorter than the cache TTL
 			ALARM_INTERVAL_MS: 300000, // 5 minutes
+			// Hiro API specific rate limiting settings
+			HIRO_API_RATE_LIMIT: {
+				// Adjust based on whether we have an API key
+				// Hiro limits: 50 RPM without key, 500 RPM with key
+				MAX_REQUESTS_PER_MINUTE: hasHiroApiKey ? 500 : 50,
+				// Convert to our interval format
+				get MAX_REQUESTS_PER_INTERVAL() {
+					return this.MAX_REQUESTS_PER_MINUTE;
+				},
+				INTERVAL_MS: 60000, // 1 minute
+			},
 			// environment variables
 			SUPABASE_URL: this.env.SUPABASE_URL,
 			SUPABASE_SERVICE_KEY: this.env.SUPABASE_SERVICE_KEY,
+			HIRO_API_KEY: this.env.HIRO_API_KEY,
 		};
 	}
 }

src/durable-objects/bns-do.ts

@@ -2,13 +2,15 @@ import { DurableObject } from 'cloudflare:workers';
 import { Env } from '../../worker-configuration';
 import { AppConfig } from '../config';
 import { validateStacksAddress } from '@stacks/transactions';
-import { createJsonResponse } from '../utils/requests-responses-util';
 import { getKnownAddresses } from '../utils/address-store-util';
 import { getNameFromAddress, initStacksFetcher } from '../utils/bns-v2-util';
+import { ApiError } from '../utils/api-error';
+import { ErrorCode } from '../utils/error-catalog';
+import { handleRequest } from '../utils/request-handler';
 
 /**
  * Durable Object class for the BNS (Blockchain Naming System) API
- * 
+ *
  * This Durable Object handles BNS name lookups for Stacks addresses.
  * It provides endpoints to retrieve BNS names associated with Stacks addresses
  * and maintains a cache of these associations to reduce API calls.
@@ -40,13 +42,13 @@ export class BnsApiDO extends DurableObject<Env> {
 
 	/**
 	 * Alarm handler that periodically updates the BNS name cache
-	 * 
+	 *
 	 * This method is triggered by the Durable Object's alarm system and:
 	 * 1. Retrieves all known Stacks addresses from KV storage
 	 * 2. Updates the BNS name for each address
 	 * 3. Stores the results in KV cache with the configured TTL
 	 * 4. Logs statistics about the update process
-	 * 
+	 *
 	 * @returns A promise that resolves when the alarm handler completes
 	 */
 	async alarm(): Promise<void> {
@@ -97,75 +99,81 @@ export class BnsApiDO extends DurableObject<Env> {
 
 	/**
 	 * Main request handler for the BNS API Durable Object
-	 * 
+	 *
 	 * Handles the following endpoints:
 	 * - / - Returns a list of supported endpoints
 	 * - /names/{address} - Returns the BNS name for the given Stacks address
-	 * 
+	 *
 	 * @param request - The incoming HTTP request
 	 * @returns A Response object with the requested data or an error message
 	 */
 	async fetch(request: Request): Promise<Response> {
 		const url = new URL(request.url);
 		const path = url.pathname;
 
-		if (!path.startsWith(this.BASE_PATH)) {
-			return createJsonResponse(
-				{
-					error: `Request at ${path} does not start with base path ${this.BASE_PATH}`,
-				},
-				404
-			);
-		}
+		return handleRequest(
+			async () => {
+				if (!path.startsWith(this.BASE_PATH)) {
+					throw new ApiError(ErrorCode.NOT_FOUND, {
+						resource: path,
+						basePath: this.BASE_PATH,
+					});
+				}
 
-		// Remove base path to get the endpoint
-		const endpoint = path.replace(this.BASE_PATH, '');
+				// Remove base path to get the endpoint
+				const endpoint = path.replace(this.BASE_PATH, '');
 
-		// Handle root path
-		if (endpoint === '' || endpoint === '/') {
-			return createJsonResponse({
-				message: `Supported endpoints: ${this.SUPPORTED_ENDPOINTS.join(', ')}`,
-			});
-		}
+				// Handle root path
+				if (endpoint === '' || endpoint === '/') {
+					return {
+						message: `Supported endpoints: ${this.SUPPORTED_ENDPOINTS.join(', ')}`,
+					};
+				}
 
-		if (endpoint === '/names') {
-			return createJsonResponse({
-				message: `Please provide an address to look up the name for, e.g. /names/SP2QEZ06AGJ3RKJPBV14SY1V5BBFNAW33D96YPGZF`,
-			});
-		}
+				if (endpoint === '/names') {
+					return {
+						message: `Please provide an address to look up the name for, e.g. /names/SP2QEZ06AGJ3RKJPBV14SY1V5BBFNAW33D96YPGZF`,
+					};
+				}
 
-		// Handle name lookups
-		if (endpoint.startsWith('/names/')) {
-			const address = endpoint.replace('/names/', '');
-			const validAddress = validateStacksAddress(address);
-			if (!validAddress) {
-				return createJsonResponse({ error: `Invalid address ${address}, valid Stacks address required` }, 400);
-			}
-			const cacheKey = `${this.CACHE_PREFIX}_names_${address}`;
-			const cachedName = await this.env.AIBTCDEV_CACHE_KV.get<string>(cacheKey);
-			if (cachedName) {
-				return createJsonResponse(cachedName);
-			}
-			const name = await getNameFromAddress(address);
-
-			if (name === '') {
-				return createJsonResponse(
-					{
-						error: `No registered name found for address ${address}`,
-					},
-					404
-				);
-			}
+				// Handle name lookups
+				if (endpoint.startsWith('/names/')) {
+					const address = endpoint.replace('/names/', '');
+					const validAddress = validateStacksAddress(address);
+					if (!validAddress) {
+						throw new ApiError(ErrorCode.INVALID_REQUEST, {
+							reason: `Invalid address ${address}, valid Stacks address required`,
+						});
+					}
 
-			await this.env.AIBTCDEV_CACHE_KV.put(cacheKey, name, { expirationTtl: this.CACHE_TTL });
-			return createJsonResponse(name);
-		}
+					const cacheKey = `${this.CACHE_PREFIX}_names_${address}`;
+					const cachedName = await this.env.AIBTCDEV_CACHE_KV.get<string>(cacheKey);
+					if (cachedName) {
+						return cachedName;
+					}
 
-		return createJsonResponse(
-			{
-				error: `Unsupported endpoint: ${endpoint}, supported endpoints: ${this.SUPPORTED_ENDPOINTS.join(', ')}`,
+					const name = await getNameFromAddress(address);
+
+					if (name === '') {
+						throw new ApiError(ErrorCode.NOT_FOUND, {
+							resource: `name for address ${address}`,
+							reason: 'No registered name found',
+						});
+					}
+
+					await this.env.AIBTCDEV_CACHE_KV.put(cacheKey, name, { expirationTtl: this.CACHE_TTL });
+					return name;
+				}
+
+				throw new ApiError(ErrorCode.NOT_FOUND, {
+					resource: endpoint,
+					supportedEndpoints: this.SUPPORTED_ENDPOINTS,
+				});
 			},
-			404
+			this.env,
+			{
+				slowThreshold: 2000, // BNS lookups can be slow
+			}
 		);
 	}
 }