ScoriaWeb.DevEndpoint (scoria v0.1.2)

Copy Markdown View Source

Dev-only Phoenix endpoint for local development of the Scoria dashboard.

Compiled ONLY in :dev (see elixirc_paths/1 in mix.exs) and never shipped to Hex. Started via the :dev_children application hook (see the Scoria application module and config/dev.exs) so that mix phx.server serves the dashboard at http://localhost:4799/scoria for the screenshot/critique harness (mix scoria.ui.shots) and manual iteration.

Assets are inlined into the root layout at compile time by ScoriaWeb.Assets (the LiveDashboard/Oban-Web self-contained model), so no Plug.Static is required here — the page is fully styled and interactive on its own.

The endpoint process always starts (it backs LiveView/PubSub), but only binds the HTTP listener when running under mix phx.server. Plain mix tasks that call app.start (e.g. the --critique pass) therefore do NOT try to bind the port, avoiding "address already in use" when a server is already running.

Summary

Functions

Callback implementation for Plug.call/2.

Returns the child specification to start the endpoint under a supervision tree.

Returns the endpoint configuration for key

Reloads the configuration given the application environment changes.

Returns the host for the given endpoint.

Callback implementation for Plug.init/1.

Generates the path information when routing to this endpoint.

Generates the script name.

Returns the address and port that the server is running on

Starts the endpoint supervision tree.

Generates a base64-encoded cryptographic hash (sha512) to a static file in priv/static. Meant to be used for Subresource Integrity with CDNs.

Returns a two item tuple with the first item being the static_path and the second item being the static_integrity.

Generates a route to a static file in priv/static.

Generates the static URL without any path information.

Generates the endpoint base URL but as a URI struct.

Callback implementation for Phoenix.Endpoint.unsubscribe/1.

Generates the endpoint base URL without any path information.

Functions

broadcast(topic, event, msg)

Callback implementation for Phoenix.Endpoint.broadcast/3.

broadcast!(topic, event, msg)

Callback implementation for Phoenix.Endpoint.broadcast!/3.

broadcast_from(from, topic, event, msg)

Callback implementation for Phoenix.Endpoint.broadcast_from/4.

broadcast_from!(from, topic, event, msg)

Callback implementation for Phoenix.Endpoint.broadcast_from!/4.

call(conn, opts)

Callback implementation for Plug.call/2.

child_spec(opts)

Returns the child specification to start the endpoint under a supervision tree.

config(key, default \\ nil)

Returns the endpoint configuration for key

Returns default if the key does not exist.

config_change(changed, removed)

Reloads the configuration given the application environment changes.

host()

Returns the host for the given endpoint.

init(opts)

Callback implementation for Plug.init/1.

local_broadcast(topic, event, msg)

Callback implementation for Phoenix.Endpoint.local_broadcast/3.

local_broadcast_from(from, topic, event, msg)

Callback implementation for Phoenix.Endpoint.local_broadcast_from/4.

path(path)

Generates the path information when routing to this endpoint.

script_name()

Generates the script name.

server_info(scheme)

Returns the address and port that the server is running on

start_link(opts \\ [])

Starts the endpoint supervision tree.

All other options are merged into the endpoint configuration.

static_integrity(path)

Generates a base64-encoded cryptographic hash (sha512) to a static file in priv/static. Meant to be used for Subresource Integrity with CDNs.

static_lookup(path)

Returns a two item tuple with the first item being the static_path and the second item being the static_integrity.

static_path(path)

Generates a route to a static file in priv/static.

static_url()

Generates the static URL without any path information.

It uses the configuration under :static_url to generate such. It falls back to :url if :static_url is not set.

struct_url()

Generates the endpoint base URL but as a URI struct.

It uses the configuration under :url to generate such. Useful for manipulating the URL data and passing it to URL helpers.

subscribe(topic, opts \\ [])

Callback implementation for Phoenix.Endpoint.subscribe/2.

unsubscribe(topic)

Callback implementation for Phoenix.Endpoint.unsubscribe/1.

url()

Generates the endpoint base URL without any path information.

It uses the configuration under :url to generate such.