class Analyzer::Go::Kratos

Overview

Kratos (https://go-kratos.dev/) is a Go microservices framework whose HTTP surface is (almost always) generated from .proto service definitions by protoc-gen-go-http, not hand-registered. A generated *_http.pb.go file looks like:

func RegisterTodoServiceHTTPServer(s *http.Server, srv TodoServiceHTTPServer) { r := s.Route("/") r.Handle("POST", "/v1/todos/create", _TodoService_CreateTodo0_HTTP_Handler(srv)) r.Handle("GET", "/v1/todos/{id}", _TodoService_GetTodo0_HTTP_Handler(srv)) }

protoc-gen-go-http v3+ emits the method-first r.Handle("METHOD", "path", handler) shape shown above; v2.x (still the majority of deployed Kratos services) emits verb shortcuts instead (r.GET("/v1/todos/{id}", handler), r.POST(...), ...). The shared tree-sitter Go route walker already recognises both shapes (it backs httprouter's analyzer for the same Handle + verb-method combo), so this analyzer is a thin Kratos-specific wrapper around it rather than a bespoke parser.

Path params ({id}) are left in the URL as-is; EndpointOptimizer derives Param entries from {...} placeholders for every analyzer, so they don't need to be extracted here.

Defined in:

analyzer/analyzers/go/kratos.cr

Constant Summary

BODY_VERBS = {"POST", "PUT", "PATCH"}

HTTP methods protoc-gen-go-http allows a google.api.http body rule on. The generator itself enforces (and warns at generation time when violated) that only these verbs bind a request body — GET/DELETE never do. Field-level body/query shapes require the paired .proto/generated request struct, which this analyzer does not parse, so a generic body param is attached instead (mirrors the connect_rpc analyzer's level of detail).

IMPORT_MARKER = /go-kratos\/kratos\/v\d+\/transport\/http/

Only .go files that import Kratos' own HTTP transport package are scanned. This is a narrow, framework-specific marker — unlike a bare .GET("/path", handler) call, which virtually any Go router could produce — so a Kratos-tagged repository never steals routes registered by a sibling framework living in the same tree (see the analyzer project-scoping campaign, #2417-2432). Matches both github.com/go-kratos/kratos/v2/transport/http and the newer v3 module path.

Class Method Summary

Instance Method Summary

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, base_relative_path(path : String) : String base_relative_path, callees_needed? : Bool callees_needed?, content_matches?(content : String, markers : Regex) : Bool content_matches?, http_header_name(name : String) : String | Nil http_header_name, line_number_for_index(content : String, char_index : Int32) : Int32 line_number_for_index, logger : NoirLogger logger, parallel_analyze(files : Array(String), &block : String -> Nil) parallel_analyze, read_file_content(path : String) : String read_file_content, result : Array(Endpoint) result, tech : String tech, unique_params(params : Array(Param)) : Array(Param) unique_params, url : String url, web_root_path(path : String, markers : Array(String)) : String web_root_path

Constructor methods inherited from class Analyzer

new(options : Hash(String, YAML::Any)) new

Macros inherited from class Analyzer

analyzer_for(tech) analyzer_for

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_basename(basename : String) : Array(String) get_files_by_basename, get_files_by_extension(extension : String) : Array(String) get_files_by_extension, get_files_by_extensions(extensions : Array(String)) : Array(String) get_files_by_extensions, get_files_by_prefix(prefix : String) : Array(String) get_files_by_prefix, get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String) get_files_by_prefix_and_extension, get_files_by_relative_path(relative_path : String, root : String = "") : Array(String) get_files_by_relative_path, get_public_dir_files(base_path : String, folder : String) : Array(String) get_public_dir_files, get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String) get_public_files, walked_path(expanded : String) : String walked_path

Class Method Detail

def self.tech_name : String #

[View source]

Instance Method Detail

def analyze #

[View source]
def tech : String #

Instance-side view of the same declaration. The per-file rescues live on this base class, which has no way to name the analyzer that is running inside them, so a skipped file could not be attributed to a tech. Deriving it from analyzer_for keeps the name written exactly once.


[View source]