fix: show LocalStack setup on only when setup is required (#58)

We've had a couple of race conditions and missing status check
dependencies. This resulted in LocalStack Setup notification being shown
when the setup is not required - this was happening on the most of VS
Code starts.

This PR fixes it with the following:

- Add explicit status initialization on every status tracker creation.
- Show Setup Wizard pop-up once setup is required. This ensures that
pop-up appears if setup is required at the start. Instead of
synchronizing statuses at the start and ensuring Setup Wizard is only
popping up once, we decided to have pop-up appearing every time the
setup is broken. This shouldn't happen normally, but when it happens
then setup wizard pop-up in addition to painting setup bar red can
actually be helpful.
- License status tracker now watches both license and auth token file
(not very clean solution, in the next iteration we should add behavioral
dependency between license tracker and auth tracker).
- Refresh status bar is now happening after the last setup wizard step.
Before it was in the middle.

Author: tiurin

src/plugins/setup.ts

@@ -296,8 +296,6 @@ export default createPlugin(
 								}),
 							);
 
-							void commands.executeCommand("localstack.refreshStatusBar");
-
 							progress.report({
 								message:
 									'Finished configuring the AWS profile named "localstack".',
@@ -326,6 +324,8 @@ export default createPlugin(
 								return;
 							}
 
+							void commands.executeCommand("localstack.refreshStatusBar");
+
 							/////////////////////////////////////////////////////////////////////
 							if (localStackStatusTracker.status() === "running") {
 								window
@@ -368,17 +368,22 @@ export default createPlugin(
 			),
 		);
 
-		if (setupStatusTracker.status() === "setup_required") {
-			window
-				.showInformationMessage("Setup LocalStack to get started.", {
-					title: "Setup",
-					command: "localstack.setup",
-				})
-				.then((selected) => {
-					if (selected) {
-						commands.executeCommand(selected.command, "extension_startup");
-					}
-				});
-		}
+		setupStatusTracker.onChange((status) => {
+			if (status === "setup_required") {
+				void window
+					.showInformationMessage("Setup LocalStack to get started.", {
+						title: "Setup",
+						command: "localstack.setup",
+					})
+					.then((selected) => {
+						if (selected) {
+							void commands.executeCommand(
+								selected.command,
+								"extension_startup",
+							);
+						}
+					});
+			}
+		});
 	},
 );

src/utils/setup-status.ts

@@ -47,10 +47,30 @@ export async function createSetupStatusTracker(
 	);
 
 	const checkStatusNow = async () => {
+		const allStatusesInitialized = Object.values({
+			awsProfileTracker: awsProfileTracker.status(),
+			authTracker: localStackAuthenticationTracker.status(),
+			licenseTracker: licenseTracker.status(),
+		}).every((check) => check !== undefined);
+
+		if (!allStatusesInitialized) {
+			outputChannel.trace(
+				`[setup-status] File watchers not initialized yet, skipping status check : ${JSON.stringify(
+					{
+						awsProfileTracker: awsProfileTracker.status() ?? "undefined",
+						authTracker:
+							localStackAuthenticationTracker.status() ?? "undefined",
+						licenseTracker: licenseTracker.status() ?? "undefined",
+					},
+				)}`,
+			);
+			return;
+		}
+
 		statuses = await checkSetupStatus(outputChannel);
 
 		const setupRequired = [
-			Object.values(statuses),
+			...Object.values(statuses),
 			awsProfileTracker.status() === "ok",
 			localStackAuthenticationTracker.status() === "ok",
 			licenseTracker.status() === "ok",
@@ -60,7 +80,12 @@ export async function createSetupStatusTracker(
 		if (status !== newStatus) {
 			status = newStatus;
 			outputChannel.trace(
-				`[setup-status] Status changed to ${JSON.stringify(statuses)}`,
+				`[setup-status] Status changed to ${JSON.stringify({
+					...statuses,
+					awsProfileTracker: awsProfileTracker.status() ?? "undefined",
+					authTracker: localStackAuthenticationTracker.status() ?? "undefined",
+					licenseTracker: licenseTracker.status() ?? "undefined",
+				})}`,
 			);
 			await emitter.emit(status);
 		}
@@ -178,6 +203,9 @@ function createFileStatusTracker(
 			outputChannel.error(error instanceof Error ? error : String(error));
 		});
 
+	// Update the status immediately on file tracker initialization
+	void updateStatus();
+
 	return {
 		status() {
 			return status;
@@ -247,7 +275,7 @@ function createLicenseStatusTracker(
 	return createFileStatusTracker(
 		outputChannel,
 		"[setup-status.license]",
-		[LICENSE_FILENAME],
+		[LOCALSTACK_AUTH_FILENAME, LICENSE_FILENAME], //TODO rewrite to depend on change in localStackAuthenticationTracker
 		async () =>
 			(await checkIsLicenseValid(outputChannel)) ? "ok" : "setup_required",
 	);