Expose SHA in settings

Author: cte

apps/vscode-nightly/esbuild.mjs

@@ -3,7 +3,7 @@ import * as fs from "fs"
 import * as path from "path"
 import { fileURLToPath } from "url"
 
-import { copyPaths, copyLocales, copyWasms, generatePackageJson } from "@roo-code/build"
+import { getGitSha, copyPaths, copyLocales, copyWasms, generatePackageJson } from "@roo-code/build"
 
 const __filename = fileURLToPath(import.meta.url)
 const __dirname = path.dirname(__filename)
@@ -13,6 +13,13 @@ async function main() {
 	const minify = production
 	const sourcemap = !production
 
+	const overrideJson = JSON.parse(fs.readFileSync(path.join(__dirname, "package.nightly.json"), "utf8"))
+	console.log(`[main] name: ${overrideJson.name}`)
+	console.log(`[main] version: ${overrideJson.version}`)
+
+	const gitSha = getGitSha()
+	console.log(`[main] gitSha: ${gitSha}`)
+
 	/**
 	 * @type {import('esbuild').BuildOptions}
 	 */
@@ -26,7 +33,9 @@ async function main() {
 		platform: "node",
 		define: {
 			"process.env.PKG_NAME": '"roo-code-nightly"',
+			"process.env.PKG_VERSION": `"${overrideJson.version}"`,
 			"process.env.PKG_OUTPUT_CHANNEL": '"Roo-Code-Nightly"',
+			...(gitSha ? { "process.env.PKG_SHA": `"${gitSha}"` } : {}),
 		},
 	}
 
@@ -72,10 +81,6 @@ async function main() {
 				build.onEnd(() => {
 					const packageJson = JSON.parse(fs.readFileSync(path.join(srcDir, "package.json"), "utf8"))
 
-					const overrideJson = JSON.parse(
-						fs.readFileSync(path.join(__dirname, "package.nightly.json"), "utf8"),
-					)
-
 					const generatedPackageJson = generatePackageJson({
 						packageJson,
 						overrideJson,

packages/build/src/index.ts

@@ -1,14 +1,23 @@
 import * as fs from "fs"
 import * as path from "path"
+import { execSync } from "child_process"
 
-import { ViewsContainer, Views, MenuItem, Menus, Configuration, contributesSchema } from "./types.js"
+import { ViewsContainer, Views, Menus, Configuration, contributesSchema } from "./types.js"
+
+export function getGitSha() {
+	let gitSha = undefined
+
+	try {
+		gitSha = execSync("git rev-parse HEAD").toString().trim()
+	} catch (e) {}
+
+	return gitSha
+}
 
 export function copyPaths(copyPaths: [string, string][], srcDir: string, dstDir: string) {
 	copyPaths.forEach(([srcRelPath, dstRelPath]) => {
 		const stats = fs.lstatSync(path.join(srcDir, srcRelPath))
 
-		console.log(`[copyPaths] ${srcRelPath} -> ${dstRelPath}`)
-
 		if (stats.isDirectory()) {
 			if (fs.existsSync(path.join(dstDir, dstRelPath))) {
 				fs.rmSync(path.join(dstDir, dstRelPath), { recursive: true })

src/exports/roo-code.d.ts

@@ -1545,6 +1545,7 @@ declare const Package: {
 	readonly name: string
 	readonly version: string
 	readonly outputChannel: string
+	readonly sha: string | undefined
 }
 /**
  * ProviderName

src/extension.ts

@@ -51,7 +51,7 @@ export async function activate(context: vscode.ExtensionContext) {
 	extensionContext = context
 	outputChannel = vscode.window.createOutputChannel(Package.outputChannel)
 	context.subscriptions.push(outputChannel)
-	outputChannel.appendLine(`${Package.name} extension activated`)
+	outputChannel.appendLine(`${Package.name} extension activated - ${JSON.stringify(Package)}`)
 
 	// Migrate old settings to new
 	await migrateSettings(context, outputChannel)

src/schemas/index.ts

@@ -19,10 +19,11 @@ import { publisher, name, version } from "../package.json"
 // by VSCode, but that build artifact is not used during the transpile step of
 // the build, so we still need this override mechanism.
 export const Package = {
-	publisher: process.env.PKG_PUBLISHER || publisher,
+	publisher,
 	name: process.env.PKG_NAME || name,
 	version: process.env.PKG_VERSION || version,
 	outputChannel: process.env.PKG_OUTPUT_CHANNEL || "Roo-Code",
+	sha: process.env.PKG_SHA,
 } as const
 
 /**

webview-ui/src/components/settings/About.tsx

@@ -5,6 +5,7 @@ import { Info, Download, Upload, TriangleAlert } from "lucide-react"
 
 import { VSCodeCheckbox, VSCodeLink } from "@vscode/webview-ui-toolkit/react"
 
+import { Package } from "@roo/schemas"
 import { TelemetrySetting } from "@roo/shared/TelemetrySetting"
 
 import { vscode } from "@/utils/vscode"
@@ -15,17 +16,21 @@ import { SectionHeader } from "./SectionHeader"
 import { Section } from "./Section"
 
 type AboutProps = HTMLAttributes<HTMLDivElement> & {
-	version: string
 	telemetrySetting: TelemetrySetting
 	setTelemetrySetting: (setting: TelemetrySetting) => void
 }
 
-export const About = ({ version, telemetrySetting, setTelemetrySetting, className, ...props }: AboutProps) => {
+export const About = ({ telemetrySetting, setTelemetrySetting, className, ...props }: AboutProps) => {
 	const { t } = useAppTranslation()
 
 	return (
 		<div className={cn("flex flex-col gap-2", className)} {...props}>
-			<SectionHeader description={`Version: ${version}`}>
+			<SectionHeader
+				description={
+					Package.sha
+						? `Version: ${Package.version} (${Package.sha.slice(0, 8)})`
+						: `Version: ${Package.version}`
+				}>
 				<div className="flex items-center gap-2">
 					<Info className="w-4" />
 					<div>{t("settings:sections.about")}</div>

webview-ui/src/components/settings/SettingsView.tsx

@@ -99,7 +99,7 @@ const SettingsView = forwardRef<SettingsViewRef, SettingsViewProps>(({ onDone, t
 	const { t } = useAppTranslation()
 
 	const extensionState = useExtensionState()
-	const { currentApiConfigName, listApiConfigMeta, uriScheme, version, settingsImportedAt } = extensionState
+	const { currentApiConfigName, listApiConfigMeta, uriScheme, settingsImportedAt } = extensionState
 
 	const [isDiscardDialogShow, setDiscardDialogShow] = useState(false)
 	const [isChangeDetected, setChangeDetected] = useState(false)
@@ -638,11 +638,7 @@ const SettingsView = forwardRef<SettingsViewRef, SettingsViewProps>(({ onDone, t
 
 					{/* About Section */}
 					{activeTab === "about" && (
-						<About
-							version={version}
-							telemetrySetting={telemetrySetting}
-							setTelemetrySetting={setTelemetrySetting}
-						/>
+						<About telemetrySetting={telemetrySetting} setTelemetrySetting={setTelemetrySetting} />
 					)}
 				</TabContent>
 			</div>

webview-ui/vite.config.ts

@@ -1,5 +1,6 @@
 import { resolve } from "path"
 import fs from "fs"
+import { execSync } from "child_process"
 
 import { defineConfig, type Plugin } from "vite"
 import react from "@vitejs/plugin-react"
@@ -21,18 +22,15 @@ function wasmPlugin(): Plugin {
 	}
 }
 
-// Custom plugin to write the server port to a file
 const writePortToFile = () => {
 	return {
 		name: "write-port-to-file",
 		configureServer(server) {
-			// Write the port to a file when the server starts
 			server.httpServer?.once("listening", () => {
 				const address = server.httpServer.address()
 				const port = typeof address === "object" && address ? address.port : null
 
 				if (port) {
-					// Write to a file in the project root
 					const portFilePath = resolve(__dirname, "../.vite-port")
 					fs.writeFileSync(portFilePath, port.toString())
 					console.log(`[Vite Plugin] Server started on port ${port}`)
@@ -45,46 +43,79 @@ const writePortToFile = () => {
 	}
 }
 
+function getGitSha() {
+	let gitSha: string | undefined = undefined
+
+	try {
+		gitSha = execSync("git rev-parse HEAD").toString().trim()
+	} catch (e) {}
+
+	return gitSha
+}
+
 // https://vitejs.dev/config/
-export default defineConfig(({ mode }) => ({
-	plugins: [react(), tailwindcss(), writePortToFile(), wasmPlugin()],
-	resolve: {
-		alias: {
-			"@": resolve(__dirname, "./src"),
-			"@src": resolve(__dirname, "./src"),
-			"@roo": resolve(__dirname, "../src"),
+export default defineConfig(({ mode }) => {
+	let outDir = "../src/webview-ui/build"
+
+	const define: Record<string, any> = {
+		"process.platform": JSON.stringify(process.platform),
+	}
+
+	// TODO: We can use `@roo-code/build` to generate `define` once the
+	// monorepo is deployed.
+	if (mode === "nightly") {
+		outDir = "../apps/vscode-nightly/build/webview-ui/build"
+
+		const { name, version } = JSON.parse(fs.readFileSync("../apps/vscode-nightly/package.nightly.json", "utf8"))
+
+		define["process.env.PKG_NAME"] = JSON.stringify(name)
+		define["process.env.PKG_VERSION"] = JSON.stringify(version)
+		define["process.env.PKG_OUTPUT_CHANNEL"] = JSON.stringify("Roo-Code-Nightly")
+
+		const gitSha = getGitSha()
+
+		if (gitSha) {
+			define["process.env.PKG_SHA"] = JSON.stringify(gitSha)
+		}
+	}
+
+	return {
+		plugins: [react(), tailwindcss(), writePortToFile(), wasmPlugin()],
+		resolve: {
+			alias: {
+				"@": resolve(__dirname, "./src"),
+				"@src": resolve(__dirname, "./src"),
+				"@roo": resolve(__dirname, "../src"),
+			},
 		},
-	},
-	build: {
-		outDir: mode === "nightly" ? "../apps/vscode-nightly/build/webview-ui/build" : "../src/webview-ui/build",
-		emptyOutDir: true,
-		reportCompressedSize: false,
-		sourcemap: true,
-		rollupOptions: {
-			output: {
-				entryFileNames: `assets/[name].js`,
-				chunkFileNames: `assets/[name].js`,
-				assetFileNames: `assets/[name].[ext]`,
+		build: {
+			outDir,
+			emptyOutDir: true,
+			reportCompressedSize: false,
+			sourcemap: true,
+			rollupOptions: {
+				output: {
+					entryFileNames: `assets/[name].js`,
+					chunkFileNames: `assets/[name].js`,
+					assetFileNames: `assets/[name].[ext]`,
+				},
 			},
 		},
-	},
-	server: {
-		hmr: {
-			host: "localhost",
-			protocol: "ws",
+		server: {
+			hmr: {
+				host: "localhost",
+				protocol: "ws",
+			},
+			cors: {
+				origin: "*",
+				methods: "*",
+				allowedHeaders: "*",
+			},
 		},
-		cors: {
-			origin: "*",
-			methods: "*",
-			allowedHeaders: "*",
+		define,
+		optimizeDeps: {
+			exclude: ["@vscode/codicons", "vscode-oniguruma", "shiki"],
 		},
-	},
-	define: {
-		"process.platform": JSON.stringify(process.platform),
-		"process.env.VSCODE_TEXTMATE_DEBUG": JSON.stringify(process.env.VSCODE_TEXTMATE_DEBUG),
-	},
-	optimizeDeps: {
-		exclude: ["@vscode/codicons", "vscode-oniguruma", "shiki"],
-	},
-	assetsInclude: ["**/*.wasm", "**/*.wav"],
-}))
+		assetsInclude: ["**/*.wasm", "**/*.wav"],
+	}
+})