@temporalio/common 1.9.3 → 1.10.0

package/lib/internal-non-workflow/data-converter-helpers.js

@@ -5,12 +5,22 @@ const payload_converter_1 = require("../converter/payload-converter");
 const data_converter_1 = require("../converter/data-converter");
 const type_helpers_1 = require("../type-helpers");
 const errors_1 = require("../errors");
-const isValidPayloadConverter = (converter) => typeof converter === 'object' &&
-    converter !== null &&
-    ['toPayload', 'fromPayload'].every((method) => typeof converter[method] === 'function');
-const isValidFailureConverter = (converter) => typeof converter === 'object' &&
-    converter !== null &&
-    ['errorToFailure', 'failureToError'].every((method) => typeof converter[method] === 'function');
+const isValidPayloadConverter = (converter, path) => {
+    const isValid = typeof converter === 'object' &&
+        converter !== null &&
+        ['toPayload', 'fromPayload'].every((method) => typeof converter[method] === 'function');
+    if (!isValid) {
+        throw new errors_1.ValueError(`payloadConverter export at ${path} must be an object with toPayload and fromPayload methods`);
+    }
+};
+const isValidFailureConverter = (converter, path) => {
+    const isValid = typeof converter === 'object' &&
+        converter !== null &&
+        ['errorToFailure', 'failureToError'].every((method) => typeof converter[method] === 'function');
+    if (!isValid) {
+        throw new errors_1.ValueError(`failureConverter export at ${path} must be an object with errorToFailure and failureToError methods`);
+    }
+};
 function requireConverter(path, type, validator) {
     let module;
     try {
@@ -24,15 +34,11 @@ function requireConverter(path, type, validator) {
     }
     if ((0, type_helpers_1.isRecord)(module) && (0, type_helpers_1.hasOwnProperty)(module, type)) {
         const converter = module[type];
-        if (validator(converter)) {
-            return converter;
-        }
-        else {
-            throw new errors_1.ValueError(`payloadConverter export at ${path} must be an object with toPayload and fromPayload methods`);
-        }
+        validator(converter, path);
+        return converter;
     }
     else {
-        throw new errors_1.ValueError(`Module ${path} does not have a \`payloadConverter\` named export`);
+        throw new errors_1.ValueError(`Module ${path} does not have a \`${type}\` named export`);
     }
 }
 /**

package/lib/internal-non-workflow/data-converter-helpers.js.map

@@ -1 +1 @@
-{"version":3,"file":"data-converter-helpers.js","sourceRoot":"","sources":["../../src/internal-non-workflow/data-converter-helpers.ts"],"names":[],"mappings":";;;AAAA,sEAA2F;AAC3F,gEAA0G;AAE1G,kDAAsE;AACtE,sCAAuC;AAEvC,MAAM,uBAAuB,GAAG,CAAC,SAAkB,EAAiC,EAAE,CACpF,OAAO,SAAS,KAAK,QAAQ;IAC7B,SAAS,KAAK,IAAI;IAClB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAQ,SAAqC,CAAC,MAAM,CAAC,KAAK,UAAU,CAAC,CAAC;AAEvH,MAAM,uBAAuB,GAAG,CAAC,SAAkB,EAAiC,EAAE,CACpF,OAAO,SAAS,KAAK,QAAQ;IAC7B,SAAS,KAAK,IAAI;IAClB,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC,KAAK,CACxC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAQ,SAAqC,CAAC,MAAM,CAAC,KAAK,UAAU,CACjF,CAAC;AAEJ,SAAS,gBAAgB,CAAI,IAAY,EAAE,IAAY,EAAE,SAAiD;IACxG,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,yDAAyD;IACnF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,IAAA,wBAAS,EAAC,KAAK,CAAC,KAAK,kBAAkB,EAAE,CAAC;YAC5C,MAAM,IAAI,mBAAU,CAAC,0CAA0C,IAAI,UAAU,IAAI,IAAI,CAAC,CAAC;QACzF,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IAED,IAAI,IAAA,uBAAQ,EAAC,MAAM,CAAC,IAAI,IAAA,6BAAc,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;QACrD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/B,IAAI,SAAS,CAAC,SAAS,CAAC,EAAE,CAAC;YACzB,OAAO,SAAS,CAAC;QACnB,CAAC;aAAM,CAAC;YACN,MAAM,IAAI,mBAAU,CAClB,8BAA8B,IAAI,2DAA2D,CAC9F,CAAC;QACJ,CAAC;IACH,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,mBAAU,CAAC,UAAU,IAAI,oDAAoD,CAAC,CAAC;IAC3F,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,aAA6B;IAC7D,IAAI,gBAAgB,GAAqB,2CAAuB,CAAC;IACjE,IAAI,aAAa,EAAE,oBAAoB,EAAE,CAAC;QACxC,gBAAgB,GAAG,gBAAgB,CACjC,aAAa,CAAC,oBAAoB,EAClC,kBAAkB,EAClB,uBAAuB,CACxB,CAAC;IACJ,CAAC;IACD,IAAI,gBAAgB,GAAqB,wCAAuB,CAAC;IACjE,IAAI,aAAa,EAAE,oBAAoB,EAAE,CAAC;QACxC,gBAAgB,GAAG,gBAAgB,CACjC,aAAa,CAAC,oBAAoB,EAClC,kBAAkB,EAClB,uBAAuB,CACxB,CAAC;IACJ,CAAC;IACD,OAAO;QACL,gBAAgB;QAChB,gBAAgB;QAChB,aAAa,EAAE,aAAa,EAAE,aAAa,IAAI,EAAE;KAClD,CAAC;AACJ,CAAC;AAtBD,8CAsBC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CACnC,aAAmD;IAEnD,OAAO,IAAA,uBAAQ,EAAC,aAAa,CAAC,IAAI,IAAA,6BAAc,EAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;AACtF,CAAC;AAJD,sDAIC"}
+{"version":3,"file":"data-converter-helpers.js","sourceRoot":"","sources":["../../src/internal-non-workflow/data-converter-helpers.ts"],"names":[],"mappings":";;;AAAA,sEAA2F;AAC3F,gEAA0G;AAE1G,kDAAsE;AACtE,sCAAuC;AAEvC,MAAM,uBAAuB,GAAG,CAAC,SAAkB,EAAE,IAAY,EAAyC,EAAE;IAC1G,MAAM,OAAO,GACX,OAAO,SAAS,KAAK,QAAQ;QAC7B,SAAS,KAAK,IAAI;QAClB,CAAC,WAAW,EAAE,aAAa,CAAC,CAAC,KAAK,CAChC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAQ,SAAqC,CAAC,MAAM,CAAC,KAAK,UAAU,CACjF,CAAC;IACJ,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,mBAAU,CAAC,8BAA8B,IAAI,2DAA2D,CAAC,CAAC;IACtH,CAAC;AACH,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,SAAkB,EAAE,IAAY,EAAyC,EAAE;IAC1G,MAAM,OAAO,GACX,OAAO,SAAS,KAAK,QAAQ;QAC7B,SAAS,KAAK,IAAI;QAClB,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC,KAAK,CACxC,CAAC,MAAM,EAAE,EAAE,CAAC,OAAQ,SAAqC,CAAC,MAAM,CAAC,KAAK,UAAU,CACjF,CAAC;IACJ,IAAI,CAAC,OAAO,EAAE,CAAC;QACb,MAAM,IAAI,mBAAU,CAClB,8BAA8B,IAAI,mEAAmE,CACtG,CAAC;IACJ,CAAC;AACH,CAAC,CAAC;AAEF,SAAS,gBAAgB,CACvB,IAAY,EACZ,IAAY,EACZ,SAAuE;IAEvE,IAAI,MAAM,CAAC;IACX,IAAI,CAAC;QACH,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC,CAAC,yDAAyD;IACnF,CAAC;IAAC,OAAO,KAAK,EAAE,CAAC;QACf,IAAI,IAAA,wBAAS,EAAC,KAAK,CAAC,KAAK,kBAAkB,EAAE,CAAC;YAC5C,MAAM,IAAI,mBAAU,CAAC,0CAA0C,IAAI,UAAU,IAAI,IAAI,CAAC,CAAC;QACzF,CAAC;QACD,MAAM,KAAK,CAAC;IACd,CAAC;IAED,IAAI,IAAA,uBAAQ,EAAC,MAAM,CAAC,IAAI,IAAA,6BAAc,EAAC,MAAM,EAAE,IAAI,CAAC,EAAE,CAAC;QACrD,MAAM,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC;QAC/B,SAAS,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;QAC3B,OAAO,SAAS,CAAC;IACnB,CAAC;SAAM,CAAC;QACN,MAAM,IAAI,mBAAU,CAAC,UAAU,IAAI,sBAAsB,IAAI,iBAAiB,CAAC,CAAC;IAClF,CAAC;AACH,CAAC;AAED;;;;GAIG;AACH,SAAgB,iBAAiB,CAAC,aAA6B;IAC7D,IAAI,gBAAgB,GAAqB,2CAAuB,CAAC;IACjE,IAAI,aAAa,EAAE,oBAAoB,EAAE,CAAC;QACxC,gBAAgB,GAAG,gBAAgB,CACjC,aAAa,CAAC,oBAAoB,EAClC,kBAAkB,EAClB,uBAAuB,CACxB,CAAC;IACJ,CAAC;IACD,IAAI,gBAAgB,GAAqB,wCAAuB,CAAC;IACjE,IAAI,aAAa,EAAE,oBAAoB,EAAE,CAAC;QACxC,gBAAgB,GAAG,gBAAgB,CACjC,aAAa,CAAC,oBAAoB,EAClC,kBAAkB,EAClB,uBAAuB,CACxB,CAAC;IACJ,CAAC;IACD,OAAO;QACL,gBAAgB;QAChB,gBAAgB;QAChB,aAAa,EAAE,aAAa,EAAE,aAAa,IAAI,EAAE;KAClD,CAAC;AACJ,CAAC;AAtBD,8CAsBC;AAED;;GAEG;AACH,SAAgB,qBAAqB,CACnC,aAAmD;IAEnD,OAAO,IAAA,uBAAQ,EAAC,aAAa,CAAC,IAAI,IAAA,6BAAc,EAAC,aAAa,EAAE,kBAAkB,CAAC,CAAC;AACtF,CAAC;AAJD,sDAIC"}

package/lib/internal-non-workflow/index.d.ts

@@ -6,5 +6,7 @@
 export * from './codec-helpers';
 export * from './codec-types';
 export * from './data-converter-helpers';
+export * from './parse-host-uri';
+export * from './proxy-config';
 export * from './tls-config';
 export * from './utils';

package/lib/internal-non-workflow/index.js

@@ -22,6 +22,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./codec-helpers"), exports);
 __exportStar(require("./codec-types"), exports);
 __exportStar(require("./data-converter-helpers"), exports);
+__exportStar(require("./parse-host-uri"), exports);
+__exportStar(require("./proxy-config"), exports);
 __exportStar(require("./tls-config"), exports);
 __exportStar(require("./utils"), exports);
 //# sourceMappingURL=index.js.map

package/lib/internal-non-workflow/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/internal-non-workflow/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;GAIG;AACH,kDAAgC;AAChC,gDAA8B;AAC9B,2DAAyC;AACzC,+CAA6B;AAC7B,0CAAwB"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/internal-non-workflow/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA;;;;GAIG;AACH,kDAAgC;AAChC,gDAA8B;AAC9B,2DAAyC;AACzC,mDAAiC;AACjC,iDAA+B;AAC/B,+CAA6B;AAC7B,0CAAwB"}

package/lib/internal-non-workflow/parse-host-uri.d.ts

@@ -0,0 +1,45 @@
+/**
+ * This file contain helper functions to parse specific subsets of URIs.
+ *
+ * The ECMAScript-compliant URL class don't properly handle some syntaxes that
+ * we care about, such as not providing a protocol (e.g. '127.0.0.1:7233'), and
+ * performs some normalizations that are not desirable for our use cases
+ * (e.g. parsing 'http://127.0.0.1:7233' adds a '/' path). On the other side,
+ * simply using `split(':')` breaks on IPv6 addresses. Hence these helpers.
+ */
+export interface ProtoHostPort {
+    scheme?: string;
+    hostname: string;
+    port?: number;
+}
+/**
+ * Split a URI composed only of a scheme, a hostname, and port.
+ * The scheme and port are optional.
+ *
+ * Examples of valid URIs for HTTP CONNECT proxies:
+ *
+ * ```
+ * http://test.com:8080 => { scheme: 'http', host: 'test.com', port: 8080 }
+ * http://192.168.0.1:8080 => { scheme: 'http', host: '192.168.0.1', port: 8080 }
+ * [::1]:8080 => { scheme: 'http', host: '::1', port: 8080 }
+ * [::ffff:192.0.2.128]:8080 => { scheme: 'http', host: '::ffff:192.0.2.128', port: 8080 }
+ * 192.168.0.1:8080 => { scheme: 'http', host: '192.168.0.1', port: 8080 }
+ * ```
+ */
+export declare function splitProtoHostPort(uri: string): ProtoHostPort | undefined;
+export declare function joinProtoHostPort(components: ProtoHostPort): string;
+/**
+ * Parse the address for the gRPC endpoint of a Temporal server.
+ *
+ * - The URI may only contain a hostname and a port.
+ * - Port is optional; it defaults to 7233.
+ *
+ * Examples of valid URIs:
+ *
+ * ```
+ * 127.0.0.1:7233 => { host: '192.168.0.1', port: 7233 }
+ * my.temporal.service.com:7233 => { host: 'my.temporal.service.com', port: 7233 }
+ * [::ffff:192.0.2.128]:8080 => { host: '[::ffff:192.0.2.128]', port: 8080 }
+ * ```
+ */
+export declare function normalizeTemporalGrpcEndpointAddress(uri: string): string;

package/lib/internal-non-workflow/parse-host-uri.js

@@ -0,0 +1,92 @@
+"use strict";
+/**
+ * This file contain helper functions to parse specific subsets of URIs.
+ *
+ * The ECMAScript-compliant URL class don't properly handle some syntaxes that
+ * we care about, such as not providing a protocol (e.g. '127.0.0.1:7233'), and
+ * performs some normalizations that are not desirable for our use cases
+ * (e.g. parsing 'http://127.0.0.1:7233' adds a '/' path). On the other side,
+ * simply using `split(':')` breaks on IPv6 addresses. Hence these helpers.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.normalizeTemporalGrpcEndpointAddress = exports.joinProtoHostPort = exports.splitProtoHostPort = void 0;
+/**
+ * Scheme. Requires but doesn't capture the ':' or '://' separator that follows.
+ * e.g. `http:` will be captured as 'http'.
+ */
+const scheme = '(?:(?<scheme>[a-z][a-z0-9]+):(?:\\/\\/)?)';
+/**
+ * IPv4-style hostname. Not captured.
+ * e.g.: `192.168.1.100`.
+ */
+const ipv4Hostname = '(?:\\d{1,3}(?:\\.\\d{1,3}){3})';
+/**
+ * IPv6-style hostname; must be enclosed in square brackets. Not captured.
+ * e.g.: `[::1]`, `[2001:db8::1]`, `[::FFFF:129.144.52.38]`, etc.
+ */
+const ipv6Hostname = '(?:\\[(?<ipv6>[0-9a-fA-F.:]+)\\])';
+// DNS-style hostname. Not captured.
+// e.g.: `test.com` or `localhost`.
+const dnsHostname = '(?:[^:/]+)';
+const hostname = `(?:${ipv4Hostname}|${ipv6Hostname}|${dnsHostname})`;
+// Port number. Requires but don't capture a preceeding ':' separator.
+// For example, `:7233` will be captured as `7233`.
+const port = '(?::(?<port>\\d+))';
+const protoHostPortRegex = new RegExp(`^${scheme}??(?<hostname>${hostname})${port}?$`);
+/**
+ * Split a URI composed only of a scheme, a hostname, and port.
+ * The scheme and port are optional.
+ *
+ * Examples of valid URIs for HTTP CONNECT proxies:
+ *
+ * ```
+ * http://test.com:8080 => { scheme: 'http', host: 'test.com', port: 8080 }
+ * http://192.168.0.1:8080 => { scheme: 'http', host: '192.168.0.1', port: 8080 }
+ * [::1]:8080 => { scheme: 'http', host: '::1', port: 8080 }
+ * [::ffff:192.0.2.128]:8080 => { scheme: 'http', host: '::ffff:192.0.2.128', port: 8080 }
+ * 192.168.0.1:8080 => { scheme: 'http', host: '192.168.0.1', port: 8080 }
+ * ```
+ */
+function splitProtoHostPort(uri) {
+    const match = protoHostPortRegex.exec(uri);
+    if (!match?.groups)
+        return undefined;
+    return {
+        scheme: match.groups.scheme,
+        hostname: match.groups.ipv6 ?? match.groups.hostname,
+        port: match.groups.port !== undefined ? Number(match.groups.port) : undefined,
+    };
+}
+exports.splitProtoHostPort = splitProtoHostPort;
+function joinProtoHostPort(components) {
+    const { scheme, hostname, port } = components;
+    const schemeText = scheme ? `${scheme}:` : '';
+    const hostnameText = hostname.includes(':') ? `[${hostname}]` : hostname;
+    const portText = port !== undefined ? `:${port}` : '';
+    return `${schemeText}${hostnameText}${portText}`;
+}
+exports.joinProtoHostPort = joinProtoHostPort;
+/**
+ * Parse the address for the gRPC endpoint of a Temporal server.
+ *
+ * - The URI may only contain a hostname and a port.
+ * - Port is optional; it defaults to 7233.
+ *
+ * Examples of valid URIs:
+ *
+ * ```
+ * 127.0.0.1:7233 => { host: '192.168.0.1', port: 7233 }
+ * my.temporal.service.com:7233 => { host: 'my.temporal.service.com', port: 7233 }
+ * [::ffff:192.0.2.128]:8080 => { host: '[::ffff:192.0.2.128]', port: 8080 }
+ * ```
+ */
+function normalizeTemporalGrpcEndpointAddress(uri) {
+    const splitted = splitProtoHostPort(uri);
+    if (!splitted || splitted.scheme !== undefined) {
+        throw new TypeError(`Invalid address for Temporal gRPC endpoint: expected URI of the form 'hostname' or 'hostname:port'; got '${uri}'`);
+    }
+    splitted.port ??= 7233;
+    return joinProtoHostPort(splitted);
+}
+exports.normalizeTemporalGrpcEndpointAddress = normalizeTemporalGrpcEndpointAddress;
+//# sourceMappingURL=parse-host-uri.js.map

package/lib/internal-non-workflow/parse-host-uri.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-host-uri.js","sourceRoot":"","sources":["../../src/internal-non-workflow/parse-host-uri.ts"],"names":[],"mappings":";AAAA;;;;;;;;GAQG;;;AAEH;;;GAGG;AACH,MAAM,MAAM,GAAG,2CAA2C,CAAC;AAE3D;;;GAGG;AACH,MAAM,YAAY,GAAG,gCAAgC,CAAC;AAEtD;;;GAGG;AACH,MAAM,YAAY,GAAG,mCAAmC,CAAC;AAEzD,oCAAoC;AACpC,mCAAmC;AACnC,MAAM,WAAW,GAAG,YAAY,CAAC;AAEjC,MAAM,QAAQ,GAAG,MAAM,YAAY,IAAI,YAAY,IAAI,WAAW,GAAG,CAAC;AAEtE,sEAAsE;AACtE,mDAAmD;AACnD,MAAM,IAAI,GAAG,oBAAoB,CAAC;AAElC,MAAM,kBAAkB,GAAG,IAAI,MAAM,CAAC,IAAI,MAAM,iBAAiB,QAAQ,IAAI,IAAI,IAAI,CAAC,CAAC;AAQvF;;;;;;;;;;;;;GAaG;AACH,SAAgB,kBAAkB,CAAC,GAAW;IAC5C,MAAM,KAAK,GAAG,kBAAkB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC3C,IAAI,CAAC,KAAK,EAAE,MAAM;QAAE,OAAO,SAAS,CAAC;IACrC,OAAO;QACL,MAAM,EAAE,KAAK,CAAC,MAAM,CAAC,MAAM;QAC3B,QAAQ,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC,QAAQ;QACpD,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;KAC9E,CAAC;AACJ,CAAC;AARD,gDAQC;AAED,SAAgB,iBAAiB,CAAC,UAAyB;IACzD,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,GAAG,UAAU,CAAC;IAC9C,MAAM,UAAU,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,MAAM,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC;IAC9C,MAAM,YAAY,GAAG,QAAQ,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,QAAQ,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC;IACzE,MAAM,QAAQ,GAAG,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC;IACtD,OAAO,GAAG,UAAU,GAAG,YAAY,GAAG,QAAQ,EAAE,CAAC;AACnD,CAAC;AAND,8CAMC;AAED;;;;;;;;;;;;;GAaG;AACH,SAAgB,oCAAoC,CAAC,GAAW;IAC9D,MAAM,QAAQ,GAAG,kBAAkB,CAAC,GAAG,CAAC,CAAC;IACzC,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;QAC/C,MAAM,IAAI,SAAS,CACjB,4GAA4G,GAAG,GAAG,CACnH,CAAC;IACJ,CAAC;IACD,QAAQ,CAAC,IAAI,KAAK,IAAI,CAAC;IACvB,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AACrC,CAAC;AATD,oFASC"}

package/lib/internal-non-workflow/proxy-config.d.ts

@@ -0,0 +1,43 @@
+import { ProtoHostPort } from './parse-host-uri';
+/**
+ * Configuration for HTTP CONNECT proxying.
+ */
+export interface HttpConnectProxyConfig {
+    type: 'http-connect';
+    /**
+     * Address of the HTTP CONNECT proxy server, in either `hostname:port` or `http://hostname:port` formats.
+     *
+     * Port is required, and only the `http` scheme is supported. Raw IPv6 addresses must be wrapped in square brackets
+     * (e.g. `[ipv6]:port`).
+     */
+    targetHost: string;
+    /**
+     * Basic auth for the HTTP CONNECT proxy, if any.
+     *
+     * Neither username nor password may contain `:` or `@`.
+     *
+     * Note that these credentials will be exposed through environment variables, and will be exchanged in non-encrypted
+     * form ovrer the network. The connection to the proxy server is not encrypted.
+     */
+    basicAuth?: {
+        username: string;
+        password: string;
+    };
+}
+export type ProxyConfig = HttpConnectProxyConfig;
+/**
+ * Parse the address of a HTTP CONNECT proxy endpoint.
+ *
+ * - The URI may only contain a scheme, a hostname, and a port;
+ * - If specified, scheme must be 'http';
+ * - Port is required.
+ *
+ * Examples of valid URIs:
+ *
+ * ```
+ * 127.0.0.1:8080 => { scheme: 'http', host: '192.168.0.1', port: 8080 }
+ * my.temporal.service.com:8888 => { scheme: 'http', host: 'my.temporal.service.com', port: 8888 }
+ * [::ffff:192.0.2.128]:8080 => { scheme: 'http', host: '::ffff:192.0.2.128', port: 8080 }
+ * ```
+ */
+export declare function parseHttpConnectProxyAddress(target: string): ProtoHostPort;

package/lib/internal-non-workflow/proxy-config.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseHttpConnectProxyAddress = void 0;
+const parse_host_uri_1 = require("./parse-host-uri");
+/**
+ * Parse the address of a HTTP CONNECT proxy endpoint.
+ *
+ * - The URI may only contain a scheme, a hostname, and a port;
+ * - If specified, scheme must be 'http';
+ * - Port is required.
+ *
+ * Examples of valid URIs:
+ *
+ * ```
+ * 127.0.0.1:8080 => { scheme: 'http', host: '192.168.0.1', port: 8080 }
+ * my.temporal.service.com:8888 => { scheme: 'http', host: 'my.temporal.service.com', port: 8888 }
+ * [::ffff:192.0.2.128]:8080 => { scheme: 'http', host: '::ffff:192.0.2.128', port: 8080 }
+ * ```
+ */
+function parseHttpConnectProxyAddress(target) {
+    const match = (0, parse_host_uri_1.splitProtoHostPort)(target);
+    if (!match)
+        throw new TypeError(`Invalid address for HTTP CONNECT proxy: expected 'hostname:port' or '[ipv6 address]:port'; got '${target}'`);
+    const { scheme = 'http', hostname: host, port } = match;
+    if (scheme !== 'http')
+        throw new TypeError(`Invalid address for HTTP CONNECT proxy: scheme must be http'; got '${target}'`);
+    if (port === undefined)
+        throw new TypeError(`Invalid address for HTTP CONNECT proxy: port is required; got '${target}'`);
+    return { scheme, hostname: host, port };
+}
+exports.parseHttpConnectProxyAddress = parseHttpConnectProxyAddress;
+//# sourceMappingURL=proxy-config.js.map

package/lib/internal-non-workflow/proxy-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy-config.js","sourceRoot":"","sources":["../../src/internal-non-workflow/proxy-config.ts"],"names":[],"mappings":";;;AAAA,qDAAqE;AAgCrE;;;;;;;;;;;;;;GAcG;AACH,SAAgB,4BAA4B,CAAC,MAAc;IACzD,MAAM,KAAK,GAAG,IAAA,mCAAkB,EAAC,MAAM,CAAC,CAAC;IACzC,IAAI,CAAC,KAAK;QACR,MAAM,IAAI,SAAS,CACjB,mGAAmG,MAAM,GAAG,CAC7G,CAAC;IACJ,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;IACxD,IAAI,MAAM,KAAK,MAAM;QACnB,MAAM,IAAI,SAAS,CAAC,sEAAsE,MAAM,GAAG,CAAC,CAAC;IACvG,IAAI,IAAI,KAAK,SAAS;QACpB,MAAM,IAAI,SAAS,CAAC,kEAAkE,MAAM,GAAG,CAAC,CAAC;IACnG,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,IAAI,EAAE,IAAI,EAAE,CAAC;AAC1C,CAAC;AAZD,oEAYC"}

package/lib/logger.d.ts

@@ -11,3 +11,39 @@ export interface Logger {
     warn(message: string, meta?: LogMetadata): any;
     error(message: string, meta?: LogMetadata): any;
 }
+/**
+ * Possible values of the `sdkComponent` meta attributes on log messages. This
+ * attribute indicates which subsystem emitted the log message; this may for
+ * example be used to implement fine-grained filtering of log messages.
+ *
+ * Note that there is no guarantee that this list will remain stable in the
+ * future; values may be added or removed, and messages that are currently
+ * emitted with some `sdkComponent` value may use a different value in the future.
+ */
+export declare enum SdkComponent {
+    /**
+     * Component name for messages emited from Workflow code, using the {@link Workflow context logger|workflow.log}.
+     * The SDK itself never publishes messages with this component name.
+     */
+    workflow = "workflow",
+    /**
+     * Component name for messages emited from an activity, using the {@link activity context logger|Context.log}.
+     * The SDK itself never publishes messages with this component name.
+     */
+    activity = "activity",
+    /**
+     * Component name for messages emited from a Temporal Worker instance.
+     *
+     * This notably includes:
+     * - Issues with Worker or runtime configuration, or the JS execution environment;
+     * - Worker's, Activity's, and Workflow's lifecycle events;
+     * - Workflow Activation and Activity Task processing events;
+     * - Workflow bundling messages;
+     * - Sink processing issues.
+     */
+    worker = "worker",
+    /**
+     * Component name for all messages emitted by the Rust Core SDK library.
+     */
+    core = "core"
+}

package/lib/logger.js

@@ -1,3 +1,41 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.SdkComponent = void 0;
+/**
+ * Possible values of the `sdkComponent` meta attributes on log messages. This
+ * attribute indicates which subsystem emitted the log message; this may for
+ * example be used to implement fine-grained filtering of log messages.
+ *
+ * Note that there is no guarantee that this list will remain stable in the
+ * future; values may be added or removed, and messages that are currently
+ * emitted with some `sdkComponent` value may use a different value in the future.
+ */
+var SdkComponent;
+(function (SdkComponent) {
+    /**
+     * Component name for messages emited from Workflow code, using the {@link Workflow context logger|workflow.log}.
+     * The SDK itself never publishes messages with this component name.
+     */
+    SdkComponent["workflow"] = "workflow";
+    /**
+     * Component name for messages emited from an activity, using the {@link activity context logger|Context.log}.
+     * The SDK itself never publishes messages with this component name.
+     */
+    SdkComponent["activity"] = "activity";
+    /**
+     * Component name for messages emited from a Temporal Worker instance.
+     *
+     * This notably includes:
+     * - Issues with Worker or runtime configuration, or the JS execution environment;
+     * - Worker's, Activity's, and Workflow's lifecycle events;
+     * - Workflow Activation and Activity Task processing events;
+     * - Workflow bundling messages;
+     * - Sink processing issues.
+     */
+    SdkComponent["worker"] = "worker";
+    /**
+     * Component name for all messages emitted by the Rust Core SDK library.
+     */
+    SdkComponent["core"] = "core";
+})(SdkComponent || (exports.SdkComponent = SdkComponent = {}));
 //# sourceMappingURL=logger.js.map

package/lib/logger.js.map

@@ -1 +1 @@
-{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":""}
+{"version":3,"file":"logger.js","sourceRoot":"","sources":["../src/logger.ts"],"names":[],"mappings":";;;AAgBA;;;;;;;;GAQG;AACH,IAAY,YA6BX;AA7BD,WAAY,YAAY;IACtB;;;OAGG;IACH,qCAAqB,CAAA;IAErB;;;OAGG;IACH,qCAAqB,CAAA;IAErB;;;;;;;;;OASG;IACH,iCAAiB,CAAA;IAEjB;;OAEG;IACH,6BAAa,CAAA;AACf,CAAC,EA7BW,YAAY,4BAAZ,YAAY,QA6BvB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@temporalio/common",
-  "version": "1.9.3",
+  "version": "1.10.0",
   "description": "Common library for code that's used across the Client, Worker, and/or Workflow",
   "main": "lib/index.js",
   "types": "./lib/index.d.ts",
@@ -12,7 +12,7 @@
   "author": "Temporal Technologies Inc. <sdk@temporal.io>",
   "license": "MIT",
   "dependencies": {
-    "@temporalio/proto": "1.9.3",
+    "@temporalio/proto": "1.10.0",
     "long": "^5.2.3",
     "ms": "^3.0.0-canary.1",
     "proto3-json-serializer": "^2.0.0"
@@ -36,5 +36,5 @@
     "src",
     "lib"
   ],
-  "gitHead": "e7e46639c1ba23b86f367a051fb54d736c5f21ce"
+  "gitHead": "39d702af7ae5d7e33ee90651292aa77fa07d33ca"
 }

package/src/internal-non-workflow/data-converter-helpers.ts

@@ -4,19 +4,37 @@ import { FailureConverter } from '../converter/failure-converter';
 import { errorCode, hasOwnProperty, isRecord } from '../type-helpers';
 import { ValueError } from '../errors';
 
-const isValidPayloadConverter = (converter: unknown): converter is PayloadConverter =>
-  typeof converter === 'object' &&
-  converter !== null &&
-  ['toPayload', 'fromPayload'].every((method) => typeof (converter as Record<string, unknown>)[method] === 'function');
+const isValidPayloadConverter = (converter: unknown, path: string): asserts converter is PayloadConverter => {
+  const isValid =
+    typeof converter === 'object' &&
+    converter !== null &&
+    ['toPayload', 'fromPayload'].every(
+      (method) => typeof (converter as Record<string, unknown>)[method] === 'function'
+    );
+  if (!isValid) {
+    throw new ValueError(`payloadConverter export at ${path} must be an object with toPayload and fromPayload methods`);
+  }
+};
 
-const isValidFailureConverter = (converter: unknown): converter is FailureConverter =>
-  typeof converter === 'object' &&
-  converter !== null &&
-  ['errorToFailure', 'failureToError'].every(
-    (method) => typeof (converter as Record<string, unknown>)[method] === 'function'
-  );
+const isValidFailureConverter = (converter: unknown, path: string): asserts converter is FailureConverter => {
+  const isValid =
+    typeof converter === 'object' &&
+    converter !== null &&
+    ['errorToFailure', 'failureToError'].every(
+      (method) => typeof (converter as Record<string, unknown>)[method] === 'function'
+    );
+  if (!isValid) {
+    throw new ValueError(
+      `failureConverter export at ${path} must be an object with errorToFailure and failureToError methods`
+    );
+  }
+};
 
-function requireConverter<T>(path: string, type: string, validator: (converter: unknown) => converter is T): T {
+function requireConverter<T>(
+  path: string,
+  type: string,
+  validator: (converter: unknown, path: string) => asserts converter is T
+): T {
   let module;
   try {
     module = require(path); // eslint-disable-line @typescript-eslint/no-var-requires
@@ -29,15 +47,10 @@ function requireConverter<T>(path: string, type: string, validator: (converter:
 
   if (isRecord(module) && hasOwnProperty(module, type)) {
     const converter = module[type];
-    if (validator(converter)) {
-      return converter;
-    } else {
-      throw new ValueError(
-        `payloadConverter export at ${path} must be an object with toPayload and fromPayload methods`
-      );
-    }
+    validator(converter, path);
+    return converter;
   } else {
-    throw new ValueError(`Module ${path} does not have a \`payloadConverter\` named export`);
+    throw new ValueError(`Module ${path} does not have a \`${type}\` named export`);
   }
 }
 

package/src/internal-non-workflow/index.ts

@@ -6,5 +6,7 @@
 export * from './codec-helpers';
 export * from './codec-types';
 export * from './data-converter-helpers';
+export * from './parse-host-uri';
+export * from './proxy-config';
 export * from './tls-config';
 export * from './utils';

package/src/internal-non-workflow/parse-host-uri.ts

@@ -0,0 +1,102 @@
+/**
+ * This file contain helper functions to parse specific subsets of URIs.
+ *
+ * The ECMAScript-compliant URL class don't properly handle some syntaxes that
+ * we care about, such as not providing a protocol (e.g. '127.0.0.1:7233'), and
+ * performs some normalizations that are not desirable for our use cases
+ * (e.g. parsing 'http://127.0.0.1:7233' adds a '/' path). On the other side,
+ * simply using `split(':')` breaks on IPv6 addresses. Hence these helpers.
+ */
+
+/**
+ * Scheme. Requires but doesn't capture the ':' or '://' separator that follows.
+ * e.g. `http:` will be captured as 'http'.
+ */
+const scheme = '(?:(?<scheme>[a-z][a-z0-9]+):(?:\\/\\/)?)';
+
+/**
+ * IPv4-style hostname. Not captured.
+ * e.g.: `192.168.1.100`.
+ */
+const ipv4Hostname = '(?:\\d{1,3}(?:\\.\\d{1,3}){3})';
+
+/**
+ * IPv6-style hostname; must be enclosed in square brackets. Not captured.
+ * e.g.: `[::1]`, `[2001:db8::1]`, `[::FFFF:129.144.52.38]`, etc.
+ */
+const ipv6Hostname = '(?:\\[(?<ipv6>[0-9a-fA-F.:]+)\\])';
+
+// DNS-style hostname. Not captured.
+// e.g.: `test.com` or `localhost`.
+const dnsHostname = '(?:[^:/]+)';
+
+const hostname = `(?:${ipv4Hostname}|${ipv6Hostname}|${dnsHostname})`;
+
+// Port number. Requires but don't capture a preceeding ':' separator.
+// For example, `:7233` will be captured as `7233`.
+const port = '(?::(?<port>\\d+))';
+
+const protoHostPortRegex = new RegExp(`^${scheme}??(?<hostname>${hostname})${port}?$`);
+
+export interface ProtoHostPort {
+  scheme?: string;
+  hostname: string;
+  port?: number;
+}
+
+/**
+ * Split a URI composed only of a scheme, a hostname, and port.
+ * The scheme and port are optional.
+ *
+ * Examples of valid URIs for HTTP CONNECT proxies:
+ *
+ * ```
+ * http://test.com:8080 => { scheme: 'http', host: 'test.com', port: 8080 }
+ * http://192.168.0.1:8080 => { scheme: 'http', host: '192.168.0.1', port: 8080 }
+ * [::1]:8080 => { scheme: 'http', host: '::1', port: 8080 }
+ * [::ffff:192.0.2.128]:8080 => { scheme: 'http', host: '::ffff:192.0.2.128', port: 8080 }
+ * 192.168.0.1:8080 => { scheme: 'http', host: '192.168.0.1', port: 8080 }
+ * ```
+ */
+export function splitProtoHostPort(uri: string): ProtoHostPort | undefined {
+  const match = protoHostPortRegex.exec(uri);
+  if (!match?.groups) return undefined;
+  return {
+    scheme: match.groups.scheme,
+    hostname: match.groups.ipv6 ?? match.groups.hostname,
+    port: match.groups.port !== undefined ? Number(match.groups.port) : undefined,
+  };
+}
+
+export function joinProtoHostPort(components: ProtoHostPort): string {
+  const { scheme, hostname, port } = components;
+  const schemeText = scheme ? `${scheme}:` : '';
+  const hostnameText = hostname.includes(':') ? `[${hostname}]` : hostname;
+  const portText = port !== undefined ? `:${port}` : '';
+  return `${schemeText}${hostnameText}${portText}`;
+}
+
+/**
+ * Parse the address for the gRPC endpoint of a Temporal server.
+ *
+ * - The URI may only contain a hostname and a port.
+ * - Port is optional; it defaults to 7233.
+ *
+ * Examples of valid URIs:
+ *
+ * ```
+ * 127.0.0.1:7233 => { host: '192.168.0.1', port: 7233 }
+ * my.temporal.service.com:7233 => { host: 'my.temporal.service.com', port: 7233 }
+ * [::ffff:192.0.2.128]:8080 => { host: '[::ffff:192.0.2.128]', port: 8080 }
+ * ```
+ */
+export function normalizeTemporalGrpcEndpointAddress(uri: string): string {
+  const splitted = splitProtoHostPort(uri);
+  if (!splitted || splitted.scheme !== undefined) {
+    throw new TypeError(
+      `Invalid address for Temporal gRPC endpoint: expected URI of the form 'hostname' or 'hostname:port'; got '${uri}'`
+    );
+  }
+  splitted.port ??= 7233;
+  return joinProtoHostPort(splitted);
+}

package/src/internal-non-workflow/proxy-config.ts

@@ -0,0 +1,60 @@
+import { ProtoHostPort, splitProtoHostPort } from './parse-host-uri';
+
+/**
+ * Configuration for HTTP CONNECT proxying.
+ */
+export interface HttpConnectProxyConfig {
+  type: 'http-connect';
+
+  /**
+   * Address of the HTTP CONNECT proxy server, in either `hostname:port` or `http://hostname:port` formats.
+   *
+   * Port is required, and only the `http` scheme is supported. Raw IPv6 addresses must be wrapped in square brackets
+   * (e.g. `[ipv6]:port`).
+   */
+  targetHost: string;
+
+  /**
+   * Basic auth for the HTTP CONNECT proxy, if any.
+   *
+   * Neither username nor password may contain `:` or `@`.
+   *
+   * Note that these credentials will be exposed through environment variables, and will be exchanged in non-encrypted
+   * form ovrer the network. The connection to the proxy server is not encrypted.
+   */
+  basicAuth?: {
+    username: string;
+    password: string;
+  };
+}
+
+export type ProxyConfig = HttpConnectProxyConfig;
+
+/**
+ * Parse the address of a HTTP CONNECT proxy endpoint.
+ *
+ * - The URI may only contain a scheme, a hostname, and a port;
+ * - If specified, scheme must be 'http';
+ * - Port is required.
+ *
+ * Examples of valid URIs:
+ *
+ * ```
+ * 127.0.0.1:8080 => { scheme: 'http', host: '192.168.0.1', port: 8080 }
+ * my.temporal.service.com:8888 => { scheme: 'http', host: 'my.temporal.service.com', port: 8888 }
+ * [::ffff:192.0.2.128]:8080 => { scheme: 'http', host: '::ffff:192.0.2.128', port: 8080 }
+ * ```
+ */
+export function parseHttpConnectProxyAddress(target: string): ProtoHostPort {
+  const match = splitProtoHostPort(target);
+  if (!match)
+    throw new TypeError(
+      `Invalid address for HTTP CONNECT proxy: expected 'hostname:port' or '[ipv6 address]:port'; got '${target}'`
+    );
+  const { scheme = 'http', hostname: host, port } = match;
+  if (scheme !== 'http')
+    throw new TypeError(`Invalid address for HTTP CONNECT proxy: scheme must be http'; got '${target}'`);
+  if (port === undefined)
+    throw new TypeError(`Invalid address for HTTP CONNECT proxy: port is required; got '${target}'`);
+  return { scheme, hostname: host, port };
+}

package/src/logger.ts

@@ -13,3 +13,43 @@ export interface Logger {
   warn(message: string, meta?: LogMetadata): any;
   error(message: string, meta?: LogMetadata): any;
 }
+
+/**
+ * Possible values of the `sdkComponent` meta attributes on log messages. This
+ * attribute indicates which subsystem emitted the log message; this may for
+ * example be used to implement fine-grained filtering of log messages.
+ *
+ * Note that there is no guarantee that this list will remain stable in the
+ * future; values may be added or removed, and messages that are currently
+ * emitted with some `sdkComponent` value may use a different value in the future.
+ */
+export enum SdkComponent {
+  /**
+   * Component name for messages emited from Workflow code, using the {@link Workflow context logger|workflow.log}.
+   * The SDK itself never publishes messages with this component name.
+   */
+  workflow = 'workflow',
+
+  /**
+   * Component name for messages emited from an activity, using the {@link activity context logger|Context.log}.
+   * The SDK itself never publishes messages with this component name.
+   */
+  activity = 'activity',
+
+  /**
+   * Component name for messages emited from a Temporal Worker instance.
+   *
+   * This notably includes:
+   * - Issues with Worker or runtime configuration, or the JS execution environment;
+   * - Worker's, Activity's, and Workflow's lifecycle events;
+   * - Workflow Activation and Activity Task processing events;
+   * - Workflow bundling messages;
+   * - Sink processing issues.
+   */
+  worker = 'worker',
+
+  /**
+   * Component name for all messages emitted by the Rust Core SDK library.
+   */
+  core = 'core',
+}