mirror of
https://github.com/harttle/liquidjs.git
synced 2026-10-03 09:05:14 -07:00
fix(memory): charge rendered output to memoryLimit at emission
Move output-length accounting into the emitters, which charge each written chunk against ctx.memoryLimit right before it reaches the result string or stream. Filters/tags now only pre-charge the extra working memory they allocate apart from that output, so join drops its bespoke output-size counting and charges array.length like its siblings. The block.super capture emitter intentionally omits the limiter to avoid double-counting content that is re-emitted through the final emitter. Co-authored-by: Cursor <[email protected]>
This commit is contained in:
@@ -13,6 +13,7 @@ export class BlockDrop extends Drop {
|
|||||||
* {{ block.super }}
|
* {{ block.super }}
|
||||||
*/
|
*/
|
||||||
public * super (): IterableIterator<unknown> {
|
public * super (): IterableIterator<unknown> {
|
||||||
|
// memory limit already enforced by final emitter, not passing memory here
|
||||||
const emitter = new SimpleEmitter()
|
const emitter = new SimpleEmitter()
|
||||||
yield this.superBlockRender(emitter)
|
yield this.superBlockRender(emitter)
|
||||||
return emitter.buffer
|
return emitter.buffer
|
||||||
|
|||||||
@@ -1,9 +1,11 @@
|
|||||||
import { stringify, toValue } from '../util'
|
import { Limiter, stringify, toValue } from '../util'
|
||||||
import { Emitter } from './emitter'
|
import { Emitter } from './emitter'
|
||||||
|
|
||||||
export class KeepingTypeEmitter implements Emitter {
|
export class KeepingTypeEmitter implements Emitter {
|
||||||
public buffer: any = '';
|
public buffer: any = '';
|
||||||
|
|
||||||
|
public constructor (private memoryLimit?: Limiter) {}
|
||||||
|
|
||||||
public write (html: any) {
|
public write (html: any) {
|
||||||
html = toValue(html)
|
html = toValue(html)
|
||||||
// This will only preserve the type if the value is isolated.
|
// This will only preserve the type if the value is isolated.
|
||||||
@@ -11,9 +13,12 @@ export class KeepingTypeEmitter implements Emitter {
|
|||||||
// {{ my-port }} -> 42
|
// {{ my-port }} -> 42
|
||||||
// {{ my-host }}:{{ my-port }} -> 'host:42'
|
// {{ my-host }}:{{ my-port }} -> 'host:42'
|
||||||
if (typeof html !== 'string' && this.buffer === '') {
|
if (typeof html !== 'string' && this.buffer === '') {
|
||||||
|
this.memoryLimit?.use(stringify(html).length)
|
||||||
this.buffer = html
|
this.buffer = html
|
||||||
} else {
|
} else {
|
||||||
this.buffer = stringify(this.buffer) + stringify(html)
|
const str = stringify(html)
|
||||||
|
this.memoryLimit?.use(str.length)
|
||||||
|
this.buffer = stringify(this.buffer) + str
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,10 +1,14 @@
|
|||||||
import { stringify } from '../util'
|
import { Limiter, stringify } from '../util'
|
||||||
import { Emitter } from './emitter'
|
import { Emitter } from './emitter'
|
||||||
|
|
||||||
export class SimpleEmitter implements Emitter {
|
export class SimpleEmitter implements Emitter {
|
||||||
public buffer = '';
|
public buffer = '';
|
||||||
|
|
||||||
|
public constructor (private memoryLimit?: Limiter) {}
|
||||||
|
|
||||||
public write (html: any) {
|
public write (html: any) {
|
||||||
this.buffer += stringify(html)
|
const str = stringify(html)
|
||||||
|
this.memoryLimit?.use(str.length)
|
||||||
|
this.buffer += str
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -1,12 +1,15 @@
|
|||||||
import { stringify } from '../util'
|
import { Limiter, stringify } from '../util'
|
||||||
import { Emitter } from './emitter'
|
import { Emitter } from './emitter'
|
||||||
import { PassThrough } from 'stream'
|
import { PassThrough } from 'stream'
|
||||||
|
|
||||||
export class StreamedEmitter implements Emitter {
|
export class StreamedEmitter implements Emitter {
|
||||||
public buffer = '';
|
public buffer = '';
|
||||||
public stream: NodeJS.ReadWriteStream = new PassThrough()
|
public stream: NodeJS.ReadWriteStream = new PassThrough()
|
||||||
|
public constructor (private memoryLimit?: Limiter) {}
|
||||||
public write (html: any) {
|
public write (html: any) {
|
||||||
this.stream.write(stringify(html))
|
const str = stringify(html)
|
||||||
|
this.memoryLimit?.use(str.length)
|
||||||
|
this.stream.write(str)
|
||||||
}
|
}
|
||||||
public error (err: Error) {
|
public error (err: Error) {
|
||||||
this.stream.emit('error', err)
|
this.stream.emit('error', err)
|
||||||
|
|||||||
@@ -7,10 +7,8 @@ import { EmptyDrop } from '../drop'
|
|||||||
|
|
||||||
export const join = argumentsToValue(function (this: FilterImpl, v: any[], arg: string) {
|
export const join = argumentsToValue(function (this: FilterImpl, v: any[], arg: string) {
|
||||||
const array = toArray(v)
|
const array = toArray(v)
|
||||||
|
this.context.memoryLimit.use(array.length)
|
||||||
const sep = isNil(arg) ? ' ' : stringify(arg)
|
const sep = isNil(arg) ? ' ' : stringify(arg)
|
||||||
let outputSize = sep.length * Math.max(array.length - 1, 0)
|
|
||||||
for (let i = 0; i < array.length; i++) outputSize += String(array[i]).length
|
|
||||||
this.context.memoryLimit.use(outputSize)
|
|
||||||
return Array.prototype.join.call(array, sep)
|
return Array.prototype.join.call(array, sep)
|
||||||
})
|
})
|
||||||
export const last = argumentsToValue(function (this: FilterImpl, v: any) {
|
export const last = argumentsToValue(function (this: FilterImpl, v: any) {
|
||||||
|
|||||||
+10
-2
@@ -91,7 +91,11 @@ export interface LiquidOptions {
|
|||||||
parseLimit?: number;
|
parseLimit?: number;
|
||||||
/** For DoS handling, limit total time (in ms) for each `render()` call. */
|
/** For DoS handling, limit total time (in ms) for each `render()` call. */
|
||||||
renderLimit?: number;
|
renderLimit?: number;
|
||||||
/** For DoS handling, limit new objects creation, including array concat/join/strftime, etc. A typical PC can handle 1e9 (1G) memory without issue. */
|
/**
|
||||||
|
* For DoS handling, caps the memory allocated while rendering. Operations allocating asymptotically more
|
||||||
|
* than their input (template and context) charge upfront to abort before allocating; everything else is
|
||||||
|
* charged as the output is written out. A typical PC can handle 1e9 (1G) memory without issue.
|
||||||
|
*/
|
||||||
memoryLimit?: number;
|
memoryLimit?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -116,7 +120,11 @@ export interface RenderOptions {
|
|||||||
templateLimit?: number;
|
templateLimit?: number;
|
||||||
/** For DoS handling, limit total time (in ms) for each `render()` call. */
|
/** For DoS handling, limit total time (in ms) for each `render()` call. */
|
||||||
renderLimit?: number;
|
renderLimit?: number;
|
||||||
/** For DoS handling, limit new objects creation, including array concat/join/strftime, etc. A typical PC can handle 1e9 (1G) memory without issue.. */
|
/**
|
||||||
|
* For DoS handling, caps the memory allocated while rendering. Operations allocating asymptotically more
|
||||||
|
* than their input (template and context) charge upfront to abort before allocating; everything else is
|
||||||
|
* charged as the output is written out. A typical PC can handle 1e9 (1G) memory without issue.
|
||||||
|
*/
|
||||||
memoryLimit?: number;
|
memoryLimit?: number;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|||||||
@@ -6,14 +6,14 @@ import { Emitter, KeepingTypeEmitter, StreamedEmitter, SimpleEmitter } from '../
|
|||||||
|
|
||||||
export class Render {
|
export class Render {
|
||||||
public renderTemplatesToNodeStream (templates: Template[], ctx: Context): NodeJS.ReadableStream {
|
public renderTemplatesToNodeStream (templates: Template[], ctx: Context): NodeJS.ReadableStream {
|
||||||
const emitter = new StreamedEmitter()
|
const emitter = new StreamedEmitter(ctx.memoryLimit)
|
||||||
Promise.resolve().then(() => toPromise(this.renderTemplates(templates, ctx, emitter)))
|
Promise.resolve().then(() => toPromise(this.renderTemplates(templates, ctx, emitter)))
|
||||||
.then(() => emitter.end(), err => emitter.error(err))
|
.then(() => emitter.end(), err => emitter.error(err))
|
||||||
return emitter.stream
|
return emitter.stream
|
||||||
}
|
}
|
||||||
public * renderTemplates (templates: Template[], ctx: Context, emitter?: Emitter): IterableIterator<any> {
|
public * renderTemplates (templates: Template[], ctx: Context, emitter?: Emitter): IterableIterator<any> {
|
||||||
if (!emitter) {
|
if (!emitter) {
|
||||||
emitter = ctx.opts.keepOutputType ? new KeepingTypeEmitter() : new SimpleEmitter()
|
emitter = ctx.opts.keepOutputType ? new KeepingTypeEmitter(ctx.memoryLimit) : new SimpleEmitter(ctx.memoryLimit)
|
||||||
}
|
}
|
||||||
ctx.renderLimit.check(getPerformance().now())
|
ctx.renderLimit.check(getPerformance().now())
|
||||||
const errors = []
|
const errors = []
|
||||||
|
|||||||
@@ -70,7 +70,7 @@ describe('DoS related', function () {
|
|||||||
const array = Array(1e3).fill(0)
|
const array = Array(1e3).fill(0)
|
||||||
const liquid = new Liquid({ memoryLimit: 100 })
|
const liquid = new Liquid({ memoryLimit: 100 })
|
||||||
await expect(liquid.parseAndRender('{{ array | slice: 0, 300 | join }}', { array })).rejects.toThrow('memory alloc limit exceeded, line:1, col:1')
|
await expect(liquid.parseAndRender('{{ array | slice: 0, 300 | join }}', { array })).rejects.toThrow('memory alloc limit exceeded, line:1, col:1')
|
||||||
await expect(liquid.parseAndRender('{{ array | slice: 0, 300 | join }}', { array }, { memoryLimit: 1e3 })).resolves.toBe(Array(300).fill(0).join(' '))
|
await expect(liquid.parseAndRender('{{ array | slice: 0, 300 | join }}', { array }, { memoryLimit: 2e3 })).resolves.toBe(Array(300).fill(0).join(' '))
|
||||||
})
|
})
|
||||||
it('should throw for too many array iteration in tags', async () => {
|
it('should throw for too many array iteration in tags', async () => {
|
||||||
const array = ['a']
|
const array = ['a']
|
||||||
@@ -100,14 +100,6 @@ describe('DoS related', function () {
|
|||||||
const liquid = new Liquid({ memoryLimit: 100 })
|
const liquid = new Liquid({ memoryLimit: 100 })
|
||||||
expect(liquid.parseAndRenderSync('{{ array | join: "" }}', { array })).toBe('a'.repeat(20) + 'b'.repeat(20))
|
expect(liquid.parseAndRenderSync('{{ array | join: "" }}', { array })).toBe('a'.repeat(20) + 'b'.repeat(20))
|
||||||
})
|
})
|
||||||
it('should prevent concat doubling from bypassing join memoryLimit', () => {
|
|
||||||
const liquid = new Liquid({ memoryLimit: 1e4 })
|
|
||||||
const src = '{%- assign a = s | split: "NOSEP" -%}' +
|
|
||||||
'{%- assign a = a | concat: a -%}{%- assign a = a | concat: a -%}{%- assign a = a | concat: a -%}' +
|
|
||||||
'{{ a | join: "" | size }}'
|
|
||||||
expect(() => liquid.parseAndRenderSync(src, { s: 'a'.repeat(5000) }))
|
|
||||||
.toThrow('memory alloc limit exceeded')
|
|
||||||
})
|
|
||||||
it('should charge array_to_sentence_string by produced output size', () => {
|
it('should charge array_to_sentence_string by produced output size', () => {
|
||||||
const array = ['a'.repeat(100), 'b'.repeat(100), 'c'.repeat(100)]
|
const array = ['a'.repeat(100), 'b'.repeat(100), 'c'.repeat(100)]
|
||||||
const liquid = new Liquid({ memoryLimit: 100 })
|
const liquid = new Liquid({ memoryLimit: 100 })
|
||||||
|
|||||||
Reference in New Issue
Block a user