Skip to content

Latest commit

 

History

History
197 lines (161 loc) · 7.41 KB

issues.md

File metadata and controls

197 lines (161 loc) · 7.41 KB

Issue Log

This document tracks both resolved and known issues in the Sandbox Development Environment project.

Resolved Issues

Variable Naming Conflicts

  • Issue: Use of PowerShell reserved variable $error in script caused potential conflicts
  • Impact: Could interfere with PowerShell's built-in error handling
  • Fix: Renamed to $errorMessage and improved variable scoping
  • Date: 2024-02-20

Manifest Validation

  • Issue: Inconsistent error collection in manifest validation
  • Impact: Made debugging manifest issues more difficult
  • Fix: Standardized error collection using $validationErrors array
  • Date: 2024-02-20

Variable Scoping

  • Issue: Inconsistent variable scoping across functions
  • Impact: Potential for variable pollution and hard-to-track bugs
  • Fix: Added proper $script: scope for shared variables
  • Date: 2024-02-20

Package Installation Error Handling

  • Issue: Inconsistent error reporting in package installation
  • Impact: Made troubleshooting failed installations difficult
  • Fix: Standardized error messages and improved logging
  • Date: 2024-02-20

PowerShell Module Implementation

  • Issue: Lack of standardized command interface for sandbox management
  • Impact: Inconsistent user experience and command execution
  • Fix: Created Start-DevSandbox module with proper parameter handling and alias
  • Date: 2024-02-20

Command Parameter Conflicts

  • Issue: Conflict with PowerShell common parameters (Verbose, Debug)
  • Impact: Command execution errors and parameter validation failures
  • Fix: Properly implemented CmdletBinding and removed duplicate parameters
  • Date: 2024-02-20

Module Installation Path

  • Issue: Inconsistent module availability across different PowerShell sessions
  • Impact: Module not always accessible when needed
  • Fix: Added Install-SandboxModule with both user and system-wide installation options
  • Date: 2024-02-20

Command Validation

  • Issue: No dry-run capability for sandbox setup
  • Impact: Unable to preview command execution
  • Fix: Implemented proper -WhatIf support with detailed execution preview
  • Date: 2024-02-20

WhatIf Message Implementation

  • Issue: WhatIf message was created but not properly displayed in ShouldProcess
  • Impact: Improved debugging experience with more informative -WhatIf output
  • Fix: Updated ShouldProcess to use the complete command message instead of just script path
  • Date: 2024-01-09
  • File: Start-DevSandbox.psm1

Sandbox Configuration Path Issues

  • Issue: Invalid configuration settings (Error 0x80070057) when using direct D: drive paths
  • Impact: Windows Sandbox failed to launch with mapped folders
  • Fix: Changed drive paths to UNC format (\localhost\D$...) and added test folder mapping
  • Date: 2024-12-07

Mapped Folder Order Sensitivity

  • Issue: Sandbox configuration failed when Windows test folder mapping was removed
  • Impact: Configuration became invalid when changing folder mapping order
  • Fix: Maintained Windows test folder as first mapped folder for initialization
  • Date: 2024-12-07

UNC Path Requirements

  • Issue: Direct drive paths (D:...) not supported for mapped folders
  • Impact: Configuration failed with drive letter paths
  • Fix: Converted all non-system drive paths to UNC format (\localhost\D$...)
  • Date: 2024-12-07

Known Issues

Package Version Management

  • Issue: Limited support for managing multiple versions of the same package
  • Impact: Cannot maintain multiple versions side-by-side
  • Status: Under Investigation
  • Potential Fix: Implement version-specific installation paths

Network Dependency

  • Issue: Some package validations require network access
  • Impact: Validation can fail in fully offline environments
  • Status: Open
  • Potential Fix: Implement offline validation mode

VSCode Extension Management

  • Issue: Limited validation of VSCode extension dependencies
  • Impact: Extensions might fail to load if dependencies are missing
  • Status: Open
  • Potential Fix: Add extension dependency checking

PowerShell Module Dependencies

  • Issue: No automatic resolution of module dependencies
  • Impact: Manual intervention needed for dependent modules
  • Status: Open
  • Potential Fix: Implement dependency resolution in manifest

Module Auto-Loading

  • Issue: Module requires manual import in new sessions
  • Impact: Extra step needed to use sandbox commands
  • Status: Under Investigation
  • Potential Fix: Implement auto-loading through PowerShell profile

Module Dependencies

  • Issue: No automatic verification of required PowerShell version
  • Impact: Potential compatibility issues
  • Status: Open
  • Potential Fix: Add #Requires statement and version checking

Module Updates

  • Issue: No built-in update mechanism
  • Impact: Manual updates required for new versions
  • Status: Open
  • Potential Fix: Implement version checking and auto-update functionality

Security Considerations

Sandbox Isolation

  • Issue: Need to verify complete isolation of sandbox environment
  • Impact: Potential security implications if isolation is incomplete
  • Status: Ongoing Monitoring
  • Current Controls:
    • Read-only mappings where possible
    • Minimal system modification
    • Controlled execution policy

Package Verification

  • Issue: Limited package signature verification
  • Impact: Potential security risk from tampered packages
  • Status: Under Investigation
  • Potential Fix: Implement checksum verification

Module Installation Privileges

  • Issue: System-wide installation requires elevated privileges
  • Impact: Installation flexibility limited by user permissions
  • Status: By Design
  • Current Controls:
    • Default to user-level installation
    • Clear error messages for privilege requirements
    • Fallback to user installation when system install fails

Performance Issues

Installation Speed

  • Issue: Sequential package installation can be slow
  • Impact: Longer setup times for new environments
  • Status: Under Investigation
  • Potential Fix: Implement parallel installation where safe

Memory Usage

  • Issue: High memory usage during large package extractions
  • Impact: Could cause issues on systems with limited resources
  • Status: Monitoring
  • Potential Fix: Implement streaming extraction

Module Load Time

  • Issue: Initial module load may add slight delay
  • Impact: Minor performance impact on first use
  • Status: Monitoring
  • Potential Fix: Optimize module import process

Reporting New Issues

When reporting new issues, please include:

  1. Clear description of the issue
  2. Steps to reproduce
  3. Expected behavior
  4. Actual behavior
  5. Environment details:
    • PowerShell version
    • Windows version
    • Available system resources
    • Network connectivity status

Issue Priorities

  • Critical: Security issues, data loss risks
  • High: Functionality blocking issues
  • Medium: Non-blocking but significant issues
  • Low: Minor improvements, cosmetic issues

Issue Labels

  • security: Security-related issues
  • performance: Performance-related issues
  • enhancement: Feature improvements
  • bug: Confirmed bugs
  • documentation: Documentation-related issues
  • help-wanted: Issues needing community input