Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for missed tarantool types #161

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Directory.Packages.props
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@
<PackageVersion Include="MsgPack.Light" Version="2.0.1" />
<PackageVersion Include="System.Net.NameResolution" Version="4.3.0" />
<PackageVersion Include="System.Threading.Thread" Version="4.3.0" />
<PackageVersion Include="System.Memory" Version="4.5.5" />

<!-- benchmark -->
<PackageVersion Include="BenchmarkDotNet" Version="0.10.12" />
Expand Down
8 changes: 8 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,14 @@ services:
TARANTOOL_USER_NAME: admin
TARANTOOL_USER_PASSWORD: adminPassword
TARANTOOL_SLAB_ALLOC_ARENA: 0.1

tarantool_2_11:
image: tarantool/tarantool:2.11
ports:
- "3311:3301"
environment:
TARANTOOL_USER_NAME: admin
TARANTOOL_USER_PASSWORD: adminPassword

redis:
image: redis:3.0-alpine
Expand Down
87 changes: 87 additions & 0 deletions src/progaudi.tarantool/Converters/DateTimeConverter.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,87 @@
using ProGaudi.MsgPack.Light;
using ProGaudi.Tarantool.Client.Model.Enums;
using ProGaudi.Tarantool.Client.Utils;
using System;
using System.Buffers.Binary;

namespace ProGaudi.Tarantool.Client.Converters
{
/// <summary>
/// Converter for Tarantool datetime values, implemeted as MsgPack extension.
/// See https://www.tarantool.io/ru/doc/latest/dev_guide/internals/msgpack_extensions/#the-datetime-type
/// </summary>
internal class DateTimeConverter : IMsgPackConverter<DateTime>, IMsgPackConverter<DateTimeOffset>
{
private const byte MP_DATETIME = 0x04;
private static readonly DateTime UnixEpocUtc = new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc);

public void Initialize(MsgPackContext context)
{
}

public DateTime Read(IMsgPackReader reader)
{
var dataType = reader.ReadByte();
var mpHeader = reader.ReadByte();
if (mpHeader != MP_DATETIME)
{
throw ExceptionHelper.UnexpectedMsgPackHeader(mpHeader, MP_DATETIME);
}

if (dataType == MsgPackExtDataTypes.FixExt8)
{
var seconds = BinaryPrimitives.ReadInt32LittleEndian(reader.ReadBytes(4));
var nanoSeconds = BinaryPrimitives.ReadInt16LittleEndian(reader.ReadBytes(2));
var _ = reader.ReadBytes(2);// also need to extract tzoffset; tzindex;
return UnixEpocUtc.AddSeconds(seconds).AddTicks(nanoSeconds / 100);
}
else if (dataType == MsgPackExtDataTypes.FixExt16)
{
var seconds = BinaryPrimitives.ReadInt64LittleEndian(reader.ReadBytes(8));
var nanoSeconds = BinaryPrimitives.ReadInt32LittleEndian(reader.ReadBytes(4));
var _ = reader.ReadBytes(4);// also need to extract tzoffset; tzindex;
return UnixEpocUtc.AddSeconds(seconds).AddTicks(nanoSeconds / 100);
}

throw ExceptionHelper.UnexpectedDataType(dataType, MsgPackExtDataTypes.FixExt8, MsgPackExtDataTypes.FixExt16);
}

DateTimeOffset IMsgPackConverter<DateTimeOffset>.Read(IMsgPackReader reader)
{
return Read(reader);
}

public void Write(DateTimeOffset value, IMsgPackWriter writer)
{
var timeSpan = value.ToUniversalTime().Subtract(UnixEpocUtc);
long seconds = (long)timeSpan.TotalSeconds;
timeSpan = timeSpan.Subtract(TimeSpan.FromSeconds(seconds));
int nanoSeconds = (int)(timeSpan.Ticks * 100);
int _ = 0;// also need to extract tzoffset; tzindex;

writer.Write(MsgPackExtDataTypes.FixExt16);
writer.Write(MP_DATETIME);

var byteArray = new byte[8];
var span = new Span<byte>(byteArray);
BinaryPrimitives.WriteInt64LittleEndian(span, seconds);
writer.Write(byteArray);

byteArray = new byte[4];
span = new Span<byte>(byteArray);
BinaryPrimitives.WriteInt32LittleEndian(span, nanoSeconds);
writer.Write(byteArray);

byteArray = new byte[4];
span = new Span<byte>(byteArray);
BinaryPrimitives.WriteInt32LittleEndian(span, _);
writer.Write(byteArray);

}

public void Write(DateTime value, IMsgPackWriter writer)
{
Write((DateTimeOffset)value, writer);
}
}
}
240 changes: 240 additions & 0 deletions src/progaudi.tarantool/Converters/DecimalConverter.cs
Original file line number Diff line number Diff line change
@@ -0,0 +1,240 @@
using ProGaudi.MsgPack.Light;
using ProGaudi.Tarantool.Client.Model.Enums;
using ProGaudi.Tarantool.Client.Utils;
using System;
using System.Globalization;
using System.IO;
using System.Linq;
using System.Text;

