feat: basepath routing for DevServer vhost emulation #59

andyl · 2024-01-05T07:25:46Z

This is a quick working solution to #57 - it allows the site developer to configure a :base_path attribute in config.exs.

The base_path attribute is used in router.ex to adjust the static path, and in Mix.Tasks.Tableau.Server to adjust the logger message.

If the :base_path is not set in config.exs, the system behaves just as it does now.

For my use case as described in #57, this solution works great!

If you reject this PR in favor of a better solution, no problemo. If you want docs, or tests etc. I will supply. Just putting this out there for ideas and feedback.

mhanberg · 2024-01-07T18:32:30Z

lib/mix/tasks/tableau.server.ex

+    case Application.get_env(:tableau, :config)[:base_path] do
+      "" -> ""
+      path -> "/" <> path
+    end


You can use Path.join/2 here

mhanberg · 2024-01-07T18:32:50Z

lib/tableau/router.ex

@@ -14,7 +16,7 @@ defmodule Tableau.Router do
  plug :rerender

  plug Tableau.IndexHtml
-  plug Plug.Static, at: "/", from: "_site", cache_control_for_etags: "no-cache"
+  plug Plug.Static, at: "/#{basepath}", from: "_site", cache_control_for_etags: "no-cache"


I would also use Path.join/2 here as well.

I used Path.join/2, and also fixed the warning associated with Application.get_env/2.

mhanberg · 2024-01-07T18:33:35Z

lib/tableau/config.ex

