aboutsummaryrefslogtreecommitdiffstats
path: root/lua/mason-registry/init.lua
blob: ad8eef5a6025fa890e0da93e4b56dcc73c200e06 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
local EventEmitter = require "mason-core.EventEmitter"
local InstallLocation = require "mason-core.installer.InstallLocation"
local log = require "mason-core.log"
local uv = vim.loop
local LazySourceCollection = require "mason-registry.sources"

-- singleton
local Registry = EventEmitter:new()

Registry.sources = LazySourceCollection:new()
---@type table<string, string[]>
Registry.aliases = {}

---@param pkg_name string
function Registry.is_installed(pkg_name)
    local ok, stat = pcall(uv.fs_stat, InstallLocation.global():package(pkg_name), "r", 438)
    return ok and stat.type == "directory"
end

---Returns an instance of the Package class if the provided package name exists. This function errors if a package
---cannot be found.
---@param pkg_name string
---@return Package
function Registry.get_package(pkg_name)
    for source in Registry.sources:iterate() do
        local pkg = source:get_package(pkg_name)
        if pkg then
            return pkg
        end
    end
    log.fmt_error("Cannot find package %q.", pkg_name)
    error(("Cannot find package %q."):format(pkg_name))
end

function Registry.has_package(pkg_name)
    local ok = pcall(Registry.get_package, pkg_name)
    return ok
end

function Registry.get_installed_package_names()
    local fs = require "mason-core.fs"
    if not fs.sync.dir_exists(InstallLocation.global():package()) then
        return {}
    end
    local entries = fs.sync.readdir(InstallLocation:global():package())
    local directories = {}
    for _, entry in ipairs(entries) do
        if entry.type == "directory" then
            directories[#directories + 1] = entry.name
        end
    end
    -- TODO: validate that entry is a mason package
    return directories
end

function Registry.get_installed_packages()
    return vim.tbl_map(Registry.get_package, Registry.get_installed_package_names())
end

function Registry.get_all_package_names()
    local pkgs = {}
    for source in Registry.sources:iterate() do
        for _, name in ipairs(source:get_all_package_names()) do
            pkgs[name] = true
        end
    end
    return vim.tbl_keys(pkgs)
end

function Registry.get_all_packages()
    return vim.tbl_map(Registry.get_package, Registry.get_all_package_names())
end

function Registry.get_all_package_specs()
    local specs = {}
    for source in Registry.sources:iterate() do
        for _, spec in ipairs(source:get_all_package_specs()) do
            if not specs[spec.name] then
                specs[spec.name] = spec
            end
        end
    end
    return vim.tbl_values(specs)
end

---Register aliases for the specified packages
---@param new_aliases table<string, string[]>
function Registry.register_package_aliases(new_aliases)
    for pkg_name, pkg_aliases in pairs(new_aliases) do
        Registry.aliases[pkg_name] = Registry.aliases[pkg_name] or {}
        for _, alias in pairs(pkg_aliases) do
            if alias ~= pkg_name then
                table.insert(Registry.aliases[pkg_name], alias)
            end
        end
    end
end

---@param name string
function Registry.get_package_aliases(name)
    return Registry.aliases[name] or {}
end

---@param callback? fun(success: boolean, updated_registries: RegistrySource[])
function Registry.update(callback)
    log.debug "Updating the registry."
    local a = require "mason-core.async"
    local installer = require "mason-registry.installer"
    local noop = function() end

    a.run(function()
        if installer.channel then
            log.trace "Registry update already in progress."
            return installer.channel:receive():get_or_throw()
        else
            return installer
                .install(Registry.sources)
                :on_success(function(updated_registries)
                    Registry:emit("update", updated_registries)
                end)
                :get_or_throw()
        end
    end, callback or noop)
end

local REGISTRY_STORE_TTL = 86400 -- 24 hrs

---@param callback? fun(success: boolean, updated_registries: RegistrySource[])
function Registry.refresh(callback)
    log.debug "Refreshing the registry."
    local a = require "mason-core.async"
    local installer = require "mason-registry.installer"

    local state = installer.get_registry_state()
    if state and Registry.sources:is_all_installed() then
        local registry_age = os.time() - state.timestamp

        if registry_age <= REGISTRY_STORE_TTL and state.checksum == Registry.sources:checksum() then
            log.fmt_debug(
                "Registry refresh is not necessary yet. Registry age=%d, checksum=%s",
                registry_age,
                state.checksum
            )
            if callback then
                callback(true, {})
            end
            return
        end
    end

    local function async_update()
        return a.wait(function(resolve, reject)
            Registry.update(function(success, result)
                if success then
                    resolve(result)
                else
                    reject(result)
                end
            end)
        end)
    end

    if not callback then
        -- We don't want to error in the synchronous version because of how this function is recommended to be used in
        -- 3rd party code. If accessing the update result is required, users are recommended to pass a callback.
        pcall(a.run_blocking, async_update)
    else
        a.run(async_update, callback)
    end
end

return Registry