namespace ProGaudi.Tarantool.Client.Converters
{
/// <summary>
/// Converter for Tarantool decimal values, implemented as MsgPack extension.
/// Format described in https://www.tarantool.io/ru/doc/latest/dev_guide/internals/msgpack_extensions/#the-decimal-type
/// Limitation: .NET decimal max scale is 28 digits, when Tarantool decimal max scale is 38 digits
/// </summary>
public class DecimalConverter : IMsgPackConverter<decimal>
{
private static readonly byte[] SupportedFixTypes = new byte[5]
{
MsgPackExtDataTypes.FixExt1,
MsgPackExtDataTypes.FixExt2,
MsgPackExtDataTypes.FixExt4,
MsgPackExtDataTypes.FixExt8,
MsgPackExtDataTypes.FixExt16
};
private static readonly byte[] SupportedNonFixTypes = new byte[3]
{
MsgPackExtDataTypes.Ext8,
MsgPackExtDataTypes.Ext16,
MsgPackExtDataTypes.Ext32
};

private const byte MP_DECIMAL = 0x01;
private const byte DECIMAL_PLUS = 0x0C;
private const byte DECIMAL_MINUS = 0x0D;
private const byte DECIMAL_MINUS_ALT = 0x0B;

public void Initialize(MsgPackContext context)
{
}

public decimal Read(IMsgPackReader reader)
{
var dataType = reader.ReadByte();
var fixedDataType = true;
var len = 0;
switch (dataType)
{
case MsgPackExtDataTypes.Ext8:
case MsgPackExtDataTypes.Ext16:
case MsgPackExtDataTypes.Ext32:
fixedDataType = false;
break;
case MsgPackExtDataTypes.FixExt1:
len = 1;
break;
case MsgPackExtDataTypes.FixExt2:
len = 2;
break;
case MsgPackExtDataTypes.FixExt4:
len = 4;
break;
case MsgPackExtDataTypes.FixExt8:
len = 8;
break;
case MsgPackExtDataTypes.FixExt16:
len = 16;
break;
default:
throw ExceptionHelper.UnexpectedDataType(dataType, SupportedFixTypes.Union(SupportedNonFixTypes).ToArray());
}

if (!fixedDataType)
{
len = reader.ReadByte();
}

var mpHeader = reader.ReadByte();
if (mpHeader != MP_DECIMAL)
{
throw ExceptionHelper.UnexpectedMsgPackHeader(mpHeader, MP_DECIMAL);
}

var data = reader.ReadBytes((uint)len).ToArray();

// used Java impl https://github.com/tarantool/cartridge-java/blob/1ca12332b870167b86d3e38891ab74527dfc8a19/src/main/java/io/tarantool/driver/mappers/converters/value/defaults/DefaultExtensionValueToBigDecimalConverter.java

// Extract sign from the last nibble
int signum = (byte)(SecondNibbleFromByte(data[len - 1]));
if (signum == DECIMAL_MINUS || signum == DECIMAL_MINUS_ALT)
{
signum = -1;
}
else if (signum <= 0x09)
{
throw new IOException("The sign nibble has wrong value");
}
else
{
signum = 1;
}

int scale = data[0];
if (scale > 28)
{
throw new OverflowException($"Maximum .NET decimal scale is exceeded. Maximum: 28. Actual: {scale}");
}

int skipIndex = 1; //skip byte with scale

int digitsNum = (len - skipIndex) << 1;
char digit = CharFromDigit(FirstNibbleFromByte(data[len - 1]), digitsNum - 1);

char[] digits = new char[digitsNum];
int pos = 2 * (len - skipIndex) - 1;

digits[pos--] = digit;
for (int i = len - 2; i >= skipIndex; i--)
{
digits[pos--] = CharFromDigit(SecondNibbleFromByte(data[i]), pos);
digits[pos--] = CharFromDigit(FirstNibbleFromByte(data[i]), pos);
}

return CreateDecimalFromDigits(digits, scale, signum < 0);
}

public void Write(decimal value, IMsgPackWriter writer)
{
(int scale, decimal unscaledValue) = ExtractScaleFromDecimal(value);

// used Java impl https://github.com/tarantool/cartridge-java/blob/1ca12332b870167b86d3e38891ab74527dfc8a19/src/main/java/io/tarantool/driver/mappers/converters/value/defaults/DefaultExtensionValueToBigDecimalConverter.java
var unscaledValueStr = unscaledValue.ToString();
byte signum = value >= 0 ? DECIMAL_PLUS : DECIMAL_MINUS;
int digitsNum = unscaledValueStr.Length;

int len = (digitsNum >> 1) + 1;
byte[] payload = new byte[len];
payload[len - 1] = signum;
int pos = 0;
char[] digits = unscaledValueStr.Substring(pos).ToCharArray();
pos = digits.Length - 1;
for (int i = len - 1; i > 0; i--)
{
payload[i] |= (byte)(DigitFromChar(digits[pos--]) << 4);
payload[i - 1] |= (byte)DigitFromChar(digits[pos--]);
}
if (pos == 0)
{
payload[0] |= (byte)(DigitFromChar(digits[pos]) << 4);
}

writer.Write(MsgPackExtDataTypes.Ext8);
writer.Write((byte)(len + 1));
writer.Write(MP_DECIMAL);
writer.Write((byte)scale);
writer.Write(payload);
}

private static (int, decimal) ExtractScaleFromDecimal(decimal val)
{
var bits = decimal.GetBits(val);
int scale = (bits[3] >> 16) & 0x7F;
decimal unscaledValue = new Decimal(bits[0], bits[1], bits[2], false, 0);
return (scale, unscaledValue);
}

private static int UnsignedRightShift(int signed, int places)
{
unchecked
{
var unsigned = (uint)signed;
unsigned >>= places;
return (int)unsigned;
}
}

private static int FirstNibbleFromByte(byte val)
{
return UnsignedRightShift(val & 0xF0, 4);
}

private static int SecondNibbleFromByte(byte val)
{
return val & 0x0F;
}

private static char CharFromDigit(int val, int pos)
{
var digit = (char)val;
if (digit > 9)
{
throw new IOException(String.Format("Invalid digit at position %d", pos));
}
return digit;
}

private static int DigitFromChar(char val)
{
return val - '0';
}

private static decimal CreateDecimalFromDigits(char[] digits, int scale, bool isNegative)
{
int pos = 0;
while (pos < digits.Length && digits[pos] == 0)
{
pos++;
}

if (pos == digits.Length)
{
return 0;
}

StringBuilder sb = new StringBuilder();
for (; pos < digits.Length; pos++)
{
sb.Append((int)digits[pos]);
}

if (scale >= sb.Length)
{
sb.Insert(0, String.Join("", Enumerable.Range(0, scale - sb.Length + 1).Select(_ => "0")));
}

if (scale > 0)
{
sb.Insert(sb.Length - scale, ".");
}

if (isNegative)
{
sb.Insert(0, '-');
}

return Decimal.Parse(sb.ToString(), CultureInfo.InvariantCulture);
}
}
}
Loading