Skip to content

Rename :path option #4

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

Open
mgwidmann wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Rename :path option #4

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
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ plug Plug.Session,
encryption_salt: "654321", #
ttl: 360, # use redis EXPIRE secs
serializer: CustomSerializer, # Optional, defaults to `PlugSessionRedis.BinaryEncoder`
path: &MyPath.path/1 # Optional, defaults to passing the session ID through unmodified
db_path: &MyPath.path/1 # Optional, defaults to passing the session ID through unmodified
```

## Custom Serializers
Expand All @@ -46,7 +46,7 @@ An example serializer is shown in `lib/plug_session_redis/binary_encoder.ex`. Fo

## Storing data in another key

The `:path` option above when configuring the plug lets you define a function which will take in the session ID binary string and returns a new storage location. If you'd like, for example, to store all sessions under the key `"myapp:sessions:" <> id` then an example implementation of the above configured `MyPath.path/1` would look like this:
The `:db_path` option above when configuring the plug lets you define a function which will take in the session ID binary string and returns a new storage location. If you'd like, for example, to store all sessions under the key `"myapp:sessions:" <> id` then an example implementation of the above configured `MyPath.path/1` would look like this:

```elixir
defmodule MyPath do
Expand Down
20 changes: 10 additions & 10 deletions lib/plug_session_redis/store.ex
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,22 @@ defmodule PlugSessionRedis.Store do
```
plug Plug.Session,
store: PlugSessionRedis.Store,
key: "_my_app_key", # Cookie name where the id is stored
table: :redis_sessions, # Name of poolboy queue, make up anything
signing_salt: "123456", # Keep this private
encryption_salt: "654321", # Keep this private
ttl: 360, # Optional, defaults to :infinity
serializer: CustomSerializer, # Optional, defaults to `PlugSessionRedis.BinaryEncoder`
path: &MyPath.path_for_sid/1 # Optional, defaults to the passed in session id only
key: "_my_app_key", # Cookie name where the id is stored
table: :redis_sessions, # Name of poolboy queue, make up anything
signing_salt: "123456", # Keep this private
encryption_salt: "654321", # Keep this private
ttl: 360, # Optional, defaults to :infinity
serializer: CustomSerializer, # Optional, defaults to `PlugSessionRedis.BinaryEncoder`
db_path: &MyPath.path_for_sid/1 # Optional, defaults to the passed in session id only
```

Custom Serializers can work to provide a way to encode and decode the data stored in Redis if you're integrating
with a legacy system. You provide the module name that implements `encode/1`, `encode!/1`, `decode/1`, and `decode!/1`
which is called by `Plug` when fetching and storing the session state back.

Path dictates under what key within redis to store the key. You will be passed a single session ID binary and expected
DB path dictates under what key within redis to store the key. You will be passed a single session ID binary and expected
to return another binary indicating where the key should be stored/fetched from. This allows you to store data under
a nested key so that other data can be stored within the same database. (i.e. key can become "sessions:" <> id instead)
a nested key so that other data can be stored within the same database. (i.e. key can become `"sessions:" <> id` instead)
"""
alias PlugSessionRedis.BinaryEncoder
@behaviour Plug.Session.Store
Expand All @@ -30,7 +30,7 @@ defmodule PlugSessionRedis.Store do
Keyword.fetch!(opts, :table),
Keyword.get(opts, :ttl, :infinite),
Keyword.get(opts, :serializer, BinaryEncoder),
Keyword.get(opts, :path, &__MODULE__.path/1)
Keyword.get(opts, :db_path, &__MODULE__.path/1)
}
end

Expand Down