@ceralive/modem-control 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +31 -0
- package/src/backend/at-lease.test.ts +106 -0
- package/src/backend/at-lease.ts +158 -0
- package/src/backend/cell-info.test.ts +154 -0
- package/src/backend/cell-info.ts +160 -0
- package/src/backend/constants.ts +35 -0
- package/src/backend/device-classifier.test.ts +168 -0
- package/src/backend/device-classifier.ts +240 -0
- package/src/backend/enrichment.ts +96 -0
- package/src/backend/features.test.ts +158 -0
- package/src/backend/features.ts +179 -0
- package/src/backend/identity-ladder.test.ts +117 -0
- package/src/backend/identity-ladder.ts +221 -0
- package/src/backend/identity-registry.test.ts +89 -0
- package/src/backend/identity-registry.ts +151 -0
- package/src/backend/index.ts +221 -0
- package/src/backend/lifecycle-interlock.ts +38 -0
- package/src/backend/managed-objects.ts +108 -0
- package/src/backend/mapping.ts +160 -0
- package/src/backend/mm-backend.ts +191 -0
- package/src/backend/mm-mutations.ts +228 -0
- package/src/backend/modem-actor.test.ts +95 -0
- package/src/backend/modem-actor.ts +112 -0
- package/src/backend/nm-auto-apn.ts +161 -0
- package/src/backend/nm-gsm-fields.ts +122 -0
- package/src/backend/nmcli-nm-port.ts +228 -0
- package/src/backend/nmcli-runner.ts +52 -0
- package/src/backend/observer.ts +297 -0
- package/src/backend/power-contract.test.ts +40 -0
- package/src/backend/power-contract.ts +83 -0
- package/src/backend/recovery-attribution.test.ts +102 -0
- package/src/backend/recovery-attribution.ts +86 -0
- package/src/backend/recovery-budget.test.ts +64 -0
- package/src/backend/recovery-budget.ts +84 -0
- package/src/backend/recovery-ladder.test.ts +257 -0
- package/src/backend/recovery-ladder.ts +249 -0
- package/src/backend/router-ethernet.test.ts +71 -0
- package/src/backend/router-ethernet.ts +90 -0
- package/src/backend/row-store.ts +105 -0
- package/src/backend/signal-setup.ts +112 -0
- package/src/backend/sim-unlock.ts +193 -0
- package/src/backend/transition-preconditions.ts +149 -0
- package/src/backend/usage/accounting.test.ts +147 -0
- package/src/backend/usage/accounting.ts +123 -0
- package/src/backend/usage/billing-cycle.test.ts +62 -0
- package/src/backend/usage/billing-cycle.ts +45 -0
- package/src/backend/usage/boot-id.ts +18 -0
- package/src/backend/usage/index.ts +37 -0
- package/src/backend/usage/proc-net-dev.test.ts +56 -0
- package/src/backend/usage/proc-net-dev.ts +77 -0
- package/src/backend/usage/sampler.test.ts +219 -0
- package/src/backend/usage/sampler.ts +228 -0
- package/src/backend/usage/store.test.ts +148 -0
- package/src/backend/usage/store.ts +177 -0
- package/src/backend/usb-enumerator.test.ts +87 -0
- package/src/backend/usb-enumerator.ts +181 -0
- package/src/backend/usb-mode-transition.test.ts +323 -0
- package/src/backend/usb-mode-transition.ts +253 -0
- package/src/domain/brand.ts +29 -0
- package/src/domain/errors.ts +77 -0
- package/src/domain/guards.test.ts +218 -0
- package/src/domain/guards.ts +144 -0
- package/src/domain/identity.test.ts +83 -0
- package/src/domain/identity.ts +165 -0
- package/src/domain/index.ts +12 -0
- package/src/domain/policy.ts +137 -0
- package/src/domain/snapshot.test.ts +266 -0
- package/src/domain/snapshot.ts +120 -0
- package/src/domain/state.ts +189 -0
- package/src/index.test.ts +6 -0
- package/src/index.ts +15 -0
- package/src/ports/README.md +61 -0
- package/src/ports/forbidden-surface.test.ts +80 -0
- package/src/ports/index.ts +16 -0
- package/src/ports/modem-manager.ts +72 -0
- package/src/ports/network-manager.ts +87 -0
- package/src/ports/observation.ts +48 -0
- package/src/ports/ops.ts +60 -0
- package/src/ports/ops.type-test.ts +39 -0
- package/src/ports/receipts.test.ts +153 -0
- package/src/ports/receipts.ts +43 -0
- package/src/ports/reconcile.test.ts +152 -0
- package/src/ports/reconcile.ts +338 -0
- package/src/ports/router.ts +29 -0
- package/src/redact.test.ts +82 -0
- package/src/redact.ts +73 -0
- package/src/transport/README.md +65 -0
- package/src/transport/codec.test.ts +118 -0
- package/src/transport/codec.ts +240 -0
- package/src/transport/conformance-python.test.ts +152 -0
- package/src/transport/conformance-same-lib.test.ts +115 -0
- package/src/transport/dbus-native-lib.d.ts +19 -0
- package/src/transport/dbus-native.ts +85 -0
- package/src/transport/errors.ts +74 -0
- package/src/transport/index.ts +30 -0
- package/src/transport/no-library-leak.test.ts +50 -0
- package/src/transport/reliability.test.ts +173 -0
- package/src/transport/signature.ts +110 -0
- package/src/transport/test-support/fake-service.ts +143 -0
- package/src/transport/test-support/independent-producer.py +110 -0
- package/src/transport/test-support/private-bus.ts +66 -0
- package/src/transport/transport.ts +439 -0
- package/src/transport/types.ts +118 -0
- package/src/usb-mode/catalog-schema.test.ts +181 -0
- package/src/usb-mode/catalog-schema.ts +113 -0
- package/src/usb-mode/catalog.ts +60 -0
- package/src/usb-mode/certified-catalog.json +67 -0
- package/src/usb-mode/index.ts +27 -0
|
@@ -0,0 +1,118 @@
|
|
|
1
|
+
// Pure, in-process encode/decode round-trip: no bus, fully deterministic. Marshals with
|
|
2
|
+
// the library's own marshaller and reads it back with its DBusBuffer under
|
|
3
|
+
// `ReturnLongjs: true` — exactly the wire path a real call takes — so a green run here is
|
|
4
|
+
// exact proof the codec is lossless, independent of any daemon timing.
|
|
5
|
+
|
|
6
|
+
import { expect, test } from 'bun:test';
|
|
7
|
+
import DBusBuffer from '@httptoolkit/dbus-native/lib/dbus-buffer';
|
|
8
|
+
import marshall from '@httptoolkit/dbus-native/lib/marshall';
|
|
9
|
+
import { decodeBody, encodeBody } from './codec';
|
|
10
|
+
import { BigIntRequiredError, SixtyFourBitRangeError, UnsupportedSignatureError } from './errors';
|
|
11
|
+
import { type DbusValue, variant } from './types';
|
|
12
|
+
|
|
13
|
+
const INT64_MAX = 2n ** 63n - 1n;
|
|
14
|
+
const INT64_MIN = -(2n ** 63n);
|
|
15
|
+
const UINT64_MAX = 2n ** 64n - 1n;
|
|
16
|
+
|
|
17
|
+
function roundTrip(signature: string, values: readonly DbusValue[]): DbusValue[] {
|
|
18
|
+
const encoded = encodeBody(signature, values);
|
|
19
|
+
const buffer = marshall(signature, encoded);
|
|
20
|
+
const reader = new DBusBuffer(buffer, 0, { ayBuffer: true, ReturnLongjs: true });
|
|
21
|
+
const raw = reader.read(signature) as unknown[];
|
|
22
|
+
return decodeBody(signature, raw);
|
|
23
|
+
}
|
|
24
|
+
|
|
25
|
+
test('2^63-1 round-trips through an INT64 exactly (bigint equality)', () => {
|
|
26
|
+
const [value] = roundTrip('x', [INT64_MAX]);
|
|
27
|
+
expect(value).toBe(INT64_MAX);
|
|
28
|
+
expect(typeof value).toBe('bigint');
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
test('the full UINT64 range (2^64-1) round-trips exactly', () => {
|
|
32
|
+
const [value] = roundTrip('t', [UINT64_MAX]);
|
|
33
|
+
expect(value).toBe(UINT64_MAX);
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
test('INT64 minimum round-trips exactly', () => {
|
|
37
|
+
const [value] = roundTrip('x', [INT64_MIN]);
|
|
38
|
+
expect(value).toBe(INT64_MIN);
|
|
39
|
+
});
|
|
40
|
+
|
|
41
|
+
test('a value just above 2^53 survives (no silent Number coercion)', () => {
|
|
42
|
+
const beyondSafe = 2n ** 53n + 1n;
|
|
43
|
+
const [asInt, asUint] = roundTrip('xt', [beyondSafe, beyondSafe]);
|
|
44
|
+
expect(asInt).toBe(beyondSafe);
|
|
45
|
+
expect(asUint).toBe(beyondSafe);
|
|
46
|
+
// The precision-losing path would have produced 9007199254740992n (== 2^53).
|
|
47
|
+
expect(asInt).not.toBe(2n ** 53n);
|
|
48
|
+
});
|
|
49
|
+
|
|
50
|
+
test('the MM GetManagedObjects shape a{oa{sa{sv}}} round-trips with a 64-bit variant', () => {
|
|
51
|
+
const managed: DbusValue = [
|
|
52
|
+
[
|
|
53
|
+
'/org/freedesktop/ModemManager1/Modem/0',
|
|
54
|
+
[
|
|
55
|
+
[
|
|
56
|
+
'org.freedesktop.ModemManager1.Modem',
|
|
57
|
+
[
|
|
58
|
+
['SupportedCapabilities', variant('t', UINT64_MAX)],
|
|
59
|
+
['SignalQuality', variant('u', 87)],
|
|
60
|
+
['DeviceIdentifier', variant('s', 'dev-0')],
|
|
61
|
+
],
|
|
62
|
+
],
|
|
63
|
+
],
|
|
64
|
+
],
|
|
65
|
+
];
|
|
66
|
+
const [decoded] = roundTrip('a{oa{sa{sv}}}', [managed]);
|
|
67
|
+
expect(decoded).toEqual(managed);
|
|
68
|
+
});
|
|
69
|
+
|
|
70
|
+
test('a variant preserves its inner signature and 64-bit value across a round-trip', () => {
|
|
71
|
+
const [decoded] = roundTrip('v', [variant('t', UINT64_MAX)]);
|
|
72
|
+
expect(decoded).toEqual({ signature: 't', value: UINT64_MAX });
|
|
73
|
+
});
|
|
74
|
+
|
|
75
|
+
test('a byte array (ay) round-trips as a Uint8Array', () => {
|
|
76
|
+
const bytes = new Uint8Array([0, 1, 2, 254, 255]);
|
|
77
|
+
const [decoded] = roundTrip('ay', [bytes]);
|
|
78
|
+
expect(decoded).toBeInstanceOf(Uint8Array);
|
|
79
|
+
expect(Array.from(decoded as Uint8Array)).toEqual([0, 1, 2, 254, 255]);
|
|
80
|
+
});
|
|
81
|
+
|
|
82
|
+
test('a struct with mixed 64-bit fields round-trips', () => {
|
|
83
|
+
const [decoded] = roundTrip('(xtu)', [[INT64_MIN, UINT64_MAX, 7]]);
|
|
84
|
+
expect(decoded).toEqual([INT64_MIN, UINT64_MAX, 7]);
|
|
85
|
+
});
|
|
86
|
+
|
|
87
|
+
test('signature h (UNIX_FD) is rejected on encode with a typed error', () => {
|
|
88
|
+
expect(() => encodeBody('h', [0])).toThrow(UnsupportedSignatureError);
|
|
89
|
+
});
|
|
90
|
+
|
|
91
|
+
test('signature h nested inside a container is rejected on encode', () => {
|
|
92
|
+
expect(() => encodeBody('a{sh}', [[]])).toThrow(UnsupportedSignatureError);
|
|
93
|
+
});
|
|
94
|
+
|
|
95
|
+
test('signature h is rejected on decode with a typed error', () => {
|
|
96
|
+
expect(() => decodeBody('h', [0])).toThrow(UnsupportedSignatureError);
|
|
97
|
+
});
|
|
98
|
+
|
|
99
|
+
test('the UnsupportedSignatureError carries the offending type', () => {
|
|
100
|
+
try {
|
|
101
|
+
encodeBody('h', [0]);
|
|
102
|
+
throw new Error('expected throw');
|
|
103
|
+
} catch (error) {
|
|
104
|
+
expect(error).toBeInstanceOf(UnsupportedSignatureError);
|
|
105
|
+
expect((error as UnsupportedSignatureError).unsupportedType).toBe('h');
|
|
106
|
+
}
|
|
107
|
+
});
|
|
108
|
+
|
|
109
|
+
test('passing a JS number for a 64-bit field throws BigIntRequiredError', () => {
|
|
110
|
+
expect(() => encodeBody('t', [123])).toThrow(BigIntRequiredError);
|
|
111
|
+
expect(() => encodeBody('x', [123])).toThrow(BigIntRequiredError);
|
|
112
|
+
});
|
|
113
|
+
|
|
114
|
+
test('an out-of-range 64-bit bigint throws SixtyFourBitRangeError', () => {
|
|
115
|
+
expect(() => encodeBody('t', [-1n])).toThrow(SixtyFourBitRangeError);
|
|
116
|
+
expect(() => encodeBody('x', [2n ** 63n])).toThrow(SixtyFourBitRangeError);
|
|
117
|
+
expect(() => encodeBody('t', [2n ** 64n])).toThrow(SixtyFourBitRangeError);
|
|
118
|
+
});
|
|
@@ -0,0 +1,240 @@
|
|
|
1
|
+
// Signature-aware encode / decode between the transport's public value vocabulary
|
|
2
|
+
// (`DbusValue`, `bigint` for 64-bit, `DbusVariant`) and the shape the underlying
|
|
3
|
+
// `@httptoolkit/dbus-native` marshaller consumes and produces.
|
|
4
|
+
//
|
|
5
|
+
// Two invariants this layer enforces that the library does not:
|
|
6
|
+
// * 64-bit `x`/`t` are `bigint` end-to-end. On decode the library returns Long.js
|
|
7
|
+
// objects (only under `ReturnLongjs: true`); we convert them to `bigint` losslessly
|
|
8
|
+
// via their exact decimal `toString()`. On encode the library accepts a decimal
|
|
9
|
+
// string for the full 64-bit range but silently truncates a `number` above 2^53 —
|
|
10
|
+
// so we require a `bigint` and convert it to a decimal string ourselves.
|
|
11
|
+
// * `h` (UNIX_FD) is rejected up front with a typed error rather than reaching the
|
|
12
|
+
// library, which would throw a generic "Unknown/Unsupported type" instead.
|
|
13
|
+
|
|
14
|
+
import { BigIntRequiredError, SixtyFourBitRangeError, UnsupportedSignatureError } from './errors';
|
|
15
|
+
import { parseSignature, type SignatureNode, signatureFromNode } from './signature';
|
|
16
|
+
import type { DbusValue, DbusVariant } from './types';
|
|
17
|
+
|
|
18
|
+
const INT64_MIN = -(2n ** 63n);
|
|
19
|
+
const INT64_MAX = 2n ** 63n - 1n;
|
|
20
|
+
const UINT64_MAX = 2n ** 64n - 1n;
|
|
21
|
+
|
|
22
|
+
// A Long.js instance as the library hands it back with `ReturnLongjs: true`. We never
|
|
23
|
+
// import `long` (it is a transitive dependency, not ours) — we duck-type and use the
|
|
24
|
+
// exact decimal `toString()`, so no library type crosses this boundary.
|
|
25
|
+
interface LongLike {
|
|
26
|
+
readonly low: number;
|
|
27
|
+
readonly high: number;
|
|
28
|
+
readonly unsigned: boolean;
|
|
29
|
+
toString(): string;
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
function isLongLike(value: unknown): value is LongLike {
|
|
33
|
+
return (
|
|
34
|
+
typeof value === 'object' &&
|
|
35
|
+
value !== null &&
|
|
36
|
+
typeof (value as LongLike).low === 'number' &&
|
|
37
|
+
typeof (value as LongLike).high === 'number' &&
|
|
38
|
+
typeof (value as LongLike).unsigned === 'boolean'
|
|
39
|
+
);
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
function longToBigInt(value: LongLike): bigint {
|
|
43
|
+
return BigInt(value.toString());
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
// ── Encode ─────────────────────────────────────────────────────────────────────────
|
|
47
|
+
// Public values → library-native body. `assertSupportedSignature` is applied to the
|
|
48
|
+
// whole signature first, so no `h` reaches the recursion.
|
|
49
|
+
export function encodeBody(signature: string, args: readonly DbusValue[]): unknown[] {
|
|
50
|
+
if (signature.includes('h')) {
|
|
51
|
+
throw new UnsupportedSignatureError(signature, 'h');
|
|
52
|
+
}
|
|
53
|
+
const nodes = parseSignature(signature);
|
|
54
|
+
if (nodes.length !== args.length) {
|
|
55
|
+
throw new Error(
|
|
56
|
+
`Body arity ${args.length} does not match signature "${signature}" (${nodes.length} types)`,
|
|
57
|
+
);
|
|
58
|
+
}
|
|
59
|
+
return nodes.map((node, i) => encodeNode(node, args[i] as DbusValue));
|
|
60
|
+
}
|
|
61
|
+
|
|
62
|
+
function encodeNode(node: SignatureNode, value: DbusValue): unknown {
|
|
63
|
+
switch (node.type) {
|
|
64
|
+
case 'x':
|
|
65
|
+
return encode64(node.type, value, INT64_MIN, INT64_MAX);
|
|
66
|
+
case 't':
|
|
67
|
+
return encode64(node.type, value, 0n, UINT64_MAX);
|
|
68
|
+
case 'a':
|
|
69
|
+
return encodeArray(node, value);
|
|
70
|
+
case '(':
|
|
71
|
+
return encodeStruct(node, value);
|
|
72
|
+
case '{':
|
|
73
|
+
return encodeDictEntry(node, value);
|
|
74
|
+
case 'v':
|
|
75
|
+
return encodeVariant(value);
|
|
76
|
+
default:
|
|
77
|
+
// y b n q i u d s o g — the library validates range/type on marshal.
|
|
78
|
+
return value;
|
|
79
|
+
}
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
function encode64(type: string, value: DbusValue, min: bigint, max: bigint): string {
|
|
83
|
+
if (typeof value !== 'bigint') {
|
|
84
|
+
throw new BigIntRequiredError(type, value);
|
|
85
|
+
}
|
|
86
|
+
if (value < min || value > max) {
|
|
87
|
+
throw new SixtyFourBitRangeError(type, value);
|
|
88
|
+
}
|
|
89
|
+
// Decimal string: the library parses this across the full 64-bit range losslessly.
|
|
90
|
+
return value.toString();
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
function encodeArray(node: SignatureNode, value: DbusValue): unknown {
|
|
94
|
+
const element = node.child[0] as SignatureNode;
|
|
95
|
+
// `ay` byte arrays pass straight through as a Uint8Array / Buffer (index-addressable).
|
|
96
|
+
if (element.type === 'y' && value instanceof Uint8Array) {
|
|
97
|
+
return value;
|
|
98
|
+
}
|
|
99
|
+
if (!Array.isArray(value)) {
|
|
100
|
+
throw new Error(`Expected array for signature "a${element.type}"`);
|
|
101
|
+
}
|
|
102
|
+
return value.map((item) => encodeNode(element, item));
|
|
103
|
+
}
|
|
104
|
+
|
|
105
|
+
function encodeStruct(node: SignatureNode, value: DbusValue): unknown[] {
|
|
106
|
+
if (!Array.isArray(value)) {
|
|
107
|
+
throw new Error('Expected array for struct value');
|
|
108
|
+
}
|
|
109
|
+
if (value.length !== node.child.length) {
|
|
110
|
+
throw new Error(`Struct arity ${value.length} does not match ${node.child.length} field types`);
|
|
111
|
+
}
|
|
112
|
+
return node.child.map((child, i) => encodeNode(child, value[i] as DbusValue));
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
function encodeDictEntry(node: SignatureNode, value: DbusValue): unknown[] {
|
|
116
|
+
if (!Array.isArray(value) || value.length !== 2) {
|
|
117
|
+
throw new Error('Expected [key, value] pair for dict entry');
|
|
118
|
+
}
|
|
119
|
+
const keyNode = node.child[0] as SignatureNode;
|
|
120
|
+
const valueNode = node.child[1] as SignatureNode;
|
|
121
|
+
return [encodeNode(keyNode, value[0] as DbusValue), encodeNode(valueNode, value[1] as DbusValue)];
|
|
122
|
+
}
|
|
123
|
+
|
|
124
|
+
function encodeVariant(value: DbusValue): [string, unknown] {
|
|
125
|
+
const asVariant = value as DbusVariant;
|
|
126
|
+
if (typeof asVariant?.signature !== 'string' || !('value' in (asVariant as object))) {
|
|
127
|
+
throw new Error('Expected a DbusVariant ({ signature, value }) for variant field');
|
|
128
|
+
}
|
|
129
|
+
if (asVariant.signature.includes('h')) {
|
|
130
|
+
throw new UnsupportedSignatureError(asVariant.signature, 'h');
|
|
131
|
+
}
|
|
132
|
+
const inner = parseSignature(asVariant.signature);
|
|
133
|
+
if (inner.length !== 1) {
|
|
134
|
+
throw new Error(`Variant signature "${asVariant.signature}" must be exactly one complete type`);
|
|
135
|
+
}
|
|
136
|
+
return [asVariant.signature, encodeNode(inner[0] as SignatureNode, asVariant.value)];
|
|
137
|
+
}
|
|
138
|
+
|
|
139
|
+
// ── Decode ─────────────────────────────────────────────────────────────────────────
|
|
140
|
+
// Library-native body → public values. The library must have been created with
|
|
141
|
+
// `ReturnLongjs: true` so `x`/`t` arrive as Long objects (this transport does exactly
|
|
142
|
+
// that); a raw `number` in a 64-bit slot means that flag was lost and is treated as a
|
|
143
|
+
// bug, not silently accepted.
|
|
144
|
+
export function decodeBody(signature: string, body: readonly unknown[]): DbusValue[] {
|
|
145
|
+
if (signature.includes('h')) {
|
|
146
|
+
throw new UnsupportedSignatureError(signature, 'h');
|
|
147
|
+
}
|
|
148
|
+
const nodes = parseSignature(signature);
|
|
149
|
+
return nodes.map((node, i) => decodeNode(node, body[i]));
|
|
150
|
+
}
|
|
151
|
+
|
|
152
|
+
function decodeNode(node: SignatureNode, value: unknown): DbusValue {
|
|
153
|
+
switch (node.type) {
|
|
154
|
+
case 'x':
|
|
155
|
+
case 't':
|
|
156
|
+
return decode64(node.type, value);
|
|
157
|
+
case 'a':
|
|
158
|
+
return decodeArray(node, value);
|
|
159
|
+
case '(':
|
|
160
|
+
return decodeStruct(node, value);
|
|
161
|
+
case '{':
|
|
162
|
+
return decodeDictEntry(node, value);
|
|
163
|
+
case 'v':
|
|
164
|
+
return decodeVariant(value);
|
|
165
|
+
case 'y':
|
|
166
|
+
case 'b':
|
|
167
|
+
case 'n':
|
|
168
|
+
case 'q':
|
|
169
|
+
case 'i':
|
|
170
|
+
case 'u':
|
|
171
|
+
case 'd':
|
|
172
|
+
case 's':
|
|
173
|
+
case 'o':
|
|
174
|
+
case 'g':
|
|
175
|
+
return value as DbusValue;
|
|
176
|
+
default:
|
|
177
|
+
throw new UnsupportedSignatureError(node.type, node.type);
|
|
178
|
+
}
|
|
179
|
+
}
|
|
180
|
+
|
|
181
|
+
function decode64(type: string, value: unknown): bigint {
|
|
182
|
+
if (isLongLike(value)) {
|
|
183
|
+
return longToBigInt(value);
|
|
184
|
+
}
|
|
185
|
+
if (typeof value === 'bigint') {
|
|
186
|
+
return value;
|
|
187
|
+
}
|
|
188
|
+
// A plain number reaching here means ReturnLongjs was not applied — refuse it rather
|
|
189
|
+
// than risk having already lost precision above 2^53.
|
|
190
|
+
throw new BigIntRequiredError(type, value);
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
function decodeArray(node: SignatureNode, value: unknown): DbusValue {
|
|
194
|
+
const element = node.child[0] as SignatureNode;
|
|
195
|
+
if (element.type === 'y') {
|
|
196
|
+
// `ay`: the library returns a Buffer; normalise to a plain Uint8Array.
|
|
197
|
+
if (value instanceof Uint8Array) {
|
|
198
|
+
return new Uint8Array(value);
|
|
199
|
+
}
|
|
200
|
+
}
|
|
201
|
+
if (!Array.isArray(value)) {
|
|
202
|
+
throw new Error(`Expected array while decoding "a${element.type}"`);
|
|
203
|
+
}
|
|
204
|
+
return value.map((item) => decodeNode(element, item));
|
|
205
|
+
}
|
|
206
|
+
|
|
207
|
+
function decodeStruct(node: SignatureNode, value: unknown): DbusValue {
|
|
208
|
+
if (!Array.isArray(value)) {
|
|
209
|
+
throw new Error('Expected array while decoding struct');
|
|
210
|
+
}
|
|
211
|
+
return node.child.map((child, i) => decodeNode(child, value[i]));
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
function decodeDictEntry(node: SignatureNode, value: unknown): DbusValue {
|
|
215
|
+
if (!Array.isArray(value) || value.length !== 2) {
|
|
216
|
+
throw new Error('Expected [key, value] pair while decoding dict entry');
|
|
217
|
+
}
|
|
218
|
+
const keyNode = node.child[0] as SignatureNode;
|
|
219
|
+
const valueNode = node.child[1] as SignatureNode;
|
|
220
|
+
return [decodeNode(keyNode, value[0]), decodeNode(valueNode, value[1])];
|
|
221
|
+
}
|
|
222
|
+
|
|
223
|
+
// The library decodes a variant to `[parseTree, [innerValue]]`. We recover the inner
|
|
224
|
+
// signature from the tree and decode the contained value recursively, preserving both.
|
|
225
|
+
function decodeVariant(value: unknown): DbusVariant {
|
|
226
|
+
if (!Array.isArray(value) || value.length !== 2) {
|
|
227
|
+
throw new Error('Malformed variant from library (expected [tree, [value]])');
|
|
228
|
+
}
|
|
229
|
+
const tree = value[0] as SignatureNode[];
|
|
230
|
+
const inner = value[1] as unknown[];
|
|
231
|
+
if (!Array.isArray(tree) || tree.length !== 1 || !Array.isArray(inner)) {
|
|
232
|
+
throw new Error('Malformed variant tree from library');
|
|
233
|
+
}
|
|
234
|
+
const innerNode = tree[0] as SignatureNode;
|
|
235
|
+
const innerSignature = signatureFromNode(innerNode);
|
|
236
|
+
return {
|
|
237
|
+
signature: innerSignature,
|
|
238
|
+
value: decodeNode(innerNode, inner[0]),
|
|
239
|
+
};
|
|
240
|
+
}
|
|
@@ -0,0 +1,152 @@
|
|
|
1
|
+
// Conformance half (b): round-trip against an INDEPENDENT `python3-dbus` producer running
|
|
2
|
+
// as a subprocess — a different implementation on the wire than the JavaScript library
|
|
3
|
+
// under test. Agreement with a foreign producer, not just the same-library fake, is the
|
|
4
|
+
// real proof the codec is correct. Exercises the MM `a{oa{sa{sv}}}` shape, `x`/`t` above
|
|
5
|
+
// 2^53, variants, and a `PropertiesChanged` signal carrying invalidated properties.
|
|
6
|
+
//
|
|
7
|
+
// Skips loudly (never fails) when the session bus or `dbus-python` bindings are absent.
|
|
8
|
+
|
|
9
|
+
import { afterAll, beforeAll, describe, expect, test } from 'bun:test';
|
|
10
|
+
import { join } from 'node:path';
|
|
11
|
+
import type { DbusTransport, SignalEvent } from './index';
|
|
12
|
+
import { createDbusTransport } from './index';
|
|
13
|
+
|
|
14
|
+
const SESSION_BUS = process.env.DBUS_SESSION_BUS_ADDRESS;
|
|
15
|
+
|
|
16
|
+
const PY_BUS_NAME = 'tv.ceralive.ModemStackPy';
|
|
17
|
+
const PY_PATH = '/tv/ceralive/pyfake';
|
|
18
|
+
const PY_IFACE = 'tv.ceralive.ModemStackPy.Conformance';
|
|
19
|
+
const PROPERTIES_IFACE = 'org.freedesktop.DBus.Properties';
|
|
20
|
+
|
|
21
|
+
const INT64_MAX = 2n ** 63n - 1n;
|
|
22
|
+
const UINT64_MAX = 2n ** 64n - 1n;
|
|
23
|
+
|
|
24
|
+
function hasDbusPython(): boolean {
|
|
25
|
+
const probe = Bun.spawnSync(['python3', '-c', 'import dbus, dbus.service, gi.repository.GLib']);
|
|
26
|
+
return probe.exitCode === 0;
|
|
27
|
+
}
|
|
28
|
+
|
|
29
|
+
async function waitForReady(proc: ReturnType<typeof Bun.spawn>, timeoutMs: number): Promise<void> {
|
|
30
|
+
const reader = (proc.stdout as ReadableStream<Uint8Array>).getReader();
|
|
31
|
+
const decoder = new TextDecoder();
|
|
32
|
+
let seen = '';
|
|
33
|
+
const deadline = Date.now() + timeoutMs;
|
|
34
|
+
try {
|
|
35
|
+
while (Date.now() < deadline) {
|
|
36
|
+
const { value, done } = await reader.read();
|
|
37
|
+
if (done) {
|
|
38
|
+
throw new Error('python producer exited before signalling READY');
|
|
39
|
+
}
|
|
40
|
+
seen += decoder.decode(value, { stream: true });
|
|
41
|
+
if (seen.includes('READY')) {
|
|
42
|
+
return;
|
|
43
|
+
}
|
|
44
|
+
}
|
|
45
|
+
throw new Error('timed out waiting for python producer READY');
|
|
46
|
+
} finally {
|
|
47
|
+
reader.releaseLock();
|
|
48
|
+
}
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
const runnable = Boolean(SESSION_BUS) && hasDbusPython();
|
|
52
|
+
|
|
53
|
+
describe.skipIf(!runnable)('conformance vs independent python3-dbus producer', () => {
|
|
54
|
+
let producer: ReturnType<typeof Bun.spawn>;
|
|
55
|
+
let transport: DbusTransport;
|
|
56
|
+
|
|
57
|
+
beforeAll(async () => {
|
|
58
|
+
const script = join(import.meta.dir, 'test-support', 'independent-producer.py');
|
|
59
|
+
producer = Bun.spawn(['python3', script], {
|
|
60
|
+
stdout: 'pipe',
|
|
61
|
+
stderr: 'inherit',
|
|
62
|
+
env: process.env,
|
|
63
|
+
});
|
|
64
|
+
await waitForReady(producer, 10_000);
|
|
65
|
+
transport = createDbusTransport({ busAddress: SESSION_BUS as string });
|
|
66
|
+
await transport.connect();
|
|
67
|
+
});
|
|
68
|
+
|
|
69
|
+
afterAll(async () => {
|
|
70
|
+
await transport.disconnect();
|
|
71
|
+
producer.kill();
|
|
72
|
+
});
|
|
73
|
+
|
|
74
|
+
const call = (member: string, signature?: string, args?: unknown[]) =>
|
|
75
|
+
transport.callMethod({
|
|
76
|
+
destination: PY_BUS_NAME,
|
|
77
|
+
path: PY_PATH,
|
|
78
|
+
interface: PY_IFACE,
|
|
79
|
+
member,
|
|
80
|
+
...(signature !== undefined ? { signature } : {}),
|
|
81
|
+
...(args !== undefined ? { args: args as never } : {}),
|
|
82
|
+
});
|
|
83
|
+
|
|
84
|
+
test('the independent producer returns the a{oa{sa{sv}}} shape with 64-bit variants', async () => {
|
|
85
|
+
const reply = await call('GetManagedObjects');
|
|
86
|
+
expect(reply.signature).toBe('a{oa{sa{sv}}}');
|
|
87
|
+
expect(reply.body[0]).toEqual([
|
|
88
|
+
[
|
|
89
|
+
'/org/freedesktop/ModemManager1/Modem/0',
|
|
90
|
+
[
|
|
91
|
+
[
|
|
92
|
+
'org.freedesktop.ModemManager1.Modem',
|
|
93
|
+
[
|
|
94
|
+
['SupportedCapabilities', { signature: 't', value: UINT64_MAX }],
|
|
95
|
+
['MaxBearers', { signature: 'x', value: -INT64_MAX }],
|
|
96
|
+
['SignalQuality', { signature: 'u', value: 87 }],
|
|
97
|
+
['DeviceIdentifier', { signature: 's', value: 'py-device-0' }],
|
|
98
|
+
],
|
|
99
|
+
],
|
|
100
|
+
],
|
|
101
|
+
],
|
|
102
|
+
]);
|
|
103
|
+
});
|
|
104
|
+
|
|
105
|
+
test('an INT64 above 2^53 from the independent producer decodes to an exact bigint', async () => {
|
|
106
|
+
const reply = await call('GetInt64');
|
|
107
|
+
expect(reply.body[0]).toBe(INT64_MAX);
|
|
108
|
+
});
|
|
109
|
+
|
|
110
|
+
test('a UINT64 at the 64-bit maximum from the independent producer decodes exactly', async () => {
|
|
111
|
+
const reply = await call('GetUint64');
|
|
112
|
+
expect(reply.body[0]).toBe(UINT64_MAX);
|
|
113
|
+
});
|
|
114
|
+
|
|
115
|
+
test('a bare variant from the independent producer preserves signature and value', async () => {
|
|
116
|
+
const reply = await call('GetVariant');
|
|
117
|
+
expect(reply.body[0]).toEqual({ signature: 't', value: UINT64_MAX });
|
|
118
|
+
});
|
|
119
|
+
|
|
120
|
+
test('2^63-1 round-trips through the independent producer exactly', async () => {
|
|
121
|
+
const reply = await call('EchoUint64', 't', [INT64_MAX]);
|
|
122
|
+
expect(reply.body[0]).toBe(INT64_MAX);
|
|
123
|
+
});
|
|
124
|
+
|
|
125
|
+
test('the independent producer confirms the exact 64-bit value we encoded', async () => {
|
|
126
|
+
const reply = await call('DescribeUint64', 't', [UINT64_MAX]);
|
|
127
|
+
expect(reply.body[0]).toBe(UINT64_MAX.toString());
|
|
128
|
+
});
|
|
129
|
+
|
|
130
|
+
test('a PropertiesChanged signal decodes changed 64-bit values and invalidated names', async () => {
|
|
131
|
+
let resolveEvent: (event: SignalEvent) => void = () => undefined;
|
|
132
|
+
const received = new Promise<SignalEvent>((resolve) => {
|
|
133
|
+
resolveEvent = resolve;
|
|
134
|
+
});
|
|
135
|
+
const subscription = await transport.subscribeSignal(
|
|
136
|
+
{ interface: PROPERTIES_IFACE, member: 'PropertiesChanged', path: PY_PATH },
|
|
137
|
+
(event) => resolveEvent(event),
|
|
138
|
+
);
|
|
139
|
+
await call('TriggerPropertiesChanged');
|
|
140
|
+
|
|
141
|
+
const event = await received;
|
|
142
|
+
expect(event.signature).toBe('sa{sv}as');
|
|
143
|
+
const [interfaceName, changed, invalidated] = event.body;
|
|
144
|
+
expect(interfaceName).toBe(PY_IFACE);
|
|
145
|
+
expect(changed).toEqual([
|
|
146
|
+
['AccessTechnologies', { signature: 't', value: UINT64_MAX }],
|
|
147
|
+
['SignalQuality', { signature: 'u', value: 42 }],
|
|
148
|
+
]);
|
|
149
|
+
expect(invalidated).toEqual(['OperatorName', 'OperatorCode']);
|
|
150
|
+
await subscription.unsubscribe();
|
|
151
|
+
});
|
|
152
|
+
});
|
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
// Conformance half (a): round-trip representative signatures against a fake service built
|
|
2
|
+
// on the SAME `@httptoolkit/dbus-native` library, over a real session bus. This proves the
|
|
3
|
+
// transport works end-to-end against the daemon; half (b) proves it against an independent
|
|
4
|
+
// producer. Run under `dbus-run-session -- bun test control/src/transport`.
|
|
5
|
+
|
|
6
|
+
import { afterAll, beforeAll, describe, expect, test } from 'bun:test';
|
|
7
|
+
import type { DbusTransport } from './index';
|
|
8
|
+
import { createDbusTransport } from './index';
|
|
9
|
+
import {
|
|
10
|
+
FAKE_IFACE,
|
|
11
|
+
FAKE_PATH,
|
|
12
|
+
type FakeService,
|
|
13
|
+
INT64_MAX,
|
|
14
|
+
startFakeService,
|
|
15
|
+
UINT64_MAX,
|
|
16
|
+
} from './test-support/fake-service';
|
|
17
|
+
|
|
18
|
+
const SESSION_BUS = process.env.DBUS_SESSION_BUS_ADDRESS;
|
|
19
|
+
|
|
20
|
+
describe.skipIf(!SESSION_BUS)('conformance vs same-library fake service', () => {
|
|
21
|
+
let fake: FakeService;
|
|
22
|
+
let transport: DbusTransport;
|
|
23
|
+
|
|
24
|
+
beforeAll(async () => {
|
|
25
|
+
const busAddress = SESSION_BUS as string;
|
|
26
|
+
fake = await startFakeService({ busAddress });
|
|
27
|
+
transport = createDbusTransport({ busAddress });
|
|
28
|
+
await transport.connect();
|
|
29
|
+
});
|
|
30
|
+
|
|
31
|
+
afterAll(async () => {
|
|
32
|
+
await transport.disconnect();
|
|
33
|
+
await fake.stop();
|
|
34
|
+
});
|
|
35
|
+
|
|
36
|
+
const call = (member: string, signature?: string, args?: unknown[]) =>
|
|
37
|
+
transport.callMethod({
|
|
38
|
+
destination: fake.busName,
|
|
39
|
+
path: FAKE_PATH,
|
|
40
|
+
interface: FAKE_IFACE,
|
|
41
|
+
member,
|
|
42
|
+
...(signature !== undefined ? { signature } : {}),
|
|
43
|
+
...(args !== undefined ? { args: args as never } : {}),
|
|
44
|
+
});
|
|
45
|
+
|
|
46
|
+
test('a basic string method replies', async () => {
|
|
47
|
+
const reply = await call('Ping');
|
|
48
|
+
expect(reply.signature).toBe('s');
|
|
49
|
+
expect(reply.body[0]).toBe('pong');
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
test('GetManagedObjects decodes the a{oa{sa{sv}}} shape with a 64-bit variant', async () => {
|
|
53
|
+
const reply = await call('GetManagedObjects');
|
|
54
|
+
expect(reply.signature).toBe('a{oa{sa{sv}}}');
|
|
55
|
+
expect(reply.body[0]).toEqual([
|
|
56
|
+
[
|
|
57
|
+
'/org/freedesktop/ModemManager1/Modem/0',
|
|
58
|
+
[
|
|
59
|
+
[
|
|
60
|
+
'org.freedesktop.ModemManager1.Modem',
|
|
61
|
+
[
|
|
62
|
+
['SupportedCapabilities', { signature: 't', value: UINT64_MAX }],
|
|
63
|
+
['SignalQuality', { signature: 'u', value: 87 }],
|
|
64
|
+
['DeviceIdentifier', { signature: 's', value: 'fake-device-0' }],
|
|
65
|
+
],
|
|
66
|
+
],
|
|
67
|
+
],
|
|
68
|
+
],
|
|
69
|
+
]);
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
test('an INT64 reply above 2^53 decodes to an exact bigint', async () => {
|
|
73
|
+
const reply = await call('GetInt64');
|
|
74
|
+
expect(reply.body[0]).toBe(INT64_MAX);
|
|
75
|
+
expect(typeof reply.body[0]).toBe('bigint');
|
|
76
|
+
});
|
|
77
|
+
|
|
78
|
+
test('a UINT64 reply at the full 64-bit maximum decodes exactly', async () => {
|
|
79
|
+
const reply = await call('GetUint64');
|
|
80
|
+
expect(reply.body[0]).toBe(UINT64_MAX);
|
|
81
|
+
});
|
|
82
|
+
|
|
83
|
+
test('2^63-1 round-trips through the daemon exactly (encode + decode)', async () => {
|
|
84
|
+
const reply = await call('EchoUint64', 't', [INT64_MAX]);
|
|
85
|
+
expect(reply.body[0]).toBe(INT64_MAX);
|
|
86
|
+
});
|
|
87
|
+
|
|
88
|
+
test('the full UINT64 maximum round-trips through the daemon exactly', async () => {
|
|
89
|
+
const reply = await call('EchoUint64', 't', [UINT64_MAX]);
|
|
90
|
+
expect(reply.body[0]).toBe(UINT64_MAX);
|
|
91
|
+
});
|
|
92
|
+
|
|
93
|
+
test('a negative INT64 round-trips through the daemon exactly', async () => {
|
|
94
|
+
const reply = await call('EchoInt64', 'x', [-INT64_MAX]);
|
|
95
|
+
expect(reply.body[0]).toBe(-INT64_MAX);
|
|
96
|
+
});
|
|
97
|
+
|
|
98
|
+
test('the service reports back the exact 64-bit value we encoded', async () => {
|
|
99
|
+
const reply = await call('DescribeUint64', 't', [INT64_MAX]);
|
|
100
|
+
expect(reply.body[0]).toBe(INT64_MAX.toString());
|
|
101
|
+
});
|
|
102
|
+
|
|
103
|
+
test('passing a JS number for a 64-bit argument is refused before the wire', async () => {
|
|
104
|
+
await expect(
|
|
105
|
+
transport.callMethod({
|
|
106
|
+
destination: fake.busName,
|
|
107
|
+
path: FAKE_PATH,
|
|
108
|
+
interface: FAKE_IFACE,
|
|
109
|
+
member: 'EchoUint64',
|
|
110
|
+
signature: 't',
|
|
111
|
+
args: [123 as never],
|
|
112
|
+
}),
|
|
113
|
+
).rejects.toThrow('requires a bigint');
|
|
114
|
+
});
|
|
115
|
+
});
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
// Ambient declarations for the deep library entry points the transport tests use to run
|
|
2
|
+
// an in-process, bus-free marshal/unmarshal round-trip. These are test-only reaches into
|
|
3
|
+
// `@httptoolkit/dbus-native` internals; the production transport never imports them.
|
|
4
|
+
|
|
5
|
+
declare module '@httptoolkit/dbus-native/lib/marshall' {
|
|
6
|
+
const marshall: (signature: string, data: unknown[], offset?: number) => Buffer;
|
|
7
|
+
export default marshall;
|
|
8
|
+
}
|
|
9
|
+
|
|
10
|
+
declare module '@httptoolkit/dbus-native/lib/dbus-buffer' {
|
|
11
|
+
export default class DBusBuffer {
|
|
12
|
+
constructor(
|
|
13
|
+
buffer: Buffer,
|
|
14
|
+
startPos?: number,
|
|
15
|
+
options?: { ayBuffer?: boolean; ReturnLongjs?: boolean },
|
|
16
|
+
);
|
|
17
|
+
read(signature: string): unknown;
|
|
18
|
+
}
|
|
19
|
+
}
|