feat(cli): log when update is avaliable (#417)

* Refactor update

* Log status

* Update contract

* Channels are constant

* Update message

* Fix tests

packages/api/source/commands/config-cli.ts

@@ -1,5 +1,6 @@
 import { Commands, Identifiers, Services } from "@mainsail/cli";
 import { inject, injectable } from "@mainsail/container";
+import { Constants } from "@mainsail/contracts";
 import { Utils } from "@mainsail/kernel";
 import Joi from "joi";
 
@@ -20,7 +21,7 @@ export class Command extends Commands.Command {
 			.setFlag(
 				"channel",
 				"The NPM registry channel that should be used.",
-				Joi.string().valid("alpha", "next", "latest"),
+				Joi.string().valid(...Constants.Channels),
 			);
 	}
 

packages/cli/source/contracts.ts

@@ -40,6 +40,8 @@ export interface Config {
 }
 
 export interface Updater {
+	logStatus(): Promise<void>;
+
 	check(force?: boolean): Promise<boolean>;
 
 	update(updateProcessManager?: boolean, force?: boolean): Promise<boolean>;

packages/cli/source/services/config.ts

@@ -1,5 +1,5 @@
 import { inject, injectable, postConstruct } from "@mainsail/container";
-import { Contracts } from "@mainsail/contracts";
+import { Constants, Contracts } from "@mainsail/contracts";
 import { ensureFileSync, readJsonSync, writeJsonSync } from "fs-extra";
 
 import { Application } from "../contracts";
@@ -87,10 +87,8 @@ export class Config {
 	}
 
 	#getRegistryChannel(version: string): string {
-		const channels: string[] = ["next"];
-
 		let channel = "latest";
-		for (const item of channels) {
+		for (const item of Constants.Channels) {
 			if (version.includes(`-${item}`)) {
 				channel = item;
 			}

packages/cli/source/services/updater.test.ts

@@ -23,17 +23,6 @@ describe<{
 
 	afterAll(() => nock.enableNetConnect());
 
-	it("#check - should forget the latest version if it has one from a previous check", async ({ config, updater }) => {
-		nock.fake(/.*/).get("/@mainsail%2Fcore").reply(200, versionNext);
-
-		config.set("latestVersion", {});
-
-		const spyForget = spy(config, "forget");
-
-		assert.false(await updater.check());
-		spyForget.calledWith("latestVersion");
-	});
-
 	it("#check - should return false if the latest version cannot be retrieved", async ({ cli, updater }) => {
 		nock.fake(/.*/).get("/@mainsail%2Fcore").reply(200, {});
 
@@ -71,7 +60,7 @@ describe<{
 
 		nock.fake(/.*/).get("/@mainsail%2Fcore").reply(200, response);
 
-		config.set("latestVersion", {});
+		config.set("latestVersion", undefined);
 
 		const spySet = spy(config, "set");
 

packages/cli/source/services/updater.ts

@@ -34,32 +34,40 @@ export class Updater implements Contracts_Updater {
 
 	#latestVersion: string | undefined;
 
+	public async logStatus(): Promise<void> {
+		if (await this.check()) {
+			this.app
+				.get<Warning>(Identifiers.Warning)
+				.render(
+					`${reset(" An update is available")} ${dim(this.#packageVersion)} ${reset(" → ")} ${green(
+						this.#latestVersion || "",
+					)}. Run ${green("mainsail update")} to update to the latest version.`,
+				);
+		}
+	}
+
 	public async check(force?: boolean): Promise<boolean> {
 		this.#latestVersion = this.config.get("latestVersion");
 
 		if (
-			this.#latestVersion &&
-			!force &&
-			Date.now() - this.config.get<number>("lastUpdateCheck") < this.#updateCheckInterval
+			!this.#latestVersion ||
+			force ||
+			Date.now() - this.config.get<number>("lastUpdateCheck") > this.#updateCheckInterval
 		) {
-			// Update is available if last seen is greater than latest.
-			return lt(this.#packageVersion, this.#latestVersion);
-		}
+			const latestVersion: string | undefined = await this.getLatestVersion();
 
-		const latestVersion: string | undefined = await this.getLatestVersion();
+			this.config.set("lastUpdateCheck", Date.now());
 
-		this.config.set("lastUpdateCheck", Date.now());
+			if (latestVersion === undefined) {
+				this.config.forget("latestVersion");
+				return false;
+			}
 
-		if (latestVersion === undefined) {
-			this.config.forget("latestVersion");
-			return false;
+			this.#latestVersion = latestVersion;
+			this.config.set("latestVersion", latestVersion);
 		}
 
-		this.config.set("latestVersion", latestVersion);
-
-		this.#latestVersion = latestVersion;
-
-		return true;
+		return lt(this.#packageVersion, this.#latestVersion);
 	}
 
 	public async update(updateProcessManager = false, force = false): Promise<boolean> {

packages/contracts/source/constants/channels.ts

@@ -0,0 +1 @@
+export const Channels = ["latest", "alpha", "next"];

packages/contracts/source/constants/index.ts

@@ -1,2 +1,3 @@
+export * from "./channels";
 export * from "./flags";
 export * from "./units";

packages/core/source/cli.ts

@@ -29,8 +29,8 @@ export class CommandLineInterface {
 		// Create the application we will work with
 		this.#app = ApplicationFactory.make(new Container(), package_);
 
-		// Check for updates
-		await this.#app.get<CliContracts.Updater>(Identifiers.Updater).check();
+		// Check for updates and log status
+		await this.#app.get<CliContracts.Updater>(Identifiers.Updater).logStatus();
 
 		// Parse arguments and flags
 		const { args, flags } = InputParser.parseArgv(this.argv);

packages/core/source/commands/config-cli.ts

@@ -1,5 +1,6 @@
 import { Commands, Identifiers, Services } from "@mainsail/cli";
 import { inject, injectable } from "@mainsail/container";
+import { Constants } from "@mainsail/contracts";
 import { Utils } from "@mainsail/kernel";
 import Joi from "joi";
 
@@ -20,7 +21,7 @@ export class Command extends Commands.Command {
 			.setFlag(
 				"channel",
 				"The NPM registry channel that should be used.",
-				Joi.string().valid("alpha", "next", "latest"),
+				Joi.string().valid(...Constants.Channels),
 			);
 	}