@slack/radar-mcp 1.14.0 → 1.17.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/README.md +15 -3
- package/dist/mcp/db-tools.js +23 -0
- package/dist/mcp/dispatch.d.ts +4 -0
- package/dist/mcp/dispatch.js +26 -0
- package/dist/mcp/index.js +104 -32
- package/dist/mcp/platform-detect.d.ts +110 -0
- package/dist/mcp/platform-detect.js +246 -0
- package/dist/mcp/prefs-tools.d.ts +4 -3
- package/dist/mcp/prefs-tools.js +26 -3
- package/dist/mcp/session-enable.js +19 -1
- package/dist/mcp/snapshot.js +4 -1
- package/dist/mcp/sources-gate.js +6 -3
- package/dist/mcp/tools.d.ts +11 -0
- package/dist/mcp/tools.js +38 -0
- package/dist/shared/android.d.ts +40 -1
- package/dist/shared/android.js +114 -51
- package/dist/shared/constants.d.ts +25 -1
- package/dist/shared/constants.js +27 -1
- package/dist/shared/db.js +11 -2
- package/dist/shared/debug-log.js +6 -1
- package/dist/shared/enable-diagnosis.d.ts +28 -0
- package/dist/shared/enable-diagnosis.js +41 -0
- package/dist/shared/prefs.d.ts +0 -5
- package/dist/shared/prefs.js +6 -2
- package/dist/shared/screen.d.ts +46 -9
- package/dist/shared/screen.js +74 -11
- package/dist/shared/transport.d.ts +62 -5
- package/dist/shared/webapp.d.ts +50 -0
- package/dist/shared/webapp.js +65 -0
- package/dist/web/install-app.d.ts +87 -0
- package/dist/web/install-app.js +703 -0
- package/dist/web/macapp/RadarApp.swift +466 -0
- package/dist/web/public/icons/radar-1024.png +0 -0
- package/dist/web/public/icons/radar.svg +40 -0
- package/dist/web/public/index.html +41 -1
- package/dist/web/public/next/app.js +3 -0
- package/dist/web/public/next/db.js +145 -5
- package/dist/web/public/next/feed.js +18 -0
- package/dist/web/public/next/hooks.js +10 -1
- package/dist/web/public/next/screen.js +147 -43
- package/dist/web/public/next/store.js +114 -16
- package/dist/web/public/next/toast.js +134 -0
- package/dist/web/server.d.ts +2 -1
- package/dist/web/server.js +117 -12
- package/package.json +2 -2
package/dist/shared/screen.js
CHANGED
|
@@ -44,16 +44,23 @@ import { promisify } from "util";
|
|
|
44
44
|
import { resolveAdbPath } from "./android.js";
|
|
45
45
|
const SC_TMP = path.join(os.homedir(), ".slack-radar", "screen");
|
|
46
46
|
/**
|
|
47
|
-
*
|
|
48
|
-
*
|
|
47
|
+
* The only file names this module writes into the screen tmp dir, and therefore the only
|
|
48
|
+
* ones it will clean up or serve for download. Screenshots (png) joined recordings (mp4)
|
|
49
|
+
* here when screenshots became two-phase: a screenshot has to exist on disk for the
|
|
50
|
+
* outcome to be reportable before the browser is told to download it.
|
|
51
|
+
*/
|
|
52
|
+
const CAPTURE_NAME = /^radar_screen_[\w-]+\.(mp4|png)$/;
|
|
53
|
+
/**
|
|
54
|
+
* Remove all captures from the screen tmp dir. Recordings and screenshots both hold
|
|
55
|
+
* sensitive live screen content and must not linger across sessions on disk. Called on
|
|
49
56
|
* resetScreenState() (device re-enable) and on process exit — the same posture the
|
|
50
|
-
* DB-browser uses for its pulled copies. Scoped to the
|
|
51
|
-
*
|
|
57
|
+
* DB-browser uses for its pulled copies. Scoped to the names this module writes so it
|
|
58
|
+
* never deletes an unrelated file that landed in the dir.
|
|
52
59
|
*/
|
|
53
60
|
export function cleanupRecordings() {
|
|
54
61
|
try {
|
|
55
62
|
for (const f of fs.readdirSync(SC_TMP)) {
|
|
56
|
-
if (
|
|
63
|
+
if (CAPTURE_NAME.test(f)) {
|
|
57
64
|
try {
|
|
58
65
|
fs.unlinkSync(path.join(SC_TMP, f));
|
|
59
66
|
}
|
|
@@ -622,6 +629,10 @@ export function startLive(fps) {
|
|
|
622
629
|
if (L.lastFrame && Date.now() - L.lastFrameTs > 350)
|
|
623
630
|
pushFrame(L, L.lastFrame);
|
|
624
631
|
}, 400);
|
|
632
|
+
// Same reasoning as orphanTimer above: a live cast that outlives normal teardown must
|
|
633
|
+
// not be the thing keeping the whole process alive.
|
|
634
|
+
if (typeof L.keepalive.unref === "function")
|
|
635
|
+
L.keepalive.unref();
|
|
625
636
|
scLive = L;
|
|
626
637
|
return L;
|
|
627
638
|
}
|
|
@@ -747,18 +758,63 @@ export function stopRecording(L = scLive) {
|
|
|
747
758
|
});
|
|
748
759
|
}
|
|
749
760
|
/**
|
|
750
|
-
* Resolve a recording for download. Restricted to the screen tmp
|
|
751
|
-
*
|
|
752
|
-
*
|
|
753
|
-
*
|
|
761
|
+
* Resolve a capture (recording or screenshot) for download. Restricted to the screen tmp
|
|
762
|
+
* dir AND to the names this module writes: path.basename strips any directory (no
|
|
763
|
+
* traversal), and the prefix/extension check means a download request can only ever name
|
|
764
|
+
* a radar capture, never an arbitrary file that happened to land in the dir.
|
|
754
765
|
*/
|
|
755
|
-
export function
|
|
766
|
+
export function capturePath(file) {
|
|
756
767
|
const base = path.basename(file);
|
|
757
|
-
if (
|
|
768
|
+
if (!CAPTURE_NAME.test(base))
|
|
758
769
|
return null;
|
|
759
770
|
const p = path.join(SC_TMP, base);
|
|
760
771
|
return fs.existsSync(p) ? p : null;
|
|
761
772
|
}
|
|
773
|
+
/** The user-facing wording for each way a screenshot save can fail. */
|
|
774
|
+
export function screenshotSaveErrorMessage(result) {
|
|
775
|
+
return result.reason === "write-failed"
|
|
776
|
+
? "could not write the screenshot to disk: " + result.detail
|
|
777
|
+
: "screencap failed; is the device awake and connected?";
|
|
778
|
+
}
|
|
779
|
+
/**
|
|
780
|
+
* Capture a screenshot and write it to the screen tmp dir.
|
|
781
|
+
*
|
|
782
|
+
* Writing to disk is what makes the outcome reportable. Streaming the PNG straight back as
|
|
783
|
+
* a Content-Disposition attachment gave the browser no way to distinguish a saved file from
|
|
784
|
+
* a 403 or a 502: the response never reaches page JavaScript, and a download navigation
|
|
785
|
+
* fires neither load nor error on the frame that requested it. Landing the bytes first
|
|
786
|
+
* turns "did this work" into an ordinary JSON answer, which is the same two-phase shape
|
|
787
|
+
* /screen/record/stop already uses.
|
|
788
|
+
*
|
|
789
|
+
* Same on-disk posture as a recording, and for the same reason: a screenshot is a full
|
|
790
|
+
* frame of whatever is on the phone, so the dir is owner-only and the file owner-read/write.
|
|
791
|
+
*/
|
|
792
|
+
export async function saveScreenshot() {
|
|
793
|
+
const png = await captureScreenshot();
|
|
794
|
+
if (!png)
|
|
795
|
+
return { ok: false, reason: "capture-failed" };
|
|
796
|
+
const safe = new Date().toISOString().replace(/[:.]/g, "-");
|
|
797
|
+
const out = path.join(SC_TMP, `radar_screen_${safe}.png`);
|
|
798
|
+
// Every host-side step is inside one try, so a failure to CREATE the dir is reported the same
|
|
799
|
+
// way as a failure to write the file. Left outside, an unwritable home threw straight out of
|
|
800
|
+
// here, and the route calling it has no catch, so the request hung until the client timed out.
|
|
801
|
+
try {
|
|
802
|
+
fs.mkdirSync(SC_TMP, { recursive: true, mode: 0o700 });
|
|
803
|
+
// mkdirSync's mode only applies on creation, so a dir from an earlier session keeps its
|
|
804
|
+
// old (world-traversable) perms. Same unconditional chmod startRecording does.
|
|
805
|
+
try {
|
|
806
|
+
fs.chmodSync(SC_TMP, 0o700);
|
|
807
|
+
}
|
|
808
|
+
catch {
|
|
809
|
+
// best-effort; the file mode below is still applied
|
|
810
|
+
}
|
|
811
|
+
fs.writeFileSync(out, png, { mode: 0o600 });
|
|
812
|
+
}
|
|
813
|
+
catch (e) {
|
|
814
|
+
return { ok: false, reason: "write-failed", detail: e.message };
|
|
815
|
+
}
|
|
816
|
+
return { ok: true, path: out };
|
|
817
|
+
}
|
|
762
818
|
// ---- lifecycle ---------------------------------------------------------------
|
|
763
819
|
/** Reset detection + tear down any live cast. Called on device re-enable and shutdown. */
|
|
764
820
|
export function resetScreenState() {
|
|
@@ -798,6 +854,13 @@ export function registerScreenCleanup() {
|
|
|
798
854
|
process.on("exit", () => {
|
|
799
855
|
if (scLive)
|
|
800
856
|
reapCastProcesses(scLive);
|
|
857
|
+
// Also delete the captures here, not only in the signal handlers below. Those handlers are
|
|
858
|
+
// not guaranteed to run: Node fires signal listeners in registration order, and another
|
|
859
|
+
// module registering earlier (logcat-capture does, at server.ts module load) calls
|
|
860
|
+
// process.exit() synchronously, which skips every later SIGTERM listener including ours.
|
|
861
|
+
// "exit" fires no matter who ends the process, so this is the order-independent place for it.
|
|
862
|
+
// Verified live: a SIGTERM'd dashboard used to leave a full-screen PNG on disk.
|
|
863
|
+
cleanupRecordings();
|
|
801
864
|
});
|
|
802
865
|
process.on("SIGINT", () => {
|
|
803
866
|
signalCleanup();
|
|
@@ -8,6 +8,17 @@
|
|
|
8
8
|
*/
|
|
9
9
|
/** Which underlying source served a getRecentLogs result. */
|
|
10
10
|
export type LogSource = "app_buffer" | "logcat_capture" | "logcat_ring";
|
|
11
|
+
/**
|
|
12
|
+
* What a fresh process probe actually established. "unknown" is a real answer, not a
|
|
13
|
+
* failure to answer: the probe ran and could not tell (no adb, device detached or
|
|
14
|
+
* unauthorized, timeout). Callers may only sharpen a message on "stopped"; "unknown"
|
|
15
|
+
* has to stay generic, because the app may well be running fine.
|
|
16
|
+
*
|
|
17
|
+
* A probe that cannot always tell must say so in its return type. Collapsing
|
|
18
|
+
* "could not tell" into "stopped" is what produced the wrong "the app is not running"
|
|
19
|
+
* message this type exists to prevent.
|
|
20
|
+
*/
|
|
21
|
+
export type ProcessState = "running" | "stopped" | "unknown";
|
|
11
22
|
/** Lines plus the source that produced them. */
|
|
12
23
|
export interface LogResult {
|
|
13
24
|
lines: string[];
|
|
@@ -26,8 +37,32 @@ export interface DeviceInfo {
|
|
|
26
37
|
state: string;
|
|
27
38
|
}
|
|
28
39
|
export interface DeviceTransport {
|
|
29
|
-
/**
|
|
40
|
+
/**
|
|
41
|
+
* Human-readable platform name (e.g. "android", "ios").
|
|
42
|
+
*
|
|
43
|
+
* For display and error text. Do NOT branch capability decisions on it. An optional member
|
|
44
|
+
* being present is the capability check; `platform !== "android"` is a guess that happens to
|
|
45
|
+
* be right today and rejects the next platform by construction rather than by an actual gap.
|
|
46
|
+
*/
|
|
30
47
|
readonly platform: string;
|
|
48
|
+
/**
|
|
49
|
+
* Whether this transport can reach the app's on-device databases and shared preferences.
|
|
50
|
+
*
|
|
51
|
+
* A flag rather than an optional method because the DB and prefs tools do not call through the
|
|
52
|
+
* transport at all -- they shell out to adb themselves (shared/db.ts, shared/prefs.ts) and take
|
|
53
|
+
* a transport only to ask this question. Defaults to unsupported when absent, so a new
|
|
54
|
+
* transport has to opt in deliberately instead of inheriting access it cannot serve.
|
|
55
|
+
*/
|
|
56
|
+
readonly supportsLocalFileAccess?: boolean;
|
|
57
|
+
/**
|
|
58
|
+
* Whether this transport has a device dashboard for open_radar_dashboard to open.
|
|
59
|
+
*
|
|
60
|
+
* A flag for the same reason as supportsLocalFileAccess: the dashboard is a separate web server
|
|
61
|
+
* this transport does not serve, so there is no method whose presence could answer the question.
|
|
62
|
+
* The dashboard's own copy is about arming a device and reconnecting to it, which a transport with
|
|
63
|
+
* no device concept cannot honour. Absent means no, so a new transport opts in deliberately.
|
|
64
|
+
*/
|
|
65
|
+
readonly supportsDeviceDashboard?: boolean;
|
|
31
66
|
/**
|
|
32
67
|
* Set up port forwarding so the device's radar HTTP server is
|
|
33
68
|
* reachable at localhost:RADAR_PORT. Returns true on success.
|
|
@@ -75,21 +110,29 @@ export interface DeviceTransport {
|
|
|
75
110
|
* Capture a screenshot from the connected device.
|
|
76
111
|
* Returns the local file path to the saved image.
|
|
77
112
|
*
|
|
113
|
+
* Optional: a platform with no device screen to capture (webapp) omits it. Callers must check
|
|
114
|
+
* for the method rather than for a platform name -- see the capability note at the top of this
|
|
115
|
+
* interface.
|
|
116
|
+
*
|
|
78
117
|
* @param fullRes If true, capture at full resolution
|
|
79
118
|
*/
|
|
80
|
-
screenshot(fullRes: boolean): string;
|
|
119
|
+
screenshot?(fullRes: boolean): string;
|
|
81
120
|
/**
|
|
82
121
|
* Record a short screen video from the connected device.
|
|
83
122
|
* Returns the local file path to the saved video.
|
|
84
123
|
*
|
|
124
|
+
* Optional: omitted by platforms with no device screen (webapp).
|
|
125
|
+
*
|
|
85
126
|
* @param durationS Recording duration in seconds
|
|
86
127
|
*/
|
|
87
|
-
recordScreen(durationS: number): string;
|
|
128
|
+
recordScreen?(durationS: number): string;
|
|
88
129
|
/**
|
|
89
130
|
* Get the current app state from the device (visible screens,
|
|
90
131
|
* fragments, arguments, etc.). Returns a human-readable string.
|
|
132
|
+
*
|
|
133
|
+
* Optional: omitted by platforms with no equivalent introspection (webapp).
|
|
91
134
|
*/
|
|
92
|
-
getAppState(): string;
|
|
135
|
+
getAppState?(): string;
|
|
93
136
|
/**
|
|
94
137
|
* Get recent log entries, optionally filtered by tag.
|
|
95
138
|
*
|
|
@@ -98,8 +141,10 @@ export interface DeviceTransport {
|
|
|
98
141
|
* @param grep Optional text to further filter
|
|
99
142
|
* @returns The matching lines plus which source served them, so the caller can tell a
|
|
100
143
|
* true-empty result from a silent fallback to an inferior source.
|
|
144
|
+
*
|
|
145
|
+
* Optional: omitted by platforms with no device log stream (webapp).
|
|
101
146
|
*/
|
|
102
|
-
getRecentLogs(tag: string, limit: number, grep?: string): LogResult;
|
|
147
|
+
getRecentLogs?(tag: string, limit: number, grep?: string): LogResult;
|
|
103
148
|
/**
|
|
104
149
|
* Returns the currently active user ID, or null if none is set. On Android
|
|
105
150
|
* this is the profile (e.g. "0" for personal, "10" for work); on iOS it
|
|
@@ -135,6 +180,18 @@ export interface DeviceTransport {
|
|
|
135
180
|
* implementations may omit it.
|
|
136
181
|
*/
|
|
137
182
|
getLastActivateError?(): string | null;
|
|
183
|
+
/**
|
|
184
|
+
* State of the target app process on the device, checked fresh (not cached). Lets the
|
|
185
|
+
* enable flow tell a confirmed "stopped" apart from "the probe could not tell" when the
|
|
186
|
+
* device server never answers a ping after activation. Optional; an absent method is
|
|
187
|
+
* the same as "unknown", so `transport.processState?.() ?? "unknown"` is the whole
|
|
188
|
+
* call-site contract and there is no falsy-vs-absent trap to remember.
|
|
189
|
+
*
|
|
190
|
+
* @param timeoutMs Optional ceiling for the probe. A caller that is only explaining a
|
|
191
|
+
* failure it already detected should pass something short, so the diagnosis cannot
|
|
192
|
+
* cost more than the operation it diagnoses. Implementations may ignore it.
|
|
193
|
+
*/
|
|
194
|
+
processState?(timeoutMs?: number): ProcessState;
|
|
138
195
|
/**
|
|
139
196
|
* Returns the path of the session-scoped log capture file, or null if no
|
|
140
197
|
* capture is running. Surfaced in tool responses so the model can reason
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import type { DeviceTransport } from "./transport.js";
|
|
2
|
+
/**
|
|
3
|
+
* DeviceTransport for the webapp Radar debug server: a local dev server plugin, not an Android
|
|
4
|
+
* device reached over adb. There is no adb forward to build, no
|
|
5
|
+
* activation broadcast to send, and no multi-user/profile model, so most of this transport is
|
|
6
|
+
* either a trivial success or a documented no-op -- see each method below for why.
|
|
7
|
+
*
|
|
8
|
+
* Real device operations (screenshot, screen recording, app state, log retrieval) are a
|
|
9
|
+
* deliberate non-goal for webapp, and they are simply ABSENT here rather than present-and-throwing.
|
|
10
|
+
* DeviceTransport declares all four optional, which is the interface's existing way of saying a
|
|
11
|
+
* capability may be missing (dropForward, reassertForward, listDevices and others already work
|
|
12
|
+
* that way). Declaring them and throwing was the same information said less directly: it forced a
|
|
13
|
+
* method to exist in order to announce that it does not, and it left the real answer discoverable
|
|
14
|
+
* only by calling it and catching. Absent members let a caller ask before calling.
|
|
15
|
+
*
|
|
16
|
+
* Same reason `supportsLocalFileAccess` and `supportsDeviceDashboard` are left unset: the DB and
|
|
17
|
+
* prefs tools shell to adb themselves and the dashboard is its own web server, so there is nothing
|
|
18
|
+
* for this transport to implement, and the flags' absent-means-no default states that without a
|
|
19
|
+
* platform-name comparison.
|
|
20
|
+
*/
|
|
21
|
+
export declare class WebappTransport implements DeviceTransport {
|
|
22
|
+
readonly platform = "webapp";
|
|
23
|
+
private forwarded;
|
|
24
|
+
private currentTimeoutMinutes;
|
|
25
|
+
/**
|
|
26
|
+
* Nothing to forward -- the webapp dev server already listens on localhost, at whatever
|
|
27
|
+
* port setRadarPort(WEBAPP_DEFAULT_PORT) pointed RADAR_PORT at (see
|
|
28
|
+
* mcp/platform-detect.ts). DeviceTransport.ensureForward() is declared synchronous
|
|
29
|
+
* (`(): boolean`, not `(): Promise<boolean>`), so a real HTTP reachability check cannot
|
|
30
|
+
* live here without either shelling out or a blocking hack, and neither is worth it: the
|
|
31
|
+
* very next thing this transport's caller does is callRadar()'s real HTTP GET against
|
|
32
|
+
* RADAR_HOST:RADAR_PORT, and that call's existing retry-then-disable-session handling
|
|
33
|
+
* already turns an unreachable server into a clean error. So this trivially succeeds
|
|
34
|
+
* (there genuinely is nothing to forward) and lets the real request be the truth-teller.
|
|
35
|
+
*/
|
|
36
|
+
ensureForward(): boolean;
|
|
37
|
+
/**
|
|
38
|
+
* No activation broadcast exists on webapp -- the dev server just runs or it does not.
|
|
39
|
+
* Only remember the requested timeout so getTimeoutMinutes() reports it back, mirroring
|
|
40
|
+
* AndroidTransport's activate() contract without the adb side effect.
|
|
41
|
+
*/
|
|
42
|
+
activate(timeoutMinutes: number): void;
|
|
43
|
+
resetState(): void;
|
|
44
|
+
isForwarded(): boolean;
|
|
45
|
+
getTimeoutMinutes(): number;
|
|
46
|
+
/** No multi-user concept on webapp. */
|
|
47
|
+
getActiveUserId(): string | null;
|
|
48
|
+
/** Single-user platform: per transport.ts's own doc comment, resolve to "". */
|
|
49
|
+
resolveActiveUser(): string;
|
|
50
|
+
}
|
|
@@ -0,0 +1,65 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* DeviceTransport for the webapp Radar debug server: a local dev server plugin, not an Android
|
|
3
|
+
* device reached over adb. There is no adb forward to build, no
|
|
4
|
+
* activation broadcast to send, and no multi-user/profile model, so most of this transport is
|
|
5
|
+
* either a trivial success or a documented no-op -- see each method below for why.
|
|
6
|
+
*
|
|
7
|
+
* Real device operations (screenshot, screen recording, app state, log retrieval) are a
|
|
8
|
+
* deliberate non-goal for webapp, and they are simply ABSENT here rather than present-and-throwing.
|
|
9
|
+
* DeviceTransport declares all four optional, which is the interface's existing way of saying a
|
|
10
|
+
* capability may be missing (dropForward, reassertForward, listDevices and others already work
|
|
11
|
+
* that way). Declaring them and throwing was the same information said less directly: it forced a
|
|
12
|
+
* method to exist in order to announce that it does not, and it left the real answer discoverable
|
|
13
|
+
* only by calling it and catching. Absent members let a caller ask before calling.
|
|
14
|
+
*
|
|
15
|
+
* Same reason `supportsLocalFileAccess` and `supportsDeviceDashboard` are left unset: the DB and
|
|
16
|
+
* prefs tools shell to adb themselves and the dashboard is its own web server, so there is nothing
|
|
17
|
+
* for this transport to implement, and the flags' absent-means-no default states that without a
|
|
18
|
+
* platform-name comparison.
|
|
19
|
+
*/
|
|
20
|
+
export class WebappTransport {
|
|
21
|
+
platform = "webapp";
|
|
22
|
+
forwarded = false;
|
|
23
|
+
currentTimeoutMinutes = 5;
|
|
24
|
+
/**
|
|
25
|
+
* Nothing to forward -- the webapp dev server already listens on localhost, at whatever
|
|
26
|
+
* port setRadarPort(WEBAPP_DEFAULT_PORT) pointed RADAR_PORT at (see
|
|
27
|
+
* mcp/platform-detect.ts). DeviceTransport.ensureForward() is declared synchronous
|
|
28
|
+
* (`(): boolean`, not `(): Promise<boolean>`), so a real HTTP reachability check cannot
|
|
29
|
+
* live here without either shelling out or a blocking hack, and neither is worth it: the
|
|
30
|
+
* very next thing this transport's caller does is callRadar()'s real HTTP GET against
|
|
31
|
+
* RADAR_HOST:RADAR_PORT, and that call's existing retry-then-disable-session handling
|
|
32
|
+
* already turns an unreachable server into a clean error. So this trivially succeeds
|
|
33
|
+
* (there genuinely is nothing to forward) and lets the real request be the truth-teller.
|
|
34
|
+
*/
|
|
35
|
+
ensureForward() {
|
|
36
|
+
this.forwarded = true;
|
|
37
|
+
return true;
|
|
38
|
+
}
|
|
39
|
+
/**
|
|
40
|
+
* No activation broadcast exists on webapp -- the dev server just runs or it does not.
|
|
41
|
+
* Only remember the requested timeout so getTimeoutMinutes() reports it back, mirroring
|
|
42
|
+
* AndroidTransport's activate() contract without the adb side effect.
|
|
43
|
+
*/
|
|
44
|
+
activate(timeoutMinutes) {
|
|
45
|
+
if (timeoutMinutes)
|
|
46
|
+
this.currentTimeoutMinutes = timeoutMinutes;
|
|
47
|
+
}
|
|
48
|
+
resetState() {
|
|
49
|
+
this.forwarded = false;
|
|
50
|
+
}
|
|
51
|
+
isForwarded() {
|
|
52
|
+
return this.forwarded;
|
|
53
|
+
}
|
|
54
|
+
getTimeoutMinutes() {
|
|
55
|
+
return this.currentTimeoutMinutes;
|
|
56
|
+
}
|
|
57
|
+
/** No multi-user concept on webapp. */
|
|
58
|
+
getActiveUserId() {
|
|
59
|
+
return null;
|
|
60
|
+
}
|
|
61
|
+
/** Single-user platform: per transport.ts's own doc comment, resolve to "". */
|
|
62
|
+
resolveActiveUser() {
|
|
63
|
+
return "";
|
|
64
|
+
}
|
|
65
|
+
}
|
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
import { spawn } from "child_process";
|
|
2
|
+
/**
|
|
3
|
+
* Resolve npx's absolute path, same reasoning as the baked-in node path: a Finder-launched dock
|
|
4
|
+
* app gets a minimal PATH with no shell config, so a bare `npx` would not resolve. npm ships npx
|
|
5
|
+
* alongside node in most installs, so check there first; `which` covers the rest. Returns null
|
|
6
|
+
* (never throws) so a machine with no npx just does not get the self-heal capability.
|
|
7
|
+
*/
|
|
8
|
+
export declare function resolveNpxPath(): string | null;
|
|
9
|
+
/**
|
|
10
|
+
* The launcher script that becomes the .app's executable. Written as text (not compiled) so it
|
|
11
|
+
* stays readable and auditable in place -- a binary blob dropped in ~/Applications by an npm
|
|
12
|
+
* package deserves more suspicion than a shell script anyone can cat.
|
|
13
|
+
*
|
|
14
|
+
* `nodeBin` and `webBin` are baked in as ABSOLUTE paths, resolved at install time. A dock app
|
|
15
|
+
* launches from Finder with a minimal PATH that usually lacks node entirely (nvm/homebrew node
|
|
16
|
+
* live in a shell-configured PATH), so `node` or `npx` by bare name would fail with a dialog-less
|
|
17
|
+
* silent exit. Baking the paths also pins the launcher to the exact install that generated it
|
|
18
|
+
* rather than whatever npx would resolve today.
|
|
19
|
+
*
|
|
20
|
+
* Exported for testing: a test can assert on the generated script without writing a bundle into
|
|
21
|
+
* the developer's ~/Applications.
|
|
22
|
+
*/
|
|
23
|
+
export declare function launcherScript(nodeBin: string, webBin: string, port: number): string;
|
|
24
|
+
/**
|
|
25
|
+
* The `--- BEGIN/END INSTALL CONFIG ---` block buildSwiftApp() substitutes into RadarApp.swift.
|
|
26
|
+
* Exported like launcherScript, for the same reason: a test can assert on the generated text
|
|
27
|
+
* without touching ~/Applications.
|
|
28
|
+
*/
|
|
29
|
+
export declare function swiftInstallConfig(radarUrl: string, node: string, webBin: string, npx: string, mcpBin: string): string;
|
|
30
|
+
/**
|
|
31
|
+
* Create (or replace) the launcher app. Returns its path.
|
|
32
|
+
*
|
|
33
|
+
* Builds the new bundle at a `.new` staging path and swaps it in only once fully written, so a
|
|
34
|
+
* failure partway through a rebuild leaves the previous, working bundle in place instead of
|
|
35
|
+
* deleted with nothing to replace it. An exclusive lock file guards the whole build+swap against
|
|
36
|
+
* a second concurrent install (a dock self-heal and a manual install-app overlapping, say) racing
|
|
37
|
+
* the same staging path.
|
|
38
|
+
*/
|
|
39
|
+
export declare function installMacApp(): {
|
|
40
|
+
app: string;
|
|
41
|
+
native: boolean;
|
|
42
|
+
};
|
|
43
|
+
/** Entry point for the `install-app` subcommand. Prints what to do next, then reveals the app. */
|
|
44
|
+
export declare function runInstallApp(): void;
|
|
45
|
+
/**
|
|
46
|
+
* Entry point for `install-app --self-heal-check`, spawned in the background by RadarApp.swift
|
|
47
|
+
* on every dock launch. install-app bakes the .app's paths and version in ONCE, so a Radar
|
|
48
|
+
* upgrade via `npx @slack/radar-mcp@latest` (the documented setup) can leave the installed app
|
|
49
|
+
* pointed at a stale, orphaned npx cache path with no signal to the user. This rebuilds it in
|
|
50
|
+
* place when this process's own version (itself just resolved via the same `@latest` npx call)
|
|
51
|
+
* differs from what is installed, so the fix lands invisibly and takes effect on the NEXT
|
|
52
|
+
* launch. Never throws out of this function: a launcher-triggered background process failing
|
|
53
|
+
* loudly would look like a crash, which is exactly what staying invisible rules out.
|
|
54
|
+
*/
|
|
55
|
+
export declare function runSelfHealCheck(): void;
|
|
56
|
+
/** Test seam: override the registry URL checkLatestPublishedVersion() reads from. */
|
|
57
|
+
export declare function _setRegistryUrlForTest(url: string): void;
|
|
58
|
+
/**
|
|
59
|
+
* Reads the latest published version from the npm registry, or null on ANY failure (non-200,
|
|
60
|
+
* timeout, malformed JSON, network down) -- never throws. This is a pure metadata read: it never
|
|
61
|
+
* executes any resolved package's code, so unlike `npx @latest install-app --self-heal-check` it
|
|
62
|
+
* carries none of the old-dispatch risk (an already-published old build that does not understand
|
|
63
|
+
* `--self-heal-check` would just run its full interactive install unconditionally).
|
|
64
|
+
*/
|
|
65
|
+
export declare function checkLatestPublishedVersion(): Promise<string | null>;
|
|
66
|
+
/** Test seam: override the spawn implementation runSelfHealPrecheckAsync() uses to trigger the
|
|
67
|
+
* conditional npx rebuild. */
|
|
68
|
+
export declare function _setSelfHealSpawnForTest(fn: typeof spawn): void;
|
|
69
|
+
/**
|
|
70
|
+
* Entry point for `install-app --self-heal-precheck`. RadarApp.swift now spawns THIS (the
|
|
71
|
+
* already-installed, guaranteed self-heal-aware mcp/index.js) instead of going straight to `npx
|
|
72
|
+
* -y @slack/radar-mcp@latest install-app --self-heal-check`. The direct-to-npx version had a real
|
|
73
|
+
* bug: nothing guaranteed `@latest` resolved to code that understood `--self-heal-check`, and the
|
|
74
|
+
* already-published old dispatch ignores unknown flags and runs the full INTERACTIVE install
|
|
75
|
+
* unconditionally (opens a Finder window) on every dock click until npm catches up -- which is
|
|
76
|
+
* the normal state, not an edge case, for a locally-built dock app ahead of what is published.
|
|
77
|
+
*
|
|
78
|
+
* This checks the registry's plain version metadata first (no package code ever executes) and
|
|
79
|
+
* only spawns the npx follow-up once that confirms a real, strictly-newer version exists. At that
|
|
80
|
+
* point whatever `npx @latest` resolves to is guaranteed to postdate this build and understand
|
|
81
|
+
* `--self-heal-check`, because versions only move forward under this project's manual, sequential
|
|
82
|
+
* publish model -- so the old-dispatch bug cannot trigger here.
|
|
83
|
+
*/
|
|
84
|
+
export declare function runSelfHealPrecheck(): void;
|
|
85
|
+
/** The awaitable core of runSelfHealPrecheck(), exported so a test can await its outcome
|
|
86
|
+
* directly instead of polling for the fire-and-forget wrapper to finish. */
|
|
87
|
+
export declare function runSelfHealPrecheckAsync(): Promise<void>;
|