68bc7015fd
CI / Lint, typecheck, test, build (pull_request) Failing after 9s
- packages/krpc-client: TypeScript kRPC protocol client
- connection.ts: varint encoding/decoding, length-prefix framing,
per-socket read queue (avoids race when multiple read promises
in flight). Uses multiplication not '<<' for varint shift
because JS truncates << to 32 bits.
- schema.ts: hand-written protobufjs schema for kRPC meta-protocol
(ConnectionRequest, Request, Response, StreamUpdate, Status, etc.)
- enough to do connection handshake, single procedure calls, and
stream subscription. Service-specific types (SpaceCenter.Vessel,
Orbit, CelestialBody) need to be loaded from the kRPC mod's
.proto files at runtime.
- client.ts: KRPCClient with connect/invoke/addStream/removeStream/
onStreamUpdate/close. Tested with hand-rolled mock server.
- 10 tests (varint round-trips incl. uint64, wire format with raw
sockets).
- apps/tools/ksp-bridge: bridge that connects KSP to our API
- convert.ts: pure kRPC -> UniverseSnapshot conversion
(situation enum mapping, body id normalization, etc.)
- bridge.ts: main poll loop with retry + backoff
- krpc-adapter.ts: KRPCAdapter class that owns the KRPCClient
- index.ts: entrypoint with MOCK MODE for development (emits
synthetic state when no KSP is available, so you can verify the
HTTP pipeline end-to-end)
- 9 tests (7 conversion + 2 end-to-end bridge)
- ksp/README.md: full setup guide
- CKAN install, KSP server start, env vars
- Hand-rolled KSP calls list (what SpaceCenter methods we need)
- Roadmap for the remaining .proto-loading work
- Protocol deep-dive (for the next dev)
- Bug fixes along the way: protobufjs default import (not namespace),
varint 32-bit truncation, JavaScript bitwise 32-bit limit,
handshake status enum comparison (number vs string).
End-to-end verified: API + bridge in mock mode, 2 bodies + 1 vessel
arriving at /api/v1/state, 500ms polling cadence, automatic recovery
on HTTP failures.
213 lines
5.7 KiB
TypeScript
213 lines
5.7 KiB
TypeScript
import { describe, it, expect } from 'vitest';
|
|
import {
|
|
bodyToOurs,
|
|
vesselToOurs,
|
|
buildSnapshot,
|
|
krpcSituationToOurs,
|
|
type KRPCBody,
|
|
type KRPCState,
|
|
} from '../src/convert.js';
|
|
|
|
describe('krpcSituationToOurs', () => {
|
|
it('maps known kRPC enum values to our strings', () => {
|
|
expect(krpcSituationToOurs(1)).toBe('ORBITING');
|
|
expect(krpcSituationToOurs(2)).toBe('ESCAPING');
|
|
expect(krpcSituationToOurs(3)).toBe('LANDED');
|
|
expect(krpcSituationToOurs(4)).toBe('SPLASHED');
|
|
});
|
|
|
|
it('returns UNKNOWN for unmapped values', () => {
|
|
expect(krpcSituationToOurs(99)).toBe('UNKNOWN');
|
|
expect(krpcSituationToOurs(-1)).toBe('UNKNOWN');
|
|
});
|
|
});
|
|
|
|
describe('bodyToOurs', () => {
|
|
it('normalizes the body name to a lowercase id', () => {
|
|
const ksp: KRPCBody = {
|
|
name: 'Kerbin',
|
|
kind: 'planet',
|
|
parentId: 'Kerbol',
|
|
radius: 600_000,
|
|
sphereOfInfluence: 84_159_286,
|
|
gravitationalParameter: 3.5316e12,
|
|
rotationPeriod: 21_600,
|
|
axialTilt: 0,
|
|
orbit: {
|
|
semiMajorAxis: 13_599_840_256,
|
|
eccentricity: 0.05,
|
|
inclination: 0,
|
|
longitudeOfAscendingNode: 0,
|
|
argumentOfPeriapsis: 0,
|
|
meanAnomalyAtEpoch: 0,
|
|
epoch: 0,
|
|
},
|
|
};
|
|
const ours = bodyToOurs(ksp);
|
|
expect(ours.id).toBe('kerbin');
|
|
expect(ours.parentId).toBe('kerbol');
|
|
expect(ours.name).toBe('Kerbin');
|
|
expect(ours.kind).toBe('planet');
|
|
expect(ours.radius).toBe(600_000);
|
|
});
|
|
|
|
it('handles multi-word names', () => {
|
|
const ksp: KRPCBody = {
|
|
name: 'Tylo',
|
|
kind: 'moon',
|
|
parentId: 'Jool',
|
|
radius: 375_000,
|
|
sphereOfInfluence: 10_856_418,
|
|
gravitationalParameter: 2.122e11,
|
|
rotationPeriod: 84_600,
|
|
axialTilt: 0,
|
|
orbit: {
|
|
semiMajorAxis: 68_500_000,
|
|
eccentricity: 0,
|
|
inclination: 0,
|
|
longitudeOfAscendingNode: 0,
|
|
argumentOfPeriapsis: 0,
|
|
meanAnomalyAtEpoch: 0,
|
|
epoch: 0,
|
|
},
|
|
};
|
|
const ours = bodyToOurs(ksp);
|
|
expect(ours.id).toBe('tylo');
|
|
});
|
|
|
|
it('preserves null parentId for the star', () => {
|
|
const ksp: KRPCBody = {
|
|
name: 'Kerbol',
|
|
kind: 'star',
|
|
parentId: null,
|
|
radius: 261_600_000,
|
|
sphereOfInfluence: 1e30,
|
|
gravitationalParameter: 1.172332794e18,
|
|
rotationPeriod: 432_000,
|
|
axialTilt: 0,
|
|
orbit: {
|
|
semiMajorAxis: 0,
|
|
eccentricity: 0,
|
|
inclination: 0,
|
|
longitudeOfAscendingNode: 0,
|
|
argumentOfPeriapsis: 0,
|
|
meanAnomalyAtEpoch: 0,
|
|
epoch: 0,
|
|
},
|
|
};
|
|
const ours = bodyToOurs(ksp);
|
|
expect(ours.parentId).toBeNull();
|
|
});
|
|
});
|
|
|
|
describe('vesselToOurs', () => {
|
|
it('maps situation enum and assigns ACTIVE status', () => {
|
|
const ours = vesselToOurs({
|
|
id: 'v-1',
|
|
name: 'Probe',
|
|
type: 'Probe',
|
|
owner: 'KASA',
|
|
situation: 'ORBITING',
|
|
orbit: {
|
|
semiMajorAxis: 7e6,
|
|
eccentricity: 0,
|
|
inclination: 0,
|
|
longitudeOfAscendingNode: 0,
|
|
argumentOfPeriapsis: 0,
|
|
meanAnomalyAtEpoch: 0,
|
|
epoch: 0,
|
|
},
|
|
referenceBodyId: 'kerbin',
|
|
createdAt: '2026-01-01T00:00:00Z',
|
|
});
|
|
expect(ours.situation).toBe('ORBITING');
|
|
expect(ours.status).toBe('ACTIVE');
|
|
expect(ours.retiredAt).toBeNull();
|
|
expect(ours.owner).toBe('KASA');
|
|
});
|
|
});
|
|
|
|
describe('buildSnapshot', () => {
|
|
it('produces a valid UniverseSnapshot from a KRPCState', () => {
|
|
const state: KRPCState = {
|
|
ut: 100,
|
|
bodies: [
|
|
{
|
|
name: 'Kerbol',
|
|
kind: 'star',
|
|
parentId: null,
|
|
radius: 1,
|
|
sphereOfInfluence: 1e30,
|
|
gravitationalParameter: 1,
|
|
rotationPeriod: 1,
|
|
axialTilt: 0,
|
|
orbit: {
|
|
semiMajorAxis: 0,
|
|
eccentricity: 0,
|
|
inclination: 0,
|
|
longitudeOfAscendingNode: 0,
|
|
argumentOfPeriapsis: 0,
|
|
meanAnomalyAtEpoch: 0,
|
|
epoch: 0,
|
|
},
|
|
},
|
|
{
|
|
name: 'Kerbin',
|
|
kind: 'planet',
|
|
parentId: 'Kerbol',
|
|
radius: 600_000,
|
|
sphereOfInfluence: 84_159_286,
|
|
gravitationalParameter: 3.5316e12,
|
|
rotationPeriod: 21_600,
|
|
axialTilt: 0,
|
|
orbit: {
|
|
semiMajorAxis: 13_599_840_256,
|
|
eccentricity: 0,
|
|
inclination: 0,
|
|
longitudeOfAscendingNode: 0,
|
|
argumentOfPeriapsis: 0,
|
|
meanAnomalyAtEpoch: 0,
|
|
epoch: 0,
|
|
},
|
|
},
|
|
],
|
|
vessels: [
|
|
{
|
|
id: 'v1',
|
|
name: 'Probe',
|
|
type: 'Probe',
|
|
owner: 'KASA',
|
|
situation: 1, // ORBITING
|
|
orbit: {
|
|
semiMajorAxis: 7e6,
|
|
eccentricity: 0,
|
|
inclination: 0,
|
|
longitudeOfAscendingNode: 0,
|
|
argumentOfPeriapsis: 0,
|
|
meanAnomalyAtEpoch: 0,
|
|
epoch: 0,
|
|
},
|
|
referenceBodyId: 'Kerbin',
|
|
createdAt: '2026-01-01T00:00:00Z',
|
|
},
|
|
],
|
|
groundStations: [
|
|
{ id: 'montana', name: 'Montana', bodyId: 'Kerbin', lat: 47, lon: -110, alt: 0 },
|
|
],
|
|
};
|
|
|
|
const snap = buildSnapshot(state, '2026-01-01T00:00:00Z');
|
|
expect(snap.ut).toBe(100);
|
|
expect(snap.capturedAt).toBe('2026-01-01T00:00:00Z');
|
|
expect(snap.bodies).toHaveLength(2);
|
|
expect(snap.bodies[0]!.id).toBe('kerbol');
|
|
expect(snap.bodies[0]!.parentId).toBeNull();
|
|
expect(snap.bodies[1]!.id).toBe('kerbin');
|
|
expect(snap.bodies[1]!.parentId).toBe('kerbol');
|
|
expect(snap.vessels).toHaveLength(1);
|
|
expect(snap.vessels[0]!.situation).toBe('ORBITING');
|
|
expect(snap.vessels[0]!.referenceBodyId).toBe('kerbin');
|
|
expect(snap.groundStations).toHaveLength(1);
|
|
});
|
|
});
|