/api/user/set-session-ended (PATCH)
await global.api.user.SetSessionEnded.patch(req) Located in Dashboard API
Returns object
Exceptions
These exceptions are thrown (NodeJS) or returned as JSON (HTTP) if you provide incorrect data or do not meet the requirements:
Exception | Circumstances |
---|---|
invalid querystring sessionid | |
invalid-sessionid | missing querystring sessionid |
invalid-session | querystring sessionid is not active session |
invalid-account | ineligible querystring sessionid |
NodeJS source (edit on github)
If you see a problem with the source submit a pull request on Github.
const dashboard = require('../../../../index.js')
module.exports = {
patch: async (req) => {
if (!req.query || !req.query.sessionid) {
throw new Error('invalid-sessionid')
}
const session = await global.api.user.Session.get(req)
if (!session) {
throw new Error('invalid-sessionid')
}
if (session.ended) {
throw new Error('invalid-session')
}
if (session.accountid !== req.account.accountid) {
throw new Error('invalid-account')
}
await dashboard.StorageObject.setProperty(`${req.appid}/session/${req.query.sessionid}`, 'ended', dashboard.Timestamp.now)
return global.api.user.Session.get(req)
}
}
Test source (edit on github)
Tests perform real HTTP requests against a running Dashboard server.
/* eslint-env mocha */
const assert = require('assert')
const TestHelper = require('../../../../test-helper.js')
/* eslint-env mocha */
describe('/api/user/set-session-ended', () => {
describe('exceptions', () => {
describe('invalid-sessionid', () => {
it('missing querystring sessionid', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/set-session-ended')
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.patch()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-sessionid')
})
it('invalid querystring sessionid', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest('/api/user/set-session-ended?sessionid=invalid')
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.patch()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-sessionid')
})
})
describe('invalid-session', () => {
it('querystring sessionid is not active session', async () => {
const user = await TestHelper.createUser()
const session1 = user.session
await TestHelper.endSession(user)
await TestHelper.createSession(user)
const req = TestHelper.createRequest(`/api/user/set-session-ended?sessionid=${session1.sessionid}`)
req.account = user.account
req.session = user.session
await req.patch()
let errorMessage
try {
await req.patch(req)
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-session')
})
})
describe('invalid-account', () => {
it('ineligible querystring sessionid', async () => {
const user = await TestHelper.createUser()
const user2 = await TestHelper.createUser()
const req = TestHelper.createRequest(`/api/user/set-session-ended?sessionid=${user2.session.sessionid}`)
req.account = user.account
req.session = user.session
let errorMessage
try {
await req.patch()
} catch (error) {
errorMessage = error.message
}
assert.strictEqual(errorMessage, 'invalid-account')
})
})
})
describe('returns', () => {
it('object', async () => {
const user = await TestHelper.createUser()
const req = TestHelper.createRequest(`/api/user/set-session-ended?sessionid=${user.session.sessionid}`)
req.account = user.account
req.session = user.session
req.filename = __filename
req.saveResponse = true
const sessionNow = await req.patch()
assert.strictEqual(sessionNow.object, 'session')
})
})
})