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.

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

Add watcher mode #19

Merged
merged 1 commit into from
May 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
211 changes: 105 additions & 106 deletions .github/workflows/elixir.yaml
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
name: Elixir CI


on:
push:
branches: [ "main" ] # adapt branch for project
branches: ["main"] # adapt branch for project
pull_request:
branches: [ "main" ] # adapt branch for project
branches: ["main"] # adapt branch for project

env:
MIX_ENV: test
Expand All @@ -21,107 +20,107 @@ jobs:
# Specify the OTP and Elixir versions to use when building
# and running the workflow steps.
matrix:
otp: ['25.0.4'] # Define the OTP version [required]
elixir: ['1.14.1'] # Define the elixir version [required]
otp: ["25.0.4"] # Define the OTP version [required]
elixir: ["1.14.1"] # Define the elixir version [required]
steps:
# Step: Setup Elixir + Erlang image as the base.
- name: Set up Elixir
uses: erlef/setup-beam@v1
with:
otp-version: ${{matrix.otp}}
elixir-version: ${{matrix.elixir}}
# Cache key based on Erlang/Elixir version and the mix.lock hash
- name: Restore PLT cache
id: plt_cache
uses: actions/cache/restore@v3
with:
key: |
plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
restore-keys: |
plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-
path: |
priv/plts

# By default, the GitHub Cache action will only save the cache if all steps in the job succeed,
# so we separate the cache restore and save steps in case running dialyzer fails.
- name: Save PLT cache
id: plt_cache_save
uses: actions/cache/save@v3
if: steps.plt_cache.outputs.cache-hit != 'true'
with:
key: |
plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
path: |
priv/plts
# Step: Check out the code.
- name: Checkout code
uses: actions/checkout@v3

# Step: Define how to cache deps. Restores existing cache if present.
- name: Cache deps
id: cache-deps
uses: actions/cache@v3
env:
cache-name: cache-elixir-deps
with:
path: deps
key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
restore-keys: |
${{ runner.os }}-mix-${{ env.cache-name }}-

# Step: Define how to cache the `_build` directory. After the first run,
# this speeds up tests runs a lot. This includes not re-compiling our
# project's downloaded deps every run.
- name: Cache compiled build
id: cache-build
uses: actions/cache@v3
env:
cache-name: cache-compiled-build
with:
path: _build
key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
restore-keys: |
${{ runner.os }}-mix-${{ env.cache-name }}-
${{ runner.os }}-mix-

# Step: Download project dependencies. If unchanged, uses
# the cached version.
- name: Install dependencies
run: mix deps.get

# Step: Compile the project treating any warnings as errors.
- name: Compiles without warnings
run: mix compile --warnings-as-errors

# Create PLTs if no cache was found
- name: Create PLTs
if: steps.plt_cache.outputs.cache-hit != 'true'
run: mix dialyzer --plt

# Step: Check that the checked in code has already been formatted.
- name: Check Formatting
run: mix format --check-formatted

# Step: Execute the tests.
- name: Run tests
run: mix test

# Step: Run Credo in Strict mode
- name: Run Credo Strict
run: mix credo --strict

# Step: Run Credo in Strict mode
- name: Run Sobelow
run: mix sobelow

# Step: Run deps audit
- name: Run Deps Audit
run: mix deps.audit

# Step: Run dialyzer
- name: Run Deps Audit
run: mix dialyzer

# Step: Check for unused dependencies in the project
- name: Check unused dependencies
run: mix deps.unlock --check-unused
# Step: Setup Elixir + Erlang image as the base.
- name: Set up Elixir
uses: erlef/setup-beam@v1
with:
otp-version: ${{matrix.otp}}
elixir-version: ${{matrix.elixir}}
# Cache key based on Erlang/Elixir version and the mix.lock hash
- name: Restore PLT cache
id: plt_cache
uses: actions/cache/restore@v3
with:
key: |
plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
restore-keys: |
plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-
path: |
priv/plts

# By default, the GitHub Cache action will only save the cache if all steps in the job succeed,
# so we separate the cache restore and save steps in case running dialyzer fails.
- name: Save PLT cache
id: plt_cache_save
uses: actions/cache/save@v3
if: steps.plt_cache.outputs.cache-hit != 'true'
with:
key: |
plt-${{ runner.os }}-${{ steps.beam.outputs.otp-version }}-${{ steps.beam.outputs.elixir-version }}-${{ hashFiles('**/mix.lock') }}
path: |
priv/plts
# Step: Check out the code.
- name: Checkout code
uses: actions/checkout@v3

# Step: Define how to cache deps. Restores existing cache if present.
- name: Cache deps
id: cache-deps
uses: actions/cache@v3
env:
cache-name: cache-elixir-deps
with:
path: deps
key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
restore-keys: |
${{ runner.os }}-mix-${{ env.cache-name }}-

