Skip to content

Improve internals and add some features #78

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 56 commits into from
May 24, 2019
Merged

Improve internals and add some features #78

merged 56 commits into from
May 24, 2019

Conversation

thephoenixofthevoid
Copy link
Contributor

@thephoenixofthevoid thephoenixofthevoid commented Apr 26, 2019 •
edited
Loading

  1. Encoder refactoring
  2. Support encoding/decoding Maps instances [Fix integer keys / Map encoding #63 and This implementation does not strictly adhere to the spec #10 possibly]
  3. Support sorting objects keys when serialization [Fix Add an option to support predicable encoding #52]
  4. Fix encodeFloat implementation [Fix Too complicated encodeFloat function. #77]
  5. TimestampEncoding is treated as an ext-type with type === -1 (inaccessible from user API though)

thephoenixofthevoid and others added 30 commits April 23, 2019 00:55
@thephoenixofthevoid
Feature: Manually encode unsuppoted object.
a0f5f62
@thephoenixofthevoid
Refactoring: inlining hasMinBufferSize and simplifying decode(buf)
12f63ee 
Changes to be committed:
  modified:   lib/decoder.js
@thephoenixofthevoid
Used while where it actually meant to.
991cc76
@thephoenixofthevoid
In decodeMap(...) simplify counting amount of bytes consumed
287d374 
Well, provided that initialOffset is the value passed as an argument:
console.log(headerLength + totalBytesConsumed === offset - initialOffset)
// true   --- always
@thephoenixofthevoid
Imporove maintainability
f7345f0 
1. getSize now is implemented through hash not switch statement.
   More concise and appear to be much faster.

2. Created helpers.js file, and functions that logically unrelated
   to decoding/encoding will go there.

3. Where possible prefer flat code that nested branches

4. In decodeExt dramatically simplify all the things.

Changes to be committed:
	modified:   lib/decoder.js
	new file:   lib/helpers.js
@thephoenixofthevoid
Getting rid of "offset + 1" artificial expression
8a932aa 
It's caused by not incrementing offset after reaading first byte.
To handle this change I first of all introduce "initialOffset" and
change everywhere offset to "initial offset". This commit does
this part of the job.

Then I will clean 1-by-1 every affected function and branch.
@thephoenixofthevoid
Keep on getting intent more clear
a9ec4fb 
1. Remove "else" statements that go after "return"
2. Where appropriate (another 1-4 bytes have been read) offset is incremented
3. So that expressions like "initialOffset + 2" --- "... + 5" could be replaced by just "offset"

Changes to be committed:
  modified:   lib/decoder.js
@thephoenixofthevoid
Implemented all integers and all kinds of floats
11ef5e6 
1. function decodeSigned (buf, offset, size)
2. function decodeFloat (buf, offset, size)
3. function decodeExt (buf, offset, type, size, headerSize)
@thephoenixofthevoid
Added missing Ranges as TODO commends
65ce0ba 
Currently:

| RANGE      |  STATUS             | function name (if exists) or type name  |
|------------|---------------------|-----------------|
| 0x00, 0x7f |  MISSING COMPLETELY | positive fixint
| 0x80, 0x8f |  MISSING COMPLETELY | fixmap
| 0x90, 0x9f |  MISSING COMPLETELY | fixarr
| 0xa0, 0xbf |  MISSING COMPLETELY | fixstr
| 0xc0, 0xc3 |  DONE               | decodeConstants(...)
| 0xc4, 0xc6 |  OLD CODE           | decodeBuffers(...)
| 0xc7, 0xc9 |  WIP NOW            | decodeExt(...)
| 0xca, 0xcb |  DONE               | decodeFloat
| 0xcc, 0xcf |  DONE               | decodeUnsignedInt()
| 0xd0, 0xd3 |  DONE               | decodeSigned()
| 0xd4, 0xd8 |  DONE               | decodeFixExt()
| 0xd9, 0xdb |  OLD CODE           | decodeStr(...)
| 0xdc, 0xdd |  OLD CODE           | decodeArray(...)
| 0xde, 0xdf |  OLD CODE           | decodeMap(...)
| 0xe0, 0xff |  MISSING COMPLETELY | negative fixint
@thephoenixofthevoid
function decodeStr (buf, offset, size)
c5789c7
@thephoenixofthevoid
Added decodeBuffers
a511bdd
@thephoenixofthevoid
gitignore updated
db3f3e8
@thephoenixofthevoid
if (inRange(0xc7, 0xc9)) return decodeExts(buf, offset, size - 2)
3ae90f9
@thephoenixofthevoid
decodeFixExt + Moved functions outside of closure
a902377
@thephoenixofthevoid
It was just a line!
e3546c8
@thephoenixofthevoid
Update .gitignore
6319853
@thephoenixofthevoid
decodeArray
f2840b6
@thephoenixofthevoid
small arrays and
ebb90c0
@thephoenixofthevoid
decodeMaps + ordering
67d253c
@thephoenixofthevoid
fixmap fixarr fixstr
83cb8ac
@thephoenixofthevoid
Inline buf.readUIntBE(offset, size) method where getLength (buf, offs…
e3be779 
…et, size) used
@thephoenixofthevoid
function decodeTimestamp (buf, size, headerSize) moved to helper
f70ee03
@thephoenixofthevoid
Use array syntax to handle results
c2c4b18
@thephoenixofthevoid
Few changes
6f725ac
@thephoenixofthevoid
Avoid using length var at top level
76a8958
@thephoenixofthevoid
Avoid using result var at top level
8d5003a
@thephoenixofthevoid
remove dist folder from git
672e68c
@thephoenixofthevoid
Restore dist files
698c73e
@thephoenixofthevoid
Restore dist min files
c2e3c1b
@thephoenixofthevoid
Finally restore min version
2cbbaeb
This was referenced Mar 12, 2021
Open
Open
Open
Open
Open
Closed
Open
Open
Open
Open
Open
Open
Open
Open
Merged
Open
Merged
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Open
Closed
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mcollina mcollina mcollina approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Too complicated encodeFloat function. integer keys / Map encoding Add an option to support predicable encoding

3 participants

@thephoenixofthevoid @mcollina @kevygreen