chore(jellyfin): adjust default allow_ttl to 1d (#84)

Author: flrgh

lib/doorbell/plugins/jellyfin.lua

@@ -28,9 +28,9 @@ local log = require("doorbell.log").with_namespace(_M.name)
 
 ---@class doorbell.config.plugin.jellyfin
 ---
----@field url        string # jellyfin address
----@field api?       string # jellyfin API address (derived from `url` if not set)
----@field allow_ttl? integer
+---@field url        string  # jellyfin address
+---@field api?       string  # jellyfin API address (derived from `url` if not set)
+---@field allow_ttl? integer # duration (in seconds) to create `allow` rules for
 
 local STATES = const.states
 local SHM = shm.with_namespace("jf")
@@ -41,14 +41,16 @@ local HOST
 ---@type string
 local API_URL
 
-local ALLOW_TTL = 60 * 60
+---@type string
+local AUTH_CHECK_URL
+
+local ALLOW_TTL = 60 * 60 * 24
 
 local LOGIN_PATH = "/users/authenticatebyname"
 local LOGOUT_PATH = "/sessions/logout"
 local AUTH_QUERY_PARAM = lower("api_key")
 local AUTH_SELF = "/Users/Me"
 local AUTH_SELF_HEADER = "X-Emby-Token"
-local AUTH_CHECK_URL
 local UNKNOWN = "<unknown>"
 
 local TOKEN_RE = [=[Token=['"]([^'"]+)['"]]=]
@@ -79,10 +81,10 @@ local function check_jellyfin_token(token)
     json, err = cjson.decode(res.body)
     if not json then
       log.warn("`GET /Users/Me` returned invalid json: ", err)
-      return true
+      return nil, "json decode error: " .. err
     end
 
-    return json.Name or json.name or true
+    return json.Name or json.name or UNKNOWN
 
   else
     return false, nil, 5
@@ -92,7 +94,7 @@ end
 ---@param token string
 ---@return string
 local function auth_cache_key(token)
-  return "doorbell.auth_token." .. sha256(token)
+  return "jellyfin.auth_token." .. sha256(token)
 end
 
 ---@param token string
@@ -314,6 +316,9 @@ local function timer_handler()
       source = "plugin",
       plugin = "jellyfin",
       comment = fmt("allowed via jellyfin plugin for user %q", user),
+      meta = {
+        ["jellyfin.user"] = user,
+      },
     })
 
     if rule then

spec/02-integration/99-plugins/01-jellyfin_spec.lua

@@ -26,7 +26,7 @@ describe("jellyfin", function()
         jellyfin = {
           url = "http://jellyfin",
           api = fmt("http://127.0.0.1:%s", const.MOCK_UPSTREAM_PORT),
-          allow_ttl = 3,
+          allow_ttl = 2,
         }
       }
     end
@@ -123,11 +123,7 @@ describe("jellyfin", function()
         assert.is_nil(client.err)
         assert.equals(200, client.response.status)
 
-        local res, req = ms.mock.get_last()
-        assert.is_table(res)
-        assert.equals(200, res.status)
-        assert.is_table(req)
-        assert.is_table(req.headers)
+        local req = ms.mock.assert_request_received()
         assert.equals(token, req.headers["x-emby-token"])
       end
 
@@ -179,6 +175,8 @@ describe("jellyfin", function()
         client:send()
         assert.is_Nil(client.err)
         assert.equals(200, client.response.status)
+
+        ms.mock.assert_no_request_received()
       end)
     end)
 
