-
Notifications
You must be signed in to change notification settings - Fork 3
Expand file tree
/
Copy pathcli.ts
More file actions
243 lines (221 loc) · 5.9 KB
/
cli.ts
File metadata and controls
243 lines (221 loc) · 5.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
import { constants } from "node:fs";
import { access } from "node:fs/promises";
import { isAbsolute } from "node:path";
import { watch } from "chokidar";
import { workspace } from "vscode";
import type { CancellationToken, LogOutputChannel, Disposable } from "vscode";
import { CLI_PATHS, LOCALSTACK_DOCKER_IMAGE_NAME } from "../constants.ts";
import { createValueEmitter } from "./emitter.ts";
import { exec } from "./exec.ts";
import { createOnceImmediate } from "./once-immediate.ts";
import type { SetupStatus } from "./setup.ts";
import { spawn } from "./spawn.ts";
import type { SpawnOptions } from "./spawn.ts";
const IMAGE_NAME = LOCALSTACK_DOCKER_IMAGE_NAME; // not using the import directly as the constant name should match the env var
const LOCALSTACK_LDM_PREVIEW = "1";
async function getLocalStackVersion(
cliPath: string,
): Promise<string | undefined> {
try {
const { stdout } = await exec([cliPath, "--version"].join(" "), {
env: {
...process.env,
IMAGE_NAME,
LOCALSTACK_LDM_PREVIEW,
},
});
const versionMatch = stdout.match(/\b([\d]+\.[\d]+.(?:\d[\d\w]*))\b/);
if (!versionMatch) {
return undefined;
}
const [, stdoutVersion] = versionMatch;
return stdoutVersion;
} catch {
return undefined;
}
}
async function getLocalStackMajorVersion(
cliPath: string,
): Promise<number | undefined> {
const version = await getLocalStackVersion(cliPath);
if (!version) {
return undefined;
}
const majorVersionMatch = version.match(/^(\d+)\./);
if (!majorVersionMatch) {
return undefined;
}
const [, majorVersionStr] = majorVersionMatch;
const majorVersion = parseInt(majorVersionStr, 10);
if (Number.isNaN(majorVersion)) {
return undefined;
}
return majorVersion;
}
async function verifyLocalStackCli(cliPath: string) {
const [found, executable, version] = await Promise.all([
access(cliPath, constants.F_OK)
.then(() => true)
.catch(() => false),
access(cliPath, constants.X_OK)
.then(() => true)
.catch(() => false),
getLocalStackMajorVersion(cliPath),
]);
return {
found,
executable,
upToDate: version !== undefined ? version >= 4 : undefined,
};
}
interface CliCheckResult {
cliPath: string | undefined;
found: boolean;
executable: boolean | undefined;
upToDate: boolean | undefined;
}
export async function findLocalStack(): Promise<CliCheckResult> {
// Check if a custom path is configured
const config = workspace.getConfiguration("localstack");
const customLocation = config.get<string | null>("cli.location");
if (customLocation) {
const { found, executable, upToDate } =
await verifyLocalStackCli(customLocation);
return {
cliPath: customLocation,
found,
executable,
upToDate,
};
}
// Fall back to default search paths
for (const CLI_PATH of CLI_PATHS) {
const { found, executable, upToDate } = await verifyLocalStackCli(CLI_PATH);
if (found) {
return {
cliPath: CLI_PATH,
found,
executable,
upToDate,
};
}
}
return {
cliPath: undefined,
found: false,
executable: undefined,
upToDate: undefined,
};
}
export const execLocalStack = async (
cliPath: string,
args: string[],
options?: {
outputChannel: LogOutputChannel;
},
) => {
const response = await exec([cliPath, ...args].join(" "), {
env: {
...process.env,
IMAGE_NAME,
LOCALSTACK_LDM_PREVIEW,
},
});
return response;
};
export const spawnLocalStack = async (
cliPath: string,
args: string[],
options: {
outputChannel: LogOutputChannel;
cancellationToken?: CancellationToken;
onStderr?: SpawnOptions["onStderr"];
},
) => {
return spawn(cliPath, args, {
outputChannel: options.outputChannel,
outputLabel: `localstack.${args[0]}`,
cancellationToken: options.cancellationToken,
environment: {
...process.env,
IMAGE_NAME,
LOCALSTACK_LDM_PREVIEW,
},
onStderr: options.onStderr,
});
};
export type LocalStackCliStatus = "not_found" | "outdated" | "ok";
export interface CliStatusTracker extends Disposable {
status(): SetupStatus | undefined;
onStatusChange(callback: (status: SetupStatus | undefined) => void): void;
cliPath(): string | undefined;
onCliPathChange(callback: (cliPath: string | undefined) => void): void;
outdated(): boolean | undefined;
onOutdatedChange(callback: (outdated: boolean | undefined) => void): void;
}
export function createCliStatusTracker(
outputChannel: LogOutputChannel,
): CliStatusTracker {
const status = createValueEmitter<SetupStatus>();
const cliPath = createValueEmitter<string | undefined>();
const outdated = createValueEmitter<boolean | undefined>();
const track = createOnceImmediate(async () => {
const newCli = await findLocalStack().catch(() => undefined);
outputChannel.info(`[cli]: findLocalStack = ${newCli?.cliPath}`);
status.setValue(
newCli?.found && newCli.executable && newCli.upToDate
? "ok"
: "setup_required",
);
cliPath.setValue(status.value() === "ok" ? newCli?.cliPath : undefined);
outdated.setValue(
newCli?.upToDate !== undefined ? !newCli.upToDate : undefined,
);
});
const watcher = watch(
// Watch absolute paths only, since `localstack` is not a real path.
CLI_PATHS.filter((path) => isAbsolute(path)),
)
.on("add", (path) => {
outputChannel.trace(
`[cli]: Detected new file at ${path}, re-checking CLI`,
);
track();
})
.on("change", (path) => {
outputChannel.trace(
`[cli]: Detected change to file at ${path}, re-checking CLI`,
);
track();
})
.on("unlink", (path) => {
outputChannel.trace(
`[cli]: Detected removal of file at ${path}, re-checking CLI`,
);
track();
});
track();
return {
cliPath() {
return cliPath.value();
},
onCliPathChange(callback) {
cliPath.onChange(callback);
},
status() {
return status.value();
},
onStatusChange(callback) {
status.onChange(callback);
},
outdated() {
return outdated.value();
},
onOutdatedChange(callback) {
outdated.onChange(callback);
},
async dispose() {
await watcher.close();
},
};
}