添加工作流文件

This commit is contained in:
2025-11-18 14:04:48 +08:00
parent 515ab4ff91
commit ef67c1bb2c
3 changed files with 457 additions and 198 deletions

View File

@@ -0,0 +1,59 @@
name: CI/CD Pipeline for DevStar Extension
on:
push:
branches:
- main
pull_request:
branches:
- main
jobs:
build:
runs-on: ubuntu-latest
container:
image: gitea/runner-images:ubuntu-latest
steps:
- name: 拉取代码
uses: https://devstar.cn/actions/checkout@v4
with:
fetch-depth: 0
- name: 安装依赖
run: |
npm install
- name: 构建插件
run: |
webpack --mode production && vsce package
- name: 上传构建产物
uses: https://devstar.cn/actions/upload-artifact@v4
with:
name: devstar-extension
path: "*.vsix"
publish:
needs: build
runs-on: ubuntu-latest
if: gitea.ref == 'refs/heads/main'
steps:
- name: 拉取代码
uses: https://devstar.cn/actions/checkout@v4
- name: 安装依赖
run: |
npm install
- name: 发布到 VSCode 市场
run: vsce publish
env:
VSCE_PAT: ${{ secrets.VSCE_PAT }}
- name: 更新版本标签
run: |
version=$(node -p "require('./package.json').version")
git config --local user.email "ci@devstar.cn"
git config --local user.name "DevStar CI"
git tag -a "v$version" -m "Release version $version"
git push origin "v$version"

View File

