Basic NGSI-LD active measures support by jason-fox · Pull Request #841 · telefonicaid/iotagent-node-lib

jason-fox · 2020-02-07T13:55:48Z

This PR offers NGSI-LD support for active measures only under the following configuration.

contextBroker: {
            url: 'https://192.168.1.1:1026',
            ngsiVersion: 'ld',
            jsonLdContext: 'http://context.json-ld'
        },

The existing NGSI-v2 support remains as default under ngsiVersion: 'v2'

The NGSI-LD support matches the decision trees for NGSI v1/v2 - where necessary a third option has been added and the necessary functionality duplicated.

The set of tests from NGSI v2 have been duplicated and the expectations amended where necessary.

Commands, Subscriptions and Lazy Attribute Support have not been added - disabled test stubs have been created to allow them to be tested once the code base has been updated.

This can act as a good regression point for NGSI-v2 and NGSI-LD capabilities.

Only forwarded request tests need to be disabled.

- Remove console.error statements. - Allow for disabled tests. - remove unused comparision

jason-fox · 2020-02-11T08:33:40Z

The tests cases are copies of the NGSI-v2 tests. The disabled tests are for commands and lazy attributes and therefore will not work until the remaining work is done.

Given that the tests are all new, I'm wondering - for the tests only should I:

a) Make minimal duplicate and amend changes (as is)
b) Prettify the changed test files - to reduce the scope of #753
c) Update the tests to run using ES6 syntax - to reduce the scope of #831

jason-fox · 2020-02-11T08:36:28Z

The command stubs account for the 2% drop in code coverage.

fgalan · 2020-02-11T12:53:50Z

CHANGES_NEXT_RELEASE

 Fix: Error message when sending measures with unknown/undefined attribute
-Add Null check within executeWithSecurity() to avoid crash (#829)
+Add Null check within executeWithSecurity() to avoid crash (#829)
+Add NGSIv2 metadata support to attributeAlias plugin.


This line seems to belong to PR #839. Thus, I understand that jason-fox:feature/ngsi-ld-measure is a branch of jason-fox:feature/add-v2-metadata.

PR #839 should be merged before, then this PR updated.

Correct - this PR is dependent upon and extends the metadata change.

PR #839 has been merged. This PR branch should be upgrade, then this diff will disappear.

I've merge master which should reduce the diff - Fixed with dd81751

fgalan · 2020-02-11T12:56:16Z

Given that the tests are all new, I'm wondering - for the tests only should I:

a) Make minimal duplicate and amend changes (as is)
b) Prettify the changed test files - to reduce the scope of #753
c) Update the tests to run using ES6 syntax - to reduce the scope of #831

Given that these .js files are entirely new, maybe it makes sense to do so.

fgalan · 2020-02-11T12:56:57Z

The command stubs account for the 2% drop in code coverage.

Not a big issue from my point of view. The drop will be eventually recovered.

jason-fox · 2020-02-11T16:54:15Z

Given that these .js files are entirely new, maybe it makes sense to do so.

Fixed (new tests only) 40875e3 - I also corrected the copyrights for the new files to 2020

…ngsi-ld-measure Applying telefonicaid#839 and telefonicaid#840 to reduce diff with master

fgalan · 2020-02-26T11:53:09Z

lib/services/devices/deviceService.js

 }

