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.

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

Compiled JQ in not execution safe for constant mutable structs #235

Open
afonsosribeiro opened this issue Dec 19, 2023 · 8 comments
Open

Comments

@afonsosribeiro
Copy link

If the jq code contains a constant map (ex {"key":1}).
It will be compiled once and reused, but has it is a mutable struct it can be changd inside the Run, or returned as output and changed by the user.

Solution all mutable structs need to be instantiated at Runtime, never at compile time.

@itchyny
Copy link
Owner

itchyny commented Dec 19, 2023

I can't understand this issue. Can you provide some problematic code?

@afonsosribeiro
Copy link
Author

afonsosribeiro commented Dec 19, 2023

Yes, maybe I also did not explain in the best way.

prog1.jq:
{"count" : 1}

Outputs to the same memory location between executions:
0xc0002ccf30
map[count:1]
0xc0002ccf30
map[count:1]

prog2.jq
{"count" : 1} | .count += 0

Outputs different memory locations between executions:
0xc0006c2540
map[count:1]
0xc0006c26f0
map[count:1]

I would assume, prog1 have the same behavior as prog2 in the output

@itchyny
Copy link
Owner

itchyny commented Dec 19, 2023

Okay, I'd like to know how you use the library. In what use case the current behavior causes problems?

@afonsosribeiro
Copy link
Author

afonsosribeiro commented Dec 19, 2023

I'm implementing a parallel event processing system using a flow of multiple gojq programs.
So the output of one jq program is used as the input of another.

Ex: I compile prog1.jq, execute prog1.jq in paralelel, both executions return a struct in the same memory position, which are then each used as variables in the next jq program of the flow in different go routines.
It is safe to call this method in goroutines, to reuse a compiled [*Code]. But for arguments, do not give values sharing same data between goroutines.

That is how I found this situation, but I can see other scenarios where this can also be an issue.

@wader
Copy link
Contributor

wader commented Dec 21, 2023

@afonsosribeiro same issue as in #212 ? which is as i understand it that RunWithContext calls normalizeNumbers on the input which will modify maps and slices

@afonsosribeiro
Copy link
Author

afonsosribeiro commented Dec 21, 2023

@wader I discovered because of it, but they are not the same issue.
This issue concerns the return struct of a compiled jq code not the normalizeNumbers aspect of runnng jq code.

@wader
Copy link
Contributor

wader commented Dec 21, 2023

Ex: I compile prog1.jq, execute prog1.jq in paralelel, both executions return a struct in the same memory position, which are then each used as variables in the next jq program of the flow in different go routines.

Ok but doesn't it end being the same issue with sharing input? or you mean gojq should guarantee to never return a "shared" variable even if it is a constant literal in your jq program etc?

@afonsosribeiro
Copy link
Author

@wader No it is not the same issue

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants