Skip to content

A "fast and loose" way to install modules from Powershell Gallery quickly. Meant for CICD, not production

License

Notifications You must be signed in to change notification settings

JustinGrote/ModuleFast

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

76 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

ModuleFast

This is a PowerShell module installer that is optimized for high performance and no external dependencies so it can be used as a bootstrap to quickly install and update modules in a declarative fashion.

Quick Start Bootstrap

NOTE: Recommended PSModulePath Prerequisite

ModuleFast installs modules to your LocalAppData/powershell/Modules folder. This is the default install folder on Linux however it is not on Windows, so on Windows the script will automatically update your profile to add this path to your psmodulepath on startup. You can alternatively add a powershell.config.json

Load ModuleFast as a module for the session

Modulefast can be quickly bootstrapped without relying on the built-in PSGet package manager

iwr tinyurl.com/modulefast | iex
Install-ModuleFast ImportExcel

Single Line Installation (good for CI/CD)

Adding args to the bootstrap passes them to Install-ModuleFast automatically, so you can one-line install modules as needed

& ([scriptblock]::Create((iwr 'tinyurl.com/modulefast'))) ImportExcel

Goals

Given a set of packages, install the packages and their dependencies as fast as possible in a declarative plan/apply incremental approach. Packages once deployed should be fully compatible with built-in *-Module commands, PSGetv2, and PSGetv3 Support a "complete" mode that will clean up packages that aren't the latest versions of the specified modules.

Non-Goals

This is not a replacement for PowerShellGetv3 This is a compliment to the hard work being done there. The focus with PSGetv3 is compatibility, the focus with ModuleFast is speed at the expense of backwards compatability.

How this script works

  1. Takes your module specifications and builds a declarative dependency tree, following a IaC plan/apply approach to installing modules.
  2. Uses a custom HTTPClient and async tasks to build the dependency tree quickly, querying with minimal data possible and using batch queries where possible to optimize for performance. This is all done in native PowerShell, no C# required (though C# would allow for certain operations to be even more parallelizable by chaining tasks).
  3. Uses HTTP/2 to run all queries in a single TCP conversation where possible (PSGallery supports it)
  4. For PowerShell Gallery, uses an optimized CloudFlare Worker to resolve dependencies as fast as possible.

What this script is not

This is an example of how fast things can be, with certain assumptions, but it only works against a single NuGet v2 repository at the moment and is pretty much only tested with PowerShell Gallery. It is not a replacement for PowerShellGet, which has much broader support for multiple repos, authentication, etc.

It makes a lot of very bad assumptions, most of which are safe for PowerShell Gallery at least

  1. Nuget v3 Only. PowerShellGet is built for compatibility with PSGetv2, I have no such compatibility restrictions and can build "from scratch"
  2. Powershell 7+ Only. PowerShellGet has 5.1+ compatibility
  3. Modules with a particular GUID and version are immutable and never change. This is great for caching purposes, and is true for PSGallery, but may not be true for other galleries.
  4. It currently has very little error handling and aggressive timeouts, and not recommended for slow or unreliable network connections. It will "fail fast" as much as possible.
  5. Local PSModule folders that don't have the format folder/moduleName/moduleVersion/moduleName.psd1 are not considered
  6. The .psd1 file isn't actually read to verify the module is correct/not corrupt.

Lessons learned

  1. Multipart $batch queries suck, they still only execute server-side in parallel. I wrote a full multipart implementation only to throw it away
  2. HTTP/2 is magic for high speed testing. Fiddler only supports HTTP/1.1 and can give false positives about how many connections are actually being made. Use wireshark to be sure.
  3. [Dictionary].keys is not a stable target at all for task iteration, best to maintain a separate list
  4. PSGetv3 doesn't follow the nuget server v3 spec of optional params (stuff marked optional will cause psgetv3 to throw if not present)
  5. Initially the logic would fetch the main page and resolve dependencies by fetching individual versions. Turns out its only barely slower to return all versions of a module in single call, probably because the PSGallery server-side filtering doesnt cache, so we instead fetch all versions of a module in a reduced way from our Cloudflare worker and use that as a cache.
  6. Parallel dependency lookups (lots of Az dependencies require Az.Account) resulted in lots of duplicate calls for Az.Account. Since all task calls bottleneck through our main async loop logic, we can safely inspect existing dependency calls just before execution to determine if the existing call will satisfy it, and then add the context on to the existing object to prevent the duplicate calls.

Dependency Resolution

This module uses a custom dependency resolution algorithm that selects the newest available modules that satisfy all the dependency criteria. If a version of a locally installed module satisfies the "latest" criteria of the dependency graph, it will be used rather than fetching what is newest on the gallery. This can be overriden with the -Update switch that will recheck whats available in the remote.

About

A "fast and loose" way to install modules from Powershell Gallery quickly. Meant for CICD, not production

Resources

License

Stars

Watchers

Forks

Packages