Merge branch 'apb/sitemap' into apb/robots-txt

Author: APB9785

CHANGELOG.md

@@ -6,13 +6,24 @@
   - Beacon will now automatically generate a `sitemap.xml` for each `beacon_site` defined in the Router
   - Add macro `beacon_sitemap_index` for use in the Router to serve a sitemap index
 
+## 0.3.3 (2024-12-13)
+
+### Fixes
+  - Support LiveView v1.0.1
+  - Fix variant roll changing when fetching assets
+
+## 0.3.2 (2024-12-11)
+
+### Fixes
+  - Make the logic to find reachable sites less strict
+  - Prevent components module reloading in manual mode
+
 ### Doc
   - Add missing instructions on Upgrade Guide v0.3.0 where to place the Beacon tuple
 
 ### Chore
   - Exclude Dialyzer files from package
 
-
 ## 0.3.1 (2024-12-10)
 
 ### Fixes

assets/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "beacon",
-  "version": "0.3.1",
+  "version": "0.3.3",
   "license": "MIT",
   "repository": {},
   "scripts": {

assets/package.json

@@ -16,6 +16,34 @@ config :beacon, Beacon.BeaconTest.Repo,
   stacktrace: true,
   show_sensitive_data_on_connection_error: true
 
+config :beacon,
+  session_options: [
+    store: :cookie,
+    key: "_beacon_test_key",
+    signing_salt: "LKBurgGF",
+    same_site: "Lax"
+  ]
+
+config :beacon, Beacon.BeaconTest.ProxyEndpoint, live_view: [signing_salt: "LKBurgGF"]
+
+config :beacon, Beacon.BeaconTest.Endpoint,
+  url: [host: "localhost", port: 4000],
+  secret_key_base: "dVxFbSNspBVvkHPN5m6FE6iqNtMnhrmPNw7mO57CJ6beUADllH0ux3nhAI1ic65X",
+  live_view: [signing_salt: "LKBurgGF"],
+  render_errors: [view: Beacon.BeaconTest.ErrorView],
+  pubsub_server: Beacon.BeaconTest.PubSub,
+  check_origin: false,
+  debug_errors: true
+
+config :beacon, Beacon.BeaconTest.EndpointB,
+  url: [host: "site_b.com", port: 4000],
+  secret_key_base: "dVxFbSNspBVvkHPN5m6FE6iqNtMnhrmPNw7mO57CJ6beUADllH0ux3nhAI1ic65X",
+  live_view: [signing_salt: "LKBurgGF"],
+  render_errors: [view: Beacon.BeaconTest.ErrorView],
+  pubsub_server: Beacon.BeaconTest.PubSub,
+  check_origin: false,
+  debug_errors: true
+
 # Fake Key Values. We're not putting real creds here.
 config :ex_aws,
   access_key_id: "AKIAIOSFODNN7EXAMPLE",

config/test.exs

@@ -77,16 +77,6 @@ which is not a big problem when you have a couple of small sites, but that becom
 
 To avoid this problem, Beacon will selectively boot only the sites that are reachable in the current host, so in the example above,
 only `:site_a` will be booted in the node hosting `sitea.com` and only `:site_b` in the node hosting `siteb.com`.
-This behavior also applies to route conflicts as well, for example:
-
-```elixir
-scope do
-  get "/", PageController, :hello
-  beacon_site "/", site: :site_a
-end
-```
-
-Two routes in the same prefix will cause a conflict.
 
 Or this other example:
 
@@ -105,7 +95,7 @@ So Beacon won't try to boot sites that can't be reached, but a warning will be d
 
 ### Admin Sites Discovery
 
-BeaconLiveAdmin is designed to scan the all apps connected in the same cluster to find running sites
+[BeaconLiveAdmin](https://hex.pm/packages/beacon_live_admin) is designed to scan the all apps connected in the same cluster to find running sites
 and make them available in the admin interface as displayed below:
 
 ```mermaid
@@ -160,8 +150,11 @@ With these constraints in mind, let's check some deployment strategies.
 
 ## Strategies
 
-### Single application
-The most simple strategy is a single project with one or more sites and the admin interface in the same project.
+Below we'll describe some common deployment strategies but Beacon is not limited to the strategies below,
+you can adapt to your needs.
+
+### 1. Single application on same host
+The most simple strategy is a single project with one or more sites and the admin interface in the same host.
 
 ```elixir
 # endpoint
@@ -197,7 +190,7 @@ flowchart TD
     r3["mysite.com/admin"] --> Admin
 ```
 
-### Clustered single applications
+### 2. Clustered single applications
 Same project as the previous strategy but with multiple nodes deployed in the same cluster.
 
 ```mermaid
@@ -235,7 +228,7 @@ flowchart TD
     r3["mysite.com/admin"] --> Node2Admin
 ```
 
-### Clustered applications with separated admin
+### 3. Clustered applications with separated admin
 You can observe the previous strategy duplicates the admin interface in each node, which works fairly well when you have
 no more than a couple of sites, but that setup tends to become harder to manage and also become a waste of resources
 if you start booting more site and more nodes.
@@ -288,16 +281,26 @@ flowchart TD
 
 A huge benefit of this topology is the flexibility to protect the Admin interface behind a VPN or scale it independently from the main applications.
 
-### Multiple hosts in single project, separated hosting apps
+### 4. Multiple hosts in single project, separated hosting apps
 Still a single project but now serving multiple sites at the root path for different dynamic hosts.
 
-In this example let's assume the most simple scenario where you'd create a new app in the hosting platform
-to serve each domain:
+In this case we're still deploying just one application but serving multiple domains for each site:
+
+- :campaigns -> campaigns.mysite.com
+- :root -> mysite.com
+
+TODO: diagram
+
+TODO: gen task and constraints
+
+### 5. Multiple hosts in single project, separated hosting apps
+Similar to the previous strategy but this time we're splitting each domain into its own app:
 
 - App1 -> mysite.com
 - App2 -> campaigns.mysite.com
 
-That means isolated apps not connected to each other, just sharing the same codebase.
+That means deploying isolated apps for each domain/site, not connected to each other,
+but still sharing the same codebase.
 
 ```elixir
 # endpoint
@@ -349,7 +352,7 @@ flowchart TD
     r4["campaigns.mysite.com/admin"] --> Node2Admin
 ```
 
-### Multiple hosts in single project, connected hosting apps
+### 6. Multiple hosts in single project, connected hosting apps
 Similar setup as the previous strategy but now connecting the apps in the same cluster with a separated admin interface.
 
 ```elixir
@@ -400,4 +403,4 @@ flowchart TD
     r1["mysite.com/campaigns/christmas"] --> n2_site
     r2["mysite.com/contact"] --> n1_site
     r3["admin.mysite.com"] --> Admin
-```
+```

guides/deployment/deployment-topologies.md

@@ -29,10 +29,14 @@ a site prefix can never match and it will never receive requests.
 
 That's is not necessarily an error if you have multiple sites in the same project
 and each scope is filtering requests on the `:host` option.
+But it may indicate:
 
-But it may indicate an invalid configuration, as a preceding route matching the prefix
+1. An invalid configuration, as a preceding route matching the prefix
 that was supposed to be handled by this site, or an invalid `:host` value.
 
+2. Missing `use Beacon.Router` and/or missing `beacon_site` in your
+app's router file.
+
 Note that if you're using `:host` on the scope and running in `localhost`,
 consider adding `"localhost"` to the list of allowed hosts.
 
@@ -41,4 +45,4 @@ Also check the [Beacon.Router](https://hexdocs.pm/beacon/Beacon.Router.html) for
 ## RuntimeError - could not find persistent term for endpoint
 
 `Beacon` should be started after your host's `Endpoint`, please review the application children
-and make sure is declared after the endpoint.
+and make sure is declared after the endpoint.

guides/general/troubleshooting.md

@@ -0,0 +1,36 @@
+defmodule Beacon.Igniter do
+  @moduledoc false
+
+  def select_router!(igniter, opts \\ []) do
+    label = Keyword.get(opts, :label)
+    raise_msg = Keyword.get(opts, :raise_msg, "No router found.")
+
+    case Igniter.Libs.Phoenix.select_router(igniter, label) do
+      {_igniter, nil} -> Mix.raise(raise_msg)
+      found -> found
+    end
+  end
+
+  def select_endpoint(igniter, router, label \\ "Which endpoint should be modified?") do
+    case Igniter.Libs.Phoenix.endpoints_for_router(igniter, router) do
+      {igniter, []} ->
+        {igniter, nil}
+
+      {igniter, [endpoint]} ->
+        {igniter, endpoint}
+
+      {igniter, endpoints} ->
+        {igniter, Igniter.Util.IO.select(label, endpoints, display: &inspect/1)}
+    end
+  end
+
+  def select_endpoint!(igniter, router, opts \\ []) do
+    label = Keyword.get(opts, :label)
+    raise_msg = Keyword.get(opts, :raise_msg, "No endpoint found.")
+
+    case select_endpoint(igniter, router, label) do
+      {_igniter, nil} -> Mix.raise(raise_msg)
+      found -> found
+    end
+  end
+end

lib/beacon/igniter.ex

@@ -17,9 +17,32 @@ defmodule Beacon.Plug do
   """
   @behaviour Plug
 
+  @private_routes [
+    "__beacon_check__",
+    "__beacon_assets__",
+    "__beacon_media__"
+  ]
+
   @impl Plug
   def init(_opts), do: []
 
   @impl Plug
-  def call(conn, _opts), do: Plug.Conn.put_session(conn, :beacon_variant_roll, Enum.random(1..100))
+  def call(conn, _opts) do
+    if Enum.any?(@private_routes, &(&1 in conn.path_info)) do
+      conn
+    else
+      put_roll(conn)
+    end
+  end
+
+  defp put_roll(conn) do
+    path_list = conn.path_params["path"]
+
+    with %{private: %{phoenix_live_view: {_, _, %{extra: %{session: %{"beacon_site" => site}}}}}} <- conn,
+         {_, _} <- Beacon.RouterServer.lookup_path(site, path_list, 1) do
+      Plug.Conn.put_session(conn, "beacon_variant_roll", Enum.random(1..100))
+    else
+      _ -> conn
+    end
+  end
 end

lib/beacon/plug.ex

@@ -6,6 +6,8 @@ defmodule Beacon.Private do
 
   # Should be avoided as much as possible.
 
+  @phoenix_live_view_version to_string(Application.spec(:phoenix_live_view)[:vsn])
+
   @doc """
   On page navigation, the request might actually hit a different site than the one defined by the current session.
 
@@ -20,7 +22,7 @@ defmodule Beacon.Private do
   We use the private function `Phoenix.LiveView.Route.live_link_info/3` in order to keep the same behavior as LV.
   """
   def site_from_session(endpoint, router, url, view) do
-    case Phoenix.LiveView.Route.live_link_info(endpoint, router, url) do
+    case live_link_info(endpoint, router, url) do
       {_,
        %{
          view: ^view,
@@ -36,4 +38,14 @@ defmodule Beacon.Private do
         nil
     end
   end
+
+  if Version.compare(@phoenix_live_view_version, "1.0.0") == :gt do
+    defp live_link_info(endpoint, router, url) do
+      Phoenix.LiveView.Route.live_link_info_without_checks(endpoint, router, url)
+    end
+  else
+    defp live_link_info(endpoint, router, url) do
+      Phoenix.LiveView.Route.live_link_info(endpoint, router, url)
+    end
+  end
 end

lib/beacon/private.ex

@@ -0,0 +1,49 @@
+defmodule Beacon.ProxyEndpoint do
+  @moduledoc false
+
+  # Proxy Endpoint to redirect requests to each site endpoint in a multiple domains setup.
+  #
+  #     TODO: beacon.deploy.add_domain fobar
+  #
+  #     TODO: use Beacon.ProxyEndpoint, otp_app: :my_app, endpoints: [MyAppWeb.EndpointSiteA, MyAppWeb.EndpointSiteB]
+
+  defmacro __using__(opts) do
+    quote location: :keep, generated: true do
+      otp_app = Keyword.get(unquote(opts), :otp_app) || raise Beacon.RuntimeError, "missing required option :otp_app in Beacon.ProxyEndpoint"
+
+      session_options =
+        Keyword.get(unquote(opts), :session_options) || raise Beacon.RuntimeError, "missing required option :session_options in Beacon.ProxyEndpoint"
+
+      Module.put_attribute(__MODULE__, :session_options, session_options)
+
+      fallback = Keyword.get(unquote(opts), :fallback) || raise Beacon.RuntimeError, "missing required option :fallback in Beacon.ProxyEndpoint"
+      Module.put_attribute(__MODULE__, :__beacon_proxy_fallback__, fallback)
+
+      use Phoenix.Endpoint, otp_app: otp_app
+
+      socket "/live", Phoenix.LiveView.Socket,
+        websocket: [connect_info: [session: @session_options]],
+        longpoll: [connect_info: [session: @session_options]]
+
+      plug :proxy
+
+      def proxy(conn, opts) do
+        %{host: host} = conn
+
+        # TODO: cache endpoint resolver
+        endpoint =
+          Enum.reduce_while(Beacon.Registry.running_sites(), @__beacon_proxy_fallback__, fn site, default ->
+            %{endpoint: endpoint} = Beacon.Config.fetch!(site)
+
+            if endpoint.host() == host do
+              {:halt, endpoint}
+            else
+              {:cont, default}
+            end
+          end)
+
+        endpoint.call(conn, endpoint.init(opts))
+      end
+    end
+  end
+end