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 2021/01/26 18:05:11 UTC

[GitHub] [trafficcontrol] traeak opened a new pull request #5467: Plugin params

traeak opened a new pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467


   <!--
   ************ 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 patly fixes issue 4759
   
   ^ 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 partly fixes 4759
   
   ## 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 ORT
   - CI tests
   
   ## 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. -->
   
   For both cache_range_requests and slice plugin create parameters and associate with a DS profile and select to use slice or cache_range_requests for range handling.
   
   Example:
   consider-ims  cache_range_requests.config <empty> false
   key cache_range_requests.config value false
   
   Run atstccfg and pull remap.config
   With the above you would see:
   ... @plugin=cache_range_requests.so @pparam=--consider-ims @pparam=--key=value ...
   
   ## 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 '1df853c8'), in v4.0.0,
   and in the current 4.0.1 Release candidate (e.g. RC1), then this list would
   look like:
   
   - master (1df853c8)
   - 4.0.0
   - 4.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
   - [ ] 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 **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



[GitHub] [trafficcontrol] rob05c merged pull request #5467: T3c: DS parameter plugin args for slice, cache_range_requets, cachekey, url_sig, background_fetch

Posted by GitBox <gi...@apache.org>.
rob05c merged pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467


   


-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] mitchell852 removed a comment on pull request #5467: ORT: consider DS parameters slice.config and cache_range_requests.config for adding plugin args

Posted by GitBox <gi...@apache.org>.
mitchell852 removed a comment on pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#issuecomment-768393297


   > ... @plugin=cache_range_requests.so @pparam=--consider-ims @pparam=--key=value ...
   
   @traeak - did you mean:
   
   ```
   @plugin=cache_range_requests.so @pparam=--consider-ims=false @pparam=--key=value ...
   ```


----------------------------------------------------------------
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



[GitHub] [trafficcontrol] mitchell852 commented on pull request #5467: ORT: consider DS parameters slice.config and cache_range_requests.config for adding plugin args

Posted by GitBox <gi...@apache.org>.
mitchell852 commented on pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#issuecomment-768393297


   > ... @plugin=cache_range_requests.so @pparam=--consider-ims @pparam=--key=value ...
   
   did you mean
   
   ```
   @plugin=cache_range_requests.so @pparam=--consider-ims=false @pparam=--key=value ...
   ```


----------------------------------------------------------------
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



[GitHub] [trafficcontrol] mitchell852 edited a comment on pull request #5467: ORT: DS parameter plugin args as slice.pparam, cache_range_requests.pparam, cachekey.pparam

Posted by GitBox <gi...@apache.org>.
mitchell852 edited a comment on pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#issuecomment-768394912


   what if it's something like this instead? cache_range_requests.config makes me think that a cache_range_requests.config file is being created.
   
   ```
   Example:
   consider-ims cache_range_requests.plugin false
   key cache_range_requests.plugin value
   ```
   
   `cache_range_requests.plugin` to make it clear that this is a parameter for a plugin...or even `cache_range_requests.pparam` <-- which means plugin param


----------------------------------------------------------------
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



[GitHub] [trafficcontrol] mitchell852 edited a comment on pull request #5467: ORT: consider DS parameters slice.config and cache_range_requests.config for adding plugin args

Posted by GitBox <gi...@apache.org>.
mitchell852 edited a comment on pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#issuecomment-768393297


   > ... @plugin=cache_range_requests.so @pparam=--consider-ims @pparam=--key=value ...
   
   @traeak - did you mean:
   
   ```
   @plugin=cache_range_requests.so @pparam=--consider-ims=false @pparam=--key=value ...
   ```


----------------------------------------------------------------
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



[GitHub] [trafficcontrol] rob05c commented on a change in pull request #5467: T3c: DS parameter plugin args for slice, cache_range_requets, cachekey, url_sig, background_fetch

Posted by GitBox <gi...@apache.org>.
rob05c commented on a change in pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#discussion_r670724764



##########
File path: cache-config/t3cutil/getdatacfg.go
##########
@@ -638,29 +642,55 @@ func GetConfigData(toClient *toreq.TOClient, disableProxy bool, cacheHostName st
 		}
 		return nil
 	}
