Skip to content
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

Jump to bottom

fix: infinite TTLs are not supported anymore, forward ttl=0 #170

Merged
merged 5 commits into from
Jun 25, 2024
Merged

fix: infinite TTLs are not supported anymore, forward ttl=0 #170

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
37fd0de
fix: infinite TTLs are not supported
moritzraho Jun 19, 2024
7feebfd
fix add doc hook
moritzraho Jun 20, 2024
7a4e065
fix e2e tests
moritzraho Jun 20, 2024
7609085
forward ttl=0 to server, but bring back e2e test checking that ttl=0 …
moritzraho Jun 20, 2024
fbf63b9
Merge branch 'main' into fix/infinite-ttl
moritzraho Jun 20, 2024
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
43 changes: 13 additions & 30 deletions doc/api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,17 @@
</dd>
</dl>

## Functions
## Members

<dl>
<dt><a href="#validate">validate(schema, data)</a> ⇒ <code>object</code></dt>
<dd><p>Validates json according to a schema.</p>
</dd>
<dt><a href="#handleResponse">handleResponse(response, params)</a> ⇒ <code>void</code></dt>
<dd><p>Handle a network response.</p>
<dt><a href="#MAX_TTL">MAX_TTL</a> : <code>number</code></dt>
<dd><p>Max supported TTL, 365 days in seconds</p>
</dd>
</dl>

## Functions

