Skip to content

Basic NGSI-LD active measures support #841

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
fgalan merged 13 commits into from
Mar 2, 2020
Merged

Basic NGSI-LD active measures support #841

Show file tree
Hide file tree
Changes from 8 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
055d343
Basic NSGI-LD Measures
jason-fox Feb 7, 2020
4d30d69
NGSI-LD Tests
jason-fox Feb 7, 2020
f1d0201
Fix tests - disable some additional NGSI-LD test fails.
jason-fox Feb 7, 2020
03779ba
Increase test coverage
jason-fox Feb 7, 2020
68b5f65
Linting codebase
jason-fox Feb 7, 2020
40875e3
Prettify tests and update tests to use ES6
jason-fox Feb 11, 2020
dd81751
Merge commit '09048b9f0a799bff3ee394790c23c47bec5af727' into feature/…
jason-fox Feb 11, 2020
a2b334a
Tidy JSON response mocks
jason-fox Feb 11, 2020
b41a18a
Changes after review.
jason-fox Feb 26, 2020
2d849b0
Amend JavaDoc
jason-fox Feb 26, 2020
a027234
More JavaDoc NGSI-v2 => NSGI-LD
jason-fox Feb 27, 2020
c70d9ed
More JavaDoc - add missing headers
jason-fox Feb 28, 2020
a5c650a
And error handler JavaDoc
jason-fox Feb 28, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion lib/commonConfig.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,8 @@ function processEnvironmentVariables() {
'IOTA_APPEND_MODE',
Copy link
Member

@fgalan fgalan Feb 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

CHANGES_NEXT_RELEASE entry should be provided for this PR.

Copy link
Contributor Author

@jason-fox jason-fox Feb 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed b41a18a

'IOTA_POLLING_EXPIRATION',
'IOTA_POLLING_DAEMON_FREQ',
'IOTA_MULTI_CORE'
'IOTA_MULTI_CORE',
'IOTA_JSON_LD_CONTEXT'
Copy link
Member

@fgalan fgalan Feb 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

New env var should be described in documentation.

Copy link
Contributor Author

@jason-fox jason-fox Feb 26, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Fixed b41a18a - Minimal Documentation for now.

],
iotamVariables = [
'IOTA_IOTAM_URL',
Expand Down Expand Up @@ -146,6 +147,9 @@ function processEnvironmentVariables() {
if (process.env.IOTA_CB_NGSI_VERSION) {
config.contextBroker.ngsiVersion = process.env.IOTA_CB_NGSI_VERSION;
}
if (process.env.IOTA_JSON_LD_CONTEXT){
config.contextBroker.jsonLdContext = process.env.IOTA_JSON_LD_CONTEXT;
}

// North Port Configuration (ensuring the configuration sub-object exists before start using it)
if (config.server === undefined) {
Expand Down Expand Up @@ -377,6 +381,21 @@ function checkNgsi2() {
return false;
}

/**
* It checks if the configuration file states the use of NGSI-LD
*
* @return {boolean} Result of the checking
*/
function checkNgsiLD() {
if (config.contextBroker &&
config.contextBroker.ngsiVersion &&
config.contextBroker.ngsiVersion === 'ld') {
return true;
}

return false;
}

function setSecurityService(newSecurityService) {
securityService = newSecurityService;
}
Expand All @@ -394,5 +413,6 @@ exports.getGroupRegistry = getGroupRegistry;
exports.setCommandRegistry = setCommandRegistry;
exports.getCommandRegistry = getCommandRegistry;
exports.checkNgsi2 = checkNgsi2;
exports.checkNgsiLD = checkNgsiLD;
exports.setSecurityService = setSecurityService;
exports.getSecurityService = getSecurityService;
4 changes: 2 additions & 2 deletions lib/plugins/attributeAlias.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ function extractAllMappings(typeInformation) {
function applyAlias(mappings) {
return function aliasApplier(attribute) {
if (mappings.direct[attribute.name]) {
if (config.checkNgsi2()) {
if (config.checkNgsi2() || config.checkNgsiLD()) {
/*jshint camelcase: false */
attribute.object_id = attribute.name; // inverse not usefull due to collision
}
Expand All @@ -96,7 +96,7 @@ function applyAlias(mappings) {
*/
function updateAttribute(entity, typeInformation, callback) {
var mappings = extractAllMappings(typeInformation);
if (config.checkNgsi2()) {
if (config.checkNgsi2() || config.checkNgsiLD()) {
var attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
attsArray = attsArray.map(applyAlias(mappings));
entity = utils.createNgsi2Entity(entity.id, entity.type, attsArray, true);
Expand Down
2 changes: 1 addition & 1 deletion lib/plugins/bidirectionalData.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ function sendSubscriptions(device, attributeList, callback) {

logger.debug(context, 'Sending bidirectionality subscriptions for device [%s]', device.id);

if (config.checkNgsi2()) {
if (config.checkNgsi2() || config.checkNgsiLD()) {
async.map(attributeList, sendSingleSubscriptionNgsi2, callback);
} else {
async.map(attributeList, sendSingleSubscriptionNgsi1, callback);
Expand Down
2 changes: 1 addition & 1 deletion lib/plugins/expressionParser.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ function expressionApplier(context, typeInformation) {
};

/*jshint camelcase: false */
if (config.checkNgsi2() && attribute.object_id) {
if (config.checkNgsi2() || config.checkNgsiLD() && attribute.object_id) {
newAttribute.object_id = attribute.object_id;
}

Expand Down
2 changes: 1 addition & 1 deletion lib/plugins/expressionPlugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ function update(entity, typeInformation, callback) {
}

try {
if (config.checkNgsi2()) {
if (config.checkNgsi2() || config.checkNgsiLD()) {
var attsArray = utils.extractAttributesArrayFromNgsi2Entity(entity);
attsArray = processEntityUpdateNgsi2(attsArray);
entity = utils.createNgsi2Entity(entity.id, entity.type, attsArray, true);
Expand Down
2 changes: 1 addition & 1 deletion lib/plugins/multiEntity.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,7 @@ function updateAttributeNgsi2(entity, typeInformation, callback) {
}

function updateAttribute(entity, typeInformation, callback) {
if (config.checkNgsi2()) {
if (config.checkNgsi2() || config.checkNgsiLD()) {
updateAttributeNgsi2(entity, typeInformation, callback);
} else {
updateAttributeNgsi1(entity, typeInformation, callback);
Expand Down
6 changes: 3 additions & 3 deletions lib/plugins/pluginUtils.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ function createProcessAttribute(fn, attributeType) {
attribute.value = fn(attribute.value);
}

if (config.checkNgsi2()) {
if (config.checkNgsi2() || config.checkNgsiLD()) {
// This code is backwards compatible to process metadata in the older NGSIv1-style (array)
// as well as supporting the newer NGSIv2-style (object). The redundant Array Check can be
// therefore be removed if/when NGSIv1 support is removed from the library.
Expand Down Expand Up @@ -152,7 +152,7 @@ function createUpdateFilter(fn, attributeType) {
return entity;
}

if (config.checkNgsi2()) {
if (config.checkNgsi2() || config.checkNgsiLD()) {
entity = processEntityUpdateNgsi2(entity);
} else {
entity.contextElements = entity.contextElements.map(processEntityUpdateNgsi1);
Expand Down Expand Up @@ -186,7 +186,7 @@ function createQueryFilter(fn, attributeType) {
return entity;
}

if (config.checkNgsi2()) {
if (config.checkNgsi2() || config.checkNgsiLD()) {
entity = processEntityQueryNgsi2(entity);
} else {
entity.contextResponses = entity.contextResponses.map(processEntityQueryNgsi1);
Expand Down
2 changes: 1 addition & 1 deletion lib/plugins/timestampProcessPlugin.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ function updatePluginNgsi1(entity, entityType, callback) {
* @param {Object} entity NGSI Entity as it would have been sent before the plugin.
*/
function updatePlugin(entity, entityType, callback) {
if (config.checkNgsi2()) {
if (config.checkNgsi2() || config.checkNgsiLD()) {
updatePluginNgsi2(entity, entityType, callback);
} else {
updatePluginNgsi1(entity, entityType, callback);
Expand Down
6 changes: 4 additions & 2 deletions lib/services/common/genericMiddleware.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ function handleError(error, req, res, next) {
function traceRequest(req, res, next) {
logger.debug(context, 'Request for path [%s] from [%s]', req.path, req.get('host'));

if (req.is('json')) {
if (req.is('json') || req.is('application/ld+json')) {
logger.debug(context, 'Body:\n\n%s\n\n', JSON.stringify(req.body, null, 4));
}

Expand Down Expand Up @@ -100,6 +100,8 @@ function getLogLevel(req, res, next) {
function ensureType(req, res, next) {
if (req.is('json')) {
next();
} else if (req.is('application/ld+json')) {
next();
} else {
next(new errors.UnsupportedContentType(req.headers['content-type']));
}
Expand All @@ -113,7 +115,7 @@ function ensureType(req, res, next) {
*/
function validateJson(template) {
return function validate(req, res, next) {
if (req.is('json')) {
if (req.is('json') || req.is('application/ld+json')) {
var errorList = revalidator.validate(req.body, template);

if (errorList.valid) {
Expand Down
Loading