chore: Deprecate internal functions that should have never been exported (#893)

* chore: Deprecate internal functions that should have never been exported

* use arduino/setup-protoc instead of @protobuf-ts/protoc

* point sdk-features at protoc branch

* add token

Co-authored-by: Loren 🤓 <lorensr@gmail.com>

Author: bergundy

.github/workflows/ci.yml

@@ -30,6 +30,11 @@ jobs:
       - uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node }}
+      - name: Install protoc
+        uses: arduino/setup-protoc@v1
+        with:
+          version: '3.x'
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
       - uses: Swatinem/rust-cache@v1
         with:
           working-directory: packages/core-bridge
@@ -79,6 +84,11 @@ jobs:
       - uses: actions/setup-node@v1
         with:
           node-version: 16
+      - name: Install protoc
+        uses: arduino/setup-protoc@v1
+        with:
+          version: '3.x'
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
       # Don't build during install phase since we're going to explicitly build
       - run: npm ci --ignore-scripts
       - run: npm run build -- --ignore @temporalio/core-bridge
@@ -149,6 +159,11 @@ jobs:
       - uses: actions/setup-node@v1
         with:
           node-version: 16
+      - name: Install protoc
+        uses: arduino/setup-protoc@v1
+        with:
+          version: '3.x'
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
       - name: Add ${{ matrix.target }} rust target
         run: rustup target add ${{ matrix.target }}
       - name: Print libc version
@@ -276,7 +291,7 @@ jobs:
 
   # Runs the sdk features repo tests with this repo's current SDK code
   sdk-features-tests:
-    uses: temporalio/sdk-features/.github/workflows/typescript.yaml@main
+    uses: temporalio/sdk-features/.github/workflows/typescript.yaml@protoc
     with:
       typescript-repo-path: ${{github.event.pull_request.head.repo.full_name}}
       typescript-repo-ref: ${{github.event.pull_request.head.ref}}

.github/workflows/stress.yml

@@ -30,6 +30,11 @@ jobs:
       - uses: actions/setup-node@v1
         with:
           node-version: ${{ matrix.node }}
+      - name: Install protoc
+        uses: arduino/setup-protoc@v1
+        with:
+          version: '3.x'
+          repo-token: ${{ secrets.GITHUB_TOKEN }}
       - uses: Swatinem/rust-cache@v1
         with:
           working-directory: packages/core-bridge

package-lock.json

@@ -53,7 +53,6 @@
     "@opentelemetry/core": "^1.3.1",
     "@opentelemetry/sdk-node": "^0.32.0",
     "@opentelemetry/semantic-conventions": "^1.3.1",
-    "@protobuf-ts/protoc": "^2.8.1",
     "@tsconfig/node14": "^1.0.3",
     "@types/dedent": "^0.7.0",
     "@types/fs-extra": "^9.0.13",

package.json

@@ -71,15 +71,14 @@
 
 import { AbortSignal } from 'abort-controller';
 import { AsyncLocalStorage } from 'async_hooks';
