Merge pull request #1302 from jason-fox/feature/exclusive-mode

fgalan · web-flow · commit 90046e8756c6 · 2023-03-14T15:38:22.000Z
Update to offer NGSI-LD 1.6.1. Registration
diff --git a/CHANGES_NEXT_RELEASE b/CHANGES_NEXT_RELEASE
@@ -1 +1,2 @@
-
+- Update to offer NGSI-LD 1.6.1. Registrations #1302
+- Document removal of support for NGSI-LD 1.3.1 Interface
diff --git a/doc/deprecated.md b/doc/deprecated.md
@@ -18,7 +18,7 @@ A list of deprecated features and the version in which they were deprecated foll
 -   Support to Node.js v8 in iotagent-node-lib 2.12.0 (finally removed in 2.13.0)
 -   Support to Node.js v10 in iotagent-node-lib 2.15.0 (finally removed in 2.16.0)
 -   Support to Node.js v12 in iotagent-node-lib 2.24.0 (finally removed in 2.25.0)
--   Support to NGSI-LD v1.3 in iotagent-node-lib 2.25.0
+-   Support to NGSI-LD v1.3 in iotagent-node-lib 2.25.0 (finally removed in 2.26.0)
 
 The use of Node.js v14 is highly recommended.
 
@@ -46,3 +46,4 @@ The following table provides information about the last iotagent-node-lib versio
 | Support to Node.js v8  | 2.12.0                                                | April 7th, 2020               |
 | Support to Node.js v10 | 2.15.0                                                | February 18th, 2021           |
 | Support to Node.js v12 | 2.24.0                                                | September 2nd, 2022           |
+| Support to NGSI-LD 1.3 | 2.25.0                                                | January 24th, 2023          |
diff --git a/lib/services/devices/registrationUtils.js b/lib/services/devices/registrationUtils.js
@@ -310,6 +310,7 @@ function sendRegistrationsNgsiLD(unregister, deviceData, callback) {
         return sendUnregistrationsNgsiLD(deviceData, callback);
     }
 
+    const operations = [];
     const properties = [];
     const lazy = deviceData.lazy || [];
     const commands = deviceData.commands || [];
@@ -321,6 +322,13 @@ function sendRegistrationsNgsiLD(unregister, deviceData, callback) {
         properties.push(element.name);
     });
 
+    if (lazy.length > 0){
+        operations.push('retrieveOps');  
+    }
+    if (commands.length > 0){
+         operations.push('updateOps'); 
+    }
+
     if (properties.length === 0) {
         logger.debug(context, 'Registration with Context Provider is not needed. Device without lazy atts or commands');
         return callback(null, deviceData);
@@ -348,10 +356,18 @@ function sendRegistrationsNgsiLD(unregister, deviceData, callback) {
             information: [
                 {
                     entities: [{ type: deviceData.type, id }],
-                    properties
+                    propertyNames: properties
                 }
             ],
+            mode: 'exclusive',
+            operations,
             endpoint: config.getConfig().providerUrl,
+            contextSourceInfo: [
+                {
+                    'key': 'jsonldContext',
+                    'value': config.getConfig().contextBroker.jsonLdContext
+                }
+            ],
             '@context': config.getConfig().contextBroker.jsonLdContext
         },
         headers: {
diff --git a/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgent1.json b/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgent1.json
@@ -1,18 +1,28 @@
 {
-    "@context": "http://context.json-ld",
-    "endpoint": "http://smartgondor.com",
-    "information": [
+  "type": "ContextSourceRegistration",
+  "information": [
+    {
+      "entities": [
         {
-            "entities": [
-                {
-                    "id": "urn:ngsi-ld:Light:light1",
-                    "type": "Light"
-                }
-            ],
-            "properties": [
-                "temperature"
-            ]
+          "type": "Light",
+          "id": "urn:ngsi-ld:Light:light1"
         }
-    ],
-    "type": "ContextSourceRegistration"
+      ],
+      "propertyNames": [
+        "temperature"
+      ]
+    }
+  ],
+  "mode": "exclusive",
+  "operations": [
+    "retrieveOps"
+  ],
+  "endpoint": "http://smartgondor.com",
+  "contextSourceInfo": [
+    {
+      "key": "jsonldContext",
+      "value": "http://context.json-ld"
+    }
+  ],
+  "@context": "http://context.json-ld"
 }
diff --git a/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgent2.json b/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgent2.json
@@ -1,18 +1,28 @@
 {
-  "type": "ContextSourceRegistration",
-  "information": [
-    {
-      "entities": [
+    "type": "ContextSourceRegistration",
+    "information": [
         {
-          "type": "Motion",
-          "id": "urn:ngsi-ld:Motion:motion1"
+            "entities": [
+                {
+                    "type": "Motion",
+                    "id": "urn:ngsi-ld:Motion:motion1"
+                }
+            ],
+            "propertyNames": [
+                "moving"
+            ]
         }
-      ],
-      "properties": [
-        "moving"
-      ]
-    }
-  ],
-  "endpoint": "http://smartgondor.com",
-  "@context": "http://context.json-ld"
-}
+    ],
+    "mode": "exclusive",
+    "operations": [
+        "retrieveOps"
+    ],
+    "endpoint": "http://smartgondor.com",
+    "contextSourceInfo":[
+      {
+        "key": "jsonldContext",
+        "value": "http://context.json-ld"
+      }
+    ],
+    "@context": "http://context.json-ld"
+}
diff --git a/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgent4.json b/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgent4.json
@@ -4,15 +4,25 @@
     {
       "entities": [
         {
-          "type": "RobotPre",
-          "id": "urn:ngsi-ld:RobotPre:TestRobotPre"
+          "type": "Light",
+          "id": "urn:ngsi-ld:Light:light1"
         }
       ],
-      "properties": [
-        "moving"
+      "propertyNames": [
+        "temperature"
       ]
     }
   ],
+  "mode": "exclusive",
+  "operations": [
+    "retrieveOps"
+  ],
   "endpoint": "http://smartgondor.com",
+  "contextSourceInfo": [
+    {
+      "key": "jsonldContext",
+      "value": "http://context.json-ld"
+    }
+  ],
   "@context": "http://context.json-ld"
-}
+}
diff --git a/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgentCommands.json b/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerIoTAgentCommands.json
@@ -1,6 +1,12 @@
 {
     "@context": "http://context.json-ld",
     "endpoint": "http://smartgondor.com",
+    "contextSourceInfo":[
+      {
+        "key": "jsonldContext",
+        "value": "http://context.json-ld"
+      }
+    ],
     "information": [
         {
             "entities": [
@@ -9,11 +15,13 @@
                     "type": "Robot"
                 }
             ],
-            "properties": [
+            "propertyNames": [
                 "position",
                 "orientation"
             ]
         }
     ],
+    "mode": "exclusive",
+    "operations" :["updateOps"],
     "type": "ContextSourceRegistration"
 }
