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/02/18 23:07:10 UTC
[GitHub] [trafficcontrol] rimashah25 opened a new pull request #5545: Added filter (host name or ID) to query API route: /servercheck
rimashah25 opened a new pull request #5545:
URL: https://github.com/apache/trafficcontrol/pull/5545
<!--
************ 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 fixes #3577 <!-- 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. -->
- 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. -->
## 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
- [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 **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] rimashah25 commented on a change in pull request #5545: Added filter (host name or ID) to query API route: /servercheck
Posted by GitBox <gi...@apache.org>.
rimashah25 commented on a change in pull request #5545:
URL: https://github.com/apache/trafficcontrol/pull/5545#discussion_r581330940
##########
File path: docs/source/api/v3/servercheck.rst
##########
@@ -44,20 +44,20 @@ Request Structure
.. code-block:: http
:caption: Request Example with ``name`` query param
- GET /api/4.0/servercheck?name=edge HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
+ GET /api/4.0/servercheck?name=edge HTTP/1.1
Review comment:
Seriously.. i did tab them
----------------------------------------------------------------
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] ocket8888 commented on a change in pull request #5545: Added filter (host name or ID) to query API route: /servercheck
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #5545:
URL: https://github.com/apache/trafficcontrol/pull/5545#discussion_r581279757
##########
File path: docs/source/api/v3/servercheck.rst
##########
@@ -44,20 +44,20 @@ Request Structure
.. code-block:: http
:caption: Request Example with ``name`` query param
- GET /api/4.0/servercheck?name=edge HTTP/1.1
- Host: trafficops.infra.ciab.test
- User-Agent: curl/7.47.0
- Accept: */*
- Cookie: mojolicious=...
+ GET /api/4.0/servercheck?name=edge HTTP/1.1
Review comment:
It looks like your latest commit only deleted a single space, didn't replace the space-based indentation with tabs
----------------------------------------------------------------
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] ocket8888 merged pull request #5545: Added filter (host name or ID) to query API route: /servercheck
Posted by GitBox <gi...@apache.org>.
ocket8888 merged pull request #5545:
URL: https://github.com/apache/trafficcontrol/pull/5545
----------------------------------------------------------------
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] ocket8888 commented on a change in pull request #5545: Added filter (host name or ID) to query API route: /servercheck
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #5545:
URL: https://github.com/apache/trafficcontrol/pull/5545#discussion_r579592440
##########
File path: docs/source/api/v3/servercheck.rst
##########
@@ -31,7 +31,32 @@ Fetches identifying and meta information as well as "check" values regarding all
Request Structure
-----------------
-No parameters available.
+.. table:: Request Query Parameters
+
+ +-----------+------------------------------------------------------------------------------------+
+ | Name | Description |
+ +===========+====================================================================================+
+ | id | Return only :term:`Servers` with this integral, unique identifier (id) |
+ +-----------+------------------------------------------------------------------------------------+
+ | name | Return only :term:`Servers` with this host_name |
+ +-----------+------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/4.0/servercheck?name=edge HTTP/1.1
+ Host: trafficops.infra.ciab.test
+ User-Agent: curl/7.47.0
+ Accept: */*
+ Cookie: mojolicious=...
+
+ OR
+
+ GET /api/4.0/servercheck?id=12 HTTP/1.1
Review comment:
If you want to add a second request example, you should wrap the second request in another `.. code-block:: http` and make sure the captions are different, like "Request Example with 'name' Query Parameter" and "Request Example with 'id' Query Parameter"
##########
File path: traffic_ops/v4-client/servercheck.go
##########
@@ -17,6 +17,8 @@ package client
import (
"github.com/apache/trafficcontrol/lib/go-tc"
+ "net/http"
+ "net/url"
Review comment:
standard library imports should come before project-local imports
##########
File path: traffic_ops/v4-client/servercheck.go
##########
@@ -41,3 +43,23 @@ func (to *Session) GetServersChecks() ([]tc.GenericServerCheck, tc.Alerts, ReqIn
reqInf, err := to.get(API_SERVERCHECK, nil, &response)
return response.Response, response.Alerts, reqInf, err
}
+
+// GetServerCheckWithParamHdr fetches the Delivery Service with the given ID.
+func (to *Session) GetServerCheckWithParamHdr(params url.Values, header http.Header) (*tc.GenericServerCheck, tc.Alerts, ReqInf, error) {
Review comment:
Can we just name this "GetServerChecks"? If something already exists that doesn't use url.Values and a header we can just get rid of it and replace it with this one that does, since this is the new client.
##########
File path: traffic_ops/traffic_ops_golang/servercheck/servercheck.go
##########
@@ -239,6 +237,35 @@ func DeprecatedReadServersChecks(w http.ResponseWriter, r *http.Request) {
func handleReadServerCheck(inf *api.APIInfo, tx *sql.Tx) ([]tc.GenericServerCheck, error, error, int) {
extensions := make(map[string]string)
+
+ // Query Parameters to Database Query column mappings
+ queryParamsToQueryCols := map[string]dbhelpers.WhereColumnInfo{
+ "id": dbhelpers.WhereColumnInfo{"servercheck.server", api.IsInt},
+ "name": dbhelpers.WhereColumnInfo{"server.host_name", nil},
+ }
+
+ where, orderBy, pagination, queryValues, errs := dbhelpers.BuildWhereAndOrderByAndPagination(inf.Params, queryParamsToQueryCols)
+ if len(errs) > 0 {
+ return nil, util.JoinErrs(errs), nil, http.StatusBadRequest
+ }
+
+ // where clause is different for servercheck and server table. Also, it differs for the query param.
+ var whereSC, whereSI string
+ if where != "" {
+ for k, _ := range inf.Params {
+ if k == "id" {
+ whereSC = where
+ whereSI = "WHERE (type.name LIKE 'MID%' OR type.name LIKE 'EDGE%') AND server.id=:id "
+ } else {
+ whereSC = ""
+ whereSI = "WHERE (type.name LIKE 'MID%' OR type.name LIKE 'EDGE%') AND server.host_name=:name "
+ }
Review comment:
It looks like if I give both the actual filtering used here will be random. I can't imagine why I'd want to, but if I did a request for `serverchecks?id=1&hostName=foo` where server \#1 is *not* 'foo', I'd expect no results returned. Based on this code, I think it would probably return results for server \#1, and if I requested `serverchecks?hostName=foo&id=1` I think it'd probably return a _different_ result set - specifically the checks for the 'foo' server - even though I passed the exact same parameters.
I think it'd probably be best to check for each supported parameter's existence and add to the `where` clause appropriately based on whether it already has contents in turn
----------------------------------------------------------------
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] rimashah25 commented on a change in pull request #5545: Added filter (host name or ID) to query API route: /servercheck
Posted by GitBox <gi...@apache.org>.
rimashah25 commented on a change in pull request #5545:
URL: https://github.com/apache/trafficcontrol/pull/5545#discussion_r580436292
##########
File path: docs/source/api/v3/servercheck.rst
##########
@@ -31,7 +31,32 @@ Fetches identifying and meta information as well as "check" values regarding all
Request Structure
-----------------
-No parameters available.
+.. table:: Request Query Parameters
+
+ +-----------+------------------------------------------------------------------------------------+
+ | Name | Description |
+ +===========+====================================================================================+
+ | id | Return only :term:`Servers` with this integral, unique identifier (id) |
+ +-----------+------------------------------------------------------------------------------------+
+ | name | Return only :term:`Servers` with this host_name |
+ +-----------+------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/4.0/servercheck?name=edge HTTP/1.1
+ Host: trafficops.infra.ciab.test
+ User-Agent: curl/7.47.0
+ Accept: */*
+ Cookie: mojolicious=...
+
+ OR
+
+ GET /api/4.0/servercheck?id=12 HTTP/1.1
Review comment:
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
[GitHub] [trafficcontrol] rimashah25 commented on a change in pull request #5545: Added filter (host name or ID) to query API route: /servercheck
Posted by GitBox <gi...@apache.org>.
rimashah25 commented on a change in pull request #5545:
URL: https://github.com/apache/trafficcontrol/pull/5545#discussion_r580588856
##########
File path: traffic_ops/v4-client/servercheck.go
##########
@@ -32,12 +35,22 @@ func (to *Session) InsertServerCheckStatus(status tc.ServercheckRequestNullable)
return &resp, reqInf, nil
}
-// GetServersChecks fetches check and meta information about servers from /servercheck.
-func (to *Session) GetServersChecks() ([]tc.GenericServerCheck, tc.Alerts, ReqInf, error) {
- var response struct {
+// GetServerCheckWithParamHdr fetches the Delivery Service with the given ID.
Review comment:
oops.
##########
File path: docs/source/api/v3/servercheck.rst
##########
@@ -31,7 +31,34 @@ Fetches identifying and meta information as well as "check" values regarding all
Request Structure
-----------------
-No parameters available.
+.. table:: Request Query Parameters
+
+ +-----------+------------------------------------------------------------------------------------+
+ | Name | Description |
+ +===========+====================================================================================+
+ | id | Return only :term:`Servers` with this integral, unique identifier (id) |
+ +-----------+------------------------------------------------------------------------------------+
Review comment:
Removed term
----------------------------------------------------------------
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] rimashah25 commented on a change in pull request #5545: Added filter (host name or ID) to query API route: /servercheck
Posted by GitBox <gi...@apache.org>.
rimashah25 commented on a change in pull request #5545:
URL: https://github.com/apache/trafficcontrol/pull/5545#discussion_r580432796
##########
File path: traffic_ops/v4-client/servercheck.go
##########
@@ -41,3 +43,23 @@ func (to *Session) GetServersChecks() ([]tc.GenericServerCheck, tc.Alerts, ReqIn
reqInf, err := to.get(API_SERVERCHECK, nil, &response)
return response.Response, response.Alerts, reqInf, err
}
+
+// GetServerCheckWithParamHdr fetches the Delivery Service with the given ID.
+func (to *Session) GetServerCheckWithParamHdr(params url.Values, header http.Header) (*tc.GenericServerCheck, tc.Alerts, ReqInf, error) {
Review comment:
Done and updated all tests (within serverchecks_test.go) accordingly.
##########
File path: traffic_ops/v4-client/servercheck.go
##########
@@ -17,6 +17,8 @@ package client
import (
"github.com/apache/trafficcontrol/lib/go-tc"
+ "net/http"
+ "net/url"
Review comment:
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
[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #5545: Added filter (host name or ID) to query API route: /servercheck
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #5545:
URL: https://github.com/apache/trafficcontrol/pull/5545#discussion_r580561590
##########
File path: traffic_ops/v4-client/servercheck.go
##########
@@ -32,12 +35,22 @@ func (to *Session) InsertServerCheckStatus(status tc.ServercheckRequestNullable)
return &resp, reqInf, nil
}
-// GetServersChecks fetches check and meta information about servers from /servercheck.
-func (to *Session) GetServersChecks() ([]tc.GenericServerCheck, tc.Alerts, ReqInf, error) {
- var response struct {
+// GetServerCheckWithParamHdr fetches the Delivery Service with the given ID.
Review comment:
I think this should maybe read something like
> GetServersChecks fetches 'Server Checks' from Traffic Ops.
##########
File path: docs/source/api/v3/servercheck.rst
##########
@@ -31,7 +31,34 @@ Fetches identifying and meta information as well as "check" values regarding all
Request Structure
-----------------
-No parameters available.
+.. table:: Request Query Parameters
+
+ +-----------+------------------------------------------------------------------------------------+
+ | Name | Description |
+ +===========+====================================================================================+
+ | id | Return only :term:`Servers` with this integral, unique identifier (id) |
+ +-----------+------------------------------------------------------------------------------------+
Review comment:
`Servers` isn't a `term`. You can add it to the glossary if you like, but I don't think I would bother. I'd probably just not use `term`.
##########
File path: docs/source/api/v3/servercheck.rst
##########
@@ -31,7 +31,34 @@ Fetches identifying and meta information as well as "check" values regarding all
Request Structure
-----------------
-No parameters available.
+.. table:: Request Query Parameters
+
+ +-----------+------------------------------------------------------------------------------------+
+ | Name | Description |
+ +===========+====================================================================================+
+ | id | Return only :term:`Servers` with this integral, unique identifier (id) |
+ +-----------+------------------------------------------------------------------------------------+
+ | name | Return only :term:`Servers` with this host_name |
+ +-----------+------------------------------------------------------------------------------------+
+
+.. code-block:: http
Review comment:
I'm not sure exactly why, but the docs build shows 'Error in "code-block" directive'
----------------------------------------------------------------
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] ocket8888 commented on a change in pull request #5545: Added filter (host name or ID) to query API route: /servercheck
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #5545:
URL: https://github.com/apache/trafficcontrol/pull/5545#discussion_r580395637
##########
File path: traffic_ops/traffic_ops_golang/servercheck/servercheck.go
##########
@@ -239,6 +237,35 @@ func DeprecatedReadServersChecks(w http.ResponseWriter, r *http.Request) {
func handleReadServerCheck(inf *api.APIInfo, tx *sql.Tx) ([]tc.GenericServerCheck, error, error, int) {
extensions := make(map[string]string)
+
+ // Query Parameters to Database Query column mappings
+ queryParamsToQueryCols := map[string]dbhelpers.WhereColumnInfo{
+ "id": dbhelpers.WhereColumnInfo{"servercheck.server", api.IsInt},
+ "name": dbhelpers.WhereColumnInfo{"server.host_name", nil},
+ }
+
+ where, orderBy, pagination, queryValues, errs := dbhelpers.BuildWhereAndOrderByAndPagination(inf.Params, queryParamsToQueryCols)
+ if len(errs) > 0 {
+ return nil, util.JoinErrs(errs), nil, http.StatusBadRequest
+ }
+
+ // where clause is different for servercheck and server table. Also, it differs for the query param.
+ var whereSC, whereSI string
+ if where != "" {
+ for k, _ := range inf.Params {
+ if k == "id" {
+ whereSC = where
+ whereSI = "WHERE (type.name LIKE 'MID%' OR type.name LIKE 'EDGE%') AND server.id=:id "
+ } else {
+ whereSC = ""
+ whereSI = "WHERE (type.name LIKE 'MID%' OR type.name LIKE 'EDGE%') AND server.host_name=:name "
+ }
Review comment:
It looks like if I give both the actual filtering used here will be random. I can't imagine why I'd want to, but if I did a request for `serverchecks?id=1&hostName=foo` where server 1 is *not* 'foo', I'd expect no results returned. Based on this code, I think it would probably return results for server 1, and if I requested `serverchecks?hostName=foo&id=1` I think it'd probably return a _different_ result set - specifically the checks for the 'foo' server - even though I passed the exact same parameters.
I think it'd probably be best to check for each supported parameter's existence and add to the `where` clause appropriately based on whether it already has contents in turn
----------------------------------------------------------------
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] ocket8888 commented on a change in pull request #5545: Added filter (host name or ID) to query API route: /servercheck
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #5545:
URL: https://github.com/apache/trafficcontrol/pull/5545#discussion_r580668614
##########
File path: docs/source/api/v3/servercheck.rst
##########
@@ -31,7 +31,33 @@ Fetches identifying and meta information as well as "check" values regarding all
Request Structure
-----------------
-No parameters available.
+.. table:: Request Query Parameters
+
+ +-----------+------------------------------------------------------------------------------------+
+ | Name | Description |
+ +===========+====================================================================================+
+ | id | Return only Servers with this integral, unique identifier (id) |
+ +-----------+------------------------------------------------------------------------------------+
+ | name | Return only Servers with this host_name |
+ +-----------+------------------------------------------------------------------------------------+
+
+.. code-block:: http
+ :caption: Request Example with ``name`` query param
+
+ GET /api/4.0/servercheck?name=edge HTTP/1.1
+ Host: trafficops.infra.ciab.test
+ User-Agent: curl/7.47.0
+ Accept: */*
+ Cookie: mojolicious=...
Review comment:
okay, I see the problem here. These are indented with three spaces instead of a tab character, which is preventing it from rendering properly
----------------------------------------------------------------
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] zrhoffman commented on a change in pull request #5545: Added filter (host name or ID) to query API route: /servercheck
Posted by GitBox <gi...@apache.org>.
zrhoffman commented on a change in pull request #5545:
URL: https://github.com/apache/trafficcontrol/pull/5545#discussion_r581299179
##########
File path: docs/source/api/v3/servercheck.rst
##########
@@ -31,7 +31,34 @@ Fetches identifying and meta information as well as "check" values regarding all
Request Structure
-----------------
-No parameters available.
+.. table:: Request Query Parameters
+
+ +-----------+------------------------------------------------------------------------------------+
+ | Name | Description |
+ +===========+====================================================================================+
+ | id | Return only :term:`Servers` with this integral, unique identifier (id) |
+ +-----------+------------------------------------------------------------------------------------+
Review comment:
[*Cache Server*](https://traffic-control-cdn.readthedocs.io/en/latest/glossary.html#term-Cache-Server) is a term and IMO would be appropriate here.
----------------------------------------------------------------
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