From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from smtp36.i.mail.ru (smtp36.i.mail.ru [94.100.177.96]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by dev.tarantool.org (Postfix) with ESMTPS id 78E5143E89B for ; Fri, 27 Mar 2020 13:28:57 +0300 (MSK) From: Chris Sosnin Date: Fri, 27 Mar 2020 13:28:54 +0300 Message-Id: <20200327102854.91290-1-k.sosnin@tarantool.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Subject: [Tarantool-patches] [PATCH] box: fix formatting in session.push List-Id: Tarantool development patches List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , To: v.shpilevoy@tarantool.org, tarantool-patches@dev.tarantool.org box.session.push() encodes data as a YAML document independent on the current console output format. This patch adds handling for Lua as well. Closes #4686 --- issue:https://github.com/tarantool/tarantool/issues/4686 branch:https://github.com/tarantool/tarantool/tree/ksosnin/gh-4686-session-push-fmt src/box/lua/console.c | 41 ++++++++++++++++++++++------------- src/box/lua/console.lua | 40 +++++++++++++++++++++++++--------- test/app-tap/console.test.lua | 22 ++++++++++++++++++- 3 files changed, 77 insertions(+), 26 deletions(-) diff --git a/src/box/lua/console.c b/src/box/lua/console.c index 603f7c11b..0185df90a 100644 --- a/src/box/lua/console.c +++ b/src/box/lua/console.c @@ -390,8 +390,8 @@ console_set_output_format(enum output_format output_format) } /** - * Dump port lua data as a YAML document tagged with !push! global - * tag. + * Dump port lua data with respect to output format: + * YAML document tagged with !push! global tag or Lua string. * @param port Port lua. * @param[out] size Size of the result. * @@ -403,18 +403,28 @@ port_lua_dump_plain(struct port *port, uint32_t *size) { struct port_lua *port_lua = (struct port_lua *) port; struct lua_State *L = port_lua->L; - int rc = lua_yaml_encode(L, luaL_yaml_default, "!push!", - "tag:tarantool.io/push,2018"); - if (rc == 2) { - /* - * Nil and error object are pushed onto the stack. - */ - assert(lua_isnil(L, -2)); - assert(lua_isstring(L, -1)); - diag_set(ClientError, ER_PROC_LUA, lua_tostring(L, -1)); - return NULL; + enum output_format fmt = console_get_output_format(); + if (fmt == OUTPUT_FORMAT_YAML) { + int rc = lua_yaml_encode(L, luaL_yaml_default, "!push!", + "tag:tarantool.io/push,2018"); + if (rc == 2) { + /* + * Nil and error object are pushed onto the stack. + */ + assert(lua_isnil(L, -2)); + assert(lua_isstring(L, -1)); + diag_set(ClientError, ER_PROC_LUA, lua_tostring(L, -1)); + return NULL; + } + assert(rc == 1); + } else { + assert(fmt == OUTPUT_FORMAT_LUA_LINE || + fmt == OUTPUT_FORMAT_LUA_BLOCK); + luaL_findtable(L, LUA_GLOBALSINDEX, "box.internal", 1); + lua_getfield(L, -1, "format_lua_push"); + lua_pushvalue(L, -3); + lua_pcall(L, 1, 1, 0); } - assert(rc == 1); assert(lua_isstring(L, -1)); size_t len; const char *result = lua_tolstring(L, -1, &len); @@ -423,10 +433,11 @@ port_lua_dump_plain(struct port *port, uint32_t *size) } /** - * Push a tagged YAML document into a console socket. + * Push a tagged YAML document or a Lua string into a console + * socket. * @param session Console session. * @param sync Unused request sync. - * @param port Port with YAML to push. + * @param port Port with the data to push. * * @retval 0 Success. * @retval -1 Error. diff --git a/src/box/lua/console.lua b/src/box/lua/console.lua index 7208d3d30..79b37bcdb 100644 --- a/src/box/lua/console.lua +++ b/src/box/lua/console.lua @@ -27,6 +27,7 @@ local errno = require('errno') local urilib = require('uri') local yaml = require('yaml') local net_box = require('net.box') +local box_internal = require('box.internal') local PUSH_TAG_HANDLE = '!push!' @@ -207,6 +208,13 @@ local function current_output() end end +-- Used by console_session_push. +box_internal.format_lua_push = function(value) + local opts = current_output()["opts"] + value = format_lua_value(value, opts) + return '-- Push begin\n' .. value .. ';' +end + -- -- Return current EOS value for currently -- active output format. @@ -426,8 +434,8 @@ local text_connection_mt = { return self._socket:write(text) end, -- - -- Read a text from a socket until YAML terminator. - -- @retval not nil Well formatted YAML. + -- Read a text from a socket until EOS. + -- @retval not nil Well formatted data. -- @retval nil Error. -- read = function(self) @@ -459,6 +467,7 @@ local text_connection_mt = { param_handlers[items[2]] == set_output then local err, fmt, opts = parse_output(items[3]) if not err then + self.fmt = fmt self.eos = output_eos[fmt] end end @@ -470,6 +479,7 @@ local text_connection_mt = { eval = function(self, text) self:preprocess_eval(text) text = text..'$EOF$\n' + local fmt = self.fmt or default_output_format["fmt"] if not self:write(text) then error(self:set_error()) end @@ -478,14 +488,23 @@ local text_connection_mt = { if not rc then break end - local handle, prefix = yaml.decode(rc, {tag_only = true}) - if not handle then - -- Can not fail - tags are encoded with no - -- user participation and are correct always. - return rc - end - if handle == PUSH_TAG_HANDLE and self.print_f then - self.print_f(rc) + if fmt == "yaml" then + local handle, prefix = yaml.decode(rc, {tag_only = true}) + if not handle then + -- Can not fail - tags are encoded with no + -- user participation and are correct always. + return rc + end + if handle == PUSH_TAG_HANDLE and self.print_f then + self.print_f(rc) + end + else + if not string.startswith(rc, '-- Push begin') then + return rc + end + if self.print_f then + self.print_f(rc) + end end end return error(self:set_error()) @@ -524,6 +543,7 @@ local function wrap_text_socket(connection, url, print_f) port = url.service, print_f = print_f, eos = current_eos(), + fmt = current_output()["fmt"] }, text_connection_mt) -- -- Prepare the connection: setup EOS symbol diff --git a/test/app-tap/console.test.lua b/test/app-tap/console.test.lua index da5c1e71e..491811f84 100755 --- a/test/app-tap/console.test.lua +++ b/test/app-tap/console.test.lua @@ -21,7 +21,7 @@ local EOL = "\n...\n" test = tap.test("console") -test:plan(73) +test:plan(77) -- Start console and connect to it local server = console.listen(CONSOLE_SOCKET) @@ -39,6 +39,26 @@ test:is(client:read(EOL), '%TAG !push! tag:tarantool.io/push,2018\n--- 200\n...\ "pushed message") test:is(client:read(EOL), '---\n- true\n...\n', "pushed message") +-- +-- gh-4686: box.session.push should respect output format. +-- +client:write('\\set output lua\n') +client:read(";") + +client:write('box.session.push({})\n') +test:is(client:read(";"), '-- Push begin\n{};', "pushed message") +test:is(client:read(";"), 'true;', "pushed message") + +client:write('\\set output lua,block\n') +client:read(";") + +client:write('box.session.push({1})\n') +test:is(client:read(";"), '-- Push begin\n{\n 1\n};', "pushed message") +test:is(client:read(";"), 'true;', "pushed message") + +client:write('\\set output yaml\n') +client:read(EOL) + -- -- gh-3790: box.session.push support uint64_t sync. -- -- 2.21.1 (Apple Git-122.3)