@@ -207,16 +205,12 @@ describe("jellyfin", function()
       assert.is_nil(client.err)
       assert.equals(200, client.response.status)
 
-      local res, req = ms.mock.get_last()
-      assert.is_table(res)
-      assert.equals(200, res.status)
-      assert.is_table(req)
-      assert.is_table(req.headers)
+      local req = ms.mock.assert_request_received()
       assert.equals(token, req.headers["x-emby-token"])
 
       local api = nginx:add_client(test.client())
       test.await.truthy(function()
-        res = api:get("/rules")
+        local res = api:get("/rules")
         assert.is_nil(api.err)
         assert.equals(200, res.status)
         assert.is_table(res.json)
@@ -234,7 +228,7 @@ describe("jellyfin", function()
         end
 
         return false
-      end, 5, 1)
+      end, 5)
     end)
 
     it("recreates allow rules as necessary", function()
@@ -262,19 +256,15 @@ describe("jellyfin", function()
       assert.is_nil(client.err)
       assert.equals(200, client.response.status)
 
-      local res, req = ms.mock.get_last()
-      assert.is_table(res)
-      assert.equals(200, res.status)
-      assert.is_table(req)
-      assert.is_table(req.headers)
+      local req = ms.mock.assert_request_received()
       assert.equals(token, req.headers["x-emby-token"])
 
       local api = nginx:add_client(test.client())
 
       local rule_id
 
       local function have_rule()
-        res = api:get("/rules")
+        local res = api:get("/rules")
         assert.is_nil(api.err)
         assert.equals(200, res.status)
         assert.is_table(res.json)
@@ -297,16 +287,16 @@ describe("jellyfin", function()
         return false
       end
 
-      test.await.truthy(have_rule, 5, 1)
-      test.await.falsy(have_rule, 10, 1)
+      test.await.truthy(have_rule, 5)
+      test.await.falsy(have_rule, 10)
 
       local old_id = rule_id
 
       client:send()
       assert.is_nil(client.err)
       assert.equals(200, client.response.status)
 
-      test.await.truthy(have_rule, 5, 1)
+      test.await.truthy(have_rule, 5)
       assert.not_equal(rule_id, old_id)
     end)
 
@@ -359,17 +349,13 @@ describe("jellyfin", function()
       assert.is_nil(client.err)
       assert.equals(200, client.response.status)
 
-      local res, req = ms.mock.get_last()
-      assert.is_table(res)
-      assert.equals(200, res.status)
-      assert.is_table(req)
-      assert.is_table(req.headers)
+      local req = ms.mock.assert_request_received()
       assert.equals(token, req.headers["x-emby-token"])
 
       local api = nginx:add_client(test.client())
 
       local function have_rule()
-        res = api:get("/rules")
+        local res = api:get("/rules")
         assert.is_nil(api.err)
         assert.equals(200, res.status)
         assert.is_table(res.json)
@@ -389,7 +375,7 @@ describe("jellyfin", function()
         return false
       end
 
-      test.await.truthy(have_rule, 5, 1)
+      test.await.truthy(have_rule, 5)
 
       client:add_x_forwarded_headers(addr, "POST", "http://jellyfin/Sessions/Logout")
       client.headers["X-Mediabrowser-Token"] = token
@@ -398,7 +384,7 @@ describe("jellyfin", function()
       assert.equals(200, client.response.status)
 
       -- wait for the rule to expire
-      test.await.falsy(have_rule, 10, 1)
+      test.await.falsy(have_rule, 10)
 
       ms.mock.prepare({
         path = "/Users/Me",

spec/testing.lua

@@ -42,14 +42,26 @@ _M.fs = require("spec.testing.fs")
 
 
 _M.await = {
+  ---@param fn       function
+  ---@param timeout? number
+  ---@param step?    number
+  ---@param msg      any
   truthy = function(fn, timeout, step, msg)
     assert(await.truthy(timeout, step, fn), msg or "timeout reached", 2)
   end,
 
+  ---@param fn       function
+  ---@param timeout? number
+  ---@param step?    number
+  ---@param msg      any
   falsy = function(fn, timeout, step, msg)
     assert(await.falsy(timeout, step, fn), msg or "timeout reached", 2)
   end,
 
+  ---@param fn       function
+  ---@param timeout? number
+  ---@param step?    number
+  ---@param msg      any
   no_error = function(fn, timeout, step, msg)
     local wrapped = function(...)
       return pcall(fn, ...)

spec/testing/await.lua

@@ -1,26 +1,49 @@
+local function back_off(step)
+  return (step * 1.25) + (0.01 * math.random())
+end
+
+local function no_back_off(step)
+  return step
+end
+
 ---@param timeout? number
 ---@param step?    number
 ---@param fn       function
 ---@param ...      any
 ---@return boolean ok
 ---@return number elapsed
 local function await(timeout, step, fn, ...)
-  step = step or 0.05
+  local next_step
+  if step then
+    next_step = no_back_off
+
+  else
+    step = 0.01
+    next_step = back_off
+  end
+
   timeout = timeout or 5
 
   ngx.update_time()
   local start = ngx.now()
   local deadline = start + timeout
 
-  repeat
+  while true do
     if fn(...) then
       ngx.update_time()
       return true, ngx.now() - start
     end
 
-    ngx.sleep(step)
     ngx.update_time()
-  until ngx.now() >= deadline
+    local time = ngx.now()
+    local remain = deadline - time
+    if remain < 0 then
+      break
+    end
+
+    step = math.min(next_step(step), remain)
+    ngx.sleep(step)
+  end
 
   return false, ngx.now() - start
 end

spec/testing/mock-upstream.lua

@@ -6,6 +6,7 @@ local cjson_safe = require "cjson.safe"
 local http  = require "doorbell.http"
 local uuid  = require("resty.jit-uuid").generate_v4
 local resty_http = require "resty.http"
+local luassert = require "luassert"
 
 local SHM = ngx.shared.mock
 local EMPTY = {}
@@ -142,7 +143,7 @@ local function get_request()
 
   local errors = {}
   local body = http.request.get_raw_body()
-  local json = ngx.null
+  local json
 
   if body and content_type:lower():find("application/json") then
     local err
@@ -155,18 +156,22 @@ local function get_request()
 
   body = body or ngx.null
 
-  ---@class spec.testing.mock-upstream.request : table
-  return {
+  ---@class spec.testing.mock-upstream.request
+  local req = {
     headers = headers,
     method  = ngx.req.get_method(),
     host    = ngx.var.host:lower(),
     uri     = ngx.var.request_uri,
     path    = ngx.var.request_uri:gsub("%?.*", ""),
     query   = ngx.req.get_uri_args(1000),
+    ---@type string|nil
     body    = body,
+    ---@type any|nil
     json    = json,
     errors  = errors,
   }
+
+  return req
 end
 
 ---@param res spec.testing.mock-upstream.response
@@ -322,17 +327,38 @@ mock.mock = {
     assert(res.status == 200)
   end,
 
+  ---@return spec.testing.mock-upstream.request|nil
   get_last = function()
     local res = mocker_send("/_/last")
     assert(res.status == 200 or res.status == 404)
-    return res, cjson.decode(res.body)
+
+    if res.status == 404 then
+      return
+    end
+
+    return cjson.decode(res.body)
   end,
 
   reset = function()
     local res = mocker_send("/_/reset", nil, { method = "POST" })
     assert(res.status == 200)
   end,
-
 }
 
+mock.mock.assert_no_request_received = function()
+  local req = mock.mock.get_last()
+  luassert.is_nil(req, "expected no recent requests to the mock upstream")
+end
+
+
+---@return spec.testing.mock-upstream.request
+mock.mock.assert_request_received = function()
+  local req = mock.mock.get_last()
+  luassert.not_nil(req, "expected the mock upstream to have received a request")
+  luassert.is_table(req)
+  luassert.is_table(req.headers)
+
+  return req
+end
+
 return mock

spec/testing/nginx.lua

@@ -34,7 +34,7 @@ end
 ---@param timeout? number
 local function wait_pid(pid, fn, timeout)
   timeout = timeout or 5
-  return await.truthy(timeout, 0.05, fn, pid)
+  return await.truthy(timeout, nil, fn, pid)
 end