From 6a7662760c515c74f2c37fc825776ead65d307f9 Mon Sep 17 00:00:00 2001
From: William Boman <william@redwill.se>
Date: Tue, 7 Nov 2023 00:29:18 +0100
Subject: 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)
```
---
 lua/mason-core/installer/compiler/init.lua | 23 +++++++++--------------
 1 file changed, 9 insertions(+), 14 deletions(-)

(limited to 'lua/mason-core/installer/compiler/init.lua')

diff --git a/lua/mason-core/installer/compiler/init.lua b/lua/mason-core/installer/compiler/init.lua
index e1df6784..4eed986b 100644
--- a/lua/mason-core/installer/compiler/init.lua
+++ b/lua/mason-core/installer/compiler/init.lua
@@ -71,9 +71,9 @@ local function upsert(dst, src)
 end
 
 ---@param source RegistryPackageSource
----@param version string
+---@param version string?
 local function coalesce_source(source, version)
-    if source.version_overrides then
+    if version and source.version_overrides then
         for i = #source.version_overrides, 1, -1 do
             local version_override = source.version_overrides[i]
             local version_type, constraint = unpack(_.split(":", version_override.constraint))
@@ -94,18 +94,12 @@ local function coalesce_source(source, version)
                 end):get_or_else(false)
 
                 if version_match then
-                    if version_override.id then
-                        -- Because this entry provides its own purl id, it overrides the entire source definition.
-                        return version_override
-                    else
-                        -- Upsert the default source with the contents of the version override.
-                        return upsert(vim.deepcopy(source), _.dissoc("constraint", version_override))
-                    end
+                    return _.dissoc("constraint", version_override)
                 end
             end
         end
     end
-    return source
+    return _.dissoc("version_overrides", source)
 end
 
 ---@param spec RegistryPackageSpec
@@ -121,7 +115,7 @@ function M.parse(spec, opts)
             )
         end
 
-        local source = opts.version and coalesce_source(spec.source, opts.version) or spec.source
+        local source = coalesce_source(spec.source, opts.version)
 
         ---@type Purl
         local purl = try(Purl.parse(source.id))
@@ -149,7 +143,7 @@ end
 ---@async
 ---@param spec RegistryPackageSpec
 ---@param opts PackageInstallOpts
-function M.compile(spec, opts)
+function M.compile_installer(spec, opts)
     log.debug("Compiling installer.", spec.name, opts)
     return Result.try(function(try)
         -- Parsers run synchronously and may access API functions, so we schedule before-hand.
@@ -210,9 +204,10 @@ function M.compile(spec, opts)
                 ctx.receipt:with_source {
                     type = ctx.package.spec.schema,
                     id = Purl.compile(parsed.purl),
+                    -- Exclude the "install" field from "mason" sources because this is a Lua function.
+                    raw = parsed.purl.type == "mason" and _.dissoc("install", parsed.raw_source) or parsed.raw_source,
                 }
-            end):on_failure(function(err)
-                error(err, 0)
+                ctx.receipt:with_install_options(opts)
             end)
         end
     end)
-- 
cgit v1.2.3-70-g09d2