feat: allow message.getTypeUrl provide custom typeUrlPrefix (#1762)

* feat: allow message.getTypeUrl provide custom tyepUrlPrefix * Update static.js * test: added tests, regenerated test files Co-authored-by: Alexander Fenster <fenster@google.com>
protobufjs · Jul 7, 2022 · 8aad1dd · 8aad1dd
1 parent e2f33a0
commit 8aad1dd
Show file tree

Hide file tree

Showing 20 changed files with 561 additions and 249 deletions.
diff --git a/cli/targets/static.js b/cli/targets/static.js
@@ -597,11 +597,17 @@ function buildType(ref, type) {
             "@function getTypeUrl",
             "@memberof " + exportName(type),
             "@static",
+            "@param {string} [typeUrlPrefix] your custom typeUrlPrefix(default \"type.googleapis.com\")",
             "@returns {string} The default type url"
         ]);
-        push(escapeName(type.name) + ".getTypeUrl = function getTypeUrl() {");
+        push(escapeName(type.name) + ".getTypeUrl = function getTypeUrl(typeUrlPrefix) {");
         ++indent;
-            push("return \"type.googleapis.com/" + exportName(type) + "\";");
+            push("if (typeUrlPrefix === undefined) {");
+            ++indent;
+                push("typeUrlPrefix = \"type.googleapis.com\";");
+            --indent;
+            push("}");
+            push("return typeUrlPrefix + \"/" + exportName(type) + "\";");
         --indent;
         push("};");
     }

diff --git a/tests/cli.js b/tests/cli.js
@@ -44,11 +44,12 @@ tape.test("pbjs generates static code", function(test) {
             decode: true,
             encode: true,
             convert: true,
+            typeurl: true,
         }, function(err, jsCode) {
             test.error(err, 'static code generation worked');
 
             // jsCode is the generated code; we'll eval it
-            // (since this is what we normally does with the code, right?)
+            // (since this is what we normally do with the code, right?)
             // This is a test code. Do not use this in production.
             var $protobuf = protobuf;
             eval(jsCode);
@@ -78,6 +79,12 @@ tape.test("pbjs generates static code", function(test) {
             var instance1 = OneofContainerDynamic.toObject(OneofContainerDynamic.fromObject(instance));
             test.deepEqual(instance, instance1, "fromObject and toObject work for instance of the static type");
 
+            // Check that getTypeUrl works
+            var defaultTypeUrl = Message.getTypeUrl();
+            var customTypeUrl = Message.getTypeUrl("example.com");
+            test.equal(defaultTypeUrl, "type.googleapis.com/Message", "getTypeUrl returns expected url");
+            test.equal(customTypeUrl, "example.com/Message", "getTypeUrl returns custom url");
+
             test.end();
         });
     });

