Fixed packet corruption issue when enum was not 4 bytes #1421

daebo01 · 2023-12-17T11:09:24Z

Fixed an issue where packets were corrupted when enum was not 4 bytes

This appears to be because the column type and the actual size of data used in the SingleCommandPayloadCreator.WriteBinaryParameters function are different.

Code and screenshots to reproduce the issue are provided below

Please check

CREATE TABLE `test1` (
	`Id` INT NOT NULL AUTO_INCREMENT,
	`A` TINYINT NOT NULL,
	`B` INT NOT NULL,
	`C` INT NOT NULL,
	PRIMARY KEY (`Id`)
);

internal class TestLogic
{
    private readonly MySqlConnection _connection;

    public TestLogic(string connStr)
    {
        _connection = new MySqlConnection(connStr);
    }

    public async Task Run()
    {
        
        await _connection.OpenAsync();

        await InsertDummyRow();
        var list = await SelectAllRow();

        foreach (var row in list)
        {
            Console.WriteLine(row);
        }
    }

    private async Task InsertDummyRow()
    {
        using var cmd = _connection.CreateCommand();
        cmd.CommandText = @"
            INSERT INTO test1 (A, B, C) 
                   VALUES (@A, @B, @C)";

        cmd.Parameters.AddWithValue("@A", TestEnum1.X);
        cmd.Parameters.AddWithValue("@B", 0x40302010);
        cmd.Parameters.AddWithValue("@C", 0);

        await cmd.PrepareAsync();

        await cmd.ExecuteNonQueryAsync();
    }

    private async Task<List<TestTable1Model>> SelectAllRow()
    {
        using var cmd = _connection.CreateCommand();
        cmd.CommandText = @"
            SELECT Id, A, B, C
              FROM test1 LIMIT 1000";

        await cmd.PrepareAsync();

        var list = new List<TestTable1Model>();
        var reader = await cmd.ExecuteReaderAsync();

        while (await reader.ReadAsync())
        {
            var row = new TestTable1Model
            {
                Id = reader.GetInt32(0),
                A = (TestEnum1)reader.GetByte(1),
                B = reader.GetInt32(2),
                C = reader.GetInt32(3),
            };

            list.Add(row);
        }

        return list;
    }
}

internal class TestTable1Model
{
    public required int Id { get; set; }

    public required TestEnum1 A { get; set; }

    public required int B { get; set; }

    public required int C { get; set; }

    public override string ToString() => $"Id: {Id}, A: {A}, B: {B:X}, C: {C:X}";
}

internal enum TestEnum1 : sbyte
{
    None = 0,
    X = 1,
    Y = 2,
    Z = 3,
};

Signed-off-by: Alisha Kim <pril@pril.cc>

bgrainger · 2023-12-17T16:18:42Z

This appears to be because the column type and the actual size of data used in the SingleCommandPayloadCreator.WriteBinaryParameters function are different.

This is the bug. More concretely, the parameter_type value sent earlier in the COM_STMT_EXECUTE packet doesn't match the format of the data that is sent later.

This PR doesn't fix the underlying problem for the general case where the user uses an enum whose underlying type doesn't match the column definition. Thanks for bringing this to my attention; I have an idea of how this might be fixed. Edit: I thought this was a bigger issue than just enums; it's not but it can still be solved without nested type tests.

(This may also have been made worse by #1384 which caused the MySqlDbType property to be ignored.)

bgrainger · 2023-12-18T20:30:34Z

Thanks for the PR! Fixed in 2.3.2.

daebo01 · 2023-12-19T12:25:56Z

thanks for checking

daebo01 force-pushed the enum-serialize-fix-pr branch 2 times, most recently from d5f2875 to 8ce6859 Compare December 17, 2023 11:46

Fixed packet corruption issue when enum was not 4 bytes.

9352d48

Signed-off-by: Alisha Kim <pril@pril.cc>

daebo01 force-pushed the enum-serialize-fix-pr branch from 8ce6859 to 9352d48 Compare December 17, 2023 11:58

bgrainger added a commit that referenced this pull request Dec 18, 2023

Use underlying enum type when writing binary parameters. Fixes #1421

2d44a00

bgrainger merged commit bd53d6e into mysql-net:master Dec 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fixed packet corruption issue when enum was not 4 bytes #1421

Fixed packet corruption issue when enum was not 4 bytes #1421

Fixed packet corruption issue when enum was not 4 bytes #1421

Fixed packet corruption issue when enum was not 4 bytes #1421

Conversation