annotate spec/util_human_io_spec.lua @ 13652:a08065207ef0

net.server_epoll: Call :shutdown() on TLS sockets when supported Comment from Matthew: This fixes a potential issue where the Prosody process gets blocked on sockets waiting for them to close. Unlike non-TLS sockets, closing a TLS socket sends layer 7 data, and this can cause problems for sockets which are in the process of being cleaned up. This depends on LuaSec changes which are not yet upstream. From Martijn's original email: So first my analysis of luasec. in ssl.c the socket is put into blocking mode right before calling SSL_shutdown() inside meth_destroy(). My best guess to why this is is because meth_destroy is linked to the __close and __gc methods, which can't exactly be called multiple times and luasec does want to make sure that a tls session is shutdown as clean as possible. I can't say I disagree with this reasoning and don't want to change this behaviour. My solution to this without changing the current behaviour is to introduce a shutdown() method. I am aware that this overlaps in a conflicting way with tcp's shutdown method, but it stays close to the OpenSSL name. This method calls SSL_shutdown() in the current (non)blocking mode of the underlying socket and returns a boolean whether or not the shutdown is completed (matching SSL_shutdown()'s 0 or 1 return values), and returns the familiar ssl_ioerror() strings on error with a false for completion. This error can then be used to determine if we have wantread/wantwrite to finalize things. Once meth_shutdown() has been called once a shutdown flag will be set, which indicates to meth_destroy() that the SSL_shutdown() has been handled by the application and it shouldn't be needed to set the socket to blocking mode. I've left the SSL_shutdown() call in the LSEC_STATE_CONNECTED to prevent TOCTOU if the application reaches a timeout for the shutdown code, which might allow SSL_shutdown() to clean up anyway at the last possible moment. Another thing I've changed to luasec is the call to socket_setblocking() right before calling close(2) in socket_destroy() in usocket.c. According to the latest POSIX[0]: Note that the requirement for close() on a socket to block for up to the current linger interval is not conditional on the O_NONBLOCK setting. Which I read to mean that removing O_NONBLOCK on the socket before close doesn't impact the behaviour and only causes noise in system call tracers. I didn't touch the windows bits of this, since I don't do windows. For the prosody side of things I've made the TLS shutdown bits resemble interface:onwritable(), and put it under a combined guard of self._tls and self.conn.shutdown. The self._tls bit is there to prevent getting stuck on this condition, and self.conn.shutdown is there to prevent the code being called by instances where the patched luasec isn't deployed. The destroy() method can be called from various places and is read by me as the "we give up" error path. To accommodate for these unexpected entrypoints I've added a single call to self.conn:shutdown() to prevent the socket being put into blocking mode. I have no expectations that there is any other use here. Same as previous, the self.conn.shutdown check is there to make sure it's not called on unpatched luasec deployments and self._tls is there to make sure we don't call shutdown() on tcp sockets. I wouldn't recommend logging of the conn:shutdown() error inside close(), since a lot of clients simply close the connection before SSL_shutdown() is done.
author Martijn van Duren <martijn@openbsd.org>
date Thu, 06 Feb 2025 15:04:38 +0000
parents 82513890a1d8
children 7eb0e47418ab
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
10978
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 describe("util.human.io", function ()
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 local human_io
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 setup(function ()
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 human_io = require "util.human.io";
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 end);
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 describe("table", function ()
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 it("alignment works", function ()
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 local row = human_io.table({
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 {
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 width = 3,
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 align = "right"
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13 },
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
14 {
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
15 width = 3,
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16 },
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
17 });
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
18
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19 assert.equal(" 1 | . ", row({ 1, "." }));
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
20 assert.equal(" 10 | .. ", row({ 10, ".." }));
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
21 assert.equal("100 | ...", row({ 100, "..." }));
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22 assert.equal("10… | ..…", row({ 1000, "...." }));
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
23
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
24 end);
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
25 end);
11896
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
26
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
27 describe("ellipsis", function()
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
28 it("works", function()
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
29 assert.equal("…", human_io.ellipsis("abc", 1));
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
30 assert.equal("a…", human_io.ellipsis("abc", 2));
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
31 assert.equal("abc", human_io.ellipsis("abc", 3));
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
32
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
33 assert.equal("…", human_io.ellipsis("räksmörgås", 1));
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
34 assert.equal("r…", human_io.ellipsis("räksmörgås", 2));
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
35 assert.equal("rä…", human_io.ellipsis("räksmörgås", 3));
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
36 assert.equal("räk…", human_io.ellipsis("räksmörgås", 4));
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
37 assert.equal("räks…", human_io.ellipsis("räksmörgås", 5));
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
38 assert.equal("räksm…", human_io.ellipsis("räksmörgås", 6));
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
39 assert.equal("räksmö…", human_io.ellipsis("räksmörgås", 7));
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
40 assert.equal("räksmör…", human_io.ellipsis("räksmörgås", 8));
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
41 assert.equal("räksmörg…", human_io.ellipsis("räksmörgås", 9));
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
42 assert.equal("räksmörgås", human_io.ellipsis("räksmörgås", 10));
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
43 end);
93e9f7ae2f9b util.human.io: Fix cutting of UTF-8 into pieces
Kim Alvefur <zash@zash.se>
parents: 10978
diff changeset
44 end);
13054
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
45
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
46 describe("parse_duration", function ()
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
47 local function test(expected, duration)
13197
6beec4de8e63 util.human.io: Include relevant arguments in test messages
Kim Alvefur <zash@zash.se>
parents: 13196
diff changeset
48 return assert.equal(expected, human_io.parse_duration(duration), ("%q -> %d"):format(duration, expected));
13054
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
49 end
13367
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
50 local function should_fail(duration)
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
51 assert.is_nil(human_io.parse_duration(duration), "invalid duration should fail: %q");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
52 end
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
53 it("works", function ()
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
54 test(1, "1s");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
55 test(60, "1min");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
56 test(60, "1 min");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
57 test(60, "1 minute");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
58 test(120, "2min");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
59 test(7200, "2h");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
60 test(7200, "2 hours");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
61 test(86400, "1d");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
62 test(604800, "1w");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
63 test(604800, "1week");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
64 test(1814400, "3 weeks");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
65 test(2678400, "1month");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
66 test(2678400, "1 month");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
67 test(31536000, "365 days");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
68 test(31556952, "1 year");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
69
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
70 should_fail("two weeks");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
71 should_fail("1m");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
72 should_fail("1mi");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
73 should_fail("1mo");
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
74 end);
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
75 end);
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
76
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
77 describe("parse_duration_lax", function ()
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
78 local function test(expected, duration)
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
79 return assert.equal(expected, human_io.parse_duration_lax(duration), ("%q -> %d"):format(duration, expected));
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
80 end
13054
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
81 it("works", function ()
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
82 test(1, "1s");
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
83 test(60, "1mi");
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
84 test(60, "1min");
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
85 test(60, "1 min");
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
86 test(60, "1 minute");
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
87 test(120, "2min");
13198
313c49c7566a util.human.io: Add tests for parse_duration() (some failing)
Kim Alvefur <zash@zash.se>
parents: 13197
diff changeset
88 test(7200, "2h");
313c49c7566a util.human.io: Add tests for parse_duration() (some failing)
Kim Alvefur <zash@zash.se>
parents: 13197
diff changeset
89 test(7200, "2 hours");
13054
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
90 test(86400, "1d");
13198
313c49c7566a util.human.io: Add tests for parse_duration() (some failing)
Kim Alvefur <zash@zash.se>
parents: 13197
diff changeset
91 test(604800, "1w");
313c49c7566a util.human.io: Add tests for parse_duration() (some failing)
Kim Alvefur <zash@zash.se>
parents: 13197
diff changeset
92 test(604800, "1week");
313c49c7566a util.human.io: Add tests for parse_duration() (some failing)
Kim Alvefur <zash@zash.se>
parents: 13197
diff changeset
93 test(1814400, "3 weeks");
13054
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
94 test(2678400, "1m");
13198
313c49c7566a util.human.io: Add tests for parse_duration() (some failing)
Kim Alvefur <zash@zash.se>
parents: 13197
diff changeset
95 test(2678400, "1mo");
13054
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
96 test(2678400, "1month");
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
97 test(2678400, "1 month");
13198
313c49c7566a util.human.io: Add tests for parse_duration() (some failing)
Kim Alvefur <zash@zash.se>
parents: 13197
diff changeset
98 test(31536000, "365 days");
313c49c7566a util.human.io: Add tests for parse_duration() (some failing)
Kim Alvefur <zash@zash.se>
parents: 13197
diff changeset
99 test(31556952, "1 year");
13367
82513890a1d8 util.human.io: Don't accept ambiguous durations by default
Matthew Wild <mwild1@gmail.com>
parents: 13198
diff changeset
100 return assert.is_nil(human_io.parse_duration_lax("two weeks"), "\"2 weeks\" -> nil");
13054
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
101 end);
f4d7fe919969 util.human.io: Add parse_duration() method to parse a duration string
Matthew Wild <mwild1@gmail.com>
parents: 11896
diff changeset
102 end);
10978
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
103 end);
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
104
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
105
4d3247a1f6b3 util.human.io: Add brief test of table generation
Kim Alvefur <zash@zash.se>
parents:
diff changeset
106