expressjs/session

update Readme to include details on extending Store implementation from store.js

Open

#349 opened on Aug 30, 2016

View on GitHub
 (4 comments) (2 reactions) (0 assignees)JavaScript (977 forks)batch import
docshelp wanted

Repository metrics

Stars
 (6,073 stars)
PR merge metrics
 (Avg merge 15d 22h) (1 merged PR in 30d)

Description

As noted in a comment on #97, developers who want to write a Store implementation either need to:

  1. extend their Store from express-session's store.js, which typically means requiring express-session as a dependency
  2. implement their own version of the functionality in store.js, session.js, and cookie.js (or copy the files from express-session)

This is because express-session requires the following methods on the Store in order to work:

  • regenerate()
  • load()
  • createSession()

These are available in store.js, but createSession itself requires both session.js and cookie.js.

The documentation should be updated to provide guidance on these facts.

Contributor guide

Research direction
Update the README to explain that developers implementing a custom Store must either extend from store.js (which requires express session as a dependency) or replicate methods from store.js, session.js, and cookie.js. Refer to the comment on issue #97 for context. The documentation should specify that three methods are required: regenerate(), load(), and createSession().
Tech stack
nodejsexpress
Domain
backenddocumentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Node.js basicsExpress session middleware
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80