https://github.com/dhonysilva/shire
Application based on the Ash's official documentation for multi tenancy utilizing the :attribute strategy
https://github.com/dhonysilva/shire
ash elixir multitenancy phoenix-framework
Last synced: 6 months ago
JSON representation
Application based on the Ash's official documentation for multi tenancy utilizing the :attribute strategy
- Host: GitHub
- URL: https://github.com/dhonysilva/shire
- Owner: dhonysilva
- Created: 2025-01-25T20:18:30.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-02-02T14:36:21.000Z (8 months ago)
- Last Synced: 2025-02-02T15:28:36.670Z (8 months ago)
- Topics: ash, elixir, multitenancy, phoenix-framework
- Language: Elixir
- Homepage:
- Size: 86.9 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Shire, multitenacy application with Ash Framework
Application created during the process of learning how to develop applications utilizing the multitenacy capability with Ash Framework.
In other project we studied the `:context` strategy, which uses postgres schemas where each tenant has its own database schema. On this strategy we can fetch data from each tenant by using the schema name as a prefix. For example, to fetch the tickets from tenant_01, tenant_02 e tenant_03 we can run the following query:
```sql
select * from tenant_01.tickets;
select * from tenant_02.tickets;
select * from tenant_03.tickets;
```
## :attribute Multitenancy strategy
For this current project, we're utilizing the `:attribute` strategy described [here](https://hexdocs.pm/ash/multitenancy.html#attribute-multitenancy).
This strategy implies that each tenant has an attribute `organization_id` that is used to filter the data.
The Ticket resource thas the `organization_id` Foreign Key, which is used to determine which tenant it belongs to.
```sql
select * from tickets;
```
| id | subject | status | organization_id |
| ---------- | ---------------------- | ------ | --------------- |
| 0d96594d | Cable doesn't work | open | 9e1c0c0a |
| b6f8ffee | Printer doesn't work | open | b948c8a3 |
| 69e44730 | Mouse doesn't work | open | b948c8a3 |
| 70c0d2ce | Screen broken | open | 9e1c0c0a |
| c74350d5 | Slow Internet | close | 9e1c0c0a |
| 83b6c16d | Fix the fan | close | 9e1c0c0a |
Each organization represents one tenant on the application. The organizations table has the following structure:
```sql
select * from organizations;
```
| id | name | domain |
| ---------- | --------- | ---------- |
| 9e1c0c0a | Tenant 01 | tenant_01 |
| b948c8a3 | Tenant 02 | tenant_02 |
## Learn more
I walked through the official Ash Multitenacy documentation while developing this project.
https://hexdocs.pm/ash/multitenancy.html
Kamaro Lambert [(visit the project here)](https://github.com/kamaroly/helpdesk) has provided two outstanding tutorials on how to work with Multitenancy utilizing the `:context` strategy and I used all of the instrunctions he provided to build this project. Here are the links to the tutorials:
- [Part 01](https://medium.com/@lambert.kamaro/how-to-build-a-saas-using-phoenix-and-ash-framework-1-4-69f3a622470d)
- [Part 02](https://medium.com/@lambert.kamaro/how-to-build-a-saas-using-phoenix-and-ash-framework-2-4-41ccbb8003fe)
### Setting up the project
To start this Phoenix server:
* Run `mix setup` to install and setup dependencies
* Run mix `mix ash.setup` to create the database and run the migrations.
* Start Phoenix endpoint with `mix phx.server` or inside IEx with `iex -S mix phx.server`
Now you can visit [`localhost:4000`](http://localhost:4000) from your browser.
The two routes available are:
* [`localhost:4000/tickets/`](http://localhost:4000/tickets/)
* [`localhost:4000/tickets/open`](http://localhost:4000/tickets/open)
### Working with data
Once you open the application, you can create organizations and tickets.
On the IEx console, you can create organizations by running the following commands:
```elixir
Shire.Accounts.create_organization(%{name: "Tenant_01", domain: "tenant_01"})
```
We will receive the following response:
```elixir
{:ok,
#Shire.Accounts.Organization<
__meta__: #Ecto.Schema.Metadata<:loaded, "organizations">,
id: "912b94c9-2990-427a-824d-1d6fb9b956c3",
name: "Tenant_01",
domain: "tenant_01",
went_live_at: nil,
email_domains: [],
inserted_at: ~U[2025-02-02 13:04:48.916403Z],
updated_at: ~U[2025-02-02 13:04:48.916403Z],
aggregates: %{},
calculations: %{},
...
>}
```
To list all organizations, run the following command:
```elixir
iex(2)> Shire.Accounts.list_organizations()
[debug] QUERY OK source="organizations" db=1.5ms queue=3.4ms idle=258.4ms
SELECT o0."id", o0."name", o0."domain", o0."email_domains", o0."inserted_at", o0."updated_at", o0."went_live_at" FROM "organizations" AS o0 []
↳ anonymous fn/3 in AshPostgres.DataLayer.run_query/2, at: lib/data_layer.ex:785
{:ok,
[
#Shire.Accounts.Organization<
__meta__: #Ecto.Schema.Metadata<:loaded, "organizations">,
id: "912b94c9-2990-427a-824d-1d6fb9b956c3",
name: "Tenant_01",
domain: "tenant_01",
went_live_at: nil,
email_domains: [],
inserted_at: ~U[2025-02-02 13:04:48.916403Z],
updated_at: ~U[2025-02-02 13:04:48.916403Z],
aggregates: %{},
calculations: %{},
...
>
]}
```
There are two ways to create a ticket with the IEx console:
```elixir
Shire.Support.Ticket
|> Ash.Changeset.for_create(:open, %{subject: "Config the printer"})
|> Ash.Changeset.set_tenant("9e1c0c0a-id-organization")
|> Ash.create!()
```
Or
```elixir
Shire.Support.open_ticket(%{subject: "Broken cable"}, tenant: "9e1c0c0a-id-organization")
```
### Fetching data
Some ways to fetch data from Tickets:
```elixir
Shire.Support.Ticket |> Ash.Query.filter(contains(subject, "5")) |> Ash.read!(tenant: "6b44e248-2011-465c-b52e-bf94c7baa950")
```
And also
```elixir
Shire.Support.Ticket |> Ash.Query.filter(status == :close and not(contains(subject, "5"))) |> Ash.read!(tenant: "6b44e248-2011-465c-b52e-bf94c7baa950")
```
### Dealing with building artifacts problems
Sometimes there's some incompatibilies with the files on `_build` folder. In this case, proceed with one of the steps below.
Clear and recompile modules with:
```bash
mix compile --force
```
Clear build artifacts and compile:
```bash
rm -rf _build
mix deps.compile
mix compile
```