-	cacheKeyParamsF := func() error {
-		defer func(start time.Time) { log.Infof("cacheKeyParamsF took %v\n", time.Since(start)) }(time.Now())
+
+	cacheKeyConfigParamsF := func() error {
+		defer func(start time.Time) { log.Infof("cacheKeyConfigParamsF took %v\n", time.Since(start)) }(time.Now())
 		{
 			reqHdr := (http.Header)(nil)
 			if oldCfg != nil {
-				reqHdr = MakeReqHdr(oldCfg.MetaData.CacheKeyParams)
+				reqHdr = MakeReqHdr(oldCfg.MetaData.CacheKeyConfigParams)
 			}
-			params, reqInf, err := toClient.GetConfigFileParameters(atscfg.CacheKeyParameterConfigFile, reqHdr)
+			params, reqInf, err := toClient.GetConfigFileParameters("cachekey.config", reqHdr)

Review comment:
       Why change the constant to a literal?




-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] mitchell852 edited a comment on pull request #5467: ORT: consider DS parameters slice.config and cache_range_requests.config for adding plugin args

Posted by GitBox <gi...@apache.org>.
mitchell852 edited a comment on pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#issuecomment-768394912


   what if it's something like this instead? cache_range_requests.config makes me think that a cache_range_requests.config file is being created.
   
   ```
   Example:
   consider-ims cache_range_requests.plugin false
   key cache_range_requests.plugin value
   ```
   
   `.plugin` to make it clear that this is a parameter for a plugin...


----------------------------------------------------------------
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



[GitHub] [trafficcontrol] rob05c commented on a change in pull request #5467: T3c: DS parameter plugin args for slice, cache_range_requets, cachekey, url_sig, background_fetch

Posted by GitBox <gi...@apache.org>.
rob05c commented on a change in pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#discussion_r681939674



##########
File path: cache-config/t3cutil/getdatacfg.go
##########
@@ -638,29 +642,55 @@ func GetConfigData(toClient *toreq.TOClient, disableProxy bool, cacheHostName st
 		}
 		return nil
 	}
-	cacheKeyParamsF := func() error {
-		defer func(start time.Time) { log.Infof("cacheKeyParamsF took %v\n", time.Since(start)) }(time.Now())
+
+	cacheKeyConfigParamsF := func() error {
+		defer func(start time.Time) { log.Infof("cacheKeyConfigParamsF took %v\n", time.Since(start)) }(time.Now())
 		{
 			reqHdr := (http.Header)(nil)
 			if oldCfg != nil {
-				reqHdr = MakeReqHdr(oldCfg.MetaData.CacheKeyParams)
+				reqHdr = MakeReqHdr(oldCfg.MetaData.CacheKeyConfigParams)
 			}
-			params, reqInf, err := toClient.GetConfigFileParameters(atscfg.CacheKeyParameterConfigFile, reqHdr)
+			params, reqInf, err := toClient.GetConfigFileParameters("cachekey.config", reqHdr)

Review comment:
       That would be ideal, but IMO not important enough to hold up merging




-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] mitchell852 edited a comment on pull request #5467: ORT: DS parameter plugin args as slice.pparam, cache_range_requests.pparam, cachekey.pparam

Posted by GitBox <gi...@apache.org>.
mitchell852 edited a comment on pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#issuecomment-768394912


   what if it's something like this instead? cache_range_requests.config makes me think that a cache_range_requests.config file is being created.
   
   ```
   Example:
   consider-ims cache_range_requests.plugin false
   key cache_range_requests.plugin value
   ```
   
   `cache_range_requests.plugin` to make it clear that this is plugin related...or even `cache_range_requests.pparam` (plugin param which is actually what this is doing)


----------------------------------------------------------------
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



[GitHub] [trafficcontrol] mitchell852 edited a comment on pull request #5467: ORT: DS parameter plugin args as slice.pparam, cache_range_requests.pparam, cachekey.pparam

Posted by GitBox <gi...@apache.org>.
mitchell852 edited a comment on pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#issuecomment-768394912


   what if it's something like this instead? cache_range_requests.config makes me think that a cache_range_requests.config file is being created.
   
   ```
   Example:
   consider-ims cache_range_requests.plugin false
   key cache_range_requests.plugin value
   ```
   
   `cache_range_requests.plugin` to make it clear that this is a parameter for a plugin...or even `cache_range_requests.pparam` (plugin param which is actually what this is doing)


----------------------------------------------------------------
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



[GitHub] [trafficcontrol] mitchell852 commented on pull request #5467: ORT: consider DS parameters slice.config and cache_range_requests.config for adding plugin args

Posted by GitBox <gi...@apache.org>.
mitchell852 commented on pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#issuecomment-768394912


   what if it's something like this instead? cache_range_requests.config makes me think that a cache_range_requests.config file is being created.
   
   ```
   Example:
   consider-ims cache_range_requests.plugin false
   key cache_range_requests.plugin value false
   ```


----------------------------------------------------------------
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



[GitHub] [trafficcontrol] mitchell852 edited a comment on pull request #5467: ORT: DS parameter plugin args as slice.pparam, cache_range_requests.pparam, cachekey.pparam

Posted by GitBox <gi...@apache.org>.
mitchell852 edited a comment on pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#issuecomment-768394912


   what if it's something like this instead? cache_range_requests.config makes me think that a cache_range_requests.config file is being created.
   
   ```
   Example:
   consider-ims cache_range_requests.plugin false
   key cache_range_requests.plugin value
   ```
   
   `.plugin` to make it clear that this is a parameter for a plugin...or even cache_range_requests.pparam <-- which means plugin param


----------------------------------------------------------------
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



[GitHub] [trafficcontrol] mitchell852 edited a comment on pull request #5467: ORT: consider DS parameters slice.config and cache_range_requests.config for adding plugin args

Posted by GitBox <gi...@apache.org>.
mitchell852 edited a comment on pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#issuecomment-768394912


   what if it's something like this instead? cache_range_requests.config makes me think that a cache_range_requests.config file is being created.
   
   ```
   Example:
   consider-ims cache_range_requests.plugin false
   key cache_range_requests.plugin value
   ```


----------------------------------------------------------------
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



[GitHub] [trafficcontrol] mitchell852 removed a comment on pull request #5467: ORT: DS parameter plugin args as slice.pparam, cache_range_requests.pparam, cachekey.pparam

Posted by GitBox <gi...@apache.org>.
mitchell852 removed a comment on pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#issuecomment-768394912


   what if it's something like this instead? cache_range_requests.config makes me think that a cache_range_requests.config file is being created.
   
   ```
   Example:
   consider-ims cache_range_requests.plugin false
   key cache_range_requests.plugin value
   ```
   
   `cache_range_requests.plugin` to make it clear that this is plugin related...or even `cache_range_requests.pparam` (plugin param which is actually what this is doing)


----------------------------------------------------------------
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



[GitHub] [trafficcontrol] rob05c commented on pull request #5467: T3c: DS parameter plugin args for slice, cache_range_requets, cachekey, url_sig, background_fetch

Posted by GitBox <gi...@apache.org>.
rob05c commented on pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#issuecomment-892006674


   This doesn't touch TM, I don't think it broke the TM tests, and this is an important feature we need, so I'm merging


-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org



[GitHub] [trafficcontrol] traeak commented on a change in pull request #5467: T3c: DS parameter plugin args for slice, cache_range_requets, cachekey, url_sig, background_fetch

Posted by GitBox <gi...@apache.org>.
traeak commented on a change in pull request #5467:
URL: https://github.com/apache/trafficcontrol/pull/5467#discussion_r671380598



##########
File path: cache-config/t3cutil/getdatacfg.go
##########
@@ -638,29 +642,55 @@ func GetConfigData(toClient *toreq.TOClient, disableProxy bool, cacheHostName st
 		}
 		return nil
 	}
-	cacheKeyParamsF := func() error {
-		defer func(start time.Time) { log.Infof("cacheKeyParamsF took %v\n", time.Since(start)) }(time.Now())
+
+	cacheKeyConfigParamsF := func() error {
+		defer func(start time.Time) { log.Infof("cacheKeyConfigParamsF took %v\n", time.Since(start)) }(time.Now())
 		{
 			reqHdr := (http.Header)(nil)
 			if oldCfg != nil {
-				reqHdr = MakeReqHdr(oldCfg.MetaData.CacheKeyParams)
+				reqHdr = MakeReqHdr(oldCfg.MetaData.CacheKeyConfigParams)
 			}
-			params, reqInf, err := toClient.GetConfigFileParameters(atscfg.CacheKeyParameterConfigFile, reqHdr)
+			params, reqInf, err := toClient.GetConfigFileParameters("cachekey.config", reqHdr)

Review comment:
       should one be added for remap.config and parent.config to make it uniform?




-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org