rfellows commented on a change in pull request #3606: [WIP] Nifi 6282 URL: https://github.com/apache/nifi/pull/3606#discussion_r316387561
########## 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,2233 @@ +/* + * 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(); + $('#parameter-referencing-components-container').empty(); + + // reset the last selected parameter + lastSelectedId = null; + + // reset the current parameter context + currentParameterContextEntity = 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 () { + var parameter = { + 'name': this.name + }; + + // if the parameter has been deleted + if (this.hidden === true && this.previousValue !== null) { + // hidden parameters were removed by the user, clear the value + parameters.push({ + 'parameter': parameter + }); + } else if (this.isModified === true) { // the parameter is modified + // check if the value has changed + if (this.value !== this.previousValue) { + parameter['sensitive'] = this.sensitive; + + // for non-sensitive values we always include the value + if (!this.sensitive) { + parameter['value'] = this.value; + } else { + // for sensitive parameters we don't know it's value so we only include the + // value if it has changed or if the empty string set checkbox has been checked + if (!nfCommon.isBlank(this.value) || this.isEmptyStringSet === true) { + parameter['value'] = this.value; + } Review comment: There is a scenario that isn't covered here. If you add a new sensitive parameter with value, then before `Apply`ing it to the context, you edit that same parameter and JUST change the description... When you do `Apply` the parameters to the context, the value of the sensitive parameter is not sent to the server. Here is a suggestion on an option to solve the problem... ``` if (!nfCommon.isBlank(this.value) || this.isEmptyStringSet === true) { parameter['value'] = this.value; } else if (nfCommon.isBlank(this.value) && this.previousValue !== '********') { // the sensitive parameter has not ever been saved and we still need to send the value as part of the update parameter['value'] = this.previousValue; } ``` There is a super-unlikely gap in my solution though: It would not work if the original value they set is `********` and then edit the description in the next step. Maybe that is acceptable? ---------------------------------------------------------------- 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
