protobufjs 8.2.0 → 8.2.1

package/ext/descriptor/index.d.ts

@@ -1 +1,2 @@
-export * from "../descriptor";
+import * as $protobuf from "../..";
+import Long = require("long");

package/ext/descriptor.js

@@ -221,9 +221,14 @@ var unnamedMessageIndex = 0;
  * @param {IDescriptorProto|Reader|Uint8Array} descriptor Descriptor
  * @param {string} [edition="proto2"] The syntax or edition to use
  * @param {boolean} [nested=false] Whether or not this is a nested object
+ * @param {number} [depth] Current nesting depth, defaults to `0`
  * @returns {Type} Type instance
  */
-Type.fromDescriptor = function fromDescriptor(descriptor, edition, nested) {
+Type.fromDescriptor = function fromDescriptor(descriptor, edition, nested, depth) {
+    if (depth === undefined)
+        depth = 0;
+    if (depth > $protobuf.util.nestingLimit)
+        throw Error("max depth exceeded");
     descriptor = decodeDescriptor(descriptor, exports.DescriptorProto);
 
     var type = new Type(descriptor.name.length ? descriptor.name : "Type" + unnamedMessageIndex++, fromDescriptorOptions(descriptor.options, exports.MessageOptions)),
@@ -255,7 +260,7 @@ Type.fromDescriptor = function fromDescriptor(descriptor, edition, nested) {
         for (i = 0; i < descriptor.nestedType.length; ++i) {
             if (descriptor.nestedType[i].options && descriptor.nestedType[i].options.mapEntry)
                 continue;
-            type.add(Type.fromDescriptor(descriptor.nestedType[i], edition, true));
+            type.add(Type.fromDescriptor(descriptor.nestedType[i], edition, true, depth + 1));
         }
     /* Nested enums */ if (descriptor.enumType)
         for (i = 0; i < descriptor.enumType.length; ++i)

package/ext/textformat.d.ts

@@ -5,17 +5,11 @@ export interface ITextFormatOptions {
     unknowns?: boolean;
 }
 
-/** Maximum recursion depth for text format parsing and formatting. Defaults to util.recursionLimit. */
-export let recursionLimit: number;
-
 /** Maximum recursion depth for formatting length-delimited unknown fields. */
 export let unknownRecursionLimit: number;
 
 declare module ".." {
     namespace textformat {
-        /** Maximum recursion depth for text format parsing and formatting. Defaults to util.recursionLimit. */
-        let recursionLimit: number;
-
         /** Maximum recursion depth for formatting length-delimited unknown fields. */
         let unknownRecursionLimit: number;
     }

package/ext/textformat.js

@@ -10,21 +10,6 @@ var Type    = protobuf.Type,
 
 var textformat = protobuf.textformat = module.exports = {};
 
-var recursionLimit;
-
-/**
- * Maximum recursion depth for text format parsing and formatting. Defaults to util.recursionLimit.
- * @type {number}
- */
-Object.defineProperty(textformat, "recursionLimit", {
-    get: function get() {
-        return recursionLimit === undefined ? util.recursionLimit : recursionLimit;
-    },
-    set: function set(value) {
-        recursionLimit = value == null ? undefined : value;
-    }
-});
-
 /**
  * Maximum recursion depth for formatting length-delimited unknown fields.
  * @type {number}
@@ -88,7 +73,7 @@ function formatText(type, message, options) {
         throw TypeError("type must be a Type");
     type.root.resolveAll();
     var lines = [];
-    writeMessage(type, message, lines, 0, options || {}, 0, textformat.recursionLimit);
+    writeMessage(type, message, lines, 0, options || {}, 0);
     return lines.join("\n");
 }
 
@@ -318,7 +303,6 @@ Tokenizer.prototype.readCodePoint = function readCodePoint(size) {
 
 function Parser(source) {
     this.tn = new Tokenizer(source);
-    this.recursionLimit = textformat.recursionLimit;
 }
 
 Parser.prototype.error = function error(message) {
@@ -331,13 +315,9 @@ Parser.prototype.expectEnd = function expectEnd() {
         this.error("unexpected token '" + token.value + "'");
 };
 
-Parser.prototype.checkRecursion = function checkRecursion(depth) {
-    if (depth > this.recursionLimit)
-        this.error("max depth exceeded");
-};
-
 Parser.prototype.parseMessage = function parseMessage(type, end, depth) {
-    this.checkRecursion(depth);
+    if (depth > util.recursionLimit)
+        this.error("max depth exceeded");
     var object = {},
         seen = {};
     for (;;) {
@@ -473,7 +453,8 @@ Parser.prototype.parseMessageFieldDelimiter = function parseMessageFieldDelimite
 };
 
 Parser.prototype.parseMapEntry = function parseMapEntry(field, depth) {
-    this.checkRecursion(depth);
+    if (depth > util.recursionLimit)
+        this.error("max depth exceeded");
     var end;
     if (this.tn.skip("{"))
         end = "}";
@@ -617,7 +598,7 @@ Parser.prototype.skipBalanced = function skipBalanced(open, close, depth) {
         if (!token)
             this.error("expected '" + close + "'");
         if (token.value === open) {
-            if (depth + ++balance > this.recursionLimit)
+            if (depth + ++balance > util.recursionLimit)
                 this.error("max depth exceeded");
         }
         else if (token.value === close)
@@ -855,13 +836,9 @@ function parseIntegerBigInt(digits, radix, sign, unsigned, bits) {
     return Number(value);
 }
 
-function checkRecursion(depth, recursionLimit) {
-    if (depth > recursionLimit)
+function writeMessage(type, message, lines, indent, options, depth) {
+    if (depth > util.recursionLimit)
         throw Error("max depth exceeded");
-}
-
-function writeMessage(type, message, lines, indent, options, depth, recursionLimit) {
-    checkRecursion(depth, recursionLimit);
     var fields = type.fieldsArray.slice().sort(util.compareFieldsById);
     for (var i = 0; i < fields.length; ++i) {
         var field = fields[i].resolve(),
@@ -869,25 +846,26 @@ function writeMessage(type, message, lines, indent, options, depth, recursionLim
         if (value == null || !Object.prototype.hasOwnProperty.call(message, field.name))
             continue;
         if (field.map)
-            writeMapField(field, value, lines, indent, options, depth, recursionLimit);
+            writeMapField(field, value, lines, indent, options, depth);
         else if (field.repeated)
             for (var j = 0; j < value.length; ++j)
-                writeField(field, value[j], lines, indent, options, depth, recursionLimit);
+                writeField(field, value[j], lines, indent, options, depth);
         else
-            writeField(field, value, lines, indent, options, depth, recursionLimit);
+            writeField(field, value, lines, indent, options, depth);
     }
     if (options.unknowns && message.$unknowns != null && Object.prototype.hasOwnProperty.call(message, "$unknowns"))
         writeUnknowns(message.$unknowns, lines, indent);
 }
 
-function writeMapField(field, map, lines, indent, options, depth, recursionLimit) {
+function writeMapField(field, map, lines, indent, options, depth) {
     var keys = Object.keys(map).sort(),
         keyField = mapKeyField(field),
         valueField = mapValueField(field),
         name = formatFieldName(field),
         sp = spaces(indent);
     for (var i = 0; i < keys.length; ++i) {
-        checkRecursion(depth + 1, recursionLimit);
+        if (depth + 1 > util.recursionLimit)
+            throw Error("max depth exceeded");
         var key = keyField.long ? util.longFromKey(keys[i], keyField.type === "uint64" || keyField.type === "fixed64") : keys[i];
         if (keyField.type === "bool")
             key = util.boolFromKey(keys[i]);
@@ -895,7 +873,7 @@ function writeMapField(field, map, lines, indent, options, depth, recursionLimit
         lines.push(spaces(indent + 2) + "key: " + formatScalar(keyField, key));
         if (valueField.resolvedType instanceof Type) {
             lines.push(spaces(indent + 2) + "value {");
-            writeMessage(valueField.resolvedType, map[keys[i]], lines, indent + 4, options, depth + 2, recursionLimit);
+            writeMessage(valueField.resolvedType, map[keys[i]], lines, indent + 4, options, depth + 2);
             lines.push(spaces(indent + 2) + "}");
         } else
             lines.push(spaces(indent + 2) + "value: " + formatScalar(valueField, map[keys[i]]));
@@ -903,12 +881,12 @@ function writeMapField(field, map, lines, indent, options, depth, recursionLimit
     }
 }
 
-function writeField(field, value, lines, indent, options, depth, recursionLimit) {
+function writeField(field, value, lines, indent, options, depth) {
     var name = formatFieldName(field),
         sp = spaces(indent);
     if (field.resolvedType instanceof Type) {
         lines.push(sp + name + " {");
-        writeMessage(field.resolvedType, value, lines, indent + 2, options, depth + 1, recursionLimit);
+        writeMessage(field.resolvedType, value, lines, indent + 2, options, depth + 1);
         lines.push(sp + "}");
     } else
         lines.push(sp + name + ": " + formatScalar(field, value));

package/index.d.ts

@@ -2436,6 +2436,9 @@ export namespace util {
      */
     function merge(dst: { [k: string]: any }, src: { [k: string]: any }, ifNotSet?: boolean): { [k: string]: any };
 
+    /** Schema declaration nesting limit. */
+    let nestingLimit: number;
+
     /** Recursion limit. */
     let recursionLimit: number;
 
@@ -2574,14 +2577,6 @@ export namespace util {
     /** Node's fs module if available. */
     let fs: { [k: string]: any };
 
-    /**
-     * Checks a recursion depth.
-     * @param depth Depth of recursion
-     * @returns Depth of recursion
-     * @throws {Error} If depth exceeds util.recursionLimit
-     */
-    function checkDepth(depth: (number|undefined)): number;
-
     /**
      * Converts an object's values to an array.
      * @param object Object to convert

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "protobufjs",
-  "version": "8.2.0",
+  "version": "8.2.1",
   "versionScheme": "~",
   "description": "Protocol Buffers for JavaScript & TypeScript.",
   "author": "Daniel Wirtz <dcode+protobufjs@dcode.io>",
@@ -51,11 +51,9 @@
   },
   "devDependencies": {
     "@eslint/js": "^10.0.0",
-    "benchmark": "^2.1.4",
     "browserify": "^17.0.0",
     "browserify-wrap": "^1.0.2",
     "bundle-collapser": "^1.3.0",
-    "chalk": "^4.0.0",
     "escodegen": "^1.13.0",
     "eslint": "^10.0.0",
     "eslint-plugin-jsdoc": "^62.9.0",
@@ -63,7 +61,6 @@
     "estraverse": "^5.1.0",
     "gh-pages": "^6.0.0",
     "globals": "^17.0.0",
-    "google-protobuf": "^4.0.0",
     "gulp": "^5.0.0",
     "gulp-header": "^2.0.9",
     "gulp-if": "^3.0.0",

package/src/converter.js

@@ -107,15 +107,15 @@ converter.fromObject = function fromObject(mtype) {
     /* eslint-disable no-unexpected-multiline, block-scoped-var, no-redeclare */
     var fields = mtype.fieldsArray;
     var gen = util.codegen(["d", "q"], mtype.name + "$fromObject")
-    ("if(d instanceof this.ctor)")
+    ("if(d instanceof C)")
         ("return d")
     ("if(q===undefined)q=0")
     ("if(q>util.recursionLimit)")
         ("throw Error(\"max depth exceeded\")");
     if (!fields.length) return gen
-    ("return new this.ctor");
+    ("return new C");
     gen
-    ("var m=new this.ctor");
+    ("var m=new C");
     for (var i = 0; i < fields.length; ++i) {
         var field  = fields[i].resolve(),
             prop   = util.safeProp(field.name),

package/src/decoder.js

@@ -32,7 +32,7 @@ function decoder(mtype) {
     ("if(q===undefined)q=0")
     ("if(q>Reader.recursionLimit)")
         ("throw Error(\"max depth exceeded\")")
-    ("var c=l===undefined?r.len:r.pos+l,m=g||new this.ctor" + (hasMapField ? ",k,v" : hasImplicitPresenceField ? ",v" : ""))
+    ("var c=l===undefined?r.len:r.pos+l,m=g||new C" + (hasMapField ? ",k,v" : hasImplicitPresenceField ? ",v" : ""))
     ("while(r.pos<c){")
         ("var s=r.pos")
         ("var t=r.tag()")
@@ -156,7 +156,11 @@ function decoder(mtype) {
             ("case %i:{", field.id)
                 ("if(u!==%i)", types.basic[type])
                     ("break");
-            if (type === "string" || type === "bytes") gen
+            if (field.resolvedType instanceof Enum && field.typeDefault !== 0) gen
+                // TODO: Protoc rejects open enums whose first value is not zero.
+                // We should do the same, but for v8 this would be a regression.
+                ("if((v=r.%s())!==%j)", type, field.typeDefault);
+            else if (type === "string" || type === "bytes") gen
                 ("if((v=r.%s()).length)", type);
             else if (types.long[type] !== undefined) gen
                 ("if(typeof(v=r.%s())===\"object\"?v.low||v.high:v!==0)", type);

package/src/namespace.js

@@ -34,7 +34,10 @@ var Type,    // cyclic
  * @throws {TypeError} If arguments are invalid
  */
 Namespace.fromJSON = function fromJSON(name, json, depth) {
-    depth = util.checkDepth(depth);
+    if (depth === undefined)
+        depth = 0;
+    if (depth > util.recursionLimit)
+        throw Error("max depth exceeded");
     return new Namespace(name, json.options).addJSON(json.nested, depth);
 };
 
@@ -197,7 +200,10 @@ Namespace.prototype.toJSON = function toJSON(toJSONOptions) {
  * @returns {Namespace} `this`
  */
 Namespace.prototype.addJSON = function addJSON(nestedJson, depth) {
-    depth = util.checkDepth(depth);
+    if (depth === undefined)
+        depth = 0;
+    if (depth > util.recursionLimit)
+        throw Error("max depth exceeded");
     var ns = this;
     /* istanbul ignore else */
     if (nestedJson) {
@@ -337,6 +343,8 @@ Namespace.prototype.define = function define(path, json) {
         throw TypeError("illegal path");
     if (path && path.length && path[0] === "")
         throw Error("path must be relative");
+    if (path.length > util.recursionLimit)
+        throw Error("max depth exceeded");
 
     var ptr = this;
     while (path.length > 0) {

package/src/parse.js

@@ -312,7 +312,9 @@ function parse(source, root, options) {
 
 
     function parseCommon(parent, token, depth) {
-        depth = util.checkDepth(depth);
+        if (depth === undefined)
+            depth = 0;
+        // depth is checked by dispatched functions
         switch (token) {
 
             case "option":
@@ -378,7 +380,10 @@ function parse(source, root, options) {
     }
 
     function parseType(parent, token, depth) {
-        depth = util.checkDepth(depth);
+        if (depth === undefined)
+            depth = 0;
+        if (depth > util.nestingLimit)
+            throw Error("max depth exceeded");
 
         /* istanbul ignore if */
         if (!nameRe.test(token = next()))
@@ -507,7 +512,10 @@ function parse(source, root, options) {
     }
 
     function parseGroup(parent, rule, extend, depth) {
-        depth = util.checkDepth(depth);
+        if (depth === undefined)
+            depth = 0;
+        if (depth > util.nestingLimit)
+            throw Error("max depth exceeded");
         if (edition >= 2023) {
             throw illegal("group");
         }
@@ -754,7 +762,10 @@ function parse(source, root, options) {
     }
 
     function parseOptionValue(parent, name, depth) {
-        depth = util.checkDepth(depth);
+        if (depth === undefined)
+            depth = 0;
+        if (depth > util.recursionLimit)
+            throw Error("max depth exceeded");
         // { a: "foo" b { c: "bar" } }
         if (skip("{", true)) {
             var objectResult = {};
@@ -845,7 +856,10 @@ function parse(source, root, options) {
     }
 
     function parseService(parent, token, depth) {
-        depth = util.checkDepth(depth);
+        if (depth === undefined)
+            depth = 0;
+        if (depth > util.recursionLimit)
+            throw Error("max depth exceeded");
 
         /* istanbul ignore if */
         if (!nameRe.test(token = next()))

package/src/root.js

@@ -59,7 +59,10 @@ function Root(options) {
  * @returns {Root} Root namespace
  */
 Root.fromJSON = function fromJSON(json, root, depth) {
-    depth = util.checkDepth(depth);
+    if (depth === undefined)
+        depth = 0;
+    if (depth > util.recursionLimit)
+        throw Error("max depth exceeded");
     if (!root)
         root = new Root();
     if (json.options)

package/src/service.js

@@ -53,7 +53,10 @@ function Service(name, options) {
  * @throws {TypeError} If arguments are invalid
  */
 Service.fromJSON = function fromJSON(name, json, depth) {
-    depth = util.checkDepth(depth);
+    if (depth === undefined)
+        depth = 0;
+    if (depth > util.recursionLimit)
+        throw Error("max depth exceeded");
     var service = new Service(name, json.options);
     /* istanbul ignore else */
     if (json.methods)

package/src/type.js

@@ -171,6 +171,8 @@ Object.defineProperties(Type.prototype, {
             util.merge(ctor, Message, true);
 
             this._ctor = ctor;
+            delete this.decode;
+            delete this.fromObject;
 
             // Messages have non-enumerable default values on their prototype
             var i = 0;
@@ -239,7 +241,10 @@ function clearCache(type) {
  * @returns {Type} Created message type
  */
 Type.fromJSON = function fromJSON(name, json, depth) {
-    depth = util.checkDepth(depth);
+    if (depth === undefined)
+        depth = 0;
+    if (depth > util.nestingLimit)
+        throw Error("max depth exceeded");
     var type = new Type(name, json.options);
     type.extensions = json.extensions;
     type.reserved = json.reserved;
@@ -479,7 +484,8 @@ Type.prototype.setup = function setup() {
     this.decode = decoder(this)({
         Reader : Reader,
         types  : types,
-        util   : util
+        util   : util,
+        C      : this.ctor
     });
     this.verify = verifier(this)({
         types : types,
@@ -487,7 +493,8 @@ Type.prototype.setup = function setup() {
     });
     this.fromObject = converter.fromObject(this)({
         types : types,
-        util  : util
+        util  : util,
+        C     : this.ctor
     });
     this.toObject = converter.toObject(this)({
         types : types,

package/src/util/minimal.js

@@ -273,12 +273,19 @@ function merge(dst, src, ifNotSet) { // used by converters
 
 util.merge = merge;
 
+/**
+ * Schema declaration nesting limit.
+ * @memberof util
+ * @type {number}
+ */
+util.nestingLimit = 32; // protoc: MaxMessageDeclarationNestingDepth
+
 /**
  * Recursion limit.
  * @memberof util
  * @type {number}
  */
-util.recursionLimit = 100;
+util.recursionLimit = 100; // protoc: CodedInputStream::default_recursion_limit_
 
 /**
  * Makes a property safe for assignment as an own property.

package/src/util/utf8.js

@@ -31,19 +31,7 @@ utf8.length = function utf8_length(string) {
     return len;
 };
 
-/**
- * Reads UTF8 bytes as a string.
- * @param {Uint8Array} buffer Source buffer
- * @param {number} start Source start
- * @param {number} end Source end
- * @returns {string} String read
- */
-utf8.read = function utf8_read(buffer, start, end) {
-    if (end - start < 1) {
-        return "";
-    }
-
-    var str = "";
+function utf8_read_js(buffer, start, end, str) {
     for (var i = start; i < end;) {
         var t = buffer[i++];
         if (t <= 0x7F) {
@@ -65,6 +53,44 @@ utf8.read = function utf8_read(buffer, start, end) {
             }
         }
     }
+    return str;
+}
+
+/**
+ * Reads UTF8 bytes as a string.
+ * @param {Uint8Array} buffer Source buffer
+ * @param {number} start Source start
+ * @param {number} end Source end
+ * @returns {string} String read
+ */
+utf8.read = function utf8_read_ascii(buffer, start, end) {
+    if (end - start < 1)
+        return "";
+
+    var str = "",
+        i = start,
+        c1, c2, c3, c4, c5, c6, c7, c8;
+
+    for (; i + 7 < end; i += 8) {
+        c1 = buffer[i];
+        c2 = buffer[i + 1];
+        c3 = buffer[i + 2];
+        c4 = buffer[i + 3];
+        c5 = buffer[i + 4];
+        c6 = buffer[i + 5];
+        c7 = buffer[i + 6];
+        c8 = buffer[i + 7];
+        if ((c1 | c2 | c3 | c4 | c5 | c6 | c7 | c8) & 0x80)
+            return utf8_read_js(buffer, i, end, str);
+        str += String.fromCharCode(c1, c2, c3, c4, c5, c6, c7, c8);
+    }
+
+    for (; i < end; ++i) {
+        c1 = buffer[i];
+        if (c1 & 0x80)
+            return utf8_read_js(buffer, i, end, str);
+        str += String.fromCharCode(c1);
+    }
 
     return str;
 };

package/src/util.js

@@ -25,20 +25,6 @@ var reservedRe = util.patterns.reservedRe,
  */
 util.fs = require("./util/fs");
 
-/**
- * Checks a recursion depth.
- * @param {number|undefined} depth Depth of recursion
- * @returns {number} Depth of recursion
- * @throws {Error} If depth exceeds util.recursionLimit
- */
-util.checkDepth = function checkDepth(depth) {
-    if (depth === undefined)
-        depth = 0;
-    if (depth > util.recursionLimit)
-        throw Error("max depth exceeded");
-    return depth;
-};
-
 /**
  * Converts an object's values to an array.
  * @param {Object.<string,*>} object Object to convert
@@ -215,6 +201,8 @@ util.setProperty = function setProperty(dst, path, value, ifNotSet) {
         throw TypeError("path must be specified");
 
     path = path.split(".");
+    if (path.length > util.recursionLimit)
+        throw Error("max depth exceeded");
     return setProp(dst, path, value);
 };
 

package/src/writer.js

@@ -173,6 +173,11 @@ function writeByte(val, buf, pos) {
     buf[pos] = val & 255;
 }
 
+function writeStringAscii(val, buf, pos) {
+    for (var i = 0; i < val.length;)
+        buf[pos++] = val.charCodeAt(i++);
+}
+
 function writeVarint32(val, buf, pos) {
     while (val > 127) {
         buf[pos++] = val & 127 | 128;
@@ -401,7 +406,7 @@ Writer.prototype.raw = function write_raw(value) {
 Writer.prototype.string = function write_string(value) {
     var len = utf8.length(value);
     return len
-        ? this.uint32(len)._push(utf8.write, len, value)
+        ? this.uint32(len)._push(len === value.length ? writeStringAscii : utf8.write, len, value)
         : this._push(writeByte, 1, 0);
 };
 

package/src/writer_buffer.js

@@ -66,6 +66,11 @@ BufferWriter.prototype.raw = function write_raw_buffer(value) {
     return len ? this._push(BufferWriter.writeBytesBuffer, len, value) : this;
 };
 
+function writeStringBufferAscii(val, buf, pos) {
+    for (var i = 0; i < val.length;)
+        buf[pos++] = val.charCodeAt(i++);
+}
+
 function writeStringBuffer(val, buf, pos) {
     if (val.length < 40) // plain js is faster for short strings (probably due to redundant assertions)
         util.utf8.write(val, buf, pos);
@@ -82,7 +87,7 @@ BufferWriter.prototype.string = function write_string_buffer(value) {
     var len = util.Buffer.byteLength(value);
     this.uint32(len);
     if (len)
-        this._push(writeStringBuffer, len, value);
+        this._push(len === value.length && len < 40 ? writeStringBufferAscii : writeStringBuffer, len, value);
     return this;
 };