# Step: Define how to cache the `_build` directory. After the first run,
# this speeds up tests runs a lot. This includes not re-compiling our
# project's downloaded deps every run.
- name: Cache compiled build
id: cache-build
uses: actions/cache@v3
env:
cache-name: cache-compiled-build
with:
path: _build
key: ${{ runner.os }}-mix-${{ env.cache-name }}-${{ hashFiles('**/mix.lock') }}
restore-keys: |
${{ runner.os }}-mix-${{ env.cache-name }}-
${{ runner.os }}-mix-

# Step: Download project dependencies. If unchanged, uses
# the cached version.
- name: Install dependencies
run: mix deps.get

# Step: Compile the project treating any warnings as errors.
- name: Compiles without warnings
run: mix compile --warnings-as-errors

# Create PLTs if no cache was found
- name: Create PLTs
if: steps.plt_cache.outputs.cache-hit != 'true'
run: mix dialyzer --plt

# Step: Check that the checked in code has already been formatted.
- name: Check Formatting
run: mix format --check-formatted

# Step: Execute the tests.
- name: Run tests
run: mix test

# Step: Run Credo in Strict mode
- name: Run Credo Strict
run: mix credo --strict

# Step: Run Credo in Strict mode
- name: Run Sobelow
run: mix sobelow --exit --ignore-files lib/watcher.ex

# Step: Run deps audit
- name: Run Deps Audit
run: mix deps.audit

# Step: Run dialyzer
- name: Run Deps Audit
run: mix dialyzer

# Step: Check for unused dependencies in the project
- name: Check unused dependencies
run: mix deps.unlock --check-unused
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,18 @@ end
To start the server up you can run `mix francis.server` or if you need a iex
console you can run with `iex -S mix francis.server`

## Watcher

If you want to have a watcher that will reload the server when you change your code:

```elixir
import Config

config :francis, watcher: true
```

It defaults to `false`

## Example of a router

```elixir
Expand Down
15 changes: 7 additions & 8 deletions lib/francis.ex
Original file line number Diff line number Diff line change
Expand Up @@ -20,9 +20,13 @@ defmodule Francis do
def start, do: start(nil, nil)

def start(_type, _args) do
children = [
{Bandit, [plug: __MODULE__] ++ Keyword.get(unquote(opts), :bandit_opts, [])}
]
watcher_spec =
if Application.get_env(:francis, :watcher, false), do: [{Francis.Watcher, []}], else: []

children =
[
{Bandit, [plug: __MODULE__] ++ Keyword.get(unquote(opts), :bandit_opts, [])}
] ++ watcher_spec

Supervisor.start_link(children, strategy: :one_for_one)
end
Expand Down Expand Up @@ -96,7 +100,6 @@ defmodule Francis do
end
```
"""

defmacro post(path, handler) do
quote location: :keep do
Plug.Router.post(unquote(path), do: handle_response(unquote(handler), var!(conn)))
Expand All @@ -118,7 +121,6 @@ defmodule Francis do
end
```
"""

defmacro put(path, handler) do
quote location: :keep do
Plug.Router.put(unquote(path), do: handle_response(unquote(handler), var!(conn)))
Expand All @@ -140,7 +142,6 @@ defmodule Francis do
end
```
"""

defmacro delete(path, handler) do
quote location: :keep do
Plug.Router.delete(unquote(path), do: handle_response(unquote(handler), var!(conn)))
Expand All @@ -162,7 +163,6 @@ defmodule Francis do
end
```
"""

defmacro patch(path, handler) do
quote location: :keep do
Plug.Router.patch(unquote(path), do: handle_response(unquote(handler), var!(conn)))
Expand All @@ -184,7 +184,6 @@ defmodule Francis do
end
```
"""

defmacro ws(path, handler) do
module_name =
path
Expand Down
35 changes: 35 additions & 0 deletions lib/watcher.ex
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
defmodule Francis.Watcher do
@moduledoc """
Watcher mode for development that checks modified time of your files and recompiles them
"""
use GenServer
require Logger

def start_link(_) do
GenServer.start_link(__MODULE__, %{files: %{}})
end

def init(state) do
Logger.debug("Development watch mode enabled")
Code.put_compiler_option(:ignore_module_conflict, true)
Process.send_after(self(), :check, 100)
{:ok, state}
end

def handle_info(:check, %{files: files} = state) do
files =
Enum.reduce(Path.wildcard("./**/*.{ex,exs}"), files, fn path, files ->
new_mtime = File.stat!(path).mtime

case Map.get(files, path) do
mtime when not is_nil(mtime) and new_mtime != mtime -> Code.eval_file(path)
_ -> nil
end

Map.put(files, path, File.stat!(path).mtime)
end)

Process.send_after(self(), :check, 100)
{:noreply, %{state | files: files}}
end
end
2 changes: 1 addition & 1 deletion mix.exs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
defmodule Francis.MixProject do
use Mix.Project

@version "0.1.4"
@version "0.1.5"

def project do
[
Expand Down
Loading
Loading