expr icon indicating copy to clipboard operation
expr copied to clipboard

[Request/Question] Support proxies for `expr.Env`

Open x1unix opened this issue 10 months ago • 8 comments

Greetings.

I've a question - does expr support having proxies as expr.Env (something similar to Proxy feature in JS)?

I have a situation where I've to deal with a chain of objects as env that have prototype inheritance (also like in JS).

As env itself is dynamic (might depend on context, environment vars, etc), in order to build expr.Env each time I need to run an expression - it's necessary to traverse a whole prototype chain and create a new map.

Feature Benefits

This feature will allow to handle complex cases such as:

  • Cases when value have to be pulled dynamically in runtime.
  • To abstract away env when it has a complex structure, such as prototype chain.
  • Avoid allocating additional maps or structs for env.

Proposed solutions

Global & Nested Proxy

Ideally, to handle such cases, expr.Env could consume a ProxyEnv interface that will be called to get a variable:

// feel free to provide a better name
type ProxyEnv interface {
   GetValue(path string) (bool, any)
}

If returned value implements ProxyEnv, it also should be treated as proxy:

func example() {
    // Let's assume expression is `foo.bar[keyName]`
    keyName, _ := getValue(env, "keyName")

    foo, _ := getValue(env, "foo")
    bar, _ := getValue(bar, "bar")

    result, _ := getValue(bar, keyName)
}

func getValue(env any, key string) (any, bool) {
  switch t := env.(type) {
    case ProxyEnv:
        return t.GetValue(key)
    case map[string]any:
        v, ok := t[key]
        return v, ok
    default:
        // use reflection
        return getUsingReflect(env, key)
  }
}

Pros

  • Easier to implement

Cons

  • Additional type casting

Alternative Solutions

Please feel free to provide a better more efficient solution.

x1unix avatar Mar 30 '25 07:03 x1unix

I think we can add those features.

What about this case:

 foo.bar[42 + x].baz

antonmedv avatar Mar 30 '25 18:03 antonmedv

@antonmedv good question!

Please check updated proposal.

x1unix avatar Mar 30 '25 20:03 x1unix

What about something like this:

type Proxy struct {
    Get(path []string) (any, error)
}

And on an expression:

let x = 100; 
foo.bar[42 + x].baz

Proxy will be called with

path := []string{
    "foo",
    "bar",
    "142",
    "baz",
}

antonmedv avatar Mar 31 '25 09:03 antonmedv

@antonmedv as far as I know, expr supports variables.

It might be complex to handle such cases:

let y = foo.bar
y[42 + x].baz // Path chain has to be preserved when passed to Proxy

imho it might be easier to support nested ProxyEnv instead.

Also user might want to have a proxy only for specific fields (e.g. only for foo.bar but not for foo.bar.baz)

x1unix avatar Mar 31 '25 15:03 x1unix

@antonmedv if you're interested, I can try to make a PR after the proposal will be finalized.

x1unix avatar Mar 31 '25 18:03 x1unix

I think implementation should be done via patcher which will replace property access with function cause.

antonmedv avatar Mar 31 '25 20:03 antonmedv

@antonmedv if patched code will throw an error, would error position point to an original (pre-patched) code?

Let's imagine a code like this:

foo.bar.baz

and patched version would look like this:

foo.bar().baz() // bar returns nil

Ideally returned EvalError should be transparently mapped to original code:

foo.bar.baz
        ^^^ Cannot read properties of undefined (reading "baz")

Imho native object proxy support will make implementation much more simple.

x1unix avatar Apr 07 '25 00:04 x1unix

Expr patcher designed to point to original code location! Actually a lot of optimizations is done via patcher. But errors always return original code allocation.

antonmedv avatar Apr 07 '25 07:04 antonmedv