Allow changing port number of competitive companion (Fixes #42)

Also allow disabling/enabling listening to competitive companion

Author: sam20908

README.md

@@ -158,6 +158,7 @@ Required files (naming scheme can be configured in settings):
   - `askForWhichFile` (default: `false`): Ask for which file to write testcase onto, even when a file is currently opened and only a single problem has been received
   - `includePattern` (default: `**/*`): Glob pattern to filter in the included files for asking prompt
   - `excludePattern` (default: *empty*): Glob pattern to filter out the included files for asking prompt
+  - `port` (default: *1327*): Port number to listen from Competitive Companion
 </details>
 
 ---

package.json

@@ -157,6 +157,12 @@
 			{
 				"title": "Competitive Companion",
 				"properties": {
+					"fastolympiccoding.port": {
+						"type": "number",
+						"default": 1327,
+						"minimum": 1024,
+						"description": "Port number to listen for Competitive Companion"
+					},
 					"fastolympiccoding.openSelectedFiles": {
 						"type": "boolean",
 						"default": true,
@@ -220,7 +226,17 @@
 				"command": "fastolympiccoding.insertFileTemplate",
 				"title": "Insert File Template",
 				"category": "Fast Olympic Coding"
-			}
+			},
+			{
+				"command": "fastolympiccoding.listenForCompetitiveCompanion",
+				"title": "Listen for Competitive Companion",
+				"category": "Fast Olympic Coding"
+			},
+			{
+				"command": "fastolympiccoding.stopCompetitiveCompanion",
+				"title": "Stop Competitive Companion",
+				"category": "Fast Olympic Coding"
+			}	
 		],
 		"keybindings": [
 			{

src/extension.ts

@@ -11,6 +11,9 @@ import StressViewProvider from './views/stress/provider/StressViewProvider';
 
 let judgeViewProvider: JudgeViewProvider;
 let stressViewProvider: StressViewProvider;
+let competitiveCompanionServer: http.Server | undefined = undefined;
+
+let competitiveCompanionStatusItem: vscode.StatusBarItem;
 
 function registerViewProviders(context: vscode.ExtensionContext): void {
 	judgeViewProvider = new JudgeViewProvider(context);
@@ -176,12 +179,29 @@ function registerCommands(context: vscode.ExtensionContext): void {
 			},
 		),
 	);
+
+	context.subscriptions.push(
+		vscode.commands.registerCommand(
+			'fastolympiccoding.listenForCompetitiveCompanion',
+			() => listenForCompetitiveCompanion(),
+		),
+	);
+	context.subscriptions.push(
+		vscode.commands.registerCommand(
+			'fastolympiccoding.stopCompetitiveCompanion',
+			() => stopCompetitiveCompanion(),
+		),
+	);
 }
 
 function listenForCompetitiveCompanion() {
+	if (competitiveCompanionServer !== undefined) {
+		return;
+	}
+
 	let problemDatas: IProblem[] = [];
 	let cnt = 0;
-	const server = http.createServer((req, res) => {
+	competitiveCompanionServer = http.createServer((req, res) => {
 		if (req.method !== 'POST') {
 			res.end();
 			return;
@@ -194,7 +214,7 @@ function listenForCompetitiveCompanion() {
 		});
 		req.on('end', () => {
 			void (async () => {
-				res.end();
+				res.end(() => req.socket.unref());
 
 				problemDatas.push(JSON.parse(ccData) as IProblem);
 				if (problemDatas.length === 0) {
@@ -296,25 +316,56 @@ function listenForCompetitiveCompanion() {
 			})();
 		});
 	});
-	server.listen(1327);
+
+	competitiveCompanionServer.once('connection', (socket) => {
+		socket.unref();
+	});
+	competitiveCompanionServer.once('listening', () => {
+		competitiveCompanionStatusItem.show();
+	});
+	competitiveCompanionServer.once('error', (error) =>
+		vscode.window.showErrorMessage(
+			`Competitive Companion listener error: ${error}`,
+		),
+	);
+	competitiveCompanionServer.once('close', () => {
+		competitiveCompanionServer = undefined;
+		competitiveCompanionStatusItem.hide();
+	});
+
+	const config = vscode.workspace.getConfiguration('fastolympiccoding');
+	// biome-ignore lint/style/noNonNullAssertion: Default value provided by VSCode
+	const port = config.get<number>('port')!;
+	competitiveCompanionServer.listen(port);
 }
 
-function addActiveStatus(context: vscode.ExtensionContext): void {
-	const statusItem = vscode.window.createStatusBarItem(
-		'fastolympiccoding.active',
+function stopCompetitiveCompanion() {
+	if (competitiveCompanionServer === undefined) {
+		return;
+	}
+
+	competitiveCompanionServer.close();
+}
+
+function createCompetitiveCompanionStatus(context: vscode.ExtensionContext) {
+	const competitiveCompanionStatus = vscode.window.createStatusBarItem(
+		'fastolympiccoding.listeningForCompetitiveCompanion',
 		vscode.StatusBarAlignment.Left,
 	);
-	statusItem.name = 'Fast Olympic Coding Indicator';
-	statusItem.text = '$(zap)';
-	statusItem.tooltip = 'Fast Olympic Coding is Active';
-	statusItem.show();
-	context.subscriptions.push(statusItem);
+	competitiveCompanionStatus.name = 'Competitive Companion Indicator';
+	competitiveCompanionStatus.text = '$(zap)';
+	competitiveCompanionStatus.tooltip = 'Listening For Competitive Companion';
+	competitiveCompanionStatus.hide();
+	context.subscriptions.push(competitiveCompanionStatus);
+
+	return competitiveCompanionStatus;
 }
 
 export function activate(context: vscode.ExtensionContext): void {
 	registerViewProviders(context);
 	registerCommands(context);
 	registerDocumentContentProviders(context);
 	listenForCompetitiveCompanion();
-	addActiveStatus(context);
+
+	competitiveCompanionStatusItem = createCompetitiveCompanionStatus(context);
 }