http: usability improvement

Formerly http.config({tls=false}, 'doh') also removed all endpoints for
'doh', which was unexpected.

With this change configurations are merged as expected and user does not
have to repeat endpoints and other options from builtin template.

diff --git a/modules/http/README.rst b/modules/http/README.rst
index 9d2b211da1ac3d8ee95c45f66b8ceaab93c5d8ba..7c82d893fab1d3254922f30f4f1d3b8e39f74cff 100644 (file)
--- a/modules/http/README.rst
+++ b/modules/http/README.rst
@@ -258,7 +258,7 @@ add the new endpoint description to respective table:
 
        modules.load('http')
        -- copy all existing webmgmt endpoints
-       my_mgmt_endpoints = http.templates.webmgmt.endpoints
+       my_mgmt_endpoints = http.configs._builtin.webmgmt.endpoints
        -- add custom endpoint to the copy
        my_mgmt_endpoints['/health'] = on_health
        -- use custom HTTP configuration for webmgmt

diff --git a/modules/http/http.lua.in b/modules/http/http.lua.in
index 34c457b494442ba1990ba09c634d5244d61336bc..718497f343c02d900439223ff956232fe78e2787 100644 (file)
--- a/modules/http/http.lua.in
+++ b/modules/http/http.lua.in
@@ -22,11 +22,11 @@ local has_mmdb, mmdb  = pcall(require, 'mmdb')
 -- Module declaration
 local M = {
        servers = {},
-       templates = {}  -- configuration templates
+       configs = { _builtin = {} }  -- configuration templates
 }
 
 -- inherited by all configurations
