Skip to content

[NIFI-6690] - Improvement to only allow goto of parameter references … #3769

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

Closed
rfellows wants to merge 1 commit into from
Closed

[NIFI-6690] - Improvement to only allow goto of parameter references … #3769

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
99 changes: 76 additions & 23 deletions ...work/nifi-web/nifi-web-ui/src/main/webapp/js/jquery/propertytable/jquery.propertytable.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,6 +99,7 @@
_) {

var groupId = null;
var currentParameterContext = null;
var COMBO_MIN_WIDTH = 212;
var EDITOR_MIN_WIDTH = 212;
var EDITOR_MIN_HEIGHT = 100;
Expand Down Expand Up @@ -132,6 +133,33 @@
return paramRefsRegex.test(value);
};

var getExistingParametersReferenced = function (parameterReference, parameterContext, sensitive) {
const parameters = _.get(parameterContext, 'component.parameters', []);
const existingParametersReferenced = [];
if (!_.isNil(parameterReference) && !_.isEmpty(parameters)) {
const paramRefsRegex = /#{([a-zA-Z0-9-_. ]+)}/gm;
let possibleMatch;
while ((possibleMatch = paramRefsRegex.exec(parameterReference)) !== null) {
// This is necessary to avoid infinite loops with zero-width matches
if (possibleMatch.index === paramRefsRegex.lastIndex) {
paramRefsRegex.lastIndex++;
}

if (!_.isEmpty(possibleMatch) && possibleMatch.length === 2) {
const parameterName = possibleMatch[1];
const found = parameters.find(param => {
// only parameters with the matching name and sensitive values are considered real matches
return _.get(param, 'parameter.name') === parameterName && _.get(param, 'parameter.sensitive', false) === sensitive;
});
if (!_.isNil(found)) {
existingParametersReferenced.push(found);
}
}
}
}
return existingParametersReferenced;
};

var getSupportTip = function (isEl, isSupported) {
var supportContainer = $('<div></div>');

Expand Down Expand Up @@ -1372,14 +1400,13 @@
var canConvertPropertyToParam = false;
var canReadParamContext = false;

if (_.isFunction(options.getParameterContext)) {
var paramContext = options.getParameterContext(groupId);
var canWriteParamContext = _.get(paramContext, 'permissions.canWrite', false);
canReadParamContext = _.get(paramContext, 'permissions.canRead', false);
if (!_.isNil(currentParameterContext) && options.supportsParameters) {
const canWriteParamContext = _.get(currentParameterContext, 'permissions.canWrite', false);
canReadParamContext = _.get(currentParameterContext, 'permissions.canRead', false);
canConvertPropertyToParam = canWriteParamContext && canReadParamContext;
}

if (referencesParam && canReadParamContext) {
if (referencesParam && canReadParamContext && !_.isEmpty(getExistingParametersReferenced(dataContext.value, currentParameterContext, propertyDescriptor.sensitive))) {
markup += '<div title="Go to parameter" class="goto-to-parameter pointer fa fa-long-arrow-right"></div>';
}

Expand Down Expand Up @@ -1585,42 +1612,49 @@
}
}
} else if (target.hasClass('convert-to-parameter')) {
var parameterContext;
var canConvertPropertyToParam = false;
if (_.isFunction(options.getParameterContext)) {
parameterContext = options.getParameterContext(groupId);
var canWriteParamContext = _.get(parameterContext, 'permissions.canWrite', false);
var canReadParamContext = _.get(parameterContext, 'permissions.canRead', false);
let canConvertPropertyToParam = false;

if (!_.isNil(currentParameterContext) && options.supportsParameters) {
const canWriteParamContext = _.get(currentParameterContext, 'permissions.canWrite', false);
const canReadParamContext = _.get(currentParameterContext, 'permissions.canRead', false);
canConvertPropertyToParam = canWriteParamContext && canReadParamContext;
}

if (options.readOnly !== true && canConvertPropertyToParam) {
var descriptors = table.data('descriptors');
var propertyDescriptor = descriptors[property.property];

nfParameterContexts.convertPropertyToParameter(property, propertyDescriptor, parameterContext.id)
nfParameterContexts.convertPropertyToParameter(property, propertyDescriptor, currentParameterContext.id)
.done(function (parameter) {
var updatedItem = _.extend({}, property, {
previousValue: property.value,
value: '#{' + parameter.name + '}'
});

if (!_.isNil(currentParameterContext)) {
// add the new parameter to the current list of parameters to support 'goto' parameter
currentParameterContext.component.parameters.push({
canWrite: true,
parameter: parameter
});
}
// set the property value to the reference the parameter that was created
propertyData.updateItem(property.id, updatedItem);
});
}
} else if (target.hasClass('goto-to-parameter')) {
var parameterContext;
if (_.isFunction(options.getParameterContext)) {
parameterContext = options.getParameterContext(groupId);
var canReadParamContext = _.get(parameterContext, 'permissions.canRead', false);
if (!_.isNil(currentParameterContext) && options.supportsParameters) {
const descriptors = table.data('descriptors');
const propertyDescriptor = descriptors[property.property];
const canReadParamContext = _.get(currentParameterContext, 'permissions.canRead', false);

if (canReadParamContext && !_.isNil(property.value)) {
// get the reference parameter
var paramRefsRegex = /#{([a-zA-Z0-9-_. ]+)}/;
var result = property.value.match(paramRefsRegex);
if (!_.isEmpty(result) && result.length === 2) {
var parameterName = result[1];
nfParameterContexts.showParameterContext(parameterContext.id, null, parameterName);
// get the reference parameters
const referencedParameters = getExistingParametersReferenced(property.value, currentParameterContext, propertyDescriptor.sensitive);
if (!_.isEmpty(referencedParameters)) {
// show the parameter context with the first parameter referenced selected
const paramNameToSelect = _.get(referencedParameters[0], 'parameter.name');
nfParameterContexts.showParameterContext(currentParameterContext.id, null, paramNameToSelect);
}
}
}
Expand Down Expand Up @@ -2023,7 +2057,25 @@
loadProperties: function (properties, descriptors, history) {
return this.each(function () {
var table = $(this).find('div.property-table');
loadProperties(table, properties, descriptors, history);
var propertyTableContainer = $(this);
var options = propertyTableContainer.data('options');

if (options.supportsParameters) {
nfParameterContexts.getParameterContext(groupId)
.then(function (response) {
// keep a local copy of the parameter context
currentParameterContext = response;
loadProperties(table, properties, descriptors, history);
})
.fail(function () {
// no parameter context, just load up the properties
currentParameterContext = null;
loadProperties(table, properties, descriptors, history);
});
} else {
currentParameterContext = null;
loadProperties(table, properties, descriptors, history);
}
});
},

Expand Down Expand Up @@ -2082,6 +2134,7 @@
$(options.dialogContainer).children('div.new-inline-controller-service-dialog').remove();
}
}
currentParameterContext = null;
});
},

