Merge pull request #25 from diffo-dev/24-refactor-rsp-using-baseparty

refactor RSP as a BaseParty fragment with EPID as Party id

Author: matt-beanland

documentation/domains/diffo_example_nbn.livemd

@@ -9,7 +9,9 @@ SPDX-License-Identifier: MIT
 ```elixir
 Mix.install(
   [
-    {:diffo_example, "~> 0.2.0"},
+    # {:diffo_example, "~> 0.3.0"},
+    {:diffo_example, github: "diffo-dev/diffo_example", branch: "dev"},
+    {:diffo, github: "diffo-dev/diffo", branch: "dev", override: true},
     {:kino, "~> 0.14"},
     {:req, "~> 0.5"}
   ],
@@ -117,7 +119,9 @@ Speeds.speeds(:home_fast, :FixedWireless)
 
 ## Multi-tenancy
 
-Each RSP operates in isolation — they can only see and manage the resources they own. This multi-tenancy is enforced at the Ash policy layer: every NBN resource is stamped with the owning RSP's id at creation, and subsequent reads, updates, and destroys are scoped to the record owner.
+Each RSP operates in isolation — they can only see and manage the resources they own. This multi-tenancy is enforced at the Ash policy layer: every NBN resource is stamped with the owning RSP's EPID at creation, and subsequent reads, updates, and destroys are scoped to the record owner.
+
+RSP is modelled as a Party (using the `Diffo.Provider.BaseParty` fragment), with its EPID as the Party id. This means the `rsp_id` stamped on owned resources is a human-readable four-digit identifier rather than a UUID.
 
 Select the RSP you want to operate as for the rest of this livebook. All resources you build will be owned by that RSP and isolated from resources owned by others.
 
@@ -127,7 +131,7 @@ alias DiffoExample.Nbn.Rsp
 import Jason, only: [encode: 2]
 DiffoExample.Nbn.Initializer.init()
 rsps = Nbn.list_rsps!()
-Kino.DataTable.new(rsps, keys: [:epid, :name, :short_name, :state])
+Kino.DataTable.new(rsps, keys: [:id, :name, :short_name, :state])
 ```
 
 ```elixir

lib/nbn/initializer.ex

@@ -15,13 +15,13 @@ defmodule DiffoExample.Nbn.Initializer do
   alias DiffoExample.Nbn
 
   @rsps [
-    %{name: "Wedge-tail Telecom", short_name: :wedgetail, epid: "0001"},
-    %{name: "Quokka Connect",     short_name: :quokka,    epid: "0002"},
-    %{name: "Ibis Telecom",       short_name: :ibis,      epid: "0003"},
-    %{name: "Taipan Group",       short_name: :taipan,    epid: "0004"},
-    %{name: "Echidna Networks",   short_name: :echidna,   epid: "0005"},
-    %{name: "Dugong Digital",     short_name: :dugong,    epid: "0006"},
-    %{name: "Lyrebird",           short_name: :lyrebird,  epid: "0007"}
+    %{name: "Wedge-tail Telecom", short_name: :wedgetail, id: "0001"},
+    %{name: "Quokka Connect",     short_name: :quokka,    id: "0002"},
+    %{name: "Ibis Telecom",       short_name: :ibis,      id: "0003"},
+    %{name: "Taipan Group",       short_name: :taipan,    id: "0004"},
+    %{name: "Echidna Networks",   short_name: :echidna,   id: "0005"},
+    %{name: "Dugong Digital",     short_name: :dugong,    id: "0006"},
+    %{name: "Lyrebird",           short_name: :lyrebird,  id: "0007"}
   ]
 
   def init do
@@ -41,13 +41,13 @@ defmodule DiffoExample.Nbn.Initializer do
   defp seed_rsps do
     Enum.each(@rsps, fn attrs ->
       try do
-        case Nbn.get_rsp_by_epid(attrs.epid) do
+        case Nbn.get_rsp_by_epid(attrs.id) do
           {:ok, nil} -> seed_rsp(attrs)
           {:ok, _} -> :ok
           {:error, _} -> seed_rsp(attrs)
         end
       rescue
-        e -> require Logger; Logger.error("Exception seeding RSP #{attrs.epid}: #{inspect(e)}")
+        e -> require Logger; Logger.error("Exception seeding RSP #{attrs.id}: #{inspect(e)}")
       end
     end)
   end

lib/nbn/nbn.ex

@@ -163,10 +163,10 @@ defmodule DiffoExample.Nbn do
     end
 
     resource Rsp do
-      define :list_rsps, action: :list
-      define :get_rsp_by_epid, action: :read, get_by: :epid
+      define :list_rsps, action: :inventory
+      define :get_rsp_by_epid, action: :read, get_by: :id
       define :get_rsp_by_short_name, action: :read, get_by: :short_name
-      define :create_rsp, action: :create
+      define :create_rsp, action: :build
       define :activate_rsp, action: :activate
       define :suspend_rsp, action: :suspend
       define :deactivate_rsp, action: :deactivate

lib/nbn/resources/avc.ex

@@ -48,7 +48,7 @@ defmodule DiffoExample.Nbn.Avc do
   end
 
   attributes do
-    attribute :rsp_id, :uuid do
+    attribute :rsp_id, :string do
       description "the owning RSP's id — nil for Perentie-managed infrastructure"
       allow_nil? true
       public? true

lib/nbn/resources/cvc.ex

@@ -52,7 +52,7 @@ defmodule DiffoExample.Nbn.Cvc do
   end
 
   attributes do
-    attribute :rsp_id, :uuid do
+    attribute :rsp_id, :string do
       description "the owning RSP's id — nil for Perentie-managed infrastructure"
       allow_nil? true
       public? true

lib/nbn/resources/nbn_ethernet.ex

@@ -52,7 +52,7 @@ defmodule DiffoExample.Nbn.NbnEthernet do
   end
 
   attributes do
-    attribute :rsp_id, :uuid do
+    attribute :rsp_id, :string do
       description "the owning RSP's id — nil for Perentie-managed infrastructure"
       allow_nil? true
       public? true

lib/nbn/resources/nni.ex

@@ -48,7 +48,7 @@ defmodule DiffoExample.Nbn.Nni do
   end
 
   attributes do
-    attribute :rsp_id, :uuid do
+    attribute :rsp_id, :string do
       description "the owning RSP's id — nil for Perentie-managed infrastructure"
       allow_nil? true
       public? true

lib/nbn/resources/nni_group.ex

@@ -51,7 +51,7 @@ defmodule DiffoExample.Nbn.NniGroup do
   end
 
   attributes do
-    attribute :rsp_id, :uuid do
+    attribute :rsp_id, :string do
       description "the owning RSP's id — nil for Perentie-managed infrastructure"
       allow_nil? true
       public? true

lib/nbn/resources/rsp.ex

@@ -11,29 +11,31 @@ defmodule DiffoExample.Nbn.Rsp do
   An RSP is a licensed provider operating within the Perentie ecosystem.
   Each RSP is assigned an EPID (four-digit regulator-assigned identifier)
   and a short_name atom used as their actor identity for authorisation.
+
+  RSP is a Party of kind :organization. The EPID is used as the Party id (Neo4j key).
   """
 
   alias DiffoExample.Nbn
 
   use Ash.Resource,
     domain: Nbn,
-    data_layer: AshNeo4j.DataLayer,
     authorizers: [Ash.Policy.Authorizer],
-    extensions: [AshStateMachine, AshJason.Resource, AshJsonApi.Resource]
-
-  neo4j do
-    label :Rsp
-  end
+    extensions: [AshStateMachine, AshJsonApi.Resource],
+    fragments: [Diffo.Provider.BaseParty]
+
+  # BaseParty provides:
+  #   data_layer: AshNeo4j.DataLayer
+  #   extensions: AshJason.Resource, AshOutstanding.Resource, Diffo.Provider.Party.Extension
+  #   Neo4j label :Party (RSP nodes are Party nodes)
+  #   attributes: id (string/key), name, kind, created_at, updated_at
+  #   relationships: party_refs
+  #   actions: :read (primary), :destroy, :create (accept [:id,:name,:kind]),
+  #            :update (name), :list (unsorted), :find_by_name
 
   json_api do
     type "rsp"
   end
 
-  jason do
-    pick [:id, :name, :short_name, :epid, :state]
-    compact true
-  end
-
   state_machine do
     initial_states [:inactive]
     default_initial_state :inactive
@@ -47,59 +49,32 @@ defmodule DiffoExample.Nbn.Rsp do
   end
 
   attributes do
-    attribute :id, :uuid do
-      primary_key? true
-      allow_nil? false
-      public? true
-      default &Ash.UUID.generate/0
-      source :uuid
-    end
-
-    attribute :name, :string do
-      description "the RSP's registered trading name"
-      allow_nil? false
-      public? true
-    end
-
     attribute :short_name, :atom do
       description "atom identifier used as the actor for authorisation"
       allow_nil? false
       public? true
     end
 
-    attribute :epid, :string do
-      description "four-digit regulator-assigned provider identifier, in historical sequence"
-      allow_nil? false
-      public? true
-      constraints [match: ~r/^\d{4}$/]
-    end
-
     attribute :state, :atom do
       allow_nil? false
       default :inactive
       public? true
       constraints [one_of: [:active, :suspended, :inactive]]
     end
-
-    create_timestamp :created_at
-    update_timestamp :updated_at
   end
 
   actions do
-    defaults [:destroy]
-
-    read :read do
-      primary? true
-    end
-
-    read :list do
-      prepare build(sort: [epid: :asc])
+    create :build do
+      accept [:name, :short_name, :id]
+      upsert? true
+      change set_attribute(:kind, :organization)
+      validate match(:id, ~r/^\d{4}$/) do
+        message "must be a four-digit EPID"
+      end
     end
 
-    create :create do
-      accept [:name, :short_name, :epid]
-      upsert? true
-      upsert_identity :unique_epid
+    read :inventory do
+      prepare build(sort: [id: :asc])
     end
 
     update :activate do
@@ -119,7 +94,6 @@ defmodule DiffoExample.Nbn.Rsp do
   end
 
   identities do
-    identity :unique_epid, [:epid]
     identity :unique_name, [:name]
     identity :unique_short_name, [:short_name]
   end

mix.exs

@@ -45,7 +45,7 @@ defmodule DiffoExample.MixProject do
       nil -> default_version
       "local" -> [path: "../diffo"]
       "main" -> [git: "https://github.com/diffo-dev/diffo.git"]
-      "0.2.0" -> [git: "https://github.com/diffo-dev/diffo.git", tag: "v0.2.0"]
+      "dev" -> [git: "https://github.com/diffo-dev/diffo.git", branch: "dev"]
       version -> "~> #{version}"
     end
   end
@@ -86,7 +86,7 @@ defmodule DiffoExample.MixProject do
   # Run "mix help deps" to learn about dependencies.
   defp deps do
     [
-      {:diffo, diffo_version("~> 0.2.0")},
+      {:diffo, diffo_version([git: "https://github.com/diffo-dev/diffo.git", branch: "dev"])},
       {:ash_json_api, "~> 1.6"},
       {:plug_cowboy, "~> 2.7"},
       {:req, "~> 0.5", only: [:dev, :test]},