-import { msToNumber } from '@temporalio/common';
+import { msToNumber } from '@temporalio/common/lib/time';
 
 export {
   ActivityFunction,
   ActivityInterface, // eslint-disable-line deprecation/deprecation
   ApplicationFailure,
   CancelledFailure,
   UntypedActivities,
-  msToNumber,
 } from '@temporalio/common';
 
 /**

packages/activity/src/index.ts

@@ -25,16 +25,15 @@ import {
 import {
   BaseWorkflowHandle,
   compileRetryPolicy,
-  optionalTsToDate,
   QueryDefinition,
   SearchAttributes,
   SignalDefinition,
-  tsToDate,
   WithWorkflowArgs,
   Workflow,
   WorkflowNotFoundError,
   WorkflowResultType,
 } from '@temporalio/common';
+import { optionalTsToDate, tsToDate } from '@temporalio/common/lib/time';
 import { composeInterceptors } from '@temporalio/common/lib/interceptors';
 import { Replace } from '@temporalio/common/lib/type-helpers';
 import { temporal } from '@temporalio/proto';

packages/client/src/workflow-client.ts

@@ -1,6 +1,7 @@
-import { Payload } from '../interfaces';
+import { decode, encode } from '../encoding';
 import { IllegalStateError, PayloadConverterError, ValueError } from '../errors';
-import { encodingKeys, encodingTypes, METADATA_ENCODING_KEY, str, u8 } from './types';
+import { Payload } from '../interfaces';
+import { encodingKeys, encodingTypes, METADATA_ENCODING_KEY } from './types';
 
 /**
  * Used by the framework to serialize/deserialize data like parameters and return values.
@@ -150,13 +151,13 @@ export class CompositePayloadConverter implements PayloadConverter {
   }
 
   /**
-   * Run {@link PayloadConverterWithEncoding.fromPayload} based on the {@link encodingTypes | encoding type} of the {@link Payload}.
+   * Run {@link PayloadConverterWithEncoding.fromPayload} based on the `encoding` metadata of the {@link Payload}.
    */
   public fromPayload<T>(payload: Payload): T {
     if (payload.metadata === undefined || payload.metadata === null) {
       throw new ValueError('Missing payload metadata');
     }
-    const encoding = str(payload.metadata[METADATA_ENCODING_KEY]);
+    const encoding = decode(payload.metadata[METADATA_ENCODING_KEY]);
     const converter = this.converterByEncoding.get(encoding);
     if (converter === undefined) {
       throw new ValueError(`Unknown encoding: ${encoding}`);
@@ -234,15 +235,15 @@ export class JsonPayloadConverter implements PayloadConverterWithEncoding {
       metadata: {
         [METADATA_ENCODING_KEY]: encodingKeys.METADATA_ENCODING_JSON,
       },
-      data: u8(json),
+      data: encode(json),
     };
   }
 
   public fromPayload<T>(content: Payload): T {
     if (content.data === undefined || content.data === null) {
       throw new ValueError('Got payload with no data');
     }
-    return JSON.parse(str(content.data));
+    return JSON.parse(decode(content.data));
   }
 }
 
