-- Regression test for tdigest_is_valid(), which performs the same checks as
-- the input functions (tdigest_in and tdigest_recv), but on an existing value
-- and without raising an error.
--
-- Digests written by older versions of the extension (which did not have all
-- of the checks) may be broken in various ways, and nothing re-validates the
-- values when reading them back from disk. This function allows finding such
-- digests.
--
-- The input functions reject invalid values, so we can't use them to build
-- the test data. Instead we build the on-disk representation by hand, and use
-- a binary-coercible cast to turn it into a t-digest. Note the forged values
-- must not be passed to anything except tdigest_is_valid() - the whole point
-- is that they are broken, so e.g. printing them might read past the end of
-- the value.
\set VERBOSITY terse
-- casts allowing us to inspect and forge the on-disk representation
CREATE CAST (tdigest AS bytea) WITHOUT FUNCTION;
CREATE CAST (bytea AS tdigest) WITHOUT FUNCTION;
-- The fields of the on-disk representation use the host byte order, while
-- the send functions produce network byte order (big endian), so we may need
-- to reverse the bytes. Determine the host byte order by looking at the flags
-- of a digest we know has flags set to 1.
CREATE FUNCTION is_little_endian() RETURNS bool AS $$
    SELECT substring('flags 1 count 1 compression 10 centroids 1 (1, 1)'::tdigest::bytea from 1 for 4)
           = '\x01000000'::bytea;
$$ LANGUAGE sql IMMUTABLE;
CREATE FUNCTION swap_bytes(b bytea) RETURNS bytea AS $$
    SELECT CASE WHEN is_little_endian()
                THEN (SELECT string_agg(substring(b from i for 1), ''::bytea ORDER BY i DESC)
                        FROM generate_series(1, length(b)) AS i)
                ELSE b
           END;
$$ LANGUAGE sql IMMUTABLE;
-- Transform values to big endian (if needed)
CREATE FUNCTION be_int4(v int) RETURNS bytea AS $$
    SELECT swap_bytes(int4send(v));
$$ LANGUAGE sql IMMUTABLE;
CREATE FUNCTION be_int8(v bigint) RETURNS bytea AS $$
    SELECT swap_bytes(int8send(v));
$$ LANGUAGE sql IMMUTABLE;
CREATE FUNCTION be_float8(v double precision) RETURNS bytea AS $$
    SELECT swap_bytes(float8send(v));
$$ LANGUAGE sql IMMUTABLE;
-- the layout has to be (flags, count, compression, ncentroids) followed by
-- the centroids, each stored as (mean, count)
SELECT length('flags 1 count 3 compression 10 centroids 2 (1, 1) (2, 2)'::tdigest::bytea) AS bytes;
 bytes 
-------
    52
(1 row)

-- a forged value has to be the same as the parsed one (sanity check of the
-- forging, not of the validation)
SELECT (be_int4(1)
     || be_int8(3::bigint)
     || be_int4(10)
     || be_int4(2)
     || be_float8(1) || be_int8(1::bigint)
     || be_float8(2) || be_int8(2::bigint))::tdigest;
                         tdigest                          
----------------------------------------------------------
 flags 1 count 3 compression 10 centroids 2 (1, 1) (2, 2)
(1 row)

--
-- valid values, to make sure the checks don't reject correct digests
--
SELECT tdigest_is_valid('flags 1 count 3 compression 10 centroids 2 (1, 1) (2, 2)'::tdigest);
 tdigest_is_valid 
------------------
 t
(1 row)

-- the old on-disk format, storing sums instead of means
SELECT tdigest_is_valid('flags 0 count 3 compression 10 centroids 2 (1, 1) (4, 2)'::tdigest);
 tdigest_is_valid 
------------------
 t
(1 row)

-- centroids not sorted by mean (produced by the incremental API)
SELECT tdigest_is_valid('flags 1 count 3 compression 10 centroids 2 (2, 2) (1, 1)'::tdigest);
 tdigest_is_valid 
------------------
 t
(1 row)

-- the extreme compression values
SELECT tdigest_is_valid('flags 1 count 1 compression 10 centroids 1 (1, 1)'::tdigest);
 tdigest_is_valid 
------------------
 t
(1 row)

SELECT tdigest_is_valid('flags 1 count 1 compression 10000 centroids 1 (1, 1)'::tdigest);
 tdigest_is_valid 
------------------
 t
(1 row)

-- digests built by the extension itself
SELECT tdigest_is_valid(tdigest(i::double precision, 10)) FROM generate_series(1, 1000) AS s(i);
 tdigest_is_valid 
------------------
 t
(1 row)

SELECT tdigest_is_valid(tdigest(i::double precision, 100)) FROM generate_series(1, 1000) AS s(i);
 tdigest_is_valid 
------------------
 t
(1 row)

SELECT tdigest_is_valid(tdigest_add(NULL::tdigest, ARRAY[1.0, 2.0, 3.0], 10, false));
 tdigest_is_valid 
------------------
 t
(1 row)

SELECT tdigest_is_valid(tdigest_union(tdigest_add(NULL::tdigest, 1.0, 10),
                                      tdigest_add(NULL::tdigest, 2.0, 10)));
 tdigest_is_valid 
------------------
 t
(1 row)

