Merge pull request #406 from renatomassaro/notifications

Add Notification system

Author: renatomassaro

config/config.exs

@@ -9,6 +9,7 @@ config :helix,
     Helix.Entity.Repo,
     Helix.Log.Repo,
     Helix.Network.Repo,
+    Helix.Notification.Repo,
     Helix.Universe.Repo,
     Helix.Process.Repo,
     Helix.Server.Repo,

config/notification/config.exs

@@ -0,0 +1,10 @@
+use Mix.Config
+
+config :helix, Helix.Notification.Repo,
+  priv: "priv/repo/notification",
+  pool_size: 3,
+  adapter: Ecto.Adapters.Postgres,
+  username: System.get_env("HELIX_DB_USER") || "postgres",
+  password: System.get_env("HELIX_DB_PASS") || "postgres",
+  hostname: System.get_env("HELIX_DB_HOST") || "localhost",
+  types: HELL.PostgrexTypes

config/notification/dev.exs

@@ -0,0 +1,6 @@
+use Mix.Config
+
+prefix = System.get_env("HELIX_DB_PREFIX") || "helix"
+
+config :helix, Helix.Notification.Repo,
+  database: prefix <> "_dev_notification"

config/notification/prod.exs

@@ -0,0 +1,10 @@
+use Mix.Config
+
+prefix = "${HELIX_DB_PREFIX}"
+
+config :helix, Helix.Notification.Repo,
+  pool_size: "${HELIX_DB_POOL_SIZE}",
+  username: "${HELIX_DB_USER}",
+  password: "${HELIX_DB_PASS}",
+  hostname: "${HELIX_DB_HOST}",
+  database: prefix <> "_prod_notification"

config/notification/test.exs

@@ -0,0 +1,8 @@
+use Mix.Config
+
+prefix = System.get_env("HELIX_DB_PREFIX") || "helix"
+
+config :helix, Helix.Notification.Repo,
+  pool: Ecto.Adapters.SQL.Sandbox,
+  database: prefix <> "_test_notification",
+  ownership_timeout: 90_000

events.json

@@ -127,9 +127,9 @@
         "Steppable (custom)"
       ]
     },
-    "Notification": {
+    "Publication": {
       "receives": ["All"],
-      "emits": ["Notificable (custom)"]
+      "emits": ["Publishable (custom)"]
     }
   },
   "flows": {
@@ -173,7 +173,7 @@
     "File.Install.Processed",
     "File.Transfer.Processed"
   ],
-  "notificable": [
+  "publishable": [
     "Log.Created",
     "Log.Modified",
     "Log.Deleted",

graph.py

@@ -6,15 +6,15 @@
 
 handlers = events["handlers"]
 flows = events["flows"]
-notificable = events["notificable"]
+publishable = events["publishable"]
 missions = events["missions"]
 process_conclusion = events["process_conclusion"]
 
-def is_notificable(name):
-    return name in notificable
+def is_publishable(name):
+    return name in publishable
 
 def node_event(g, name):
-    color = 'lightblue4' if is_notificable(name) else 'lightblue2'
+    color = 'lightblue4' if is_publishable(name) else 'lightblue2'
     g.node(name, shape='box', color=color, style='filled')
 
 def node_handler(g, name):

lib/account/model/account.ex

@@ -8,6 +8,7 @@ defmodule Helix.Account.Model.Account do
 
   alias Comeonin.Bcrypt
   alias Ecto.Changeset
+  alias Helix.Entity.Model.Entity
 
   @type email :: String.t
   @type username :: String.t
@@ -89,6 +90,14 @@ defmodule Helix.Account.Model.Account do
   def check_password(account = %__MODULE__{}, pass),
     do: Bcrypt.checkpw(pass, account.password)
 
+  @spec cast_from_entity(Entity.id) ::
+    id
+  @doc """
+  "Translates" an Entity.id into Account.id
+  """
+  def cast_from_entity(entity_id = %Entity.ID{}),
+    do: __MODULE__.ID.cast!(to_string(entity_id))
+
   @spec generic_validations(Changeset.t) ::
     Changeset.t
   defp generic_validations(changeset) do

lib/account/public/index.ex

@@ -6,6 +6,7 @@ defmodule Helix.Account.Public.Index do
   alias Helix.Entity.Query.Entity, as: EntityQuery
   alias Helix.Network.Model.Bounce
   alias Helix.Network.Query.Bounce, as: BounceQuery
+  alias Helix.Notification.Public.Index.Account, as: AccountNotificationIndex
   alias Helix.Server.Model.Server
   alias Helix.Universe.Bank.Model.BankAccount
   alias Helix.Universe.Bank.Query.Bank, as: BankQuery
@@ -18,7 +19,8 @@ defmodule Helix.Account.Public.Index do
       inventory: InventoryIndex.index,
       bounces: [Bounce.t],
       database: DatabaseIndex.index,
-      bank_accounts: [BankAccount.t]
+      bank_accounts: [BankAccount.t],
+      notifications: AccountNotificationIndex.index
     }
 
   @type rendered_index ::
@@ -27,7 +29,8 @@ defmodule Helix.Account.Public.Index do
       inventory: InventoryIndex.rendered_index,
       bounces: [ClientRenderer.rendered_bounce],
       database: DatabaseIndex.rendered_index,
-      bank_accounts: [rendered_bank_account]
+      bank_accounts: [rendered_bank_account],
+      notifications: AccountNotificationIndex.rendered_index
     }
 
   @typep rendered_bank_account ::