@@ -5,6 +5,7 @@ defmodule Tableau.Config do

  defstruct [
    :url,
+    base_path: "",


Please add documentation for this. Its in the Tableau moduledoc

andyl · 2024-01-08T00:14:49Z

I added Path.join/2, fixed a warning with Application.get_env/2 and added base_path moduledocs to tableau.ex.

mhanberg · 2024-01-08T01:47:46Z

lib/mix/tasks/tableau.server.ex

+    case Application.get_env(:tableau, :config)[:base_path] do
+      "" -> ""
+      path -> Path.join("/", path)
+    end


Suggested change

case Application.get_env(:tableau, :config)[:base_path] do

"" -> ""

path -> Path.join("/", path)

end

Path.join("/", Application.get_env(:tableau, :config)[:base_path])

mhanberg · 2024-01-08T01:53:49Z

lib/tableau.ex

@@ -4,9 +4,69 @@ defmodule Tableau do

  * `:include_dir` - string - Directory that is just copied to the output directory. Defaults to `extra`.
  * `:timezone` - string - Timezone to use when parsing date times. Defaults to `Etc/UTC`.
+  * `:base_path - string - base path to use with Github Pages or web-servers that use a location prefix for Vhosts


Suggested change

* `:base_path - string - base path to use with Github Pages or web-servers that use a location prefix for Vhosts

* `:base_path - string - Development server root . Defaults to `/`.

mhanberg · 2024-01-08T01:54:13Z

lib/tableau.ex

+
+  ## Working with Github Pages or web-server Vhosts
+
+  Github Pages provides a root url like `https://andyl.github.io/xmeyers`, where
+  the `xmeyers` prefix is a virtual host identifier tied to the repo at
+  `https://github.com/andyl/xmeyers`.
+
+  With Nginx and Apache it is common to use a location prefix for Vhosts.
+  Here is an example NGINX config snippet:
+
+  ```
+  server {
+    listen 80;
+    server_name myhost.com;
+
+    location /site1 {
+        # Configuration for site1 - eg the root directive to a directory
+        # root /var/www/site1;
+    }
+
+    location /site2 {
+        # Configuration for site2
+        # Similar configuration as site1, adjusted for site2 specifics
+    }
+
+    # Other configuration...
+  }
+  ```
+
+  To make Tableau's development server (`mix tableau.server`) also use a Vost
+  prefix, configure your app with the `:base_path` attribute.  With that, your
+  website HREFs will work in both development and production.
+
+  ## Example
+
+  In `config/config.exs`:
+
+  ```elixir
+  config :tableau, :config,
+    url: "http://localhost:4999",
+    base_path: "xmeyers",
+    markdown: [
+      ...
+    ]
+  ```
+
+  In `root_layout.ex`:
+
+  ```elixir
+  def template(assigns) do
+    ~H\"""
+    <!DOCTYPE html>
+    <html>
+      <head>
+        <title>Xmeyers</title>
+        <link rel="icon" href="/xmeyers/static/img/favicon.ico" type="image/x-icon" />
+        <link rel="stylesheet" type="text/css" href="/xmeyers/css/site.css" />
+     ...
+  ```


Delete all of this

mhanberg · 2024-01-08T01:54:44Z

lib/tableau/router.ex

@@ -6,6 +6,8 @@ defmodule Tableau.Router do

  require Logger

+  @base_path Path.join("/", Application.compile_env(:tableau, :config)[:base_path] || "")


I don't think you actually need the || "" since it defaults to ""

In my testing it defaults to nil, which causes Path.join/2 to raise an error.

Oh, sorry, I was thinking of the default coming from the struct. This is fine then, should also add to the other spot instead of that case expression

I took a closer look at this. Turns out there is a small difference in the arguments accepted by Application.get_env and Application.compile_env. I believe the forms I used are correct, and tested it with and without a base_path configuration.

…env`

andyl · 2024-01-08T02:54:53Z

All changes done.

mhanberg · 2024-01-08T14:10:27Z

awesome work, thanks!

andyl added 3 commits January 4, 2024 23:10

Add base_path for Vhost Path Prefix on DevServer

6ac028b

Merge branch 'elixir-tools:main' into basepath_routing

ff0fc09

Merge branch 'elixir-tools:main' into basepath_routing

36990fd

mhanberg reviewed Jan 7, 2024

View reviewed changes

andyl added 3 commits January 7, 2024 15:03

Merge branch 'elixir-tools:main' into basepath_routing

fdf49ca

basepath routing updates for PR elixir-tools#59

7e83c6d

Add backslash to fix formatting error

a51fa07

mhanberg reviewed Jan 8, 2024

View reviewed changes

andyl added 4 commits January 7, 2024 18:10

Remove documentation

588fc78

Make moduledoc comment more concise.

d79cccb

Replace case logic with one-line command

a97653b

Use default value for Application.compile_env, check for nil on `get_…

d2d8b79

…env`

mhanberg merged commit 641cb20 into elixir-tools:main Jan 8, 2024

github-actions bot mentioned this pull request Jan 8, 2024

chore(main): release 0.15.0 #66

Merged

andyl deleted the basepath_routing branch January 8, 2024 16:01

kevinschweikert mentioned this pull request Jan 28, 2024

fix: add base_path to config schema #68

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: basepath routing for DevServer vhost emulation #59

feat: basepath routing for DevServer vhost emulation #59

andyl commented Jan 5, 2024

mhanberg Jan 7, 2024

mhanberg Jan 7, 2024

andyl Jan 7, 2024

mhanberg Jan 7, 2024

andyl Jan 7, 2024

andyl commented Jan 8, 2024

mhanberg Jan 8, 2024

andyl Jan 8, 2024

mhanberg Jan 8, 2024

andyl Jan 8, 2024

mhanberg Jan 8, 2024

andyl Jan 8, 2024

mhanberg Jan 8, 2024

andyl Jan 8, 2024

mhanberg Jan 8, 2024

andyl Jan 8, 2024

andyl commented Jan 8, 2024

mhanberg commented Jan 8, 2024

	* `:base_path - string - base path to use with Github Pages or web-servers that use a location prefix for Vhosts
	* `:base_path - string - Development server root . Defaults to `/`.

		@@ -6,6 +6,8 @@ defmodule Tableau.Router do

		require Logger

		@base_path Path.join("/", Application.compile_env(:tableau, :config)[:base_path] \|\| "")

feat: basepath routing for DevServer vhost emulation #59

feat: basepath routing for DevServer vhost emulation #59

Conversation

andyl commented Jan 5, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andyl commented Jan 8, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

andyl commented Jan 8, 2024

mhanberg commented Jan 8, 2024