feat: pull emoji data from Gitlab

Instead of using an incomplete local emojis.json list, the plugin now
pulls the emoji data from Gitlab. This makes sure the data is complete
and doesn't contain invalid items, which would cause a Go server error
(e.g., cmd/config/emojis.json contained ⛵ for ⛵).

Author: jakubbortlik

cmd/config/emojis.json

@@ -297,13 +297,18 @@ you call this function with no values the defaults will be used:
       emojis = {
         -- Function for modifying how emojis are displayed in the picker. This does not affect the actual selected emoji.
         -- The function is passed an emoji object as a paramter, e.g.,
-        -- {"unicode": "1F44D","name": "thumbs up sign", "shortname": ":thumbsup:", "moji": "👍"}
+        -- {"name": "thumbs up", "shortname": ":thumbsup:", "moji": "👍", "category": "People & Body"}
         -- This is useful if your editor/terminal/font/tmux does not render some emojis properly,
-        -- e.g., you can remove skin tones and additionally show the shortname with
+        -- e.g., you can remove skin tones and additionally show the shortname and category with
         -- formatter = function(val)
-        --   return string.format("%s %s %s", val.moji:gsub("[\240][\159][\143][\187-\191]", ""), val.shortname, val.name)
+        --   return string.format("%s %s %s (%s)", val.moji:gsub("[\240][\159][\143][\187-\191]", ""), val.shortname, val.name, val.category)
         -- end
         formatter = nil,
+        -- The emoji version used by the Gitlab instance: https://{GITLAB_URL}/-/emojis/{VERSION}/emojis.json. Can be a function that receives the gitlab_url as an argument and returns the version string, e.g.:
+        -- version = function(gitlab_url)
+        --   return gitlab_url == "https://gitlab.com" and "4" or "3"
+        -- end
+        version = "4",
       },
       choose_merge_request = {
         open_reviewer = true, -- Open the reviewer window automatically after switching merge requests
@@ -595,6 +600,14 @@ To see who has reacted with an emoji, hover over the emoji. A popup will
 appear with anyone who has responded with that emoji. You can only delete
 emojis that you have responded with.
 
+The emoji data are pulled from the Gitlab server. This makes sure the data is
+complete, as compared to storing a limited list of emojis in the plugin repo.
+However, this also means that your Gitlab instance can use a different emoji
+version than the default expected by this plugin. Use
+`settings.emojis.version` to adjust to the emojis version of your particular
+Gitlab instance. You need to find the right `{VERSION}` for
+https://{GITLAB_URL}/-/emojis/{VERSION}/emojis.json.
+
 
 UPLOADING FILES                                  *gitlab.nvim.uploading-files*
 

doc/gitlab.nvim.txt

@@ -71,10 +71,10 @@
 
 ---@class EmojiMap: table<string, Emoji>
 ---@class Emoji
----@field	unicode           string
----@field	name              string
----@field	shortname         string
----@field	moji              string
+---@field name string
+---@field shortname string
+---@field moji string
+---@field category string
 
 ---@class WinbarTable
 ---@field view_type string
@@ -154,6 +154,7 @@
 ---@field keymaps? Keymaps -- Keymaps for the plugin
 ---@field popup? PopupSettings -- Settings for the popup windows
 ---@field discussion_tree? DiscussionSettings -- Settings for the popup windows
+---@field emojis? EmojisSettings -- Settings for emojis
 ---@field choose_merge_request? ChooseMergeRequestSettings -- Default settings when choosing a merge request
 ---@field info? InfoSettings -- Settings for the "info" or "summary" view
 ---@field mergeability_checks? MergeabilityChecksSettings -- Settings for the mergeability checks in the "summary" view
@@ -308,7 +309,11 @@
 ---@field draft_mode? boolean -- Whether comments are posted as drafts as part of a review
 ---@field winbar? function -- Custom function to return winbar title, should return a string. Provided with WinbarTable (defined in annotations.lua)
 
----@class ExpanderOpts: table<string string>
+---@class EmojisSettings: table
+---@field formatter? function -- Custom function to modify how emojis are displayed in the picker.
+---@field version? string|fun(gitlab_url: string):string -- The (function that returns the) emoji version used by the Gitlab instance: https://{GITLAB_URL}/-/emojis/{VERSION}/emojis.json.
+
+---@class ExpanderOpts: table<string, string>
 ---@field expanded? string -- Icon for expanded discussion thread
 ---@field collapsed? string -- Icon for collapsed discussion thread
 ---@field indentation? string -- Indentation Icon

lua/gitlab/annotations.lua

@@ -51,7 +51,7 @@ M.sequence = function(dependencies, cb)
 
     -- Sets configuration for plugin, if not already set
     if not state.initialized then
-      if not state.setPluginConfiguration() then
+      if not state.set_plugin_configuration() then
         return
       end
     end

lua/gitlab/async.lua

@@ -1,38 +1,46 @@
 local u = require("gitlab.utils")
 local common = require("gitlab.actions.common")
-local state = require("gitlab.state")
+
+-- Basic emoji aliases that are missing in Gitlab's list.
+local thumbsup = { name = "+1", shortname = ":+1:", moji = "👍", category = "People & Body" }
+local thumbsdown = { name = "-1", shortname = ":-1:", moji = "👎", category = "People & Body" }
 
 local M = {
-  ---@type EmojiMap|nil
-  emoji_map = {},
+  ---@type EmojiMap
+  emoji_map = { ["+1"] = thumbsup, ["-1"] = thumbsdown },
   ---@type Emoji[]
-  emoji_list = {},
+  emoji_list = { thumbsup, thumbsdown },
 }
 
+-- Fetch emojis from Gitlab and make them available in the plugin.
 M.init = function()
-  local root_path = state.settings.root_path
-  local emoji_path = root_path
-    .. state.settings.file_separator
-    .. "cmd"
-    .. state.settings.file_separator
-    .. "config"
-    .. state.settings.file_separator
-    .. "emojis.json"
-  local emojis = u.read_file(emoji_path)
-  if emojis == nil then
-    u.notify("Could not read emoji file at " .. emoji_path, vim.log.levels.WARN)
-  end
-
-  local data_ok, data = pcall(vim.json.decode, emojis)
-  if not data_ok then
-    u.notify("Could not parse emoji file at " .. emoji_path, vim.log.levels.WARN)
-  end
-
-  M.emoji_map = data
-  M.emoji_list = {}
-  for _, v in pairs(M.emoji_map) do
-    table.insert(M.emoji_list, v)
-  end
+  local settings = require("gitlab.state").settings
+  local version = type(settings.emojis.version) == "function" and settings.emojis.version(settings.gitlab_url)
+    or settings.emojis.version
+  local emojis_url = settings.gitlab_url .. "/-/emojis/" .. version .. "/emojis.json"
+  local command = { "curl", emojis_url }
+  vim.system(command, { text = true }, function(result)
+    vim.schedule(function()
+      if result.code ~= 0 then
+        require("gitlab.utils").notify(result.stderr, vim.log.levels.ERROR)
+      else
+        local data_ok, data = pcall(vim.json.decode, result.stdout)
+        if not data_ok then
+          local message = "Could not get emojis from "
+            .. emojis_url
+            .. (data ~= nil and string.format(". JSON.decode error: %s", data) or "")
+          u.notify(message, vim.log.levels.ERROR)
+          u.notify(result.stdout, vim.log.levels.DEBUG)
+          return
+        end
+        for _, v in ipairs(data or {}) do
+          local emoji = { name = v.d, shortname = string.format(":%s:", v.n), moji = v.e, category = v.c }
+          M.emoji_map[v.n] = emoji
+          table.insert(M.emoji_list, emoji)
+        end
+      end
+    end)
+  end)
 end
 
 -- Define the popup window options
@@ -80,7 +88,7 @@ M.init_popup = function(tree, bufnr)
       local note_node = common.get_note_node(tree, node)
       local root_node = common.get_root_node(tree, node)
       local note_id_str = tostring(note_node.is_root and root_node.root_note_id or note_node.id)
-      local emojis = state.DISCUSSION_DATA.emojis
+      local emojis = require("gitlab.state").DISCUSSION_DATA.emojis
 
       local note_emojis = emojis[note_id_str]
       if note_emojis == nil then
@@ -131,11 +139,12 @@ M.get_users_who_reacted_with_emoji = function(name, note_emojis)
 end
 
 M.pick_emoji = function(options, cb)
+  local settings = require("gitlab.state").settings
   vim.ui.select(options, {
     prompt = "Choose emoji",
     format_item = function(val)
-      if type(state.settings.emojis.formatter) == "function" then
-        return state.settings.emojis.formatter(val)
+      if type(settings.emojis.formatter) == "function" then
+        return settings.emojis.formatter(val)
       end
       return string.format("%s %s", val.moji, val.name)
     end,

lua/gitlab/emoji.lua

@@ -45,6 +45,7 @@ local function setup(args)
   end
 
   state.merge_settings(args) -- Merges user settings with default settings
+  state.set_plugin_configuration() -- Sets auth_token and gitlab_url into the settings module
   server.build() -- Builds the Go binary if it doesn't exist
   state.set_global_keymaps() -- Sets keymaps that are not bound to a specific buffer
   require("gitlab.colors") -- Sets colors

lua/gitlab/init.lua

@@ -190,6 +190,7 @@ M.settings = {
   },
   emojis = {
     formatter = nil,
+    version = "4",
   },
   create_mr = {
     target = nil,
@@ -501,7 +502,7 @@ end
 -- then attemps to read a `.gitlab.nvim` configuration file.
 -- If after doing this, any variables are missing, alerts the user.
 -- The `.gitlab.nvim` configuration file takes precedence.
-M.setPluginConfiguration = function()
+M.set_plugin_configuration = function()
   if M.initialized then
     return true
   end