feat: add username on disconnect event (#84)

* feat: add username on disconnect event

* fix: fix lint error

* fix: lint issue

* fix: lint issue

* fix: lint issue

* fix: lint issue

* fix: auto generated file not generating

* fix: missing username on test case

* refactor: apply erlfmt

---------

Co-authored-by: Ken Kalang <ken.qalyubi@gojek.com>

Author: kenkalang

apps/vmq_diversity/src/vmq_diversity.app.src

@@ -53,8 +53,8 @@
 
             {vmq_diversity_plugin, on_offline_message, 5, []},
             {vmq_diversity_plugin, on_client_wakeup, 1, []},
-            {vmq_diversity_plugin, on_client_offline, 2, []},
-            {vmq_diversity_plugin, on_client_gone, 2, []},
+            {vmq_diversity_plugin, on_client_offline, 3, []},
+            {vmq_diversity_plugin, on_client_gone, 3, []},
             {vmq_diversity_plugin, on_session_expired, 1, []}
         ]},
         {db_config, [

apps/vmq_diversity/src/vmq_diversity_plugin.erl

@@ -51,8 +51,8 @@
     on_deliver/8,
     on_offline_message/5,
     on_client_wakeup/1,
-    on_client_offline/2,
-    on_client_gone/2,
+    on_client_offline/3,
+    on_client_gone/3,
     on_session_expired/1,
     on_delivery_complete/8,
     auth_on_register_m5/6,
@@ -624,20 +624,22 @@ on_client_wakeup(SubscriberId) ->
         {client_id, ClientId}
     ]).
 
-on_client_offline(SubscriberId, _) ->
+on_client_offline(SubscriberId, _, UserName) ->
     {MP, ClientId} = subscriber_id(SubscriberId),
     vmq_diversity_cache:clear_cache(MP, ClientId),
     all(on_client_offline, [
         {mountpoint, MP},
-        {client_id, ClientId}
+        {client_id, ClientId},
+        {username, nilify(UserName)}
     ]).
 
-on_client_gone(SubscriberId, _) ->
+on_client_gone(SubscriberId, _, UserName) ->
     {MP, ClientId} = subscriber_id(SubscriberId),
     vmq_diversity_cache:clear_cache(MP, ClientId),
     all(on_client_gone, [
         {mountpoint, MP},
-        {client_id, ClientId}
+        {client_id, ClientId},
+        {username, nilify(UserName)}
     ]).
 
 on_session_expired(SubscriberId) ->

apps/vmq_diversity/test/vmq_diversity_auth_cache_SUITE.erl

@@ -141,7 +141,7 @@ auth_cache_cleanup_test(_) ->
      {subscribe, SubscribeAcls}] = vmq_diversity_cache:entries(<<"">>, <<"allowed-subscriber-id">>),
     3 = length(PublishAcls),
     3 = length(SubscribeAcls),
-    vmq_plugin:all(on_client_offline, [allowed_subscriber_id(), reason()]),
+    vmq_plugin:all(on_client_offline, [allowed_subscriber_id(), reason(), username()]),
     [] = vmq_diversity_cache:entries(<<"">>, <<"allowed-subscriber-id">>).
 
 

apps/vmq_diversity/test/vmq_diversity_plugin_SUITE.erl

@@ -137,9 +137,9 @@ on_offline_message_test(_) ->
 on_client_wakeup_test(_) ->
     [next] = vmq_plugin:all(on_client_wakeup, [allowed_subscriber_id()]).
 on_client_offline_test(_) ->
-    [next] = vmq_plugin:all(on_client_offline, [allowed_subscriber_id(), reason()]).
+    [next] = vmq_plugin:all(on_client_offline, [allowed_subscriber_id(), reason(), username()]).
 on_client_gone_test(_) ->
-    [next] = vmq_plugin:all(on_client_gone, [allowed_subscriber_id(), reason()]).
+    [next] = vmq_plugin:all(on_client_gone, [allowed_subscriber_id(), reason(), username()]).
 on_session_expired_test(_) ->
     [next] = vmq_plugin:all(on_session_expired, [allowed_subscriber_id()]).
 

apps/vmq_events_sidecar/src/vmq_events_sidecar.app.src

@@ -23,10 +23,10 @@
             {vmq_events_sidecar_plugin, on_deliver, 8, []},
             {vmq_events_sidecar_plugin, on_offline_message, 5, []},
             {vmq_events_sidecar_plugin, on_client_wakeup, 1, []},
-            {vmq_events_sidecar_plugin, on_client_offline, 2, []},
+            {vmq_events_sidecar_plugin, on_client_offline, 3, []},
             {vmq_events_sidecar_plugin, on_session_expired, 1, []},
             {vmq_events_sidecar_plugin, on_delivery_complete, 8, []},
-            {vmq_events_sidecar_plugin, on_client_gone, 2, []},
+            {vmq_events_sidecar_plugin, on_client_gone, 3, []},
             {vmq_events_sidecar_plugin, on_message_drop, 3, []}
         ]}
     ]},

apps/vmq_events_sidecar/src/vmq_events_sidecar_format.erl

@@ -188,24 +188,26 @@ encode({on_client_wakeup, Timestamp, {MP, ClientId}}) ->
             timestamp = convert_timestamp(Timestamp)
         })
     );
-encode({on_client_offline, Timestamp, {MP, ClientId, Reason}}) ->
+encode({on_client_offline, Timestamp, {MP, ClientId, Reason, UserName}}) ->
     encode_envelope(
         "OnClientOffline",
         on_client_offline_pb:encode_msg(#'eventssidecar.v1.OnClientOffline'{
             client_id = ClientId,
             mountpoint = MP,
             timestamp = convert_timestamp(Timestamp),
-            reason = Reason
+            reason = Reason,
+            username = UserName
         })
     );
