Add a javascript runner for running javascript before and after requests #516
Conversation
mrloop
requested review from
NTBBloodbath and
boltlessengineer
as code owners
mrloop
force-pushed
the
javascript_runner
branch
3 times, most recently
from
b86f3bb to
17a25cb
Compare
There was a problem hiding this comment.
Thank you for your interest and all works!
Didn't expect someone will contribute to javascript runner.
Though I think injecting all data directly to javascript code is too hacky. Both environment variables and response data can be quite large. I'm thinking of communicating with node client using jsonrpc to share data asynchronously.
lua/rest-nvim/script/javascript.lua
Outdated
| local script = {} | ||
| local logger = require("rest-nvim.logger") | ||
|
|
||
| local has_js = vim.fn.has('node') |
There was a problem hiding this comment.
has() is for checking features, not executables. It will check if Neovim node provider is loaded (:h node-client, :h g:loaded_node_provider) and running node is still possible when node provider is not loaded.
We can use vim.fn.executable('node') instead. (:h executable())
| end | ||
|
|
||
| local function write_file(filename, content) | ||
| local file_to_open = cwd() .. "/" .. filename |
There was a problem hiding this comment.
if script file is saved for temporary use, it should be saved in temporary directory like $XDG_RUNTIME_DIR where you can find with stdpath("run")
There was a problem hiding this comment.
not sure the best way to do this and still let node resolve dependencies
lua/rest-nvim/script/javascript.lua
Outdated
| local function create_handler_env(ctx, res) | ||
| local env_vars = {} | ||
| -- can't do pairs(vim.env) instead need to use environ | ||
| for k, v in pairs(vim.fn.environ()) do |
There was a problem hiding this comment.
I'm not sure if passing environment variables is necessary. vim.env table will be available as normal environment variables in processes under Neovim instance.
There was a problem hiding this comment.
Using process.env in node to read environment variables now
lua/rest-nvim/script/javascript.lua
Outdated
| -- can't do pairs(vim.env) instead need to use environ | ||
| for k, v in pairs(vim.fn.environ()) do | ||
| -- ignore values which will make escaping complicated | ||
| if not string.find(v, "[\\'\"`]") then |
There was a problem hiding this comment.
just not handling variables with quotes feel too hacky imho.
There was a problem hiding this comment.
no longer copying all the things
This implement a basic javascript runner. * support Response API * support set/get Request API variables * support set/get client global variables * support jsonPath query in javascript Dev notes: A intermediate file is created for each request in the script folder, `last_javascript.mjs` is the last javascript file that was run. This is useful for debugging. For instance you can run the file from the command line `node --inspect-brk last_javascript.mjs` and then open up `chrome://inspect` in chrome based browers and debug the javascript.
mrloop
force-pushed
the
javascript_runner
branch
from
17a25cb to
335f997
Compare
|
Thanks for reviewing
That sounds good. Would you still need something like |
|
I think it would be better to prioritize implementing a proper jsonrpc version from the start. This approach will take more time, but it will provide a more maintainable and appropriate solution in the long run. For this reason, I’m closing this PR, but I truly value your work and hope you’ll continue contributing in the future. :) |
|
I look forward to seeing the jsonrpc implementation |
This implement a basic javascript runner.
Dev notes:
A intermediate file is created for each request in the script folder,
last_javascript.mjsis the last javascript file that was run. This is useful for debugging. For instance you can run the file from the command linenode --inspect-brk last_javascript.mjsand then open upchrome://inspectin chrome based browers and debug the javascript.