Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow importing extra config #3906

Merged
merged 4 commits into from
Mar 19, 2024
+51 −2
Merged

Allow importing extra config #3906

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d880129
allow importing extra config
ruslandoga Mar 17, 2024
3cf1912
changelog
ruslandoga Mar 17, 2024
0618d7f
fix typo
ruslandoga Mar 17, 2024
fabdcac
add test
ruslandoga Mar 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ All notable changes to this project will be documented in this file.
- Add 'browser_versions.csv' to CSV export
- Add `CLICKHOUSE_MAX_BUFFER_SIZE_BYTES` env var which defaults to `100000` (100KB)
- Add alternative SMTP adapter plausible/analytics#3654
- Add `EXTRA_CONFIG_PATH` env var to specify extra Elixir config plausible/analytics#3906

### Removed
- Removed the nested custom event property breakdown UI when filtering by a goal in Goal Conversions
Expand Down
6 changes: 4 additions & 2 deletions mix.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,10 @@ defmodule Plausible.MixProject do
releases: [
plausible: [
include_executables_for: [:unix],
applications: [plausible: :permanent],
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is part of the default applications

steps: [:assemble, :tar]
Copy link
Contributor Author

@ruslandoga ruslandoga Mar 17, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We are copying all rel/ files directly, the tar archive ends up being unused.

config_providers: [
{Config.Reader,
path: {:system, "RELEASE_ROOT", "/import_extra_config.exs"}, imports: []}
]
]
],
dialyzer: [
Expand Down
8 changes: 8 additions & 0 deletions rel/overlays/import_extra_config.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
import Config
import Plausible.ConfigHelpers

config_dir = System.get_env("CONFIG_DIR", "/run/secrets")

if extra_config_path = get_var_from_path_or_env(config_dir, "EXTRA_CONFIG_PATH") do
import_config extra_config_path
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This intermediate config file is needed as runtime.exs is forbidden from importing other configs

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From https://hexdocs.pm/mix/Mix.Tasks.Release.html#module-runtime-configuration

It MUST NOT import any other configuration file via import_config

end
38 changes: 38 additions & 0 deletions test/plausible/config_test.exs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -264,6 +264,44 @@ defmodule Plausible.ConfigTest do
end
end

describe "extra config" do
test "no-op when no extra path is set" do
put_system_env_undo({"EXTRA_CONFIG_PATH", nil})

assert Config.Reader.read!("rel/overlays/import_extra_config.exs") == []
end

test "raises if path is invalid" do
put_system_env_undo({"EXTRA_CONFIG_PATH", "no-such-file"})

assert_raise File.Error, ~r/could not read file/, fn ->
Config.Reader.read!("rel/overlays/import_extra_config.exs")
end
end

@tag :tmp_dir
test "reads extra config", %{tmp_dir: tmp_dir} do
extra_config_path = Path.join(tmp_dir, "config.exs")

File.write!(extra_config_path, """
import Config

config :plausible, Plausible.Repo,
after_connect: {Postgrex, :query!, ["SET search_path TO global_prefix", []]}
""")

put_system_env_undo({"EXTRA_CONFIG_PATH", extra_config_path})

assert Config.Reader.read!("rel/overlays/import_extra_config.exs") == [
{:plausible,
[
{Plausible.Repo,
[after_connect: {Postgrex, :query!, ["SET search_path TO global_prefix", []]}]}
]}
]
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've also tried it out locally:

docker run --rm -d \
    -v ./my_config.exs:/app/my_config.exs \
    -e EXTRA_CONFIG_PATH=my_config.exs \
    -e BASE_URL=http://localhost:8000 \
    -e SECRET_KEY_BASE=FQ9iAQSkUx4peZfjRT9AIcX2iUupTYIPH90GbRS42NDUYQUcVzaTEARzK8NBRpVO \
    -e TOTP_VAULT_KEY=ykRRyEnKQX8jJ0zrE3rn91U0jluSsnevOGnQO2fTYUg= \
    -e DATABASE_URL=ecto://postgres:[email protected]:5432/plausible_dev \
    -e CLICKHOUSE_DATABASE_URL=http://172.17.0.3:8123/plausible_events_db \
    plausible:local
$ ls
bin                      erts-14.2.1              init-admin.sh            migrate.sh               pending-migrations.sh    rollback.sh
createdb.sh              import_extra_config.exs  lib                      my_config.exs            releases                 seed.sh
$ cat my_config.exs 
import Config

config :plausible, Plausible.Repo,
  after_connect: {Postgrex, :query!, ["SET search_path TO public", []]}

config :plausible, a: :b
$ bin/plausible remote
Erlang/OTP 26 [erts-14.2.1] [source] [64-bit] [smp:8:8] [ds:8:8:10] [async-threads:1] [jit]

Interactive Elixir (1.16.0) - press Ctrl+C to exit (type h() ENTER for help)
iex(plausible@7f241994598d)1> Application.get_env :plausible, Plausible.Repo
[
  timeout: 300000,
  connect_timeout: 300000,
  handshake_timeout: 300000,
  url: "ecto://postgres:[email protected]:5432/plausible_dev",
  socket_options: [],
  ssl_opts: [
    cacertfile: "/app/lib/castore-1.0.5/priv/cacerts.pem",
    verify: :verify_peer,
    customize_hostname_check: [
      match_fun: #Function<6.117093159/2 in :public_key.pkix_verify_hostname_match_fun/1>
    ]
  ],
  after_connect: {Postgrex, :query!, ["SET search_path TO public", []]}
]
iex(plausible@7f241994598d)2> Application.get_env :plausible, :a
:b

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I couldn't come up with a simple test that would check that extra config overrides runtime.exs, but it does.

end
end

defp runtime_config(env) do
put_system_env_undo(env)
Config.Reader.read!("config/runtime.exs", env: :prod)
Expand Down