Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Remove internal usage of deprecated function in @bufbuild/protoplugin #714

Merged
merged 2 commits into from
Feb 13, 2024
Merged

Remove internal usage of deprecated function in @bufbuild/protoplugin #714

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ec19f80
Remove internal usage of deprecated function in @bufbuild/protoplugin
timostamm Feb 12, 2024
75fe044
Add tests
timostamm Feb 12, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/protoc-gen-es/src/declaration.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ function generateOneof(schema: Schema, f: GeneratedFile, oneof: DescOneof) {
f.print(` } | {`);
}
f.print(f.jsDoc(field, " "));
const { typing } = getFieldTypeInfo(field, f);
const { typing } = getFieldTypeInfo(field);
f.print(` value: `, typing, `;`);
f.print(` case: "`, localName(field), `";`);
}
Expand All @@ -135,7 +135,7 @@ function generateOneof(schema: Schema, f: GeneratedFile, oneof: DescOneof) {
function generateField(schema: Schema, f: GeneratedFile, field: DescField) {
f.print(f.jsDoc(field, " "));
const e: Printable = [];
const { typing, optional } = getFieldTypeInfo(field, f);
const { typing, optional } = getFieldTypeInfo(field);
if (!optional) {
e.push(" ", localName(field), ": ", typing, ";");
} else {
Expand All @@ -150,7 +150,7 @@ function generateExtension(
f: GeneratedFile,
ext: DescExtension,
) {
const { typing } = getFieldTypeInfo(ext, f);
const { typing } = getFieldTypeInfo(ext);
f.print(f.jsDoc(ext));
f.print(f.exportDecl("declare const", ext), ": ", schema.runtime.Extension, "<", ext.extendee, ", ", typing, ">;");
f.print();
Expand Down Expand Up @@ -230,7 +230,7 @@ function generateWktStaticMethods(schema: Schema, f: GeneratedFile, message: Des
case "google.protobuf.BoolValue":
case "google.protobuf.StringValue":
case "google.protobuf.BytesValue": {
const {typing} = getFieldTypeInfo(ref.value, f);
const {typing} = getFieldTypeInfo(ref.value);
f.print(" static readonly fieldWrapper: {")
f.print(" wrapField(value: ", typing, "): ", message, ",")
f.print(" unwrapField(value: ", message, "): ", typing, ",")
Expand Down
5 changes: 1 addition & 4 deletions packages/protoc-gen-es/src/javascript.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,7 @@ export function getFieldInfoLiteral(schema: Schema, field: DescField | DescExten
} else if (field.proto.label === FieldDescriptorProto_Label.REQUIRED) {
e.push(`req: true, `);
}
const defaultValue = getFieldDefaultValueExpression(field, {
enumAs: "enum_value_ref",
protoInt64Symbol: schema.runtime.protoInt64,
});
const defaultValue = getFieldDefaultValueExpression(field);
if (defaultValue !== undefined) {
e.push(`default: `, defaultValue, `, `);
}
Expand Down
13 changes: 5 additions & 8 deletions packages/protoc-gen-es/src/typescript.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -148,7 +148,7 @@ function generateOneof(schema: Schema, f: GeneratedFile, oneof: DescOneof) {
f.print(` } | {`);
}
f.print(f.jsDoc(field, " "));
const { typing } = getFieldTypeInfo(field, f);
const { typing } = getFieldTypeInfo(field);
f.print(` value: `, typing, `;`);
f.print(` case: "`, localName(field), `";`);
}
Expand All @@ -159,7 +159,7 @@ function generateOneof(schema: Schema, f: GeneratedFile, oneof: DescOneof) {
function generateField(schema: Schema, f: GeneratedFile, field: DescField) {
f.print(f.jsDoc(field, " "));
const e: Printable = [];
const { typing, optional, typingInferrableFromZeroValue } = getFieldTypeInfo(field, f);
const { typing, optional, typingInferrableFromZeroValue } = getFieldTypeInfo(field);
if (optional) {
e.push(" ", localName(field), "?: ", typing, ";");
} else {
Expand All @@ -168,10 +168,7 @@ function generateField(schema: Schema, f: GeneratedFile, field: DescField) {
} else {
e.push(" ", localName(field), ": ", typing);
}
const zeroValue = getFieldZeroValueExpression(field, {
enumAs: "enum_value_ref",
protoInt64Symbol: schema.runtime.protoInt64,
});
const zeroValue = getFieldZeroValueExpression(field);
if (zeroValue !== undefined) {
e.push(" = ", zeroValue);
}
Expand All @@ -187,7 +184,7 @@ function generateExtension(
ext: DescExtension,
) {
const protoN = getNonEditionRuntime(schema, ext.file);
const { typing } = getFieldTypeInfo(ext, f);
const { typing } = getFieldTypeInfo(ext);
f.print(f.jsDoc(ext));
f.print(f.exportDecl("const", ext), " = ", protoN, ".makeExtension<", ext.extendee, ", ", typing, ">(");
f.print(" ", f.string(ext.typeName), ", ");
Expand Down Expand Up @@ -654,7 +651,7 @@ function generateWktStaticMethods(schema: Schema, f: GeneratedFile, message: Des
case "google.protobuf.BoolValue":
case "google.protobuf.StringValue":
case "google.protobuf.BytesValue": {
const {typing} = getFieldTypeInfo(ref.value, f);
const {typing} = getFieldTypeInfo(ref.value);
f.print(" static readonly fieldWrapper = {")
f.print(" wrapField(value: ", typing, "): ", message, " {")
f.print(" return new ", message, "({value});")
Expand Down
128 changes: 64 additions & 64 deletions packages/protoc-gen-es/src/util.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,26 +14,18 @@

import {
codegenInfo,
DescEnum,
DescEnumValue,
DescExtension,
DescField,
DescMessage,
FieldDescriptorProto_Label,
LongType,
protoInt64,
ScalarType,
ScalarValue,
} from "@bufbuild/protobuf";
import type { Printable } from "@bufbuild/protoplugin/ecmascript";
import { literalString, localName } from "@bufbuild/protoplugin/ecmascript";
import type { ImportSymbol } from "@bufbuild/protoplugin/src/ecmascript";
import { localName } from "@bufbuild/protoplugin/ecmascript";

export function getFieldTypeInfo(
field: DescField | DescExtension,
opt: {
import: (desc: DescEnum | DescMessage) => ImportSymbol;
},
): {
export function getFieldTypeInfo(field: DescField | DescExtension): {
typing: Printable;
optional: boolean;
typingInferrableFromZeroValue: boolean;
Expand All @@ -54,14 +46,22 @@ export function getFieldTypeInfo(
if (baseType !== undefined) {
typing.push(scalarTypeScriptType(baseType, LongType.BIGINT));
} else {
typing.push(opt.import(field.message).toTypeOnly());
typing.push({
kind: "es_ref_message",
type: field.message,
typeOnly: true,
});
}
optional = true;
typingInferrableFromZeroValue = true;
break;
}
case "enum":
typing.push(opt.import(field.enum).toTypeOnly());
typing.push({
kind: "es_ref_enum",
type: field.enum,
typeOnly: true,
});
optional =
field.optional ||
field.proto.label === FieldDescriptorProto_Label.REQUIRED;
Expand All @@ -81,7 +81,7 @@ export function getFieldTypeInfo(
keyType = "string";
break;
}
let valueType;
let valueType: Printable;
switch (field.mapValue.kind) {
case "scalar":
valueType = scalarTypeScriptType(
Expand All @@ -90,10 +90,18 @@ export function getFieldTypeInfo(
);
break;
case "message":
valueType = opt.import(field.mapValue.message).toTypeOnly();
valueType = {
kind: "es_ref_message",
type: field.mapValue.message,
typeOnly: true,
};
break;
case "enum":
valueType = opt.import(field.mapValue.enum).toTypeOnly();
valueType = {
kind: "es_ref_enum",
type: field.mapValue.enum,
typeOnly: true,
};
break;
}
typing.push("{ [key: ", keyType, "]: ", valueType, " }");
Expand All @@ -110,25 +118,16 @@ export function getFieldTypeInfo(
return { typing, optional, typingInferrableFromZeroValue };
}

type GetFieldExpressionOptions =
| {
enumAs: "enum_value_ref" | "enum_value_integer";
importEnum?: (desc: DescEnum) => ImportSymbol;
protoInt64Symbol: ImportSymbol;
}
| {
enumAs: "enum_value_integer_as_ref";
importEnum: (desc: DescEnum) => ImportSymbol;
protoInt64Symbol: ImportSymbol;
};

/**
* Return a printable expression for the default value of a field.
* Only applicable for singular scalar and enum fields.
*/
export function getFieldDefaultValueExpression(
field: DescField | DescExtension,
opt: GetFieldExpressionOptions,
enumAs:
| "enum_value_as_is"
| "enum_value_as_integer"
| "enum_value_as_cast_integer" = "enum_value_as_is",
): Printable | undefined {
if (field.repeated) {
return undefined;
Expand All @@ -150,10 +149,10 @@ export function getFieldDefaultValueExpression(
`invalid enum default value: ${String(defaultValue)} for ${enumValue}`,
);
}
return literalEnumValue(enumValue, opt);
return literalEnumValue(enumValue, enumAs);
}
case "scalar":
return literalScalarValue(defaultValue, field, opt.protoInt64Symbol);
return literalScalarValue(defaultValue, field);
}
}

Expand All @@ -169,7 +168,10 @@ export function getFieldDefaultValueExpression(
*/
export function getFieldZeroValueExpression(
field: DescField | DescExtension,
opt: GetFieldExpressionOptions,
enumAs:
| "enum_value_as_is"
| "enum_value_as_integer"
| "enum_value_as_cast_integer" = "enum_value_as_is",
): Printable | undefined {
if (field.repeated) {
return "[]";
Expand All @@ -186,22 +188,21 @@ export function getFieldZeroValueExpression(
throw new Error("invalid enum: missing at least one value");
}
const zeroValue = field.enum.values[0];
return literalEnumValue(zeroValue, opt);
return literalEnumValue(zeroValue, enumAs);
}
case "scalar": {
const defaultValue = codegenInfo.scalarDefaultValue(
const defaultValue = codegenInfo.scalarZeroValue(
field.scalar,
field.longType,
) as string | boolean | number | bigint | Uint8Array;
return literalScalarValue(defaultValue, field, opt.protoInt64Symbol);
);
return literalScalarValue(defaultValue, field);
}
}
}

function literalScalarValue(
value: string | number | bigint | boolean | Uint8Array,
value: ScalarValue,
field: (DescField | DescExtension) & { fieldKind: "scalar" },
protoInt64Symbol: ImportSymbol,
): Printable {
switch (field.scalar) {
case ScalarType.DOUBLE:
Expand Down Expand Up @@ -230,7 +231,7 @@ function literalScalarValue(
`Unexpected value for ${ScalarType[field.scalar]} ${field.toString()}: ${String(value)}`,
);
}
return literalString(value);
return { kind: "es_string", value };
case ScalarType.BYTES:
if (!(value instanceof Uint8Array)) {
throw new Error(
Expand All @@ -243,36 +244,35 @@ function literalScalarValue(
case ScalarType.SFIXED64:
case ScalarType.UINT64:
case ScalarType.FIXED64:
switch (typeof value) {
case "bigint":
if (value == protoInt64.zero) {
return [protoInt64Symbol, ".zero"];
}
switch (field.scalar) {
case ScalarType.UINT64:
case ScalarType.FIXED64:
return [protoInt64Symbol, `.uParse("${value.toString()}")`];
default:
return [protoInt64Symbol, `.parse("${value.toString()}")`];
}
case "string":
return literalString(value);
default:
throw new Error(
`Unexpected value for ${ScalarType[field.scalar]} ${field.toString()}: ${String(value)}`,
);
if (typeof value != "bigint" && typeof value != "string") {
throw new Error(
`Unexpected value for ${ScalarType[field.scalar]} ${field.toString()}: ${String(value)}`,
);
}
return {
kind: "es_proto_int64",
type: field.scalar,
longType: field.longType,
value,
};
}
}

function literalEnumValue(
value: DescEnumValue,
opt: GetFieldExpressionOptions,
enumAs:
| "enum_value_as_is"
| "enum_value_as_integer"
| "enum_value_as_cast_integer",
): Printable {
switch (opt.enumAs) {
case "enum_value_ref":
return [value.parent, ".", localName(value)];
case "enum_value_integer":
switch (enumAs) {
case "enum_value_as_is":
return [
{ kind: "es_ref_enum", type: value.parent, typeOnly: false },
".",
localName(value),
];
case "enum_value_as_integer":
return [
value.number,
" /* ",
Expand All @@ -281,11 +281,11 @@ function literalEnumValue(
value.name,
" */",
];
case "enum_value_integer_as_ref":
case "enum_value_as_cast_integer":
return [
value.number,
" as ",
opt.importEnum(value.parent).toTypeOnly(),
{ kind: "es_ref_enum", type: value.parent, typeOnly: true },
".",
localName(value),
];
Expand Down
Loading
Loading