diff --git a/tests/data/comments.d.ts b/tests/data/comments.d.ts
@@ -19,7 +19,7 @@ export class Test1 implements ITest1 {
     public static fromObject(object: { [k: string]: any }): Test1;
     public static toObject(message: Test1, options?: $protobuf.IConversionOptions): { [k: string]: any };
     public toJSON(): { [k: string]: any };
-    public static getTypeUrl(): string;
+    public static getTypeUrl(typeUrlPrefix?: string): string;
 }
 
 export interface ITest2 {
@@ -36,12 +36,13 @@ export class Test2 implements ITest2 {
     public static fromObject(object: { [k: string]: any }): Test2;
     public static toObject(message: Test2, options?: $protobuf.IConversionOptions): { [k: string]: any };
     public toJSON(): { [k: string]: any };
-    public static getTypeUrl(): string;
+    public static getTypeUrl(typeUrlPrefix?: string): string;
 }
 
 export enum Test3 {
     ONE = 1,
     TWO = 2,
     THREE = 3,
-    FOUR = 4
+    FOUR = 4,
+    FIVE = 5
 }
diff --git a/tests/data/comments.js b/tests/data/comments.js
@@ -246,10 +246,14 @@ $root.Test1 = (function() {
      * @function getTypeUrl
      * @memberof Test1
      * @static
+     * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
      * @returns {string} The default type url
      */
-    Test1.getTypeUrl = function getTypeUrl() {
-        return "type.googleapis.com/Test1";
+    Test1.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+        if (typeUrlPrefix === undefined) {
+            typeUrlPrefix = "type.googleapis.com";
+        }
+        return typeUrlPrefix + "/Test1";
     };
 
     return Test1;
@@ -417,10 +421,14 @@ $root.Test2 = (function() {
      * @function getTypeUrl
      * @memberof Test2
      * @static
+     * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
      * @returns {string} The default type url
      */
-    Test2.getTypeUrl = function getTypeUrl() {
-        return "type.googleapis.com/Test2";
+    Test2.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+        if (typeUrlPrefix === undefined) {
+            typeUrlPrefix = "type.googleapis.com";
+        }
+        return typeUrlPrefix + "/Test2";
     };
 
     return Test2;
@@ -434,13 +442,15 @@ $root.Test2 = (function() {
  * @property {number} TWO=2 TWO value
  * @property {number} THREE=3 Preferred value with a comment.
  * @property {number} FOUR=4 Other value with a comment.
+ * @property {number} FIVE=5 Leading comment for value with both types of comments after field with trailing comment.
  */
 $root.Test3 = (function() {
     var valuesById = {}, values = Object.create(valuesById);
     values[valuesById[1] = "ONE"] = 1;
     values[valuesById[2] = "TWO"] = 2;
     values[valuesById[3] = "THREE"] = 3;
     values[valuesById[4] = "FOUR"] = 4;
+    values[valuesById[5] = "FIVE"] = 5;
     return values;
 })();
 

diff --git a/tests/data/convert.d.ts b/tests/data/convert.d.ts
@@ -31,7 +31,7 @@ export class Message implements IMessage {
     public static fromObject(object: { [k: string]: any }): Message;
     public static toObject(message: Message, options?: $protobuf.IConversionOptions): { [k: string]: any };
     public toJSON(): { [k: string]: any };
-    public static getTypeUrl(): string;
+    public static getTypeUrl(typeUrlPrefix?: string): string;
 }
 
 export namespace Message {

diff --git a/tests/data/convert.js b/tests/data/convert.js
@@ -567,10 +567,14 @@ $root.Message = (function() {
      * @function getTypeUrl
      * @memberof Message
      * @static
+     * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
      * @returns {string} The default type url
      */
-    Message.getTypeUrl = function getTypeUrl() {
-        return "type.googleapis.com/Message";
+    Message.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+        if (typeUrlPrefix === undefined) {
+            typeUrlPrefix = "type.googleapis.com";
+        }
+        return typeUrlPrefix + "/Message";
     };
 
     /**

diff --git a/tests/data/mapbox/vector_tile.d.ts b/tests/data/mapbox/vector_tile.d.ts
@@ -17,7 +17,7 @@ export namespace vector_tile {
         public static fromObject(object: { [k: string]: any }): vector_tile.Tile;
         public static toObject(message: vector_tile.Tile, options?: $protobuf.IConversionOptions): { [k: string]: any };
         public toJSON(): { [k: string]: any };
-        public static getTypeUrl(): string;
+        public static getTypeUrl(typeUrlPrefix?: string): string;
     }
 
     namespace Tile {
@@ -57,7 +57,7 @@ export namespace vector_tile {
             public static fromObject(object: { [k: string]: any }): vector_tile.Tile.Value;
             public static toObject(message: vector_tile.Tile.Value, options?: $protobuf.IConversionOptions): { [k: string]: any };
             public toJSON(): { [k: string]: any };
-            public static getTypeUrl(): string;
+            public static getTypeUrl(typeUrlPrefix?: string): string;
         }
 
         interface IFeature {
@@ -82,7 +82,7 @@ export namespace vector_tile {
             public static fromObject(object: { [k: string]: any }): vector_tile.Tile.Feature;
             public static toObject(message: vector_tile.Tile.Feature, options?: $protobuf.IConversionOptions): { [k: string]: any };
             public toJSON(): { [k: string]: any };
-            public static getTypeUrl(): string;
+            public static getTypeUrl(typeUrlPrefix?: string): string;
         }
 
         interface ILayer {
@@ -111,7 +111,7 @@ export namespace vector_tile {
             public static fromObject(object: { [k: string]: any }): vector_tile.Tile.Layer;
             public static toObject(message: vector_tile.Tile.Layer, options?: $protobuf.IConversionOptions): { [k: string]: any };
             public toJSON(): { [k: string]: any };
-            public static getTypeUrl(): string;
+            public static getTypeUrl(typeUrlPrefix?: string): string;
         }
     }
 }
diff --git a/tests/data/mapbox/vector_tile.js b/tests/data/mapbox/vector_tile.js
@@ -228,10 +228,14 @@ $root.vector_tile = (function() {
          * @function getTypeUrl
          * @memberof vector_tile.Tile
          * @static
+         * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
          * @returns {string} The default type url
          */
-        Tile.getTypeUrl = function getTypeUrl() {
-            return "type.googleapis.com/vector_tile.Tile";
+        Tile.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+            if (typeUrlPrefix === undefined) {
+                typeUrlPrefix = "type.googleapis.com";
+            }
+            return typeUrlPrefix + "/vector_tile.Tile";
         };
 
         /**
@@ -616,10 +620,14 @@ $root.vector_tile = (function() {
              * @function getTypeUrl
              * @memberof vector_tile.Tile.Value
              * @static
+             * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
              * @returns {string} The default type url
              */
-            Value.getTypeUrl = function getTypeUrl() {
-                return "type.googleapis.com/vector_tile.Tile.Value";
+            Value.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+                if (typeUrlPrefix === undefined) {
+                    typeUrlPrefix = "type.googleapis.com";
+                }
+                return typeUrlPrefix + "/vector_tile.Tile.Value";
             };
 
             return Value;
@@ -968,10 +976,14 @@ $root.vector_tile = (function() {
              * @function getTypeUrl
              * @memberof vector_tile.Tile.Feature
              * @static
+             * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
              * @returns {string} The default type url
              */
-            Feature.getTypeUrl = function getTypeUrl() {
-                return "type.googleapis.com/vector_tile.Tile.Feature";
+            Feature.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+                if (typeUrlPrefix === undefined) {
+                    typeUrlPrefix = "type.googleapis.com";
+                }
+                return typeUrlPrefix + "/vector_tile.Tile.Feature";
             };
 
             return Feature;
@@ -1337,10 +1349,14 @@ $root.vector_tile = (function() {
              * @function getTypeUrl
              * @memberof vector_tile.Tile.Layer
              * @static
+             * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
              * @returns {string} The default type url
              */
-            Layer.getTypeUrl = function getTypeUrl() {
-                return "type.googleapis.com/vector_tile.Tile.Layer";
+            Layer.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+                if (typeUrlPrefix === undefined) {
+                    typeUrlPrefix = "type.googleapis.com";
+                }
+                return typeUrlPrefix + "/vector_tile.Tile.Layer";
             };
 
             return Layer;

diff --git a/tests/data/package.d.ts b/tests/data/package.d.ts
@@ -47,7 +47,7 @@ export class Package implements IPackage {
     public static fromObject(object: { [k: string]: any }): Package;
     public static toObject(message: Package, options?: $protobuf.IConversionOptions): { [k: string]: any };
     public toJSON(): { [k: string]: any };
-    public static getTypeUrl(): string;
+    public static getTypeUrl(typeUrlPrefix?: string): string;
 }
 
 export namespace Package {
@@ -70,6 +70,6 @@ export namespace Package {
         public static fromObject(object: { [k: string]: any }): Package.Repository;
         public static toObject(message: Package.Repository, options?: $protobuf.IConversionOptions): { [k: string]: any };
         public toJSON(): { [k: string]: any };
-        public static getTypeUrl(): string;
+        public static getTypeUrl(typeUrlPrefix?: string): string;
     }
 }
diff --git a/tests/data/package.js b/tests/data/package.js
@@ -729,10 +729,14 @@ $root.Package = (function() {
      * @function getTypeUrl
      * @memberof Package
      * @static
+     * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
      * @returns {string} The default type url
      */
-    Package.getTypeUrl = function getTypeUrl() {
-        return "type.googleapis.com/Package";
+    Package.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+        if (typeUrlPrefix === undefined) {
+            typeUrlPrefix = "type.googleapis.com";
+        }
+        return typeUrlPrefix + "/Package";
     };
 
     Package.Repository = (function() {
@@ -947,10 +951,14 @@ $root.Package = (function() {
          * @function getTypeUrl
          * @memberof Package.Repository
          * @static
+         * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
          * @returns {string} The default type url
          */
-        Repository.getTypeUrl = function getTypeUrl() {
-            return "type.googleapis.com/Package.Repository";
+        Repository.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+            if (typeUrlPrefix === undefined) {
+                typeUrlPrefix = "type.googleapis.com";
+            }
+            return typeUrlPrefix + "/Package.Repository";
         };
 
         return Repository;

diff --git a/tests/data/rpc-es6.d.ts b/tests/data/rpc-es6.d.ts
@@ -27,7 +27,7 @@ export class MyRequest implements IMyRequest {
     public static fromObject(object: { [k: string]: any }): MyRequest;
     public static toObject(message: MyRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
     public toJSON(): { [k: string]: any };
-    public static getTypeUrl(): string;
+    public static getTypeUrl(typeUrlPrefix?: string): string;
 }
 
 export interface IMyResponse {
@@ -46,5 +46,5 @@ export class MyResponse implements IMyResponse {
     public static fromObject(object: { [k: string]: any }): MyResponse;
     public static toObject(message: MyResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
     public toJSON(): { [k: string]: any };
-    public static getTypeUrl(): string;
+    public static getTypeUrl(typeUrlPrefix?: string): string;
 }
diff --git a/tests/data/rpc-es6.js b/tests/data/rpc-es6.js
@@ -1,7 +1,5 @@
 /*eslint-disable block-scoped-var, id-length, no-control-regex, no-magic-numbers, no-prototype-builtins, no-redeclare, no-shadow, no-var, sort-vars*/
-"use strict";
-
-var $protobuf = require("../../minimal");
+import * as $protobuf from "../../minimal";
 
 // Common aliases
 const $Reader = $protobuf.Reader, $Writer = $protobuf.Writer, $util = $protobuf.util;
@@ -266,10 +264,14 @@ export const MyRequest = $root.MyRequest = (() => {
      * @function getTypeUrl
      * @memberof MyRequest
      * @static
+     * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
      * @returns {string} The default type url
      */
-    MyRequest.getTypeUrl = function getTypeUrl() {
-        return "type.googleapis.com/MyRequest";
+    MyRequest.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+        if (typeUrlPrefix === undefined) {
+            typeUrlPrefix = "type.googleapis.com";
+        }
+        return typeUrlPrefix + "/MyRequest";
     };
 
     return MyRequest;
@@ -464,13 +466,17 @@ export const MyResponse = $root.MyResponse = (() => {
      * @function getTypeUrl
      * @memberof MyResponse
      * @static
+     * @param {string} [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
      * @returns {string} The default type url
      */
-    MyResponse.getTypeUrl = function getTypeUrl() {
-        return "type.googleapis.com/MyResponse";
+    MyResponse.getTypeUrl = function getTypeUrl(typeUrlPrefix) {
+        if (typeUrlPrefix === undefined) {
+            typeUrlPrefix = "type.googleapis.com";
+        }
+        return typeUrlPrefix + "/MyResponse";
     };
 
     return MyResponse;
 })();
 
-module.exports = $root;
+export { $root as default };
diff --git a/tests/data/rpc-reserved.d.ts b/tests/data/rpc-reserved.d.ts
@@ -27,7 +27,7 @@ export class MyRequest implements IMyRequest {
     public static fromObject(object: { [k: string]: any }): MyRequest;
     public static toObject(message: MyRequest, options?: $protobuf.IConversionOptions): { [k: string]: any };
     public toJSON(): { [k: string]: any };
-    public static getTypeUrl(): string;
+    public static getTypeUrl(typeUrlPrefix?: string): string;
 }
 
 export interface IMyResponse {
@@ -46,5 +46,5 @@ export class MyResponse implements IMyResponse {
     public static fromObject(object: { [k: string]: any }): MyResponse;
     public static toObject(message: MyResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
     public toJSON(): { [k: string]: any };
-    public static getTypeUrl(): string;
+    public static getTypeUrl(typeUrlPrefix?: string): string;
 }