Update extension name to sagemaker-idle-extension and Add CONTRIBUTING.md

Author: aws-asolidu

patched-vscode/build/gulpfile.extensions.js

@@ -61,7 +61,7 @@ const compilations = [
 	'extensions/search-result/tsconfig.json',
 	'extensions/simple-browser/tsconfig.json',
 	'extensions/sagemaker-extension/tsconfig.json',
-	'extensions/code-editor-idle-extension/tsconfig.json',
+	'extensions/sagemaker-idle-extension/tsconfig.json',
 	'extensions/tunnel-forwarding/tsconfig.json',
 	'extensions/typescript-language-features/test-workspace/tsconfig.json',
 	'extensions/typescript-language-features/web/tsconfig.json',

patched-vscode/build/npm/dirs.js

@@ -40,7 +40,7 @@ const dirs = [
 	'extensions/php-language-features',
 	'extensions/references-view',
 	'extensions/sagemaker-extension',
-	'extensions/code-editor-idle-extension',
+	'extensions/sagemaker-idle-extension',
 	'extensions/search-result',
 	'extensions/simple-browser',
 	'extensions/tunnel-forwarding',

patched-vscode/extensions/code-editor-idle-extension/README.md

@@ -0,0 +1,40 @@
+# Contributing to the Sagemaker Idle Extension
+This guide explains how to make changes to this extension and test them.
+## How to Make Changes
+Changes to the sagemaker-idle-extension are managed by creating patches using the Quilt tool. Follow these steps:
+1. Create a new patch: 
+```
+quilt new sagemaker-idle-extension-v<n>.patch # Replace <n> with the next version number
+```
+2. Make changes and add file 
+```
+quilt add sagemaker-idle-extension-v<n>.patch
+```
+3. Refresh the patch to include your changes:
+```
+quilt refresh
+```
+4. Update the changes in the patched-vsode folder 
+5. Commit your changes and submit a pull request from your personal fork.
+
+## How to Test 
+1. Launch the Extension with Code Editor in local environment: 
+    1. Install Prerequisite tools described [here](https://web.archive.org/web/20231012223533/https://github.com/microsoft/vscode/wiki/How-to-Contribute#prerequisites)  for your operating system.
+    2. Run sh ./scripts/install.sh
+    3. Run yarn watch from within the vscode folder
+    4. Open a new terminal and run ./vscode/scripts/code-server.sh --launch
+
+2. Perform user activity such as file changes, cursor editor movements, and terminal activity 
+3. Verify `lastActiveTimestamp` is updated in the `.sagemaker-last-active-timestamp` file. 
+4. Verify that the `/api/idle` endpoint returns the same `lastActiveTimestamp. 
+
+### Test Cases
+1. File change Detectcion 
+    - Modify a file and ensure the timestamp updates.
+	- Delete a file and verify the timestamp updates.
+2. Text Editor Movement 
+   - Move the text cursor within a file and check for timestamp updates.
+	- Switch between files and verify updates.
+3. Terminal Activity 
+   - Open a new terminal, run a command, and ensure the timestamp updates.
+	- Close the terminal and verify updates.

patched-vscode/extensions/code-editor-idle-extension/.vscodeignore renamed to patched-vscode/extensions/sagemaker-idle-extension/.vscodeignore

@@ -0,0 +1,3 @@
+# Code Editor Idle Extension
+
+The Code Editor Idle Extension tracks user activity and logs the last active timestamp (in UTC) to a local file. User activities monitored include file changes, text editor selection changes, and terminal interactions. Additionally, it provides an API endpoint `/api/idle` that returns the lastActiveTimestamp.

patched-vscode/extensions/sagemaker-idle-extension/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 {
-  "name": "code-editor-idle-extension",
-  "displayName": "Code Editor Idle Extension",
+  "name": "sagemaker-idle-extension",
+  "displayName": "Sagemaker Idle Extension",
   "description": "Expose an API called /idle that returns latest activity timestamp",
   "extensionKind": [
     "workspace"
@@ -27,16 +27,16 @@
   "contributes": {
     "configuration": {
       "type": "object",
-      "title": "Code Editor Idle Extension",
+      "title": "Sagemaker Idle Extension",
       "properties": {}
     },
     "commands": []
   },
   "scripts": {
-    "compile": "gulp compile-extension:code-editor-idle-extension",
-    "watch": "npm run build-preview && gulp watch-extension:code-editor-idle-extension",
+    "compile": "gulp compile-extension:sagemaker-idle-extension",
+    "watch": "npm run build-preview && gulp watch-extension:sagemaker-idle-extension",
     "vscode:prepublish": "npm run build-ext",
-    "build-ext": "node ../../node_modules/gulp/bin/gulp.js --gulpfile ../../build/gulpfile.extensions.js compile-extension:code-editor-idle-extension ./tsconfig.json"
+    "build-ext": "node ../../node_modules/gulp/bin/gulp.js --gulpfile ../../build/gulpfile.extensions.js compile-extension:sagemaker-idle-extension ./tsconfig.json"
   },
   "dependencies": {},
   "repository": {}

patched-vscode/extensions/sagemaker-idle-extension/README.md

@@ -4,6 +4,7 @@ import * as path from "path";
 
 let idleFilePath: string
 let terminalActivityInterval: NodeJS.Timeout | undefined
+const LOG_PREFIX = "[sagemaker-idle-extension]"
 const CHECK_INTERVAL = 60000; // 60 seconds interval
 
 export function activate(context: vscode.ExtensionContext) {
@@ -25,10 +26,10 @@ export function deactivate() {
 function initializeIdleFilePath() {
 	const homeDirectory = process.env.HOME || process.env.USERPROFILE;
 	if (!homeDirectory) {
-		console.log("Unable to determine the home directory.");
+		console.log(`${LOG_PREFIX} Unable to determine the home directory.`);
 		return;
 	}
-	idleFilePath = path.join(homeDirectory, ".code-editor-last-active-timestamp");
+	idleFilePath = path.join(homeDirectory, ".sagemaker-last-active-timestamp");
 }
 
 /**
@@ -66,12 +67,20 @@ const startMonitoringTerminalActivity = () => {
 
 /**
  * Checks for terminal activity by reading the /dev/pts directory and comparing modification times of the files.
- * If activity is detected, it updates the last activity timestamp.
+ * 
+ * The /dev/pts directory is used in Unix-like operating systems to represent pseudo-terminal (PTY) devices.
+ * Each active terminal session is assigned a PTY device. These devices are represented as files within the /dev/pts directory. 
+ * When a terminal session has activity, such as when a user inputs commands or output is written to the terminal, 
+ * the modification time (mtime) of the corresponding PTY device file is updated. By monitoring the modification 
+ * times of the files in the /dev/pts directory, we can detect terminal activity.
+ * 
+ * If activity is detected (i.e., if any PTY device file was modified within the CHECK_INTERVAL), this function
+ * updates the last activity timestamp.
  */
 const checkTerminalActivity = () => {
 	fs.readdir("/dev/pts", (err, files) => {
 		if (err) {
-			console.error("Error reading /dev/pts directory:", err);
+			console.error(`${LOG_PREFIX} Error reading /dev/pts directory:`, err);
 			return;
 		}
 
@@ -83,7 +92,7 @@ const checkTerminalActivity = () => {
 				const mtime = new Date(stats.mtime).getTime();
 				return now - mtime < CHECK_INTERVAL;
 			} catch (error) {
-				console.error("Error reading file stats:", error);
+				console.error(`${LOG_PREFIX}}Error reading file stats:`, error);
 				return false;
 			}
 		});
@@ -95,7 +104,7 @@ const checkTerminalActivity = () => {
 };
 
 /**
- * Updates the last activity timestamp by writing the current timestamp to the idle file and updating the status bar.
+ * Updates the last activity timestamp by writing the current timestamp to the idle file.
  */
 function updateLastActivityTimestamp() {
 	const timestamp = new Date().toISOString();