Skip to content
This repository was archived by the owner on Nov 24, 2025. It is now read-only.

Deprecate /capabilities/{{name}}#3880

Merged
rawlinp merged 4 commits into
apache:masterfrom
ocket8888:capabilities-name-go
Jan 30, 2020
Merged

Deprecate /capabilities/{{name}}#3880
rawlinp merged 4 commits into
apache:masterfrom
ocket8888:capabilities-name-go

Conversation

@ocket8888

@ocket8888 ocket8888 commented Aug 19, 2019

Copy link
Copy Markdown
Contributor

What does this PR (Pull Request) do?

Depends on PR #3870

Adds deprecation notices to the output bodies of all method handlers for /capabilities/{{name}} as well as to the documentation. Also adds a new Mojo helper to add deprecation notices to responses that already have alerts and also don't have alternative routes.

Which Traffic Control components are affected by this PR?

  • Documentation
  • Traffic Ops

What is the best way to verify this PR?

Build and run Traffic Ops and make sure the /capabilities/{{name}} endpoint works and outputs the correct deprecation notices. Build and read the documentation to ensure it builds and is correct and thorough.

The following criteria are ALL met by this PR

  • I have explained why tests are unnecessary
  • I have explained why documentation is unnecessary
  • This PR includes an update to CHANGELOG.md
  • This PR does not include a database migration
  • This PR DOES NOT FIX A SERIOUS SECURITY VULNERABILITY

@ocket8888 ocket8888 added this to the Go Rewrite milestone Aug 19, 2019
@asfgit

asfgit commented Aug 19, 2019

Copy link
Copy Markdown
Contributor

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4169/
Test PASSed.

@ocket8888 ocket8888 added the Traffic Ops related to Traffic Ops label Aug 19, 2019
@mitchell852 mitchell852 added the tech debt rework due to choosing easy/limited solution label Aug 21, 2019
@mhoppa

mhoppa commented Oct 9, 2019

Copy link
Copy Markdown
Contributor

based on https://lists.apache.org/thread.html/cfd3a6d631f2c7510e3a15ee051840a9f04f3f0aa0c2696e460c9ab9@%3Cdev.trafficcontrol.apache.org%3E should this be closed and redone as a deprecate message on the perl route?

@ocket8888

Copy link
Copy Markdown
Contributor Author

That thread never reached a decision as to whether or not deprecated routes ought to be rewritten. If a decision to not rewrite these handlers is reached I'll close this PR (assuming it's still open), in the meantime I guess it's in the hands of people browsing PRs whether or not this is worth merging (once it isn't a draft (if ever)).

@mhoppa

mhoppa commented Oct 10, 2019

Copy link
Copy Markdown
Contributor

do we need to get convergence on that prior to moving forward with PRs #3954 & #3766 then?

@ocket8888

Copy link
Copy Markdown
Contributor Author

I don't think so. Making changes in Go is easier than in Perl, so if somebody wants to spend the time writing it and someone else wants to spend the time reviewing it, a rewrite of a deprecated endpoint could still be valuable. It lets Perl die faster. Worst case scenario, we've wasted some time, but the impact on the project is neutral - not strictly negative.

@ocket8888
ocket8888 force-pushed the capabilities-name-go branch from b8a9073 to e807256 Compare November 7, 2019 19:23
@asf-ci

asf-ci commented Nov 7, 2019

Copy link
Copy Markdown
Contributor

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4751/

@ocket8888
ocket8888 force-pushed the capabilities-name-go branch from e807256 to 6906c02 Compare November 25, 2019 19:20
@asf-ci

asf-ci commented Nov 25, 2019

Copy link
Copy Markdown
Contributor

Refer to this link for build results (access rights to CI server needed):
https://builds.apache.org/job/trafficcontrol-PR/4831/

@ocket8888
ocket8888 force-pushed the capabilities-name-go branch from 6906c02 to 89a717f Compare January 29, 2020 20:06
@ocket8888
ocket8888 force-pushed the capabilities-name-go branch from 8ca6ecf to e02aaaa Compare January 29, 2020 23:22
@ocket8888
ocket8888 marked this pull request as ready for review January 29, 2020 23:22
@ocket8888 ocket8888 changed the title Rewrote /capabilities/{{name}} to Go Deprecate /capabilities/{{name}} Jan 29, 2020
@ocket8888 ocket8888 added the documentation related to documentation label Jan 29, 2020
Comment thread traffic_ops/app/lib/API/Capability.pm Outdated

@mhoppa mhoppa left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Once the typo is fixed this is rdy to go, docs looks good, deprecation notices return from the api calls

@mhoppa

mhoppa commented Jan 30, 2020

Copy link
Copy Markdown
Contributor

retest this please

@rawlinp
rawlinp merged commit 5fbd141 into apache:master Jan 30, 2020
@ocket8888
ocket8888 deleted the capabilities-name-go branch January 30, 2020 20:46
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation related to documentation tech debt rework due to choosing easy/limited solution Traffic Ops related to Traffic Ops

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Rewrite /capabilities/{{capability}} to Go

6 participants