dev-npgsql/npgsql: Npgsql is the .NET data provider for PostgreSQL.

test/Npgsql.PluginTests/JsonNetTests.cs
281 строка9 KB
Nikita Kazmin
Make the default value for json with Json.NET a string (#5914)
09 ноя 2024, 00:07
09 ноя 2024, 00:07e038010
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using Npgsql.Tests;
using NpgsqlTypes;
using NUnit.Framework;
using System;
using System.Text;
using System.Threading.Tasks;

// ReSharper disable AccessToModifiedClosure
// ReSharper disable AccessToDisposedClosure

namespace Npgsql.PluginTests;

/// <summary>
/// Tests for the Npgsql.Json.NET mapping plugin
/// </summary>
[TestFixture(NpgsqlDbType.Jsonb)]
[TestFixture(NpgsqlDbType.Json)]
public class JsonNetTests(NpgsqlDbType npgsqlDbType) : TestBase
{
    [Test]
    public Task Roundtrip_object()
        => AssertType(
            JsonDataSource,
            new Foo { Bar = 8 },
            IsJsonb ? @"{""Bar"": 8}" : @"{""Bar"":8}",
            _pgTypeName,
            npgsqlDbType,
            isDefault: false,
            isNpgsqlDbTypeInferredFromClrType: false);

    [Test, IssueLink("https://github.com/npgsql/npgsql/issues/3085")]
    public Task Roundtrip_string()
        => AssertType(
            JsonDataSource,
            @"{""p"": 1}",
            @"{""p"": 1}",
            _pgTypeName,
            npgsqlDbType,
            isDefaultForWriting: false,
            isNpgsqlDbTypeInferredFromClrType: false);

    [Test, IssueLink("https://github.com/npgsql/npgsql/issues/3085")]
    public Task Roundtrip_char_array()
        => AssertType(
            JsonDataSource,
            @"{""p"": 1}".ToCharArray(),
            @"{""p"": 1}",
            _pgTypeName,
            npgsqlDbType,
            isDefault: false,
            isNpgsqlDbTypeInferredFromClrType: false);

    [Test, IssueLink("https://github.com/npgsql/npgsql/issues/3085")]
    public Task Roundtrip_byte_array()
        => AssertType(
            JsonDataSource,
            Encoding.ASCII.GetBytes(@"{""p"": 1}"),
            @"{""p"": 1}",
            _pgTypeName,
            npgsqlDbType,
            isDefault: false,
            isNpgsqlDbTypeInferredFromClrType: false);

    [Test]
    public Task Roundtrip_JObject()
        => AssertType(
            JsonDataSource,
            new JObject { ["Bar"] = 8 },
            IsJsonb ? @"{""Bar"": 8}" : @"{""Bar"":8}",
            _pgTypeName,
            npgsqlDbType,
            // By default we map JObject to jsonb
            isDefaultForWriting: IsJsonb,
            isDefaultForReading: false,
            isNpgsqlDbTypeInferredFromClrType: false);

    [Test]
    public Task Roundtrip_JArray()
        => AssertType(
            JsonDataSource,
            new JArray(new[] { 1, 2, 3 }),
            IsJsonb ? "[1, 2, 3]" : "[1,2,3]",
            _pgTypeName,
            npgsqlDbType,
            // By default we map JArray to jsonb
            isDefaultForWriting: IsJsonb,
            isDefaultForReading: false,
            isNpgsqlDbTypeInferredFromClrType: false);

    [Test]
    public async Task Deserialize_failure()
    {
        await using var conn = await JsonDataSource.OpenConnectionAsync();
        await using var cmd = new NpgsqlCommand($@"SELECT '[1, 2, 3]'::{_pgTypeName}", conn);
        await using var reader = await cmd.ExecuteReaderAsync();
        await reader.ReadAsync();
        // Attempt to deserialize JSON array into object
        Assert.That(() => reader.GetFieldValue<Foo>(0), Throws.TypeOf<JsonSerializationException>());
        // State should still be OK to continue
        var actual = reader.GetFieldValue<JArray>(0);
        Assert.That((int)actual[0], Is.EqualTo(1));
    }

    [Test]
    public async Task Clr_type_mapping()
    {
        var dataSourceBuilder = CreateDataSourceBuilder();
        if (IsJsonb)
            dataSourceBuilder.UseJsonNet(jsonbClrTypes: [typeof(Foo)]);
        else
            dataSourceBuilder.UseJsonNet(jsonClrTypes: [typeof(Foo)]);
        await using var dataSource = dataSourceBuilder.Build();

        await AssertType(
            dataSource,
            new Foo { Bar = 8 },
            IsJsonb ? @"{""Bar"": 8}" : @"{""Bar"":8}",
            _pgTypeName,
            npgsqlDbType,
            isDefaultForReading: false,
            isNpgsqlDbTypeInferredFromClrType: false);
    }

    [Test]
    public async Task Roundtrip_clr_array()
    {
        var dataSourceBuilder = CreateDataSourceBuilder();
        if (IsJsonb)
            dataSourceBuilder.UseJsonNet(jsonbClrTypes: [typeof(int[])]);
        else
            dataSourceBuilder.UseJsonNet(jsonClrTypes: [typeof(int[])]);
        await using var dataSource = dataSourceBuilder.Build();

        await AssertType(
            dataSource,
            new[] { 1, 2, 3 },
            IsJsonb ? "[1, 2, 3]" : "[1,2,3]",
            _pgTypeName,
            npgsqlDbType,
            isDefaultForReading: false,
            isNpgsqlDbTypeInferredFromClrType: false);
    }

    class DateWrapper
    {
        public DateTime Date;
        public override bool Equals(object? obj) => (obj as DateWrapper)?.Date == Date;
        public override int GetHashCode() => Date.GetHashCode();
    }

    [Test]
    public async Task Custom_serializer_settings()
    {
        var settings = new JsonSerializerSettings { DateFormatString = @"T\he d\t\h o\f MMMM, yyyy" };

        var dataSourceBuilder = CreateDataSourceBuilder();
        if (IsJsonb)
            dataSourceBuilder.UseJsonNet(jsonbClrTypes: [typeof(DateWrapper)], settings: settings);
        else
            dataSourceBuilder.UseJsonNet(jsonClrTypes: [typeof(DateWrapper)], settings: settings);
        await using var dataSource = dataSourceBuilder.Build();

        await AssertType(
            dataSource,
            new DateWrapper { Date = new DateTime(2018, 04, 20) },
            IsJsonb ? "{\"Date\": \"The 20th of April, 2018\"}" : "{\"Date\":\"The 20th of April, 2018\"}",
            _pgTypeName,
            npgsqlDbType,
            isDefault: false,
            isNpgsqlDbTypeInferredFromClrType: false);
    }

    [Test]
    public async Task Bug3464()
    {
        var dataSourceBuilder = CreateDataSourceBuilder();
        dataSourceBuilder.UseJsonNet(jsonbClrTypes: [typeof(Bug3464Class)]);
        await using var dataSource = dataSourceBuilder.Build();

        var expected = new Bug3464Class { SomeString = new string('5', 8174) };
        await using var conn = await dataSource.OpenConnectionAsync();
        await using var cmd = new NpgsqlCommand(@"SELECT @p1, @p2", conn);

        cmd.Parameters.AddWithValue("p1", expected).NpgsqlDbType = npgsqlDbType;
        cmd.Parameters.AddWithValue("p2", expected).NpgsqlDbType = npgsqlDbType;

        await using var reader = cmd.ExecuteReader();
    }

    public class Bug3464Class
    {
        public string? SomeString { get; set; }
    }

    [Test, IssueLink("https://github.com/npgsql/npgsql/issues/5475")]
    public async Task Read_jarray_from_get_value()
    {
        await using var conn = await JsonDataSource.OpenConnectionAsync();

        await using var cmd = new NpgsqlCommand { Connection = conn };

        var json = new JArray(new JObject { { "name", "value1" } });

        cmd.CommandText = $"SELECT @p";
        cmd.Parameters.Add(new("p", json));
        await cmd.ExecuteScalarAsync();
    }
    [Test]
    public async Task Write_jobject_without_npgsqldbtype()
    {
        await using var conn = await JsonDataSource.OpenConnectionAsync();
        var tableName = await TestUtil.CreateTempTable(conn, "key SERIAL PRIMARY KEY, ingredients json");

        await using var cmd = new NpgsqlCommand { Connection = conn };

        var jsonObject = new JObject
        {
            { "name", "value1" },
            { "amount", 1 },
            { "unit", "ml" }
        };

        cmd.CommandText = $"INSERT INTO {tableName} (ingredients) VALUES (@p)";
        cmd.Parameters.Add(new("p", jsonObject));
        await cmd.ExecuteNonQueryAsync();
    }

    [Test, IssueLink("https://github.com/npgsql/npgsql/issues/4537")]
    public async Task Write_jobject_array_without_npgsqldbtype()
    {
        await using var conn = await JsonDataSource.OpenConnectionAsync();
        var tableName = await TestUtil.CreateTempTable(conn, "key SERIAL PRIMARY KEY, ingredients json[]");

        await using var cmd = new NpgsqlCommand { Connection = conn };

        var jsonObject1 = new JObject
        {
            { "name", "value1" },
            { "amount", 1 },
            { "unit", "ml" }
        };

        var jsonObject2 = new JObject
        {
            { "name", "value2" },
            { "amount", 2 },
            { "unit", "g" }
        };

        cmd.CommandText = $"INSERT INTO {tableName} (ingredients) VALUES (@p)";
        cmd.Parameters.Add(new("p", new[] { jsonObject1, jsonObject2 }));
        await cmd.ExecuteNonQueryAsync();
    }

    class Foo
    {
        public int Bar { get; set; }
        public override bool Equals(object? obj) => (obj as Foo)?.Bar == Bar;
        public override int GetHashCode() => Bar.GetHashCode();
    }

    readonly string _pgTypeName = npgsqlDbType.ToString().ToLower();

    [OneTimeSetUp]
    public void SetUp()
    {
        var dataSourceBuilder = CreateDataSourceBuilder();
        dataSourceBuilder.UseJsonNet();
        JsonDataSource = dataSourceBuilder.Build();
    }

    [OneTimeTearDown]
    public async Task Teardown()
        => await JsonDataSource.DisposeAsync();

    bool IsJsonb => npgsqlDbType == NpgsqlDbType.Jsonb;

    NpgsqlDataSource JsonDataSource = default!;
}