mirror of
https://github.com/lukaszraczylo/go-telegram.git
synced 2026-06-11 23:19:31 +00:00
refactor(api): typed enums for emoji-list fields (DiceEmoji, ReactionEmoji)
Two API fields carry restricted emoji-value sets that the scraper's
curly-quote regex strips during IR extraction (multi-byte boundary
issue): ReactionTypeEmoji.Emoji and sendDice.Emoji. They previously
typed as plain string with no compile-time guarantee on values.
Add hand-curated typed-string enums in api/enums.go (the manual file,
not enums.gen.go):
- DiceEmoji: 6 constants (Dice, Dart, Basketball, Football, Bowling,
SlotMachine) covering Telegram's full set for sendDice.
- ReactionEmoji: 73 constants covering the canonical reaction set
from https://core.telegram.org/bots/api#reactiontypeemoji. Names
follow Unicode CLDR short names where one exists, otherwise stable
common-English labels (e.g. ThumbsUp, Heart, Clown, ManTechnologist).
Wire the field-type override via cmd/genapi/emitter.go:
- fieldTypeOverrides map keyed "<TypeOrParamsName>.<FieldName>".
- goField/multipartFieldEntry consult the override after the enum-plan
lookup; falls through to the default goType when nothing matches.
- methods.tmpl gains goFieldP/multipartFieldEntryP helpers that pass
the params type name as override-parent (the params struct doesn't
share a Go type with the field, so the existing parent="" enum-key
convention is preserved).
Regenerated api/types.gen.go and api/methods.gen.go now type the two
fields as ReactionEmoji and DiceEmoji respectively. No other Emoji
field is affected (override is scoped per parent type). regen-from-
fixture is byte-deterministic across runs.
Add api/emoji_enums_test.go covering const wire values, reflection
checks on field types, and a marshal/unmarshal round-trip for
ReactionTypeEmoji.
This commit is contained in:
+57
-3
@@ -46,6 +46,30 @@ var runtimeTypes = map[string]bool{
|
||||
"MessageOrBool": true,
|
||||
}
|
||||
|
||||
// fieldTypeOverrides maps "<TypeOrParamsName>.<FieldName>" → Go type expression.
|
||||
// Used for fields whose values are restricted but whose enum the scraper
|
||||
// can't detect (Telegram's curly-quoted emoji literals are routinely
|
||||
// stripped by the scraper's regex due to byte-boundary issues with
|
||||
// multi-byte sequences). The hand-curated typed-string enum lives in
|
||||
// api/enums.go (manual file); this override just retypes the field so
|
||||
// callers get IDE completion and compile-time checks. Generated fields
|
||||
// stay typed even after `make regen`.
|
||||
var fieldTypeOverrides = map[string]string{
|
||||
"ReactionTypeEmoji.Emoji": "ReactionEmoji",
|
||||
"SendDiceParams.Emoji": "DiceEmoji",
|
||||
}
|
||||
|
||||
// fieldTypeOverride returns the override type for a (parent, fieldName)
|
||||
// pair, or "" if none. parent is the Go type name owning the field —
|
||||
// either a struct type (e.g. "ReactionTypeEmoji") or a method-params
|
||||
// type (e.g. "SendDiceParams").
|
||||
func fieldTypeOverride(parent, fieldName string) string {
|
||||
if parent == "" {
|
||||
return ""
|
||||
}
|
||||
return fieldTypeOverrides[parent+"."+fieldName]
|
||||
}
|
||||
|
||||
// discriminatorSpec describes how to decode a sealed-interface union by
|
||||
// peeking at a single JSON field.
|
||||
type discriminatorSpec struct {
|
||||
@@ -395,6 +419,9 @@ func funcs(plan *enumPlan) template.FuncMap {
|
||||
"goField": func(parent string, f spec.Field) string {
|
||||
return goField(plan, parent, f)
|
||||
},
|
||||
"goFieldP": func(methodName string, f spec.Field) string {
|
||||
return goFieldX(plan, "", title(methodName)+"Params", f)
|
||||
},
|
||||
"docComment": docComment,
|
||||
"isOptional": func(f spec.Field) bool { return !f.Required },
|
||||
"not": func(b bool) bool { return !b },
|
||||
@@ -404,6 +431,9 @@ func funcs(plan *enumPlan) template.FuncMap {
|
||||
"multipartFieldEntry": func(parent string, f spec.Field) string {
|
||||
return multipartFieldEntry(plan, parent, f)
|
||||
},
|
||||
"multipartFieldEntryP": func(methodName string, f spec.Field) string {
|
||||
return multipartFieldEntryX(plan, "", title(methodName)+"Params", f)
|
||||
},
|
||||
"multipartFileEntry": multipartFileEntry,
|
||||
"returnGoType": returnGoType,
|
||||
// enum helpers
|
||||
@@ -503,7 +533,17 @@ func multipartFileEntry(f spec.Field) string {
|
||||
// when non-zero/non-empty. Typed-string enum fields are cast to string
|
||||
// before assignment because the multipart map is map[string]string.
|
||||
func multipartFieldEntry(plan *enumPlan, parent string, f spec.Field) string {
|
||||
enumName := plan.FieldEnum(parent, f.Name)
|
||||
return multipartFieldEntryX(plan, parent, parent, f)
|
||||
}
|
||||
|
||||
// multipartFieldEntryX mirrors goFieldX: enumParent keys the enum plan,
|
||||
// overrideParent keys fieldTypeOverrides. They differ only for method
|
||||
// params.
|
||||
func multipartFieldEntryX(plan *enumPlan, enumParent, overrideParent string, f spec.Field) string {
|
||||
enumName := plan.FieldEnum(enumParent, f.Name)
|
||||
if enumName == "" {
|
||||
enumName = fieldTypeOverride(overrideParent, f.Name)
|
||||
}
|
||||
switch f.Type.Kind {
|
||||
case spec.KindPrimitive:
|
||||
switch f.Type.Name {
|
||||
@@ -775,10 +815,24 @@ func matchesVariants(got []string, want ...string) bool {
|
||||
// has a planned enum name for (parent, field), the field's Go type is
|
||||
// the enum identifier. Typed-string enums use the zero string ""
|
||||
// behaviour for omitempty, so we do not pointer-wrap optional enum
|
||||
// fields. Parent is "" for method parameters.
|
||||
// fields. Parent is "" for method parameters; pass the params type
|
||||
// name (e.g. "SendDiceParams") via overrideParent when calling from
|
||||
// the methods template so fieldTypeOverrides can resolve.
|
||||
func goField(plan *enumPlan, parent string, f spec.Field) string {
|
||||
return goFieldX(plan, parent, parent, f)
|
||||
}
|
||||
|
||||
// goFieldX is the underlying field-emitter. enumParent is used for the
|
||||
// enum-plan lookup (which keys method params under ""); overrideParent
|
||||
// is used for fieldTypeOverrides (which keys method params under the
|
||||
// params type name). For struct types both are the same; for method
|
||||
// params they differ.
|
||||
func goFieldX(plan *enumPlan, enumParent, overrideParent string, f spec.Field) string {
|
||||
tag := fmt.Sprintf("`json:%q`", f.JSONName+omitempty(f))
|
||||
if name := plan.FieldEnum(parent, f.Name); name != "" {
|
||||
if name := plan.FieldEnum(enumParent, f.Name); name != "" {
|
||||
return fmt.Sprintf("%s %s %s", f.Name, name, tag)
|
||||
}
|
||||
if name := fieldTypeOverride(overrideParent, f.Name); name != "" {
|
||||
return fmt.Sprintf("%s %s %s", f.Name, name, tag)
|
||||
}
|
||||
return fmt.Sprintf("%s %s %s", f.Name, goType(f.Type, !f.Required), tag)
|
||||
|
||||
@@ -15,12 +15,12 @@ import (
|
||||
var _ = strconv.Itoa // keep import for multipart helpers
|
||||
var _ = json.Marshal // keep import for complex multipart fields
|
||||
|
||||
{{range .Methods}}
|
||||
{{range .Methods}}{{$methodName := .Name}}
|
||||
// {{title .Name}}Params is the parameter set for {{title .Name}}.
|
||||
//
|
||||
{{docComment .Doc -}}
|
||||
type {{title .Name}}Params struct {
|
||||
{{range .Params}}{{docComment .Doc}} {{goField "" .}}
|
||||
{{range .Params}}{{docComment .Doc}} {{goFieldP $methodName .}}
|
||||
{{end}}}
|
||||
{{if .HasFiles}}
|
||||
// HasFile reports whether a multipart upload is required.
|
||||
@@ -31,7 +31,7 @@ func (p *{{title .Name}}Params) HasFile() bool {
|
||||
// MultipartFields returns the non-file fields used in the multipart body.
|
||||
func (p *{{title .Name}}Params) MultipartFields() map[string]string {
|
||||
out := map[string]string{}
|
||||
{{range .Params}}{{if not (isFileField .)}}{{multipartFieldEntry "" .}}{{end}}{{end}} return out
|
||||
{{range .Params}}{{if not (isFileField .)}}{{multipartFieldEntryP $methodName .}}{{end}}{{end}} return out
|
||||
}
|
||||
|
||||
// MultipartFiles returns the file parts.
|
||||
|
||||
Reference in New Issue
Block a user