mirror of
https://github.com/plausible/analytics.git
synced 2024-11-28 04:30:42 +03:00
5eb8929929
* first commit with test and compile job Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding 'prepare' stage Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated ci script to include "test" compile phase Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding environment variables for connecting to postgresql Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated ci config for postgres Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * using non-alpine version of elixir Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * re-using the 'compile' artifacts and added explict env variables for testing Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * removing redundant deps fetching from common code Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * formatting using mix.format -- beware no-code changes! Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * added release config Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding consistent env variable for Database Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * more cleaning up of environment variables Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding releases config for enabling releases Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * cleaning up env configs Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Cleaned up config and prepared config for releases Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated CI script with new config for test Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Added Dockerfile for creating production docker image Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding "docker" build job yay! Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * using non-slim version of debian and installing webpack Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding overlays for migrations on releases Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * restricting the docker built to master branch only Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * typo fix Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding "Hosting.md" to explain hosting instructions Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * removed the default comments Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Added documentation related to env variables * updated documentation and fixed typo Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated documentation * Bumping up elixir version as `overlays` are only supported in latest version read release notes: https://github.com/elixir-lang/elixir/releases/tag/v1.10.0 Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding tarball assembly during release Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updated HOSTING.md Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Added support for db migration Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * minor corrections Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * initializing admin user Admin user has been added in the "migration" phase. A default user is automatically created in the process. One can provide the related env variables, else a new one will be automatically created for you. Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Initial base domain update - phase#1 These changes are only meant for correct operating it under self-hosting. There are many other cosmetic changes, that require updates to email, site and other places where the original website and author is used. Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Using dedicated config variable `base_domain` instead Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding base_domain to releases config Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * removing the dedicated config "base_domain", relying on endpoint host Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Removed the usage of "Mix" in code! It is bad practice to use "mix" module inside the code as in actual release this module is unavailable. Replacing this with a config environment variable Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Added support for SMTP via Bamboo Smtp Adapter Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Capturing SMTP errors via Sentry Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Minor updates Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * Adding junit formatter -- useful for generating test reports Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding documentation for default user * Resolve "Gitlab Adoption: Add supported services in "Security & Compliance"" * bumping up the debian version to fix issues fixing some vulnerabilities identified by the scanning tools * More updates for self-hosting Changes in most of the places to suit self-hosting. Although, there are some which have been left-off. Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * quick-dirty-fix! * bumping up the db connect timeout Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * bumping up the db connect timeout Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * bumping up the db connect timeout Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * bumping up timeout - skipping MRs :-/ * removing restrictions on watching for changes this stuff isn't working * Update HOSTING.md * renamed the module name * reverting formatting-whitespace changes Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * reverting the name to release Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * adding docker-compose.yml and related instructions Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * using `plausible_url` instead of assuming `https` this is because, it is much to test in local dev machines and in most cases there's already a layer above which is capable for `https` termination and http -> https upgrade Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * WIP: merging changes from upstream Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * wip: more changes * Pushing in changes from upstream Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * changes to ci for testing Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * cleaning up and finishing clickhouse integration Signed-off-by: Chandra Tungathurthi <tckb@tgrthi.me> * updating readme with hosting details
235 lines
6.3 KiB
Elixir
235 lines
6.3 KiB
Elixir
defmodule Plausible.Release do
|
|
use Plausible.Repo
|
|
@app :plausible
|
|
@start_apps [
|
|
:postgrex,
|
|
:ecto
|
|
]
|
|
alias Mix.Tasks.HydrateClickhouse, as: Clickhouse
|
|
|
|
def init_admin do
|
|
{admin_email, admin_user, admin_pwd} =
|
|
validate_admin(
|
|
{Application.get_env(:plausible, :admin_email),
|
|
Application.get_env(:plausible, :admin_user),
|
|
Application.get_env(:plausible, :admin_pwd)}
|
|
)
|
|
|
|
{:ok, admin} = Plausible.Auth.create_user(admin_user, admin_email)
|
|
# set the password
|
|
{:ok, admin} = Plausible.Auth.User.set_password(admin, admin_pwd) |> Repo.update()
|
|
# bump-up the trail period
|
|
admin
|
|
|> Ecto.Changeset.cast(%{trial_expiry_date: Timex.today() |> Timex.shift(years: 100)}, [
|
|
:trial_expiry_date
|
|
])
|
|
|> Repo.update()
|
|
|
|
IO.puts("Admin user created successful!")
|
|
end
|
|
|
|
def migrate do
|
|
prepare()
|
|
Enum.each(repos(), &run_migrations_for/1)
|
|
init_admin()
|
|
IO.puts("Migrations successful!")
|
|
end
|
|
|
|
def seed do
|
|
prepare()
|
|
# Run seed script
|
|
Enum.each(repos(), &run_seeds_for/1)
|
|
|
|
# Signal shutdown
|
|
IO.puts("Success!")
|
|
end
|
|
|
|
def createdb do
|
|
prepare()
|
|
do_create_db()
|
|
IO.puts("Creation of Db successful!")
|
|
end
|
|
|
|
def rollback do
|
|
prepare()
|
|
|
|
get_step =
|
|
IO.gets("Enter the number of steps: ")
|
|
|> String.trim()
|
|
|> Integer.parse()
|
|
|
|
case get_step do
|
|
{int, _trailing} ->
|
|
Enum.each(repos(), fn repo -> run_rollbacks_for(repo, int) end)
|
|
IO.puts("Rollback successful!")
|
|
|
|
:error ->
|
|
IO.puts("Invalid integer")
|
|
end
|
|
end
|
|
|
|
##############################
|
|
|
|
defp validate_admin({nil, nil, nil}) do
|
|
random_user = :crypto.strong_rand_bytes(8) |> Base.encode64() |> binary_part(0, 8)
|
|
random_pwd = :crypto.strong_rand_bytes(20) |> Base.encode64() |> binary_part(0, 20)
|
|
random_email = "#{random_user}@#{System.get_env("HOST")}"
|
|
IO.puts("generated admin user/password: #{random_email} / #{random_pwd}")
|
|
{random_email, random_user, random_pwd}
|
|
end
|
|
|
|
defp validate_admin({admin_email, admin_user, admin_password}) do
|
|
{admin_email, admin_user, admin_password}
|
|
end
|
|
|
|
defp repos do
|
|
Application.fetch_env!(@app, :ecto_repos)
|
|
end
|
|
|
|
defp run_seeds_for(repo) do
|
|
# Run the seed script if it exists
|
|
seed_script = seeds_path(repo)
|
|
|
|
if File.exists?(seed_script) do
|
|
IO.puts("Running seed script..")
|
|
Code.eval_file(seed_script)
|
|
end
|
|
end
|
|
|
|
defp run_migrations_for(repo) do
|
|
app = Keyword.get(repo.config, :otp_app)
|
|
IO.puts("Running migrations for #{app}")
|
|
{:ok, _, _} = Ecto.Migrator.with_repo(repo, &Ecto.Migrator.run(&1, :up, all: true))
|
|
end
|
|
|
|
defp do_create_db do
|
|
for repo <- repos() do
|
|
:ok = ensure_repo_created(repo)
|
|
end
|
|
do_create_ch_db()
|
|
end
|
|
|
|
|
|
defp do_create_ch_db() do
|
|
db_to_create = Keyword.get(Application.get_env(:plausible, :clickhouse),:database)
|
|
|
|
IO.puts("create #{inspect(db_to_create)} clickhouse database/tables if it doesn't exist")
|
|
|
|
Clickhousex.query(:clickhouse, "CREATE DATABASE IF NOT EXISTS #{db_to_create}", [])
|
|
|
|
tb_events = """
|
|
CREATE TABLE IF NOT EXISTS #{db_to_create}.events (
|
|
timestamp DateTime,
|
|
name String,
|
|
domain String,
|
|
user_id UInt64,
|
|
session_id UInt64,
|
|
hostname String,
|
|
pathname String,
|
|
referrer String,
|
|
referrer_source String,
|
|
initial_referrer String,
|
|
initial_referrer_source String,
|
|
country_code LowCardinality(FixedString(2)),
|
|
screen_size LowCardinality(String),
|
|
operating_system LowCardinality(String),
|
|
browser LowCardinality(String)
|
|
) ENGINE = MergeTree()
|
|
PARTITION BY toYYYYMM(timestamp)
|
|
ORDER BY (name, domain, user_id, timestamp)
|
|
SETTINGS index_granularity = 8192
|
|
"""
|
|
|
|
Clickhousex.query(:clickhouse, tb_events, [])
|
|
|
|
tb_sessions = """
|
|
CREATE TABLE IF NOT EXISTS #{db_to_create}.sessions (
|
|
session_id UInt64,
|
|
sign Int8,
|
|
domain String,
|
|
user_id UInt64,
|
|
hostname String,
|
|
timestamp DateTime,
|
|
start DateTime,
|
|
is_bounce UInt8,
|
|
entry_page String,
|
|
exit_page String,
|
|
pageviews Int32,
|
|
events Int32,
|
|
duration UInt32,
|
|
referrer String,
|
|
referrer_source String,
|
|
country_code LowCardinality(FixedString(2)),
|
|
screen_size LowCardinality(String),
|
|
operating_system LowCardinality(String),
|
|
browser LowCardinality(String)
|
|
) ENGINE = CollapsingMergeTree(sign)
|
|
PARTITION BY toYYYYMM(start)
|
|
ORDER BY (domain, user_id, session_id, start)
|
|
SETTINGS index_granularity = 8192
|
|
"""
|
|
|
|
Clickhousex.query(:clickhouse, tb_sessions, [])
|
|
end
|
|
|
|
|
|
defp ensure_repo_created(repo) do
|
|
IO.puts("create #{inspect(repo)} database if it doesn't exist")
|
|
|
|
case repo.__adapter__.storage_up(repo.config) do
|
|
:ok -> :ok
|
|
{:error, :already_up} -> :ok
|
|
{:error, term} -> {:error, term}
|
|
end
|
|
end
|
|
|
|
defp run_rollbacks_for(repo, step) do
|
|
app = Keyword.get(repo.config, :otp_app)
|
|
IO.puts("Running rollbacks for #{app} (STEP=#{step})")
|
|
|
|
{:ok, _, _} =
|
|
Ecto.Migrator.with_repo(repo, &Ecto.Migrator.run(&1, :down, all: false, step: step))
|
|
end
|
|
|
|
defp prepare do
|
|
IO.puts("Loading #{@app}..")
|
|
# Load the code for myapp, but don't start it
|
|
:ok = Application.load(@app)
|
|
|
|
prepare_clickhouse()
|
|
|
|
IO.puts("Starting dependencies..")
|
|
# Start apps necessary for executing migrations
|
|
Enum.each(@start_apps, &Application.ensure_all_started/1)
|
|
|
|
|
|
# Start the Repo(s) for myapp
|
|
IO.puts("Starting repos..")
|
|
Enum.each(repos(), & &1.start_link(pool_size: 2))
|
|
|
|
end
|
|
|
|
defp prepare_clickhouse do
|
|
Application.ensure_all_started(:db_connection)
|
|
Application.ensure_all_started(:hackney)
|
|
Clickhousex.start_link([
|
|
scheme: :http,
|
|
port: 8123,
|
|
name: :clickhouse,
|
|
database: "default",
|
|
hostname: Keyword.get(Application.get_env(:plausible,:clickhouse),:hostname)
|
|
])
|
|
end
|
|
|
|
defp seeds_path(repo), do: priv_path_for(repo, "seeds.exs")
|
|
|
|
defp priv_path_for(repo, filename) do
|
|
app = Keyword.get(repo.config, :otp_app)
|
|
IO.puts("App: #{app}")
|
|
repo_underscore = repo |> Module.split() |> List.last() |> Macro.underscore()
|
|
Path.join([priv_dir(app), repo_underscore, filename])
|
|
end
|
|
|
|
defp priv_dir(app), do: "#{:code.priv_dir(app)}"
|
|
end
|