This repository has been archived by the owner on May 22, 2020. It is now read-only.
Run plugs on the socket before the actual action #10
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Frankt now allows the configuration of plugs that will be run before the actual action handler. The plugs may modify the socket and add assigns that can be used later either in another socket or in the action handler.
crbelaus
force-pushed
the
features/4-allow-plugs
branch
from
7634002 to
7929ca5
Compare
When a channel configures its plugs, it can add some extra options that will be later received in the plug when called.
Travis builds will now lint the project with Credo in strict mode. If any errors are found, the test won't be run.
crbelaus
force-pushed
the
features/4-allow-plugs
branch
from
095b821 to
de8863b
Compare
odarriba
reviewed
Jun 16, 2018
| end | ||
|
|
||
| @impl true | ||
| def call(%{private: %{frankt_module: frankt_module}}, _opts) do |
There was a problem hiding this comment.
Shouldn't this line pattern match to this?
def call(%{private: %{frankt_gettext: frankt_gettext, frankt_module: frankt_module}}, _opts) when not is_nil(frankt_gettext) do``` There was a problem hiding this comment.
I am taking a look at the code again and I think that the when not is_nil(frankt_gettext) guard can be omitted since it would previously match with the function declaration in line 10.
def call(socket = %{private: %{frankt_gettext: nil}}, _opts) do
invoke_action(socket)
endThe function clause order would be the following one:
- No Gettext configured: go ahead and invoke the action.
- Gettext configured and locale set: go ahead and invoke the action in an internationalized environment.
- Other cases (Gettext configured but no locale set), raise an error.
When using the `Frankt.Plug` module, it automatically declares the `Frankt.Plug` behaviour and imports the `Phoenix.Socket.assign/3` function into modules.
crbelaus
force-pushed
the
features/4-allow-plugs
branch
from
2ec41f4 to
a10dfbc
Compare
crbelaus
force-pushed
the
features/4-allow-plugs
branch
from
a10dfbc to
87a4fb2
Compare
|
I've been adding some more improvements to the docs and updating the README. The docs still require more improvements and updates, but I think that we can merge this branch and prepare the 1.0 release. The docs can be improved bit by bit over time. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request closes #4.
The main objective of this PR is to allow Frankt users to act on the socket before the action handler is executed.
Acting on the socket
In some projects we have found the need of performing certain actions on the socket even before running the action handler. For example: assigning certain values in the socket or setting up monitoring instrumentation.
Before this PR there was no way to perform those actions on the socket, so the only possibility was to throw all those responsibilities into the action handler. It was soon obvious that we can handle those cases in a better way.
We took the inspiration from the Plug package. Frankt channels can now implement a
plugsfunction which returns a list of modules implementing theFrankt.Plugbehaviour. Those modules are run in order and can do whathever they want with the socket: assigning or modifying values, pushing messages, setting up instrumentation, etc.As way to test the implementation and provide live documentation we reimplemented Frankt internals as a series of plugs, the last one being the action handler provided by the user. This has led to clearer and more modular code, while maintaing Frankt public interface unmodified.
Tasks
This is a detailed list of the tasks that have been done in this pull request:
I've also added Credo as a direct dependency so we can control the linting configuration and use the new checks that are not included in Ebert.