Skip to content

feat: add computeTTL and sanitizeValue utilities #252

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

Closed
chsrimanaswi wants to merge 2 commits into from
Closed

feat: add computeTTL and sanitizeValue utilities #252

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7bfec7f
feat: add computeTTL and sanitizeValue utilities
May 29, 2026
be7c479
Merge branch 'main' into test/pr-reviewer-validation
chsrimanaswi May 29, 2026
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
34 changes: 33 additions & 1 deletion lib/utils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,8 +117,40 @@ function formatAjvErrors (errors) {
return stringErrors
}

/**
* Computes the TTL in seconds from an expiry date or a number of seconds.
* Returns undefined if no expiry is provided.
*
* @private
* @param {Date|number} expiry a Date object or seconds from now
* @returns {number|undefined} TTL in seconds
*/
function computeTTL (expiry) {
if (expiry === undefined || expiry === null) return undefined
if (expiry instanceof Date) {
Copy link
Copy Markdown

@github-actions github-actions Bot May 29, 2026

Choose a reason for hiding this comment

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

computeTTL can return a negative TTL if the provided Date is in the past. Callers will likely get unexpected behavior (e.g., negative cache TTLs). Consider returning 0 or throwing an error for expired dates.

Suggested change
if (expiry instanceof Date) {
function computeTTL (expiry) {
if (expiry === undefined || expiry === null) return undefined
if (expiry instanceof Date) {
const ttl = Math.floor((expiry.getTime() - Date.now()) / 1000)
if (ttl < 0) throw new Error('expiry date is in the past')
return ttl
}
if (typeof expiry !== 'number' || expiry < 0) throw new Error('expiry must be a non-negative number of seconds')
return expiry
}

return Math.floor((expiry.getTime() - Date.now()) / 1000)
}
return expiry
}

/**
* Truncates a value to the max allowed byte size for state storage.
*
* @private
* @param {string} value the value to sanitize
* @param {number} maxBytes max allowed size in bytes
* @returns {string} the value, truncated if necessary
*/
function sanitizeValue (value, maxBytes) {
const encoded = Buffer.from(value)
if (encoded.length <= maxBytes) return value
return encoded.slice(0, maxBytes).toString()
}
Copy link
Copy Markdown

@github-actions github-actions Bot May 29, 2026

Choose a reason for hiding this comment

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

Buffer.from(value) defaults to UTF-8 encoding, but slicing at an arbitrary byte boundary can split a multibyte character, producing an invalid/garbled string. Use a TextDecoder or ensure truncation happens on a character boundary.

Suggested change
}
function sanitizeValue (value, maxBytes) {
const encoded = Buffer.from(value, 'utf8')
if (encoded.length <= maxBytes) return value
// Truncate safely on a character boundary by decoding with replacement
return new TextDecoder('utf-8', { fatal: false }).decode(encoded.slice(0, maxBytes)).replace(/\uFFFD$/, '')
}


module.exports = {
withHiddenFields,
isInternalToAdobeRuntime,
formatAjvErrors
formatAjvErrors,
computeTTL,
sanitizeValue
}
Loading