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

Use byte arrays to store non-unicode fate strings #291

Merged
merged 1 commit into from
Oct 9, 2024
Merged
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
13 changes: 8 additions & 5 deletions src/Serializers/StringSerializer.js
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,14 @@ const byteArraySerializer = new ByteArraySerializer()

class StringSerializer extends BaseSerializer {
serialize(value) {
const encoder = new TextEncoder()
const bytes = encoder.encode(value)
let bytesOrString = value.valueOf()

return byteArraySerializer.serialize(bytes)
if (typeof bytesOrString === 'string') {
const encoder = new TextEncoder()
bytesOrString = encoder.encode(bytesOrString)
}

return byteArraySerializer.serialize(bytesOrString)
}

deserializeStream(data) {
Expand All @@ -25,11 +29,10 @@ class StringSerializer extends BaseSerializer {
throw new FatePrefixError(prefix)
}

const decoder = new TextDecoder()
const [bytes, rest] = byteArraySerializer.deserializeStream(buffer)

return [
new FateString(decoder.decode(bytes.valueOf())),
new FateString(bytes.valueOf()),
rest
]
}
Expand Down
25 changes: 24 additions & 1 deletion src/types/FateString.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
const FateData = require('./FateData')
const {FateTypeString} = require('../FateTypes')
const { byteArray2Int } = require('../utils/int2ByteArray')

const toString = (data) => {
if (data instanceof Uint8Array) {
Expand All @@ -10,22 +11,44 @@ const toString = (data) => {
return data.toString()
}

const toBytes = (data) => {
if (typeof data === 'string') {
const encoder = new TextEncoder()
return encoder.encode(data)
}

return data
}

const isUnicodeString = (data) => {
const bytes = toBytes(toString(data))
return byteArray2Int(data) === byteArray2Int(bytes)
}

class FateString extends FateData {
constructor(value) {
super('string')

this._value = toString(value)
this._value = toBytes(value)
}

get type() {
return FateTypeString()
}

toString() {
return toString(this._value)
}

toBytes() {
return this._value
}

valueOf() {
if (isUnicodeString(this._value)) {
return this.toString()
}

return this._value
}
}
Expand Down
4 changes: 4 additions & 0 deletions src/utils/int2ByteArray.js
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,10 @@ const byteArrayToHexArray = (data) => {
}

const byteArray2Int = (data) => {
if (data.length === 0) {
return 0n
}

const hex = byteArrayToHexArray(data)

return BigInt('0x' + hex.join(''))
Expand Down
6 changes: 4 additions & 2 deletions tests/Serializers/StringSerializer.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,22 +5,24 @@ const StringSerializer = require('../../src/Serializers/StringSerializer')
const s = new StringSerializer()

test('Serialize', t => {
t.plan(3)
t.plan(4)
t.deepEqual(s.serialize(new FateString("abc")), [13,97,98,99])
t.deepEqual(s.serialize("abc"), [13,97,98,99])
t.deepEqual(
s.serialize("x".repeat(64)),
[1,0].concat(Array(64).fill(120))
)
t.deepEqual(s.serialize(new FateString(new Uint8Array([253,254,255]))), [13,253,254,255])
})

test('Deserialize', t => {
t.plan(4)
t.plan(5)
t.deepEqual(s.deserialize([13,97,98,99]), new FateString("abc"))
t.deepEqual(
s.deserialize([1,0].concat(Array(64).fill(120))),
new FateString("x".repeat(64))
)
t.deepEqual(s.deserialize([95]), new FateString(""))
t.throws(() => s.deserialize([0b00001011]), { name: 'FatePrefixError' })
t.deepEqual(s.deserialize([13,253,254,255]), new FateString(new Uint8Array([253,254,255])))
})