You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
analytics/lib/plausible/plugins/api/goals.ex

93 lines
2.5 KiB
Elixir

Plugins API: 2nd pass with Goals resource + SharedLinks schema changes (#3396) * Remove "Context" namespace level * Change Goal string representation * Alias Schemas in Plugin API Test Case template * Update schema & tests for SharedLink resource * Update Goals interface - make it possible to create revenue goals - extract "for site" query to a standalone function * Fixup typespecs * Alias Errors module in OpenAPI controllers * Add missing goals test * Implement Goals Plugins API resource * Add extra test to confirm changeset error propagation * Mute credo * Fix typos * Handle changeset traversal in `Errors` * Use upserts in `Goals.find_or_create` * Extract touch_site! to Site.Cache, address credo, improve code docs * Apply formatting * Remove unused inner join * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update error message on revenue goal currency clash * Remove unused code --------- Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com>
3 years ago
defmodule Plausible.Plugins.API.Goals do
@moduledoc """
Plugins API context module for Goals.
All high level Goal operations should be implemented here.
"""
use Plausible
Plugins API: 2nd pass with Goals resource + SharedLinks schema changes (#3396) * Remove "Context" namespace level * Change Goal string representation * Alias Schemas in Plugin API Test Case template * Update schema & tests for SharedLink resource * Update Goals interface - make it possible to create revenue goals - extract "for site" query to a standalone function * Fixup typespecs * Alias Errors module in OpenAPI controllers * Add missing goals test * Implement Goals Plugins API resource * Add extra test to confirm changeset error propagation * Mute credo * Fix typos * Handle changeset traversal in `Errors` * Use upserts in `Goals.find_or_create` * Extract touch_site! to Site.Cache, address credo, improve code docs * Apply formatting * Remove unused inner join * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update error message on revenue goal currency clash * Remove unused code --------- Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com>
3 years ago
import Ecto.Query
Implement new sites view (#3463) * Implement complete basics of LV sites * Reimplement everything in LV except pagination * Implement basic search capability * PoC: plot visitors on sites index * Add rudimentary clipped gradient in minicharts * Fix clipping gradient, define once * Format * Add moduledoc to visitors component * Move paginator helpers to the top core namespace * Fix typespec of `Plausible.Sites.list` * Split sites component into subcomponents * Add function to uniformly calculate 24h intervals and visitor totals across multiple sites. * Integrate batch 24h interval query with plots on sites view * Don't confuse heex compiler with alpine @ shorthands * Make linear gradient svg definition truly invisible * Implement basic pagination * Extract `site_stats` from site and invitation cards * Improve pagination * Tweak css * Improve filtering on pagination and make WSS fail graceful * Test `last_24h_visitors_hourly_intervals/2` * Replace /sites with LV implementation * Add debounce to search filter * Fix typespecs * Fix styling * Fix mini graph scaling factor calculation * Fix search consuming itself * Minimal tweaks to the plots * Fixup * Remove magic numbers from the plot * Create `site_pins` table * Add `SitePin` schema * Implement listing invitations, sites and pins in a single query * Add FIXME note * Remove site pins for now * Add tests for `Plausible.Sites.list/3` * Add a couple more tests to sites dead view * Remove unnecessary FIXME * Add LV tests for Sites * Calculate and display 24h visitors change * Render the change in bold * Add clarfying comment on virtual field in `Site` schema * Remove unnecessary function from Invitations API * Remove unused list opt from type definition in `Sites` * Improve joins in list query slightly * Add comment on manually computing sites list total * Start searching from a singly character in domain field * Add typespec to `last_24h_visitors_hourly_intervals` * Extend moduledoc in visitors component * Simplify loading sites in LV * Simplify assigns in LV * Add missing group for shadow under site card * Make invitation modal render * Make HTML in sites LV semantically correct * Remove autofocus and focus search on `/` * Remove shadow from search input * Make search cancel on escape * Fix tests relying on outdated HTML structure * Make visitor chart color scheme consistent with dashboard chart * Update styling of trend labels * Fix empty state and improve search blur/focus handling * Use live navigation for pagination * Implement spinner on load from search * Remove unused `Plausible.Stats.Clickhouse.last_24h_visitors/1` * Calculate uniques correctly across hour boundaries * Swap inlined svg for Heroicons component in invitation modal * Add order by to base query in 24h hourly intervals * Revert "Add order by to base query in 24h hourly intervals" This reverts commit a6be5e302662b3a90f68da0e3fdfa6ff271c168e. * Query clickhouse 24h visitors only on second mount * Remove redundant sign from percentage change when negative * Switch to offset-based pagination - offset seems easier to deal with for when actions on paginated list will be performed such as site pinning; tracking cursor data makes some entries disappear in edge cases. The data set is still fairly small and static, even for large customers. - we're removing Phoenix.Pagination as it doesn't really fir any use case, and it was only used to limit the number of sites in the site picker - site picker is now limited to 9 sites (future: pinned sites will be prioritized there) - no need to re-query for total count any more - BTW, the old /sites template was removed * Refine the plot queries; Tests pass snapshot * Add PromEx plugin for LiveView * Fix tiny plot cut-off at the top --------- Co-authored-by: Adam Rutkowski <hq@mtod.org>
3 years ago
import Plausible.Pagination
Plugins API: 2nd pass with Goals resource + SharedLinks schema changes (#3396) * Remove "Context" namespace level * Change Goal string representation * Alias Schemas in Plugin API Test Case template * Update schema & tests for SharedLink resource * Update Goals interface - make it possible to create revenue goals - extract "for site" query to a standalone function * Fixup typespecs * Alias Errors module in OpenAPI controllers * Add missing goals test * Implement Goals Plugins API resource * Add extra test to confirm changeset error propagation * Mute credo * Fix typos * Handle changeset traversal in `Errors` * Use upserts in `Goals.find_or_create` * Extract touch_site! to Site.Cache, address credo, improve code docs * Apply formatting * Remove unused inner join * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update error message on revenue goal currency clash * Remove unused code --------- Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com>
3 years ago
alias Plausible.Repo
alias PlausibleWeb.Plugins.API.Schemas.Goal.CreateRequest
@type create_request() ::
CreateRequest.CustomEvent.t()
| CreateRequest.Revenue.t()
| CreateRequest.Pageview.t()
@spec create(
Plausible.Site.t(),
create_request() | list(create_request())
) ::
{:ok, list(Plausible.Goal.t())}
| {:error, Ecto.Changeset.t()}
| {:error, :upgrade_required}
Plugins API: 2nd pass with Goals resource + SharedLinks schema changes (#3396) * Remove "Context" namespace level * Change Goal string representation * Alias Schemas in Plugin API Test Case template * Update schema & tests for SharedLink resource * Update Goals interface - make it possible to create revenue goals - extract "for site" query to a standalone function * Fixup typespecs * Alias Errors module in OpenAPI controllers * Add missing goals test * Implement Goals Plugins API resource * Add extra test to confirm changeset error propagation * Mute credo * Fix typos * Handle changeset traversal in `Errors` * Use upserts in `Goals.find_or_create` * Extract touch_site! to Site.Cache, address credo, improve code docs * Apply formatting * Remove unused inner join * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update error message on revenue goal currency clash * Remove unused code --------- Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com>
3 years ago
def create(site, goal_or_goals) do
Repo.transaction(fn -> find_or_create(site, goal_or_goals) end)
end
@spec get_goals(Plausible.Site.t(), map()) :: {:ok, Paginator.Page.t()}
def get_goals(site, params) do
query = Plausible.Goals.for_site_query(site, preload_funnels?: false)
Plugins API: 2nd pass with Goals resource + SharedLinks schema changes (#3396) * Remove "Context" namespace level * Change Goal string representation * Alias Schemas in Plugin API Test Case template * Update schema & tests for SharedLink resource * Update Goals interface - make it possible to create revenue goals - extract "for site" query to a standalone function * Fixup typespecs * Alias Errors module in OpenAPI controllers * Add missing goals test * Implement Goals Plugins API resource * Add extra test to confirm changeset error propagation * Mute credo * Fix typos * Handle changeset traversal in `Errors` * Use upserts in `Goals.find_or_create` * Extract touch_site! to Site.Cache, address credo, improve code docs * Apply formatting * Remove unused inner join * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update error message on revenue goal currency clash * Remove unused code --------- Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com>
3 years ago
{:ok, paginate(query, params, cursor_fields: [{:id, :desc}])}
end
@spec get(Plausible.Site.t(), pos_integer()) :: nil | Plausible.Goal.t()
def get(site, id) when is_integer(id) do
site
|> get_query()
|> where([g], g.id == ^id)
|> Repo.one()
end
@spec delete(Plausible.Site.t(), [pos_integer()] | pos_integer()) :: :ok
def delete(site, id_or_ids) do
Plausible.Repo.transaction(fn ->
id_or_ids
|> List.wrap()
|> Enum.each(fn id when is_integer(id) ->
Plausible.Goals.delete(id, site)
end)
end)
:ok
end
defp get_query(site) do
from g in Plausible.Goal,
where: g.site_id == ^site.id,
order_by: [desc: g.id],
group_by: g.id
Plugins API: 2nd pass with Goals resource + SharedLinks schema changes (#3396) * Remove "Context" namespace level * Change Goal string representation * Alias Schemas in Plugin API Test Case template * Update schema & tests for SharedLink resource * Update Goals interface - make it possible to create revenue goals - extract "for site" query to a standalone function * Fixup typespecs * Alias Errors module in OpenAPI controllers * Add missing goals test * Implement Goals Plugins API resource * Add extra test to confirm changeset error propagation * Mute credo * Fix typos * Handle changeset traversal in `Errors` * Use upserts in `Goals.find_or_create` * Extract touch_site! to Site.Cache, address credo, improve code docs * Apply formatting * Remove unused inner join * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update test/plausible_web/plugins/api/controllers/goals_test.exs Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com> * Update error message on revenue goal currency clash * Remove unused code --------- Co-authored-by: Adrian Gruntkowski <adrian.gruntkowski@gmail.com>
3 years ago
end
defp convert_to_create_params(%CreateRequest.CustomEvent{goal: %{event_name: event_name}}) do
%{"goal_type" => "event", "event_name" => event_name}
end
defp convert_to_create_params(%CreateRequest.Revenue{
goal: %{event_name: event_name, currency: currency}
}) do
%{"goal_type" => "event", "event_name" => event_name, "currency" => currency}
end
defp convert_to_create_params(%CreateRequest.Pageview{goal: %{path: page_path}}) do
%{"goal_type" => "page", "page_path" => page_path}
end
defp find_or_create(site, goal_or_goals) do
goal_or_goals
|> List.wrap()
|> Enum.map(fn goal ->
case Plausible.Goals.find_or_create(site, convert_to_create_params(goal)) do
{:ok, goal} ->
goal
{:error, changeset} ->
Repo.rollback(changeset)
end
end)
end
end