@@ -56,7 +59,8 @@ defmodule Helix.Account.Public.Index do
       inventory: InventoryIndex.index(entity),
       bounces: bounces,
       database: DatabaseIndex.index(entity),
-      bank_accounts: BankQuery.get_accounts(account_id)
+      bank_accounts: BankQuery.get_accounts(account_id),
+      notifications: AccountNotificationIndex.index(account_id)
     }
   end
 
@@ -68,7 +72,8 @@ defmodule Helix.Account.Public.Index do
       inventory: InventoryIndex.render_index(index.inventory),
       bounces: Enum.map(index.bounces, &ClientRenderer.render_bounce/1),
       database: DatabaseIndex.render_index(index.database),
-      bank_accounts: Enum.map(index.bank_accounts, &render_bank_account/1)
+      bank_accounts: Enum.map(index.bank_accounts, &render_bank_account/1),
+      notifications: AccountNotificationIndex.render_index(index.notifications)
     }
   end
 

lib/account/websocket/channel/account.ex

@@ -2,7 +2,8 @@ import Helix.Websocket.Channel
 
 channel Helix.Account.Websocket.Channel.Account do
   @moduledoc """
-  Channel to notify an user of an action that affects them.
+  Two-way channel to receive requests and send out publications to an user about
+  actions that affects them.
   """
 
   alias Helix.Account.Websocket.Channel.Account.Join, as: AccountJoin
@@ -13,6 +14,7 @@ channel Helix.Account.Websocket.Channel.Account do
   alias Helix.Network.Websocket.Requests.Bounce.Create, as: BounceCreateRequest
   alias Helix.Network.Websocket.Requests.Bounce.Update, as: BounceUpdateRequest
   alias Helix.Network.Websocket.Requests.Bounce.Remove, as: BounceRemoveRequest
+  alias Helix.Notification.Websocket.Requests.Read, as: NotificationReadRequest
   alias Helix.Software.Websocket.Requests.Virus.Collect, as: VirusCollectRequest
   alias Helix.Story.Websocket.Requests.Email.Reply, as: EmailReplyRequest
 
@@ -59,7 +61,7 @@ channel Helix.Account.Websocket.Channel.Account do
   topic "client.setup", ClientSetupProxyRequest
 
   @doc """
-  Notifies the backend that `action` has been performed by the player.
+  Notifies Helix that `action` has been performed by the player.
 
   Params:
     *action: Action performed by the player. [0]
@@ -202,10 +204,42 @@ channel Helix.Account.Websocket.Channel.Account do
 
   Input:
   + base errors
-
   """
   topic "bounce.remove", BounceRemoveRequest
 
+  @doc """
+  Marks one (or all) notifications as read.
+
+  Params:
+    - notification_id: Which notification to mark as read. See [1].
+    - class: Which class the notification belongs to. See [1].
+
+  [1] - This request can be used to mark a single notification as read, or all
+    notifications within a class as read. If the `notification_id` param is
+    given, we assume only that notification must be marked as read. On the other
+    hand, if only `class` is given, we assume all notifications of that class
+    shall be marked as read. Only one of them must be given. If both are given,
+    we blow up and assume the client did not read this documentation.
+
+  Returns: :ok
+
+  Events:
+  - notification_read_event: Emitted when notification(s) are successfully read.
+
+  Errors:
+
+  Henforcer:
+  - notification_not_found: The given `notification_id` does not exist.
+  - notification_not_belongs: Client attempted to read a notification that
+    belongs to another user.
+
+  Input:
+  - read_the_docs: Client did not read the docs. See [1].
+  - bad_class: The given class is not valid.
+  + base errors
+  """
+  topic "notification.read", NotificationReadRequest
+
   @doc """
   Collects money off of active viruses.