From 9a79a645590fcbf09e08293d8dfd4f7a414ebd2b Mon Sep 17 00:00:00 2001 From: Asad Memon Date: Fri, 28 Jul 2023 20:47:14 +0000 Subject: [PATCH] pw_web: Remove dependency on 'crc' and 'buffer' NPM packages Change-Id: Ia1dace5389f4ec3006c567e162a14de5375d0885 Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/160830 Commit-Queue: Asad Memon Reviewed-by: Anthony DiGirolamo --- package-lock.json | 76 +--------------------------------- package.json | 2 - pw_hdlc/ts/crc32.ts | 67 ++++++++++++++++++++++++++++++ pw_hdlc/ts/encoder_test.ts | 11 +++++ pw_hdlc/ts/protocol.ts | 3 +- pw_tokenizer/ts/detokenizer.ts | 1 - 6 files changed, 81 insertions(+), 79 deletions(-) create mode 100644 pw_hdlc/ts/crc32.ts diff --git a/package-lock.json b/package-lock.json index d7950364dd..3701015204 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "pigweedjs", - "version": "0.0.9", + "version": "0.0.10", "lockfileVersion": 2, "requires": true, "packages": { "": { "name": "pigweedjs", - "version": "0.0.9", + "version": "0.0.10", "license": "Apache-2.0", "dependencies": { "@protobuf-ts/protoc": "^2.7.0", @@ -36,8 +36,6 @@ "ansi_up": "^5.1.0", "arg": "^5.0.2", "base64-js": "^1.5.1", - "buffer": "^6.0.3", - "crc": "^4.1.1", "debug": "^4.3.2", "eslint": "^7.30.0", "eslint-plugin-react": "^7.24.0", @@ -2859,29 +2857,6 @@ "node-int64": "^0.4.0" } }, - "node_modules/buffer": { - "version": "6.0.3", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "MIT", - "dependencies": { - "base64-js": "^1.3.1", - "ieee754": "^1.2.1" - } - }, "node_modules/buffer-es6": { "version": "4.9.3", "dev": true, @@ -3340,17 +3315,6 @@ "node": ">= 0.4.0" } }, - "node_modules/crc": { - "version": "4.1.1", - "dev": true, - "license": "MIT", - "engines": { - "node": ">=12" - }, - "peerDependencies": { - "buffer": ">=6.0.3" - } - }, "node_modules/create-ecdh": { "version": "4.0.4", "dev": true, @@ -5486,25 +5450,6 @@ "dev": true, "license": "MIT" }, - "node_modules/ieee754": { - "version": "1.2.1", - "dev": true, - "funding": [ - { - "type": "github", - "url": "https://github.com/sponsors/feross" - }, - { - "type": "patreon", - "url": "https://www.patreon.com/feross" - }, - { - "type": "consulting", - "url": "https://feross.org/support" - } - ], - "license": "BSD-3-Clause" - }, "node_modules/ignore": { "version": "5.1.8", "dev": true, @@ -13046,14 +12991,6 @@ "node-int64": "^0.4.0" } }, - "buffer": { - "version": "6.0.3", - "dev": true, - "requires": { - "base64-js": "^1.3.1", - "ieee754": "^1.2.1" - } - }, "buffer-es6": { "version": "4.9.3", "dev": true @@ -13368,11 +13305,6 @@ "version": "2.0.1", "dev": true }, - "crc": { - "version": "4.1.1", - "dev": true, - "requires": {} - }, "create-ecdh": { "version": "4.0.4", "dev": true, @@ -14842,10 +14774,6 @@ "version": "1.7.2", "dev": true }, - "ieee754": { - "version": "1.2.1", - "dev": true - }, "ignore": { "version": "5.1.8", "dev": true diff --git a/package.json b/package.json index 469879cc31..99cec7e39c 100644 --- a/package.json +++ b/package.json @@ -43,8 +43,6 @@ "ansi_up": "^5.1.0", "arg": "^5.0.2", "base64-js": "^1.5.1", - "buffer": "^6.0.3", - "crc": "^4.1.1", "debug": "^4.3.2", "eslint": "^7.30.0", "eslint-plugin-react": "^7.24.0", diff --git a/pw_hdlc/ts/crc32.ts b/pw_hdlc/ts/crc32.ts new file mode 100644 index 0000000000..1599c83e8b --- /dev/null +++ b/pw_hdlc/ts/crc32.ts @@ -0,0 +1,67 @@ +// Copyright 2023 The Pigweed Authors +// +// 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 +// +// https://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. + +/** Calculate CRC32 unsigned. Browser and NodeJS compatible version. */ + +// Generated by pycrc (https://github.com/tpircher/pycrc) using +// `./pycrc.py --algorithm=table-driven --model=crc-32 --generate=c` +let TABLE: Array | Int32Array = [ + 0x00000000, 0x77073096, 0xee0e612c, 0x990951ba, 0x076dc419, 0x706af48f, 0xe963a535, 0x9e6495a3, + 0x0edb8832, 0x79dcb8a4, 0xe0d5e91e, 0x97d2d988, 0x09b64c2b, 0x7eb17cbd, 0xe7b82d07, 0x90bf1d91, + 0x1db71064, 0x6ab020f2, 0xf3b97148, 0x84be41de, 0x1adad47d, 0x6ddde4eb, 0xf4d4b551, 0x83d385c7, + 0x136c9856, 0x646ba8c0, 0xfd62f97a, 0x8a65c9ec, 0x14015c4f, 0x63066cd9, 0xfa0f3d63, 0x8d080df5, + 0x3b6e20c8, 0x4c69105e, 0xd56041e4, 0xa2677172, 0x3c03e4d1, 0x4b04d447, 0xd20d85fd, 0xa50ab56b, + 0x35b5a8fa, 0x42b2986c, 0xdbbbc9d6, 0xacbcf940, 0x32d86ce3, 0x45df5c75, 0xdcd60dcf, 0xabd13d59, + 0x26d930ac, 0x51de003a, 0xc8d75180, 0xbfd06116, 0x21b4f4b5, 0x56b3c423, 0xcfba9599, 0xb8bda50f, + 0x2802b89e, 0x5f058808, 0xc60cd9b2, 0xb10be924, 0x2f6f7c87, 0x58684c11, 0xc1611dab, 0xb6662d3d, + 0x76dc4190, 0x01db7106, 0x98d220bc, 0xefd5102a, 0x71b18589, 0x06b6b51f, 0x9fbfe4a5, 0xe8b8d433, + 0x7807c9a2, 0x0f00f934, 0x9609a88e, 0xe10e9818, 0x7f6a0dbb, 0x086d3d2d, 0x91646c97, 0xe6635c01, + 0x6b6b51f4, 0x1c6c6162, 0x856530d8, 0xf262004e, 0x6c0695ed, 0x1b01a57b, 0x8208f4c1, 0xf50fc457, + 0x65b0d9c6, 0x12b7e950, 0x8bbeb8ea, 0xfcb9887c, 0x62dd1ddf, 0x15da2d49, 0x8cd37cf3, 0xfbd44c65, + 0x4db26158, 0x3ab551ce, 0xa3bc0074, 0xd4bb30e2, 0x4adfa541, 0x3dd895d7, 0xa4d1c46d, 0xd3d6f4fb, + 0x4369e96a, 0x346ed9fc, 0xad678846, 0xda60b8d0, 0x44042d73, 0x33031de5, 0xaa0a4c5f, 0xdd0d7cc9, + 0x5005713c, 0x270241aa, 0xbe0b1010, 0xc90c2086, 0x5768b525, 0x206f85b3, 0xb966d409, 0xce61e49f, + 0x5edef90e, 0x29d9c998, 0xb0d09822, 0xc7d7a8b4, 0x59b33d17, 0x2eb40d81, 0xb7bd5c3b, 0xc0ba6cad, + 0xedb88320, 0x9abfb3b6, 0x03b6e20c, 0x74b1d29a, 0xead54739, 0x9dd277af, 0x04db2615, 0x73dc1683, + 0xe3630b12, 0x94643b84, 0x0d6d6a3e, 0x7a6a5aa8, 0xe40ecf0b, 0x9309ff9d, 0x0a00ae27, 0x7d079eb1, + 0xf00f9344, 0x8708a3d2, 0x1e01f268, 0x6906c2fe, 0xf762575d, 0x806567cb, 0x196c3671, 0x6e6b06e7, + 0xfed41b76, 0x89d32be0, 0x10da7a5a, 0x67dd4acc, 0xf9b9df6f, 0x8ebeeff9, 0x17b7be43, 0x60b08ed5, + 0xd6d6a3e8, 0xa1d1937e, 0x38d8c2c4, 0x4fdff252, 0xd1bb67f1, 0xa6bc5767, 0x3fb506dd, 0x48b2364b, + 0xd80d2bda, 0xaf0a1b4c, 0x36034af6, 0x41047a60, 0xdf60efc3, 0xa867df55, 0x316e8eef, 0x4669be79, + 0xcb61b38c, 0xbc66831a, 0x256fd2a0, 0x5268e236, 0xcc0c7795, 0xbb0b4703, 0x220216b9, 0x5505262f, + 0xc5ba3bbe, 0xb2bd0b28, 0x2bb45a92, 0x5cb36a04, 0xc2d7ffa7, 0xb5d0cf31, 0x2cd99e8b, 0x5bdeae1d, + 0x9b64c2b0, 0xec63f226, 0x756aa39c, 0x026d930a, 0x9c0906a9, 0xeb0e363f, 0x72076785, 0x05005713, + 0x95bf4a82, 0xe2b87a14, 0x7bb12bae, 0x0cb61b38, 0x92d28e9b, 0xe5d5be0d, 0x7cdcefb7, 0x0bdbdf21, + 0x86d3d2d4, 0xf1d4e242, 0x68ddb3f8, 0x1fda836e, 0x81be16cd, 0xf6b9265b, 0x6fb077e1, 0x18b74777, + 0x88085ae6, 0xff0f6a70, 0x66063bca, 0x11010b5c, 0x8f659eff, 0xf862ae69, 0x616bffd3, 0x166ccf45, + 0xa00ae278, 0xd70dd2ee, 0x4e048354, 0x3903b3c2, 0xa7672661, 0xd06016f7, 0x4969474d, 0x3e6e77db, + 0xaed16a4a, 0xd9d65adc, 0x40df0b66, 0x37d83bf0, 0xa9bcae53, 0xdebb9ec5, 0x47b2cf7f, 0x30b5ffe9, + 0xbdbdf21c, 0xcabac28a, 0x53b39330, 0x24b4a3a6, 0xbad03605, 0xcdd70693, 0x54de5729, 0x23d967bf, + 0xb3667a2e, 0xc4614ab8, 0x5d681b02, 0x2a6f2b94, 0xb40bbe37, 0xc30c8ea1, 0x5a05df1b, 0x2d02ef8d, +]; + +if (typeof Int32Array !== 'undefined') { + TABLE = new Int32Array(TABLE); +} + +export function crc32(bytes: Uint8Array): number { + let crc = 0xFFFFFFFF; + for (const byte of bytes) { + const tableIndex = (crc ^ byte) & 0xFF; + const tableVal = TABLE[tableIndex]; + if (tableVal === undefined) throw new Error('tableIndex out of range 0-255'); + crc = (crc >>> 8) ^ tableVal; + } + return crc ^ 0xFFFFFFFF; +}; diff --git a/pw_hdlc/ts/encoder_test.ts b/pw_hdlc/ts/encoder_test.ts index 2780fa93e4..f05d64b18c 100644 --- a/pw_hdlc/ts/encoder_test.ts +++ b/pw_hdlc/ts/encoder_test.ts @@ -86,4 +86,15 @@ describe('Encoder', () => { ); expect(encoder.uiFrame(0x3e, data2)).toEqual(withFlags(expectedContent2)); }); + + it('Computes frameCheckSequence correctly', () => { + expect(protocol.frameCheckSequence(textEncoder.encode('\x7d\x03A\x7e\x7dBC'))) + .toEqual(new Uint8Array([195, 124, 135, 9])); + expect(protocol.frameCheckSequence(textEncoder.encode('\x7d\x5d\x03\x7d\x5d'))) + .toEqual(new Uint8Array([183, 144, 10, 115])); + expect(protocol.frameCheckSequence(textEncoder.encode('\x7d\x03\x7d'))) + .toEqual(new Uint8Array([83, 124, 241, 166])); + expect(protocol.frameCheckSequence(textEncoder.encode('hello pigweed'))) + .toEqual(new Uint8Array([34, 22, 236, 2])); + }); }); diff --git a/pw_hdlc/ts/protocol.ts b/pw_hdlc/ts/protocol.ts index ef357a0d80..bf25f8e5ec 100644 --- a/pw_hdlc/ts/protocol.ts +++ b/pw_hdlc/ts/protocol.ts @@ -13,8 +13,7 @@ // the License. /** Low-level HDLC protocol features. */ -import {Buffer} from 'buffer'; -import {crc32} from 'crc'; +import {crc32} from './crc32'; /** Special flag character for delimiting HDLC frames. */ export const FLAG = 0x7e; diff --git a/pw_tokenizer/ts/detokenizer.ts b/pw_tokenizer/ts/detokenizer.ts index fe6ea910aa..f53b696100 100644 --- a/pw_tokenizer/ts/detokenizer.ts +++ b/pw_tokenizer/ts/detokenizer.ts @@ -13,7 +13,6 @@ // the License. /** Decodes and detokenizes strings from binary or Base64 input. */ -import {Buffer} from 'buffer'; import {Frame} from 'pigweedjs/pw_hdlc'; import {TokenDatabase} from './token_database'; import {PrintfDecoder} from './printf_decoder';