#1245: add SSE group and broadcast level control support

examples/sse.ps1

@@ -14,7 +14,7 @@ Start-PodeServer -Threads 3 {
 
     # open local sse connection, and send back data
     Add-PodeRoute -Method Get -Path '/data' -ScriptBlock {
-        Set-PodeSseConnection -Name 'Data' -Scope Local
+        ConvertTo-PodeSseConnection -Name 'Data' -Scope Local
         Send-PodeSseEvent -Id 1234 -EventType Action -Data 'hello, there!'
         Start-Sleep -Seconds 3
         Send-PodeSseEvent -Id 1337 -EventType BoldOne -Data 'general kenobi'
@@ -26,7 +26,7 @@ Start-PodeServer -Threads 3 {
     }
 
     Add-PodeRoute -Method Get -Path '/sse' -ScriptBlock {
-        Set-PodeSseConnection -Name 'Test'
+        ConvertTo-PodeSseConnection -Name 'Test'
     }
 
     Add-PodeTimer -Name 'SendEvent' -Interval 10 -ScriptBlock {

src/Listener/PodeHttpRequest.cs

@@ -36,6 +36,7 @@ public class PodeHttpRequest : PodeRequest
 
         public string SseClientId { get; private set; }
         public string SseClientName { get; private set; }
+        public string SseClientGroup { get; private set; }
         public bool HasSseClientId
         {
             get => !string.IsNullOrEmpty(SseClientId);
@@ -304,6 +305,7 @@ private int ParseHeaders(string[] reqLines, string newline)
             if (HasSseClientId)
             {
                 SseClientName = $"{Headers["X-Pode-Sse-Client-Name"]}";
+                SseClientGroup = $"{Headers["X-Pode-Sse-Client-Group"]}";
             }
 
             // keep-alive?

src/Listener/PodeListener.cs

@@ -135,7 +135,7 @@ public void AddSseConnection(PodeServerEvent sse)
             }
         }
 
-        public void SendSseEvent(string name, string[] clientIds, string eventType, string data, string id = null)
+        public void SendSseEvent(string name, string[] groups, string[] clientIds, string eventType, string data, string id = null)
         {
             Task.Factory.StartNew(() => {
                 if (!ServerEvents.ContainsKey(name))
@@ -155,12 +155,15 @@ public void SendSseEvent(string name, string[] clientIds, string eventType, stri
                         continue;
                     }
 
-                    ServerEvents[name][clientId].Context.Response.SendSseEvent(eventType, data, id);
+                    if (ServerEvents[name][clientId].IsForGroup(groups))
+                    {
+                        ServerEvents[name][clientId].Context.Response.SendSseEvent(eventType, data, id);
+                    }
                 }
             }, CancellationToken);
         }
 
-        public void CloseSseConnection(string name, string[] clientIds)
+        public void CloseSseConnection(string name, string[] groups, string[] clientIds)
         {
             Task.Factory.StartNew(() => {
                 if (!ServerEvents.ContainsKey(name))
@@ -180,7 +183,10 @@ public void CloseSseConnection(string name, string[] clientIds)
                         continue;
                     }
 
-                    ServerEvents[name][clientId].Context.Response.CloseSseConnection();
+                    if (ServerEvents[name][clientId].IsForGroup(groups))
+                    {
+                        ServerEvents[name][clientId].Context.Response.CloseSseConnection();
+                    }
                 }
             }, CancellationToken);
         }

src/Listener/PodeResponse.cs

@@ -193,7 +193,7 @@ public void Flush()
             }
         }
 
