Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 21x 21x 21x 21x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 25x 3x 3x 3x 3x 3x 3x 3x 25x 1x 1x 1x 1x 1x 1x 1x 21x 21x 25x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 25x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 3x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 3x 3x 4x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 4x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 4x 4x 4x 4x 4x 4x 5x 5x 5x 5x 5x 5x 5x 5x 5x 5x 4x 4x | /**
* Tracked Query Utility
*
* Wraps database queries with performance tracking.
* Records metrics to the database for analysis and monitoring.
*/
import { logger } from '@/lib/logging';
import {
recordDatabaseMetric,
inferOperation,
inferTableName,
type QueryOperation,
} from '@/lib/monitoring/databaseMetrics';
/**
* Options for tracked queries
*/
export interface TrackedQueryOptions {
/** Duration threshold for slow query warnings (ms). Default: 500 */
warnThreshold?: number;
/** Log level for successful queries. Default: 'slow' */
logLevel?: 'always' | 'slow' | 'never';
/** Whether to count rows in result. Default: true for arrays */
includeRowCount?: boolean;
/** Explicit operation type. Auto-inferred if not provided */
operation?: QueryOperation;
/** Explicit table name. Auto-inferred if not provided */
tableName?: string;
/** Request ID for correlation */
requestId?: string;
/** User ID for tracking */
userId?: number;
}
/**
* Tracked query result with metrics
*/
export interface TrackedQueryResult<T> {
data: T;
duration: number;
rowCount?: number;
}
/**
* Execute a database query with performance tracking
*
* @param name - Descriptive name for the query (e.g., "findActiveProducts", "getUserById")
* @param queryFn - Async function that executes the query
* @param options - Optional configuration
* @returns The query result
*
* @example
* ```typescript
* // Basic usage
* const products = await trackedQuery('findActiveProducts', () =>
* prisma.product.findMany({ where: { status: 'ACTIVE' } })
* );
*
* // With options
* const user = await trackedQuery(
* 'getUserById',
* () => prisma.user.findUnique({ where: { id: userId } }),
* { tableName: 'user', operation: 'findUnique', warnThreshold: 200 }
* );
* ```
*/
export async function trackedQuery<T>(
name: string,
queryFn: () => Promise<T>,
options?: TrackedQueryOptions
): Promise<T> {
const startTime = performance.now();
const warnThreshold = options?.warnThreshold ?? 500;
const logLevel = options?.logLevel ?? 'slow';
// Infer operation and table from name if not provided
const operation = options?.operation ?? inferOperation(name);
const tableName = options?.tableName ?? inferTableName(name);
try {
const result = await queryFn();
const duration = performance.now() - startTime;
// Calculate row count for array results
const rowCount =
options?.includeRowCount !== false && Array.isArray(result)
? result.length
: undefined;
// Record metric (non-blocking)
recordDatabaseMetric({
name,
operation,
tableName,
duration,
rowCount,
success: true,
requestId: options?.requestId,
userId: options?.userId,
});
// Log based on level and threshold
const isSlow = duration > warnThreshold;
if (isSlow) {
logger.warn(`Slow query: ${name}`, {
category: 'DATABASE',
duration: Number(duration.toFixed(2)),
rowCount,
tableName,
operation,
});
} else if (logLevel === 'always') {
logger.debug(`Query: ${name}`, {
category: 'DATABASE',
duration: Number(duration.toFixed(2)),
rowCount,
tableName,
});
}
return result;
} catch (error) {
const duration = performance.now() - startTime;
// Record failed metric
recordDatabaseMetric({
name,
operation,
tableName,
duration,
success: false,
errorType: error instanceof Error ? error.name : 'Unknown',
requestId: options?.requestId,
userId: options?.userId,
});
// Always log errors
logger.error(`Query failed: ${name}`, error instanceof Error ? error : new Error(String(error)), {
category: 'DATABASE',
duration: Number(duration.toFixed(2)),
tableName,
operation,
});
throw error;
}
}
/**
* Execute a tracked query and return both result and metrics
*
* @example
* ```typescript
* const { data, duration, rowCount } = await trackedQueryWithMetrics(
* 'findProducts',
* () => prisma.product.findMany()
* );
* console.log(`Found ${rowCount} products in ${duration}ms`);
* ```
*/
export async function trackedQueryWithMetrics<T>(
name: string,
queryFn: () => Promise<T>,
options?: TrackedQueryOptions
): Promise<TrackedQueryResult<T>> {
const startTime = performance.now();
const warnThreshold = options?.warnThreshold ?? 500;
const operation = options?.operation ?? inferOperation(name);
const tableName = options?.tableName ?? inferTableName(name);
try {
const data = await queryFn();
const duration = performance.now() - startTime;
const rowCount = Array.isArray(data) ? data.length : undefined;
// Record metric
recordDatabaseMetric({
name,
operation,
tableName,
duration,
rowCount,
success: true,
requestId: options?.requestId,
userId: options?.userId,
});
// Log if slow
if (duration > warnThreshold) {
logger.warn(`Slow query: ${name}`, {
category: 'DATABASE',
duration: Number(duration.toFixed(2)),
rowCount,
tableName,
});
}
return { data, duration, rowCount };
} catch (error) {
const duration = performance.now() - startTime;
recordDatabaseMetric({
name,
operation,
tableName,
duration,
success: false,
errorType: error instanceof Error ? error.name : 'Unknown',
requestId: options?.requestId,
userId: options?.userId,
});
logger.error(`Query failed: ${name}`, error instanceof Error ? error : new Error(String(error)), {
category: 'DATABASE',
duration: Number(duration.toFixed(2)),
tableName,
});
throw error;
}
}
/**
* Create a query tracker for a specific context (request/user)
* Useful for tracking all queries within a single request
*
* @example
* ```typescript
* // In an API route handler
* const track = createQueryTracker({ requestId, userId });
*
* const users = await track('findUsers', () => prisma.user.findMany());
* const products = await track('findProducts', () => prisma.product.findMany());
* ```
*/
export function createQueryTracker(context: {
requestId?: string;
userId?: number;
warnThreshold?: number;
}) {
return function track<T>(
name: string,
queryFn: () => Promise<T>,
options?: Omit<TrackedQueryOptions, 'requestId' | 'userId'>
): Promise<T> {
return trackedQuery(name, queryFn, {
...options,
requestId: context.requestId,
userId: context.userId,
warnThreshold: options?.warnThreshold ?? context.warnThreshold,
});
};
}
|