Skip to content

Commit

Permalink
feat: bigIntLiteral option for using BigInt literals (#1063)
Browse files Browse the repository at this point in the history
Fixes #928. Since I finally got around to contributing, I figured I'd
try this old issue out too, and it was surprisingly simple. Entirely up
to you whether to trash it or not - it's not a very consequential option
and the size optimization should probably be handled by
terser/terser#1535 anyway, and it could cause
some breakage for users.

Supercedes #932.
  • Loading branch information
bhollis authored Jun 15, 2024
1 parent db1b1a2 commit b89fbcb
Show file tree
Hide file tree
Showing 22 changed files with 1,710 additions and 63 deletions.
4 changes: 3 additions & 1 deletion README.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -551,6 +551,8 @@ Generated code will be placed in the Gradle build directory.
- With `--ts_proto_opt=comments=false`, comments won't be copied from the proto files to the generated code.
- With `--ts_proto_opt=bigIntLiteral=false`, the generated code will use `BigInt("0")` instead of `0n` for BigInt literals. BigInt literals aren't supported by TypeScript when the "target" compiler option set to something older than "ES2020".
- With `--ts_proto_opt=useNullAsOptional=true`, `undefined` values will be converted to `null`, and if you use `optional` label in your `.proto` file, the field will have `undefined` type as well. for example:
```protobuf
Expand Down Expand Up @@ -603,7 +605,7 @@ export interface User {
}
```
- With `--ts_proto_opt=noDefaultsForOptionals=true`, `undefined` primitive values will not be defaulted as per the protobuf spec. Additionally unlike the standard behavior, when a field is set to it's standard default value, it *will* be encoded allowing it to be sent over the wire and distinguished from undefined values. For example if a message does not set a boolean value, ordinarily this would be defaulted to `false` which is different to it being undefined.
- With `--ts_proto_opt=noDefaultsForOptionals=true`, `undefined` primitive values will not be defaulted as per the protobuf spec. Additionally unlike the standard behavior, when a field is set to it's standard default value, it *will* be encoded allowing it to be sent over the wire and distinguished from undefined values. For example if a message does not set a boolean value, ordinarily this would be defaulted to `false` which is different to it being undefined.
This option allows the library to act in a compatible way with the [Wire implementation](https://square.github.io/wire/) maintained and used by Square/Block. Note: this option should only be used in combination with other client/server code generated using Wire or ts-proto with this option enabled.
Expand Down
2 changes: 1 addition & 1 deletion integration/extension-import/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"compilerOptions": {
"target": "es2018",
"target": "es2020",
"lib": ["es2018"],
"module": "commonjs",
"strict": true,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,12 +14,12 @@ export interface FieldOption {
}

function createBaseFieldOption(): FieldOption {
return { normalField: BigInt("0"), numberField: 0, stringField: "0" };
return { normalField: 0n, numberField: 0, stringField: "0" };
}

export const FieldOption = {
encode(message: FieldOption, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
if (message.normalField !== BigInt("0")) {
if (message.normalField !== 0n) {
if (BigInt.asIntN(64, message.normalField) !== message.normalField) {
throw new globalThis.Error("value provided for field message.normalField of type int64 too large");
}
Expand Down Expand Up @@ -79,15 +79,15 @@ export const FieldOption = {

fromJSON(object: any): FieldOption {
return {
normalField: isSet(object.normalField) ? BigInt(object.normalField) : BigInt("0"),
normalField: isSet(object.normalField) ? BigInt(object.normalField) : 0n,
numberField: isSet(object.numberField) ? globalThis.Number(object.numberField) : 0,
stringField: isSet(object.stringField) ? globalThis.String(object.stringField) : "0",
};
},

toJSON(message: FieldOption): unknown {
const obj: any = {};
if (message.normalField !== BigInt("0")) {
if (message.normalField !== 0n) {
obj.normalField = message.normalField.toString();
}
if (message.numberField !== 0) {
Expand All @@ -104,7 +104,7 @@ export const FieldOption = {
},
fromPartial<I extends Exact<DeepPartial<FieldOption>, I>>(object: I): FieldOption {
const message = createBaseFieldOption();
message.normalField = object.normalField ?? BigInt("0");
message.normalField = object.normalField ?? 0n;
message.numberField = object.numberField ?? 0;
message.stringField = object.stringField ?? "0";
return message;
Expand Down
19 changes: 8 additions & 11 deletions integration/map-bigint-optional/test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -127,18 +127,18 @@ export const MapBigInt = {
};

function createBaseMapBigInt_MapEntry(): MapBigInt_MapEntry {
return { key: BigInt("0"), value: BigInt("0") };
return { key: 0n, value: 0n };
}

export const MapBigInt_MapEntry = {
encode(message: MapBigInt_MapEntry, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
if (message.key !== BigInt("0")) {
if (message.key !== 0n) {
if (BigInt.asUintN(64, message.key) !== message.key) {
throw new globalThis.Error("value provided for field message.key of type fixed64 too large");
}
writer.uint32(9).fixed64(message.key.toString());
}
if (message.value !== BigInt("0")) {
if (message.value !== 0n) {
if (BigInt.asIntN(64, message.value) !== message.value) {
throw new globalThis.Error("value provided for field message.value of type int64 too large");
}
Expand Down Expand Up @@ -205,18 +205,15 @@ export const MapBigInt_MapEntry = {
},

fromJSON(object: any): MapBigInt_MapEntry {
return {
key: isSet(object.key) ? BigInt(object.key) : BigInt("0"),
value: isSet(object.value) ? BigInt(object.value) : BigInt("0"),
};
return { key: isSet(object.key) ? BigInt(object.key) : 0n, value: isSet(object.value) ? BigInt(object.value) : 0n };
},

toJSON(message: MapBigInt_MapEntry): unknown {
const obj: any = {};
if (message.key !== BigInt("0")) {
if (message.key !== 0n) {
obj.key = message.key.toString();
}
if (message.value !== BigInt("0")) {
if (message.value !== 0n) {
obj.value = message.value.toString();
}
return obj;
Expand All @@ -227,8 +224,8 @@ export const MapBigInt_MapEntry = {
},
fromPartial<I extends Exact<DeepPartial<MapBigInt_MapEntry>, I>>(object: I): MapBigInt_MapEntry {
const message = createBaseMapBigInt_MapEntry();
message.key = object.key ?? BigInt("0");
message.value = object.value ?? BigInt("0");
message.key = object.key ?? 0n;
message.value = object.value ?? 0n;
return message;
},
};
Expand Down
5 changes: 5 additions & 0 deletions integration/pbjs.sh
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,11 @@ if match "simple-long-bigint"; then
yarn run pbts --no-comments -o integration/simple-long-bigint/pbjs.d.ts integration/simple-long-bigint/pbjs.js
fi

if match "simple-long-bigint-noliteral"; then
yarn run pbjs --force-message --force-long -t static-module -o integration/simple-long-bigint-noliteral/pbjs.js integration/simple-long-bigint-noliteral/simple.proto
yarn run pbts --no-comments -o integration/simple-long-bigint-noliteral/pbjs.d.ts integration/simple-long-bigint-noliteral/pbjs.js
fi

if match "vector-tile"; then
yarn run pbjs --force-message --force-number -t static-module -o integration/vector-tile/pbjs.js integration/vector-tile/vector_tile.proto
yarn run pbts --no-comments -o integration/vector-tile/pbjs.d.ts integration/vector-tile/pbjs.js
Expand Down
2 changes: 1 addition & 1 deletion integration/simple-esmodule-interop/tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"compilerOptions": {
"target": "es2018",
"target": "es2020",
"lib": ["es2018"],
"module": "commonjs",
"strict": true,
Expand Down
217 changes: 217 additions & 0 deletions integration/simple-long-bigint-noliteral/google/protobuf/timestamp.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,217 @@
// Code generated by protoc-gen-ts_proto. DO NOT EDIT.
// source: google/protobuf/timestamp.proto

/* eslint-disable */
import * as _m0 from "protobufjs/minimal";
import Long = require("long");

export const protobufPackage = "google.protobuf";

/**
* A Timestamp represents a point in time independent of any time zone or local
* calendar, encoded as a count of seconds and fractions of seconds at
* nanosecond resolution. The count is relative to an epoch at UTC midnight on
* January 1, 1970, in the proleptic Gregorian calendar which extends the
* Gregorian calendar backwards to year one.
*
* All minutes are 60 seconds long. Leap seconds are "smeared" so that no leap
* second table is needed for interpretation, using a [24-hour linear
* smear](https://developers.google.com/time/smear).
*
* The range is from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z. By
* restricting to that range, we ensure that we can convert to and from [RFC
* 3339](https://www.ietf.org/rfc/rfc3339.txt) date strings.
*
* # Examples
*
* Example 1: Compute Timestamp from POSIX `time()`.
*
* Timestamp timestamp;
* timestamp.set_seconds(time(NULL));
* timestamp.set_nanos(0);
*
* Example 2: Compute Timestamp from POSIX `gettimeofday()`.
*
* struct timeval tv;
* gettimeofday(&tv, NULL);
*
* Timestamp timestamp;
* timestamp.set_seconds(tv.tv_sec);
* timestamp.set_nanos(tv.tv_usec * 1000);
*
* Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
*
* FILETIME ft;
* GetSystemTimeAsFileTime(&ft);
* UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
*
* // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
* // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
* Timestamp timestamp;
* timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
* timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
*
* Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
*
* long millis = System.currentTimeMillis();
*
* Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
* .setNanos((int) ((millis % 1000) * 1000000)).build();
*
* Example 5: Compute Timestamp from Java `Instant.now()`.
*
* Instant now = Instant.now();
*
* Timestamp timestamp =
* Timestamp.newBuilder().setSeconds(now.getEpochSecond())
* .setNanos(now.getNano()).build();
*
* Example 6: Compute Timestamp from current time in Python.
*
* timestamp = Timestamp()
* timestamp.GetCurrentTime()
*
* # JSON Mapping
*
* In JSON format, the Timestamp type is encoded as a string in the
* [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
* format is "{year}-{month}-{day}T{hour}:{min}:{sec}[.{frac_sec}]Z"
* where {year} is always expressed using four digits while {month}, {day},
* {hour}, {min}, and {sec} are zero-padded to two digits each. The fractional
* seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
* are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
* is required. A proto3 JSON serializer should always use UTC (as indicated by
* "Z") when printing the Timestamp type and a proto3 JSON parser should be
* able to accept both UTC and other timezones (as indicated by an offset).
*
* For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
* 01:30 UTC on January 15, 2017.
*
* In JavaScript, one can convert a Date object to this format using the
* standard
* [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
* method. In Python, a standard `datetime.datetime` object can be converted
* to this format using
* [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
* the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
* the Joda Time's [`ISODateTimeFormat.dateTime()`](
* http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
* ) to obtain a formatter capable of generating timestamps in this format.
*/
export interface Timestamp {
/**
* Represents seconds of UTC time since Unix epoch
* 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
* 9999-12-31T23:59:59Z inclusive.
*/
seconds: bigint;
/**
* Non-negative fractions of a second at nanosecond resolution. Negative
* second values with fractions must still have non-negative nanos values
* that count forward in time. Must be from 0 to 999,999,999
* inclusive.
*/
nanos: number;
}

function createBaseTimestamp(): Timestamp {
return { seconds: BigInt("0"), nanos: 0 };
}

export const Timestamp = {
encode(message: Timestamp, writer: _m0.Writer = _m0.Writer.create()): _m0.Writer {
if (message.seconds !== BigInt("0")) {
if (BigInt.asIntN(64, message.seconds) !== message.seconds) {
throw new globalThis.Error("value provided for field message.seconds of type int64 too large");
}
writer.uint32(8).int64(message.seconds.toString());
}
if (message.nanos !== 0) {
writer.uint32(16).int32(message.nanos);
}
return writer;
},

decode(input: _m0.Reader | Uint8Array, length?: number): Timestamp {
const reader = input instanceof _m0.Reader ? input : _m0.Reader.create(input);
let end = length === undefined ? reader.len : reader.pos + length;
const message = createBaseTimestamp();
while (reader.pos < end) {
const tag = reader.uint32();
switch (tag >>> 3) {
case 1:
if (tag !== 8) {
break;
}

message.seconds = longToBigint(reader.int64() as Long);
continue;
case 2:
if (tag !== 16) {
break;
}

message.nanos = reader.int32();
continue;
}
if ((tag & 7) === 4 || tag === 0) {
break;
}
reader.skipType(tag & 7);
}
return message;
},

fromJSON(object: any): Timestamp {
return {
seconds: isSet(object.seconds) ? BigInt(object.seconds) : BigInt("0"),
nanos: isSet(object.nanos) ? globalThis.Number(object.nanos) : 0,
};
},

toJSON(message: Timestamp): unknown {
const obj: any = {};
if (message.seconds !== BigInt("0")) {
obj.seconds = message.seconds.toString();
}
if (message.nanos !== 0) {
obj.nanos = Math.round(message.nanos);
}
return obj;
},

create<I extends Exact<DeepPartial<Timestamp>, I>>(base?: I): Timestamp {
return Timestamp.fromPartial(base ?? ({} as any));
},
fromPartial<I extends Exact<DeepPartial<Timestamp>, I>>(object: I): Timestamp {
const message = createBaseTimestamp();
message.seconds = object.seconds ?? BigInt("0");
message.nanos = object.nanos ?? 0;
return message;
},
};

type Builtin = Date | Function | Uint8Array | string | number | boolean | bigint | undefined;

export type DeepPartial<T> = T extends Builtin ? T
: T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>>
: T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>>
: T extends {} ? { [K in keyof T]?: DeepPartial<T[K]> }
: Partial<T>;

type KeysOfUnion<T> = T extends T ? keyof T : never;
export type Exact<P, I extends P> = P extends Builtin ? P
: P & { [K in keyof P]: Exact<P[K], I[K]> } & { [K in Exclude<keyof I, KeysOfUnion<P>>]: never };

function longToBigint(long: Long) {
return BigInt(long.toString());
}

if (_m0.util.Long !== Long) {
_m0.util.Long = Long as any;
_m0.configure();
}

function isSet(value: any): boolean {
return value !== null && value !== undefined;
}
Loading

0 comments on commit b89fbcb

Please sign in to comment.