You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2020/02/21 14:19:03 UTC

[GitHub] [trafficcontrol] mhoppa opened a new pull request #4423: Deprecate cachegroup/:id/unassigned_parameters

mhoppa opened a new pull request #4423: Deprecate cachegroup/:id/unassigned_parameters
URL: https://github.com/apache/trafficcontrol/pull/4423
 
 
   <!--
   ************ STOP!! ************
   If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
   the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
   guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
   -->
   ## What does this PR (Pull Request) do?
   <!-- Explain the changes you made here. If this fixes an Issue, identify it by
   replacing the text in the checkbox item with the Issue number e.g.
   
   - [x] This PR fixes #9001 OR is not related to any Issue
   
   ^ This will automatically close Issue number 9001 when the Pull Request is
   merged (The '#' is important).
   
   Be sure you check the box properly, see the "The following criteria are ALL
   met by this PR" section for details.
   -->
   
   - [x] This PR is not related to any Issue <!-- You can check for an issue here: https://github.com/apache/trafficcontrol/issues -->
   
   
   ## Which Traffic Control components are affected by this PR?
   <!-- Please delete all components from this list that are NOT affected by this
   Pull Request. Also, feel free to add the name of a tool or script that is
   affected but not on the list.
   
   Additionally, if this Pull Request does NOT affect documentation, please
   explain why documentation is not required. -->
   
   - Documentation
   - Traffic Ops
   
   ## What is the best way to verify this PR?
   <!-- Please include here ALL the steps necessary to test your Pull Request. If
   it includes tests (and most should), outline here the steps needed to run the
   tests. If not, lay out the manual testing procedure and please explain why
   tests are unnecessary for this Pull Request. -->
   Run traffic ops and make sure you can not hit the endpoint in API 2.0 and when performing a GET on it in 1.x you receive a deprecation message back in the returned alerts. 
   
   ## If this is a bug fix, what versions of Traffic Control are affected?
   <!-- If this PR fixes a bug, please list here all of the affected versions - to
   the best of your knowledge. It's also pretty helpful to include a commit hash
   of where 'master' is at the time this PR is opened (if it affects master),
   because what 'master' means will change over time. For example, if this PR
   fixes a bug that's present in master (at commit hash '2697ebac'), in v3.0.0,
   and in the current 3.0.1 Release candidate (e.g. RC1), then this list would
   look like:
   
   - master (2697ebac)
   - 3.0.0
   - 3.0.1 (RC1)
   
   If you don't know what other versions might have this bug, AND don't know how
   to find the commit hash of 'master', then feel free to leave this section
   blank (or, preferably, delete it entirely).
    -->
   
   
   ## The following criteria are ALL met by this PR
   <!-- Check the boxes to signify that the associated statement is true. To
   "check a box", replace the space inside of the square brackets with an 'x'.
   e.g.
   
   - [ x] <- Wrong
   - [x ] <- Wrong
   - [] <- Wrong
   - [*] <- Wrong
   - [x] <- Correct!
   
   -->
   
   - [x] This PR includes tests OR I have explained why tests are unnecessary
   - [x] This PR includes documentation OR I have explained why documentation is unnecessary
   - [x] This PR includes an update to CHANGELOG.md OR such an update is not necessary
   - [x] This PR includes any and all required license headers
   - [x] This PR ensures that database migration sequence is correct OR this PR does not include a database migration
   - [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
   
   
   ## Additional Information
   <!-- If you would like to include any additional information on the PR for
   potential reviewers please put it here.
   
   Some examples of this would be:
   
   - Before and after screenshots/gifs of the Traffic Portal if it is affected
   - Links to other dependent Pull Requests
   - References to relevant context (e.g. new/updates to dependent libraries,
   mailing list records, blueprints)
   
   Feel free to leave this section blank (or, preferably, delete it entirely).
   -->
   
   <!--
   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.
   -->
   

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [trafficcontrol] mhoppa commented on issue #4423: Deprecate cachegroup/:id/unassigned_parameters

Posted by GitBox <gi...@apache.org>.
mhoppa commented on issue #4423: Deprecate cachegroup/:id/unassigned_parameters
URL: https://github.com/apache/trafficcontrol/pull/4423#issuecomment-594728021
 
 
   All done 👍 

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [trafficcontrol] mhoppa commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters

Posted by GitBox <gi...@apache.org>.
mhoppa commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters
URL: https://github.com/apache/trafficcontrol/pull/4423#discussion_r391142691
 
 

 ##########
 File path: traffic_portal/app/src/common/modules/table/cacheGroupParameters/TableCacheGroupParamsUnassignedController.js
 ##########
 @@ -17,13 +17,15 @@
  * under the License.
  */
 
-var TableCacheGroupParamsUnassignedController = function(cg, parameters, $scope, $uibModalInstance) {
+var TableCacheGroupParamsUnassignedController = function(cg, allParams, assignedParams, $scope, $uibModalInstance) {
 
 	var selectedParams = [];
 
 	$scope.cg = cg;
 
-	$scope.unassignedParams = parameters;
+	$scope.unassignedParams = _.filter(allParams, function(param) {
+		return !_.find(assignedParams, function(assignedParam) { return assignedParam.id == param.id });
 
 Review comment:
   sure ill look into it
   

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [trafficcontrol] ocket8888 merged pull request #4423: Deprecate cachegroup/:id/unassigned_parameters

Posted by GitBox <gi...@apache.org>.
ocket8888 merged pull request #4423: Deprecate cachegroup/:id/unassigned_parameters
URL: https://github.com/apache/trafficcontrol/pull/4423
 
 
   

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [trafficcontrol] mhoppa commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters

Posted by GitBox <gi...@apache.org>.
mhoppa commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters
URL: https://github.com/apache/trafficcontrol/pull/4423#discussion_r391142042
 
 

 ##########
 File path: traffic_portal/app/src/common/modules/table/cacheGroupParameters/TableCacheGroupParamsUnassignedController.js
 ##########
 @@ -17,13 +17,15 @@
  * under the License.
  */
 
-var TableCacheGroupParamsUnassignedController = function(cg, parameters, $scope, $uibModalInstance) {
+var TableCacheGroupParamsUnassignedController = function(cg, allParams, assignedParams, $scope, $uibModalInstance) {
 
 	var selectedParams = [];
 
 	$scope.cg = cg;
 
-	$scope.unassignedParams = parameters;
+	$scope.unassignedParams = _.filter(allParams, function(param) {
 
 Review comment:
   for my knowledge why?

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters

Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters
URL: https://github.com/apache/trafficcontrol/pull/4423#discussion_r392369698
 
 

 ##########
 File path: traffic_portal/app/src/common/modules/table/cacheGroupParameters/TableCacheGroupParamsUnassignedController.js
 ##########
 @@ -17,22 +17,26 @@
  * under the License.
  */
 
-var TableCacheGroupParamsUnassignedController = function(cg, parameters, $scope, $uibModalInstance) {
+var TableCacheGroupParamsUnassignedController = function(cg, allParams, assignedParams, $scope, $uibModalInstance) {
 
 	var selectedParams = [];
 
 	$scope.cg = cg;
 
-	$scope.unassignedParams = parameters;
+	$scope.unassignedParams = allParams.filter(
+		function(p) {
+			return !assignedParams.has(p.id);
+		}
+	);
 
 	var addParam = function(paramId) {
-		if (_.indexOf(selectedParams, paramId) == -1) {
+		if (selectedParams.indexOf(paramId) == -1) {
 
 Review comment:
   comparison should use `===` not `==`

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters

Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters
URL: https://github.com/apache/trafficcontrol/pull/4423#discussion_r392364882
 
 

 ##########
 File path: traffic_portal/app/src/common/modules/table/cacheGroupParameters/TableCacheGroupParamsUnassignedController.js
 ##########
 @@ -17,22 +17,26 @@
  * under the License.
  */
 
-var TableCacheGroupParamsUnassignedController = function(cg, parameters, $scope, $uibModalInstance) {
+var TableCacheGroupParamsUnassignedController = function(cg, allParams, assignedParams, $scope, $uibModalInstance) {
 
 	var selectedParams = [];
 
 	$scope.cg = cg;
 
-	$scope.unassignedParams = parameters;
+	$scope.unassignedParams = allParams.filter(
+		function(p) {
+			return !assignedParams.has(p.id);
+		}
+	);
 
 	var addParam = function(paramId) {
-		if (_.indexOf(selectedParams, paramId) == -1) {
+		if (selectedParams.indexOf(paramId) == -1) {
 			selectedParams.push(paramId);
 		}
 	};
 
 	var removeParam = function(paramId) {
-		selectedParams = _.without(selectedParams, paramId);
+		selectedParams = selectedParams.without(paramId);
 
 Review comment:
   > ``` TypeError: Array.prototype.without is not a function ```
   
   There isn't a 1:1 correspondence between `_` and ES6 collection types in terms of exact function names, just functionality. The equivalent in this case is just a negative filter:
   
   ```javascript
   selectedParams = selectedParams.filter(x=>x!==paramId);
   ```
   
   Or, without "fat-arrow" functions
   
   ```javascript
   selectedParams = selectedParams.filter(
   	function (param) {
   		return param !== paramId;
   	}
   );
   ```

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters

Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters
URL: https://github.com/apache/trafficcontrol/pull/4423#discussion_r391129633
 
 

 ##########
 File path: traffic_portal/app/src/common/modules/table/cacheGroupParameters/TableCacheGroupParamsUnassignedController.js
 ##########
 @@ -17,13 +17,15 @@
  * under the License.
  */
 
-var TableCacheGroupParamsUnassignedController = function(cg, parameters, $scope, $uibModalInstance) {
+var TableCacheGroupParamsUnassignedController = function(cg, allParams, assignedParams, $scope, $uibModalInstance) {
 
 	var selectedParams = [];
 
 	$scope.cg = cg;
 
-	$scope.unassignedParams = parameters;
+	$scope.unassignedParams = _.filter(allParams, function(param) {
+		return !_.find(assignedParams, function(assignedParam) { return assignedParam.id == param.id });
 
 Review comment:
   Instead of using `_.find`, consider using the Javascript built-in [`Array.find`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find) method.
   
   Also, though, you could avoid iterating the whole array of assigned parameters for every parameter if it's made into just a Set of ids first:
   ```javascript
   // In TableCacheGroupParametersController.js
   // ...
   assignedParams: function() {
   	return new Set(parameters.map(x=>x.id));
   	// I think maybe webpack won't actually handle fat-arrow functions, so might need to do:
   	// return new Set(parameters.map(function(x){return x.id;}));
   }
   //...
   // now in TableCacheGroupParamsUnassignedController.js
   $scope.unassignedParams = allParams.filter(x=>!assignedParams.has(x.id));
   // or, if you can't use "fat-arrow" functions:
   $scope.unassignedParams = allParams.filter(
   	function(p) {
   		return !assignedParams.has(p.id);
   	}
   );
   ```

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters

Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters
URL: https://github.com/apache/trafficcontrol/pull/4423#discussion_r391129633
 
 

 ##########
 File path: traffic_portal/app/src/common/modules/table/cacheGroupParameters/TableCacheGroupParamsUnassignedController.js
 ##########
 @@ -17,13 +17,15 @@
  * under the License.
  */
 
-var TableCacheGroupParamsUnassignedController = function(cg, parameters, $scope, $uibModalInstance) {
+var TableCacheGroupParamsUnassignedController = function(cg, allParams, assignedParams, $scope, $uibModalInstance) {
 
 	var selectedParams = [];
 
 	$scope.cg = cg;
 
-	$scope.unassignedParams = parameters;
+	$scope.unassignedParams = _.filter(allParams, function(param) {
+		return !_.find(assignedParams, function(assignedParam) { return assignedParam.id == param.id });
 
 Review comment:
   Instead of using `_.find`, consider using the Javascript built-in [`Array.find`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/find) method.
   
   Also, though, you could avoid iterating the whole array of assigned params if it's a Set of ids first:
   ```javascript
   // In TableCacheGroupParametersController.js
   // ...
   assignedParams: function() {
   	return new Set(parameters.map(x=>x.id));
   	// I think maybe webpack won't actually handle fat-arrow functions, so might need to do:
   	// return new Set(parameters.map(function(x){return x.id;}));
   }
   //...
   // now in TableCacheGroupParamsUnassignedController.js
   $scope.unassignedParams = allParams.filter(x=>!assignedParams.has(x.id));
   // or, if you can't use "fat-arrow" functions:
   $scope.unassignedParams = allParams.filter(
   	function(p) {
   		return !assignedParams.has(p.id);
   	}
   );
   ```

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters

Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters
URL: https://github.com/apache/trafficcontrol/pull/4423#discussion_r391120005
 
 

 ##########
 File path: traffic_portal/app/src/common/modules/table/cacheGroupParameters/TableCacheGroupParamsUnassignedController.js
 ##########
 @@ -17,13 +17,15 @@
  * under the License.
  */
 
-var TableCacheGroupParamsUnassignedController = function(cg, parameters, $scope, $uibModalInstance) {
+var TableCacheGroupParamsUnassignedController = function(cg, allParams, assignedParams, $scope, $uibModalInstance) {
 
 	var selectedParams = [];
 
 	$scope.cg = cg;
 
-	$scope.unassignedParams = parameters;
+	$scope.unassignedParams = _.filter(allParams, function(param) {
 
 Review comment:
   Instead of using `_.filter`, consider using the Javascript built-in [`Array.filter`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/filter) method.

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters

Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters
URL: https://github.com/apache/trafficcontrol/pull/4423#discussion_r391321323
 
 

 ##########
 File path: traffic_portal/app/src/common/modules/table/cacheGroupParameters/TableCacheGroupParamsUnassignedController.js
 ##########
 @@ -17,13 +17,15 @@
  * under the License.
  */
 
-var TableCacheGroupParamsUnassignedController = function(cg, parameters, $scope, $uibModalInstance) {
+var TableCacheGroupParamsUnassignedController = function(cg, allParams, assignedParams, $scope, $uibModalInstance) {
 
 	var selectedParams = [];
 
 	$scope.cg = cg;
 
-	$scope.unassignedParams = parameters;
+	$scope.unassignedParams = _.filter(allParams, function(param) {
 
 Review comment:
   Because it saves me work :P
   
   Everything we're using `_` for can be done natively in Javascript in every browser with above a 0.5% market share - except Internet Explorer and Opera Mini, both of which we don't support.
   
   So I have a PR open to remove our dependency on it: #4410 .
   
   [It's also ever so slightly faster because it is built in](https://jsperf.com/array-prototype-filter-vs-filter).

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters

Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #4423: Deprecate cachegroup/:id/unassigned_parameters
URL: https://github.com/apache/trafficcontrol/pull/4423#discussion_r391321323
 
 

 ##########
 File path: traffic_portal/app/src/common/modules/table/cacheGroupParameters/TableCacheGroupParamsUnassignedController.js
 ##########
 @@ -17,13 +17,15 @@
  * under the License.
  */
 
-var TableCacheGroupParamsUnassignedController = function(cg, parameters, $scope, $uibModalInstance) {
+var TableCacheGroupParamsUnassignedController = function(cg, allParams, assignedParams, $scope, $uibModalInstance) {
 
 	var selectedParams = [];
 
 	$scope.cg = cg;
 
-	$scope.unassignedParams = parameters;
+	$scope.unassignedParams = _.filter(allParams, function(param) {
 
 Review comment:
   Because it saves me work :P
   
   Everything we're using `_` for can be done natively in Javascript in every browser with above a 0.5% market share - except Internet Explorer and Opera Mini, both of which we don't support.
   
   So I have a PR open to remove our dependency on it: #4410 .
   
   [It's also every so slightly faster because it is built in](https://jsperf.com/array-prototype-filter-vs-filter).

----------------------------------------------------------------
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:
users@infra.apache.org


With regards,
Apache Git Services