diff --git a/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerProvisionedDevice.json b/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerProvisionedDevice.json
@@ -1,6 +1,12 @@
 {
     "@context": "http://context.json-ld",
     "endpoint": "http://smartgondor.com",
+    "contextSourceInfo":[
+      {
+        "key": "jsonldContext",
+        "value": "http://context.json-ld"
+      }
+    ],
     "information": [
         {
             "entities": [
@@ -9,11 +15,16 @@
                     "type": "TheLightType"
                 }
             ],
-            "properties": [
+            "propertyNames": [
                 "luminance",
                 "commandAttr"
             ]
         }
     ],
+    "mode": "exclusive",
+    "operations": [
+        "retrieveOps",
+        "updateOps"
+    ],
     "type": "ContextSourceRegistration"
 }
diff --git a/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerProvisionedDevice2.json b/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerProvisionedDevice2.json
@@ -1,6 +1,12 @@
 {
     "@context": "http://context.json-ld",
     "endpoint": "http://smartgondor.com",
+    "contextSourceInfo":[
+      {
+        "key": "jsonldContext",
+        "value": "http://context.json-ld"
+      }
+    ],
     "information": [
         {
             "entities": [
@@ -9,10 +15,12 @@
                     "type": "TheLightType"
                 }
             ],
-            "properties": [
+            "propertyNames": [
                 "luminance"
             ]
         }
     ],
+    "mode": "exclusive",
+    "operations" :["retrieveOps"],
     "type": "ContextSourceRegistration"
 }
diff --git a/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerProvisionedDeviceWithGroup.json b/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerProvisionedDeviceWithGroup.json
@@ -1,6 +1,12 @@
 {
     "@context": "http://context.json-ld",
     "endpoint": "http://smartgondor.com",
+    "contextSourceInfo":[
+      {
+        "key": "jsonldContext",
+        "value": "http://context.json-ld"
+      }
+    ],
     "information": [
         {
             "entities": [
@@ -9,13 +15,18 @@
                     "type": "TheLightType"
                 }
             ],
-            "properties": [
+            "propertyNames": [
                 "luminance",
                 "luminescence",
                 "commandAttr",
                 "wheel1"
             ]
         }
     ],
+    "mode": "exclusive",
+    "operations": [
+        "retrieveOps",
+        "updateOps"
+    ],
     "type": "ContextSourceRegistration"
 }
diff --git a/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerProvisionedDeviceWithGroup2.json b/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerProvisionedDeviceWithGroup2.json
@@ -1,6 +1,12 @@
 {
     "@context": "http://context.json-ld",
     "endpoint": "http://smartgondor.com",
+    "contextSourceInfo":[
+      {
+        "key": "jsonldContext",
+        "value": "http://context.json-ld"
+      }
+    ],
     "information": [
         {
             "entities": [
@@ -9,13 +15,18 @@
                     "type": "SensorMachine"
                 }
             ],
-            "properties": [
+            "propertyNames": [
                 "luminance",
                 "luminescence",
                 "commandAttr",
                 "wheel1"
             ]
         }
     ],
+    "mode": "exclusive",
+    "operations" : [
+        "retrieveOps",
+        "updateOps"
+    ],
     "type": "ContextSourceRegistration"
 }
