Module: HeadlessBrowserTool::SessionPersistence

Defined in:
lib/headless_browser_tool/session_persistence.rb

Overview

rubocop:disable Metrics/ModuleLength

Constant Summary collapse

BLANK_URLS = 
["about:blank", "data:,"].freeze
SESSIONS_DIR = 
File.join(".hbt", "sessions").freeze

Class Method Summary collapse

Class Method Details

.delete_session(session_id) ⇒ Object 



84
85
86
87
 
# File 'lib/headless_browser_tool/session_persistence.rb', line 84

def delete_session(session_id)
  session_file = File.join(SESSIONS_DIR, "#{session_id}.json")
  FileUtils.rm_f(session_file)
end

.extract_cookies(session) ⇒ Object 



89
90
91
92
93
94
 
# File 'lib/headless_browser_tool/session_persistence.rb', line 89

def extract_cookies(session)
  session.driver.browser.manage.all_cookies
rescue StandardError => e
  HeadlessBrowserTool::Logger.log.info "Error extracting cookies: #{e.message}"
  []
end

.extract_storage(session, storage_type) ⇒ Object 



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/headless_browser_tool/session_persistence.rb', line 96

def extract_storage(session, storage_type)
  return {} if BLANK_URLS.include?(session.current_url)

  session.evaluate_script(<<~JS)
    (() => {
      const items = {};
      for (let i = 0; i < #{storage_type}.length; i++) {
        const key = #{storage_type}.key(i);
        items[key] = #{storage_type}.getItem(key);
      }
      return items;
    })()
  JS
rescue StandardError => e
  HeadlessBrowserTool::Logger.log.info "Error extracting #{storage_type}: #{e.message}"
  {}
end

.extract_window_size(session) ⇒ Object 



114
115
116
117
118
119
120
 
# File 'lib/headless_browser_tool/session_persistence.rb', line 114

def extract_window_size(session)
  size = session.current_window.size
  { "width" => size[0], "height" => size[1] }
rescue StandardError => e
  HeadlessBrowserTool::Logger.log.info "Error extracting window size: #{e.message}"
  nil
end

.restore_cookies(session, cookies) ⇒ Object 



122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/headless_browser_tool/session_persistence.rb', line 122

def restore_cookies(session, cookies)
  return if cookies.nil? || cookies.empty?

  cookies.each do |cookie|
    cookie_hash = cookie.transform_keys(&:to_sym)
    # Remove browser-specific fields that can't be set
    cookie_hash.delete(:same_site)
    cookie_hash.delete(:http_only) unless cookie_hash[:httpOnly]
    session.driver.browser.manage.add_cookie(cookie_hash)
  end
rescue StandardError => e
  HeadlessBrowserTool::Logger.log.info "Error restoring cookies: #{e.message}"
end

.restore_session(session_id, capybara_session) ⇒ Object 



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
 
# File 'lib/headless_browser_tool/session_persistence.rb', line 38

def restore_session(session_id, capybara_session)
  session_file = File.join(SESSIONS_DIR, "#{session_id}.json")
  return unless File.exist?(session_file)

  begin
    state = JSON.parse(File.read(session_file))
    HeadlessBrowserTool::Logger.log.info "Restoring session from #{session_file}"

    # Visit the URL first (needed to set cookies/storage for the domain)
    capybara_session.visit(state["current_url"]) if state["current_url"] && !BLANK_URLS.include?(state["current_url"])

    # Restore cookies
    restore_cookies(capybara_session, state["cookies"]) if state["cookies"]

    # Restore localStorage
    restore_storage(capybara_session, "localStorage", state["local_storage"]) if state["local_storage"]

    # Restore sessionStorage
    restore_storage(capybara_session, "sessionStorage", state["session_storage"]) if state["session_storage"]

    # Restore window size
    if state["window_size"]
      capybara_session.current_window.resize_to(
        state["window_size"]["width"],
        state["window_size"]["height"]
      )
    end

    HeadlessBrowserTool::Logger.log.info "Session restored successfully"
    true
  rescue StandardError => e
    HeadlessBrowserTool::Logger.log.info "Error restoring session: #{e.message}"
    # Delete corrupted state file
    begin
      File.delete(session_file)
    rescue StandardError
      nil
    end
    false
  end
end

.restore_storage(session, storage_type, storage_data) ⇒ Object 



136
137
138
139
140
141
142
143
144
 
# File 'lib/headless_browser_tool/session_persistence.rb', line 136

def restore_storage(session, storage_type, storage_data)
  return if storage_data.nil? || storage_data.empty? || BLANK_URLS.include?(session.current_url)

  storage_data.each do |key, value|
    session.execute_script("#{storage_type}.setItem(#{key.to_json}, #{value.to_json})")
  end
rescue StandardError => e
  HeadlessBrowserTool::Logger.log.info "Error restoring #{storage_type}: #{e.message}"
end

.save_session(session_id, capybara_session) ⇒ Object 



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/headless_browser_tool/session_persistence.rb', line 14

def save_session(session_id, capybara_session)
  return unless session_id && capybara_session

  FileUtils.mkdir_p(SESSIONS_DIR)
  session_file = File.join(SESSIONS_DIR, "#{session_id}.json")

  begin
    state = {
      session_id: session_id,
      saved_at: Time.now.iso8601,
      current_url: capybara_session.current_url,
      cookies: extract_cookies(capybara_session),
      local_storage: extract_storage(capybara_session, "localStorage"),
      session_storage: extract_storage(capybara_session, "sessionStorage"),
      window_size: extract_window_size(capybara_session)
    }

    File.write(session_file, JSON.pretty_generate(state))
    HeadlessBrowserTool::Logger.log.info "Saved session to #{session_file}"
  rescue StandardError => e
    HeadlessBrowserTool::Logger.log.info "Error saving session: #{e.message}"
  end
end

.session_exists?(session_id) ⇒ Boolean

Returns:

  • (Boolean) 


80
81
82
 
# File 'lib/headless_browser_tool/session_persistence.rb', line 80

def session_exists?(session_id)
  File.exist?(File.join(SESSIONS_DIR, "#{session_id}.json"))
end