feat!: `get_current()` returns custom session save directory if available #31

Subjective · 2023-09-15T02:14:39Z

Currently, there is no easy way (afaik) to retrieve session data for sessions not stored in the default save directory from within the session itself. It would be nice if the API exposed a function to do exactly that. One fairly clean way of doing this might be to add this functionality to the existing get_current(), by allowing it to have a second optional return string representing the save directory. This way, data for the current session can be retrieved (no matter the save directory) like this:

local resession = require "resession"
local files = require "resession.files"
local util = require "resession.util"

local filename = util.get_session_file(resession.get_current())
local data = files.load_json_file(filename)

If you're wondering what my use case is, I would like to have my Grapple tags specific to a session, and one way to do this by having a custom resolver that creates a scope based on the cwd of the current session. (Since projects.nvim autochanges the directory, it's necessary to have the scope resolved to global cwd stored by resession.nvim as opposed to the vim's cwd so that the tags don't get reset). This allows Grapple's builtin resession extension to function seamlessly in this kind of workflow.

Example Grapple setup

local scope = require "grapple.scope"
local resession = require "resession"
local files = require "resession.files"
local util = require "resession.util"

local get_session_path = function(session_name, dirname)
  if session_name then
    local filename = util.get_session_file(session_name, dirname)
    local data = files.load_json_file(filename)
    if data then
      local session_cwd = data.tab_scoped and data.tabs[1].cwd or data.global.cwd
      return string.format("%s", session_cwd)
    end
  end
end

local session_path = scope.resolver(function()
  if resession.get_current() then return string.format("%s", get_session_path(resession.get_current())) end
end, { cache = false, persist = false })

local resolver = scope.fallback {
  session_path,
  require("grapple.scope_resolvers").git,
}

local format_title = function()
  local current_session, session_dir = resession.get_current()
  if current_session then
    local title = string.format(" %s [%s] ", current_session, util.shorten_path(get_session_path(current_session, session_dir)))
    return #title > 50 and string.format(" %s ", current_session) or title
  else
    local git_root = require("grapple.state").ensure_loaded(require("grapple.scope_resolvers").git)
    return string.format(" %s ", git_root ~= vim.env.HOME and util.shorten_path(git_root) or git_root)
  end
end

resession.add_hook("pre_save", function()
  if require("resession").get_current() == nil then
    require("grapple").save()
    require("grapple.settings").integrations.resession = true
  end
end)
resession.add_hook("pre_load", function()
  require("grapple").save()
  require("grapple.settings").integrations.resession = true
end)

local unload_scopes = function()
  local grapple_state = require("grapple.state").state()
  for loaded_scope, _ in pairs(grapple_state) do
    if loaded_scope ~= get_session_path(resession.get_current()) then require("grapple.state").reset(loaded_scope, true) end
  end
end
resession.add_hook("post_save", function() unload_scopes() end)
resession.add_hook("post_load", function() unload_scopes() end)

Subjective · 2023-09-15T02:15:56Z

Not sure why the generate script for docs formatted the return types like this:

Type	Desc
string	?, string?

stevearc

I'll admit I don't think I fully understand your problem or how this solves it, but I'm fine with an API change that supports returning more data about the current session.

I think I would prefer this to go into a new method, something like get_current_session_info that can return an object with the name & dir of the session. That makes it much easier to extend in the future if we ever add more metadata about sessions.

… available"

stevearc · 2023-09-18T18:04:38Z

lua/resession/types.lua

+---@class resession.SessionInfo
+---@field name nil|string Name of the current session
+---@field directory nil|string Name of the directory that the current session is saved in


name should be non-nilable, and I believe directory should be as well

I set the directory in session_configs to the default value if it wasn't provided.

lua/resession/init.lua

stevearc · 2023-09-18T18:06:14Z

lua/resession/init.lua

+  local session_info = {}
+  local session = M.get_current()
+  if session_info[session] ~= nil then
+    session_info.dir = session_info[session].dir
+  end
+  return session_info
+end


This will never work because the local session_info will override the global one. if session_info[session] will always be nil. Did you test this at all?

Also, you aren't setting the session name on the return value.

Sorry, I don't know what I was thinking at the time. It should be fixed now.

stevearc · 2023-09-18T23:36:55Z

Looks good, thanks!

Subjective added 2 commits September 14, 2023 17:14

feat!: get_current returns custom session save directory if available

f7fc6b9

doc: update docs for get_current()

58777a8

refactor: simplify tenary logic

de85902

Subjective mentioned this pull request Sep 15, 2023

feat: add get_session_data() function to retrieve session session data #32

Closed

Subjective changed the title ~~feat!: get_current returns custom session save directory if available~~ feat!: get_current() returns custom session save directory if available Sep 15, 2023

stevearc requested changes Sep 16, 2023

View reviewed changes

Revert "feat!: get_current returns custom session save directory if…

f77e7ff

… available"

Subjective force-pushed the patch-7 branch 2 times, most recently from cfc4e52 to fbe1885 Compare September 18, 2023 06:01

feat: add get_current_session_info()

b89f400

Subjective force-pushed the patch-7 branch from fbe1885 to b89f400 Compare September 18, 2023 06:02

stevearc requested changes Sep 18, 2023

View reviewed changes

Subjective and others added 5 commits September 18, 2023 15:46

fix: implement suggestions

64a6c5c

fix: store session dir in session_configs

6e38f28

fix: don't return full save_dir path

e1d75c7

docs: rename directory to dir

de5144a

Merge branch 'master' into patch-7

c710a80

stevearc merged commit 5fc35f6 into stevearc:master Sep 18, 2023

github-actions bot mentioned this pull request Sep 15, 2023

chore(master): release 1.2.0 #29

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat!: `get_current()` returns custom session save directory if available #31

feat!: `get_current()` returns custom session save directory if available #31

Uh oh!

Subjective commented Sep 15, 2023 •

edited

Loading

Uh oh!

Subjective commented Sep 15, 2023

Uh oh!

stevearc left a comment

Uh oh!

stevearc Sep 18, 2023

Uh oh!

Subjective Sep 18, 2023

Uh oh!

Uh oh!

stevearc Sep 18, 2023

Uh oh!

Subjective Sep 18, 2023

Uh oh!

stevearc commented Sep 18, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat!: get_current() returns custom session save directory if available #31

feat!: get_current() returns custom session save directory if available #31

Uh oh!

Conversation

Subjective commented Sep 15, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Subjective commented Sep 15, 2023

Uh oh!

stevearc left a comment

Choose a reason for hiding this comment

Uh oh!

stevearc Sep 18, 2023

Choose a reason for hiding this comment

Uh oh!

Subjective Sep 18, 2023

Choose a reason for hiding this comment

Uh oh!

Uh oh!

stevearc Sep 18, 2023

Choose a reason for hiding this comment

Uh oh!

Subjective Sep 18, 2023

Choose a reason for hiding this comment

Uh oh!

stevearc commented Sep 18, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

feat!: `get_current()` returns custom session save directory if available #31

feat!: `get_current()` returns custom session save directory if available #31

Subjective commented Sep 15, 2023 •

edited

Loading