feat: promise in expression & nested property, #533 #276

.eslintignore

@@ -3,3 +3,4 @@ dist
 demo
 coverage
 docs
+private.*

.eslintrc.json

@@ -7,13 +7,18 @@
     "node": true
   },
   "parser": "@typescript-eslint/parser",
+  "parserOptions": {
+    "project": "tsconfig.json"
+  },
   "plugins": [
+    "deprecation",
     "mocha",
     "standard",
     "@typescript-eslint",
     "promise"
   ],
   "rules": {
+    "deprecation/deprecation": "error",
     "no-var": 2,
     "prefer-const": 2,
     "no-unused-vars": "off",
@@ -36,5 +41,10 @@
     "rules": {
       "@typescript-eslint/no-var-requires": "off"
     }
+  }, {
+    "files": ["test/**/*.ts"],
+    "rules": {
+      "deprecation/deprecation": "off"
+    }
   }]
 }

package.json

@@ -84,6 +84,7 @@
     "cross-env": "^5.2.0",
     "eslint": "^7.32.0",
     "eslint-config-standard": "^12.0.0",
+    "eslint-plugin-deprecation": "^1.3.2",
     "eslint-plugin-import": "^2.15.0",
     "eslint-plugin-mocha": "^5.3.0",
     "eslint-plugin-node": "^8.0.1",

src/builtin/filters/array.ts

@@ -10,14 +10,19 @@ export const last = argumentsToValue((v: any) => isArray(v) ? arrayLast(v) : '')
 export const first = argumentsToValue((v: any) => isArray(v) ? v[0] : '')
 export const reverse = argumentsToValue((v: any[]) => [...toArray(v)].reverse())
 
