class Detector::Specification::Apisix

Defined in:

detector/detectors/specification/apisix.cr

Constant Summary

PAYLOAD_MARKER = /\bupstream_id\b|\bplugins\b/
ROUTES_MARKER = /\broutes\b/

Word-bounded guard markers. The accepted shapes require actual routes / uri(uris) / upstream_id or plugins keys, which always appear word-bounded in the raw document ("uri": / uri:), so \b keeps the guard a necessary condition while no longer tripping on substrings — the bare includes?("uri") matched "security" and made large OpenAPI JSON specs pay a full redundant parse here on every scan (this detector is non-idempotent).

URI_MARKER = /\buris?\b/

Instance Method Summary

Instance methods inherited from class Detector

applicable?(filename : String) : Bool applicable?, detect(filename : String, file_contents : String) : Bool detect, gemfile_dependency?(file_contents : String, gem_name : String) : Bool gemfile_dependency?, gemspec_dependency?(file_contents : String, gem_name : String) : Bool gemspec_dependency?, idempotent? : Bool idempotent?, logger : NoirLogger logger, name : String name, path_sensitive? : Bool path_sensitive?

Constructor methods inherited from class Detector

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

Instance Method Detail

def applicable?(filename : String) : Bool #
Description copied from class Detector

Cheap filename-only filter the detector pass uses to skip #detect on files the detector cannot possibly match. The default true preserves prior behavior (every detector runs on every file). Override with the same predicate the body of #detect starts with — e.g., filename.ends_with?(".py") for a Python framework detector — so the detector loop avoids the #detect dispatch on files outside the detector's language.

On large codebases (saleor's 4255 .py files) this lifts ~100 virtual #detect calls per file out of the hot loop because most detectors' inner first-line is exactly this kind of cheap filename check.


[View source]
def detect(filename : String, file_contents : String) : Bool #

[View source]
def idempotent? : Bool #

Registers every APISIX route config path in CodeLocator.


[View source]
def set_name #

[View source]