(layer compat) Add auto generation update logic to release tools

Author: agarwal-navin

build-tools/packages/build-cli/src/handlers/doFunctions.ts

@@ -4,6 +4,7 @@
  */
 
 import { strict as assert } from "node:assert";
+import { readFile, writeFile } from "node:fs/promises";
 import type { Machine } from "jssm";
 import chalk from "picocolors";
 
@@ -191,3 +192,109 @@ export const doReleaseGroupBump: StateHandlerFunction = async (
 	BaseStateHandler.signalSuccess(machine, state);
 	return true;
 };
+
+/**
+ * Updates the generation used for layer compatibility.
+ *
+ * @param state - The current state machine state.
+ * @param machine - The state machine.
+ * @param testMode - Set to true to run function in test mode.
+ * @param log - A logger that the function can use for logging.
+ * @param data - An object with handler-specific contextual data.
+ * @returns True if the state was handled; false otherwise.
+ */
+export const doLayerGenerationUpdate: StateHandlerFunction = async (
+	state: MachineState,
+	machine: Machine<unknown>,
+	testMode: boolean,
+	log: CommandLogger,
+	data: FluidReleaseStateHandlerData,
+): Promise<boolean> => {
+	if (testMode) return true;
+
+	const { bumpType } = data;
+	if (bumpType === "patch") {
+		log.info(`Generation update is not needed for patch release`);
+		BaseStateHandler.signalSuccess(machine, state);
+		return true;
+	}
+
+	log.info(`Updating layerGeneration.ts for a ${bumpType} release`);
+
+	// eslint-disable-next-line no-warning-comments
+	// TODO: Is it okay to read a file from this folder?
+	// The file that stores information of the current generation and release date.
+	const filename = "packages/common/client-utils/src/layerGeneration.ts";
+
+	// eslint-disable-next-line no-warning-comments
+	// TODO: This should ideally be read from a common location in client utils. What is the best way to do this?
+	// The minimum compatibility window in months that is supported across all layers.
+	const minimumCompatWindowMonths = 3;
+
+	const today = new Date();
+	let previousGeneration = -1;
+	let newGeneration = 1;
+
+	let fileContents: string | undefined;
+	try {
+		fileContents = await readFile(filename, "utf8");
+	} catch {
+		log.info(`File ${filename} doesn't exist yet`);
+	}
+
+	if (fileContents !== undefined) {
+		const match = fileContents.match(
+			/.*\nexport const generation = (\d+);[\n\r]*export const releaseDate = "((0[1-9]|1[0-2])\/(0[1-9]|1\d|2\d|3[01])\/(19|20)\d{2})";.*/m,
+		);
+		if (match === null) {
+			log.errorLog(`${filename} content not as expected`);
+			BaseStateHandler.signalFailure(machine, state);
+			return false;
+		}
+
+		previousGeneration = Number(match[1]);
+		const previousReleaseDateString = match[2];
+		const previousReleaseDate = new Date(previousReleaseDateString);
+		const daysBetweenReleases = Math.round(
+			(today.getTime() - previousReleaseDate.getTime()) / (1000 * 60 * 60 * 24),
+		);
+
+		const monthsBetweenReleases = Math.floor(daysBetweenReleases / 30);
+		newGeneration =
+			previousGeneration + Math.min(monthsBetweenReleases, minimumCompatWindowMonths - 1);
+
+		log.info(`Previous release date: ${previousReleaseDate}, Today: ${today}`);
+		log.info(`Days between releases: ${daysBetweenReleases}`);
+		log.info(`Months between releases: ${monthsBetweenReleases}`);
+	}
+
+	if (newGeneration === previousGeneration) {
+		log.info(`Generation does not need to be bumped`);
+		BaseStateHandler.signalSuccess(machine, state);
+		return true;
+	}
+
+	const yyyy = today.getFullYear();
+	const mmNumber = today.getMonth() + 1; // Months start at 0!
+	const ddNumber = today.getDate();
+
+	const dd = ddNumber < 10 ? `0${ddNumber}` : ddNumber.toString();
+	const mm = mmNumber < 10 ? `0${mmNumber}` : mmNumber.toString();
+	const releaseDateFormatted = `${mm}/${dd}/${yyyy}`;
+
+	const output = `/*!
+ * Copyright (c) Microsoft Corporation and contributors. All rights reserved.
+ * Licensed under the MIT License.
+ * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY
+ */
+
+export const generation = ${newGeneration};
+export const releaseDate = "${releaseDateFormatted}";
+`;
+
+	log.info(`Bumping generation from ${previousGeneration} to ${newGeneration}`);
+	await writeFile(filename, output);
+
+	BaseStateHandler.signalSuccess(machine, state);
+	return true;
+};

build-tools/packages/build-cli/src/handlers/fluidReleaseStateHandler.ts

@@ -41,7 +41,11 @@ import {
 	checkTypeTestPrepare,
 	checkValidReleaseGroup,
 } from "./checkFunctions.js";
-import { doBumpReleasedDependencies, doReleaseGroupBump } from "./doFunctions.js";
+import {
+	doBumpReleasedDependencies,
+	doLayerGenerationUpdate,
+	doReleaseGroupBump,
+} from "./doFunctions.js";
 import { InitFailedStateHandler } from "./initFailedStateHandler.js";
 import {
 	promptToCommitChanges,
@@ -191,6 +195,7 @@ export class FluidReleaseStateHandler extends InitFailedStateHandler {
 		["CheckTypeTestPrepare2", checkTypeTestPrepare],
 		["CheckValidReleaseGroup", checkValidReleaseGroup],
 		["DoBumpReleasedDependencies", doBumpReleasedDependencies],
+		["DoLayerGenerationUpdate", doLayerGenerationUpdate],
 		["DoMajorRelease", handleBumpType],
 		["DoMinorRelease", handleBumpType],
 		["DoPatchRelease", handleBumpType],

build-tools/packages/build-cli/src/machines/FluidRelease.fsl

@@ -137,6 +137,7 @@ CheckShouldCommitDeps 'failure'
 // Bumps a release group and prompts to push/PR or commit changes
 
 DoReleaseGroupBump 'success'
+=> DoLayerGenerationUpdate 'success'
 => CheckShouldCommitBump 'success'
 => PromptToPRBump;