com.spotify.scio.jdbc.sharded.ShardString.scala Maven / Gradle / Ivy
The newest version!
/*
* Copyright 2020 Spotify AB.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package com.spotify.scio.jdbc.sharded
import java.nio.charset.StandardCharsets
import org.apache.commons.codec.binary.Base64
sealed trait ShardString extends Serializable {
val value: String
override def toString: String = value
}
object ShardString {
sealed trait HexString extends ShardString
final case class HexUpperString(value: String) extends HexString
final case class HexLowerString(value: String) extends HexString
sealed trait UuidString extends HexString
final case class UuidLowerString(value: String) extends UuidString
final case class UuidUpperString(value: String) extends UuidString
sealed trait SqlServerUuidString extends HexString
final case class SqlServerUuidUpperString(value: String) extends SqlServerUuidString
final case class SqlServerUuidLowerString(value: String) extends SqlServerUuidString
final case class Base64String(value: String) extends ShardString
}
trait RangeShardStringCodec[T <: ShardString] extends Serializable {
def encode(bigInt: BigInt): T
def decode(str: T): BigInt
def lift(str: String): T
}
object RangeShardStringCodec {
import ShardString._
private def hexShardRangeStringCodec[S <: HexString](
hexStringBuilder: String => S
): RangeShardStringCodec[S] =
new RangeShardStringCodec[S] {
def encode(bigInt: BigInt): S = lift(bigInt.toString(16))
def decode(str: S): BigInt = BigInt(str.value, 16)
def lift(str: String): S = hexStringBuilder(str)
}
implicit val hexUpperShardRangeStringCodec: RangeShardStringCodec[HexUpperString] =
hexShardRangeStringCodec(str => HexUpperString(str.toUpperCase))
implicit val hexLowerShardRangeStringCodec: RangeShardStringCodec[HexLowerString] =
hexShardRangeStringCodec(str => HexLowerString(str.toLowerCase))
private def hexToUuid(hex: String): String = Seq(
hex.substring(0, 8),
hex.substring(8, 12),
hex.substring(12, 16),
hex.substring(16, 20),
hex.substring(20, 32)
).mkString("-")
private def uuidToHex(uuid: String): String = uuid.replaceAll("-", "")
def uuidShardRangeStringCodec[S <: UuidString](
uuidStringBuilder: String => S
): RangeShardStringCodec[S] =
new RangeShardStringCodec[S] {
def encode(bigInt: BigInt): S = lift(hexToUuid(f"$bigInt%032x"))
def decode(str: S): BigInt = BigInt(uuidToHex(str.value), 16)
def lift(str: String): S = uuidStringBuilder(str)
}
implicit val uuidLowerShardRangeStringCodec: RangeShardStringCodec[UuidLowerString] =
uuidShardRangeStringCodec(str => UuidLowerString(str.toLowerCase))
implicit val uuidUpperShardRangeStringCodec: RangeShardStringCodec[UuidUpperString] =
uuidShardRangeStringCodec(str => UuidUpperString(str.toUpperCase))
// SQL Server guid uses own ordering
// see https://learn.microsoft.com/en-us/sql/connect/ado-net/sql/compare-guid-uniqueidentifier-values?view=sql-server-ver16
// more details in https://stackoverflow.com/questions/7810602/sql-server-guid-sort-algorithm-why
def sqlServerUuidShardRangeStringCodec[S <: SqlServerUuidString](
uuidStringBuilder: String => S
): RangeShardStringCodec[S] =
new RangeShardStringCodec[S] {
def encode(bigInt: BigInt): S = {
val bytes = f"$bigInt%032x".grouped(2).toList
val encoded = bytes.slice(12, 16).reverse ++
bytes.slice(10, 12).reverse ++
bytes.slice(8, 10).reverse ++
bytes.slice(6, 8) ++
bytes.slice(0, 6)
lift(hexToUuid(encoded.mkString))
}
def decode(str: S): BigInt = {
val bytes = str.value.replace("-", "").grouped(2).toArray
val decoded = bytes.slice(10, 16) ++
bytes.slice(8, 10) ++
bytes.slice(6, 8).reverse ++
bytes.slice(4, 6).reverse ++
bytes.slice(0, 4).reverse
BigInt(decoded.mkString, 16)
}
def lift(str: String): S = uuidStringBuilder(str)
}
implicit val sqlServerUuidLowerShardRangeStringCodec
: RangeShardStringCodec[SqlServerUuidLowerString] =
sqlServerUuidShardRangeStringCodec(str => SqlServerUuidLowerString(str.toLowerCase))
implicit val sqlServerUuidUpperShardRangeStringCodec
: RangeShardStringCodec[SqlServerUuidUpperString] =
sqlServerUuidShardRangeStringCodec(str => SqlServerUuidUpperString(str.toUpperCase))
implicit val base64ShardRangeStringCodec: RangeShardStringCodec[Base64String] =
new RangeShardStringCodec[Base64String] {
def encode(bigInt: BigInt): Base64String =
lift(new String(Base64.encodeInteger(bigInt.bigInteger), StandardCharsets.UTF_8))
def decode(str: Base64String): BigInt =
Base64.decodeInteger(str.value.getBytes(StandardCharsets.UTF_8))
def lift(str: String): Base64String = Base64String(str)
}
}