@@ -178,6 +178,11 @@ export class DevStarExtension {
vscode.commands.registerCommand('devstar.showHome', () => vscode.commands.registerCommand('devstar.showHome', () =>
this.dsHome.toggle() this.dsHome.toggle()
), ),
vscode.commands.registerCommand('devstar.showPortMappings', () => {
// 这里需要根据当前活动连接获取hostname和port
// 简化实现:显示所有活动的端口映射
this.remoteContainer.showPortMappingsInOutputChannel('current', 0);
}),
vscode.commands.registerCommand('devstar.clean', () => { vscode.commands.registerCommand('devstar.clean', () => {
// 先清除ssh key // 先清除ssh key
if (fs.existsSync(this.user.getUserPrivateKeyPath())) { if (fs.existsSync(this.user.getUserPrivateKeyPath())) {

View File

@@ -3,8 +3,8 @@ import * as fs from 'fs';
import * as path from 'path'; import * as path from 'path';
import * as os from 'os'; import * as os from 'os';
import * as vscode from 'vscode'; import * as vscode from 'vscode';
import * as rd from 'readline' import * as rd from 'readline';
const { NodeSSH } = require('node-ssh') const { NodeSSH } = require('node-ssh');
const { spawn } = require('child_process'); const { spawn } = require('child_process');
const net = require('net'); const net = require('net');
@@ -15,68 +15,56 @@ import DevstarAPIHandler from './devstar-api';
export default class RemoteContainer { export default class RemoteContainer {
private user: User; private user: User;
private sshProcesses?: Map<string, any>; private sshProcesses?: Map<string, any>;
private portMappings: Map<string, Array<{containerPort: number, localPort: number, label: string, source: string}>> = new Map();
private statusBarItems?: Map<string, vscode.StatusBarItem>;
constructor(user: User) { constructor(user: User) {
this.user = user this.user = user;
} }
public setUser(user: User) { public setUser(user: User) {
this.user = user this.user = user;
} }
/** /**
* 第一次打开远程项目 * 第一次打开远程项目
*
* 远程环境先创建local窗口在通过命令行调用url打开目前仅支持vscode协议
* @param host 项目名称
* @param hostname ip
* @param port
* @param username
* @param path
* @param context 用于支持远程项目环境
*/ */
async firstOpenProject(host: string, hostname: string, port: number, username: string, path: string, context: vscode.ExtensionContext) { async firstOpenProject(host: string, hostname: string, port: number, username: string, path: string, context: vscode.ExtensionContext) {
console.log(`[RemoteContainer] firstOpenProject called with:`, { host, hostname, port, username, path }); console.log(`[RemoteContainer] firstOpenProject called with:`, { host, hostname, port, username, path });
if (vscode.env.remoteName) { if (vscode.env.remoteName) {
// 远程环境 // 远程环境
console.log(`[RemoteContainer] Running in remote environment: ${vscode.env.remoteName}`); console.log(`[RemoteContainer] Running in remote environment: ${vscode.env.remoteName}`);
try { try {
await vscode.commands.executeCommand('workbench.action.terminal.newLocal'); await vscode.commands.executeCommand('workbench.action.terminal.newLocal');
const terminal = vscode.window.terminals[vscode.window.terminals.length - 1]; const terminal = vscode.window.terminals[vscode.window.terminals.length - 1];
if (terminal) {
let devstarDomain: string | undefined = context.globalState.get("devstarDomain_" + vscode.env.sessionId)
if (devstarDomain == undefined || devstarDomain == "")
devstarDomain = undefined
// vscode协议 if (terminal) {
// 根据系统+命令行版本确定命令 let devstarDomain: string | undefined = context.globalState.get("devstarDomain_" + vscode.env.sessionId);
const semver = require('semver') if (devstarDomain == undefined || devstarDomain == "") {
const powershellVersion = context.globalState.get('powershellVersion') devstarDomain = undefined;
const powershell_semver_compatible_version = semver.coerce(powershellVersion) }
const semver = require('semver');
const powershellVersion = context.globalState.get('powershellVersion');
const powershell_semver_compatible_version = semver.coerce(powershellVersion);
let command = ''; let command = '';
if (devstarDomain === undefined) { if (devstarDomain === undefined) {
// 不传递devstarDomain
if (powershellVersion === undefined) { if (powershellVersion === undefined) {
command = `code --new-window && code --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}"`; command = `code --new-window && code --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}"`;
} else if (semver.satisfies(powershell_semver_compatible_version, ">=5.1.26100")) { } else if (semver.satisfies(powershell_semver_compatible_version, ">=5.1.26100")) {
// win & powershell >= 5.1.26100.0
command = `code --new-window ; code --% --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}"`; command = `code --new-window ; code --% --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}"`;
} else { } else {
// win & powershell < 5.1.26100.0
command = `code --new-window && code --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}"`; command = `code --new-window && code --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}"`;
} }
} else { } else {
if (powershellVersion === undefined) { if (powershellVersion === undefined) {
command = `code --new-window && code --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}&devstar_domain=${devstarDomain}"`; command = `code --new-window && code --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}&devstar_domain=${devstarDomain}"`;
} else if (semver.satisfies(powershell_semver_compatible_version, ">=5.1.26100")) { } else if (semver.satisfies(powershell_semver_compatible_version, ">=5.1.26100")) {
// win & powershell >= 5.1.26100.0
command = `code --new-window ; code --% --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}&devstar_domain=${devstarDomain}"`; command = `code --new-window ; code --% --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}&devstar_domain=${devstarDomain}"`;
} else { } else {
// win & powershell < 5.1.26100.0
command = `code --new-window && code --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}&devstar_domain=${devstarDomain}"`; command = `code --new-window && code --open-url "vscode://mengning.devstar/openProjectSkippingLoginCheck?host=${host}&hostname=${hostname}&port=${port}&username=${username}&path=${path}&devstar_domain=${devstarDomain}"`;
} }
} }
@@ -95,12 +83,10 @@ export default class RemoteContainer {
} else { } else {
console.log(`[RemoteContainer] Running in local environment, attempting firstConnect`); console.log(`[RemoteContainer] Running in local environment, attempting firstConnect`);
try { try {
//传入真实IP
await this.firstConnect(host, hostname, username, port, path) await this.firstConnect(host, hostname, username, port, path)
.then((res) => { .then((res) => {
if (res === 'success') { if (res === 'success') {
console.log(`[RemoteContainer] firstConnect succeeded, opening remote folder`); console.log(`[RemoteContainer] firstConnect succeeded, opening remote folder`);
// only success then open folder
this.openRemoteFolder(host, port, username, path); this.openRemoteFolder(host, port, username, path);
} else { } else {
console.error(`[RemoteContainer] firstConnect returned: ${res}`); console.error(`[RemoteContainer] firstConnect returned: ${res}`);
@@ -122,19 +108,13 @@ export default class RemoteContainer {
/** /**
* local environment第一次连接其他项目 * local environment第一次连接其他项目
* @param host 项目名称
* @param hostname ip
* @param username
* @param port
* @param projectPath 项目路径用于查找devcontainer.json
* @returns 成功返回success
*/ */
async firstConnect(host: string, hostname: string, username: string, port: number, projectPath?: string): Promise<string> { async firstConnect(host: string, hostname: string, username: string, port: number, projectPath?: string): Promise<string> {
console.log(`[RemoteContainer] firstConnect called with:`, { host, hostname, username, port, projectPath }); console.log(`[RemoteContainer] firstConnect called with:`, { host, hostname, username, port, projectPath });
return new Promise(async (resolve, reject) => { return new Promise(async (resolve, reject) => {
const ssh = new NodeSSH(); const ssh = new NodeSSH();
vscode.window.withProgress({ vscode.window.withProgress({
location: vscode.ProgressLocation.Notification, location: vscode.ProgressLocation.Notification,
title: vscode.l10n.t("Installing vscode-server and devstar extension in container"), title: vscode.l10n.t("Installing vscode-server and devstar extension in container"),
@@ -142,18 +122,16 @@ export default class RemoteContainer {
}, async (progress) => { }, async (progress) => {
try { try {
console.log(`[RemoteContainer] Checking SSH keys existence`); console.log(`[RemoteContainer] Checking SSH keys existence`);
// 检查公私钥是否存在,如果不存在,需要创建
if (!this.user.existUserPrivateKey() || !this.user.existUserPublicKey()) { if (!this.user.existUserPrivateKey() || !this.user.existUserPublicKey()) {
console.log(`[RemoteContainer] SSH keys not found, creating new keys`); console.log(`[RemoteContainer] SSH keys not found, creating new keys`);
await this.user.createUserSSHKey() await this.user.createUserSSHKey();
// 上传公钥
console.log(`[RemoteContainer] Uploading public key`); console.log(`[RemoteContainer] Uploading public key`);
const devstarAPIHandler = new DevstarAPIHandler() const devstarAPIHandler = new DevstarAPIHandler();
const uploadResult = await devstarAPIHandler.uploadUserPublicKey(this.user) const uploadResult = await devstarAPIHandler.uploadUserPublicKey(this.user);
if (uploadResult !== "ok") { if (uploadResult !== "ok") {
throw new Error('Upload public key failed.') throw new Error('Upload public key failed.');
} }
console.log(`[RemoteContainer] Public key uploaded successfully`); console.log(`[RemoteContainer] Public key uploaded successfully`);
} else { } else {
@@ -161,44 +139,41 @@ export default class RemoteContainer {
} }
} catch (error) { } catch (error) {
const errorMessage = error instanceof Error ? error.message : '未知错误'; const errorMessage = error instanceof Error ? error.message : '未知错误';
console.error("[RemoteContainer] Failed to first connect container - SSH key setup: ", error) console.error("[RemoteContainer] Failed to first connect container - SSH key setup: ", error);
reject(error); reject(error);
return; return;
} }
// 本地环境
try { try {
console.log(`[RemoteContainer] Attempting SSH connection to ${hostname}:${port} as ${username}`); console.log(`[RemoteContainer] Attempting SSH connection to ${hostname}:${port} as ${username}`);
// connect with key
await ssh.connect({ await ssh.connect({
host: hostname, host: hostname,
username: 'root', username: 'root',
port: port, port: port,
privateKeyPath: this.user.getUserPrivateKeyPath(), privateKeyPath: this.user.getUserPrivateKeyPath(),
readyTimeout: 30000, // 增加超时时间到30秒 readyTimeout: 30000,
onKeyboardInteractive: ( onKeyboardInteractive: (
_name: string, _name: string,
_instructions: string, _instructions: string,
_instructionsLang: string, _instructionsLang: string,
_prompts: any[], _prompts: any[],
finish: (responses: string[]) => void finish: (responses: string[]) => void
) => { ) => {
console.log(`[RemoteContainer] Keyboard interactive authentication required`); console.log(`[RemoteContainer] Keyboard interactive authentication required`);
finish([]); finish([]);
} }
}); });
console.log(`[RemoteContainer] SSH connection established successfully`); console.log(`[RemoteContainer] SSH connection established successfully`);
progress.report({ message: vscode.l10n.t("Connected! Start installation") }); progress.report({ message: vscode.l10n.t("Connected! Start installation") });
// install vscode-server and devstar extension
console.log(`[RemoteContainer] Getting VSCode commit ID`); console.log(`[RemoteContainer] Getting VSCode commit ID`);
const vscodeCommitId = await utils.getVsCodeCommitId() const vscodeCommitId = await utils.getVsCodeCommitId();
if ("" != vscodeCommitId) { if ("" !== vscodeCommitId) {
console.log(`[RemoteContainer] VSCode commit ID: ${vscodeCommitId}`); console.log(`[RemoteContainer] VSCode commit ID: ${vscodeCommitId}`);
const vscodeServerUrl = `https://vscode.download.prss.microsoft.com/dbazure/download/stable/${vscodeCommitId}/vscode-server-linux-x64.tar.gz` const vscodeServerUrl = `https://vscode.download.prss.microsoft.com/dbazure/download/stable/${vscodeCommitId}/vscode-server-linux-x64.tar.gz`;
const installVscodeServerScript = ` const installVscodeServerScript = `
mkdir -p ~/.vscode-server/bin/${vscodeCommitId} && \\ mkdir -p ~/.vscode-server/bin/${vscodeCommitId} && \\
if [ "$(ls -A ~/.vscode-server/bin/${vscodeCommitId})" ]; then if [ "$(ls -A ~/.vscode-server/bin/${vscodeCommitId})" ]; then
@@ -214,17 +189,17 @@ export default class RemoteContainer {
~/.vscode-server/bin/${vscodeCommitId}/bin/code-server --install-extension mengning.devstar ~/.vscode-server/bin/${vscodeCommitId}/bin/code-server --install-extension mengning.devstar
fi fi
`; `;
console.log(`[RemoteContainer] Executing installation script`); console.log(`[RemoteContainer] Executing installation script`);
const installResult = await ssh.execCommand(installVscodeServerScript); const installResult = await ssh.execCommand(installVscodeServerScript);
if (installResult.code === 0) { if (installResult.code === 0) {
console.log("[RemoteContainer] VSCode server and extension installed successfully"); console.log("[RemoteContainer] VSCode server and extension installed successfully");
console.log("[RemoteContainer] Installation stdout:", installResult.stdout); console.log("[RemoteContainer] Installation stdout:", installResult.stdout);
if (installResult.stderr) { if (installResult.stderr) {
console.warn("[RemoteContainer] Installation stderr:", installResult.stderr); console.warn("[RemoteContainer] Installation stderr:", installResult.stderr);
} }
vscode.window.showInformationMessage(vscode.l10n.t('Installation completed!')); vscode.window.showInformationMessage(vscode.l10n.t('Installation completed!'));
} else { } else {
console.error("[RemoteContainer] Installation failed with code:", installResult.code); console.error("[RemoteContainer] Installation failed with code:", installResult.code);
@@ -235,34 +210,26 @@ export default class RemoteContainer {
throw new Error('Failed to get VSCode commit ID'); throw new Error('Failed to get VSCode commit ID');
} }
// 设置端口映射(如果提供了项目路径) // 移除端口映射设置,移到 openRemoteFolder 中
// 只记录项目路径信息,供后续使用
if (projectPath) { if (projectPath) {
progress.report({ message: vscode.l10n.t("Setting up port mappings") }); console.log(`[RemoteContainer] Project path recorded for port forwarding: ${projectPath}`);
try { // 这里可以存储项目路径信息,但不在第一次连接时建立端口映射
await this.setupPortForwarding(hostname, port, projectPath);
console.log(`[RemoteContainer] Port mappings established successfully`);
} catch (portError) {
console.warn(`[RemoteContainer] Port forwarding setup failed:`, portError);
// 端口映射失败不应阻止主要功能
vscode.window.showWarningMessage('端口映射设置失败,但容器连接已建立');
}
} }
await ssh.dispose(); await ssh.dispose();
console.log(`[RemoteContainer] SSH connection disposed`); console.log(`[RemoteContainer] SSH connection disposed`);
// only connect successfully then save the host info
console.log(`[RemoteContainer] Storing project SSH info`); console.log(`[RemoteContainer] Storing project SSH info`);
await this.storeProjectSSHInfo(host, hostname, port, 'root') await this.storeProjectSSHInfo(host, hostname, port, 'root');
resolve('success') resolve('success');
} catch (error) { } catch (error) {
const errorMessage = error instanceof Error ? error.message : '未知错误'; const errorMessage = error instanceof Error ? error.message : '未知错误';
console.error('[RemoteContainer] Failed to install vscode-server and extension: ', error); console.error('[RemoteContainer] Failed to install vscode-server and extension: ', error);
try { try {
await ssh.dispose(); await ssh.dispose();
} catch (disposeError) { } catch (disposeError) {
const disposeErrorMessage = disposeError instanceof Error ? disposeError.message : '未知错误';
console.error('[RemoteContainer] Error disposing SSH connection: ', disposeError); console.error('[RemoteContainer] Error disposing SSH connection: ', disposeError);
} }
reject(error); reject(error);
@@ -274,24 +241,30 @@ export default class RemoteContainer {
/** /**
* 从 devcontainer.json 中提取端口映射配置 * 从 devcontainer.json 中提取端口映射配置
*/ */
private async getPortsAttributesFromDevContainer(ssh: any, containerPath: string): Promise<any> { private async getPortsConfigFromDevContainer(ssh: any, containerPath: string): Promise<{
portsAttributes: any;
forwardPorts?: number[];
otherPortsAttributes?: any;
}> {
try { try {
console.log(`[RemoteContainer] Looking for devcontainer.json at: ${containerPath}`); console.log(`[RemoteContainer] Looking for devcontainer.json at: ${containerPath}`);
// 在容器中查找 devcontainer.json 文件
const findResult = await ssh.execCommand(`find ${containerPath} -name "devcontainer.json" -type f`); const findResult = await ssh.execCommand(`find ${containerPath} -name "devcontainer.json" -type f`);
if (findResult.code === 0 && findResult.stdout.trim()) { if (findResult.code === 0 && findResult.stdout.trim()) {
const devcontainerPath = findResult.stdout.trim().split('\n')[0]; // 取第一个找到的文件 const devcontainerPath = findResult.stdout.trim().split('\n')[0];
console.log(`[RemoteContainer] Found devcontainer.json at: ${devcontainerPath}`); console.log(`[RemoteContainer] Found devcontainer.json at: ${devcontainerPath}`);
// 读取 devcontainer.json 内容
const readResult = await ssh.execCommand(`cat ${devcontainerPath}`); const readResult = await ssh.execCommand(`cat ${devcontainerPath}`);
if (readResult.code === 0) { if (readResult.code === 0) {
const devcontainerConfig = JSON.parse(readResult.stdout); const devcontainerConfig = JSON.parse(readResult.stdout);
console.log(`[RemoteContainer] Parsed devcontainer.json:`, devcontainerConfig); console.log(`[RemoteContainer] Parsed devcontainer.json:`, devcontainerConfig);
return devcontainerConfig.portsAttributes || {}; return {
portsAttributes: devcontainerConfig.portsAttributes || {},
forwardPorts: devcontainerConfig.forwardPorts,
otherPortsAttributes: devcontainerConfig.otherPortsAttributes
};
} }
} else { } else {
console.log(`[RemoteContainer] No devcontainer.json found in ${containerPath}`); console.log(`[RemoteContainer] No devcontainer.json found in ${containerPath}`);
@@ -299,64 +272,67 @@ export default class RemoteContainer {
} catch (error) { } catch (error) {
console.error(`[RemoteContainer] Error reading devcontainer.json:`, error); console.error(`[RemoteContainer] Error reading devcontainer.json:`, error);
} }
return {}; return { portsAttributes: {} };
} }
/** /**
* 建立端口映射 * 查找可用的本地端口 - 优先使用相同端口
*/ */
private async setupPortForwarding(hostname: string, port: number, containerPath: string): Promise<void> { private async findAvailableLocalPort(containerPort: number): Promise<number> {
console.log(`[RemoteContainer] Setting up port forwarding for ${hostname}:${port}`); // 首先尝试使用相同的端口号
if (await this.isPortAvailable(containerPort)) {
const ssh = new NodeSSH(); console.log(`[RemoteContainer] Using same port: ${containerPort}`);
return containerPort;
try {
// 连接到容器
await ssh.connect({
host: hostname,
username: 'root',
port: port,
privateKeyPath: this.user.getUserPrivateKeyPath(),
readyTimeout: 30000,
});
// 获取端口配置
const portsAttributes = await this.getPortsAttributesFromDevContainer(ssh, containerPath);
console.log(`[RemoteContainer] Ports attributes found:`, portsAttributes);
// 建立端口映射
for (const [containerPortStr, attributes] of Object.entries(portsAttributes)) {
const containerPort = parseInt(containerPortStr);
if (!isNaN(containerPort)) {
// 查找可用的本地端口
const localPort = await this.findAvailableLocalPort();
// 建立 SSH 端口转发
await this.createSSHPortForward(hostname, port, containerPort, localPort);
console.log(`[RemoteContainer] Port mapping established: localhost:${localPort} -> container:${containerPort}`);
// 显示通知
const label = (attributes as any).label || `Port ${containerPort}`;
vscode.window.showInformationMessage(
`端口映射: ${label} -> http://localhost:${localPort}`
);
}
}
await ssh.dispose();
} catch (error) {
console.error(`[RemoteContainer] Error setting up port forwarding:`, error);
await ssh.dispose();
throw error;
} }
// 如果相同端口被占用,尝试在附近查找可用端口
console.log(`[RemoteContainer] Port ${containerPort} is occupied, finding alternative...`);
// 在 containerPort ± 10 范围内查找
for (let offset = 1; offset <= 10; offset++) {
// 尝试 containerPort + offset
const port1 = containerPort + offset;
if (port1 < 65536 && await this.isPortAvailable(port1)) {
console.log(`[RemoteContainer] Using alternative port: ${port1}`);
return port1;
}
// 尝试 containerPort - offset
const port2 = containerPort - offset;
if (port2 > 0 && await this.isPortAvailable(port2)) {
console.log(`[RemoteContainer] Using alternative port: ${port2}`);
return port2;
}
}
// 如果附近端口都被占用,使用随机端口
console.log(`[RemoteContainer] No nearby ports available, using random port`);
return this.findRandomAvailablePort();
} }
/** /**
* 查找可用的本地端口 * 检查端口是否可用
*/ */
private async findAvailableLocalPort(): Promise<number> { private async isPortAvailable(port: number): Promise<boolean> {
return new Promise((resolve) => {
const server = net.createServer();
server.unref();
server.on('error', () => {
resolve(false);
});
server.listen(port, () => {
server.close(() => {
resolve(true);
});
});
});
}
/**
* 查找随机可用端口
*/
private async findRandomAvailablePort(): Promise<number> {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
const server = net.createServer(); const server = net.createServer();
server.unref(); server.unref();
@@ -370,45 +346,127 @@ export default class RemoteContainer {
}); });
} }
/**
* 建立端口映射 - 根据 devcontainer.json 配置
*/
private async setupPortForwarding(hostname: string, port: number, containerPath: string): Promise<void> {
console.log(`[RemoteContainer] Setting up port forwarding for ${hostname}:${port}`);
const ssh = new NodeSSH();
const portMappings: Array<{ containerPort: number, localPort: number, label: string, source: string }> = [];
try {
await ssh.connect({
host: hostname,
username: 'root',
port: port,
privateKeyPath: this.user.getUserPrivateKeyPath(),
readyTimeout: 30000,
});
// 获取完整的端口配置
const portsConfig = await this.getPortsConfigFromDevContainer(ssh, containerPath);
console.log(`[RemoteContainer] Ports config found:`, portsConfig);
// 1. 首先处理 forwardPorts显式指定的端口
if (portsConfig.forwardPorts && portsConfig.forwardPorts.length > 0) {
for (const containerPort of portsConfig.forwardPorts) {
const localPort = await this.findAvailableLocalPort(containerPort);
await this.createSSHPortForward(hostname, port, containerPort, localPort);
portMappings.push({
containerPort,
localPort,
label: `Port ${containerPort}`,
source: 'forwardPorts'
});
console.log(`[RemoteContainer] ForwardPorts mapping: localhost:${localPort} -> container:${containerPort}`);
}
}
// 2. 处理 portsAttributes 配置的端口
for (const [containerPortStr, attributes] of Object.entries(portsConfig.portsAttributes)) {
const containerPort = parseInt(containerPortStr);
if (!isNaN(containerPort)) {
// 检查是否已经在 forwardPorts 中处理过
const alreadyMapped = portMappings.some(m => m.containerPort === containerPort);
if (!alreadyMapped) {
const localPort = await this.findAvailableLocalPort(containerPort);
await this.createSSHPortForward(hostname, port, containerPort, localPort);
const label = (attributes as any).label || `Port ${containerPort}`;
portMappings.push({
containerPort,
localPort,
label,
source: 'portsAttributes'
});
console.log(`[RemoteContainer] PortsAttributes mapping: localhost:${localPort} -> container:${containerPort}`);
}
}
}
await ssh.dispose();
// 存储端口映射信息
const mappingKey = `${hostname}:${port}`;
this.portMappings.set(mappingKey, portMappings);
// 显示映射汇总信息
if (portMappings.length > 0) {
this.showPortMappingsSummary(portMappings);
// 注册命令以便后续查看
this.registerPortMappingsCommands(mappingKey, portMappings);
}
} catch (error) {
console.error(`[RemoteContainer] Error setting up port forwarding:`, error);
await ssh.dispose();
throw error;
}
}
/** /**
* 创建 SSH 端口转发 * 创建 SSH 端口转发
*/ */
private async createSSHPortForward(hostname: string, sshPort: number, containerPort: number, localPort: number): Promise<void> { private async createSSHPortForward(hostname: string, sshPort: number, containerPort: number, localPort: number): Promise<void> {
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
const sshArgs = [ const sshArgs = [
'-N', // 不执行远程命令 '-N',
'-L', // 本地端口转发 '-L',
`${localPort}:localhost:${containerPort}`, // 转发规则 `${localPort}:localhost:${containerPort}`,
'-o', 'StrictHostKeyChecking=no', '-o', 'StrictHostKeyChecking=no',
'-o', 'UserKnownHostsFile=/dev/null', '-o', 'UserKnownHostsFile=/dev/null',
'-p', sshPort.toString(), '-p', sshPort.toString(),
'-i', this.user.getUserPrivateKeyPath(), '-i', this.user.getUserPrivateKeyPath(),
`root@${hostname}` `root@${hostname}`
]; ];
const sshProcess = spawn('ssh', sshArgs); const sshProcess = spawn('ssh', sshArgs);
sshProcess.on('error', (error: Error) => { sshProcess.on('error', (error: Error) => {
console.error(`[RemoteContainer] SSH port forward error:`, error); console.error(`[RemoteContainer] SSH port forward error:`, error);
reject(error); reject(error);
}); });
sshProcess.stdout.on('data', (data: Buffer) => { sshProcess.stdout.on('data', (data: Buffer) => {
console.log(`[RemoteContainer] SSH stdout:`, data.toString()); console.log(`[RemoteContainer] SSH stdout:`, data.toString());
}); });
sshProcess.stderr.on('data', (data: Buffer) => { sshProcess.stderr.on('data', (data: Buffer) => {
console.log(`[RemoteContainer] SSH stderr:`, data.toString()); console.log(`[RemoteContainer] SSH stderr:`, data.toString());
}); });
// 存储进程引用以便后续管理(可选) // 存储进程引用以便后续管理
if (!this.sshProcesses) { if (!this.sshProcesses) {
this.sshProcesses = new Map(); this.sshProcesses = new Map();
} }
const key = `${hostname}:${sshPort}:${containerPort}`; const key = `${hostname}:${sshPort}:${containerPort}`;
this.sshProcesses.set(key, sshProcess); this.sshProcesses.set(key, sshProcess);
// 等待一段时间确保连接建立
setTimeout(() => { setTimeout(() => {
console.log(`[RemoteContainer] SSH port forward established: ${localPort} -> ${hostname}:${containerPort}`); console.log(`[RemoteContainer] SSH port forward established: ${localPort} -> ${hostname}:${containerPort}`);
resolve(); resolve();
@@ -416,29 +474,142 @@ export default class RemoteContainer {
}); });
} }
/**
* 显示端口映射汇总信息
*/
private showPortMappingsSummary(portMappings: Array<{ containerPort: number, localPort: number, label: string, source: string }>): void {
let message = `🎯 已建立 ${portMappings.length} 个端口映射:\n\n`;
portMappings.forEach(mapping => {
const samePort = mapping.containerPort === mapping.localPort ? " ✅" : " 🔄";
message += `${mapping.label}\n`;
message += ` 容器端口: ${mapping.containerPort} → 本地端口: ${mapping.localPort}${samePort}\n`;
message += ` 访问地址: http://localhost:${mapping.localPort}\n`;
message += ` 配置来源: ${mapping.source}\n\n`;
});
vscode.window.showInformationMessage(message, '复制映射信息', '在浏览器中打开', '查看详细信息')
.then(selection => {
if (selection === '复制映射信息') {
const copyText = portMappings.map(m =>
`${m.label}: http://localhost:${m.localPort} (容器端口: ${m.containerPort})`
).join('\n');
vscode.env.clipboard.writeText(copyText);
vscode.window.showInformationMessage('端口映射信息已复制到剪贴板');
} else if (selection === '在浏览器中打开' && portMappings.length > 0) {
// 打开第一个映射的地址
vscode.env.openExternal(vscode.Uri.parse(`http://localhost:${portMappings[0].localPort}`));
} else if (selection === '查看详细信息') {
this.showPortMappingsInOutputChannel('current', 0);
}
});
}
/**
* 注册端口映射查看命令
*/
private registerPortMappingsCommands(mappingKey: string, portMappings: Array<{containerPort: number, localPort: number, label: string, source: string}>): void {
// 注册一个全局命令来显示端口映射信息
const showPortMappingsCommand = `devstar.showPortMappings.${mappingKey.replace(/[^a-zA-Z0-9]/g, '_')}`;
vscode.commands.registerCommand(showPortMappingsCommand, () => {
this.showPortMappingsSummary(portMappings);
});
// 在状态栏显示端口映射信息
this.createStatusBarItem(mappingKey, portMappings);
}
/**
* 创建状态栏项目
*/
private createStatusBarItem(mappingKey: string, portMappings: Array<{containerPort: number, localPort: number, label: string, source: string}>): void {
if (portMappings.length === 0) return;
const statusBarItem = vscode.window.createStatusBarItem(vscode.StatusBarAlignment.Right, 100);
// 显示端口数量
statusBarItem.text = `$(plug) ${portMappings.length} Ports`;
statusBarItem.tooltip = `点击查看 ${portMappings.length} 个端口映射详情`;
// 添加命令
statusBarItem.command = `devstar.showPortMappings.${mappingKey.replace(/[^a-zA-Z0-9]/g, '_')}`;
statusBarItem.show();
// 存储状态栏项目以便后续清理
if (!this.statusBarItems) {
this.statusBarItems = new Map();
}
this.statusBarItems.set(mappingKey, statusBarItem);
}
/**
* 获取当前活动的端口映射信息
*/
public getActivePortMappings(hostname: string, port: number): Array<{containerPort: number, localPort: number, label: string, source: string}> {
const mappingKey = `${hostname}:${port}`;
return this.portMappings.get(mappingKey) || [];
}
/**
* 显示端口映射面板
*/
public showPortMappingsPanel(hostname: string, port: number): void {
const mappings = this.getActivePortMappings(hostname, port);
if (mappings.length === 0) {
vscode.window.showInformationMessage('当前没有活动的端口映射');
return;
}
this.showPortMappingsSummary(mappings);
}
/**
* 在输出通道显示详细的端口映射信息
*/
public showPortMappingsInOutputChannel(hostname: string, port: number): void {
const mappings = this.getActivePortMappings(hostname, port);
if (mappings.length === 0) {
vscode.window.showInformationMessage('当前没有活动的端口映射');
return;
}
const outputChannel = vscode.window.createOutputChannel('DevStar Port Mappings');
outputChannel.show();
outputChannel.appendLine(`🎯 端口映射信息 - ${hostname}:${port}`);
outputChannel.appendLine('='.repeat(50));
mappings.forEach((mapping, index) => {
outputChannel.appendLine(`${index + 1}. ${mapping.label}`);
outputChannel.appendLine(` 容器端口: ${mapping.containerPort}`);
outputChannel.appendLine(` 本地端口: ${mapping.localPort}`);
outputChannel.appendLine(` 访问地址: http://localhost:${mapping.localPort}`);
outputChannel.appendLine(` 配置来源: ${mapping.source}`);
outputChannel.appendLine('');
});
outputChannel.appendLine('💡 提示: 您可以在浏览器中访问上述本地端口来访问容器中的服务');
}
/** /**
* 本地环境保存项目的ssh连接信息 * 本地环境保存项目的ssh连接信息
* @param host
* @param hostname
* @param port
* @param username
*/ */
async storeProjectSSHInfo(host: string, hostname: string, port: number, username: string): Promise<void> { async storeProjectSSHInfo(host: string, hostname: string, port: number, username: string): Promise<void> {
console.log(`[RemoteContainer] storeProjectSSHInfo called with:`, { host, hostname, port, username }); console.log(`[RemoteContainer] storeProjectSSHInfo called with:`, { host, hostname, port, username });
const sshConfigPath = path.join(os.homedir(), '.ssh', 'config'); const sshConfigPath = path.join(os.homedir(), '.ssh', 'config');
console.log(`[RemoteContainer] SSH config path: ${sshConfigPath}`); console.log(`[RemoteContainer] SSH config path: ${sshConfigPath}`);
// check if the host and related info exist in local ssh config file before saving
let canAppendSSHConfig = true; let canAppendSSHConfig = true;
if (fs.existsSync(sshConfigPath)) { if (fs.existsSync(sshConfigPath)) {
console.log(`[RemoteContainer] SSH config file exists, checking for existing host`); console.log(`[RemoteContainer] SSH config file exists, checking for existing host`);
const reader = rd.createInterface(fs.createReadStream(sshConfigPath)); const reader = rd.createInterface(fs.createReadStream(sshConfigPath));
for await (const line of reader) { for await (const line of reader) {
if (line.includes(`Host ${host}`)) { if (line.includes(`Host ${host}`)) {
// the container ssh info exists
console.log(`[RemoteContainer] Host ${host} already exists in SSH config`); console.log(`[RemoteContainer] Host ${host} already exists in SSH config`);
canAppendSSHConfig = false; canAppendSSHConfig = false;
break; break;
@@ -449,18 +620,16 @@ export default class RemoteContainer {
} }
if (canAppendSSHConfig) { if (canAppendSSHConfig) {
// save the host to the local ssh config file
const privateKeyPath = this.user.getUserPrivateKeyPath(); const privateKeyPath = this.user.getUserPrivateKeyPath();
console.log(`[RemoteContainer] Using private key path: ${privateKeyPath}`); console.log(`[RemoteContainer] Using private key path: ${privateKeyPath}`);
const newSShConfigContent = const newSShConfigContent =
`\nHost ${host}\n HostName ${hostname}\n Port ${port}\n User ${username}\n PreferredAuthentications publickey\n IdentityFile ${privateKeyPath}\n `; `\nHost ${host}\n HostName ${hostname}\n Port ${port}\n User ${username}\n PreferredAuthentications publickey\n IdentityFile ${privateKeyPath}\n `;
try { try {
fs.writeFileSync(sshConfigPath, newSShConfigContent, { encoding: 'utf8', flag: 'a' }); fs.writeFileSync(sshConfigPath, newSShConfigContent, { encoding: 'utf8', flag: 'a' });
console.log('[RemoteContainer] Host registered in local ssh config'); console.log('[RemoteContainer] Host registered in local ssh config');
} catch (error) { } catch (error) {
const errorMessage = error instanceof Error ? error.message : '未知错误';
console.error('[RemoteContainer] Failed to write SSH config:', error); console.error('[RemoteContainer] Failed to write SSH config:', error);
throw error; throw error;
} }
@@ -469,36 +638,39 @@ export default class RemoteContainer {
/** /**
* local env * local env
* 仅支持已经成功连接并在ssh config file中存储ssh信息的项目连接。
*
* @host 表示project name
*/ */
async openRemoteFolder(host: string, port: number, username: string, path: string): Promise<void> { async openRemoteFolder(host: string, port: number, username: string, path: string): Promise<void> {
console.log(`[RemoteContainer] openRemoteFolder called with:`, { host, port, username, path }); console.log(`[RemoteContainer] openRemoteFolder called with:`, { host, port, username, path });
try { try {
// 先设置端口映射 // 先设置端口映射(保留这里的端口映射建立)
const sshConfig = await this.getSSHConfig(host); const sshConfig = await this.getSSHConfig(host);
if (sshConfig) { if (sshConfig) {
try { try {
await this.setupPortForwarding(sshConfig.hostname, port, path); await this.setupPortForwarding(sshConfig.hostname, port, path);
console.log(`[RemoteContainer] Port forwarding established for existing connection`); console.log(`[RemoteContainer] Port forwarding established for existing connection`);
// 延迟显示端口映射信息,确保用户能看到
setTimeout(() => {
this.showPortMappingsPanel(sshConfig.hostname, port);
}, 3000);
} catch (portError) { } catch (portError) {
console.warn(`[RemoteContainer] Port forwarding setup failed:`, portError); console.warn(`[RemoteContainer] Port forwarding setup failed:`, portError);
// 端口映射失败不应阻止主要功能 vscode.window.showWarningMessage('端口映射设置失败,但容器连接已建立');
} }
} }
// 然后打开远程文件夹 // 然后打开远程文件夹
let terminal = vscode.window.activeTerminal || vscode.window.createTerminal(`Ext Terminal`); let terminal = vscode.window.activeTerminal || vscode.window.createTerminal(`Ext Terminal`);
terminal.show(true); terminal.show(true);
const command = `code --remote ssh-remote+root@${host}:${port} ${path} --reuse-window`; const command = `code --remote ssh-remote+root@${host}:${port} ${path} --reuse-window`;
console.log(`[RemoteContainer] Sending command to terminal: ${command}`); console.log(`[RemoteContainer] Sending command to terminal: ${command}`);
// 在原窗口打开
terminal.sendText(command); terminal.sendText(command);
console.log(`[RemoteContainer] Command sent successfully`); console.log(`[RemoteContainer] Command sent successfully`);
} catch (error) { } catch (error) {
const errorMessage = error instanceof Error ? error.message : '未知错误'; const errorMessage = error instanceof Error ? error.message : '未知错误';
console.error(`[RemoteContainer] Error in openRemoteFolder:`, error); console.error(`[RemoteContainer] Error in openRemoteFolder:`, error);
@@ -511,21 +683,21 @@ export default class RemoteContainer {
*/ */
private async getSSHConfig(host: string): Promise<{ hostname: string; port: number } | null> { private async getSSHConfig(host: string): Promise<{ hostname: string; port: number } | null> {
const sshConfigPath = path.join(os.homedir(), '.ssh', 'config'); const sshConfigPath = path.join(os.homedir(), '.ssh', 'config');
if (!fs.existsSync(sshConfigPath)) { if (!fs.existsSync(sshConfigPath)) {
return null; return null;
} }
const configContent = fs.readFileSync(sshConfigPath, 'utf8'); const configContent = fs.readFileSync(sshConfigPath, 'utf8');
const lines = configContent.split('\n'); const lines = configContent.split('\n');
let currentHost = ''; let currentHost = '';
let hostname = ''; let hostname = '';
let port = 22; // 默认端口 let port = 22;
for (const line of lines) { for (const line of lines) {
const trimmed = line.trim(); const trimmed = line.trim();
if (trimmed.startsWith('Host ')) { if (trimmed.startsWith('Host ')) {
currentHost = trimmed.substring(5).trim(); currentHost = trimmed.substring(5).trim();
} else if (currentHost === host) { } else if (currentHost === host) {
@@ -535,48 +707,71 @@ export default class RemoteContainer {
port = parseInt(trimmed.substring(5).trim()); port = parseInt(trimmed.substring(5).trim());
} }
} }
if (hostname && currentHost === host) { if (hostname && currentHost === host) {
return { hostname, port }; return { hostname, port };
} }
} }
return null; return null;
} }
/** /**
* 清理端口转发(可选) * 清理端口映射和相关UI
*/ */
public cleanupPortForwarding(): void { public cleanupPortForwarding(hostname?: string, port?: number): void {
if (!this.sshProcesses) return; // 清理SSH进程
if (this.sshProcesses) {
console.log(`[RemoteContainer] Cleaning up ${this.sshProcesses.size} SSH port forwarding processes`);
for (const [key, process] of this.sshProcesses.entries()) {
try {
process.kill();
console.log(`[RemoteContainer] Killed SSH process: ${key}`);
} catch (error) {
console.warn(`[RemoteContainer] Failed to kill process ${key}:`, error);
}
}
this.sshProcesses.clear();
}
console.log(`[RemoteContainer] Cleaning up ${this.sshProcesses.size} SSH port forwarding processes`); // 清理状态栏项目
if (this.statusBarItems) {
for (const [key, process] of this.sshProcesses.entries()) { if (hostname && port) {
try { const mappingKey = `${hostname}:${port}`;
process.kill(); const statusBarItem = this.statusBarItems.get(mappingKey);
console.log(`[RemoteContainer] Killed SSH process: ${key}`); if (statusBarItem) {
} catch (error) { statusBarItem.dispose();
console.warn(`[RemoteContainer] Failed to kill process ${key}:`, error); this.statusBarItems.delete(mappingKey);
}
} else {
// 清理所有状态栏项目
for (const [_, statusBarItem] of this.statusBarItems) {
statusBarItem.dispose();
}
this.statusBarItems.clear();
} }
} }
this.sshProcesses.clear();
// 清理端口映射信息
if (hostname && port) {
const mappingKey = `${hostname}:${port}`;
this.portMappings.delete(mappingKey);
} else {
this.portMappings.clear();
}
} }
} }
/** /**
* 打开项目(无须插件登录) * 打开项目(无须插件登录)
* @param hostname 表示ip
* @param port
* @param username
* @param path
*/ */
export async function openProjectWithoutLogging(hostname: string, port: number, username: string, path: string): Promise<void> { export async function openProjectWithoutLogging(hostname: string, port: number, username: string, path: string): Promise<void> {
console.log(`[RemoteContainer] openProjectWithoutLogging called with:`, { hostname, port, username, path }); console.log(`[RemoteContainer] openProjectWithoutLogging called with:`, { hostname, port, username, path });
const command = `code --remote ssh-remote+${username}@${hostname}:${port} ${path} --reuse-window` const command = `code --remote ssh-remote+${username}@${hostname}:${port} ${path} --reuse-window`;
console.log(`[RemoteContainer] Command: ${command}`); console.log(`[RemoteContainer] Command: ${command}`);
try { try {
let terminal = vscode.window.activeTerminal || vscode.window.createTerminal(`Ext Terminal`); let terminal = vscode.window.activeTerminal || vscode.window.createTerminal(`Ext Terminal`);
terminal.show(true); terminal.show(true);