Skip to content

Prevent empty sessions from being stored (lazy session creation) #113

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sdogruyol merged 1 commit into from
Feb 2, 2026
Merged

Prevent empty sessions from being stored (lazy session creation) #113

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions spec/base_spec.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,8 @@ describe "Session" do
Kemal::Session.destroy_all
Kemal::Session.all.size.should eq(0)
3.times do
Kemal::Session.new(create_context(Random::Secure.hex))
session = Kemal::Session.new(create_context(Random::Secure.hex))
session.int("test", 1) # Write data so session is persisted
end
Kemal::Session.all.size.should eq(3)
end
Expand All @@ -262,7 +263,8 @@ describe "Session" do
it "should iterate through all sessions" do
Kemal::Session.destroy_all
5.times do
Kemal::Session.new(create_context(Random::Secure.hex))
session = Kemal::Session.new(create_context(Random::Secure.hex))
session.int("test", 1) # Write data so session is persisted
end
count = 0
Kemal::Session.each do |session|
Expand Down
22 changes: 18 additions & 4 deletions spec/file_spec.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,6 +251,7 @@ describe "Session::FileEngine" do
describe ".destroy" do
it "should remove session from filesystem" do
session = Kemal::Session.new(create_context(SESSION_ID))
session.int("test", 1) # Write data so session is persisted
File.file?(SESSION_DIR + SESSION_ID + ".json").should be_true
session.destroy
File.file?(SESSION_DIR + SESSION_ID + ".json").should be_false
Expand All @@ -260,6 +261,7 @@ describe "Session::FileEngine" do
describe "#destroy" do
it "should remove session from filesystem" do
session = Kemal::Session.new(create_context(SESSION_ID))
session.int("test", 1) # Write data so session is persisted
File.file?(SESSION_DIR + SESSION_ID + ".json").should be_true
Kemal::Session.destroy(SESSION_ID)
File.file?(SESSION_DIR + SESSION_ID + ".json").should be_false
Expand All @@ -272,7 +274,10 @@ describe "Session::FileEngine" do

describe "#run_gc" do
it "should remove all sessions that are older than gc config" do
2.times { Kemal::Session.new(create_context(Random::Secure.hex)) }
2.times do
session = Kemal::Session.new(create_context(Random::Secure.hex))
session.int("test", 1) # Write data so session is persisted
end
Kemal::Session.all.size.should eq(2)

# should remove nothing, as the gc > now
Expand All @@ -288,7 +293,10 @@ describe "Session::FileEngine" do

describe "#destroy_all" do
it "should remove all sessions in filesystem" do
5.times { Kemal::Session.new(create_context(Random::Secure.hex)) }
5.times do
session = Kemal::Session.new(create_context(Random::Secure.hex))
session.int("test", 1) # Write data so session is persisted
end
Kemal::Session.all.size.should eq(5)

Kemal::Session.destroy_all
Expand Down Expand Up @@ -346,7 +354,10 @@ describe "Session::FileEngine" do
end

it "should return an array of Sessions" do
3.times { Kemal::Session.new(create_context(Random::Secure.hex)) }
3.times do
session = Kemal::Session.new(create_context(Random::Secure.hex))
session.int("test", 1) # Write data so session is persisted
end
arr = Kemal::Session.all
arr.is_a?(Array).should be_true
arr.size.should eq(3)
Expand All @@ -355,7 +366,10 @@ describe "Session::FileEngine" do

describe "#each" do
it "should iterate over all sessions" do
5.times { Kemal::Session.new(create_context(Random::Secure.hex)) }
5.times do
session = Kemal::Session.new(create_context(Random::Secure.hex))
session.int("test", 1) # Write data so session is persisted
end
count = 0
Kemal::Session.each do |session|
count = count + 1
Expand Down
5 changes: 3 additions & 2 deletions src/kemal-session/base.cr
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ module Kemal

if id.nil? || !valid
id = Random::Secure.hex
Kemal::Session.config.engine.create_session(id)
# Session will be created lazily when data is written
# This prevents empty sessions from being stored (e.g., from bots/crawlers)
end

ctx.response.cookies << Session.create_cookie(id)
Expand Down Expand Up @@ -52,7 +53,7 @@ module Kemal
destroy
if context = @context
@id = Random::Secure.hex
Kemal::Session.config.engine.create_session(@id)
# Session will be created lazily when data is written
context.response.cookies << self.class.create_cookie(@id)
end
end
Expand Down