MishkaCmsCore.
Copy Markdown
View Source
A table of an extension's own merged into the activity log, as one more branch of the UNION ALL
MishkaCmsCore.Activity.Query runs.
The core's branches read what every installation has: AshPaperTrail versions, AshEvents logs, the
runtime drafts and Oban jobs. A record that is none of those — the visual editor's history is the
first — would never reach the log, so its owner contributes the branch. It registers on
activity:sources, a collect event, through MishkaCmsCore.ProviderRegistry:
use MishkaCmsCore.ProviderRegistry, event: "activity:sources", priority: 50
@behaviour MishkaCmsCore.Activity.Behaviours.UnionSourceWith no source registered the log is the core's branches alone.
The branch
union_branch/1 answers {sql, params} for one read, or nil when the read cannot reach any of
its rows (a warn read of a table that only ever holds information, say), so its table is not
scanned to return nothing. sql is one parenthesised (SELECT … LIMIT $1) selecting, in this
order and with these types, the columns every branch selects:
source text -- the source's id/0, which is how its rows find entry_from_row/1 again
resource text -- the module name an entry is filed under ("Elixir.MishkaCmsCore.Runtime.Page")
action text, source_id text, event_id text, site_id text, user_id text,
inserted_at timestamp, payload jsonbIt filters and orders itself, newest first, and caps itself at $1, so the merged top of the log
is the top of each branch. The read's filters arrive as the shared positional parameters, which
MishkaCmsCore.Activity.Query's public clause builders write: $1 the cap, $4 the resource
(resource_clause/1), $5 the search (search_clause/1) and $6 the tenant's site
(version_site_clause/2, only when site_id is set); shown_clause/2 and
content_severity_clause/2 narrow it by the viewer's resources and the read's severity.
A value of the source's own is a parameter too, never text written into the SQL: params lists
them, and the first is $ followed by first_param, the next first_param + 1, and so on. Each
is cast where it is used ($7::text), because Postgres must infer every parameter's type.
ONE BROKEN BRANCH EMPTIES THE WHOLE LOG. The read is one query, so SQL that Postgres refuses fails
every source with it, and the log answers "no matching events" (the failure is logged). A branch
that raises or answers anything but {sql, params} is left out of the read on its own.
Summary
Types
The read a branch is asked for. site_id is the one site read, nil for every site (a master);
severity is "info", "warn", "error" or nil; shown is :all or the module strings
the viewer may see; first_param is the position of the source's first own parameter.
Callbacks
One row the branch produced, as an entry of the log.
The value the branch writes in the source column: unique, and none of the core's own.
The branch for one read and its own parameters, or nil when the read reaches none of it.
Types
@type read() :: %{ site_id: String.t() | nil, severity: String.t() | nil, shown: :all | [String.t()], first_param: pos_integer() }
The read a branch is asked for. site_id is the one site read, nil for every site (a master);
severity is "info", "warn", "error" or nil; shown is :all or the module strings
the viewer may see; first_param is the position of the source's first own parameter.
Callbacks
@callback entry_from_row(map()) :: MishkaCmsCore.Activity.Behaviours.Source.entry()
One row the branch produced, as an entry of the log.
@callback id() :: String.t()
The value the branch writes in the source column: unique, and none of the core's own.
The branch for one read and its own parameters, or nil when the read reaches none of it.