-M.templates._builtin = {
+M.configs._builtin._all = {
        cq = worker.bg_worker.cq,
        cert = 'self.crt',
        key = 'self.key',
@@ -34,7 +34,7 @@ M.templates._builtin = {
        client_timeout = 5
 }
 -- log errors but do not throw
-M.templates._builtin.onerror = function(myserver, context, op, err, errno) -- luacheck: ignore 212
+M.configs._builtin._all.onerror = function(myserver, context, op, err, errno) -- luacheck: ignore 212
        local msg = '[http] ' .. op .. ' on ' .. tostring(context) .. ' failed'
        if err then
                msg = msg .. ': ' .. tostring(err)
@@ -45,13 +45,13 @@ M.templates._builtin.onerror = function(myserver, context, op, err, errno) -- lu
 end
 
 -- M.config() without explicit "kind" modifies this
-M.templates._default = {}
+M.configs._all = {}
 
 -- DoH
-M.templates.doh = {}
+M.configs._builtin.doh = {}
 
 -- management endpoint
-M.templates.webmgmt = {}
+M.configs._builtin.webmgmt = {}
 
 -- Map extensions to MIME type
 local mime_types = {
@@ -119,9 +119,9 @@ local function serve_root()
 end
 
 -- Export HTTP service endpoints
-M.templates.doh.endpoints = {}
-M.templates.webmgmt.endpoints = {}
-local mgmt_endpoints = M.templates.webmgmt.endpoints
+M.configs._builtin.doh.endpoints = {}
+M.configs._builtin.webmgmt.endpoints = {}
+local mgmt_endpoints = M.configs._builtin.webmgmt.endpoints
 
 mgmt_endpoints['/'] = {'text/html', serve_root()}
 
@@ -144,11 +144,11 @@ for k, v in pairs(http_trace.endpoints) do
 end
 M.trace = http_trace
 
-M.templates.doh.endpoints = {}
+M.configs._builtin.doh.endpoints = {}
 local http_doh = require('kres_modules.http_doh')
 for k, v in pairs(http_doh.endpoints) do
        mgmt_endpoints[k] = v
-       M.templates.doh.endpoints[k] = v
+       M.configs._builtin.doh.endpoints[k] = v
 end
 M.doh = http_doh
 
@@ -318,14 +318,19 @@ local function updatecert(crtfile, keyfile)
        return crt, key
 end
 
--- @function Merge dictionaries.
+-- @function Merge dictionaries, nil is like empty dict.
 -- Values from right-hand side dictionaries take precedence.
 local function mergeconf(...)
        local merged = {}
-       for _, intable in ipairs({...}) do
-               assert(type(intable) == 'table', 'cannot merge non-tables')
-               for key, val in pairs(intable) do
-                       merged[key] = val
+       local ntables = select('#', ...)
+       local tables = {...}
+       for i = 1, ntables do
+               local intable = tables[i]
+               if intable ~= nil then
+                       assert(type(intable) == 'table', 'cannot merge non-tables')
+                       for key, val in pairs(intable) do
+                               merged[key] = val
+                       end
                end
        end
        return merged
@@ -359,7 +364,7 @@ end
 local function add_socket(fd, kind, addr_str)
        assert(M.servers[fd] == nil, 'socket is already served by an HTTP instance')
        local conf, crt, key
-       conf = mergeconf(M.templates._builtin, M.templates._default, M.templates[kind] or {})
+       conf = mergeconf(M.configs._builtin._all, M.configs._builtin[kind], M.configs._all, M.configs[kind])
        conf.socket = cqueues.socket.fdopen(fd)
        if conf.tls ~= false then
                -- Check if a cert file was specified
@@ -458,16 +463,20 @@ function M.config(conf, kind)
                return
        end
 
-       kind = kind or '_default'
+       kind = kind or '_all'
        assert(type(kind) == 'string')
 
        local operation
-       if M.templates[kind] then  -- config on an existing template
+       -- builtins cannot be removed or added
+       if M.configs._builtin[kind] then
+               operation = 'modify'
+               conf = conf or {}
+       elseif M.configs[kind] then  -- config on an existing user template
                if conf then    operation = 'modify'
                else            operation = 'delete' end
        else  -- config for not-yet-existing template
                if conf then    operation = 'add'
-               else            panic('endpoint kind "%s" does not exist, '
+               else            panic('[http] endpoint kind "%s" does not exist, '
                                        .. 'nothing to delete', kind) end
        end
 
@@ -494,7 +503,7 @@ function M.config(conf, kind)
        for _, instance in pairs(M.servers) do
                -- modification cannot be implemented as
                -- remove_socket + add_socket because remove closes the socket
-               if instance.kind == kind then
+               if instance.kind == kind or kind == '_all' then
                        panic('unable to modify configration for '
                                .. 'endpoint kind "%s" because it is in '
                                .. 'use, use net.close() first', kind)
@@ -506,7 +515,7 @@ function M.config(conf, kind)
        elseif operation == 'delete' then
                net.register_endpoint_kind(kind)
        end
-       M.templates[kind] = conf
+       M.configs[kind] = conf
 end
 
 return M

diff --git a/modules/http/http.test.lua b/modules/http/http.test.lua
index ed8f510c559f24fbd39caa19e8dcc7b3be1713d3..960288aae831b2d8ddb996828367106f00eadde4 100644 (file)
--- a/modules/http/http.test.lua
+++ b/modules/http/http.test.lua
@@ -7,7 +7,7 @@ else
        local request = require('http.request')
 
        modules.load('http')
-       local endpoints = http.templates.webmgmt.endpoints
+       local endpoints = http.configs._builtin.webmgmt.endpoints
 
        -- custom endpoints
        endpoints['/test'] = {'text/custom', function () return 'hello' end}

diff --git a/modules/http/http_doh.test.lua b/modules/http/http_doh.test.lua
index 74e1d4357d3eff003beb2bed30f519a5e321d69d..90a39d03a0432ff2fba853a3a641e62e2e1548f9 100644 (file)
--- a/modules/http/http_doh.test.lua
+++ b/modules/http/http_doh.test.lua
@@ -84,7 +84,6 @@ else
        modules.load('http')
        http.config({
                tls = false,
-               endpoints = http.templates.doh.endpoints
        }, 'doh')
 
        local bound