Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Deprecate (and eventually remove) the ?watch option from the REST API #2265

Closed
patrick-east opened this issue Apr 3, 2020 · 1 comment · Fixed by #2716
Closed

Deprecate (and eventually remove) the ?watch option from the REST API #2265

patrick-east opened this issue Apr 3, 2020 · 1 comment · Fixed by #2716
Assignees
@tsandall
Labels
deprecate pre1.0
Projects
Open Policy Agent

Comments

@patrick-east
Copy link
Contributor

The ?watch option for the REST API is not widely used (if at all) and adds quite a bit of complexity into the server.. which is prone to having bugs as a result of the additional complexity.

Due to it not really being used we should deprecate the option and eventually remove it altogether.

First steps:

  • Log a depreciation warning whenever it is used
  • Remove it from the documentation
  • Mark code in OPA source as deprecated
  • Put a notice in the changelog
@patrick-east patrick-east added this to TODO (Things That Should Be Done) in Open Policy Agent via automation Apr 3, 2020
@patrick-east patrick-east moved this from TODO (Things That Should Be Done) to Planned (Things We Are Going To Do) in Open Policy Agent Apr 3, 2020
@tsandall tsandall moved this from Planned (Things We Are Going To Do) to TODO (Things That Should Be Done) in Open Policy Agent Apr 15, 2020
@tsandall tsandall moved this from TODO (Things That Should Be Done) to Planned (Things We Are Going To Do) in Open Policy Agent May 21, 2020
tsandall added a commit to tsandall/opa that referenced this issue Aug 7, 2020
@tsandall
server: Deprecate the watch and partial query parameters
2a1fe50 
Related: open-policy-agent#2265
Related: open-policy-agent#2266

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
@tsandall tsandall mentioned this issue Aug 7, 2020
Merged
tsandall added a commit that referenced this issue Aug 10, 2020
@tsandall
server: Deprecate the watch and partial query parameters
7821831 
Related: #2265
Related: #2266

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
@tsandall
Copy link
Member

The changes above are in. Let's schedule removal for v0.24.0 (the release after next).

tsandall added a commit to tsandall/opa that referenced this issue Sep 23, 2020
@tsandall
watch: Remove deprecated watch package and server feature
faab37c 
This commit removes the deprecated watch package and server
feature. This feature was never adopted and since the implementation
was not incremental, it would inevitably encounter
performance/scalability issues.

Fixes open-policy-agent#2265

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
@tsandall tsandall mentioned this issue Sep 23, 2020
Merged
@tsandall tsandall moved this from Planned (Things We Are Going To Do) to In Progress in Open Policy Agent Sep 23, 2020
@tsandall tsandall self-assigned this Sep 23, 2020
Open Policy Agent automation moved this from In Progress to Done Sep 23, 2020
patrick-east pushed a commit that referenced this issue Sep 23, 2020
@tsandall @patrick-east
watch: Remove deprecated watch package and server feature
186ef99 
This commit removes the deprecated watch package and server
feature. This feature was never adopted and since the implementation
was not incremental, it would inevitably encounter
performance/scalability issues.

Fixes #2265

Signed-off-by: Torin Sandall <torinsandall@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@tsandall tsandall

Labels
deprecate pre1.0
Projects
Open Policy Agent
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

watch: Remove deprecated watch package and server feature tsandall/opa
2 participants
@tsandall @patrick-east