THRIFT-5924: UUID support for NodeTS

LANGUAGES.md

@@ -241,7 +241,7 @@ Thrift's core protocol is TBinary, supported by all languages except for JavaScr
 <!-- Since -----------------><td>0.6.0</td>
 <!-- Build Systems ---------><td><img src="/doc/images/cgrn.png" alt="Yes"/></td><td><img src="/doc/images/cred.png" alt=""/></td>
 <!-- Language Levels -------><td>10.x</td><td>10.x</td>
-<!-- Field types -----------><td><img src="/doc/images/cred.png" alt=""/></td>
+<!-- Field types -----------><td><img src="/doc/images/cgrn.png" alt="Yes"/></td>
 <!-- Low-Level Transports --><td><img src="/doc/images/cgrn.png" alt="Yes"/></td><td><img src="/doc/images/cred.png" alt=""/></td><td><img src="/doc/images/cred.png" alt=""/></td><td><img src="/doc/images/cred.png" alt=""/></td><td><img src="/doc/images/cgrn.png" alt="Yes"/></td><td><img src="/doc/images/cgrn.png" alt="Yes"/></td>
 <!-- Transport Wrappers ----><td><img src="/doc/images/cgrn.png" alt="Yes"/></td><td><img src="/doc/images/cgrn.png" alt="Yes"/></td><td><img src="/doc/images/cgrn.png" alt="Yes"/></td><td><img src="/doc/images/cred.png" alt=""/></td>
 <!-- Protocols -------------><td><img src="/doc/images/cgrn.png" alt="Yes"/></td><td><img src="/doc/images/cgrn.png" alt="Yes"/></td><td><img src="/doc/images/cgrn.png" alt="Yes"/></td><td><img src="/doc/images/cgrn.png" alt="Yes"/></td>
@@ -253,7 +253,7 @@ Thrift's core protocol is TBinary, supported by all languages except for JavaScr
 <!-- Since -----------------><td>0.12.0</td>
 <!-- Build Systems ---------><td><img src="/doc/images/cgrn.png" alt="Yes"/></td><td><img src="/doc/images/cred.png" alt=""/></td>
 <!-- Language Levels -------><td>5.7.2</td><td></td>
-<!-- Field types -----------><td><img src="/doc/images/cred.png" alt=""/></td>
+<!-- Field types -----------><td><img src="/doc/images/cgrn.png" alt="Yes"/></td>
 <!-- Low-Level Transports --><td><img src="/doc/images/cred.png" alt=""/></td><td><img src="/doc/images/cred.png" alt=""/></td><td><img src="/doc/images/cred.png" alt=""/></td><td><img src="/doc/images/cred.png" alt=""/></td><td><img src="/doc/images/cgrn.png" alt="Yes"/></td><td><img src="/doc/images/cgrn.png" alt="Yes"/></td>
 <!-- Transport Wrappers ----><td><img src="/doc/images/cred.png" alt=""/></td><td><img src="/doc/images/cred.png" alt=""/></td><td><img src="/doc/images/cred.png" alt=""/></td><td><img src="/doc/images/cred.png" alt=""/></td>
 <!-- Protocols -------------><td><img src="/doc/images/cgrn.png" alt="Yes"/></td><td><img src="/doc/images/cred.png" alt=""/></td><td><img src="/doc/images/cred.png" alt=""/></td><td><img src="/doc/images/cred.png" alt=""/></td>

build/docker/ubuntu-noble/Dockerfile

@@ -52,8 +52,8 @@ RUN curl https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - &
   /etc/apt/sources.list.d/dart_stable.list
 
 # node.js
-RUN curl -sL https://deb.nodesource.com/gpgkey/nodesource.gpg.key | apt-key add - && \
-  echo "deb https://deb.nodesource.com/node_16.x focal main" | tee /etc/apt/sources.list.d/nodesource.list
+RUN curl -sL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | apt-key add - && \
+  echo "deb https://deb.nodesource.com/node_20.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list
 
 ### install general dependencies
 RUN apt-get update -yq && \
@@ -295,8 +295,8 @@ RUN apt-get install -y --no-install-recommends \
 RUN apt-get install -y --no-install-recommends \
   `# Static Code Analysis dependencies` \
   cppcheck \
-  sloccount 
-  
+  sloccount
+
 #RUN pip install flake8
 
 # NOTE: this does not reduce the image size but adds an additional layer.

compiler/cpp/src/thrift/generate/t_js_generator.cc

