Skip to content

Centralize protobuf scalar initialization #1313

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

Merged
jwils merged 1 commit into from
Jul 20, 2026
Merged

Centralize protobuf scalar initialization #1313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
25 changes: 2 additions & 23 deletions ...-proto_ingestion/lib/elastic_graph/proto_ingestion/schema_definition/factory_extension.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,23 +18,6 @@ module ProtoIngestion
module SchemaDefinition
# Extension module applied to Factory to add proto support.
module FactoryExtension
# Default protobuf types applied to ElasticGraph's built-in scalar types as they are constructed.
BUILT_IN_SCALAR_PROTO_TYPES_BY_NAME = {
"Boolean" => "bool",
"Cursor" => "string",
"Date" => "string",
"DateTime" => "string",
"Float" => "double",
"ID" => "string",
"Int" => "int32",
"JsonSafeLong" => "int64",
"LocalTime" => "string",
"LongString" => "int64",
"String" => "string",
"TimeZone" => "string",
"Untyped" => "string"
}.freeze

# Creates a new enum type with proto extensions.
#
# @param name [String] enum type name
Expand Down Expand Up @@ -92,13 +75,9 @@ def new_object_type(name)
def new_scalar_type(name)
super(name) do |type|
extended_type = type.extend(SchemaElements::ScalarTypeExtension) # : ::ElasticGraph::SchemaDefinition::SchemaElements::ScalarType & SchemaElements::ScalarTypeExtension

if (proto_type = BUILT_IN_SCALAR_PROTO_TYPES_BY_NAME[name.to_s])
extended_type.protobuf type: proto_type
extended_type.initialize_proto_extension do
yield extended_type if block_given?
end

yield extended_type if block_given?
extended_type.finalize_protobuf_configuration!
end
end

Expand Down
32 changes: 28 additions & 4 deletions .../elastic_graph/proto_ingestion/schema_definition/schema_elements/scalar_type_extension.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,23 @@ module SchemaDefinition
module SchemaElements
# Extends ScalarType with proto field type conversion.
module ScalarTypeExtension
# Default protobuf types applied to ElasticGraph's built-in scalar types as they are constructed.
BUILT_IN_SCALAR_PROTO_TYPES_BY_NAME = {
"Boolean" => "bool",
"Cursor" => "string",
"Date" => "string",
"DateTime" => "string",
"Float" => "double",
"ID" => "string",
"Int" => "int32",
"JsonSafeLong" => "int64",
"LocalTime" => "string",
"LongString" => "int64",
"String" => "string",
"TimeZone" => "string",
"Untyped" => "string"
}.freeze

# Configured protobuf type (e.g. string, int64, bool).
# @dynamic protobuf_type
attr_reader :protobuf_type
Expand All @@ -26,13 +43,20 @@ def protobuf(type:)
@protobuf_type = type
end

# Validates that a protobuf type has been configured on this scalar type. GraphQL-only
# scalar types are skipped because they are not part of ingestion.
# Applies any built-in protobuf type, yields for further configuration, and validates the result.
#
# @yield additional scalar type configuration
# @return [void]
# @raise [Errors::SchemaError] when missing
def finalize_protobuf_configuration!
# @raise [Errors::SchemaError] when a protobuf type is missing
def initialize_proto_extension
original_name = type_ref.with_reverted_override.name
if (proto_type = BUILT_IN_SCALAR_PROTO_TYPES_BY_NAME[original_name])
protobuf type: proto_type
end

yield
return if graphql_only?

proto_name
nil
end
Expand Down
2 changes: 0 additions & 2 deletions ...proto_ingestion/sig/elastic_graph/proto_ingestion/schema_definition/factory_extension.rbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,6 @@ module ElasticGraph
module ProtoIngestion
module SchemaDefinition
module FactoryExtension: ::ElasticGraph::SchemaDefinition::Factory
BUILT_IN_SCALAR_PROTO_TYPES_BY_NAME: ::Hash[::String, ::String]

def new_enum_type: (::String) ?{ (::ElasticGraph::SchemaDefinition::SchemaElements::EnumType & SchemaElements::EnumTypeExtension) -> void } -> (::ElasticGraph::SchemaDefinition::SchemaElements::EnumType & SchemaElements::EnumTypeExtension)
def new_enum_value: (::String, ::String) ?{ (::ElasticGraph::SchemaDefinition::SchemaElements::EnumValue & SchemaElements::EnumValueExtension) -> void } -> (::ElasticGraph::SchemaDefinition::SchemaElements::EnumValue & SchemaElements::EnumValueExtension)
def new_interface_type: (::String) ?{ (::ElasticGraph::SchemaDefinition::SchemaElements::InterfaceType & SchemaElements::ObjectInterfaceAndUnionExtension) -> void } -> (::ElasticGraph::SchemaDefinition::SchemaElements::InterfaceType & SchemaElements::ObjectInterfaceAndUnionExtension)
Expand Down
4 changes: 3 additions & 1 deletion ...elastic_graph/proto_ingestion/schema_definition/schema_elements/scalar_type_extension.rbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,12 @@ module ElasticGraph
module SchemaDefinition
module SchemaElements
module ScalarTypeExtension: ::ElasticGraph::SchemaDefinition::SchemaElements::ScalarType
BUILT_IN_SCALAR_PROTO_TYPES_BY_NAME: ::Hash[::String, ::String]

attr_reader protobuf_type: ::String?

def protobuf: (type: ::String) -> void
def finalize_protobuf_configuration!: () -> void
def initialize_proto_extension: () { () -> void } -> void
def proto_name: () -> ::String
def proto_type_reference: (::String package_name) -> ::String
def to_proto: (::String package_name) -> nil
Expand Down
6 changes: 3 additions & 3 deletions ...ingestion/spec/unit/elastic_graph/proto_ingestion/schema_definition/api_extension_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,16 +35,16 @@ module SchemaDefinition
field_types = []
proto = define_proto_schema do |s|
s.object_type "Widget" do |t|
FactoryExtension::BUILT_IN_SCALAR_PROTO_TYPES_BY_NAME.each_key do |type_name|
SchemaElements::ScalarTypeExtension::BUILT_IN_SCALAR_PROTO_TYPES_BY_NAME.each_key do |type_name|
t.field type_name.downcase, type_name
end
field_types = t.graphql_fields_by_name.values.map { |field| field.type.name }
t.index "widgets"
end
end

expect(field_types).to match_array(FactoryExtension::BUILT_IN_SCALAR_PROTO_TYPES_BY_NAME.keys)
FactoryExtension::BUILT_IN_SCALAR_PROTO_TYPES_BY_NAME.each.with_index(1) do |(type_name, proto_type), field_number|
expect(field_types).to match_array(SchemaElements::ScalarTypeExtension::BUILT_IN_SCALAR_PROTO_TYPES_BY_NAME.keys)
SchemaElements::ScalarTypeExtension::BUILT_IN_SCALAR_PROTO_TYPES_BY_NAME.each.with_index(1) do |(type_name, proto_type), field_number|
expect(proto).to include("#{proto_type} #{type_name.downcase} = #{field_number};")
end
end
Expand Down