|
| 1 | +/** |
| 2 | + * ObjectQL |
| 3 | + * Copyright (c) 2026-present ObjectStack Inc. |
| 4 | + * |
| 5 | + * This source code is licensed under the MIT license found in the |
| 6 | + * LICENSE file in the root directory of this source tree. |
| 7 | + */ |
| 8 | + |
| 9 | +import type { EdgeCapabilities, EdgeRuntime } from '@objectql/types'; |
| 10 | +import { EDGE_CAPABILITIES } from '@objectql/types'; |
| 11 | + |
| 12 | +/** |
| 13 | + * Declares the minimum capabilities a runtime must provide. |
| 14 | + */ |
| 15 | +export interface CapabilityRequirement { |
| 16 | + readonly wasm?: boolean; |
| 17 | + readonly persistentStorage?: boolean; |
| 18 | + readonly webSocket?: boolean; |
| 19 | + readonly scheduledTriggers?: boolean; |
| 20 | + readonly minExecutionTime?: number; |
| 21 | +} |
| 22 | + |
| 23 | +/** |
| 24 | + * Result of validating a runtime against a set of requirements. |
| 25 | + */ |
| 26 | +export interface CapabilityValidationResult { |
| 27 | + readonly valid: boolean; |
| 28 | + readonly runtime: EdgeRuntime; |
| 29 | + readonly capabilities: EdgeCapabilities; |
| 30 | + readonly missing: readonly string[]; |
| 31 | +} |
| 32 | + |
| 33 | +/** |
| 34 | + * Returns the predefined capability profile for a given runtime. |
| 35 | + */ |
| 36 | +export function getCapabilities(runtime: EdgeRuntime): EdgeCapabilities { |
| 37 | + return EDGE_CAPABILITIES[runtime]; |
| 38 | +} |
| 39 | + |
| 40 | +/** |
| 41 | + * Validates that a runtime satisfies the given capability requirements. |
| 42 | + */ |
| 43 | +export function validateCapabilities( |
| 44 | + runtime: EdgeRuntime, |
| 45 | + requirements: CapabilityRequirement, |
| 46 | +): CapabilityValidationResult { |
| 47 | + const capabilities = getCapabilities(runtime); |
| 48 | + const missing: string[] = []; |
| 49 | + |
| 50 | + if (requirements.wasm && !capabilities.wasm) { |
| 51 | + missing.push('WebAssembly'); |
| 52 | + } |
| 53 | + if (requirements.persistentStorage && !capabilities.persistentStorage) { |
| 54 | + missing.push('Persistent Storage'); |
| 55 | + } |
| 56 | + if (requirements.webSocket && !capabilities.webSocket) { |
| 57 | + missing.push('WebSocket'); |
| 58 | + } |
| 59 | + if (requirements.scheduledTriggers && !capabilities.scheduledTriggers) { |
| 60 | + missing.push('Scheduled Triggers'); |
| 61 | + } |
| 62 | + if ( |
| 63 | + requirements.minExecutionTime && |
| 64 | + capabilities.maxExecutionTime !== undefined && |
| 65 | + capabilities.maxExecutionTime !== Infinity && |
| 66 | + capabilities.maxExecutionTime < requirements.minExecutionTime |
| 67 | + ) { |
| 68 | + missing.push( |
| 69 | + `Execution time (need ${requirements.minExecutionTime}ms, max ${capabilities.maxExecutionTime}ms)`, |
| 70 | + ); |
| 71 | + } |
| 72 | + |
| 73 | + return { |
| 74 | + valid: missing.length === 0, |
| 75 | + runtime, |
| 76 | + capabilities, |
| 77 | + missing, |
| 78 | + }; |
| 79 | +} |
0 commit comments