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 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 | 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 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 3x 3x 3x 3x 3x 3x 3x 3x 1x 1x 1x 1x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 4x 1x 1x 1x 3x 3x 3x 3x 3x 4x 1x 1x 1x 1x 1x 3x 4x 1x 1x 1x 1x 1x 1x 3x 4x 1x 1x 4x 4x 4x 1x 1x 1x 4x 4x 4x | /**
* Request Chaining
*
* Enables running multiple API requests in sequence where subsequent
* requests can use data from previous responses.
*/
import { ApiTestRequest, ApiTestResponse } from '@/types/api-docs';
import { executeRequest } from './executor';
import { clientLogger } from '@/lib/logging/clientLogger';
export interface ChainStep {
id: string;
name: string;
request: ApiTestRequest;
/** Variable extractions from response */
extractions?: VariableExtraction[];
/** Conditions that must be met to continue */
assertions?: ChainAssertion[];
/** Delay in ms before executing this step */
delay?: number;
/** Skip this step if condition fails */
skipIf?: string;
}
export interface VariableExtraction {
/** Variable name to store (e.g., "userId") */
name: string;
/** JSONPath-like expression (e.g., "$.data.id", "$.items[0].name") */
path: string;
/** Optional default value if extraction fails */
defaultValue?: unknown;
}
export interface ChainAssertion {
/** JSONPath to value to check */
path: string;
/** Comparison operator */
operator: 'equals' | 'notEquals' | 'contains' | 'notContains' | 'exists' | 'notExists' | 'gt' | 'lt' | 'gte' | 'lte';
/** Expected value */
expected?: unknown;
/** Error message if assertion fails */
message?: string;
}
export interface ChainContext {
/** Extracted variables from previous steps */
variables: Record<string, unknown>;
/** Results from each step */
stepResults: StepResult[];
/** Current step index */
currentStep: number;
/** Whether the chain is currently running */
isRunning: boolean;
/** Whether the chain completed successfully */
success: boolean;
/** Error message if chain failed */
error?: string;
/** Total execution time */
totalDuration: number;
}
export interface StepResult {
stepId: string;
stepName: string;
request: ApiTestRequest;
response: ApiTestResponse | null;
success: boolean;
error?: string;
skipped?: boolean;
extractedVariables?: Record<string, unknown>;
assertionResults?: AssertionResult[];
duration: number;
}
export interface AssertionResult {
assertion: ChainAssertion;
passed: boolean;
actualValue?: unknown;
message: string;
}
/**
* Extract value from object using JSONPath-like syntax
* Supports: $.key, $.key.nested, $.array[0], $.array[*].field
*/
function extractValue(obj: unknown, path: string): unknown {
if (!path.startsWith('$.')) {
throw new Error(`Invalid path: ${path}. Must start with $.`);
}
const parts = path.slice(2).split(/\.|\[|\]/).filter(Boolean);
let current: unknown = obj;
for (const part of parts) {
if (current === null || current === undefined) {
return undefined;
}
if (part === '*') {
// Array wildcard - not fully implemented
if (Array.isArray(current)) {
return current;
}
return undefined;
}
if (/^\d+$/.test(part)) {
// Array index
const index = parseInt(part);
if (Array.isArray(current)) {
current = current[index];
} else {
return undefined;
}
} else {
// Object key
if (typeof current === 'object' && current !== null) {
current = (current as Record<string, unknown>)[part];
} else {
return undefined;
}
}
}
return current;
}
/**
* Interpolate variables in a string
* Replaces {{variableName}} with the variable value
*/
function interpolateString(str: string, variables: Record<string, unknown>): string {
return str.replace(/\{\{(\w+)\}\}/g, (match, varName) => {
const value = variables[varName];
if (value === undefined) {
clientLogger.warn(`Variable "${varName}" not found`, {
category: 'SYSTEM',
varName,
});
return match;
}
return String(value);
});
}
/**
* Interpolate variables in an object recursively
*/
function interpolateObject(
obj: unknown,
variables: Record<string, unknown>
): unknown {
if (typeof obj === 'string') {
return interpolateString(obj, variables);
}
if (Array.isArray(obj)) {
return obj.map(item => interpolateObject(item, variables));
}
if (typeof obj === 'object' && obj !== null) {
const result: Record<string, unknown> = {};
for (const [key, value] of Object.entries(obj)) {
result[key] = interpolateObject(value, variables);
}
return result;
}
return obj;
}
/**
* Interpolate variables in a request
*/
function interpolateRequest(
request: ApiTestRequest,
variables: Record<string, unknown>
): ApiTestRequest {
return {
...request,
pathParams: interpolateObject(request.pathParams, variables) as Record<string, string>,
queryParams: interpolateObject(request.queryParams, variables) as Record<string, string>,
headers: interpolateObject(request.headers, variables) as Record<string, string>,
body: interpolateObject(request.body, variables)};
}
/**
* Evaluate an assertion
*/
function evaluateAssertion(
assertion: ChainAssertion,
response: ApiTestResponse
): AssertionResult {
const actualValue = extractValue(response.body, assertion.path);
let passed = false;
switch (assertion.operator) {
case 'equals':
passed = JSON.stringify(actualValue) === JSON.stringify(assertion.expected);
break;
case 'notEquals':
passed = JSON.stringify(actualValue) !== JSON.stringify(assertion.expected);
break;
case 'contains':
if (typeof actualValue === 'string' && typeof assertion.expected === 'string') {
passed = actualValue.includes(assertion.expected);
} else if (Array.isArray(actualValue)) {
passed = actualValue.some(
item => JSON.stringify(item) === JSON.stringify(assertion.expected)
);
}
break;
case 'notContains':
if (typeof actualValue === 'string' && typeof assertion.expected === 'string') {
passed = !actualValue.includes(assertion.expected);
} else if (Array.isArray(actualValue)) {
passed = !actualValue.some(
item => JSON.stringify(item) === JSON.stringify(assertion.expected)
);
}
break;
case 'exists':
passed = actualValue !== undefined && actualValue !== null;
break;
case 'notExists':
passed = actualValue === undefined || actualValue === null;
break;
case 'gt':
passed =
typeof actualValue === 'number' &&
typeof assertion.expected === 'number' &&
actualValue > assertion.expected;
break;
case 'lt':
passed =
typeof actualValue === 'number' &&
typeof assertion.expected === 'number' &&
actualValue < assertion.expected;
break;
case 'gte':
passed =
typeof actualValue === 'number' &&
typeof assertion.expected === 'number' &&
actualValue >= assertion.expected;
break;
case 'lte':
passed =
typeof actualValue === 'number' &&
typeof assertion.expected === 'number' &&
actualValue <= assertion.expected;
break;
}
const message = passed
? `Assertion passed: ${assertion.path} ${assertion.operator} ${JSON.stringify(assertion.expected)}`
: assertion.message ||
`Assertion failed: ${assertion.path} ${assertion.operator} ${JSON.stringify(assertion.expected)}, got ${JSON.stringify(actualValue)}`;
return {
assertion,
passed,
actualValue,
message};
}
/**
* Execute a chain of requests
*/
export async function executeChain(
steps: ChainStep[],
initialVariables: Record<string, unknown> = {},
onProgress?: (context: ChainContext) => void
): Promise<ChainContext> {
const context: ChainContext = {
variables: { ...initialVariables },
stepResults: [],
currentStep: 0,
isRunning: true,
success: true,
totalDuration: 0};
const startTime = performance.now();
try {
for (let i = 0; i < steps.length; i++) {
const step = steps[i];
context.currentStep = i;
if (onProgress) {
onProgress({ ...context });
}
// Check skip condition
if (step.skipIf) {
const skipValue = context.variables[step.skipIf];
if (skipValue) {
context.stepResults.push({
stepId: step.id,
stepName: step.name,
request: step.request,
response: null,
success: true,
skipped: true,
duration: 0});
continue;
}
}
// Apply delay if specified
if (step.delay && step.delay > 0) {
await new Promise(resolve => setTimeout(resolve, step.delay));
}
// Interpolate variables into request
const interpolatedRequest = interpolateRequest(step.request, context.variables);
// Execute request
const stepStartTime = performance.now();
let response: ApiTestResponse;
let success = true;
let error: string | undefined;
try {
response = await executeRequest(interpolatedRequest);
// Check if response indicates success (2xx status)
if (response.status < 200 || response.status >= 300) {
success = false;
error = `Request failed with status ${response.status}`;
}
} catch (err) {
response = {
status: 0,
statusText: 'Error',
headers: {},
body: { error: err instanceof Error ? err.message : 'Unknown error' },
duration: 0,
timestamp: new Date()};
success = false;
error = err instanceof Error ? err.message : 'Unknown error';
}
const stepDuration = performance.now() - stepStartTime;
// Extract variables
const extractedVariables: Record<string, unknown> = {};
if (step.extractions && success) {
for (const extraction of step.extractions) {
const value = extractValue(response.body, extraction.path);
if (value !== undefined) {
extractedVariables[extraction.name] = value;
context.variables[extraction.name] = value;
} else if (extraction.defaultValue !== undefined) {
extractedVariables[extraction.name] = extraction.defaultValue;
context.variables[extraction.name] = extraction.defaultValue;
}
}
}
// Evaluate assertions
const assertionResults: AssertionResult[] = [];
if (step.assertions && success) {
for (const assertion of step.assertions) {
const result = evaluateAssertion(assertion, response);
assertionResults.push(result);
if (!result.passed) {
success = false;
error = result.message;
}
}
}
// Record result
context.stepResults.push({
stepId: step.id,
stepName: step.name,
request: interpolatedRequest,
response,
success,
error,
extractedVariables:
Object.keys(extractedVariables).length > 0 ? extractedVariables : undefined,
assertionResults: assertionResults.length > 0 ? assertionResults : undefined,
duration: Math.round(stepDuration)});
// Stop chain if step failed
if (!success) {
context.success = false;
context.error = `Step "${step.name}" failed: ${error}`;
break;
}
}
} catch (err) {
context.success = false;
context.error = err instanceof Error ? err.message : 'Unknown error';
}
context.isRunning = false;
context.totalDuration = Math.round(performance.now() - startTime);
if (onProgress) {
onProgress({ ...context });
}
return context;
}
/**
* Create a simple chain from saved requests
*/
export function createChainFromRequests(
requests: Array<{ id: string; name: string; request: ApiTestRequest }>
): ChainStep[] {
return requests.map((item, index) => ({
id: item.id,
name: item.name || `Step ${index + 1}`,
request: item.request}));
}
/**
* Format chain results for display
*/
export function formatChainResults(context: ChainContext): string {
const lines: string[] = [];
lines.push('='.repeat(60));
lines.push(`Chain Execution ${context.success ? 'PASSED' : 'FAILED'}`);
lines.push('='.repeat(60));
lines.push(`Total Duration: ${context.totalDuration}ms`);
lines.push(`Steps: ${context.stepResults.length}`);
lines.push('');
for (const result of context.stepResults) {
const icon = result.skipped ? '⏭️' : result.success ? '✅' : '❌';
lines.push(`${icon} ${result.stepName} (${result.duration}ms)`);
if (result.skipped) {
lines.push(' Skipped');
continue;
}
if (result.response) {
lines.push(` Status: ${result.response.status} ${result.response.statusText}`);
}
if (result.extractedVariables) {
lines.push(' Extracted:');
for (const [key, value] of Object.entries(result.extractedVariables)) {
lines.push(` ${key} = ${JSON.stringify(value)}`);
}
}
if (result.assertionResults) {
lines.push(' Assertions:');
for (const assertion of result.assertionResults) {
const aIcon = assertion.passed ? '✓' : '✗';
lines.push(` ${aIcon} ${assertion.message}`);
}
}
if (result.error) {
lines.push(` Error: ${result.error}`);
}
}
if (context.error) {
lines.push('');
lines.push(`Error: ${context.error}`);
}
return lines.join('\n');
}
|