-        public string SetSseConnection(PodeSseScope scope, string clientId, string name, int retry, bool allowAllOrigins)
+        public string SetSseConnection(PodeSseScope scope, string clientId, string name, string group, int retry, bool allowAllOrigins)
         {
             // do nothing for no scope
             if (scope == PodeSseScope.None)
@@ -225,15 +225,20 @@ public string SetSseConnection(PodeSseScope scope, string clientId, string name,
             Headers.Set("X-Pode-Sse-Client-Id", clientId);
             Headers.Set("X-Pode-Sse-Client-Name", name);
 
+            if (!string.IsNullOrEmpty(group))
+            {
+                Headers.Set("X-Pode-Sse-Client-Group", group);
+            }
+
             // send headers, and open event
             Send();
             SendSseRetry(retry);
-            SendSseEvent("pode.open", $"{{\"clientId\":\"{clientId}\",\"name\":\"{name}\"}}");
+            SendSseEvent("pode.open", $"{{\"clientId\":\"{clientId}\",\"group\":\"{group}\",\"name\":\"{name}\"}}");
 
             // if global, cache connection in listener
             if (scope == PodeSseScope.Global)
             {
-                Context.Listener.AddSseConnection(new PodeServerEvent(Context, name, clientId));
+                Context.Listener.AddSseConnection(new PodeServerEvent(Context, name, group, clientId));
             }
 
             // return clientId

src/Listener/PodeServerEvent.cs

@@ -1,22 +1,40 @@
 using System;
+using System.Linq;
 
 namespace Pode
 {
     public class PodeServerEvent : IDisposable
     {
         public PodeContext Context { get; private set; }
         public string Name { get; private set; }
+        public string Group { get; private set; }
         public string ClientId { get; private set; }
         public DateTime Timestamp { get; private set; }
 
-        public PodeServerEvent(PodeContext context, string name, string clientId)
+        public PodeServerEvent(PodeContext context, string name, string group, string clientId)
         {
             Context = context;
             Name = name;
+            Group = group;
             ClientId = clientId;
             Timestamp = DateTime.UtcNow;
         }
 
+        public bool IsForGroup(string[] groups)
+        {
+            if (groups == default(string[]) || groups.Length == 0)
+            {
+                return true;
+            }
+
+            if (string.IsNullOrEmpty(Group))
+            {
+                return false;
+            }
+
+            return groups.Any(x => x.Equals(Group, StringComparison.OrdinalIgnoreCase));
+        }
+
         public void Dispose()
         {
             Context.Dispose(true);

src/Pode.psd1

@@ -91,15 +91,17 @@
         'Send-PodeResponse',
 
         # sse
-        'Set-PodeSseConnection',
+        'ConvertTo-PodeSseConnection',
         'Send-PodeSseEvent',
         'Close-PodeSseConnection',
         'Test-PodeSseClientIdSigned',
         'Test-PodeSseClientIdValid',
-        'Get-PodeSseClientId',
         'New-PodeSseClientId',
         'Enable-PodeSseSigning',
         'Disable-PodeSseSigning',
+        'Set-PodeSseBroadcastLevel',
+        'Get-PodeSseBroadcastLevel',
+        'Test-PodeSseBroadcastLevel',
 
         # utility helpers
         'Close-PodeDisposable',

src/Private/Context.ps1

@@ -159,9 +159,10 @@ function New-PodeContext {
     }
 
     $ctx.Server.Sse = @{
-        Signed = $false
-        Secret = $null
-        Strict = $false
+        Signed         = $false
+        Secret         = $null
+        Strict         = $false
+        BroadcastLevel = @{}
     }
 
     $ctx.Server.WebSockets = @{

src/Private/FileWatchers.ps1

@@ -91,6 +91,7 @@ function Start-PodeFileWatcherRunspace {
                             Parameters = @{}
                             Lockable   = $PodeContext.Threading.Lockables.Global
                             Timestamp  = [datetime]::UtcNow
+                            Metadata   = @{}
                         }
 
                         # do we have any parameters?

src/Private/PodeServer.ps1

@@ -147,6 +147,7 @@ function Start-PodeWebServer {
                                 AcceptEncoding   = $null
                                 Ranges           = $null
                                 Sse              = $null
+                                Metadata         = @{}
                             }
 
                             # if iis, and we have an app path, alter it
@@ -181,6 +182,7 @@ function Start-PodeWebServer {
 
                                 $WebEvent.Sse = @{
                                     Name        = $WebEvent.Request.SseClientName
+                                    Group       = $WebEvent.Request.SseClientGroup
                                     ClientId    = $WebEvent.Request.SseClientId
                                     LastEventId = $null
                                     IsLocal     = $false
@@ -379,6 +381,7 @@ function Start-PodeWebServer {
                             ClientId  = $context.Signal.ClientId
                             Timestamp = $context.Timestamp
                             Streamed  = $true
+                            Metadata  = @{}
                         }
 
                         # endpoint name

src/Private/Schedules.ps1

@@ -169,6 +169,7 @@ function Invoke-PodeInternalScheduleLogic {
             Event = @{
                 Lockable = $PodeContext.Threading.Lockables.Global
                 Sender   = $Schedule
+                Metadata = @{}
             }
         }
 

src/Private/Serverless.ps1

@@ -54,6 +54,7 @@ function Start-PodeAzFuncServer {
                 TransferEncoding = $null
                 AcceptEncoding   = $null
                 Ranges           = $null
+                Metadata         = @{}
             }
 
             $WebEvent.Endpoint.Address = ((Get-PodeHeader -Name 'host') -split ':')[0]
@@ -180,6 +181,7 @@ function Start-PodeAwsLambdaServer {
                 TransferEncoding = $null
                 AcceptEncoding   = $null
                 Ranges           = $null
+                Metadata         = @{}
             }
 
             $WebEvent.Endpoint.Protocol = (Get-PodeHeader -Name 'X-Forwarded-Proto')

src/Private/ServiceServer.ps1

@@ -14,6 +14,7 @@ function Start-PodeServiceServer {
                 # the event object
                 $ServiceEvent = @{
                     Lockable = $PodeContext.Threading.Lockables.Global
+                    Metadata = @{}
                 }
 
                 # invoke the service handlers

src/Private/SmtpServer.ps1

@@ -112,6 +112,7 @@ function Start-PodeSmtpServer {
                                 Name     = $null
                             }
                             Timestamp = [datetime]::UtcNow
+                            Metadata  = @{}
                         }
 
                         # endpoint name

src/Private/Tasks.ps1

@@ -80,6 +80,7 @@ function Invoke-PodeInternalTask {
             Event = @{
                 Lockable = $PodeContext.Threading.Lockables.Global
                 Sender   = $Task
+                Metadata = @{}
             }
         }
 

src/Private/TcpServer.ps1

@@ -98,6 +98,7 @@ function Start-PodeTcpServer {
                             }
                             Parameters = $null
                             Timestamp  = [datetime]::UtcNow
+                            Metadata   = @{}
                         }
 
                         # endpoint name

src/Private/Timers.ps1

@@ -75,6 +75,7 @@ function Invoke-PodeInternalTimer {
         $global:TimerEvent = @{
             Lockable = $PodeContext.Threading.Lockables.Global
             Sender   = $Timer
+            Metadata = @{}
         }
 
         # add main timer args

src/Private/WebSockets.ps1

@@ -64,6 +64,7 @@ function Start-PodeWebSocketRunspace {
                             Files     = $null
                             Lockable  = $PodeContext.Threading.Lockables.Global
                             Timestamp = [datetime]::UtcNow
+                            Metadata  = @{}
                         }
 
                         # find the websocket definition

src/Public/Cookies.ps1

@@ -29,6 +29,9 @@ Inform browsers to remove the cookie.
 .PARAMETER Secure
 Only allow the cookie on secure (HTTPS) connections.
 
+.PARAMETER Strict
+If supplied, the Secret will be extended using the client request's UserAgent and RemoteIPAddress.
+
 .EXAMPLE
 Set-PodeCookie -Name 'Views' -Value 2
 
@@ -117,6 +120,9 @@ The name of the cookie to retrieve.
 .PARAMETER Secret
 The secret used to unsign the cookie's value.
 
+.PARAMETER Strict
+If supplied, the Secret will be extended using the client request's UserAgent and RemoteIPAddress.
+
 .PARAMETER Raw
 If supplied, the cookie returned will be the raw .NET Cookie object for manipulation.
 
@@ -179,6 +185,9 @@ The name of the cookie to retrieve.
 .PARAMETER Secret
 The secret used to unsign the cookie's value.
 
+.PARAMETER Strict
+If supplied, the Secret will be extended using the client request's UserAgent and RemoteIPAddress.
+
 .EXAMPLE
 Get-PodeCookieValue -Name 'Views'
 
@@ -284,6 +293,9 @@ The name of the cookie to test.
 .PARAMETER Secret
 A secret to use for attempting to unsign the cookie's value.
 
+.PARAMETER Strict
+If supplied, the Secret will be extended using the client request's UserAgent and RemoteIPAddress.
+
 .EXAMPLE
 Test-PodeCookieSigned -Name 'Views' -Secret 'hunter2'
 #>

src/Public/Headers.ps1

@@ -14,6 +14,9 @@ The value to set against the header.
 .PARAMETER Secret
 If supplied, the secret with which to sign the header's value.
 
+.PARAMETER Strict
+If supplied, the Secret will be extended using the client request's UserAgent and RemoteIPAddress.
+
 .EXAMPLE
 Add-PodeHeader -Name 'X-AuthToken' -Value 'AA-BB-CC-33'
 #>
@@ -63,6 +66,9 @@ A hashtable of headers to be appended.
 .PARAMETER Secret
 If supplied, the secret with which to sign the header values.
 
+.PARAMETER Strict
+If supplied, the Secret will be extended using the client request's UserAgent and RemoteIPAddress.
+
 .EXAMPLE
 Add-PodeHeaderBulk -Values @{ Name1 = 'Value1'; Name2 = 'Value2' }
 #>
@@ -138,6 +144,9 @@ The name of the header to retrieve.
 .PARAMETER Secret
 The secret used to unsign the header's value.
 
+.PARAMETER Strict
+If supplied, the Secret will be extended using the client request's UserAgent and RemoteIPAddress.
+
 .EXAMPLE
 Get-PodeHeader -Name 'X-AuthToken'
 #>
@@ -184,6 +193,9 @@ The value to set against the header.
 .PARAMETER Secret
 If supplied, the secret with which to sign the header's value.
 
+.PARAMETER Strict
+If supplied, the Secret will be extended using the client request's UserAgent and RemoteIPAddress.
+
 .EXAMPLE
 Set-PodeHeader -Name 'X-AuthToken' -Value 'AA-BB-CC-33'
 #>
@@ -233,6 +245,9 @@ A hashtable of headers to be set.
 .PARAMETER Secret
 If supplied, the secret with which to sign the header values.
 
+.PARAMETER Strict
+If supplied, the Secret will be extended using the client request's UserAgent and RemoteIPAddress.
+
 .EXAMPLE
 Set-PodeHeaderBulk -Values @{ Name1 = 'Value1'; Name2 = 'Value2' }
 #>
@@ -282,6 +297,9 @@ The name of the header to test.
 .PARAMETER Secret
 A secret to use for attempting to unsign the header's value.
 
+.PARAMETER Strict
+If supplied, the Secret will be extended using the client request's UserAgent and RemoteIPAddress.
+
 .EXAMPLE
 Test-PodeHeaderSigned -Name 'X-Header-Name' -Secret 'hunter2'
 #>