diff --git a/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerProvisionedDeviceWithGroup3.json b/test/unit/ngsi-ld/examples/contextAvailabilityRequests/registerProvisionedDeviceWithGroup3.json
@@ -1,6 +1,12 @@
 {
     "@context": "http://context.json-ld",
     "endpoint": "http://smartgondor.com",
+    "contextSourceInfo":[
+      {
+        "key": "jsonldContext",
+        "value": "http://context.json-ld"
+      }
+    ],
     "information": [
         {
             "entities": [
@@ -9,10 +15,12 @@
                     "type": "Light"
                 }
             ],
-            "properties": [
+            "propertyNames": [
                 "temperature"
             ]
         }
     ],
+    "mode": "exclusive",
+    "operations" :["retrieveOps"],
     "type": "ContextSourceRegistration"
 }
diff --git a/test/unit/ngsi-ld/examples/contextAvailabilityRequests/updateCommands1.json b/test/unit/ngsi-ld/examples/contextAvailabilityRequests/updateCommands1.json
@@ -1,5 +1,11 @@
 {
     "type":"ContextSourceRegistration",
+    "contextSourceInfo":[
+      {
+        "key": "jsonldContext",
+        "value": "http://context.json-ld"
+      }
+    ],
     "information":[
         {
             "entities":[
@@ -8,11 +14,13 @@
                     "id":"urn:ngsi-ld:Light:light1"
                 }
             ],
-            "properties":[
+            "propertyNames":[
                 "move"
             ]
         }
     ],
+    "mode": "exclusive",
+    "operations":["updateOps"],
     "endpoint":"http://smartgondor.com",
     "@context": "http://context.json-ld"
-}
+}
diff --git a/test/unit/ngsi-ld/examples/contextAvailabilityRequests/updateIoTAgent1.json b/test/unit/ngsi-ld/examples/contextAvailabilityRequests/updateIoTAgent1.json
diff --git a/test/unit/ngsi-ld/examples/contextAvailabilityRequests/updateIoTAgent2.json b/test/unit/ngsi-ld/examples/contextAvailabilityRequests/updateIoTAgent2.json

Original file line number	Diff line number	Diff line change
`@@ -1 +1,2 @@`
`1`		`-`
	`1`	`+- Update to offer NGSI-LD 1.6.1. Registrations #1302`
	`2`	`+- Document removal of support for NGSI-LD 1.3.1 Interface`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,12 @@`
`1`	`1`	`{`
`2`	`2`	`"@context": "http://context.json-ld",`
`3`	`3`	`"endpoint": "http://smartgondor.com",`
	`4`	`+ "contextSourceInfo":[`
	`5`	`+ {`
	`6`	`+ "key": "jsonldContext",`
	`7`	`+ "value": "http://context.json-ld"`
	`8`	`+ }`
	`9`	`+ ],`
`4`	`10`	`"information": [`
`5`	`11`	`{`
`6`	`12`	`"entities": [`
`@@ -9,11 +15,13 @@`
`9`	`15`	`"type": "Robot"`
`10`	`16`	`}`
`11`	`17`	`],`
`12`		`- "properties": [`
	`18`	`+ "propertyNames": [`
`13`	`19`	`"position",`
`14`	`20`	`"orientation"`
`15`	`21`	`]`
`16`	`22`	`}`
`17`	`23`	`],`
	`24`	`+ "mode": "exclusive",`
	`25`	`+ "operations" :["updateOps"],`
`18`	`26`	`"type": "ContextSourceRegistration"`
`19`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,11 @@`
`1`	`1`	`{`
`2`	`2`	`"type":"ContextSourceRegistration",`
	`3`	`+ "contextSourceInfo":[`
	`4`	`+ {`
	`5`	`+ "key": "jsonldContext",`
	`6`	`+ "value": "http://context.json-ld"`
	`7`	`+ }`
	`8`	`+ ],`
`3`	`9`	`"information":[`
`4`	`10`	`{`
`5`	`11`	`"entities":[`
`@@ -8,11 +14,13 @@`
`8`	`14`	`"id":"urn:ngsi-ld:Light:light1"`
`9`	`15`	`}`
`10`	`16`	`],`
`11`		`- "properties":[`
	`17`	`+ "propertyNames":[`
`12`	`18`	`"move"`
`13`	`19`	`]`
`14`	`20`	`}`
`15`	`21`	`],`
	`22`	`+ "mode": "exclusive",`
	`23`	`+ "operations":["updateOps"],`
`16`	`24`	`"endpoint":"http://smartgondor.com",`
`17`	`25`	`"@context": "http://context.json-ld"`
`18`		`-}`
	`26`	`+}`