Minor fixes, tested current state unsubscribe on ws close

csw/CommandServer.py

@@ -190,6 +190,7 @@ async def _handleWs(self, request: Request) -> WebSocketResponse:
             elif msg.type == aiohttp.WSMsgType.ERROR:
                 print('Error: ws connection closed with exception %s' % ws.exception())
         print('websocket connection closed')
+        self.handler._unsubscribeCurrentState(ws)
         return ws
 
     @staticmethod

csw/ComponentHandlers.py

@@ -99,3 +99,11 @@ def _subscribeCurrentState(self, stateNames: List[str], ws: WebSocketResponse):
         else:
             for stateName in stateNames:
                 self._addCurrentStateSubscriber(stateName, ws)
+
+    def _unsubscribeCurrentState(self, ws: WebSocketResponse):
+        """
+        Internal method used to unsubscribe a websocket from current state events
+        """
+        for stateName in self._currentStateSubscribers:
+            if ws in self._currentStateSubscribers[stateName]:
+                self._currentStateSubscribers[stateName].remove(ws)

docs/CommandServer.html

@@ -184,7 +184,7 @@ <h1 class="title">Module <code>csw.CommandServer</code></h1>
             responseDict = commandResponse._asDict()
             return web.json_response(responseDict)
         else:
-            raise Exception(&#34;Invalid Location type: &#34; + method)
+            raise Exception(&#34;Invalid command type: &#34; + method)
 
     async def _handleQueryFinal(self, queryFinal: QueryFinal) -&gt; Response:
         commandResponse = await self._crm.waitForTask(queryFinal.runId, queryFinal.timeoutInSeconds)
@@ -218,6 +218,7 @@ <h1 class="title">Module <code>csw.CommandServer</code></h1>
             elif msg.type == aiohttp.WSMsgType.ERROR:
                 print(&#39;Error: ws connection closed with exception %s&#39; % ws.exception())
         print(&#39;websocket connection closed&#39;)
+        self.handler._unsubscribeCurrentState(ws)
         return ws
 
     @staticmethod
@@ -309,7 +310,7 @@ <h2 id="args">Args</h2>
             responseDict = commandResponse._asDict()
             return web.json_response(responseDict)
         else:
-            raise Exception(&#34;Invalid Location type: &#34; + method)
+            raise Exception(&#34;Invalid command type: &#34; + method)
 
     async def _handleQueryFinal(self, queryFinal: QueryFinal) -&gt; Response:
         commandResponse = await self._crm.waitForTask(queryFinal.runId, queryFinal.timeoutInSeconds)
@@ -343,6 +344,7 @@ <h2 id="args">Args</h2>
             elif msg.type == aiohttp.WSMsgType.ERROR:
                 print(&#39;Error: ws connection closed with exception %s&#39; % ws.exception())
         print(&#39;websocket connection closed&#39;)
+        self.handler._unsubscribeCurrentState(ws)
         return ws
 
     @staticmethod

docs/ComponentHandlers.html

@@ -91,8 +91,7 @@ <h1 class="title">Module <code>csw.ComponentHandlers</code></h1>
 
     def currentStates(self) -&gt; List[CurrentState]:
         &#34;&#34;&#34;
-        Returns the current state for the component
-        :stateName str: the name of the current state to get
+        Returns the current states for the component
         &#34;&#34;&#34;
         return []
 
@@ -127,7 +126,15 @@ <h1 class="title">Module <code>csw.ComponentHandlers</code></h1>
             self._addCurrentStateSubscriber(&#34;&#34;, ws)
         else:
             for stateName in stateNames:
-                self._addCurrentStateSubscriber(stateName, ws)</code></pre>
+                self._addCurrentStateSubscriber(stateName, ws)
+
+    def _unsubscribeCurrentState(self, ws: WebSocketResponse):
+        &#34;&#34;&#34;
+        Internal method used to unsubscribe a websocket from current state events
+        &#34;&#34;&#34;
+        for stateName in self._currentStateSubscribers:
+            if ws in self._currentStateSubscribers[stateName]:
+                self._currentStateSubscribers[stateName].remove(ws)</code></pre>
 </details>
 </section>
 <section>
@@ -203,8 +210,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
     def currentStates(self) -&gt; List[CurrentState]:
         &#34;&#34;&#34;
-        Returns the current state for the component
-        :stateName str: the name of the current state to get
+        Returns the current states for the component
         &#34;&#34;&#34;
         return []
 
@@ -239,24 +245,30 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             self._addCurrentStateSubscriber(&#34;&#34;, ws)
         else:
             for stateName in stateNames:
-                self._addCurrentStateSubscriber(stateName, ws)</code></pre>
+                self._addCurrentStateSubscriber(stateName, ws)
+
+    def _unsubscribeCurrentState(self, ws: WebSocketResponse):
+        &#34;&#34;&#34;
+        Internal method used to unsubscribe a websocket from current state events
+        &#34;&#34;&#34;
+        for stateName in self._currentStateSubscribers:
+            if ws in self._currentStateSubscribers[stateName]:
+                self._currentStateSubscribers[stateName].remove(ws)</code></pre>
 </details>
 <h3>Methods</h3>
 <dl>
 <dt id="csw.ComponentHandlers.ComponentHandlers.currentStates"><code class="name flex">
 <span>def <span class="ident">currentStates</span></span>(<span>self) ‑> List[<a title="csw.CurrentState.CurrentState" href="CurrentState.html#csw.CurrentState.CurrentState">CurrentState</a>]</span>
 </code></dt>
 <dd>
-<div class="desc"><p>Returns the current state for the component
-:stateName str: the name of the current state to get</p></div>
+<div class="desc"><p>Returns the current states for the component</p></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def currentStates(self) -&gt; List[CurrentState]:
     &#34;&#34;&#34;
-    Returns the current state for the component
-    :stateName str: the name of the current state to get
+    Returns the current states for the component
     &#34;&#34;&#34;
     return []</code></pre>
 </details>

docs/Event.html

@@ -172,7 +172,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="csw.Event.Event"><code class="flex name class">
 <span>class <span class="ident">Event</span></span>
-<span>(</span><span>source: str, eventName: str, paramSet: List[<a title="csw.Parameter.Parameter" href="Parameter.html#csw.Parameter.Parameter">Parameter</a>], eventTime: <a title="csw.EventTime.EventTime" href="EventTime.html#csw.EventTime.EventTime">EventTime</a> = EventTime(seconds=1611843294, nanos=818454980), eventId: str = '4b8f912d-259b-49b4-9ce7-47b21aa21b83')</span>
+<span>(</span><span>source: str, eventName: str, paramSet: List[<a title="csw.Parameter.Parameter" href="Parameter.html#csw.Parameter.Parameter">Parameter</a>], eventTime: <a title="csw.EventTime.EventTime" href="EventTime.html#csw.EventTime.EventTime">EventTime</a> = EventTime(seconds=1612987758, nanos=283993959), eventId: str = 'cd5d2f42-5458-4430-935b-96b9859e134d')</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Abstract base class that creates an Event that can be published to the event service
@@ -414,7 +414,7 @@ <h2 id="args">Args</h2>
 </dd>
 <dt id="csw.Event.ObserveEvent"><code class="flex name class">
 <span>class <span class="ident">ObserveEvent</span></span>
-<span>(</span><span>source: str, eventName: str, paramSet: List[<a title="csw.Parameter.Parameter" href="Parameter.html#csw.Parameter.Parameter">Parameter</a>], eventTime: <a title="csw.EventTime.EventTime" href="EventTime.html#csw.EventTime.EventTime">EventTime</a> = EventTime(seconds=1611843294, nanos=818454980), eventId: str = '4b8f912d-259b-49b4-9ce7-47b21aa21b83')</span>
+<span>(</span><span>source: str, eventName: str, paramSet: List[<a title="csw.Parameter.Parameter" href="Parameter.html#csw.Parameter.Parameter">Parameter</a>], eventTime: <a title="csw.EventTime.EventTime" href="EventTime.html#csw.EventTime.EventTime">EventTime</a> = EventTime(seconds=1612987758, nanos=283993959), eventId: str = 'cd5d2f42-5458-4430-935b-96b9859e134d')</span>
 </code></dt>
 <dd>
 <div class="desc"><p>An event type fired when an observation has taken place.</p>
@@ -491,7 +491,7 @@ <h3>Inherited members</h3>
 </dd>
 <dt id="csw.Event.SystemEvent"><code class="flex name class">
 <span>class <span class="ident">SystemEvent</span></span>
-<span>(</span><span>source: str, eventName: str, paramSet: List[<a title="csw.Parameter.Parameter" href="Parameter.html#csw.Parameter.Parameter">Parameter</a>], eventTime: <a title="csw.EventTime.EventTime" href="EventTime.html#csw.EventTime.EventTime">EventTime</a> = EventTime(seconds=1611843294, nanos=818454980), eventId: str = '4b8f912d-259b-49b4-9ce7-47b21aa21b83')</span>
+<span>(</span><span>source: str, eventName: str, paramSet: List[<a title="csw.Parameter.Parameter" href="Parameter.html#csw.Parameter.Parameter">Parameter</a>], eventTime: <a title="csw.EventTime.EventTime" href="EventTime.html#csw.EventTime.EventTime">EventTime</a> = EventTime(seconds=1612987758, nanos=283993959), eventId: str = 'cd5d2f42-5458-4430-935b-96b9859e134d')</span>
 </code></dt>
 <dd>
 <div class="desc"><p>An event type for publishing changes in system data.</p>

docs/LocationService.html

@@ -105,7 +105,7 @@ <h1 class="title">Module <code>csw.LocationService</code></h1>
         elif typ == &#34;AkkaLocation&#34;:
             return AkkaLocation.schema().loads(s)
         else:
-            raise Exception(&#34;Invalid Location type: &#34; + typ)
+            raise Exception(&#34;Invalid location type: &#34; + typ)
 
 
 _pdocIgnoreGenerated(&#34;AkkaLocation&#34;)
@@ -585,7 +585,7 @@ <h3>Class variables</h3>
         elif typ == &#34;AkkaLocation&#34;:
             return AkkaLocation.schema().loads(s)
         else:
-            raise Exception(&#34;Invalid Location type: &#34; + typ)</code></pre>
+            raise Exception(&#34;Invalid location type: &#34; + typ)</code></pre>
 </details>
 <h3>Subclasses</h3>
 <ul class="hlist">

examples/TestCommandServer.py

@@ -11,6 +11,7 @@
 
 
 class MyComponentHandlers(ComponentHandlers):
+    prefix = "CSW.pycswTest"
 
     async def longRunningCommand(self, runId: str, command: ControlCommand) -> CommandResponse:
         await asyncio.sleep(3)
@@ -71,9 +72,9 @@ def onOneway(self, runId: str, command: ControlCommand) -> CommandResponse:
         """
         n = len(command.paramSet)
         print(f"MyComponentHandlers Received oneway {str(command)} with {n} params")
-        filt = command.get("filter").values[0]
-        encoder = command.get("encoder").values[0]
-        print(f"filter = {filt}, encoder = {encoder}")
+        # filt = command.get("filter").values[0]
+        # encoder = command.get("encoder").values[0]
+        # print(f"filter = {filt}, encoder = {encoder}")
         return Accepted(runId)
 
     def validateCommand(self, runId: str, command: ControlCommand) -> CommandResponse:
@@ -96,8 +97,12 @@ def currentStates(self) -> List[CurrentState]:
         floatArrayParam = Parameter("FloatArrayValue", "FloatArrayKey", [[1.2, 2.3, 3.4], [5.6, 7.8, 9.1]], "marcsec")
         intMatrixParam = Parameter("IntMatrixValue", "IntMatrixKey",
                                    [[[1, 2, 3, 4], [5, 6, 7, 8]], [[-1, -2, -3, -4], [-5, -6, -7, -8]]], "meter")
-        return [CurrentState("csw.assembly", "PyCswState", [intParam, intArrayParam, floatArrayParam, intMatrixParam])]
+        return [CurrentState(self.prefix, "PyCswState", [intParam, intArrayParam, floatArrayParam, intMatrixParam])]
 
 
 # noinspection PyTypeChecker
-commandServer = CommandServer("csw.pycswTest", MyComponentHandlers())
+handlers = MyComponentHandlers()
+commandServer = CommandServer(handlers.prefix, handlers)
+handlers.commandServer = commandServer
+print(f"Starting test command server on port {commandServer.port}")
+commandServer.start()

tests/PyTestAssemblyEventHandlers.out

@@ -1,5 +1,3 @@
 {"_type":"SystemEvent","eventId":"test","source":"CSW.TestPublisher","eventName":"testEvent1","eventTime":"1970-01-01T00:00:00Z","paramSet":[{"DoubleKey":{"keyName":"assemblyEventValue","values":[42.0],"units":"NoUnits"}}]}
 {"_type":"SystemEvent","eventId":"test","source":"CSW.TestPublisher","eventName":"testEvent2","eventTime":"1970-01-01T00:00:00Z","paramSet":[{"IntKey":{"keyName":"IntValue","values":[42],"units":"arcsec"}},{"IntArrayKey":{"keyName":"IntArrayValue","values":[[1,2,3,4],[5,6,7,8]],"units":"NoUnits"}},{"FloatArrayKey":{"keyName":"FloatArrayValue","values":[[1.2,2.3,3.4],[5.6,7.8,9.1]],"units":"marcsec"}},{"IntMatrixKey":{"keyName":"IntMatrixValue","values":[[[1,2,3,4],[5,6,7,8]],[[-1,-2,-3,-4],[-5,-6,-7,-8]]],"units":"meter"}}]}
-{"_type":"SystemEvent","eventId":"test","source":"CSW.TestPublisher","eventName":"testEvent2","eventTime":"1970-01-01T00:00:00Z","paramSet":[{"IntKey":{"keyName":"IntValue","values":[42],"units":"arcsec"}},{"IntArrayKey":{"keyName":"IntArrayValue","values":[[1,2,3,4],[5,6,7,8]],"units":"NoUnits"}},{"FloatArrayKey":{"keyName":"FloatArrayValue","values":[[1.2,2.3,3.4],[5.6,7.8,9.1]],"units":"marcsec"}},{"IntMatrixKey":{"keyName":"IntMatrixValue","values":[[[1,2,3,4],[5,6,7,8]],[[-1,-2,-3,-4],[-5,-6,-7,-8]]],"units":"meter"}}]}
-{"_type":"SystemEvent","eventId":"test","source":"CSW.TestPublisher","eventName":"testEvent3","eventTime":"1970-01-01T00:00:00Z","paramSet":[{"StructKey":{"keyName":"MyStruct","values":[{"paramSet":[{"CoordKey":{"keyName":"CoordParam","values":[{"_type":"EqCoord","tag":"BASE","ra":659912249999,"dec":-109892300000,"frame":"FK5","catalogName":"none","pm":{"pmx":0.5,"pmy":2.33}},{"_type":"SolarSystemCoord","tag":"BASE","body":"Venus"},{"_type":"MinorPlanetCoord","tag":"GUIDER1","epoch":2000.0,"inclination":324000000000,"longAscendingNode":7200000000,"argOfPerihelion":360000000000,"meanDistance":1.4,"eccentricity":0.234,"meanAnomaly":792000000000},{"_type":"CometCoord","tag":"BASE","epochOfPerihelion":2000.0,"inclination":324000000000,"longAscendingNode":7200000000,"argOfPerihelion":360000000000,"perihelionDistance":1.4,"eccentricity":0.234},{"_type":"AltAzCoord","tag":"301 deg","alt":153000000000,"az":0}],"units":"NoUnits"}},{"ShortKey":{"keyName":"shortValue","values":[42],"units":"arcsec"}},{"BooleanKey":{"keyName":"booleanValue","values":[true,false],"units":"arcsec"}},{"IntArrayKey":{"keyName":"IntArrayValue","values":[[1,2,3,4],[5,6,7,8]],"units":"NoUnits"}},{"LongKey":{"keyName":"longValue","values":[42],"units":"arcsec"}},{"FloatKey":{"keyName":"floatValue","values":[42.1],"units":"arcsec"}},{"FloatArrayKey":{"keyName":"FloatArrayValue","values":[[1.2,2.3,3.4],[5.6,7.8,9.1]],"units":"arcsec"}},{"IntMatrixKey":{"keyName":"IntMatrixValue","values":[[[1,2,3,4],[5,6,7,8]],[[-1,-2,-3,-4],[-5,-6,-7,-8]]],"units":"meter"}},{"DoubleArrayKey":{"keyName":"DoubleArrayValue","values":[[1.2,2.3,3.4],[5.6,7.8,9.1]],"units":"arcsec"}},{"IntKey":{"keyName":"IntValue","values":[42],"units":"arcsec"}}]}],"units":"NoUnits"}},{"CoordKey":{"keyName":"CoordParam","values":[{"_type":"EqCoord","tag":"BASE","ra":659912249999,"dec":-109892300000,"frame":"FK5","catalogName":"none","pm":{"pmx":0.5,"pmy":2.33}},{"_type":"SolarSystemCoord","tag":"BASE","body":"Venus"},{"_type":"MinorPlanetCoord","tag":"GUIDER1","epoch":2000.0,"inclination":324000000000,"longAscendingNode":7200000000,"argOfPerihelion":360000000000,"meanDistance":1.4,"eccentricity":0.234,"meanAnomaly":792000000000},{"_type":"CometCoord","tag":"BASE","epochOfPerihelion":2000.0,"inclination":324000000000,"longAscendingNode":7200000000,"argOfPerihelion":360000000000,"perihelionDistance":1.4,"eccentricity":0.234},{"_type":"AltAzCoord","tag":"301 deg","alt":153000000000,"az":0}],"units":"NoUnits"}},{"ByteKey":{"keyName":"byteValue","values":[-34,-83,-66,-17],"units":"NoUnits"}},{"ShortKey":{"keyName":"shortValue","values":[42],"units":"arcsec"}},{"BooleanKey":{"keyName":"booleanValue","values":[true,false],"units":"arcsec"}},{"ByteArrayKey":{"keyName":"ByteArrayValue","values":[[-34,-83,-66,-17],[1,2,3,4]],"units":"NoUnits"}},{"IntArrayKey":{"keyName":"IntArrayValue","values":[[1,2,3,4],[5,6,7,8]],"units":"NoUnits"}},{"LongKey":{"keyName":"longValue","values":[42],"units":"arcsec"}},{"FloatKey":{"keyName":"floatValue","values":[42.1],"units":"arcsec"}},{"FloatArrayKey":{"keyName":"FloatArrayValue","values":[[1.2,2.3,3.4],[5.6,7.8,9.1]],"units":"arcsec"}},{"IntMatrixKey":{"keyName":"IntMatrixValue","values":[[[1,2,3,4],[5,6,7,8]],[[-1,-2,-3,-4],[-5,-6,-7,-8]]],"units":"meter"}},{"DoubleArrayKey":{"keyName":"DoubleArrayValue","values":[[1.2,2.3,3.4],[5.6,7.8,9.1]],"units":"arcsec"}},{"IntKey":{"keyName":"IntValue","values":[42],"units":"arcsec"}}]}
 {"_type":"SystemEvent","eventId":"test","source":"CSW.TestPublisher","eventName":"testEvent3","eventTime":"1970-01-01T00:00:00Z","paramSet":[{"StructKey":{"keyName":"MyStruct","values":[{"paramSet":[{"CoordKey":{"keyName":"CoordParam","values":[{"_type":"EqCoord","tag":"BASE","ra":659912249999,"dec":-109892300000,"frame":"FK5","catalogName":"none","pm":{"pmx":0.5,"pmy":2.33}},{"_type":"SolarSystemCoord","tag":"BASE","body":"Venus"},{"_type":"MinorPlanetCoord","tag":"GUIDER1","epoch":2000.0,"inclination":324000000000,"longAscendingNode":7200000000,"argOfPerihelion":360000000000,"meanDistance":1.4,"eccentricity":0.234,"meanAnomaly":792000000000},{"_type":"CometCoord","tag":"BASE","epochOfPerihelion":2000.0,"inclination":324000000000,"longAscendingNode":7200000000,"argOfPerihelion":360000000000,"perihelionDistance":1.4,"eccentricity":0.234},{"_type":"AltAzCoord","tag":"301 deg","alt":153000000000,"az":0}],"units":"NoUnits"}},{"ShortKey":{"keyName":"shortValue","values":[42],"units":"arcsec"}},{"BooleanKey":{"keyName":"booleanValue","values":[true,false],"units":"arcsec"}},{"IntArrayKey":{"keyName":"IntArrayValue","values":[[1,2,3,4],[5,6,7,8]],"units":"NoUnits"}},{"LongKey":{"keyName":"longValue","values":[42],"units":"arcsec"}},{"FloatKey":{"keyName":"floatValue","values":[42.1],"units":"arcsec"}},{"FloatArrayKey":{"keyName":"FloatArrayValue","values":[[1.2,2.3,3.4],[5.6,7.8,9.1]],"units":"arcsec"}},{"IntMatrixKey":{"keyName":"IntMatrixValue","values":[[[1,2,3,4],[5,6,7,8]],[[-1,-2,-3,-4],[-5,-6,-7,-8]]],"units":"meter"}},{"DoubleArrayKey":{"keyName":"DoubleArrayValue","values":[[1.2,2.3,3.4],[5.6,7.8,9.1]],"units":"arcsec"}},{"IntKey":{"keyName":"IntValue","values":[42],"units":"arcsec"}}]}],"units":"NoUnits"}},{"CoordKey":{"keyName":"CoordParam","values":[{"_type":"EqCoord","tag":"BASE","ra":659912249999,"dec":-109892300000,"frame":"FK5","catalogName":"none","pm":{"pmx":0.5,"pmy":2.33}},{"_type":"SolarSystemCoord","tag":"BASE","body":"Venus"},{"_type":"MinorPlanetCoord","tag":"GUIDER1","epoch":2000.0,"inclination":324000000000,"longAscendingNode":7200000000,"argOfPerihelion":360000000000,"meanDistance":1.4,"eccentricity":0.234,"meanAnomaly":792000000000},{"_type":"CometCoord","tag":"BASE","epochOfPerihelion":2000.0,"inclination":324000000000,"longAscendingNode":7200000000,"argOfPerihelion":360000000000,"perihelionDistance":1.4,"eccentricity":0.234},{"_type":"AltAzCoord","tag":"301 deg","alt":153000000000,"az":0}],"units":"NoUnits"}},{"ByteKey":{"keyName":"byteValue","values":[-34,-83,-66,-17],"units":"NoUnits"}},{"ShortKey":{"keyName":"shortValue","values":[42],"units":"arcsec"}},{"BooleanKey":{"keyName":"booleanValue","values":[true,false],"units":"arcsec"}},{"ByteArrayKey":{"keyName":"ByteArrayValue","values":[[-34,-83,-66,-17],[1,2,3,4]],"units":"NoUnits"}},{"IntArrayKey":{"keyName":"IntArrayValue","values":[[1,2,3,4],[5,6,7,8]],"units":"NoUnits"}},{"LongKey":{"keyName":"longValue","values":[42],"units":"arcsec"}},{"FloatKey":{"keyName":"floatValue","values":[42.1],"units":"arcsec"}},{"FloatArrayKey":{"keyName":"FloatArrayValue","values":[[1.2,2.3,3.4],[5.6,7.8,9.1]],"units":"arcsec"}},{"IntMatrixKey":{"keyName":"IntMatrixValue","values":[[[1,2,3,4],[5,6,7,8]],[[-1,-2,-3,-4],[-5,-6,-7,-8]]],"units":"meter"}},{"DoubleArrayKey":{"keyName":"DoubleArrayValue","values":[[1.2,2.3,3.4],[5.6,7.8,9.1]],"units":"arcsec"}},{"IntKey":{"keyName":"IntValue","values":[42],"units":"arcsec"}}]}

tests/testSupport/project/Common.scala

@@ -36,7 +36,7 @@ object Common extends AutoPlugin {
     ),
     resolvers ++= Seq(
       "jitpack" at "https://jitpack.io",
-      "bintray" at "https://jcenter.bintray.com",
+//      "bintray" at "https://jcenter.bintray.com",
       Resolver.bintrayRepo("lonelyplanet", "maven")
     ),
     version := "0.0.1",