--
-- sanity checks on the header
--
-- unknown flags
SELECT tdigest_is_valid((be_int4(2)
                      || be_int8(1::bigint)
                      || be_int4(10)
                      || be_int4(1)
                      || be_float8(1) || be_int8(1::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

-- compression out of the supported range
SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(1::bigint)
                      || be_int4(9)
                      || be_int4(1)
                      || be_float8(1) || be_int8(1::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(1::bigint)
                      || be_int4(10001)
                      || be_int4(1)
                      || be_float8(1) || be_int8(1::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

-- non-positive total count
SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(0::bigint)
                      || be_int4(10)
                      || be_int4(1)
                      || be_float8(1) || be_int8(1::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

SELECT tdigest_is_valid((be_int4(1)
                      || be_int8((-1)::bigint)
                      || be_int4(10)
                      || be_int4(1)
                      || be_float8(1) || be_int8(1::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

-- non-positive number of centroids
SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(1::bigint)
                      || be_int4(10)
                      || be_int4(0))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(1::bigint)
                      || be_int4(10)
                      || be_int4(-1))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

-- more centroids than fit into the buffer (10 * compression)
SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(1::bigint)
                      || be_int4(10)
                      || be_int4(101)
                      || be_float8(1) || be_int8(1::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

--
-- sanity checks on the length of the value
--
-- The input functions build the digest from the parsed header, so the length
-- always matches. For an existing value we have to check it really is long
-- enough for the centroids the header promises.
--
-- value too short to even contain the header
SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(1::bigint)
                      || be_int4(10))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

-- fewer centroids than the header says
SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(3::bigint)
                      || be_int4(10)
                      || be_int4(2)
                      || be_float8(1) || be_int8(1::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

-- more centroids than the header says
SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(1::bigint)
                      || be_int4(10)
                      || be_int4(1)
                      || be_float8(1) || be_int8(1::bigint)
                      || be_float8(2) || be_int8(2::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

-- incomplete centroid at the end of the value
SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(1::bigint)
                      || be_int4(10)
                      || be_int4(1)
                      || be_float8(1))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

--
-- sanity checks on the centroids
--
-- centroid mean that is not a valid number
SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(1::bigint)
                      || be_int4(10)
                      || be_int4(1)
                      || be_float8('NaN') || be_int8(1::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(1::bigint)
                      || be_int4(10)
                      || be_int4(1)
                      || be_float8('Infinity') || be_int8(1::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(3::bigint)
                      || be_int4(10)
                      || be_int4(2)
                      || be_float8(1) || be_int8(1::bigint)
                      || be_float8('-Infinity') || be_int8(2::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

-- non-positive centroid count
SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(1::bigint)
                      || be_int4(10)
                      || be_int4(1)
                      || be_float8(1) || be_int8(0::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(1::bigint)
                      || be_int4(10)
                      || be_int4(2)
                      || be_float8(1) || be_int8(1::bigint)
                      || be_float8(2) || be_int8((-1)::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

-- centroid count exceeding the total count
SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(1::bigint)
                      || be_int4(10)
                      || be_int4(1)
                      || be_float8(1) || be_int8(2::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

-- centroid counts overflowing the total count
SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(9223372036854775807::bigint)
                      || be_int4(10)
                      || be_int4(2)
                      || be_float8(1) || be_int8(9223372036854775807::bigint)
                      || be_float8(2) || be_int8(9223372036854775807::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

--
-- sanity checks on the value as a whole
--
-- centroid counts not adding up to the total count
SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(3::bigint)
                      || be_int4(10)
                      || be_int4(1)
                      || be_float8(1) || be_int8(1::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

SELECT tdigest_is_valid((be_int4(1)
                      || be_int8(3::bigint)
                      || be_int4(10)
                      || be_int4(2)
                      || be_float8(1) || be_int8(1::bigint)
                      || be_float8(2) || be_int8(3::bigint))::tdigest);
 tdigest_is_valid 
------------------
 f
(1 row)

--
-- the checks have to work on values read back from a table too (which may
-- use a different varlena header, or be TOASTed)
--
CREATE TABLE tdigest_values (id int, d tdigest);
INSERT INTO tdigest_values
SELECT 1, 'flags 1 count 3 compression 10 centroids 2 (1, 1) (2, 2)'::tdigest;
INSERT INTO tdigest_values
SELECT 2, (be_int4(1)
        || be_int8(3::bigint)
        || be_int4(10)
        || be_int4(1)
        || be_float8(1) || be_int8(1::bigint))::tdigest;
INSERT INTO tdigest_values
SELECT 3, tdigest(i::double precision, 1000) FROM generate_series(1, 100000) AS s(i);
SELECT id, tdigest_is_valid(d) FROM tdigest_values ORDER BY id;
 id | tdigest_is_valid 
----+------------------
  1 | t
  2 | f
  3 | t
(3 rows)

-- NULL input produces NULL
SELECT tdigest_is_valid(NULL::tdigest) IS NULL;
 ?column? 
----------
 t
(1 row)

DROP TABLE tdigest_values;
DROP FUNCTION be_float8(double precision);
DROP FUNCTION be_int8(bigint);
DROP FUNCTION be_int4(int);
DROP FUNCTION swap_bytes(bytea);
DROP FUNCTION is_little_endian();
DROP CAST (bytea AS tdigest);
DROP CAST (tdigest AS bytea);