https://github.com/chalk-hwang/koa-session-dynamodb-store
It is extension of koa-session that uses DynamoDB as session store inspired by dynamodb-store.
https://github.com/chalk-hwang/koa-session-dynamodb-store
dynamodb dynamodb-local koa-session koa2 sessoin store
Last synced: 5 months ago
JSON representation
It is extension of koa-session that uses DynamoDB as session store inspired by dynamodb-store.
- Host: GitHub
- URL: https://github.com/chalk-hwang/koa-session-dynamodb-store
- Owner: chalk-hwang
- License: mit
- Archived: true
- Created: 2018-12-15T20:38:05.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-03-21T18:09:51.000Z (over 4 years ago)
- Last Synced: 2025-01-20T09:19:03.790Z (5 months ago)
- Topics: dynamodb, dynamodb-local, koa-session, koa2, sessoin, store
- Language: JavaScript
- Homepage:
- Size: 110 KB
- Stars: 5
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# koa-session-dynamodb-store
[![NPM version][npm-image]][npm-url]
[![npm download][download-image]][download-url]
[npm-image]: https://img.shields.io/npm/v/koa-session-dynamodb-store.svg?style=flat-square
[npm-url]: https://npmjs.org/package/koa-session-dynamodb-store
[download-image]: https://img.shields.io/npm/dt/koa-session-dynamodb-store.svg?style=flat-square
[download-url]: https://npmjs.org/package/koa-session-dynamodb-store
It is extension of [koa-session](https://github.com/koajs/session) that uses [DynamoDB](https://aws.amazon.com/dynamodb/) as session store inspired by [dynamodb-store](https://github.com/rafaelrpinto/dynamodb-store).
The project uses the following stack:
- ES2017
- Babel
- Eslint with AirBnB style
- Yarn
- Flow
## Installation
`yarn add koa-session-dynamodb-store`
or
`npm install --save koa-session-dynamodb-store`
## Usage
Usage within koa:
```javascript
const koaSession = require("koa-session");
const DynamoDBStore = require('koa-session-dynamodb-store');
const options = {
table: {
autoCreate: true // You should set this option to true if you want to automatically create a DynamoDB table for your session.
}
}
app.use(koaSession({
store: new DynamoDBStore(options),
...
}, app));
```
Usage within dynamodb-local:
```javascript
const koaSession = require("koa-session");
const DynamoDBStore = require('koa-session-dynamodb-store');
const dynamoDBStoreOptions = {
dynamoConfig: {
region: 'local',
endpoint: 'http://localhost:8000',
accessKeyId: "dummyKey",
secretAccessKey: "dummyKey"
};
};
app.use(koaSession({
store: new DynamoDBStore(dynamoDBStoreOptions),
...
}, app));
```
## Options
```
{
"table": {
"name": "", // default, sessions
"hashKey": "", // default, sessionId
"ttlKey": "", // default, expires
"useTtlExpired": "", // default, true
"readCapacityUnits": "", // default,: 5
"writeCapacityUnits": "" // default, 5
"autoCreate": "" // default, false
},
"dynamoConfig": {
"accessKeyId": "", // default
"secretAccessKey": "", // default
"region": "", // default, If you are using the local version of DynamoDB, it must be a word that starts with local.
"endpoint": "" // default
}
}
```
The `table` configuration is optional. The missing properties will be replaced by [defaults](https://github.com/DGURI/koa-session-dynamodb-store/blob/master/lib/constants.js).
Changing the `table.ttlKey` property may be ignored if the TTL attribute of DynamoDB is enabled. In this case, use the TTL property of DynamoDB as a priority.
If you have recently changed the value of `table.useTtlExpired`, the DynamoDB service will return an error. This will not work, please try again later.
Changing the `readCapacityUnits` and `writeCapacityUnits` frequently can also cause the DynamoDB service to return an error.
Please refer to the [AWS DynamoDB Development Guide](https://docs.aws.amazon.com/ko_kr/amazondynamodb/latest/developerguide/Programming.Errors.html) for details of the above error.
If option `table.autoCreate` is set to **true** the `store` will try to create a session table automatically during its initialization. Otherwise in order to initialize the table developer can explicitly call
```js
await store.createTableIfDontExists();
```
at the right point according to an application architecture.
The `dynamoConfig` can be optional if the following environment variables are set: **AWS_ACCESS_KEY_ID**, **AWS_SECRET_ACCESS_KEY** and **AWS_REGION** (which are present on Lambda Functions running on AWS). All properties from [AWS.DynamoDB constructor](https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/DynamoDB.html#constructor-property) can be informed in this structure.