-encode({on_client_gone, Timestamp, {MP, ClientId, Reason}}) ->
+encode({on_client_gone, Timestamp, {MP, ClientId, Reason, UserName}}) ->
     encode_envelope(
         "OnClientGone",
         on_client_gone_pb:encode_msg(#'eventssidecar.v1.OnClientGone'{
             client_id = ClientId,
             mountpoint = MP,
             timestamp = convert_timestamp(Timestamp),
-            reason = Reason
+            reason = Reason,
+            username = UserName
         })
     );
 encode({on_session_expired, Timestamp, {MP, ClientId}}) ->

apps/vmq_events_sidecar/src/vmq_events_sidecar_plugin.erl

@@ -28,8 +28,8 @@
     on_deliver/8,
     on_offline_message/5,
     on_client_wakeup/1,
-    on_client_offline/2,
-    on_client_gone/2,
+    on_client_offline/3,
+    on_client_gone/3,
     on_session_expired/1,
     on_delivery_complete/8,
     on_message_drop/3
@@ -353,15 +353,15 @@ on_client_wakeup(SubscriberId) ->
     {MP, ClientId} = subscriber_id(SubscriberId),
     send_event(on_client_wakeup, {MP, ClientId}).
 
--spec on_client_offline(subscriber_id(), reason()) -> 'next'.
-on_client_offline(SubscriberId, Reason) ->
+-spec on_client_offline(subscriber_id(), reason(), username()) -> 'next'.
+on_client_offline(SubscriberId, Reason, UserName) ->
     {MP, ClientId} = subscriber_id(SubscriberId),
-    send_event(on_client_offline, {MP, ClientId, Reason}).
+    send_event(on_client_offline, {MP, ClientId, Reason, UserName}).
 
--spec on_client_gone(subscriber_id(), reason()) -> 'next'.
-on_client_gone(SubscriberId, Reason) ->
+-spec on_client_gone(subscriber_id(), reason(), username()) -> 'next'.
+on_client_gone(SubscriberId, Reason, UserName) ->
     {MP, ClientId} = subscriber_id(SubscriberId),
-    send_event(on_client_gone, {MP, ClientId, Reason}).
+    send_event(on_client_gone, {MP, ClientId, Reason, UserName}).
 
 -spec on_session_expired(subscriber_id()) -> 'next'.
 on_session_expired(SubscriberId) ->

apps/vmq_events_sidecar/test/events_sidecar_handler.erl

@@ -174,13 +174,13 @@ on_client_wakeup(#'eventssidecar.v1.OnClientWakeUp'{mountpoint = ?MOUNTPOINT_BIN
 
 
 on_client_offline(#'eventssidecar.v1.OnClientOffline'{mountpoint = ?MOUNTPOINT_BIN,
-                   client_id = BinPid, reason = ?REASON}) ->
+                   client_id = ?ALLOWED_CLIENT_ID, reason = ?REASON, username = BinPid}) ->
     Pid = list_to_pid(binary_to_list(BinPid)),
     Pid ! on_client_offline_ok.
 
 
 on_client_gone(#'eventssidecar.v1.OnClientGone'{mountpoint = ?MOUNTPOINT_BIN,
-                 client_id = BinPid, reason = ?REASON}) ->
+                 client_id = ?ALLOWED_CLIENT_ID, reason = ?REASON, username = BinPid}) ->
     Pid = list_to_pid(binary_to_list(BinPid)),
     Pid ! on_client_gone_ok.
 

apps/vmq_events_sidecar/test/vmq_events_sidecar_SUITE.erl

@@ -140,14 +140,14 @@ on_client_wakeup_test(_) ->
 on_client_offline_test(_) ->
     enable_hook(on_client_offline),
     Self = pid_to_bin(self()),
-    [ok] = vmq_plugin:all(on_client_offline, [{?MOUNTPOINT, Self}, ?REASON]),
+    [ok] = vmq_plugin:all(on_client_offline, [{?MOUNTPOINT, ?ALLOWED_CLIENT_ID}, ?REASON, Self]),
     ok = exp_response(on_client_offline_ok),
     disable_hook(on_client_offline).
 
 on_client_gone_test(_) ->
     enable_hook(on_client_gone),
     Self = pid_to_bin(self()),
-    [ok] = vmq_plugin:all(on_client_gone, [{?MOUNTPOINT, Self}, ?REASON]),
+    [ok] = vmq_plugin:all(on_client_gone, [{?MOUNTPOINT, ?ALLOWED_CLIENT_ID}, ?REASON, Self]),
     ok = exp_response(on_client_gone_ok),
     disable_hook(on_client_gone).
 

apps/vmq_proto/include/on_client_gone_pb.hrl

@@ -1,11 +1,11 @@
 %% -*- coding: utf-8 -*-
 %% Automatically generated, do not edit
-%% Generated by gpb_compile version 4.20.0
+%% Generated by gpb_compile version 4.21.5
 
 -ifndef(on_client_gone_pb).
 -define(on_client_gone_pb, true).
 
--define(on_client_gone_pb_gpb_version, "4.20.0").
+-define(on_client_gone_pb_gpb_version, "4.21.5").
 
 -ifndef('EVENTSSIDECAR.V1.ONCLIENTGONE_PB_H').
 -define('EVENTSSIDECAR.V1.ONCLIENTGONE_PB_H', true).
@@ -38,7 +38,9 @@
             | 'REASON_EXIT_SIGNAL_RECEIVED'
             | 'REASON_TCP_CLOSED'
             | integer()
-            | undefined
+            | undefined,
+        % = 5, optional
+        username = <<>> :: unicode:chardata() | undefined
     }
 ).
 -endif.