Create benches for performance testing, remove profiler

## Details

Attempt to measure actual user latency by moving cursor around
and changing modes in unit test.

The profile option is no longer needed as this is a more robust
way to see what's happening.

Fix module annotation on unit tests by adding blank line.

Author: MeanderingProgrammer

CHANGELOG.md

@@ -9,6 +9,10 @@
   interchangeable. Notice of deprecation has been available for a month since
   [726c85c](https://github.com/MeanderingProgrammer/markdown.nvim/commit/726c85cb9cc6d7d9c85af6ab093e1ee53b5e3c82).
     - Ultimately removed in TODO
+- Remove `profile` field in favor of benches [2f21726](https://github.com/MeanderingProgrammer/markdown.nvim/commit/2f217266c6b416c4948ddb7e88a5db02670c75d5)
+- In order to fix:
+  - Implement `parse` method instead of `render`, no direct translation
+  - `profile` field was only meant for development, should not have any users
 
 ### Bug Fixes
 

README.md

@@ -122,8 +122,6 @@ Some of the more useful fields are discussed further down.
 require('render-markdown').setup({
     -- Whether Markdown should be rendered by default or not
     enabled = true,
-    -- Whether to track performance metrics, should only be used for development
-    profile = false,
     -- Maximum file size (in MB) that this plugin will attempt to render
     -- Any file larger than this will effectively be ignored
     max_file_size = 1.5,

benches/medium_spec.lua

@@ -0,0 +1,46 @@
+---@module 'luassert'
+
+local util = require('tests.util')
+local eq = assert.are.same
+local truthy = assert.truthy
+
+---@param f fun()
+---@return number
+local function time(f)
+    local start_ns = vim.uv.hrtime()
+    f()
+    return (vim.uv.hrtime() - start_ns) / 1e+6
+end
+
+---@param keys string
+local function feed(keys)
+    local escape = vim.api.nvim_replace_termcodes(keys, true, false, true)
+    vim.api.nvim_feedkeys(escape, 'nx', false)
+end
+
+describe('medium.md', function()
+    it('default', function()
+        local start_time = time(function()
+            util.setup('temp/medium.md')
+        end)
+        eq(2998, #util.get_actual_marks())
+
+        local move_time = time(function()
+            feed('3j')
+            -- Unsure why, but the CursorMoved event needs to be triggered manually
+            vim.api.nvim_exec_autocmds('CursorMoved', {})
+            vim.wait(0)
+        end)
+        eq(3000, #util.get_actual_marks())
+
+        local refresh_time = time(function()
+            feed('i')
+            vim.wait(0)
+        end)
+        eq(3000, #util.get_actual_marks())
+
+        truthy(start_time > 400 and start_time < 500, 'expected start time (400, 500)')
+        truthy(refresh_time > 400 and refresh_time < 500, 'expected refresh time (400, 500)')
+        truthy(move_time > 1 and move_time < 5, 'expected move time (1, 5)')
+    end)
+end)

doc/render-markdown.txt

@@ -154,8 +154,6 @@ Full Default Configuration ~
     require('render-markdown').setup({
         -- Whether Markdown should be rendered by default or not
         enabled = true,
-        -- Whether to track performance metrics, should only be used for development
-        profile = false,
         -- Maximum file size (in MB) that this plugin will attempt to render
         -- Any file larger than this will effectively be ignored
         max_file_size = 1.5,

justfile

@@ -3,8 +3,16 @@ init := "tests/minimal.lua"
 default: update test health
 
 test:
+  just busted "tests"
+
+bench:
+  just gen-medium
+  just busted "benches"
+
+[private]
+busted directory:
   nvim --headless --noplugin -u {{init}} \
-    -c "PlenaryBustedDirectory tests { minimal_init = '{{init}}', sequential=true }"
+    -c "PlenaryBustedDirectory {{directory}} { minimal_init = '{{init}}', sequential = true, keep_going = false }"
 
 health:
   nvim -c "checkhealth render-markdown" -- .
@@ -52,13 +60,17 @@ cat-log:
   cat ~/.local/state/nvim/render-markdown.log
 
 gen-medium:
-  just gen-file "1000" > temp/medium.md
+  just gen-file "1000" "temp/medium.md"
 
 gen-large:
-  just gen-file "100000" > temp/large.md
+  just gen-file "100000" "temp/large.md"
+
+[private]
+gen-file lines path:
+  {{path_exists(path)}} || just gen-file-content {{lines}} > {{path}}
 
 [private]
-gen-file lines:
+gen-file-content lines:
   #!/usr/bin/env python
   for i in range({{lines}}):
     level = "#" * ((i % 6) + 1)

lua/render-markdown/init.lua

@@ -107,7 +107,6 @@ local M = {}
 
 ---@class render.md.UserConfig
 ---@field public enabled? boolean
----@field public profile? boolean
 ---@field public max_file_size? number
 ---@field public markdown_query? string
 ---@field public markdown_quote_query? string
@@ -137,8 +136,6 @@ local M = {}
 M.default_config = {
     -- Whether Markdown should be rendered by default or not
     enabled = true,
-    -- Whether to track performance metrics, should only be used for development
-    profile = false,
     -- Maximum file size (in MB) that this plugin will attempt to render
     -- Any file larger than this will effectively be ignored
     max_file_size = 1.5,

lua/render-markdown/profiler.lua

@@ -76,7 +76,6 @@ function state.validate()
     local config = state.config
     append_errors('render-markdown', config, {
         enabled = { config.enabled, 'boolean' },
-        profile = { config.profile, 'boolean' },
         max_file_size = { config.max_file_size, 'number' },
         markdown_query = { config.markdown_query, 'string' },
         markdown_quote_query = { config.markdown_quote_query, 'string' },

lua/render-markdown/state.lua

@@ -94,7 +94,6 @@
 
 ---@class render.md.Config
 ---@field public enabled boolean
----@field public profile boolean
 ---@field public max_file_size number
 ---@field public markdown_query string
 ---@field public markdown_quote_query string

lua/render-markdown/types.lua

@@ -1,5 +1,4 @@
 local logger = require('render-markdown.logger')
-local profiler = require('render-markdown.profiler')
 local state = require('render-markdown.state')
 local util = require('render-markdown.util')
 
@@ -31,26 +30,19 @@ end
 function M.schedule_render(buf, parse)
     local mode = vim.fn.mode(true)
     vim.schedule(function()
-        if state.config.profile then
-            profiler.profile(buf, function()
-                return M.render(buf, mode, parse)
-            end)
-        else
-            M.render(buf, mode, parse)
-        end
+        M.render(buf, mode, parse)
     end)
 end
 
 ---@private
 ---@param buf integer
 ---@param mode string
 ---@param parse boolean
----@return 'invalid'|'disable'|'parsed'|'movement'
 function M.render(buf, mode, parse)
     -- Check that buffer and associated window are valid
     local win = util.buf_to_win(buf)
     if not vim.api.nvim_buf_is_valid(buf) or not vim.api.nvim_win_is_valid(win) then
-        return 'invalid'
+        return
     end
     vim.api.nvim_buf_clear_namespace(buf, M.namespace, 0, -1)
 
@@ -59,7 +51,6 @@ function M.render(buf, mode, parse)
         for name, value in pairs(state.config.win_options) do
             util.set_win(win, name, value.default)
         end
-        return 'disable'
     else
         -- Set window options to rendered & perform render
         for name, value in pairs(state.config.win_options) do
@@ -85,12 +76,6 @@ function M.render(buf, mode, parse)
                 vim.api.nvim_buf_set_extmark(buf, M.namespace, mark.start_row, mark.start_col, mark.opts)
             end
         end
-
-        if parsed then
-            return 'parsed'
-        else
-            return 'movement'
-        end
     end
 end