Expand Down
8 changes: 2 additions & 6 deletions ...nifi-framework/nifi-web/nifi-web-ui/src/main/webapp/js/nf/canvas/nf-controller-service.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1895,9 +1895,7 @@
goToServiceDeferred: function () {
return goToServiceFromProperty(serviceTable);
},
getParameterContext: function (groupId) {
return getParameterContext(groupId, controllerServiceEntity);
}
supportsParameters: true
});

// update the mode
Expand Down Expand Up @@ -2082,9 +2080,7 @@
$('#controller-service-properties').propertytable('destroy').propertytable({
supportsGoTo: true,
readOnly: true,
getParameterContext: function (groupId) {
return getParameterContext(groupId, controllerServiceEntity);
}
supportsParameters: true
});

// update the mode
Expand Down
39 changes: 39 additions & 0 deletions ...nifi-framework/nifi-web/nifi-web-ui/src/main/webapp/js/nf/canvas/nf-parameter-contexts.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2543,6 +2543,45 @@
}).fail(nfErrorHandler.handleAjaxError);
},

/**
* Get the parameter context for a process group. Will use the active process group id if null.
* @param processGroupId Optional - id if the process group to get the parameter context for.
* @return Promise A Promise that resolves with the parameter context
*/
getParameterContext: function (processGroupId) {
return $.Deferred(function (deferred) {
var partialParameterContext;

// attempt to identify the parameter context id, conditional based on whether
// the user is configuring the current process group
if (_.isNil(processGroupId) || processGroupId === nfCanvasUtils.getGroupId()) {
partialParameterContext = nfCanvasUtils.getParameterContext();
} else {
var parentProcessGroup = nfCanvasUtils.getComponentByType('ProcessGroup').get(processGroupId);
partialParameterContext = parentProcessGroup.parameterContext;
}
if (_.isNil(partialParameterContext)) {
deferred.reject('No parameter context');
return;
} else if (!_.get(partialParameterContext, 'permissions.canRead', false)) {
// the partial context already has the permissions. no sense in asking for the whole thing
// if the user can not read it
deferred.reject('Unauthorized to read parameter context');
return;
}

$.ajax({
type: 'GET',
url: config.urls.parameterContexts + '/' + encodeURIComponent(partialParameterContext.id),
dataType: 'json'
}).done(function(response) {
deferred.resolve(response);
}).fail(function (errorResponse) {
deferred.reject(errorResponse);
});
}).promise();
},

/**
* Converts a property in to a parameter and adds the parameter to the current parameter context.
* @param property property to convert
Expand Down
5 changes: 1 addition & 4 deletions ...framework/nifi-web/nifi-web-ui/src/main/webapp/js/nf/canvas/nf-processor-configuration.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -660,10 +660,7 @@
}).promise();
},
goToServiceDeferred: goToServiceFromProperty,
getParameterContext: function (groupId) {
// processors being configured must be in the current group
return nfCanvasUtils.getParameterContext();
}
supportsParameters: true
});
},

Expand Down
5 changes: 1 addition & 4 deletions ...-bundle/nifi-framework/nifi-web/nifi-web-ui/src/main/webapp/js/nf/nf-processor-details.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,10 +177,7 @@
$('#read-only-processor-properties').propertytable({
supportsGoTo: config.supportsGoTo,
readOnly: true,
getParameterContext: function (groupId) {
// processors being configured must be in the current group
return nfCanvasUtils.getParameterContext();
}
supportsParameters: true
});
},

Expand Down