class Analyzer::Dart::Serverpod

Overview

Serverpod is an RPC-style backend framework. Server endpoints are Dart classes that extend Endpoint (or StreamingEndpoint); each public method takes a Session as its first parameter and is exposed to clients as a callable RPC. The class name's Endpoint suffix is dropped and the first character is lowercased to derive the endpoint name (OrderEndpoint → order).

Serverpod dispatches every call as a POST to /<endpointName> with the method name and arguments encoded in the body. We surface each method as POST /<endpointName>/<methodName> so individual RPCs are visible in the output, with the non-Session arguments reported as JSON body params.

Defined in:

analyzer/analyzers/dart/serverpod.cr

Constant Summary

HTTP_METHOD = "POST"
RESERVED_DART_NAMES = ["if", "else", "for", "while", "switch", "case", "return", "try", "catch", "finally", "throw", "new", "const", "final", "var", "late", "void", "await", "async", "assert"] of ::String
SPLIT_COMMAS_RULES = Noir::TopLevelSplit::Rules.new(nest: Noir::TopLevelSplit::Nest::Paren | Noir::TopLevelSplit::Nest::Angle, quotes: "", escape: Noir::TopLevelSplit::Escape::None, strip: false, empties: Noir::TopLevelSplit::Empties::Keep, per_kind: false, clamp: true)

Serverpod's argument lists carry Dart generics (Future<List<Foo>>) and call expressions, and nothing else nests: this splitter sees method signatures, never string literals, so quote handling stays off.

Nest::Paren | Nest::Angle with per_kind: false is the whole of the old body's depth model — one counter incremented by < and ( alike and decremented by > and ), with [] and {} inert. Those are two orthogonal choices in Rules (nest picks which characters count, per_kind picks how many counters exist), which is why this reads as a plain preset despite earlier surveys in this series calling the combination inexpressible.

WEB_METHOD_MAP = {"get" => "GET", "post" => "POST", "put" => "PUT", "patch" => "PATCH", "delete" => "DELETE", "head" => "HEAD", "options" => "OPTIONS"}

Method.<verb> constants accepted by Route's methods: set.

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]