@@ -519,7 +519,7 @@ void t_js_generator::init_generator() {
 string t_js_generator::js_includes() {
   if (gen_node_) {
     string result;
-    
+
     if (gen_esm_) {
       result += "import { Thrift } from 'thrift';\n";
     } else {
@@ -534,13 +534,16 @@ string t_js_generator::js_includes() {
       }
     }
     if (gen_esm_) {
-      result += "import Int64 from 'node-int64';";
+      result += "import Int64 from 'node-int64';\n";
+      result += "import { v4 as uuid } from 'uuid';";
     } else {
       result += js_const_type_ + "Int64 = require('node-int64');\n";
+      result += js_const_type_ + "uuid = require('uuid').v4;\n";
     }
     return result;
   }
   string result = "if (typeof Int64 === 'undefined' && typeof require === 'function') {\n  " + js_const_type_ + "Int64 = require('node-int64');\n}\n";
+  result += "if (typeof uuid === 'undefined' && typeof require === 'function') {\n  " + js_const_type_ + "uuid = require('uuid').v4;\n}\n";
   return result;
 }
 
@@ -553,9 +556,14 @@ string t_js_generator::ts_includes() {
         "import thrift = require('thrift');\n"
         "import Thrift = thrift.Thrift;\n"
         "import Q = thrift.Q;\n"
-        "import Int64 = require('node-int64');");
-  }
-  return string("import Int64 = require('node-int64');");
+        "import Int64 = require('node-int64');\n"
+        "import { v4 as uuid } from 'uuid';\n"
+        "type uuid = string;");
+  }
+  return string(
+    "import Int64 = require('node-int64');\n"
+    "import { v4 as uuid } from 'uuid';\n"
+    "type uuid = string;");
 }
 
 /**
@@ -742,6 +750,10 @@ string t_js_generator::render_const_value(t_type* type, t_const_value* value) {
     case t_base_type::TYPE_STRING:
       out << "'" << get_escaped_string(value) << "'";
       break;
+    case t_base_type::TYPE_UUID:
+      // The UUID should be in the correct string format already the get_escaped* might be redundant
+      out << "'" << get_escaped_string(value) << "'";
+      break;
     case t_base_type::TYPE_BOOL:
       out << (value->get_integer() > 0 ? "true" : "false");
       break;
@@ -2317,6 +2329,9 @@ void t_js_generator::generate_deserialize_field(ostream& out,
       case t_base_type::TYPE_STRING:
         out << (type->is_binary() ? "readBinary()" : "readString()");
         break;
+      case t_base_type::TYPE_UUID:
+        out << "readUuid()";
+        break;
       case t_base_type::TYPE_BOOL:
         out << "readBool()";
         break;
@@ -2503,6 +2518,9 @@ void t_js_generator::generate_serialize_field(ostream& out, t_field* tfield, str
       case t_base_type::TYPE_STRING:
         out << (type->is_binary() ? "writeBinary(" : "writeString(") << name << ")";
         break;
+      case t_base_type::TYPE_UUID:
+        out << "writeUuid(" << name << ")";
+        break;
       case t_base_type::TYPE_BOOL:
         out << "writeBool(" << name << ")";
         break;
@@ -2661,6 +2679,7 @@ string t_js_generator::declare_field(t_field* tfield, bool init, bool obj) {
       case t_base_type::TYPE_VOID:
         break;
       case t_base_type::TYPE_STRING:
+      case t_base_type::TYPE_UUID:
       case t_base_type::TYPE_BOOL:
       case t_base_type::TYPE_I8:
       case t_base_type::TYPE_I16:
@@ -2752,6 +2771,8 @@ string t_js_generator::type_to_enum(t_type* type) {
       throw std::runtime_error("NO T_VOID CONSTRUCT");
     case t_base_type::TYPE_STRING:
       return "Thrift.Type.STRING";
+    case t_base_type::TYPE_UUID:
+      return "Thrift.Type.UUID";
     case t_base_type::TYPE_BOOL:
       return "Thrift.Type.BOOL";
     case t_base_type::TYPE_I8:
@@ -2765,7 +2786,7 @@ string t_js_generator::type_to_enum(t_type* type) {
     case t_base_type::TYPE_DOUBLE:
       return "Thrift.Type.DOUBLE";
     default:
-      throw "compiler error: unhandled type";
+      throw "compiler error: unhandled js type";
     }
   } else if (type->is_enum()) {
     return "Thrift.Type.I32";
@@ -2798,6 +2819,9 @@ string t_js_generator::ts_get_type(t_type* type) {
     case t_base_type::TYPE_STRING:
       ts_type = type->is_binary() ? "Buffer" : "string";
       break;
+    case t_base_type::TYPE_UUID:
+      ts_type = "uuid";
+      break;
     case t_base_type::TYPE_BOOL:
       ts_type = "boolean";
       break;
@@ -2816,7 +2840,7 @@ string t_js_generator::ts_get_type(t_type* type) {
       ts_type = "void";
       break;
     default:
-      throw "compiler error: unhandled type";
+      throw "compiler error: unhandled js type";
     }
   } else if (type->is_enum() || type->is_struct() || type->is_xception()) {
     std::string type_name;

compiler/cpp/src/thrift/generate/t_st_generator.cc

@@ -1037,7 +1037,7 @@ string t_st_generator::type_to_enum(t_type* type) {
     case t_base_type::TYPE_DOUBLE:
       return "TType double";
     default:
-      throw "compiler error: unhandled type";
+      throw "compiler error: unhandled ts type";
     }
   } else if (type->is_enum()) {
     return "TType i32";

lib/nodejs/Makefile.am

@@ -17,11 +17,8 @@
 
 # We call npm twice to work around npm issues
 
-stubs: $(top_srcdir)/test/v0.16/ThriftTest.thrift $(top_srcdir)/test/v0.16/FuzzTestNoUuid.thrift
-	$(THRIFT) --gen js:node -o test/ $(top_srcdir)/test/v0.16/ThriftTest.thrift
-	$(THRIFT) --gen js:node -o test/fuzz/ $(top_srcdir)/test/v0.16/FuzzTestNoUuid.thrift
-	sed -i "s/require('thrift')/require(\"..\/..\/..\/lib\/thrift\")/" test/fuzz/gen-nodejs/FuzzTestNoUuid_types.js
-
+stubs: $(top_srcdir)/test/ThriftTest.thrift
+	$(THRIFT) --gen js:node -o test/ $(top_srcdir)/test/ThriftTest.thrift
 
 deps-root: $(top_srcdir)/package.json
 	$(NPM) install $(top_srcdir)/ || $(NPM) install $(top_srcdir)/

lib/nodejs/lib/thrift/binary_protocol.js

@@ -23,6 +23,8 @@ var Int64 = require("node-int64");
 var Thrift = require("./thrift");
 var Type = Thrift.Type;
 
+const { parse: uuidParse, stringify: uuidStringify } = require("uuid");
+
 module.exports = TBinaryProtocol;
 
 // JavaScript supports only numeric doubles, therefore even hex values are always signed.
@@ -170,6 +172,10 @@ TBinaryProtocol.prototype.writeBinary = function (arg) {
   this.writeStringOrBinary("writeBinary", "binary", arg);
 };
 
+TBinaryProtocol.prototype.writeUuid = function (arg) {
+  this.trans.write(Buffer.from(uuidParse(arg)));
+};
+
 TBinaryProtocol.prototype.readMessageBegin = function () {
   var sz = this.readI32();
   var type, name, seqid;
@@ -302,6 +308,11 @@ TBinaryProtocol.prototype.readString = function () {
   return this.trans.readString(len);
 };
 
+TBinaryProtocol.prototype.readUuid = function () {
+  const buf = this.trans.read(16);
+  return uuidStringify(new Uint8Array(buf));
+};
+
 TBinaryProtocol.prototype.getTransport = function () {
   return this.trans;
 };
@@ -329,6 +340,9 @@ TBinaryProtocol.prototype.skip = function (type) {
     case Type.STRING:
       this.readString();
       break;
+    case Type.UUID:
+      this.readUuid();
+      break;
     case Type.STRUCT:
       this.readStructBegin();
       while (true) {

lib/nodejs/lib/thrift/compact_protocol.js

@@ -22,6 +22,8 @@ var Int64 = require("node-int64");
 var Thrift = require("./thrift");
 var Type = Thrift.Type;
 
+const { parse: uuidParse, stringify: uuidStringify } = require("uuid");
+
 module.exports = TCompactProtocol;
 
 var POW_8 = Math.pow(2, 8);
@@ -120,6 +122,7 @@ TCompactProtocol.TYPE_SHIFT_AMOUNT = 5;
  * @property {number}  CT_SET           - A collection type (unordered and without repeated values).
  * @property {number}  CT_MAP           - A collection type (map/associative-array/dictionary).
  * @property {number}  CT_STRUCT        - A multifield type.
+ * @property {number}  CT_UUID          - A UUID type.
  */
 TCompactProtocol.Types = {
   CT_STOP: 0x00,
@@ -135,6 +138,7 @@ TCompactProtocol.Types = {
   CT_SET: 0x0a,
   CT_MAP: 0x0b,
   CT_STRUCT: 0x0c,
+  CT_UUID: 0x0d,
 };
 
 /**
@@ -158,6 +162,7 @@ TCompactProtocol.TTypeToCType = [
   TCompactProtocol.Types.CT_MAP, // T_MAP
   TCompactProtocol.Types.CT_SET, // T_SET
   TCompactProtocol.Types.CT_LIST, // T_LIST
+  TCompactProtocol.Types.CT_UUID, // T_UUID
 ];
 
 //
@@ -214,6 +219,8 @@ TCompactProtocol.prototype.getTType = function (type) {
       return Type.MAP;
     case TCompactProtocol.Types.CT_STRUCT:
       return Type.STRUCT;
+    case TCompactProtocol.Types.CT_UUID:
+      return Type.UUID;
     default:
       throw new Thrift.TProtocolException(
         Thrift.TProtocolExceptionType.INVALID_DATA,
@@ -459,6 +466,10 @@ TCompactProtocol.prototype.writeBinary = function (arg) {
   this.writeStringOrBinary("writeBinary", "binary", arg);
 };
 
+TCompactProtocol.prototype.writeUuid = function (arg) {
+  this.trans.write(Buffer.from(uuidParse(arg)));
+};
+
 //
 // Compact Protocol internal write methods
 //
@@ -735,6 +746,11 @@ TCompactProtocol.prototype.readByte = function () {
   return this.trans.readByte();
 };
 
+TCompactProtocol.prototype.readUuid = function () {
+  const buf = this.trans.read(16);
+  return uuidStringify(new Uint8Array(buf));
+};
+
 TCompactProtocol.prototype.readI16 = function () {
   return this.readI32();
 };
@@ -908,6 +924,9 @@ TCompactProtocol.prototype.skip = function (type) {
     case Type.STRING:
       this.readString();
       break;
+    case Type.UUID:
+      this.readUuid();
+      break;
     case Type.STRUCT:
       this.readStructBegin();
       while (true) {

lib/nodejs/lib/thrift/header_protocol.js

@@ -158,6 +158,10 @@ THeaderProtocol.prototype.writeBinary = function (arg) {
   return this.protocol.writeBinary(arg);
 };
 
+THeaderProtocol.prototype.writeUuid = function (arg) {
+  return this.protocol.writeUuid(arg);
+};
+
 THeaderProtocol.prototype.readMessageBegin = function () {
   this.trans.readHeaders();
   this.setProtocol();
@@ -236,6 +240,10 @@ THeaderProtocol.prototype.readBinary = function () {
   return this.protocol.readBinary();
 };
 
+THeaderProtocol.prototype.readUuid = function () {
+  return this.protocol.readUuid();
+};
+
 THeaderProtocol.prototype.readString = function () {
   return this.protocol.readString();
 };

lib/nodejs/lib/thrift/json_protocol.js

@@ -62,6 +62,7 @@ TJSONProtocol.Type[Type.STRING] = '"str"';
 TJSONProtocol.Type[Type.MAP] = '"map"';
 TJSONProtocol.Type[Type.LIST] = '"lst"';
 TJSONProtocol.Type[Type.SET] = '"set"';
+TJSONProtocol.Type[Type.UUID] = '"uid"';
 
 /**
  * Thrift IDL type string to Id mapping.
@@ -80,6 +81,7 @@ TJSONProtocol.RType.str = Type.STRING;
 TJSONProtocol.RType.map = Type.MAP;
 TJSONProtocol.RType.lst = Type.LIST;
 TJSONProtocol.RType.set = Type.SET;
+TJSONProtocol.RType.uid = Type.UUID;
 
 /**
  * The TJSONProtocol version number.
@@ -424,6 +426,11 @@ TJSONProtocol.prototype.writeBinary = function (arg) {
   this.tstack.push('"' + buf.toString("base64") + '"');
 };
 
+/** Serializes a UUID */
+TJSONProtocol.prototype.writeUuid = function (arg) {
+  this.tstack.push('"' + arg + '"');
+};
+
 /**
  * @class
  * @name AnonReadMessageBeginReturn
@@ -758,6 +765,10 @@ TJSONProtocol.prototype.readString = function () {
   return this.readValue();
 };
 
+TJSONProtocol.prototype.readUuid = function() {
+  return this.readValue();
+};
+
 /**
  * Returns the underlying transport.
  * @readonly
@@ -793,6 +804,9 @@ TJSONProtocol.prototype.skip = function (type) {
     case Type.STRING:
       this.readString();
       break;
+    case Type.UUID:
+      this.readUuid();
+      break;
     case Type.STRUCT:
       this.readStructBegin();
       while (true) {

lib/nodejs/lib/thrift/thrift.js

@@ -34,8 +34,7 @@ var Type = (exports.Type = {
   MAP: 13,
   SET: 14,
   LIST: 15,
-  UTF8: 16,
-  UTF16: 17,
+  UUID: 16,
 });
 
 exports.MessageType = {