scottyaslan commented on a change in pull request #3606: [WIP] Nifi 6282 URL: https://github.com/apache/nifi/pull/3606#discussion_r316864133
########## File path: nifi-nar-bundles/nifi-framework-bundle/nifi-framework/nifi-web/nifi-web-ui/src/main/webapp/js/nf/canvas/nf-parameter-contexts.js ########## @@ -0,0 +1,2092 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +/* global define, module, require, exports */ + +(function (root, factory) { + if (typeof define === 'function' && define.amd) { + define(['jquery', + 'Slick', + 'd3', + 'nf.Client', + 'nf.Dialog', + 'nf.Storage', + 'nf.Common', + 'nf.CanvasUtils', + 'nf.ng.Bridge', + 'nf.ErrorHandler', + 'nf.FilteredDialogCommon', + 'nf.Shell', + 'nf.ComponentState', + 'nf.ComponentVersion', + 'nf.PolicyManagement', + 'nf.Processor', + 'nf.ProcessGroup', + 'nf.ProcessGroupConfiguration'], + function ($, Slick, d3, nfClient, nfDialog, nfStorage, nfCommon, nfCanvasUtils, nfNgBridge, nfErrorHandler, nfFilteredDialogCommon, nfShell, nfComponentState, nfComponentVersion, nfPolicyManagement, nfProcessor, nfProcessGroup, nfProcessGroupConfiguration) { + return (nf.ParameterContexts = factory($, Slick, d3, nfClient, nfDialog, nfStorage, nfCommon, nfCanvasUtils, nfNgBridge, nfErrorHandler, nfFilteredDialogCommon, nfShell, nfComponentState, nfComponentVersion, nfPolicyManagement, nfProcessor, nfProcessGroup, nfProcessGroupConfiguration)); + }); + } else if (typeof exports === 'object' && typeof module === 'object') { + module.exports = (nf.ParameterContexts = + factory(require('jquery'), + require('Slick'), + require('d3'), + require('nf.Client'), + require('nf.Dialog'), + require('nf.Storage'), + require('nf.Common'), + require('nf.CanvasUtils'), + require('nf.ng.Bridge'), + require('nf.ErrorHandler'), + require('nf.FilteredDialogCommon'), + require('nf.Shell'), + require('nf.ComponentState'), + require('nf.ComponentVersion'), + require('nf.PolicyManagement'), + require('nf.Processor'), + require('nf.ProcessGroup'), + require('nf.ProcessGroupConfiguration'))); + } else { + nf.ParameterContexts = factory(root.$, + root.Slick, + root.d3, + root.nf.Client, + root.nf.Dialog, + root.nf.Storage, + root.nf.Common, + root.nf.CanvasUtils, + root.nf.ng.Bridge, + root.nf.ErrorHandler, + root.nf.FilteredDialogCommon, + root.nf.Shell, + root.nf.ComponentState, + root.nf.ComponentVersion, + root.nf.PolicyManagement, + root.nf.Processor, + root.nf.ProcessGroup, + root.nf.ProcessGroupConfiguration); + } +}(this, function ($, Slick, d3, nfClient, nfDialog, nfStorage, nfCommon, nfCanvasUtils, nfNgBridge, nfErrorHandler, nfFilteredDialogCommon, nfShell, nfComponentState, nfComponentVersion, nfPolicyManagement, nfProcessor, nfProcessGroup, nfProcessGroupConfiguration) { + 'use strict'; + + var config = { + urls: { + parameterContexts: '../nifi-api/parameter-contexts' + } + }; + + var parameterContextsGridOptions = { + forceFitColumns: true, + enableTextSelectionOnCells: true, + enableCellNavigation: true, + enableColumnReorder: false, + autoEdit: false, + multiSelect: false, + rowHeight: 24 + }; + + var parametersGridOptions = { + forceFitColumns: true, + enableTextSelectionOnCells: true, + enableCellNavigation: true, + enableColumnReorder: false, + editable: false, + enableAddRow: false, + autoEdit: false, + multiSelect: false, + rowHeight: 24 + }; + + /** + * Formatter for the name column. + * + * @param {type} row + * @param {type} cell + * @param {type} value + * @param {type} columnDef + * @param {type} dataContext + * @returns {String} + */ + var nameFormatter = function (row, cell, value, columnDef, dataContext) { + if (!dataContext.permissions.canRead) { + return '<span class="blank">' + nfCommon.escapeHtml(dataContext.id) + '</span>'; + } + + return nfCommon.escapeHtml(dataContext.component.name); + }; + + /** + * Sorts the specified data using the specified sort details. + * + * @param {object} sortDetails + * @param {object} data + */ + var sort = function (sortDetails, data) { + // defines a function for sorting + var comparer = function (a, b) { + if (a.permissions.canRead && b.permissions.canRead) { + var aString = nfCommon.isDefinedAndNotNull(a.component[sortDetails.columnId]) ? a.component[sortDetails.columnId] : ''; + var bString = nfCommon.isDefinedAndNotNull(b.component[sortDetails.columnId]) ? b.component[sortDetails.columnId] : ''; + return aString === bString ? 0 : aString > bString ? 1 : -1; + } else { + if (!a.permissions.canRead && !b.permissions.canRead) { + return 0; + } + if (a.permissions.canRead) { + return 1; + } else { + return -1; + } + } + }; + + // perform the sort + data.sort(comparer, sortDetails.sortAsc); + }; + + var lastSelectedId = null; + + /** + * Sorts the specified data using the specified sort details. + * + * @param {object} sortDetails + * @param {object} data + */ + var sortParameters = function (sortDetails, data) { + // defines a function for sorting + var comparer = function (a, b) { + if (sortDetails.columnId === 'name') { + var aString = nfCommon.isDefinedAndNotNull(a[sortDetails.columnId]) ? a[sortDetails.columnId] : ''; + var bString = nfCommon.isDefinedAndNotNull(b[sortDetails.columnId]) ? b[sortDetails.columnId] : ''; + return aString === bString ? 0 : aString > bString ? 1 : -1; + } + }; + + // perform the sort + data.sort(comparer, sortDetails.sortAsc); + }; + + /** + * Reset the dialog. + */ + var resetDialog = function () { + $('#parameter-context-name').val(''); + $('#parameter-context-description-field').val(''); + $('#parameter-table, #add-parameter').show(); + $('#parameter-context-tabs').show(); + $('#parameter-context-tabs').find('.tab')[0].click(); + $('#parameter-context-update-status').hide(); + + $('#process-group-parameter').text(''); + $('#parameter-process-group-id').text('').removeData('revision'); + $('#parameter-affected-components-context').removeClass('unset').text(''); + + var parameterGrid = $('#parameter-table').data('gridInstance'); + var parameterData = parameterGrid.getData(); + parameterData.setItems([]); + + var affectedProcessorContainer = $('#parameter-context-affected-processors'); + nfCommon.cleanUpTooltips(affectedProcessorContainer, 'div.referencing-component-state'); + nfCommon.cleanUpTooltips(affectedProcessorContainer, 'div.referencing-component-bulletins'); + affectedProcessorContainer.empty(); + + var affectedControllerServicesContainer = $('#parameter-context-affected-controller-services'); + nfCommon.cleanUpTooltips(affectedControllerServicesContainer, 'div.referencing-component-state'); + nfCommon.cleanUpTooltips(affectedControllerServicesContainer, 'div.referencing-component-bulletins'); + affectedControllerServicesContainer.empty(); + + $('#parameter-context-affected-unauthorized-components').empty(); + + // reset the last selected parameter + lastSelectedId = null; + + // clean up any tooltips that may have been generated + nfCommon.cleanUpTooltips($('#parameter-table'), 'div.fa-question-circle'); + }; + + /** + * Marshals the parameters in the table. + */ + var marshalParameters = function () { + var parameters = []; + var table = $('#parameter-table'); + var parameterGrid = table.data('gridInstance'); + var parameterData = parameterGrid.getData(); + $.each(parameterData.getItems(), function () { + if (this.hidden === true) { + var parameter = { + parameter: { + 'name': this.name, + 'value': null + } + }; + + // hidden parameters were removed by the user, clear the value + parameters.push(parameter); + } else if (this.value !== this.previousValue || this.description !== this.previousDescription) { + var parameter = { + parameter: { + 'name': this.name, + 'description': this.description, + 'value': this.value, + 'sensitive': this.sensitive + } + }; + + // the value has changed + parameters.push(parameter); + } + }); + + return parameters; + }; + + /** + * Handles outstanding changes. + * + * @returns {deferred} + */ + var handleOutstandingChanges = function () { + if (!$('#parameter-dialog').hasClass('hidden')) { + // commit the current edit + addNewParameter(); + } + + return $.Deferred(function (deferred) { + if ($('#parameter-context-update-status').is(':visible')) { + close(); + deferred.resolve(); + } else { + var parameters = marshalParameters(); + + // if there are no parameters there is nothing to save + if ($.isEmptyObject(parameters)) { + close(); + deferred.resolve(); + } else { + // see if those changes should be saved + nfDialog.showYesNoDialog({ + headerText: 'Parameters', + dialogContent: 'Save changes before leaving parameter context configuration?', + noHandler: function () { + close(); + deferred.resolve(); + }, + yesHandler: function () { + updateParameterContexts().done(function () { + deferred.resolve(); + }).fail(function () { + deferred.reject(); + }); + } + }); + } + } + + }).promise(); + }; + + /** + * Adds a border to the controller service referencing components if necessary. + * + * @argument {jQuery} referenceContainer + */ + var updateReferencingComponentsBorder = function (referenceContainer) { + // determine if it is too big + var tooBig = referenceContainer.get(0).scrollHeight > Math.round(referenceContainer.innerHeight()) || + referenceContainer.get(0).scrollWidth > Math.round(referenceContainer.innerWidth()); + + // draw the border if necessary + if (referenceContainer.is(':visible') && tooBig) { + referenceContainer.css('border-width', '1px'); + } else { + referenceContainer.css('border-width', '0px'); + } + }; + + /** + * Cancels adding a new parameter context. + */ + var close = function () { + $('#parameter-context-dialog').modal('hide'); + }; + + /** + * Renders the specified affected component. + * + * @param {object} affectedProcessorEntity + * @param {jQuery} container + */ + var renderAffectedProcessor = function (affectedProcessorEntity, container) { + var affectedProcessorContainer = $('<li class="affected-component-container"></li>').appendTo(container); + var affectedProcessor = affectedProcessorEntity.component; + + // processor state + $('<div class="referencing-component-state"></div>').addClass(function () { + if (nfCommon.isDefinedAndNotNull(affectedProcessor.state)) { + var icon = $(this); + + var state = affectedProcessor.state.toLowerCase(); + if (state === 'stopped' && !nfCommon.isEmpty(affectedProcessor.validationErrors)) { + state = 'invalid'; + + // build the validation error listing + var list = nfCommon.formatUnorderedList(affectedProcessor.validationErrors); + + // add tooltip for the warnings + icon.qtip($.extend({}, + nfCanvasUtils.config.systemTooltipConfig, + { + content: list + })); + } + + return state; + } else { + return ''; + } + }).appendTo(affectedProcessorContainer); + + + // processor name + $('<span class="referencing-component-name link"></span>').text(affectedProcessor.name).on('click', function () { + // check if there are outstanding changes + handleOutstandingChanges().done(function () { + // close the shell + $('#shell-dialog').modal('hide'); + + // show the component in question + nfCanvasUtils.showComponent(affectedProcessor.processGroupId, affectedProcessor.id); + }); + }).appendTo(affectedProcessorContainer); + + // bulletin + $('<div class="referencing-component-bulletins"></div>').addClass(affectedProcessor.id + '-affected-bulletins').appendTo(affectedProcessorContainer); + + // processor active threads + $('<span class="referencing-component-active-thread-count"></span>').text(function () { + if (nfCommon.isDefinedAndNotNull(affectedProcessor.activeThreadCount) && affectedProcessor.activeThreadCount > 0) { + return '(' + affectedProcessor.activeThreadCount + ')'; + } else { + return ''; + } + }).appendTo(affectedProcessorContainer); + }; + + /** + * Renders the specified affect controller service. + * + * @param {object} affectedControllerServiceEntity + * @param {jQuery} container + */ + var renderAffectedControllerService = function (affectedControllerServiceEntity, container) { + var affectedControllerServiceContainer = $('<li class="affected-component-container"></li>').appendTo(container); + var affectedControllerService = affectedControllerServiceEntity.component; + + // controller service state + $('<div class="referencing-component-state"></div>').addClass(function () { + if (nfCommon.isDefinedAndNotNull(affectedControllerService.state)) { + var icon = $(this); + + var state = affectedControllerService.state === 'ENABLED' ? 'enabled' : 'disabled'; + if (state === 'disabled' && !nfCommon.isEmpty(affectedControllerService.validationErrors)) { + state = 'invalid'; + + // build the error listing + var list = nfCommon.formatUnorderedList(affectedControllerService.validationErrors); + + // add tooltip for the warnings + icon.qtip($.extend({}, + nfCanvasUtils.config.systemTooltipConfig, + { + content: list + })); + } + return state; + } else { + return ''; + } + }).appendTo(affectedControllerServiceContainer); + + // bulletin + $('<div class="referencing-component-bulletins"></div>').addClass(affectedControllerService.id + '-affected-bulletins').appendTo(affectedControllerServiceContainer); + + // controller service name + $('<span class="referencing-component-name link"></span>').text(affectedControllerService.name).on('click', function () { + // check if there are outstanding changes + handleOutstandingChanges().done(function () { + // close the shell + $('#shell-dialog').modal('hide'); + + // show the component in question + nfProcessGroupConfiguration.showConfiguration(affectedControllerService.processGroupId).done(function () { + nfProcessGroupConfiguration.selectControllerService(affectedControllerService.id); + }); + }); + }).appendTo(affectedControllerServiceContainer); + }; + + /** + * Populates the affected components for the specified parameter context. + * + * @param {object} affectedComponents + */ + var populateAffectedComponents = function (affectedComponents) { + // toggles the visibility of a container + var toggle = function (twist, container) { + if (twist.hasClass('expanded')) { + twist.removeClass('expanded').addClass('collapsed'); + container.hide(); + } else { + twist.removeClass('collapsed').addClass('expanded'); + container.show(); + } + }; + + var affectedProcessors = []; + var affectedControllerServices = []; + var unauthorizedAffectedComponents = []; + + // clear the affected components from the previous selection + var affectedProcessorContainer = $('.parameter-context-affected-processors'); + nfCommon.cleanUpTooltips(affectedProcessorContainer, 'div.referencing-component-state'); + nfCommon.cleanUpTooltips(affectedProcessorContainer, 'div.referencing-component-bulletins'); + affectedProcessorContainer.empty(); + + var affectedControllerServiceContainer = $('.parameter-context-affected-controller-services'); + nfCommon.cleanUpTooltips(affectedControllerServiceContainer, 'div.referencing-component-state'); + nfCommon.cleanUpTooltips(affectedControllerServiceContainer, 'div.referencing-component-bulletins'); + affectedControllerServiceContainer.empty(); + + var unauthorizedComponentsContainer = $('.parameter-context-affected-unauthorized-components'); + unauthorizedComponentsContainer.empty(); + + var parameterReferencingComponentsContainer = $('#parameter-referencing-components-container').empty(); + + // affected component will be undefined when a new parameter is added + if (nfCommon.isUndefined(affectedComponents)) { + // set to pending + $('<div class="affected-component-container"><span class="unset">Pending Apply</span></div>').appendTo(parameterReferencingComponentsContainer); + } else { + var referencingComponentsForBulletinRetrieval = []; + + // bin the affected components according to their type + $.each(affectedComponents, function (_, affectedComponentEntity) { + if (affectedComponentEntity.permissions.canRead === true && affectedComponentEntity.permissions.canWrite === true) { + referencingComponentsForBulletinRetrieval.push(affectedComponentEntity.id); + + if (affectedComponentEntity.component.referenceType === 'PROCESSOR') { + affectedProcessors.push(affectedComponentEntity); + } else { + affectedControllerServices.push(affectedComponentEntity); + } + } else { + // if we're unauthorized only because the user is lacking write permissions, we can still query for bulletins + if (affectedComponentEntity.permissions.canRead === true) { + referencingComponentsForBulletinRetrieval.push(affectedComponentEntity.id); + } + + unauthorizedAffectedComponents.push(affectedComponentEntity); + } + }); + + var affectedProcessGroups = {}; + + // bin the affected processors according to their PG + $.each(affectedProcessors, function (_, affectedProcessorEntity) { + if (affectedProcessGroups[affectedProcessorEntity.component.processGroupId]) { + affectedProcessGroups[affectedProcessorEntity.component.processGroupId].affectedProcessors.push(affectedProcessorEntity); + } else { + affectedProcessGroups[affectedProcessorEntity.component.processGroupId] = { + affectedProcessors: [], + affectedControllerServices: [], + unauthorizedAffectedComponents: [] + }; + + affectedProcessGroups[affectedProcessorEntity.component.processGroupId].affectedProcessors.push(affectedProcessorEntity); + } + }); + + // bin the affected CS according to their PG + $.each(affectedControllerServices, function (_, affectedControllerServiceEntity) { + if (affectedProcessGroups[affectedControllerServiceEntity.component.processGroupId]) { + affectedProcessGroups[affectedControllerServiceEntity.component.processGroupId].affectedControllerServices.push(affectedControllerServiceEntity); + } else { + affectedProcessGroups[affectedControllerServiceEntity.component.processGroupId] = { + affectedProcessors: [], + affectedControllerServices: [], + unauthorizedAffectedComponents: [] + }; + + affectedProcessGroups[affectedControllerServiceEntity.component.processGroupId].affectedControllerServices.push(affectedControllerServiceEntity); + } + }); + + // bin the affected unauthorized components according to their PG + $.each(unauthorizedAffectedComponents, function (_, unauthorizedAffectedComponentEntity) { + if(unauthorizedAffectedComponentEntity.permissions.canRead === true) { + if (affectedProcessGroups[unauthorizedAffectedComponentEntity.component.processGroupId]) { + affectedProcessGroups[unauthorizedAffectedComponentEntity.component.processGroupId].unauthorizedAffectedComponents.push(unauthorizedAffectedComponentEntity); + } else { + affectedProcessGroups[unauthorizedAffectedComponentEntity.component.processGroupId] = { + affectedProcessors: [], + affectedControllerServices: [], + unauthorizedAffectedComponents: [] + }; + + affectedProcessGroups[unauthorizedAffectedComponentEntity.component.processGroupId].unauthorizedAffectedComponents.push(unauthorizedAffectedComponentEntity); + } + } + }); + + var parameterReferencingComponentsContainer = $('#parameter-referencing-components-container'); + var groups = $('<ul class="referencing-component-listing clear"></ul>'); + for (var key in affectedProcessGroups) { + if (affectedProcessGroups.hasOwnProperty(key)) { + // container for this pg's references + var referencingPgReferencesContainer = $('<div class="referencing-component-references"></div>'); + parameterReferencingComponentsContainer.append(referencingPgReferencesContainer); + + // create the collapsable listing for each PG + var createReferenceBlock = function (titleText, list) { + var twist = $('<div class="expansion-button collapsed"></div>'); + var title = $('<span class="referencing-component-title"></span>').text(titleText); + var count = $('<span class="referencing-component-count"></span>').text('(' + (affectedProcessGroups[key].affectedProcessors.length + affectedProcessGroups[key].affectedControllerServices.length + affectedProcessGroups[key].unauthorizedAffectedComponents.length) + ')'); + var referencingComponents = $('#referencing-components-template').clone(); + referencingComponents.removeAttr('id'); + referencingComponents.removeClass('hidden'); + + // create the reference block + var groupTwist = $('<div class="referencing-component-block pointer unselectable"></div>').data( 'processGroupId', key ).on('click', function () { + if (twist.hasClass('collapsed')) { + groupTwist.append(referencingComponents); + + var processorContainer = groupTwist.find('.parameter-context-affected-processors'); + nfCommon.cleanUpTooltips(processorContainer, 'div.referencing-component-state'); + nfCommon.cleanUpTooltips(processorContainer, 'div.referencing-component-bulletins'); + processorContainer.empty(); + + var controllerServiceContainer = groupTwist.find('.parameter-context-affected-controller-services'); + nfCommon.cleanUpTooltips(controllerServiceContainer, 'div.referencing-component-state'); + nfCommon.cleanUpTooltips(controllerServiceContainer, 'div.referencing-component-bulletins'); + controllerServiceContainer.empty(); + + var unauthorizedComponentsContainer = groupTwist.find('.parameter-context-affected-unauthorized-components').empty(); + + if (affectedProcessGroups[$(this).data('processGroupId')].affectedProcessors.length === 0) { + $('<li class="affected-component-container"><span class="unset">None</span></li>').appendTo(processorContainer); + } else { + // sort the affected processors + affectedProcessGroups[$(this).data('processGroupId')].affectedProcessors.sort(nameComparator); + + // render each and register a click handler + $.each(affectedProcessGroups[$(this).data('processGroupId')].affectedProcessors, function (_, affectedProcessorEntity) { + renderAffectedProcessor(affectedProcessorEntity, processorContainer); + }); + } + + if (affectedProcessGroups[$(this).data('processGroupId')].affectedControllerServices.length === 0) { + $('<li class="affected-component-container"><span class="unset">None</span></li>').appendTo(controllerServiceContainer); + } else { + // sort the affected controller services + affectedProcessGroups[$(this).data('processGroupId')].affectedControllerServices.sort(nameComparator); + + // render each and register a click handler + $.each(affectedProcessGroups[$(this).data('processGroupId')].affectedControllerServices, function (_, affectedControllerServiceEntity) { + renderAffectedControllerService(affectedControllerServiceEntity, controllerServiceContainer); + }); + } + + if (affectedProcessGroups[$(this).data('processGroupId')].unauthorizedAffectedComponents.length === 0) { + $('<li class="affected-component-container"><span class="unset">None</span></li>').appendTo(unauthorizedComponentsContainer); + } else { + // sort the unauthorized affected components + affectedProcessGroups[$(this).data('processGroupId')].unauthorizedAffectedComponents.sort(function (a, b) { + if (a.permissions.canRead === true && b.permissions.canRead === true) { + // processors before controller services + var sortVal = a.component.referenceType === b.component.referenceType ? 0 : a.component.referenceType > b.component.referenceType ? -1 : 1; + + // if a and b are the same type, then sort by name + if (sortVal === 0) { + sortVal = a.component.name === b.component.name ? 0 : a.component.name > b.component.name ? 1 : -1; + } + + return sortVal; + } else { + + // if lacking read and write perms on both, sort by id + if (a.permissions.canRead === false && b.permissions.canRead === false) { + return a.id > b.id ? 1 : -1; + } else { + // if only one has read perms, then let it come first + if (a.permissions.canRead === true) { + return -1; + } else { + return 1; + } + } + } + }); + + $.each(affectedProcessGroups[$(this).data('processGroupId')].unauthorizedAffectedComponents, function (_, unauthorizedAffectedComponentEntity) { + if (unauthorizedAffectedComponentEntity.permissions.canRead === true) { + if (unauthorizedAffectedComponentEntity.component.referenceType === 'PROCESSOR') { + renderAffectedProcessor(unauthorizedAffectedComponentEntity, unauthorizedComponentsContainer); + } else { + renderAffectedControllerService(unauthorizedAffectedComponentEntity, unauthorizedComponentsContainer); + } + } else { + var affectedUnauthorizedComponentContainer = $('<li class="affected-component-container"></li>').appendTo(unauthorizedComponentsContainer); + $('<span class="unset"></span>').text(unauthorizedAffectedComponentEntity.id).appendTo(affectedUnauthorizedComponentContainer); + } + }); + } + + // query for the bulletins + if (referencingComponentsForBulletinRetrieval.length > 0) { + nfCanvasUtils.queryBulletins(referencingComponentsForBulletinRetrieval).done(function (response) { + var bulletins = response.bulletinBoard.bulletins; + + var bulletinsBySource = d3.nest() + .key(function (d) { + return d.sourceId; + }) + .map(bulletins, d3.map); + + bulletinsBySource.each(function (sourceBulletins, sourceId) { + $('div.' + sourceId + '-affected-bulletins').each(function () { + var bulletinIcon = $(this); + + // if there are bulletins update them + if (sourceBulletins.length > 0) { + // format the new bulletins + var formattedBulletins = nfCommon.getFormattedBulletins(sourceBulletins); + + var list = nfCommon.formatUnorderedList(formattedBulletins); + + // update existing tooltip or initialize a new one if appropriate + bulletinIcon.addClass('has-bulletins').show().qtip($.extend({}, + nfCanvasUtils.config.systemTooltipConfig, + { + content: list + })); + } + }); + }); + }); + } + } else { + groupTwist.find('.referencing-components-template').remove(); + } + + // toggle this block + toggle(twist, list); + + // update the border if necessary + updateReferencingComponentsBorder($('#parameter-referencing-components-container')); + }).append(twist).append(title).append(count).appendTo(referencingPgReferencesContainer); + + // add the listing + list.appendTo(referencingPgReferencesContainer); + }; + + // get process group and show name or UUID based on user permissions + var pg = nfProcessGroup.get(key); + if (!nfCommon.isUndefinedOrNull(pg)) { + if (pg.permissions.canRead === true) { + // create block for this process group + createReferenceBlock(pg.component.name, groups); + } else { + // create block for this process group + createReferenceBlock(key, groups); + } + } else { + var processGroupName = key; + + // attempt to resolve the group name + var breadcrumbs = nfNgBridge.injector.get('breadcrumbsCtrl').getBreadcrumbs(); + $.each(breadcrumbs, function (_, breadcrumbEntity) { + if (breadcrumbEntity.id === key) { + processGroupName = breadcrumbEntity.label; + return false; + } + }); + // create block for this process group + createReferenceBlock(processGroupName, groups); + } + } + } + } + }; + + /** + * Sorts the specified entities based on the name. + * + * @param {object} a + * @param {object} b + * @returns {number} + */ + var nameComparator = function (a, b) { + return a.component.name.localeCompare(b.component.name); + }; + + /** + * Adds a new parameter. + */ + var addNewParameter = function () { + var parameterName = $.trim($('#parameter-name').val()); + + // ensure the parameter name is specified + if (parameterName !== '') { + var parameterGrid = $('#parameter-table').data('gridInstance'); + var parameterData = parameterGrid.getData(); + + // ensure the parameter name is unique + var matchingParameter = null; + $.each(parameterData.getItems(), function (_, item) { + if (parameterName === item.name) { + matchingParameter = item; + } + }); + + if (matchingParameter === null) { + var parameter = { + id: parameterCount, + hidden: false, + type: 'Parameter', + sensitive: $('#parameter-dialog').find('input[name="sensitive"]:checked').val() === "sensitive" ? true : false, + name: parameterName, + value: ($.trim($('#parameter-value-field').val()) === '' ? ($('#parameter-dialog').find('.nf-checkbox').hasClass('checkbox-checked') ? '' : null) : $.trim($('#parameter-value-field').val())), + description: $.trim($('#parameter-description-field').val()), + previousValue: null, + previousDescription: null, + isEditable: true + }; + + // add a row for the new parameter + parameterData.addItem(parameter); + + // sort the data + parameterData.reSort(); + + // select the new parameter row + var row = parameterData.getRowById(parameterCount); + parameterGrid.setActiveCell(row, parameterGrid.getColumnIndex('value')); + parameterCount++; + } else { + nfDialog.showOkDialog({ + headerText: 'Parameter Exists', + dialogContent: 'A parameter with this name already exists.' + }); + + // select the existing properties row + var matchingRow = parameterData.getRowById(matchingParameter.id); + parameterGrid.setSelectedRows([matchingRow]); + parameterGrid.scrollRowIntoView(matchingRow); + } + + // close the new parameter dialog + $('#parameter-dialog').modal('hide'); + + // update the buttons to possibly trigger the disabled state + $('#parameter-context-dialog').modal('refreshButtons'); + + } else { + nfDialog.showOkDialog({ + headerText: 'Configuration Error', + dialogContent: 'The name of the parameter must be specified.' + }); + } + }; + + /** + * Update a parameter. + */ + var updateParameter = function () { + var parameterName = $.trim($('#parameter-name').val()); + + // ensure the parameter name is specified + if (parameterName !== '') { + var parameterGrid = $('#parameter-table').data('gridInstance'); + var parameterData = parameterGrid.getData(); + + // ensure the parameter name is unique + var matchingParameter = null; + $.each(parameterData.getItems(), function (_, item) { + if (parameterName === item.name) { + matchingParameter = item; + } + }); + + if (matchingParameter !== null) { + var parameter = { + id: matchingParameter.id, + hidden: false, + type: 'Parameter', + sensitive: matchingParameter.sensitive, + name: parameterName, + value: ($.trim($('#parameter-value-field').val()) === '' ? ($('#parameter-dialog').find('.nf-checkbox').hasClass('checkbox-checked') ? '' : null) : $.trim($('#parameter-value-field').val())), + description: $.trim($('#parameter-description-field').val()), + previousValue: matchingParameter.value, + previousDescription: matchingParameter.description, + isEditable: matchingParameter.isEditable + }; + + // update row for the parameter + parameterData.updateItem(matchingParameter.id, parameter); + + // sort the data + parameterData.reSort(); + + // select the parameter row + var row = parameterData.getRowById(matchingParameter.id); + parameterGrid.setActiveCell(row, parameterGrid.getColumnIndex('value')); + } else { + nfDialog.showOkDialog({ + headerText: 'Parameter Does Not Exists', + dialogContent: 'A parameter with this name does not exist.' + }); + } + + // close the new parameter dialog + $('#parameter-dialog').modal('hide'); + + // update the buttons to possibly trigger the disabled state + $('#parameter-context-dialog').modal('refreshButtons'); + } else { + nfDialog.showOkDialog({ + headerText: 'Create Parameter Error', + dialogContent: 'The name of the parameter must be specified.' + }); + } + }; + + /** + * Updates parameter contexts by issuing an update request and polling until it's completion. + */ + var updateParameterContexts = function (parameterContextEntity) { + var parameters = marshalParameters(); + + if (parameters.length === 0) { + // no + parameterContextEntity.component.parameters = []; + if ($('#parameter-context-name').val() === parameterContextEntity.component.name && + $('#parameter-context-description-field').val() === parameterContextEntity.component.description) { + close(); + + return; + } + } else { + parameterContextEntity.component.parameters = parameters; + } + + parameterContextEntity.component.name = $('#parameter-context-name').val(); + parameterContextEntity.component.description = $('#parameter-context-description-field').val(); + + // update the parameters context + var parameterNames = parameterContextEntity.component.parameters.map(function (parameterEntity) { + return parameterEntity.parameter.name; + }); + $('#parameter-affected-components-context').removeClass('unset').text(parameterNames.join(', ')); + + return $.Deferred(function (deferred) { + // updates the button model to show the close button + var updateToCloseButtonModel = function () { + $('#parameter-context-dialog').modal('setButtonModel', [{ + buttonText: 'Close', + color: { + base: '#728E9B', + hover: '#004849', + text: '#ffffff' + }, + handler: { + click: function () { + deferred.resolve(); + close(); + } + } + }]); + }; + + var cancelled = false; + + // update the button model to show the cancel button + $('#parameter-context-dialog').modal('setButtonModel', [{ + buttonText: 'Cancel', + color: { + base: '#E3E8EB', + hover: '#C7D2D7', + text: '#004849' + }, + handler: { + click: function () { + cancelled = true; + updateToCloseButtonModel() + } + } + }]); + + var requestId; + var handleAjaxFailure = function (xhr, status, error) { + // delete the request if possible + if (nfCommon.isDefinedAndNotNull(requestId)) { + deleteUpdateRequest(parameterContextEntity.id, requestId); + } + + // update the step status + $('#parameter-context-update-steps').find('div.parameter-context-step.ajax-loading').removeClass('ajax-loading').addClass('ajax-error'); + + // update the button model + updateToCloseButtonModel(); + }; + + submitUpdateRequest(parameterContextEntity).done(function (response) { + var pollUpdateRequest = function (updateRequestEntity) { + var updateRequest = updateRequestEntity.request; + var errored = nfCommon.isDefinedAndNotNull(updateRequest.failureReason); + + // get the request id + requestId = updateRequest.requestId; + + // update the affected components + populateAffectedComponents(updateRequest.affectedComponents); + + // update the progress/steps + populateParameterContextUpdateStep(updateRequest.updateSteps, cancelled, errored); + + // if this request was cancelled, remove the update request + if (cancelled) { + deleteUpdateRequest(parameterContextEntity.id, requestId); + } else { + if (updateRequest.complete === true) { + if (errored) { + nfDialog.showOkDialog({ + headerText: 'Parameter Context Update Error', + dialogContent: 'Unable to complete parameter context update request: ' + nfCommon.escapeHtml(updateRequest.failureReason) + }); + } + + // reload affected processors + $.each(updateRequest.affectedComponents, function (_, affectedComponentEntity) { + if (affectedComponentEntity.permissions.canRead === true) { + var affectedComponent = affectedComponentEntity.component; + + // reload the processor if it's in the current group + if (affectedComponent.referenceType === 'PROCESSOR' /*&& nfCanvasUtils.getGroupId() === affectedComponent.processGroupId*/) { + nfProcessor.reload(affectedComponent.id); + } + } + }); + + // update the parameter context table if displayed + var parameterContextGrid = $('#parameter-contexts-table').data('gridInstance'); + if (nfCommon.isDefinedAndNotNull(parameterContextGrid)) { + var parameterContextData = parameterContextGrid.getData(); + + $.extend(parameterContextEntity, { + revision: updateRequestEntity.parameterContextRevision, + component: updateRequestEntity.request.parameterContext + }); + + parameterContextData.updateItem(parameterContextEntity.id, parameterContextEntity); + } + + // delete the update request + deleteUpdateRequest(parameterContextEntity.id, requestId); + + // update the button model + updateToCloseButtonModel(); + } else { + // wait to get an updated status + setTimeout(function () { + getUpdateRequest(parameterContextEntity.id, requestId).done(function (getResponse) { + pollUpdateRequest(getResponse); + }).fail(handleAjaxFailure); + }, 2000); + } + } + }; + + // update the visibility + $('#parameter-table, #add-parameter').hide(); + $('#parameter-context-tabs').find('.tab')[1].click(); + $('#parameter-context-tabs').hide(); + $('#parameter-context-update-status').show(); + + pollUpdateRequest(response); + }).fail(handleAjaxFailure); + }).promise(); + }; + + /** + * Obtains the current state of the updateRequest using the specified update request id. + * + * @param {string} updateRequestId + * @returns {deferred} update request xhr + */ + var getUpdateRequest = function (parameterContextId, updateRequestId) { + return $.ajax({ + type: 'GET', + url: config.urls.parameterContexts + '/' + encodeURIComponent(parameterContextId) + '/update-requests/' + encodeURIComponent(updateRequestId), + dataType: 'json' + }).fail(nfErrorHandler.handleAjaxError); + }; + + /** + * Deletes an updateRequest using the specified update request id. + * + * @param {string} updateRequestId + * @returns {deferred} update request xhr + */ + var deleteUpdateRequest = function (parameterContextId, updateRequestId) { + return $.ajax({ + type: 'DELETE', + url: config.urls.parameterContexts + '/' + encodeURIComponent(parameterContextId) + '/update-requests/' + encodeURIComponent(updateRequestId) + '?' + $.param({ + 'disconnectedNodeAcknowledged': nfStorage.isDisconnectionAcknowledged() + }), + dataType: 'json' + }).fail(nfErrorHandler.handleAjaxError); + }; + + /** + * Submits an parameter context update request. + * + * @param {object} parameterContextEntity + * @returns {deferred} update request xhr + */ + var submitUpdateRequest = function (parameterContextEntity) { + return $.ajax({ + type: 'POST', + data: JSON.stringify(parameterContextEntity), + url: config.urls.parameterContexts + '/' + encodeURIComponent(parameterContextEntity.id) + '/update-requests', + dataType: 'json', + contentType: 'application/json' + }).fail(nfErrorHandler.handleAjaxError); + }; + + /** + * Populates the parameter update steps. + * + * @param {array} updateSteps + * @param {boolean} whether this request has been cancelled + * @param {boolean} whether this request has errored + */ + var populateParameterContextUpdateStep = function (updateSteps, cancelled, errored) { + var updateStatusContainer = $('#parameter-context-update-steps').empty(); + + // go through each step + $.each(updateSteps, function (_, updateStep) { + var stepItem = $('<li></li>').text(updateStep.description).appendTo(updateStatusContainer); + + $('<div class="parameter-context-step"></div>').addClass(function () { + if (nfCommon.isDefinedAndNotNull(updateStep.failureReason)) { + return 'ajax-error'; + } else { + if (updateStep.complete === true) { + return 'ajax-complete'; + } else { + return cancelled === true || errored === true ? 'ajax-error' : 'ajax-loading'; + } + } + }).appendTo(stepItem); + + $('<div class="clear"></div>').appendTo(stepItem); + }); + }; + + var parameterCount = 0; + var parameterIndex = 0; + + /** + * Loads the specified parameter registry. + * + * @param {object} parameterContext + * @param {string} parameterToSelect to select + */ + var loadParameters = function (parameterContext, parameterToSelect) { + if (nfCommon.isDefinedAndNotNull(parameterContext)) { + + var parameterGrid = $('#parameter-table').data('gridInstance'); + var parameterData = parameterGrid.getData(); + + // begin the update + parameterData.beginUpdate(); + + var parameters = []; + $.each(parameterContext.component.parameters, function (i, parameterEntity) { + var parameter = { + id: parameterCount++, + hidden: false, + type: 'Parameter', + name: parameterEntity.parameter.name, + value: parameterEntity.parameter.value, + sensitive: parameterEntity.parameter.sensitive, + description: parameterEntity.parameter.description, + previousValue: parameterEntity.parameter.value, + previousDescription: parameterEntity.parameter.description, + isEditable: parameterEntity.canWrite, + affectedComponents: parameterEntity.parameter.referencingComponents + }; + + parameters.push({ + parameter: parameter + }); + + parameterData.addItem(parameter); + }); + + // complete the update + parameterData.endUpdate(); + parameterData.reSort(); + + // if we are pre-selecting a specific parameter, get it's parameterIndex + if (nfCommon.isDefinedAndNotNull(parameterToSelect)) { + $.each(parameters, function (i, parameterEntity) { + if (parameterEntity.parameter.name === parameterToSelect) { + parameterIndex = parameterData.getRowById(parameterEntity.parameter.id); + } + }); + } + + if (parameters.length === 0) { + resetUsage(); + } else { + // select the desired row + parameterGrid.setSelectedRows([parameterIndex]); + } + } + }; + + var resetUsage = function () { + // empty the containers + var processorContainer = $('#parameter-context-affected-processors'); + nfCommon.cleanUpTooltips(processorContainer, 'div.referencing-component-state'); + nfCommon.cleanUpTooltips(processorContainer, 'div.referencing-component-bulletins'); + processorContainer.empty(); + + var controllerServiceContainer = $('#parameter-context-affected-controller-services'); + nfCommon.cleanUpTooltips(controllerServiceContainer, 'div.referencing-component-state'); + nfCommon.cleanUpTooltips(controllerServiceContainer, 'div.referencing-component-bulletins'); + controllerServiceContainer.empty(); + + var unauthorizedComponentsContainer = $('#parameter-context-affected-unauthorized-components').empty(); + + // reset the last selected parameter + lastSelectedId = null; + + // indicate no affected components + $('<li class="affected-component-container"><span class="unset">None</span></li>').appendTo(processorContainer); + $('<li class="affected-component-container"><span class="unset">None</span></li>').appendTo(controllerServiceContainer); + $('<li class="affected-component-container"><span class="unset">None</span></li>').appendTo(unauthorizedComponentsContainer); + + // update the selection context + $('#parameter-affected-components-context').addClass('unset').text('None'); + }; + + /** + * Performs the filtering. + * + * @param {object} item The item subject to filtering + * @param {object} args Filter arguments + * @returns {Boolean} Whether or not to include the item + */ + var filter = function (item, args) { + return item.hidden === false; + }; + + /** + * Initializes the parameter table + */ + var initParameterTable = function () { + var parameterTable = $('#parameter-table'); + + var nameFormatter = function (row, cell, value, columnDef, dataContext) { + var nameWidthOffset = 30; + var cellContent = $('<div></div>'); + + // format the contents + var formattedValue = $('<span/>').addClass('table-cell').text(value).appendTo(cellContent); + if (dataContext.type === 'required') { + formattedValue.addClass('required'); + } + + // show the parameter description if applicable + if (!nfCommon.isBlank(dataContext.description)) { + $('<div class="fa fa-question-circle" alt="Info" style="float: right;"></div>').appendTo(cellContent); + $('<span class="hidden parameter-row"></span>').text(row).appendTo(cellContent); + nameWidthOffset = 46; // 10 + icon width (10) + icon margin (6) + padding (20) + } + + // adjust the width accordingly + formattedValue.width(columnDef.width - nameWidthOffset).ellipsis(); + + // return the cell content + return cellContent.html(); + }; + + var valueFormatter = function (row, cell, value, columnDef, dataContext) { + if (nfCommon.isDefinedAndNotNull(value)) { + // determine if the parameter is sensitive + if (dataContext.sensitive === true) { + return '<span class="table-cell sensitive">Sensitive value set</span>'; + } else { + if (value === '') { + return '<span class="table-cell blank">Empty string set</span>'; + } else { + return '<div class="table-cell value"><pre class="ellipsis">' + nfCommon.escapeHtml(value) + '</pre></div>'; + } + } + } else { + return '<span class="unset">No value set</span>'; + } + }; + + var parameterActionFormatter = function (row, cell, value, columnDef, dataContext) { + var markup = ''; + + if (dataContext.isEditable === true) { + markup += '<div title="Edit" class="edit-parameter pointer fa fa-pencil"></div>'; + markup += '<div title="Delete" class="delete-parameter pointer fa fa-trash"></div>'; + } + + return markup; + }; + + // define the column model for the controller services table + var parameterColumns = [ + { + id: 'name', + name: 'Name', + field: 'name', + formatter: nameFormatter, + sortable: true, + resizable: true, + rerenderOnResize: true + }, + { + id: 'value', + name: 'Value', + field: 'value', + formatter: valueFormatter, + sortable: false, + resizable: true + }, + { + id: 'actions', + name: ' ', + resizable: false, + rerenderOnResize: true, + formatter: parameterActionFormatter, + sortable: false, + width: 90, + maxWidth: 90 + } + ]; + + // initialize the dataview + var parameterData = new Slick.Data.DataView({ + inlineFilters: false + }); + parameterData.setFilterArgs({ + searchString: '', + property: 'hidden' + }); + parameterData.setFilter(filter); + + // initialize the sort + sortParameters({ + columnId: 'name', + sortAsc: true + }, parameterData); + + // initialize the grid + var parametersGrid = new Slick.Grid(parameterTable, parameterData, parameterColumns, parametersGridOptions); + parametersGrid.setSelectionModel(new Slick.RowSelectionModel()); + parametersGrid.registerPlugin(new Slick.AutoTooltips()); + parametersGrid.setSortColumn('name', true); + parametersGrid.onSort.subscribe(function (e, args) { + sortParameters({ + columnId: args.sortCol.id, + sortAsc: args.sortAsc + }, parameterData); + }); + parametersGrid.onClick.subscribe(function (e, args) { + // get the parameter at this row + var parameter = parameterData.getItem(args.row); + + if (parametersGrid.getColumns()[args.cell].id === 'actions') { + var target = $(e.target); + + // determine the desired action + if (target.hasClass('delete-parameter')) { + // mark the property in question for removal and refresh the table + parameterData.updateItem(parameter.id, $.extend(parameter, { + hidden: true + })); + + // reset the selection if necessary + var selectedRows = parametersGrid.getSelectedRows(); + if (selectedRows.length === 0) { + parametersGrid.setSelectedRows([0]); + } + + var rows = parameterData.getItems(); + + if (rows.length === 0) { + // clear usages + resetUsage(); + } else { + var reset = true; + $.each(rows, function (_, parameter) { + if (!parameter.hidden) { + reset = false; + } + }); + + if (reset) { + // clear usages + resetUsage(); + } + } + + // update the buttons to possibly trigger the disabled state + $('#parameter-context-dialog').modal('refreshButtons'); + + // prevents standard edit logic + e.stopImmediatePropagation(); + } else if (target.hasClass('edit-parameter')) { + $('#parameter-dialog').modal('setHeaderText', 'Edit Parameter').modal('setButtonModel', [{ + buttonText: 'Apply', + color: { + base: '#728E9B', + hover: '#004849', + text: '#ffffff' + }, + disabled: function () { + var value = $('#parameter-value-field').val(); + var description = $('#parameter-description-field').val(); + + if (value === parameter.value) { + if (value === '********') { + return false; + } else if (value === '' && $('#parameter-dialog').find('.nf-checkbox').hasClass('checkbox-unchecked')) { + return true; + } else if ($('#parameter-dialog').find('.nf-checkbox').hasClass('checkbox-checked')) { + return false; + } + Review comment: @mcgilman thoughts? ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services