-export function sort<T> (this: FilterImpl, arr: T[], property?: string) {
-  arr = toValue(arr)
-  const getValue = (obj: Scope) => property ? this.context.getFromScope(obj, stringify(property).split('.')) : obj
-  return [...toArray(arr)].sort((lhs, rhs) => {
-    lhs = getValue(lhs)
-    rhs = getValue(rhs)
-    return lhs < rhs ? -1 : (lhs > rhs ? 1 : 0)
-  })
+export function * sort<T> (this: FilterImpl, arr: T[], property?: string): IterableIterator<unknown> {
+  const values: [T, string | number][] = []
+  for (const item of toArray(toValue(arr))) {
+    values.push([
+      item,
+      property ? yield this.context._getFromScope(item, stringify(property).split('.')) : item
+    ])
+  }
+  return values.sort((lhs, rhs) => {
+    const lvalue = lhs[1]
+    const rvalue = rhs[1]
+    return lvalue < rvalue ? -1 : (lvalue > rvalue ? 1 : 0)
+  }).map(tuple => tuple[0])
 }
 
 export function sortNatural<T> (input: T[], property?: string) {
@@ -31,9 +36,12 @@ export function sortNatural<T> (input: T[], property?: string) {
 
 export const size = (v: string | any[]) => (v && v.length) || 0
 
-export function map (this: FilterImpl, arr: Scope[], property: string) {
-  arr = toValue(arr)
-  return toArray(arr).map(obj => this.context.getFromScope(obj, stringify(property).split('.')))
+export function * map (this: FilterImpl, arr: Scope[], property: string): IterableIterator<unknown> {
+  const results = []
+  for (const item of toArray(toValue(arr))) {
+    results.push(yield this.context._getFromScope(item, stringify(property).split('.')))
+  }
+  return results
 }
 
 export function compact<T> (this: FilterImpl, arr: T[]) {
@@ -55,13 +63,16 @@ export function slice<T> (v: T[] | string, begin: number, length = 1): T[] | str
   return v.slice(begin, begin + length)
 }
 
-export function where<T extends object> (this: FilterImpl, arr: T[], property: string, expected?: any): T[] {
-  arr = toValue(arr)
-  return toArray(arr).filter(obj => {
-    const value = this.context.getFromScope(obj, stringify(property).split('.'))
-    if (expected === undefined) return isTruthy(value, this.context)
-    if (isComparable(expected)) return expected.equals(value)
-    return value === expected
+export function * where<T extends object> (this: FilterImpl, arr: T[], property: string, expected?: any): IterableIterator<unknown> {
+  const values: unknown[] = []
+  arr = toArray(toValue(arr))
+  for (const item of arr) {
+    values.push(yield this.context._getFromScope(item, stringify(property).split('.')))
+  }
+  return arr.filter((_, i) => {
+    if (expected === undefined) return isTruthy(values[i], this.context)
+    if (isComparable(expected)) return expected.equals(values[i])
+    return values[i] === expected
   })
 }
 

src/builtin/tags/case.ts

@@ -1,4 +1,4 @@
-import { toValue, evalToken, Value, Emitter, TagToken, TopLevelToken, Context, Template, TagImplOptions, ParseStream } from '../../types'
+import { toValue, _evalToken, Value, Emitter, TagToken, TopLevelToken, Context, Template, TagImplOptions, ParseStream } from '../../types'
 import { Tokenizer } from '../../parser/tokenizer'
 
 export default {
@@ -37,7 +37,7 @@ export default {
     const r = this.liquid.renderer
     const cond = toValue(yield this.cond.value(ctx, ctx.opts.lenientIf))
     for (const branch of this.cases) {
-      const val = evalToken(branch.val, ctx, ctx.opts.lenientIf)
+      const val = yield _evalToken(branch.val, ctx, ctx.opts.lenientIf)
       if (val === cond) {
         yield r.renderTemplates(branch.templates, ctx, emitter)
         return

src/builtin/tags/cycle.ts

@@ -1,5 +1,5 @@
 import { assert } from '../../util/assert'
-import { evalToken, Emitter, TagToken, Context, TagImplOptions } from '../../types'
+import { _evalToken, Emitter, TagToken, Context, TagImplOptions } from '../../types'
 import { Tokenizer } from '../../parser/tokenizer'
 
 export default {
@@ -25,8 +25,8 @@ export default {
     assert(this.candidates.length, () => `empty candidates: ${tagToken.getText()}`)
   },
 
-  render: function (ctx: Context, emitter: Emitter) {
-    const group = evalToken(this.group, ctx)
+  render: function * (ctx: Context, emitter: Emitter) {
+    const group = yield _evalToken(this.group, ctx)
     const fingerprint = `cycle:${group}:` + this.candidates.join(',')
     const groups = ctx.getRegister('cycle')
     let idx = groups[fingerprint]
@@ -38,7 +38,7 @@ export default {
     const candidate = this.candidates[idx]
     idx = (idx + 1) % this.candidates.length
     groups[fingerprint] = idx
-    const html = evalToken(candidate, ctx)
+    const html = yield _evalToken(candidate, ctx)
     emitter.write(html)
   }
 } as TagImplOptions

src/builtin/tags/for.ts

@@ -1,4 +1,4 @@
-import { assert, Tokenizer, evalToken, Emitter, TagToken, TopLevelToken, Context, Template, TagImplOptions, ParseStream } from '../../types'
+import { assert, Tokenizer, _evalToken, Emitter, TagToken, TopLevelToken, Context, Template, TagImplOptions, ParseStream } from '../../types'
 import { toEnumerable } from '../../util/collection'
 import { ForloopDrop } from '../../drop/forloop-drop'
 import { Hash, HashValue } from '../../template/tag/hash'
@@ -40,7 +40,7 @@ export default {
   },
   render: function * (ctx: Context, emitter: Emitter): Generator<unknown, void | string, HashValue | Template[]> {
     const r = this.liquid.renderer
-    let collection = toEnumerable(yield evalToken(this.collection, ctx))
+    let collection = toEnumerable(yield _evalToken(this.collection, ctx))
 
     if (!collection.length) {
       yield r.renderTemplates(this.elseTemplates, ctx, emitter)

src/builtin/tags/include.ts

@@ -1,4 +1,4 @@
-import { assert, Tokenizer, evalToken, Hash, Emitter, TagToken, Context, TagImplOptions } from '../../types'
+import { assert, Tokenizer, _evalToken, Hash, Emitter, TagToken, Context, TagImplOptions } from '../../types'
 import BlockMode from '../../context/block-mode'
 import { parseFilePath, renderFilePath } from './render'
 
@@ -32,7 +32,7 @@ export default {
     ctx.setRegister('blocks', {})
     ctx.setRegister('blockMode', BlockMode.OUTPUT)
     const scope = yield hash.render(ctx)
-    if (withVar) scope[filepath] = evalToken(withVar, ctx)
+    if (withVar) scope[filepath] = yield _evalToken(withVar, ctx)
     const templates = yield liquid._parsePartialFile(filepath, ctx.sync, this['currentFile'])
     ctx.push(ctx.opts.jekyllInclude ? { include: scope } : scope)
     yield renderer.renderTemplates(templates, ctx, emitter)

src/builtin/tags/render.ts

@@ -3,7 +3,7 @@ import { assert } from '../../util/assert'
 import { ForloopDrop } from '../../drop/forloop-drop'
 import { toEnumerable } from '../../util/collection'
 import { Liquid } from '../../liquid'
-import { Token, Template, evalQuotedToken, TypeGuards, Tokenizer, evalToken, Hash, Emitter, TagToken, Context, TagImplOptions } from '../../types'
+import { Token, Template, evalQuotedToken, TypeGuards, Tokenizer, _evalToken, Hash, Emitter, TagToken, Context, TagImplOptions } from '../../types'
 
 export default {
   parseFilePath,
@@ -56,12 +56,12 @@ export default {
     __assign(scope, yield hash.render(ctx))
     if (this['with']) {
       const { value, alias } = this['with']
-      scope[alias || filepath] = evalToken(value, ctx)
+      scope[alias || filepath] = yield _evalToken(value, ctx)
     }
 
     if (this['for']) {
       const { value, alias } = this['for']
-      let collection = evalToken(value, ctx)
+      let collection = yield _evalToken(value, ctx)
       collection = toEnumerable(collection)
       scope['forloop'] = new ForloopDrop(collection.length, value.getText(), alias)
       for (const item of collection) {
@@ -108,8 +108,8 @@ function optimize (templates: Template[]): string | Template[] {
   return templates
 }
 
-export function renderFilePath (file: ParsedFileName, ctx: Context, liquid: Liquid) {
+export function * renderFilePath (file: ParsedFileName, ctx: Context, liquid: Liquid): IterableIterator<unknown> {
   if (typeof file === 'string') return file
   if (Array.isArray(file)) return liquid.renderer.renderTemplates(file, ctx)
-  return evalToken(file, ctx)
+  return yield _evalToken(file, ctx)
 }

src/builtin/tags/tablerow.ts

@@ -1,5 +1,5 @@
 import { toEnumerable } from '../../util/collection'
-import { assert, evalToken, Emitter, Hash, TagToken, TopLevelToken, Context, Template, TagImplOptions, ParseStream } from '../../types'
+import { assert, _evalToken, Emitter, Hash, TagToken, TopLevelToken, Context, Template, TagImplOptions, ParseStream } from '../../types'
 import { TablerowloopDrop } from '../../drop/tablerowloop-drop'
 import { Tokenizer } from '../../parser/tokenizer'
 
@@ -31,7 +31,7 @@ export default {
   },
 
   render: function * (ctx: Context, emitter: Emitter) {
-    let collection = toEnumerable(yield evalToken(this.collection, ctx))
+    let collection = toEnumerable(yield _evalToken(this.collection, ctx))
     const hash = yield this.hash.render(ctx)
     const offset = hash.offset || 0
     const limit = (hash.limit === undefined) ? collection.length : hash.limit

src/context/context.ts

@@ -4,6 +4,7 @@ import { NormalizedFullOptions, defaultOptions, RenderOptions } from '../liquid-
 import { Scope } from './scope'
 import { isArray, isNil, isString, isFunction, toLiquid } from '../util/underscore'
 import { InternalUndefinedVariableError } from '../util/error'
+import { toValueSync } from '../util/async'
 
 type PropertyKey = string | number;
 
@@ -56,19 +57,31 @@ export class Context {
     return [this.globals, this.environments, ...this.scopes]
       .reduce((ctx, val) => __assign(ctx, val), {})
   }
-  public get (paths: PropertyKey[]) {
-    const scope = this.findScope(paths[0])
-    return this.getFromScope(scope, paths)
+  /**
+   * @deprecated use `_get()` instead
+   */
+  public get (paths: PropertyKey[]): unknown {
+    return toValueSync(this._get(paths))
   }
-  public getFromScope (scope: object, paths: PropertyKey[] | string) {
+  public * _get (paths: PropertyKey[]): IterableIterator<unknown> {
+    const scope = this.findScope(paths[0])
+    return yield this._getFromScope(scope, paths)
+  }
+  /**
+   * @deprecated use `_get()` instead
+   */
+  public getFromScope (scope: unknown, paths: PropertyKey[] | string): IterableIterator<unknown> {
+    return toValueSync(this._getFromScope(scope, paths))
+  }
+  public * _getFromScope (scope: unknown, paths: PropertyKey[] | string): IterableIterator<unknown> {
     if (isString(paths)) paths = paths.split('.')
-    return paths.reduce((scope, path, i) => {
-      scope = readProperty(scope, path, this.opts.ownPropertyOnly)
+    for (let i = 0; i < paths.length; i++) {
+      scope = yield readProperty(scope as object, paths[i], this.opts.ownPropertyOnly)
       if (isNil(scope) && this.strictVariables) {
         throw new InternalUndefinedVariableError((paths as string[]).slice(0, i + 1).join!('.'))
       }
-      return scope
-    }, scope)
+    }
+    return scope
   }
   public push (ctx: object) {
     return this.scopes.push(ctx)

src/render/expression.ts

@@ -13,6 +13,7 @@ import { Context } from '../context/context'
 import { range } from '../util/underscore'
 import { Operators } from '../render/operator'
 import { UndefinedVariableError } from '../util/error'
+import { toValueSync } from '../util/async'
 
 export class Expression {
   private postfix: Token[]
@@ -30,26 +31,36 @@ export class Expression {
         const result = yield evalOperatorToken(ctx.opts.operators, token, l, r, ctx)
         operands.push(result)
       } else {
-        operands.push(yield evalToken(token, ctx, lenient && this.postfix.length === 1))
+        operands.push(yield _evalToken(token, ctx, lenient && this.postfix.length === 1))
       }
     }
     return operands[0]
   }
 }
 
-export function evalToken (token: Token | undefined, ctx: Context, lenient = false): any {
-  if (TypeGuards.isPropertyAccessToken(token)) return evalPropertyAccessToken(token, ctx, lenient)
-  if (TypeGuards.isRangeToken(token)) return evalRangeToken(token, ctx)
+/**
+ * @deprecated use `_evalToken` instead
+ */
+export function * evalToken (token: Token | undefined, ctx: Context, lenient = false) {
+  return toValueSync(_evalToken(token, ctx, lenient))
+}
+
+export function * _evalToken (token: Token | undefined, ctx: Context, lenient = false): IterableIterator<unknown> {
+  if (TypeGuards.isPropertyAccessToken(token)) return yield evalPropertyAccessToken(token, ctx, lenient)
+  if (TypeGuards.isRangeToken(token)) return yield evalRangeToken(token, ctx)
   if (TypeGuards.isLiteralToken(token)) return evalLiteralToken(token)
   if (TypeGuards.isNumberToken(token)) return evalNumberToken(token)
   if (TypeGuards.isWordToken(token)) return token.getText()
   if (TypeGuards.isQuotedToken(token)) return evalQuotedToken(token)
 }
 
-function evalPropertyAccessToken (token: PropertyAccessToken, ctx: Context, lenient: boolean) {
-  const props: string[] = token.props.map(prop => evalToken(prop, ctx, false))
+function * evalPropertyAccessToken (token: PropertyAccessToken, ctx: Context, lenient: boolean): IterableIterator<unknown> {
+  const props: string[] = []
+  for (const prop of token.props) {
+    props.push((yield _evalToken(prop, ctx, false)) as unknown as string)
+  }
   try {
-    return ctx.get([token.propertyName, ...props])
+    return yield ctx._get([token.propertyName, ...props])
   } catch (e) {
     if (lenient && (e as Error).name === 'InternalUndefinedVariableError') return null
     throw (new UndefinedVariableError(e as Error, token))
@@ -74,9 +85,9 @@ function evalLiteralToken (token: LiteralToken) {
   return literalValues[token.literal]
 }
 
-function evalRangeToken (token: RangeToken, ctx: Context) {
-  const low: number = evalToken(token.lhs, ctx)
-  const high: number = evalToken(token.rhs, ctx)
+function * evalRangeToken (token: RangeToken, ctx: Context) {
+  const low: number = yield _evalToken(token.lhs, ctx)
+  const high: number = yield _evalToken(token.rhs, ctx)
   return range(+low, +high + 1)
 }
 

src/template/filter/filter.ts

@@ -1,4 +1,4 @@
-import { evalToken } from '../../render/expression'
+import { _evalToken } from '../../render/expression'
 import { Context } from '../../context/context'
 import { identify } from '../../util/underscore'
 import { FilterImplOptions } from './filter-impl-options'
@@ -17,11 +17,11 @@ export class Filter {
     this.args = args
     this.liquid = liquid
   }
-  public render (value: any, context: Context) {
+  public * render (value: any, context: Context): IterableIterator<unknown> {
     const argv: any[] = []
     for (const arg of this.args as FilterArg[]) {
-      if (isKeyValuePair(arg)) argv.push([arg[0], evalToken(arg[1], context)])
-      else argv.push(evalToken(arg, context))
+      if (isKeyValuePair(arg)) argv.push([arg[0], yield _evalToken(arg[1], context)])
+      else argv.push(yield _evalToken(arg, context))
     }
     return this.impl.apply({ context, liquid: this.liquid }, [value, ...argv])
   }

src/template/tag/hash.ts

@@ -1,4 +1,4 @@
-import { evalToken } from '../../render/expression'
+import { _evalToken } from '../../render/expression'
 import { Context } from '../../context/context'
 import { Tokenizer } from '../../parser/tokenizer'
 
@@ -25,7 +25,7 @@ export class Hash {
   * render (ctx: Context): Generator<unknown, HashValue, unknown> {
     const hash = {}
     for (const key of Object.keys(this.hash)) {
-      hash[key] = this.hash[key] === undefined ? true : yield evalToken(this.hash[key], ctx)
+      hash[key] = this.hash[key] === undefined ? true : yield _evalToken(this.hash[key], ctx)
     }
     return hash
   }

src/types.ts

@@ -20,7 +20,8 @@ export { TopLevelToken } from './tokens/toplevel-token'
 export { Tokenizer } from './parser/tokenizer'
 export { Hash } from './template/tag/hash'
 export { Value } from './template/value'
-export { evalToken, evalQuotedToken } from './render/expression'
+// eslint-disable-next-line deprecation/deprecation
+export { _evalToken, evalToken, evalQuotedToken } from './render/expression'
 export { toPromise, toThenable, toValueSync } from './util/async'
 export { defaultOperators, Operators } from './render/operator'
 export { createTrie, Trie } from './util/operator-trie'

src/util/strftime.ts

@@ -109,7 +109,7 @@ const formatCodes = {
   M: (d: LiquidDate) => d.getMinutes(),
   N: (d: LiquidDate, opts: FormatOptions) => {
     const width = Number(opts.width) || 9
-    const str = String(d.getMilliseconds()).substr(0, width)
+    const str = String(d.getMilliseconds()).slice(0, width)
     return padEnd(str, width, '0')
   },
   p: (d: LiquidDate) => (d.getHours() < 12 ? 'AM' : 'PM'),
@@ -123,7 +123,7 @@ const formatCodes = {
   W: (d: LiquidDate) => getWeekOfYear(d, 1),
   x: (d: LiquidDate) => d.toLocaleDateString(),
   X: (d: LiquidDate) => d.toLocaleTimeString(),
-  y: (d: LiquidDate) => d.getFullYear().toString().substring(2, 4),
+  y: (d: LiquidDate) => d.getFullYear().toString().slice(2, 4),
   Y: (d: LiquidDate) => d.getFullYear(),
   z: (d: LiquidDate, opts: FormatOptions) => {
     const nOffset = Math.abs(d.getTimezoneOffset())

src/util/underscore.ts

@@ -150,7 +150,7 @@ export function changeCase (str: string): string {
 }
 
 export function ellipsis (str: string, N: number): string {
-  return str.length > N ? str.substr(0, N - 3) + '...' : str
+  return str.length > N ? str.slice(0, N - 3) + '...' : str
 }
 
 // compare string in case-insensitive way, undefined values to the tail

test/e2e/issues.ts

@@ -276,4 +276,57 @@ describe('Issues', function () {
     const result = liquid.evalValueSync('a > b', { a: 1, b: 2 })
     expect(result).to.equal(false)
   })
+  it('#276 Promise support in expressions', async () => {
+    const liquid = new Liquid()
+    const tpl = '{%if name == "alice" %}true{%endif%}'
+    const ctx = { name: Promise.resolve('alice') }
+    const html = await liquid.parseAndRender(tpl, ctx)
+    expect(html).to.equal('true')
+  })
+  it('#533 Nested Promise support for scope object', async () => {
+    const liquid = new Liquid()
+    const context = {
+      a: 1,
+      b: Promise.resolve(1),
+      async c () { return 1 },
+      d: { d: 1 },
+      e: { e: Promise.resolve(1) },
+      f: {
+        async f () { return 1 }
+      },
+      g: Promise.resolve({ g: 1 }),
+      async h () {
+        return { h: 1 }
+      },
+      i: Promise.resolve({
+        i: Promise.resolve(1)
+      }),
+      j: Promise.resolve({
+        async j () {
+          return 1
+        }
+      })
+    }
+
+    expect(await liquid.evalValue('a == 1', context)).to.equal(true)
+    expect(await liquid.evalValue('b == 1', context)).to.equal(true)
+    expect(await liquid.evalValue('c == 1', context)).to.equal(true)
+    expect(await liquid.evalValue('d.d == 1', context)).to.equal(true)
+    expect(await liquid.evalValue('e.e == 1', context)).to.equal(true)
+    expect(await liquid.evalValue('f.f == 1', context)).to.equal(true)
+    expect(await liquid.evalValue('g.g == 1', context)).to.equal(true)
+    expect(await liquid.evalValue('h.h == 1', context)).to.equal(true)
+    expect(await liquid.evalValue('i.i == 1', context)).to.equal(true)
+    expect(await liquid.evalValue('j.j == 1', context)).to.equal(true)
+    expect(await liquid.parseAndRender('{{a}}', context)).to.equal('1')
+    expect(await liquid.parseAndRender('{{b}}', context)).to.equal('1')
+    expect(await liquid.parseAndRender('{{c}}', context)).to.equal('1')
+    expect(await liquid.parseAndRender('{{d.d}}', context)).to.equal('1')
+    expect(await liquid.parseAndRender('{{e.e}}', context)).to.equal('1')
+    expect(await liquid.parseAndRender('{{f.f}}', context)).to.equal('1')
+    expect(await liquid.parseAndRender('{{g.g}}', context)).to.equal('1')
+    expect(await liquid.parseAndRender('{{h.h}}', context)).to.equal('1')
+    expect(await liquid.parseAndRender('{{i.i}}', context)).to.equal('1')
+    expect(await liquid.parseAndRender('{{j.j}}', context)).to.equal('1')
+  })
 })