mirror of
https://github.com/safedep/pmg.git
synced 2026-08-03 07:24:09 +02:00
* feat: add FilterPMGFromPath utility for PATH shim recursion prevention * feat: add FilterPMGFromEnv to filter PATH from env slices * feat: filter ~/.pmg/bin from PATH in proxy subprocess env * feat: add PathExport method to Shell interface for shim PATH integration * feat: add ShimManager for PATH shim install/remove lifecycle * feat: wire ShimManager into setup commands with --use-aliases fallback * refactor: add DefaultShimConfig helper to reduce setup boilerplate * fix: resolve real binary path to prevent shim double-invocation exec.CommandContext resolves the binary using the current process PATH, which still contains ~/.pmg/bin. This caused pmg to launch the shim instead of the real package manager, resulting in a second pmg instance with its own proxy — producing duplicate error messages and wasted work. ResolveRealBinary searches a filtered PATH (without ~/.pmg/bin) to find the real package manager binary before execution. * fix: resolve real binary in runner.Execute and expand path resolution tests Ensure guard mode and proxy skip paths also resolve through ResolveRealBinary to prevent infinite shim recursion. Add table-driven tests covering error cases, multi-binary PATH, and PATH restoration. * fix: handle error return values from os.Setenv and file Close calls Address errcheck lint failures: check os.Setenv returns in ResolveRealBinary, and check f.Close/tempFile.Close in ShimManager. * feat: auto-migrate shell aliases to PATH shims on setup install When running `pmg setup install`, detect existing shell aliases and automatically remove them before installing shims. Existing users get a seamless migration with no extra flags or commands needed. * fix: update E2E test to verify shim installation instead of alias RC file Replace the .pmg.rc file check with assertions that ~/.pmg/bin/ exists and contains executable shim scripts for npm and pip. * feat: add FilterPMGFromPath utility for PATH shim recursion prevention * feat: add FilterPMGFromEnv to filter PATH from env slices * feat: filter ~/.pmg/bin from PATH in proxy subprocess env * feat: add PathExport method to Shell interface for shim PATH integration * feat: add ShimManager for PATH shim install/remove lifecycle * feat: wire ShimManager into setup commands with --use-aliases fallback * refactor: add DefaultShimConfig helper to reduce setup boilerplate * fix: resolve real binary path to prevent shim double-invocation exec.CommandContext resolves the binary using the current process PATH, which still contains ~/.pmg/bin. This caused pmg to launch the shim instead of the real package manager, resulting in a second pmg instance with its own proxy — producing duplicate error messages and wasted work. ResolveRealBinary searches a filtered PATH (without ~/.pmg/bin) to find the real package manager binary before execution. * fix: resolve real binary in runner.Execute and expand path resolution tests Ensure guard mode and proxy skip paths also resolve through ResolveRealBinary to prevent infinite shim recursion. Add table-driven tests covering error cases, multi-binary PATH, and PATH restoration. * fix: handle error return values from os.Setenv and file Close calls Address errcheck lint failures: check os.Setenv returns in ResolveRealBinary, and check f.Close/tempFile.Close in ShimManager. * feat: auto-migrate shell aliases to PATH shims on setup install When running `pmg setup install`, detect existing shell aliases and automatically remove them before installing shims. Existing users get a seamless migration with no extra flags or commands needed. * fix: update E2E test to verify shim installation instead of alias RC file Replace the .pmg.rc file check with assertions that ~/.pmg/bin/ exists and contains executable shim scripts for npm and pip. * feat: install both aliases and shims for full coverage Aliases win in interactive shells (including venvs), shims catch non-interactive contexts (IDEs, CI, subprocesses). Remove --use-aliases flag and migration logic since both are always installed together. Update E2E to verify all shim scripts and alias RC file. * feat: address review feedback for shim implementation - Install both aliases and shims together for full coverage - Move homeDir resolution into NewDefaultShimManager (internal concern) - Add mutex to ResolveRealBinary to guard against concurrent PATH mutation - Use filepath.SplitList for platform-correct PATH splitting - Add ResolveRealBinary to runner.Execute and proxy flow to prevent shim recursion in all execution paths - Remove print side-effects from ShimManager.Remove - Update E2E to verify all shim scripts and alias RC file - Expand ResolveRealBinary tests with table-driven cases * fix: restore errcheck handling and add concurrency test for ResolveRealBinary - Restore proper defer with log.Warnf for PATH restoration in ResolveRealBinary - Restore errcheck handling for f.Close() and tempFile.Close() in ShimManager - Add explanatory comment for ResolveRealBinary call in proxy_flow - Add TestResolveRealBinaryConcurrent to verify mutex guards concurrent access * feat: skip shell integration on Windows with informative warning On Windows, pmg setup install now writes only the config file and prints a warning that shell aliases and PATH shims require WSL. * fix: PMG use pre-resolved binary path (#253) --------- Co-authored-by: Abhisek Datta <abhisek.datta@gmail.com>
246 lines
5.7 KiB
Go
246 lines
5.7 KiB
Go
package shim
|
|
|
|
import (
|
|
"bufio"
|
|
"bytes"
|
|
"fmt"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/safedep/dry/log"
|
|
"github.com/safedep/pmg/internal/alias"
|
|
)
|
|
|
|
const shimMarker = "PMG shims"
|
|
|
|
type ShimConfig struct {
|
|
BinDir string
|
|
HomeDir string
|
|
PMGBin string
|
|
PackageManagers []string
|
|
Shells []alias.Shell
|
|
}
|
|
|
|
type ShimManager struct {
|
|
config ShimConfig
|
|
}
|
|
|
|
func NewShimManager(config ShimConfig) *ShimManager {
|
|
return &ShimManager{config: config}
|
|
}
|
|
|
|
func NewDefaultShimManager() (*ShimManager, error) {
|
|
homeDir, err := os.UserHomeDir()
|
|
if err != nil {
|
|
return nil, fmt.Errorf("failed to get home directory: %w", err)
|
|
}
|
|
|
|
aliasCfg := alias.DefaultConfig()
|
|
pmgBin, err := currentExecutable()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &ShimManager{config: ShimConfig{
|
|
BinDir: filepath.Join(homeDir, ".pmg", "bin"),
|
|
HomeDir: homeDir,
|
|
PMGBin: pmgBin,
|
|
PackageManagers: aliasCfg.PackageManagers,
|
|
Shells: aliasCfg.Shells,
|
|
}}, nil
|
|
}
|
|
|
|
func (m *ShimManager) Install() error {
|
|
if m.config.PMGBin == "" {
|
|
pmgBin, err := currentExecutable()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
m.config.PMGBin = pmgBin
|
|
}
|
|
|
|
if err := os.MkdirAll(m.config.BinDir, 0o755); err != nil {
|
|
return fmt.Errorf("failed to create shim directory %s: %w", m.config.BinDir, err)
|
|
}
|
|
|
|
for _, pm := range m.config.PackageManagers {
|
|
if err := m.writeShimScript(pm); err != nil {
|
|
return fmt.Errorf("failed to write shim for %s: %w", pm, err)
|
|
}
|
|
}
|
|
|
|
if err := m.addPathToShells(); err != nil {
|
|
return fmt.Errorf("failed to update shell configs: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (m *ShimManager) Remove() error {
|
|
if err := os.RemoveAll(m.config.BinDir); err != nil && !os.IsNotExist(err) {
|
|
log.Warnf("Warning: failed to remove shim directory: %v", err)
|
|
}
|
|
|
|
if err := m.removePathFromShells(); err != nil {
|
|
return fmt.Errorf("failed to clean shell configs: %w", err)
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (m *ShimManager) IsInstalled() (bool, error) {
|
|
for _, shell := range m.config.Shells {
|
|
configPath := filepath.Join(m.config.HomeDir, shell.Path())
|
|
|
|
data, err := os.ReadFile(configPath)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
continue
|
|
}
|
|
log.Warnf("Warning: could not read %s (%s)", shell.Name(), err)
|
|
continue
|
|
}
|
|
|
|
if strings.Contains(string(data), shimMarker) {
|
|
return true, nil
|
|
}
|
|
}
|
|
|
|
return false, nil
|
|
}
|
|
|
|
func (m *ShimManager) GetBinDir() string {
|
|
return m.config.BinDir
|
|
}
|
|
|
|
func (m *ShimManager) writeShimScript(pm string) error {
|
|
shimPath := filepath.Join(m.config.BinDir, pm)
|
|
pmgBin := shellQuote(m.config.PMGBin)
|
|
|
|
content := fmt.Sprintf(`#!/bin/sh
|
|
# PMG shim - do not edit, managed by pmg setup
|
|
PMG_BIN=%s
|
|
if [ ! -x "$PMG_BIN" ]; then
|
|
echo "[pmg] error: PMG binary not found or not executable: $PMG_BIN" >&2
|
|
echo "[pmg] error: run 'pmg setup install' again or remove shims with 'pmg setup remove'" >&2
|
|
exit 127
|
|
fi
|
|
exec "$PMG_BIN" %s "$@"
|
|
`, pmgBin, pm)
|
|
|
|
return os.WriteFile(shimPath, []byte(content), 0o755)
|
|
}
|
|
|
|
func currentExecutable() (string, error) {
|
|
exe, err := os.Executable()
|
|
if err != nil {
|
|
return "", fmt.Errorf("failed to resolve pmg executable: %w", err)
|
|
}
|
|
|
|
resolved, err := filepath.EvalSymlinks(exe)
|
|
if err != nil {
|
|
return filepath.Abs(exe)
|
|
}
|
|
|
|
return resolved, nil
|
|
}
|
|
|
|
func shellQuote(value string) string {
|
|
return "'" + strings.ReplaceAll(value, "'", "'\\''") + "'"
|
|
}
|
|
|
|
func (m *ShimManager) addPathToShells() error {
|
|
for _, shell := range m.config.Shells {
|
|
configPath := filepath.Join(m.config.HomeDir, shell.Path())
|
|
|
|
data, err := os.ReadFile(configPath)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
continue
|
|
}
|
|
log.Warnf("Warning: skipping %s (%s)", shell.Name(), err)
|
|
continue
|
|
}
|
|
|
|
if strings.Contains(string(data), shimMarker) {
|
|
continue
|
|
}
|
|
|
|
f, err := os.OpenFile(configPath, os.O_APPEND|os.O_WRONLY, 0o644)
|
|
if err != nil {
|
|
log.Warnf("Warning: skipping %s (%s)", shell.Name(), err)
|
|
continue
|
|
}
|
|
|
|
_, err = fmt.Fprintf(f, "\n%s", shell.PathExport(m.config.BinDir))
|
|
if closeErr := f.Close(); closeErr != nil {
|
|
log.Warnf("Warning: failed to close %s: %s", shell.Name(), closeErr)
|
|
}
|
|
if err != nil {
|
|
log.Warnf("Warning: failed to write PATH export to %s: %s", shell.Name(), err)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|
|
|
|
func (m *ShimManager) removePathFromShells() error {
|
|
for _, shell := range m.config.Shells {
|
|
configPath := filepath.Join(m.config.HomeDir, shell.Path())
|
|
|
|
data, err := os.ReadFile(configPath)
|
|
if err != nil {
|
|
if os.IsNotExist(err) {
|
|
continue
|
|
}
|
|
log.Warnf("Warning: skipping %s (%s)", shell.Name(), err)
|
|
continue
|
|
}
|
|
|
|
info, err := os.Stat(configPath)
|
|
if err != nil {
|
|
log.Warnf("Warning: skipping %s (%s)", shell.Name(), err)
|
|
continue
|
|
}
|
|
|
|
tempFile, err := os.CreateTemp(filepath.Dir(configPath), ".tmp-"+filepath.Base(configPath))
|
|
if err != nil {
|
|
log.Warnf("Warning: failed to create temporary file for %s: %s", configPath, err)
|
|
continue
|
|
}
|
|
tempPath := tempFile.Name()
|
|
|
|
scanner := bufio.NewScanner(bytes.NewReader(data))
|
|
writer := bufio.NewWriter(tempFile)
|
|
|
|
for scanner.Scan() {
|
|
line := scanner.Text()
|
|
if strings.Contains(line, shimMarker) {
|
|
continue
|
|
}
|
|
if _, err := writer.WriteString(line + "\n"); err != nil {
|
|
log.Warnf("Warning: failed to write to temporary file: %s", err)
|
|
}
|
|
}
|
|
|
|
if err := writer.Flush(); err != nil {
|
|
log.Warnf("Warning: failed to flush temporary file: %s", err)
|
|
}
|
|
if err := tempFile.Close(); err != nil {
|
|
log.Warnf("Warning: failed to close temporary file: %s", err)
|
|
}
|
|
|
|
if err := os.Chmod(tempPath, info.Mode()); err != nil {
|
|
log.Warnf("Warning: failed to set permissions on temporary file: %s", err)
|
|
}
|
|
|
|
if err := os.Rename(tempPath, configPath); err != nil {
|
|
_ = os.Remove(tempPath)
|
|
log.Warnf("Warning: failed to update %s: %s", configPath, err)
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|