|
| 1 | +/* |
| 2 | +Toolbox Aid |
| 3 | +David Quesenberry |
| 4 | +04/15/2026 |
| 5 | +AuthoritativeInputIngestionContract.js |
| 6 | +*/ |
| 7 | +export const INPUT_INGESTION_REJECTION_CODES = Object.freeze({ |
| 8 | + ENVELOPE_REQUIRED: 'ENVELOPE_REQUIRED', |
| 9 | + SESSION_ID_REQUIRED: 'SESSION_ID_REQUIRED', |
| 10 | + SESSION_MISMATCH: 'SESSION_MISMATCH', |
| 11 | + CLIENT_ID_REQUIRED: 'CLIENT_ID_REQUIRED', |
| 12 | + SEQUENCE_INVALID: 'SEQUENCE_INVALID', |
| 13 | + INPUT_TYPE_REQUIRED: 'INPUT_TYPE_REQUIRED', |
| 14 | + PAYLOAD_OBJECT_REQUIRED: 'PAYLOAD_OBJECT_REQUIRED', |
| 15 | + SENT_AT_INVALID: 'SENT_AT_INVALID', |
| 16 | + SERVER_OWNERSHIP_VIOLATION: 'SERVER_OWNERSHIP_VIOLATION', |
| 17 | +}); |
| 18 | + |
| 19 | +export const SERVER_OWNED_STATE_FIELDS = Object.freeze([ |
| 20 | + 'authoritativeTick', |
| 21 | + 'runtimePhase', |
| 22 | + 'connectedClients', |
| 23 | + 'acceptedInputQueue', |
| 24 | +]); |
| 25 | + |
| 26 | +function clone(value) { |
| 27 | + return JSON.parse(JSON.stringify(value)); |
| 28 | +} |
| 29 | + |
| 30 | +function isPlainObject(value) { |
| 31 | + return value !== null |
| 32 | + && typeof value === 'object' |
| 33 | + && Object.getPrototypeOf(value) === Object.prototype; |
| 34 | +} |
| 35 | + |
| 36 | +function createReject(code, message) { |
| 37 | + return { |
| 38 | + ok: false, |
| 39 | + code, |
| 40 | + message, |
| 41 | + }; |
| 42 | +} |
| 43 | + |
| 44 | +export function validateClientInputEnvelope(envelope, { sessionId = null } = {}) { |
| 45 | + if (!isPlainObject(envelope)) { |
| 46 | + return createReject( |
| 47 | + INPUT_INGESTION_REJECTION_CODES.ENVELOPE_REQUIRED, |
| 48 | + 'Input envelope must be a plain object.', |
| 49 | + ); |
| 50 | + } |
| 51 | + |
| 52 | + if (typeof envelope.sessionId !== 'string' || envelope.sessionId.length === 0) { |
| 53 | + return createReject( |
| 54 | + INPUT_INGESTION_REJECTION_CODES.SESSION_ID_REQUIRED, |
| 55 | + 'sessionId must be a non-empty string.', |
| 56 | + ); |
| 57 | + } |
| 58 | + |
| 59 | + if (typeof sessionId === 'string' && sessionId.length > 0 && envelope.sessionId !== sessionId) { |
| 60 | + return createReject( |
| 61 | + INPUT_INGESTION_REJECTION_CODES.SESSION_MISMATCH, |
| 62 | + 'Input envelope sessionId does not match runtime session.', |
| 63 | + ); |
| 64 | + } |
| 65 | + |
| 66 | + if (typeof envelope.clientId !== 'string' || envelope.clientId.length === 0) { |
| 67 | + return createReject( |
| 68 | + INPUT_INGESTION_REJECTION_CODES.CLIENT_ID_REQUIRED, |
| 69 | + 'clientId must be a non-empty string.', |
| 70 | + ); |
| 71 | + } |
| 72 | + |
| 73 | + if (!Number.isInteger(envelope.sequence) || envelope.sequence < 0) { |
| 74 | + return createReject( |
| 75 | + INPUT_INGESTION_REJECTION_CODES.SEQUENCE_INVALID, |
| 76 | + 'sequence must be a non-negative integer.', |
| 77 | + ); |
| 78 | + } |
| 79 | + |
| 80 | + if (typeof envelope.inputType !== 'string' || envelope.inputType.length === 0) { |
| 81 | + return createReject( |
| 82 | + INPUT_INGESTION_REJECTION_CODES.INPUT_TYPE_REQUIRED, |
| 83 | + 'inputType must be a non-empty string.', |
| 84 | + ); |
| 85 | + } |
| 86 | + |
| 87 | + if (!isPlainObject(envelope.payload)) { |
| 88 | + return createReject( |
| 89 | + INPUT_INGESTION_REJECTION_CODES.PAYLOAD_OBJECT_REQUIRED, |
| 90 | + 'payload must be a plain object.', |
| 91 | + ); |
| 92 | + } |
| 93 | + |
| 94 | + if (!Number.isFinite(envelope.sentAtMs)) { |
| 95 | + return createReject( |
| 96 | + INPUT_INGESTION_REJECTION_CODES.SENT_AT_INVALID, |
| 97 | + 'sentAtMs must be a finite number.', |
| 98 | + ); |
| 99 | + } |
| 100 | + |
| 101 | + const violatingKey = SERVER_OWNED_STATE_FIELDS.find( |
| 102 | + (serverOwnedField) => Object.prototype.hasOwnProperty.call(envelope.payload, serverOwnedField), |
| 103 | + ); |
| 104 | + if (violatingKey) { |
| 105 | + return createReject( |
| 106 | + INPUT_INGESTION_REJECTION_CODES.SERVER_OWNERSHIP_VIOLATION, |
| 107 | + `payload cannot include server-owned field: ${violatingKey}`, |
| 108 | + ); |
| 109 | + } |
| 110 | + |
| 111 | + return { ok: true }; |
| 112 | +} |
| 113 | + |
| 114 | +export function normalizeClientInputEnvelope( |
| 115 | + envelope, |
| 116 | + { acceptedAtTick = 0, acceptedAtMs = 0 } = {}, |
| 117 | +) { |
| 118 | + return { |
| 119 | + sessionId: envelope.sessionId, |
| 120 | + clientId: envelope.clientId, |
| 121 | + sequence: envelope.sequence, |
| 122 | + inputType: envelope.inputType, |
| 123 | + payload: clone(envelope.payload), |
| 124 | + sentAtMs: Number(envelope.sentAtMs), |
| 125 | + acceptedAtTick, |
| 126 | + acceptedAtMs, |
| 127 | + }; |
| 128 | +} |
| 129 | + |
| 130 | +export default class AuthoritativeInputIngestionContract { |
| 131 | + constructor({ sessionId = 'session' } = {}) { |
| 132 | + this.sessionId = sessionId; |
| 133 | + this.stats = { |
| 134 | + accepted: 0, |
| 135 | + rejected: 0, |
| 136 | + }; |
| 137 | + } |
| 138 | + |
| 139 | + validate(envelope, { sessionId = this.sessionId } = {}) { |
| 140 | + const result = validateClientInputEnvelope(envelope, { sessionId }); |
| 141 | + if (result.ok) { |
| 142 | + this.stats.accepted += 1; |
| 143 | + } else { |
| 144 | + this.stats.rejected += 1; |
| 145 | + } |
| 146 | + return result; |
| 147 | + } |
| 148 | + |
| 149 | + normalize(envelope, metadata = {}) { |
| 150 | + return normalizeClientInputEnvelope(envelope, metadata); |
| 151 | + } |
| 152 | + |
| 153 | + getStats() { |
| 154 | + return { |
| 155 | + ...this.stats, |
| 156 | + sessionId: this.sessionId, |
| 157 | + }; |
| 158 | + } |
| 159 | +} |
| 160 | + |
0 commit comments