<dl>
<dt><a href="#init">init([config])</a> ⇒ <code><a href="#AdobeState">Promise.&lt;AdobeState&gt;</a></code></dt>
<dd><p>Initializes and returns the key-value-store SDK.</p>
<p>To use the SDK you must either provide your
Expand Down Expand Up @@ -159,31 +161,12 @@ for await (const { keys } of state.list({ match: 'abc*' })) {
console.log(keys)
}
```
<a name="validate"></a>

## validate(schema, data) ⇒ <code>object</code>
Validates json according to a schema.

**Kind**: global function
**Returns**: <code>object</code> - the result
<a name="MAX_TTL"></a>

| Param | Type | Description |
| --- | --- | --- |
| schema | <code>object</code> | the AJV schema |
| data | <code>object</code> | the json data to test |

<a name="handleResponse"></a>

## handleResponse(response, params) ⇒ <code>void</code>
Handle a network response.

**Kind**: global function

| Param | Type | Description |
| --- | --- | --- |
| response | <code>Response</code> | a fetch Response |
| params | <code>object</code> | the params to the network call |
## MAX\_TTL : <code>number</code>
Max supported TTL, 365 days in seconds

**Kind**: global variable
<a name="init"></a>

## init([config]) ⇒ [<code>Promise.&lt;AdobeState&gt;</code>](#AdobeState)
Expand Down Expand Up @@ -227,7 +210,7 @@ AdobeState put options

| Name | Type | Description |
| --- | --- | --- |
| ttl | <code>number</code> | time-to-live for key-value pair in seconds, defaults to 24 hours (86400s). Set to < 0 for max ttl of one year. A value of 0 sets default. |
| ttl | <code>number</code> | Time-To-Live for key-value pair in seconds. When not defined or set to 0, defaults to 24 hours (86400s). Max TTL is one year (31536000s), `require('@adobe/aio-lib-state').MAX_TTL`. A TTL of 0 defaults to 24 hours. |

<a name="AdobeStateGetReturnValue"></a>

Expand Down
7 changes: 5 additions & 2 deletions e2e/e2e.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,17 +113,20 @@ describe('e2e tests using OpenWhisk credentials (as env vars)', () => {

// 3. test max ttl
const nowPlus365Days = new Date(MAX_TTL_SECONDS).getTime()
expect(await state.put(testKey, testValue, { ttl: -1 })).toEqual(testKey)
expect(await state.put(testKey, testValue, { ttl: MAX_TTL_SECONDS })).toEqual(testKey)
res = await state.get(testKey)
resTime = new Date(res.expiration).getTime()
expect(resTime).toBeGreaterThanOrEqual(nowPlus365Days)
expect(resTime).toBeGreaterThanOrEqual(nowPlus365Days - 10000)

// 4. test that after ttl object is deleted
expect(await state.put(testKey, testValue, { ttl: 2 })).toEqual(testKey)
res = await state.get(testKey)
expect(new Date(res.expiration).getTime()).toBeLessThanOrEqual(new Date(Date.now() + 2000).getTime())
await waitFor(3000) // give it one more sec - ttl is not so precise
expect(await state.get(testKey)).toEqual(undefined)

// 5. infinite ttl not supported
await expect(state.put(testKey, testValue, { ttl: -1 })).rejects.toThrow()
})

test('listKeys test: few < 128 keys, many, and expired entries', async () => {
Expand Down
10 changes: 9 additions & 1 deletion index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
Copyright 2019 Adobe. All rights reserved.
Copyright 2024 Adobe. All rights reserved.
This file is licensed to you under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. You may obtain a copy
of the License at http://www.apache.org/licenses/LICENSE-2.0
Expand All @@ -9,5 +9,13 @@ the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTA
OF ANY KIND, either express or implied. See the License for the specific language
governing permissions and limitations under the License.
*/
const { MAX_TTL_SECONDS } = require('./lib/constants')
require('./lib/AdobeState')

module.exports = require('./lib/init')

/**
* Max supported TTL, 365 days in seconds
* @type {number}
*/
module.exports.MAX_TTL = MAX_TTL_SECONDS
32 changes: 24 additions & 8 deletions lib/AdobeState.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ const {
MAX_LIST_COUNT_HINT,
REQUEST_ID_HEADER,
MIN_LIST_COUNT_HINT,
REGEX_PATTERN_LIST_KEY_MATCH
REGEX_PATTERN_LIST_KEY_MATCH,
MAX_TTL_SECONDS
} = require('./constants')

/* *********************************** typedefs *********************************** */
Expand All @@ -48,8 +49,10 @@ const {
*
* @typedef AdobeStatePutOptions
* @type {object}
* @property {number} ttl time-to-live for key-value pair in seconds, defaults to 24 hours (86400s). Set to < 0 for max ttl of one year. A
* value of 0 sets default.
* @property {number} ttl Time-To-Live for key-value pair in seconds. When not
* defined or set to 0, defaults to 24 hours (86400s). Max TTL is one year
* (31536000s), `require('@adobe/aio-lib-state').MAX_TTL`. A TTL of 0 defaults
* to 24 hours.
*/

/**
Expand All @@ -69,6 +72,7 @@ const {
* @param {object} schema the AJV schema
* @param {object} data the json data to test
* @returns {object} the result
* @private
*/
function validate (schema, data) {
const ajv = new Ajv({ allErrors: true })
Expand All @@ -78,7 +82,7 @@ function validate (schema, data) {
return { valid, errors: validate.errors }
}

// eslint-disable-next-line jsdoc/require-jsdoc
/** @private */
async function _wrap (promise, params) {
let response
try {
Expand All @@ -97,6 +101,7 @@ async function _wrap (promise, params) {
* @param {Response} response a fetch Response
* @param {object} params the params to the network call
* @returns {void}
* @private
*/
async function handleResponse (response, params) {
if (response.ok) {
Expand Down Expand Up @@ -317,20 +322,31 @@ class AdobeState {
},
value: {
type: 'string'
},
ttl: {
type: 'integer'
}
}
}

const { valid, errors } = validate(schema, { key, value })
// validation
const { ttl } = options
const { valid, errors } = validate(schema, { key, value, ttl })
if (!valid) {
logAndThrow(new codes.ERROR_BAD_ARGUMENT({
messageValues: utils.formatAjvErrors(errors),
sdkDetails: { key, value, options, errors }
sdkDetails: { key, valueLength: value.length, options, errors }
}))
}
if (ttl !== undefined && (ttl < 0 || ttl > MAX_TTL_SECONDS)) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

too bad AJV validator can't have a min max :/

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes AJV has a min max, but the error message is not nice...

AioCoreSDKError [AdobeStateLibError]: [AdobeStateLib:ERROR_BAD_ARGUMENT] WARNING: keyword 'minimum' was not handled for formatting: {
  "instancePath": "/ttl",
  "schemaPath": "#/properties/ttl/minimum",
  "keyword": "minimum",
  "params": {
    "comparison": ">=",
    "limit": 0
  },
  "message": "must be >= 0"
}

I wanted to make it clear that infinite ttls are not supported anymore!

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

actually we can add the support in our code here, but maybe for next time:

aio-lib-state/lib/utils.js

Line 63 in 94e34ad

function formatAjvErrors (errors) {

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

great maybe next time, as this is a custom error anyways

// error message is nicer like this than for
logAndThrow(new codes.ERROR_BAD_ARGUMENT({
messageValues: 'ttl must be <= 365 days (31536000s). Infinite TTLs (< 0) are not supported.',
sdkDetails: { key, valueLength: value.length, options }
}))
}

const { ttl } = options
const queryParams = ttl ? { ttl } : {}
const queryParams = ttl !== undefined ? { ttl } : {}
const requestOptions = {
method: 'PUT',
headers: {
Expand Down
6 changes: 4 additions & 2 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,12 @@
"e2e": "jest -c jest.e2e.config.js",
"jsdoc": "jsdoc2md -f index.js 'lib/**/*.js' > doc/api.md",
"typings": "jsdoc -t node_modules/tsd-jsdoc/dist -r lib -d . && replace-in-file /declare/g export types.d.ts --isRegex",
"generate-docs": "npm run jsdoc && npm run typings"
"generate-docs": "npm run jsdoc && npm run typings",
"git-add-docs": "git add doc/ types.d.ts"
},
"pre-commit": [
"generate-docs"
"generate-docs",
"git-add-docs"
],
"author": "Adobe Inc.",
"license": "Apache-2.0",
Expand Down
Loading
Loading