Packages
caffeine_lang
0.0.2
6.3.1
6.3.0
6.2.2
6.2.1
6.2.0
6.1.2
6.1.1
6.1.0
6.0.0
5.6.0
5.5.0
5.4.4
5.4.3
5.4.2
5.4.1
5.4.0
5.3.0
5.2.0
5.1.1
5.1.0
5.0.12
5.0.11
5.0.10
5.0.8
5.0.7
5.0.6
5.0.5
5.0.4
5.0.1
5.0.0
4.10.0
4.9.0
4.8.3
4.8.2
4.8.1
4.8.0
4.7.9
4.7.8
4.7.7
4.7.6
4.7.5
4.6.7
4.6.6
4.6.5
4.6.4
4.6.3
4.6.2
4.6.0
4.5.1
4.5.0
4.4.4
4.4.3
4.4.1
4.4.0
4.3.7
4.3.6
3.0.6
3.0.5
3.0.4
3.0.3
3.0.2
3.0.1
3.0.0
2.0.5
2.0.4
2.0.3
2.0.2
2.0.1
2.0.0
1.0.2
1.0.1
0.1.0
0.0.24
0.0.23
0.0.22
0.0.21
0.0.20
0.0.19
0.0.18
0.0.17
0.0.16
0.0.15
0.0.14
0.0.13
0.0.12
0.0.11
0.0.10
0.0.9
0.0.8
0.0.7
0.0.6
0.0.5
0.0.4
0.0.2
0.0.1
A compiler for generating reliability artifacts from service expectation definitions.
Current section
Files
Jump to
Current section
Files
src/caffeine_lang@phase_3@semantic.erl
-module(caffeine_lang@phase_3@semantic).
-compile([no_auto_import, nowarn_unused_vars, nowarn_unused_function, nowarn_nomatch, inline]).
-define(FILEPATH, "src/caffeine_lang/phase_3/semantic.gleam").
-export([validate_services_from_instantiation/1, validate_sli_types_exist_from_instantiation/1, validate_slos_thresholds_reasonable_from_instantiation/1, perform_semantic_analysis/1]).
-export_type([semantic_analysis_error/0]).
-if(?OTP_RELEASE >= 27).
-define(MODULEDOC(Str), -moduledoc(Str)).
-define(DOC(Str), -doc(Str)).
-else.
-define(MODULEDOC(Str), -compile([])).
-define(DOC(Str), -compile([])).
-endif.
?MODULEDOC(
" We perform the following semantic analysis against the intermediate representation of the organization.\n"
" (3) Ensure that all SLOs are referencing valid SLI types for their service.\n"
" (5) Ensure that all filters are valid for the SLI type.\n"
" (7) Ensure no duplicate service names or duplicate SLOs for a single service and team combination.\n"
" (8) Ensure that all services, sli types, and sli filters in the specification are unique.\n"
" (9) Ensure that all filters within the SLOs are the correct types for the SLI type's filters.\n"
" (10) For every required true sli filter, ensure that it is present in the SLO.\n"
" (11) For every filter within SLO instantiation, if unknown, reject it.\n"
" (12) Perform query template hygiene:\n"
" (12.1) Ensure that the query template is valid and not empty.\n"
" (12.2) Every template variable in the query template must be present in the filters of the SLI type.\n"
" (13) Warn on unused sli types, sli filters, and services.\n"
" (14) Normalize team names, service names, sli type names, sli filter names, and sli filter attribute names to lowercase.\n"
).
-type semantic_analysis_error() :: {undefined_service_error, list(binary())} |
{undefined_sli_type_error, list(binary())} |
{invalid_slo_threshold_error, list(float())} |
{duplicate_service_error, list(binary())}.
-file("src/caffeine_lang/phase_3/semantic.gleam", 25).
-spec slos_filtered_attribute(
caffeine_lang@types@ast:organization(),
fun((caffeine_lang@types@ast:slo()) -> PMC),
fun((PMC) -> boolean())
) -> list(PMC).
slos_filtered_attribute(Organization, Extract_fn, Predicate_fn) ->
_pipe = erlang:element(2, Organization),
_pipe@1 = gleam@list:flat_map(
_pipe,
fun(Team) -> erlang:element(3, Team) end
),
_pipe@2 = gleam@list:map(_pipe@1, Extract_fn),
_pipe@3 = gleam@list:filter(_pipe@2, Predicate_fn),
gleam@list:unique(_pipe@3).
-file("src/caffeine_lang/phase_3/semantic.gleam", 37).
-spec validate_services_from_instantiation(
caffeine_lang@types@ast:organization()
) -> {ok, boolean()} | {error, semantic_analysis_error()}.
validate_services_from_instantiation(Organization) ->
Defined_services = begin
_pipe = erlang:element(3, Organization),
gleam@list:map(
_pipe,
fun(Service_definition) -> erlang:element(2, Service_definition) end
)
end,
Undefined_services = slos_filtered_attribute(
Organization,
fun(Slo) -> erlang:element(5, Slo) end,
fun(Service_name) ->
not gleam@list:contains(Defined_services, Service_name)
end
),
case Undefined_services of
[] ->
{ok, true};
Services ->
{error, {undefined_service_error, Services}}
end.
-file("src/caffeine_lang/phase_3/semantic.gleam", 58).
-spec validate_sli_types_exist_from_instantiation(
caffeine_lang@types@ast:organization()
) -> {ok, boolean()} | {error, semantic_analysis_error()}.
validate_sli_types_exist_from_instantiation(Organization) ->
Defined_sli_types = begin
_pipe = erlang:element(3, Organization),
_pipe@1 = gleam@list:map(
_pipe,
fun(Service_definition) -> erlang:element(3, Service_definition) end
),
_pipe@2 = gleam@list:flat_map(_pipe@1, fun(Sli_types) -> Sli_types end),
_pipe@3 = gleam@list:map(
_pipe@2,
fun(Sli_type) -> erlang:element(2, Sli_type) end
),
gleam@list:unique(_pipe@3)
end,
Undefined_sli_types = slos_filtered_attribute(
Organization,
fun(Slo) -> erlang:element(4, Slo) end,
fun(Sli_type_name) ->
not gleam@list:contains(Defined_sli_types, Sli_type_name)
end
),
case Undefined_sli_types of
[] ->
{ok, true};
Sli_types@1 ->
{error, {undefined_sli_type_error, Sli_types@1}}
end.
-file("src/caffeine_lang/phase_3/semantic.gleam", 84).
?DOC(" Ensure that all SLO thresholds are between 0 and 100.\n").
-spec validate_slos_thresholds_reasonable_from_instantiation(
caffeine_lang@types@ast:organization()
) -> {ok, boolean()} | {error, semantic_analysis_error()}.
validate_slos_thresholds_reasonable_from_instantiation(Organization) ->
Invalid_thresholds = slos_filtered_attribute(
Organization,
fun(Slo) -> erlang:element(3, Slo) end,
fun(Threshold) -> (Threshold < +0.0) orelse (Threshold > 100.0) end
),
case Invalid_thresholds of
[] ->
{ok, true};
Thresholds ->
{error, {invalid_slo_threshold_error, Thresholds}}
end.
-file("src/caffeine_lang/phase_3/semantic.gleam", 100).
-spec perform_semantic_analysis(caffeine_lang@types@ast:organization()) -> {ok,
boolean()} |
{error, semantic_analysis_error()}.
perform_semantic_analysis(Organization) ->
case validate_services_from_instantiation(Organization) of
{ok, _} ->
case validate_sli_types_exist_from_instantiation(Organization) of
{ok, _} ->
case validate_slos_thresholds_reasonable_from_instantiation(
Organization
) of
{ok, _} ->
{ok, true};
{error, Error} ->
{error, Error}
end;
{error, Error@1} ->
{error, Error@1}
end;
{error, Error@2} ->
{error, Error@2}
end.