+/**
+ * Creates the response handler for the initial entity creation request using NGSIv2.


Suggested change

* Creates the response handler for the initial entity creation request using NGSIv2.

* Creates the response handler for the initial entity creation request using NGSI-LD.

Fixed b41a18a

fgalan · 2020-02-26T11:53:39Z

lib/commonConfig.js

             'IOTA_POLLING_DAEMON_FREQ',
-             'IOTA_MULTI_CORE'
+             'IOTA_MULTI_CORE',
+             'IOTA_JSON_LD_CONTEXT'


New env var should be described in documentation.

Fixed b41a18a - Minimal Documentation for now.

fgalan · 2020-02-26T11:53:56Z

lib/commonConfig.js

@@ -91,7 +91,8 @@ function processEnvironmentVariables() {
             'IOTA_APPEND_MODE',


CHANGES_NEXT_RELEASE entry should be provided for this PR.

Fixed b41a18a

fgalan · 2020-02-26T11:54:33Z

lib/services/devices/deviceService.js


+
+/**
+ * Creates the initial entity representing the device in the Context Broker using NGSIv2.


Suggested change

* Creates the initial entity representing the device in the Context Broker using NGSIv2.

* Creates the initial entity representing the device in the Context Broker using NGSI-LD.

Fixed b41a18a

fgalan · 2020-02-26T11:55:01Z

lib/services/devices/deviceService.js

+
+
+/**
+ * Updates the entity representing the device in the Context Broker using NGSIv2.


Suggested change

* Updates the entity representing the device in the Context Broker using NGSIv2.

* Updates the entity representing the device in the Context Broker using NGSIv2.

Three times :) Please, do an overall check for this.

Fixed b41a18a

fgalan · 2020-02-26T11:56:26Z

lib/services/ngsi/ngsiService.js

+
+
+
+function convertNGSIv2ToLD(attr){


JavaDoc should be provided?

Fixed b41a18a

fgalan · 2020-02-26T11:56:37Z

lib/services/ngsi/ngsiService.js

+    return obj;
+}
+
+function formatAsNGSILD(json){


JavaDoc should be provided?

Fixed b41a18a

fgalan · 2020-02-26T11:57:27Z

lib/services/ngsi/ngsiService.js

+
+
+
+
+
+
+
+


Big bunch of empty blank lines... intentional?

Fixed b41a18a (if only this tidying could be done automatically)

fgalan · 2020-02-26T12:06:25Z

test/.jshintrc

    "predef":
        [
-            "describe", "beforeEach", "afterEach", "it"
+            "describe", "beforeEach", "afterEach", "it", "xdescribe", "xit"


I have check there are 26 xdescribe() statement and 4 xit() statement added in this PR.

I understand that the work in sucesive PRs within the NGSI-LD line will be re-enable them, isn't it?

- Update CNR - Add Docker ENV to docs - basic LD set-up documentation - amend copy-paste JavaDoc - add missing JavaDoc - remove blank lines.

fgalan · 2020-02-27T11:35:29Z

lib/services/devices/registrationUtils.js

+
+
+/**
+ * Sends a Context Provider registration or unregistration request to the Context Broker using NGSIv2.


Another one ;)

Suggested change

* Sends a Context Provider registration or unregistration request to the Context Broker using NGSIv2.

* Sends a Context Provider registration or unregistration request to the Context Broker using NGSI-LD.

Fixed a027234

fgalan · 2020-02-27T11:46:33Z

lib/services/ngsi/ngsiService.js


+
+/**
+ * Generate an operation handler for NGSIv2-based operations (query and update). The handler takes care of identifiying


Suggested change

* Generate an operation handler for NGSIv2-based operations (query and update). The handler takes care of identifiying

* Generate an operation handler for NGSI-LD-based operations (query and update). The handler takes care of identifiying

Fixed a027234

fgalan · 2020-02-27T11:47:39Z

lib/services/ngsi/ngsiService.js

+
+/**
+ * Makes an update in the Device's entity in the context broker, with the values given in the 'attributes' array. This
+ * array should comply to the NGSIv2's attribute format.


Suggested change

* array should comply to the NGSIv2's attribute format.

* array should comply to the NGSI-LD's attribute format.

Fixed a027234

fgalan · 2020-02-27T11:48:43Z

lib/services/ngsi/subscriptionService.js


+
+/**
+ * Makes a subscription for the given device's entity using NGSIv2, triggered by the given attributes.


Suggested change

* Makes a subscription for the given device's entity using NGSIv2, triggered by the given attributes.

* Makes a subscription for the given device's entity using NGSIv2, triggered by the given attributes.

Still too many of them... an overall review should be done.

Fixed a027234

This one was not fixed at the end (my fault: my suggestion was not correct in my first comment). Now it should be ok:

Suggested change

* Makes a subscription for the given device's entity using NGSIv2, triggered by the given attributes.

* Makes a subscription for the given device's entity using NGSI-LD, triggered by the given attributes.

Fixed c70d9ed

fgalan · 2020-02-27T19:59:37Z

lib/services/northBound/contextServer.js

    }
 }

+function handleNotificationNgsiLD(req, res, next) {


Missing Javadoc ?

Fixed c70d9ed

Fixed and Propagated (contextServer isn't the focus of Measures) : a5c650a

fgalan · 2020-02-27T19:59:54Z

lib/services/northBound/contextServer.js

    });
 }

+function queryErrorHandlingNgsiLD(error, req, res, next) {


Missing JavaDoc?

Fixed c70d9ed

Maybe github diff is fooling me, but it seems JavaDoc was not added here, despite the "Fixed ..." mark.

Can you check, please?

Fixed a5c650a

fgalan · 2020-02-27T20:00:20Z

lib/services/northBound/contextServer.js

    });
 }

+function updateErrorHandlingNgsiLD(error, req, res, next) {


Missing JavaDoc?

Fixed c70d9ed

Fixed: a5c650a

fgalan

LGTM

jason-fox added 5 commits February 7, 2020 13:35

Basic NSGI-LD Measures

055d343

NGSI-LD Tests

4d30d69

Fix tests - disable some additional NGSI-LD test fails.

f1d0201

This can act as a good regression point for NGSI-v2 and NGSI-LD capabilities.

Increase test coverage

03779ba

Only forwarded request tests need to be disabled.

Linting codebase

68b5f65

- Remove console.error statements. - Allow for disabled tests. - remove unused comparision

jason-fox mentioned this pull request Feb 7, 2020

Adding NGSI-LD support #842

Closed

jason-fox requested review from AlvaroVega and fgalan February 11, 2020 08:33

fgalan reviewed Feb 11, 2020

View reviewed changes

fgalan mentioned this pull request Feb 11, 2020

Prepend NGSI-v1 to the v1 tests, NGSI-v2 to the v2 tests #840

Merged

Prettify tests and update tests to use ES6

40875e3

jason-fox added 2 commits February 11, 2020 19:19

Merge commit '09048b9f0a799bff3ee394790c23c47bec5af727' into feature/…

dd81751

…ngsi-ld-measure Applying telefonicaid#839 and telefonicaid#840 to reduce diff with master

Tidy JSON response mocks

a2b334a

fgalan changed the base branch from master to feature/842_ngsi_ld February 13, 2020 09:00

fgalan reviewed Feb 26, 2020

View reviewed changes

jason-fox added 2 commits February 26, 2020 21:58

Changes after review.

b41a18a

- Update CNR - Add Docker ENV to docs - basic LD set-up documentation - amend copy-paste JavaDoc - add missing JavaDoc - remove blank lines.

Amend JavaDoc

2d849b0

fgalan reviewed Feb 27, 2020

View reviewed changes

More JavaDoc NGSI-v2 => NSGI-LD

a027234

fgalan reviewed Feb 27, 2020

View reviewed changes

jason-fox added 2 commits February 28, 2020 09:19

More JavaDoc - add missing headers

c70d9ed

And error handler JavaDoc

a5c650a

fgalan approved these changes Mar 2, 2020

View reviewed changes

fgalan merged commit cc42cb7 into telefonicaid:feature/842_ngsi_ld Mar 2, 2020

This was referenced Mar 2, 2020

[e2e testing] NGSI-LD #849

Merged

Add GeoJSON and DateTime, unitCode and observedAt NGSI-LD support #843

Merged

jason-fox mentioned this pull request Mar 4, 2020

Update NGSI support to use ES6 syntax. #850

Merged

jason-fox deleted the feature/ngsi-ld-measure branch March 4, 2020 19:17

	* Creates the response handler for the initial entity creation request using NGSIv2.
	* Creates the response handler for the initial entity creation request using NGSI-LD.

		@@ -91,7 +91,8 @@ function processEnvironmentVariables() {
		'IOTA_APPEND_MODE',



		/**
		* Creates the initial entity representing the device in the Context Broker using NGSIv2.



		/**
		* Updates the entity representing the device in the Context Broker using NGSIv2.



		/**
		* Sends a Context Provider registration or unregistration request to the Context Broker using NGSIv2.



		/**
		* Generate an operation handler for NGSIv2-based operations (query and update). The handler takes care of identifiying

	* array should comply to the NGSIv2's attribute format.
	* array should comply to the NGSI-LD's attribute format.



		/**
		* Makes a subscription for the given device's entity using NGSIv2, triggered by the given attributes.

Conversation

jason-fox commented Feb 7, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jason-fox commented Feb 11, 2020

Uh oh!

jason-fox commented Feb 11, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fgalan commented Feb 11, 2020

Uh oh!

fgalan commented Feb 11, 2020

Uh oh!

jason-fox commented Feb 11, 2020

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jason-fox Feb 26, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jason-fox commented Feb 7, 2020 •

edited

Loading

jason-fox Feb 26, 2020 •

edited

Loading