@@ -305,7 +306,7 @@ export class SearchAttributePayloadConverter implements PayloadConverter {
     const value = this.jsonConverter.fromPayload(payload);
     let arrayWrappedValue = value instanceof Array ? value : [value];
 
-    const searchAttributeType = str(payload.metadata.type);
+    const searchAttributeType = decode(payload.metadata.type);
     if (searchAttributeType === 'Datetime') {
       arrayWrappedValue = arrayWrappedValue.map((dateString) => new Date(dateString));
     }

packages/common/src/converter/payload-converter.ts

@@ -1,21 +1,22 @@
-import { PayloadConverterError, ValueError } from '../errors';
-import { errorMessage, hasOwnProperties, hasOwnProperty, isRecord } from '../type-helpers';
 import * as protoJsonSerializer from 'proto3-json-serializer';
 import type { Message, Namespace, Root, Type } from 'protobufjs';
+import { decode, encode } from '../encoding';
+import { PayloadConverterError, ValueError } from '../errors';
+import { Payload } from '../interfaces';
+import { errorMessage, hasOwnProperties, hasOwnProperty, isRecord } from '../type-helpers';
 import {
   BinaryPayloadConverter,
   CompositePayloadConverter,
   JsonPayloadConverter,
   PayloadConverterWithEncoding,
   UndefinedPayloadConverter,
 } from './payload-converter';
-import { Payload } from '../interfaces';
 
-import { EncodingType, encodingTypes, METADATA_ENCODING_KEY, METADATA_MESSAGE_TYPE_KEY, str, u8 } from './types';
+import { encodingTypes, METADATA_ENCODING_KEY, METADATA_MESSAGE_TYPE_KEY } from './types';
 
 abstract class ProtobufPayloadConverter implements PayloadConverterWithEncoding {
   protected readonly root: Root | undefined;
-  public abstract encodingType: EncodingType;
+  public abstract encodingType: string;
 
   public abstract toPayload<T>(value: T): Payload | undefined;
   public abstract fromPayload<T>(payload: Payload): T;
@@ -42,7 +43,7 @@ abstract class ProtobufPayloadConverter implements PayloadConverterWithEncoding
       throw new PayloadConverterError('Unable to deserialize protobuf message without `root` being provided');
     }
 
-    const messageTypeName = str(content.metadata[METADATA_MESSAGE_TYPE_KEY]);
+    const messageTypeName = decode(content.metadata[METADATA_MESSAGE_TYPE_KEY]);
     let messageType;
     try {
       messageType = this.root.lookupType(messageTypeName);
@@ -62,8 +63,8 @@ abstract class ProtobufPayloadConverter implements PayloadConverterWithEncoding
   protected constructPayload({ messageTypeName, message }: { messageTypeName: string; message: Uint8Array }): Payload {
     return {
       metadata: {
-        [METADATA_ENCODING_KEY]: u8(this.encodingType),
-        [METADATA_MESSAGE_TYPE_KEY]: u8(messageTypeName),
+        [METADATA_ENCODING_KEY]: encode(this.encodingType),
+        [METADATA_MESSAGE_TYPE_KEY]: encode(messageTypeName),
       },
       data: message,
     };
@@ -122,13 +123,13 @@ export class ProtobufJsonPayloadConverter extends ProtobufPayloadConverter {
 
     return this.constructPayload({
       messageTypeName: getNamespacedTypeName(value.$type),
-      message: u8(JSON.stringify(jsonValue)),
+      message: encode(JSON.stringify(jsonValue)),
     });
   }
 
   public fromPayload<T>(content: Payload): T {
     const { messageType, data } = this.validatePayload(content);
-    return protoJsonSerializer.fromProto3JSON(messageType, JSON.parse(str(data))) as unknown as T;
+    return protoJsonSerializer.fromProto3JSON(messageType, JSON.parse(decode(data))) as unknown as T;
   }
 }
 

packages/common/src/converter/protobuf-payload-converters.ts

@@ -1,15 +1,4 @@
-import { TextDecoder, TextEncoder } from './encoding';
-
-/**
- * Transform an *ascii* string into a Uint8Array
- */
-export function u8(s: string): Uint8Array {
-  return new TextEncoder().encode(s);
-}
-
-export function str(a: Uint8Array): string {
-  return new TextDecoder().decode(a);
-}
+import { encode } from '../encoding';
 
 export const METADATA_ENCODING_KEY = 'encoding';
 export const encodingTypes = {
@@ -22,11 +11,11 @@ export const encodingTypes = {
 export type EncodingType = typeof encodingTypes[keyof typeof encodingTypes];
 
 export const encodingKeys = {
-  METADATA_ENCODING_NULL: u8(encodingTypes.METADATA_ENCODING_NULL),
-  METADATA_ENCODING_RAW: u8(encodingTypes.METADATA_ENCODING_RAW),
-  METADATA_ENCODING_JSON: u8(encodingTypes.METADATA_ENCODING_JSON),
-  METADATA_ENCODING_PROTOBUF_JSON: u8(encodingTypes.METADATA_ENCODING_PROTOBUF_JSON),
-  METADATA_ENCODING_PROTOBUF: u8(encodingTypes.METADATA_ENCODING_PROTOBUF),
+  METADATA_ENCODING_NULL: encode(encodingTypes.METADATA_ENCODING_NULL),
+  METADATA_ENCODING_RAW: encode(encodingTypes.METADATA_ENCODING_RAW),
+  METADATA_ENCODING_JSON: encode(encodingTypes.METADATA_ENCODING_JSON),
+  METADATA_ENCODING_PROTOBUF_JSON: encode(encodingTypes.METADATA_ENCODING_PROTOBUF_JSON),
+  METADATA_ENCODING_PROTOBUF: encode(encodingTypes.METADATA_ENCODING_PROTOBUF),
 } as const;
 
 export const METADATA_MESSAGE_TYPE_KEY = 'messageType';