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/04/30 17:07:13 UTC
[GitHub] [trafficcontrol] mattjackson220 opened a new pull request #5801: URL Sig Keys in Postgres and DELETE methods
mattjackson220 opened a new pull request #5801:
URL: https://github.com/apache/trafficcontrol/pull/5801
<!--
************ 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 -->
This PR adds support for URL Sig Keys using Postgres as the Traffic Vault backend. It also adds DELETE functionality for URL Sig Keys for both Postgres and Riak backends.
## 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
- Traffic Vault
- 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. -->
Make sure you have Traffic Vault set up to use Postgres in your test environment.
Update cdn.conf to use Postgres
Verify that all of these endpoints work as expected:
POST `deliveryservices/xmlId/{name}/urlkeys/copyFromXmlId/{copy-name}/?$`,
POST `deliveryservices/xmlId/{name}/urlkeys/generate/?$`
GET `deliveryservices/xmlId/{name}/urlkeys/?$`
DELETE `deliveryservices/xmlId/{name}/urlkeys/?$`
GET `deliveryservices/{id}/urlkeys/?$`
DELETE `deliveryservices/{id}/urlkeys/`
Verify that the data from those endpoints is successfully going into your TV in Postgres.
Run it again without the Postgres backend to point back to Riak.
Verify that all of those endpoints work with Riak still and that the 2 new DELETE endpoints work.
Verify that the API tests run successfully (Postgres TV in ciab is not set up yet so verify that the tests work like normal with Riak and that the new tests work locally or a non-ciab environment with Postgres)
## 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!
-->
No doc updates since its using the same endpoints / format as before just a different backend.
- [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] ocket8888 commented on pull request #5801: URL Sig Keys in Postgres and DELETE methods
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on pull request #5801:
URL: https://github.com/apache/trafficcontrol/pull/5801#issuecomment-832071084
Whoops, it seems I waited too long to hit "Submit Review"
--
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 #5801: URL Sig Keys in Postgres and DELETE methods
Posted by GitBox <gi...@apache.org>.
ocket8888 commented on a change in pull request #5801:
URL: https://github.com/apache/trafficcontrol/pull/5801#discussion_r625897190
##########
File path: docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys.rst
##########
@@ -66,3 +66,36 @@ Response Structure
"key14":"DtXsu8nsw04YhT0kNoKBhu2G3P9WRpQJ",
"key7":"cmKoIIxXGAxUMdCsWvnGLoIMGmNiuT5I"
}}
+
+
+``DELETE``
+==========
+.. seealso:: :ref:`to-api-deliveryservices-id-urlkeys`
+
+Deletes URL signing keys for a :term:`Delivery Service`.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +-------+------------------------------------------------------+
+ | Name | Description |
+ +=======+======================================================+
+ | xmlid | The 'xml_id' of the desired :term:`Delivery Service` |
Review comment:
Putting a term in single grave accents ("back-ticks" <kbd>\`</kbd>) gives it [the "default" Role](https://www.sphinx-doc.org/en/master/usage/configuration.html#confval-default_role) which for us is not configured, so it's the same as `:emphasis` or, in this case, `*xml_id*`. I _think_ what you wanted was to mark it up as code with the `:literal:` Role, but that would require *two* grave accents like:
```rst
``xml_id``
```
On the other hand, you could just make a link to the `ds-xmlid` label which will allow the reader to read about what an XMLID is and means.
--
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] rawlinp commented on a change in pull request #5801: URL Sig Keys in Postgres and DELETE methods
Posted by GitBox <gi...@apache.org>.
rawlinp commented on a change in pull request #5801:
URL: https://github.com/apache/trafficcontrol/pull/5801#discussion_r624110807
##########
File path: CHANGELOG.md
##########
@@ -37,6 +37,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Add a Federation to the Ansible Dataset Loader
- Added asynchronous status to ACME certificate generation.
- Added headers to Traffic Portal, Traffic Ops, and Traffic Monitor to opt out of tracking users via Google FLoC.
+- `DELETE` request method for `deliveryservices/xmlId/{name}/urlkeys` and `deliveryservices/{id}/urlkeys`.
+- Added URL Sig Keys support for Postgres Traffic Vault.
Review comment:
I already added a line in the changelog saying that postgres support for traffic vault has been added, so we don't really need to include these for every PR (the `DELETE` one should stay though)
##########
File path: traffic_ops/traffic_ops_golang/trafficvault/backends/postgres/url_sig_keys.go
##########
@@ -0,0 +1,73 @@
+package postgres
+
+/*
+ * 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.
+ */
+
+import (
+ "database/sql"
+ "encoding/json"
+ "errors"
+
+ "github.com/apache/trafficcontrol/lib/go-tc"
+
+ "github.com/jmoiron/sqlx"
+)
+
+func getURLSigKeys(xmlID string, tvTx *sqlx.Tx) (tc.URLSigKeys, bool, error) {
+ var jsonUrlKeys string
+ if err := tvTx.QueryRow("SELECT data FROM url_sig_key WHERE deliveryservice = $1", xmlID).Scan(&jsonUrlKeys); err != nil {
+ if err == sql.ErrNoRows {
+ return tc.URLSigKeys{}, true, nil
+ }
+ return tc.URLSigKeys{}, false, err
+ }
+
+ urlSignKey := tc.URLSigKeys{}
+ err := json.Unmarshal([]byte(jsonUrlKeys), &urlSignKey)
+ if err != nil {
+ return tc.URLSigKeys{}, false, errors.New("unmarshalling keys: " + err.Error())
+ }
+
+ return urlSignKey, true, nil
+}
+
+func putURLSigKeys(xmlID string, tvTx *sqlx.Tx, keys tc.URLSigKeys) error {
+ keyJSON, err := json.Marshal(&keys)
+ if err != nil {
+ return errors.New("marshalling keys: " + err.Error())
+ }
+
+ res, err := tvTx.Exec("INSERT INTO url_sig_key (deliveryservice, data) VALUES ($1, $2)", xmlID, keyJSON)
Review comment:
This query needs to be idempotent, so we may need to `DELETE FROM url_sig_key WHERE deliveryservice = $1` before running the `INSERT`. The way this is currently, the request will fail if someone tries to generate URL sig keys more than once on the same DS without deleting them first.
##########
File path: traffic_ops/traffic_ops_golang/trafficvault/backends/postgres/postgres.go
##########
@@ -133,11 +133,32 @@ func (p *Postgres) DeleteDNSSECKeys(cdnName string, tx *sql.Tx, ctx context.Cont
}
func (p *Postgres) GetURLSigKeys(xmlID string, tx *sql.Tx, ctx context.Context) (tc.URLSigKeys, bool, error) {
- return tc.URLSigKeys{}, false, notImplementedErr
+ tvTx, dbCtx, cancelFunc, err := p.beginTransaction(ctx)
+ if err != nil {
+ return tc.URLSigKeys{}, false, err
+ }
+ defer p.commitTransaction(tvTx, dbCtx, cancelFunc)
+ return getURLSigKeys(xmlID, tvTx)
}
func (p *Postgres) PutURLSigKeys(xmlID string, keys tc.URLSigKeys, tx *sql.Tx, ctx context.Context) error {
- return notImplementedErr
+ tvTx, dbCtx, cancelFunc, err := p.beginTransaction(ctx)
+ if err != nil {
+ return err
+ }
+ defer p.commitTransaction(tvTx, dbCtx, cancelFunc)
+
+ return putURLSigKeys(xmlID, tvTx, keys)
+}
+
+func (p *Postgres) DeleteURLSigKeys(xmlID string, tx *sql.Tx, ctx context.Context) error {
+ tvTx, dbCtx, cancelFunc, err := p.beginTransaction(ctx)
+ if err != nil {
+ return err
+ }
+ defer p.commitTransaction(tvTx, dbCtx, cancelFunc)
+
+ return deleteURLSigKeys(xmlID, tvTx)
Review comment:
ditto prior comment
##########
File path: traffic_ops/traffic_ops_golang/trafficvault/backends/postgres/url_sig_keys.go
##########
@@ -0,0 +1,73 @@
+package postgres
+
+/*
+ * 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.
+ */
+
+import (
+ "database/sql"
+ "encoding/json"
+ "errors"
+
+ "github.com/apache/trafficcontrol/lib/go-tc"
+
+ "github.com/jmoiron/sqlx"
+)
+
+func getURLSigKeys(xmlID string, tvTx *sqlx.Tx) (tc.URLSigKeys, bool, error) {
+ var jsonUrlKeys string
+ if err := tvTx.QueryRow("SELECT data FROM url_sig_key WHERE deliveryservice = $1", xmlID).Scan(&jsonUrlKeys); err != nil {
+ if err == sql.ErrNoRows {
+ return tc.URLSigKeys{}, true, nil
+ }
+ return tc.URLSigKeys{}, false, err
Review comment:
Before this return is where we should call `checkErrWithContext` in case the context was cancelled
##########
File path: traffic_ops/traffic_ops_golang/trafficvault/backends/postgres/url_sig_keys.go
##########
@@ -0,0 +1,73 @@
+package postgres
+
+/*
+ * 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.
+ */
+
+import (
+ "database/sql"
+ "encoding/json"
+ "errors"
+
+ "github.com/apache/trafficcontrol/lib/go-tc"
+
+ "github.com/jmoiron/sqlx"
+)
+
+func getURLSigKeys(xmlID string, tvTx *sqlx.Tx) (tc.URLSigKeys, bool, error) {
+ var jsonUrlKeys string
+ if err := tvTx.QueryRow("SELECT data FROM url_sig_key WHERE deliveryservice = $1", xmlID).Scan(&jsonUrlKeys); err != nil {
+ if err == sql.ErrNoRows {
+ return tc.URLSigKeys{}, true, nil
Review comment:
I think this should return `false` because the row didn't exist and was hence "not found"
##########
File path: traffic_ops/v4-client/deliveryservice.go
##########
@@ -329,6 +335,25 @@ func (to *Session) GetDeliveryServiceURLSigKeys(dsName string, header http.Heade
return data.Response, reqInf, nil
}
+// CreateDeliveryServiceURLSigKeys creates new URL-signing keys used by the Delivery Service
+// identified by the XMLID 'dsName'
+func (to *Session) CreateDeliveryServiceURLSigKeys(dsName string, header http.Header) (tc.Alerts, toclientlib.ReqInf, error) {
+ var alerts tc.Alerts
+ reqInf, err := to.post(fmt.Sprintf(APIDeliveryServicesURLSigKeysGenerate, dsName), nil, header, &alerts)
+ if err != nil {
Review comment:
This `err != nil` check is redundant, we can just return `err` regardless
##########
File path: traffic_ops/traffic_ops_golang/trafficvault/backends/postgres/url_sig_keys.go
##########
@@ -0,0 +1,73 @@
+package postgres
+
+/*
+ * 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.
+ */
+
+import (
+ "database/sql"
+ "encoding/json"
+ "errors"
+
+ "github.com/apache/trafficcontrol/lib/go-tc"
+
+ "github.com/jmoiron/sqlx"
+)
+
+func getURLSigKeys(xmlID string, tvTx *sqlx.Tx) (tc.URLSigKeys, bool, error) {
+ var jsonUrlKeys string
+ if err := tvTx.QueryRow("SELECT data FROM url_sig_key WHERE deliveryservice = $1", xmlID).Scan(&jsonUrlKeys); err != nil {
+ if err == sql.ErrNoRows {
+ return tc.URLSigKeys{}, true, nil
+ }
+ return tc.URLSigKeys{}, false, err
+ }
+
+ urlSignKey := tc.URLSigKeys{}
+ err := json.Unmarshal([]byte(jsonUrlKeys), &urlSignKey)
+ if err != nil {
+ return tc.URLSigKeys{}, false, errors.New("unmarshalling keys: " + err.Error())
+ }
+
+ return urlSignKey, true, nil
+}
+
+func putURLSigKeys(xmlID string, tvTx *sqlx.Tx, keys tc.URLSigKeys) error {
+ keyJSON, err := json.Marshal(&keys)
+ if err != nil {
+ return errors.New("marshalling keys: " + err.Error())
+ }
+
+ res, err := tvTx.Exec("INSERT INTO url_sig_key (deliveryservice, data) VALUES ($1, $2)", xmlID, keyJSON)
+ if err != nil {
+ return err
Review comment:
Before this return is where we should call `checkErrWithContext` in case the context was cancelled
##########
File path: traffic_ops/traffic_ops_golang/trafficvault/backends/postgres/postgres.go
##########
@@ -133,11 +133,32 @@ func (p *Postgres) DeleteDNSSECKeys(cdnName string, tx *sql.Tx, ctx context.Cont
}
func (p *Postgres) GetURLSigKeys(xmlID string, tx *sql.Tx, ctx context.Context) (tc.URLSigKeys, bool, error) {
- return tc.URLSigKeys{}, false, notImplementedErr
+ tvTx, dbCtx, cancelFunc, err := p.beginTransaction(ctx)
+ if err != nil {
+ return tc.URLSigKeys{}, false, err
+ }
+ defer p.commitTransaction(tvTx, dbCtx, cancelFunc)
+ return getURLSigKeys(xmlID, tvTx)
}
func (p *Postgres) PutURLSigKeys(xmlID string, keys tc.URLSigKeys, tx *sql.Tx, ctx context.Context) error {
- return notImplementedErr
+ tvTx, dbCtx, cancelFunc, err := p.beginTransaction(ctx)
+ if err != nil {
+ return err
+ }
+ defer p.commitTransaction(tvTx, dbCtx, cancelFunc)
+
+ return putURLSigKeys(xmlID, tvTx, keys)
Review comment:
ditto prior comment
##########
File path: traffic_ops/traffic_ops_golang/trafficvault/backends/postgres/url_sig_keys.go
##########
@@ -0,0 +1,73 @@
+package postgres
+
+/*
+ * 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.
+ */
+
+import (
+ "database/sql"
+ "encoding/json"
+ "errors"
+
+ "github.com/apache/trafficcontrol/lib/go-tc"
+
+ "github.com/jmoiron/sqlx"
+)
+
+func getURLSigKeys(xmlID string, tvTx *sqlx.Tx) (tc.URLSigKeys, bool, error) {
+ var jsonUrlKeys string
+ if err := tvTx.QueryRow("SELECT data FROM url_sig_key WHERE deliveryservice = $1", xmlID).Scan(&jsonUrlKeys); err != nil {
+ if err == sql.ErrNoRows {
+ return tc.URLSigKeys{}, true, nil
+ }
+ return tc.URLSigKeys{}, false, err
+ }
+
+ urlSignKey := tc.URLSigKeys{}
+ err := json.Unmarshal([]byte(jsonUrlKeys), &urlSignKey)
+ if err != nil {
+ return tc.URLSigKeys{}, false, errors.New("unmarshalling keys: " + err.Error())
+ }
+
+ return urlSignKey, true, nil
+}
+
+func putURLSigKeys(xmlID string, tvTx *sqlx.Tx, keys tc.URLSigKeys) error {
+ keyJSON, err := json.Marshal(&keys)
+ if err != nil {
+ return errors.New("marshalling keys: " + err.Error())
+ }
+
+ res, err := tvTx.Exec("INSERT INTO url_sig_key (deliveryservice, data) VALUES ($1, $2)", xmlID, keyJSON)
+ if err != nil {
+ return err
+ }
+ if rowsAffected, err := res.RowsAffected(); err != nil {
+ return err
+ } else if rowsAffected == 0 {
+ return errors.New("URL Sign Keys: no keys were inserted")
+ }
+ return nil
+}
+
+func deleteURLSigKeys(xmlID string, tvTx *sqlx.Tx) error {
+ if _, err := tvTx.Exec("DELETE FROM url_sig_key WHERE deliveryservice = $1", xmlID); err != nil {
+ return err
Review comment:
Before this return is where we should call `checkErrWithContext` in case the context was cancelled
##########
File path: traffic_ops/traffic_ops_golang/trafficvault/backends/postgres/postgres.go
##########
@@ -133,11 +133,32 @@ func (p *Postgres) DeleteDNSSECKeys(cdnName string, tx *sql.Tx, ctx context.Cont
}
func (p *Postgres) GetURLSigKeys(xmlID string, tx *sql.Tx, ctx context.Context) (tc.URLSigKeys, bool, error) {
- return tc.URLSigKeys{}, false, notImplementedErr
+ tvTx, dbCtx, cancelFunc, err := p.beginTransaction(ctx)
+ if err != nil {
+ return tc.URLSigKeys{}, false, err
+ }
+ defer p.commitTransaction(tvTx, dbCtx, cancelFunc)
+ return getURLSigKeys(xmlID, tvTx)
Review comment:
I think we may want to pass `ctx` into these function as well in order to use `checkErrWithContext` after attempting the DB query. That function is basically there to give us better context in the error message in case the client closed the connection or the query timed out -- both of which _cancel_ the context, cancelling the DB query.
--
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] mattjackson220 commented on a change in pull request #5801: URL Sig Keys in Postgres and DELETE methods
Posted by GitBox <gi...@apache.org>.
mattjackson220 commented on a change in pull request #5801:
URL: https://github.com/apache/trafficcontrol/pull/5801#discussion_r625991007
##########
File path: docs/source/api/v4/deliveryservices_xmlid_xmlid_urlkeys.rst
##########
@@ -66,3 +66,36 @@ Response Structure
"key14":"DtXsu8nsw04YhT0kNoKBhu2G3P9WRpQJ",
"key7":"cmKoIIxXGAxUMdCsWvnGLoIMGmNiuT5I"
}}
+
+
+``DELETE``
+==========
+.. seealso:: :ref:`to-api-deliveryservices-id-urlkeys`
+
+Deletes URL signing keys for a :term:`Delivery Service`.
+
+:Auth. Required: Yes
+:Roles Required: "admin" or "operations"
+:Response Type: Object
+
+Request Structure
+-----------------
+.. table:: Request Path Parameters
+
+ +-------+------------------------------------------------------+
+ | Name | Description |
+ +=======+======================================================+
+ | xmlid | The 'xml_id' of the desired :term:`Delivery Service` |
Review comment:
oh good call. thats copy / paste leftover from the GET docs above but ill open a new PR to fix both!
--
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] rawlinp merged pull request #5801: URL Sig Keys in Postgres and DELETE methods
Posted by GitBox <gi...@apache.org>.
rawlinp merged pull request #5801:
URL: https://github.com/apache/trafficcontrol/pull/5801
--
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