diff options
| author | William Boman <william@redwill.se> | 2023-11-07 00:29:18 +0100 |
|---|---|---|
| committer | William Boman <william@redwill.se> | 2025-02-19 12:15:48 +0100 |
| commit | 6a7662760c515c74f2c37fc825776ead65d307f9 (patch) | |
| tree | 0f4496d0678c7029b10236cbf48cc0f5ff63c1dc /lua/mason-test | |
| parent | fix(pypi): remove -U flag and fix log message (diff) | |
| download | mason-6a7662760c515c74f2c37fc825776ead65d307f9.tar mason-6a7662760c515c74f2c37fc825776ead65d307f9.tar.gz mason-6a7662760c515c74f2c37fc825776ead65d307f9.tar.bz2 mason-6a7662760c515c74f2c37fc825776ead65d307f9.tar.lz mason-6a7662760c515c74f2c37fc825776ead65d307f9.tar.xz mason-6a7662760c515c74f2c37fc825776ead65d307f9.tar.zst mason-6a7662760c515c74f2c37fc825776ead65d307f9.zip | |
refactor!: change Package API
This changes the following public APIs:
**(_breaking_) Events on the `Package` class**
The `uninstall:success` event on the `Package` class now receives an `InstallReceipt` as argument, instead of an
`InstallHandle`. This receipt is an in-memory representation of what was uninstalled. There's also a new
`uninstall:failed` event for situations where uninstallation for some
reason fails. Note: this also applies to the registry events (i.e.
`package:uninstall:success` and `package:uninstall:failed`).
---
**(_breaking_) `Package:uninstall()` is now asynchronous and receives two new arguments, similarly to `Package:install()`**
While package uninstallations remain synchronous under the hood, the public API has been changed from synchronous ->
asynchronous. Users of this method are recommended to provide a callback in situations where code needs to execute after
uninstallation fully completes.
---
**(_breaking_) `Package:get_install_path()` has been removed.
---
**`Package:install()` now takes an optional callback**
This callback allows consumers to be informed whether installation was successful or not without having to go through a
different, low-level, API. See below for a comparison between the old and new APIs:
```lua
-- before
local handle = pkg:install()
handle:once("closed", function ()
-- ...
end)
-- after
pkg:install({}, function (success, result)
-- ...
end)
```
Diffstat (limited to 'lua/mason-test')
| -rw-r--r-- | lua/mason-test/helpers.lua | 45 |
1 files changed, 40 insertions, 5 deletions
diff --git a/lua/mason-test/helpers.lua b/lua/mason-test/helpers.lua index 2348e9df..88354046 100644 --- a/lua/mason-test/helpers.lua +++ b/lua/mason-test/helpers.lua @@ -1,7 +1,8 @@ local InstallContext = require "mason-core.installer.context" -local InstallHandle = require "mason-core.installer.handle" -local InstallLocation = require "mason-core.installer.location" +local InstallHandle = require "mason-core.installer.InstallHandle" +local InstallLocation = require "mason-core.installer.InstallLocation" local Result = require "mason-core.result" +local a = require "mason-core.async" local registry = require "mason-registry" local spy = require "luassert.spy" @@ -10,9 +11,8 @@ local M = {} ---@param opts? { install_opts?: PackageInstallOpts, package?: string } function M.create_context(opts) local pkg = registry.get_package(opts and opts.package or "dummy") - local handle = InstallHandle:new(pkg) - local location = InstallLocation.global() - local context = InstallContext:new(handle, location, opts and opts.install_opts or {}) + local handle = InstallHandle:new(pkg, InstallLocation.global()) + local context = InstallContext:new(handle, opts and opts.install_opts or {}) context.spawn = setmetatable({}, { __index = function(s, cmd) s[cmd] = spy.new(function() @@ -25,4 +25,39 @@ function M.create_context(opts) return context end +---@param pkg AbstractPackage +---@param opts? PackageInstallOpts +function M.sync_install(pkg, opts) + return a.run_blocking(function() + return a.wait(function(resolve, reject) + pkg:install(opts, function(success, result) + (success and resolve or reject)(result) + end) + end) + end) +end + +---@param pkg AbstractPackage +---@param opts? PackageUninstallOpts +function M.sync_uninstall(pkg, opts) + return a.run_blocking(function() + return a.wait(function(resolve, reject) + pkg:uninstall(opts, function(success, result) + (success and resolve or reject)(result) + end) + end) + end) +end + +---@param runner InstallRunner +---@param opts PackageInstallOpts +function M.sync_runner_execute(runner, opts) + local callback = spy.new() + runner:execute(opts, callback) + assert.wait(function() + assert.spy(callback).was_called() + end) + return callback +end + return M |
