[JENKINS-33972] Item Categories should not be shipped from /categories - Jenkins Jira

XML

Word

Printable

Details

Type: Task
Status: Closed (View Workflow)
Priority: Minor
Resolution: Fixed
Component/s: core
Labels:
- 2.0
- 2.0-planned
- api

Similar Issues:

Show

Description

It is the follow-up to our discussion with Manuel Recena Soto and Jesse Glick.

The current Item categorization uses JENKINS_URL/categories endpoint to provide the list of categories.

It causes several concerns:

Categories apply to items only, but the "/categories" endpoint does not mention it in paths. Once we want to implement slave categories, it may become a problem
The endpoint may conflict with existing closed-source plugins. E.g. I had the Categorization plugin at one of my previous companies, which used the similar endpoint. Update to 2.0 will cause regressions in such plugins
The implementation is not pluggable. E.g. Views and Items cannot filter the categories somehow

Proposed solution:

Ship categories via VIEW_URL/itemCategories
Allow overriding of the method in views. Just for the future pluggability

Attachments

Issue Links

links to

Activity

Ascending order - Click to sort in descending order

Hide

Permalink

Manuel Recena Soto added a comment - 2016-04-01 10:14 - edited

I disagree because:

It is not a bug
it is not a regression at all

Show

Manuel Recena Soto added a comment - 2016-04-01 10:14 - edited I disagree because: It is not a bug it is not a regression at all

Hide

Permalink

Manuel Recena Soto added a comment - 2016-04-01 10:36

Categories apply to items only, but the "/categories" endpoint does not mention it in paths.

This endpoint is not valid, the right endpoint is: JENKINS_ROOT/PATH_VIEW/categories where PATH_VIEW can be:

empty: JENKINS_ROOT/categories
or for example: JENKINS_ROOT/view/custom/categories

The meaning is Please, give me the item categories and its items availables in this view.

The endpoint may conflict with existing closed-source plugins. E.g. I had the Categorization plugin at one of my previous companies, which used the similar endpoint. Update to 2.0 will cause regressions in such plugins

Is this really an argument? As contributor of Jenkins core I have to thing about possible proprietary developments. This is crazy! Why something like itemCategories is a valid option?

The implementation is not pluggable. E.g. Views and Items cannot filter the categories somehow

This is a new requirement we can implement in the future. By the way, Items are being filtered.

Show

Manuel Recena Soto added a comment - 2016-04-01 10:36 Categories apply to items only, but the "/categories" endpoint does not mention it in paths. This endpoint is not valid, the right endpoint is: JENKINS_ROOT/PATH_VIEW/categories where PATH_VIEW can be: empty: JENKINS_ROOT/categories or for example: JENKINS_ROOT/view/custom/categories The meaning is Please, give me the item categories and its items availables in this view . The endpoint may conflict with existing closed-source plugins. E.g. I had the Categorization plugin at one of my previous companies, which used the similar endpoint. Update to 2.0 will cause regressions in such plugins Is this really an argument? As contributor of Jenkins core I have to thing about possible proprietary developments. This is crazy! Why something like itemCategories is a valid option? The implementation is not pluggable. E.g. Views and Items cannot filter the categories somehow This is a new requirement we can implement in the future. By the way, Items are being filtered.

Hide

Permalink

Oleg Nenashev added a comment - 2016-04-01 10:50

> empty: JENKINS_ROOT/categories

So in such case it overlaps with the corner-case I've provided

> Is this really an argument? As contributor of Jenkins core I have to thing about possible proprietary developments. This is crazy!

You are not supposed to think about them. That's why we have Jenkins 2.0 beta testing, because it allows users to notify us about such issues. It does not mean that we must fix such issues, but at least it worths some discussion

Show

Oleg Nenashev added a comment - 2016-04-01 10:50 > empty: JENKINS_ROOT/categories So in such case it overlaps with the corner-case I've provided > Is this really an argument? As contributor of Jenkins core I have to thing about possible proprietary developments. This is crazy! You are not supposed to think about them. That's why we have Jenkins 2.0 beta testing, because it allows users to notify us about such issues. It does not mean that we must fix such issues, but at least it worths some discussion

Hide

Permalink

Manuel Recena Soto added a comment - 2016-04-01 10:58

Daniel Beck your PoV here would be great!

Show

Manuel Recena Soto added a comment - 2016-04-01 10:58 Daniel Beck your PoV here would be great!

Hide

Permalink

Daniel Beck added a comment - 2016-04-01 12:28

Closed-source plugins are not an argument to me. I'm not even sure open-source plugins would be a major argument to impede core development, depending on exactly what the problem is. They would just be fixed. Otherwise, no detaching JUnit plugin from core in 1.577, or ever.

However, Oleg does have a point with the confusion regarding what the categories are for. So a rename to itemCategories to support e.g. viewCategories besides it, seems straightforward enough. FWIW I was a big proponent for generic categorization from the beginning, Jenkins users typically have more view types than item types.

Show

Daniel Beck added a comment - 2016-04-01 12:28 Closed-source plugins are not an argument to me. I'm not even sure open-source plugins would be a major argument to impede core development, depending on exactly what the problem is. They would just be fixed. Otherwise, no detaching JUnit plugin from core in 1.577, or ever. However, Oleg does have a point with the confusion regarding what the categories are for. So a rename to itemCategories to support e.g. viewCategories besides it, seems straightforward enough. FWIW I was a big proponent for generic categorization from the beginning, Jenkins users typically have more view types than item types.

Hide

Permalink

Oleg Nenashev added a comment - 2016-04-01 12:48

> Closed-source plugins are not an argument to me. I'm not even sure open-source plugins would be a major argument to impede core development, depending on exactly what the problem is. They would just be fixed.

IMHO it does not well comply with the "this guy is fully compatible, no reason not to upgrade" statement we declare for 2.0. I'm OK if we don't fix in this case, but there maybe corner cases. Maybe we should explicitly recommend testing before upgrading.

Show

Oleg Nenashev added a comment - 2016-04-01 12:48 > Closed-source plugins are not an argument to me. I'm not even sure open-source plugins would be a major argument to impede core development, depending on exactly what the problem is. They would just be fixed. IMHO it does not well comply with the "this guy is fully compatible, no reason not to upgrade" statement we declare for 2.0. I'm OK if we don't fix in this case, but there maybe corner cases. Maybe we should explicitly recommend testing before upgrading.

Hide

Permalink

Manuel Recena Soto added a comment - 2016-04-01 13:33

Oleg Nenashev By the way, the renaming involves to send a new PR to cloudbees-folder-plugin ref.

Show

Manuel Recena Soto added a comment - 2016-04-01 13:33 Oleg Nenashev By the way, the renaming involves to send a new PR to cloudbees-folder-plugin ref .

Hide

Permalink

Manuel Recena Soto added a comment - 2016-04-01 14:00

Jesse Glick Do you agree with the change proposed? Remember that this change involves to change this again.

Show

Manuel Recena Soto added a comment - 2016-04-01 14:00 Jesse Glick Do you agree with the change proposed? Remember that this change involves to change this again.

Hide

Permalink

Jesse Glick added a comment - 2016-04-01 16:49

Yes go ahead and change categories to itemCategories. I was holding off on a cloudbees-folder release until you did so, so that I can make the matching change.

Show

Jesse Glick added a comment - 2016-04-01 16:49 Yes go ahead and change categories to itemCategories . I was holding off on a cloudbees-folder release until you did so, so that I can make the matching change.

Hide

Permalink

Manuel Recena Soto added a comment - 2016-04-01 16:54

Oleg Nenashev working in progress....

Show

Manuel Recena Soto added a comment - 2016-04-01 16:54 Oleg Nenashev working in progress....

Hide

Permalink

Oleg Nenashev added a comment - 2016-04-01 17:06

Manuel Recena Soto Thanks a lot!

Show

Oleg Nenashev added a comment - 2016-04-01 17:06 Manuel Recena Soto Thanks a lot!

Hide

Permalink

Manuel Recena Soto added a comment - 2016-04-01 17:23

Oleg Nenashev Done.

Show

Manuel Recena Soto added a comment - 2016-04-01 17:23 Oleg Nenashev Done.

Hide

Permalink

SCM/JIRA link daemon added a comment - 2016-04-01 23:47

Code changed in jenkins
User: recena
Path:
core/src/main/java/hudson/model/View.java
war/src/main/js/add-item.js
http://jenkins-ci.org/commit/jenkins/4a5b825b479d56beb0717bfb1cbcb659c51557fb
Log:
~~JENKINS-33972~~ The REST API URL has been removed to [..]/itemCategories

Show

SCM/JIRA link daemon added a comment - 2016-04-01 23:47 Code changed in jenkins User: recena Path: core/src/main/java/hudson/model/View.java war/src/main/js/add-item.js http://jenkins-ci.org/commit/jenkins/4a5b825b479d56beb0717bfb1cbcb659c51557fb Log: JENKINS-33972 The REST API URL has been removed to [..] /itemCategories

Hide

Permalink

SCM/JIRA link daemon added a comment - 2016-04-01 23:47

Code changed in jenkins
User: Daniel Beck
Path:
core/src/main/java/hudson/model/View.java
war/src/main/js/add-item.js
http://jenkins-ci.org/commit/jenkins/4649e04cbe58f5af0e583da04084b2ebc442a320
Log:
Merge pull request #2208 from recena/~~JENKINS-33972~~

~~JENKINS-33972~~ The REST API URL has been removed to [..]/itemCategories

Compare: https://github.com/jenkinsci/jenkins/compare/0db4bc2a6327...4649e04cbe58

Show

SCM/JIRA link daemon added a comment - 2016-04-01 23:47 Code changed in jenkins User: Daniel Beck Path: core/src/main/java/hudson/model/View.java war/src/main/js/add-item.js http://jenkins-ci.org/commit/jenkins/4649e04cbe58f5af0e583da04084b2ebc442a320 Log: Merge pull request #2208 from recena/ JENKINS-33972 JENKINS-33972 The REST API URL has been removed to [..] /itemCategories Compare: https://github.com/jenkinsci/jenkins/compare/0db4bc2a6327...4649e04cbe58

Hide

Permalink

SCM/JIRA link daemon added a comment - 2016-04-03 01:11

Code changed in jenkins
User: Jesse Glick
Path:
src/main/java/com/cloudbees/hudson/plugins/folder/FolderAddFilter.java
http://jenkins-ci.org/commit/cloudbees-folder-plugin/dab943292bcc6121c62701cb62307edce09c6d31
Log:
~~JENKINS-33972~~ View.doCategories renamed to doItemCategories.

Show

Hide

Permalink

SCM/JIRA link daemon added a comment - 2016-04-03 01:11

Code changed in jenkins
User: Jesse Glick
Path:
src/main/java/com/cloudbees/hudson/plugins/folder/FolderAddFilter.java
http://jenkins-ci.org/commit/cloudbees-folder-plugin/526694d36b9d2e0685ceac9c168204a209969b3d
Log:
Merge pull request #54 from jglick/itemCategories-~~JENKINS-33972~~

~~JENKINS-33972~~ View.doCategories renamed to doItemCategories

#55 is identical, just merging the lower-numbered one.

Compare: https://github.com/jenkinsci/cloudbees-folder-plugin/compare/6f2daf46be91...526694d36b9d

Show

SCM/JIRA link daemon added a comment - 2016-04-03 01:11 Code changed in jenkins User: Jesse Glick Path: src/main/java/com/cloudbees/hudson/plugins/folder/FolderAddFilter.java http://jenkins-ci.org/commit/cloudbees-folder-plugin/526694d36b9d2e0685ceac9c168204a209969b3d Log: Merge pull request #54 from jglick/itemCategories- JENKINS-33972 JENKINS-33972 View.doCategories renamed to doItemCategories #55 is identical, just merging the lower-numbered one. Compare: https://github.com/jenkinsci/cloudbees-folder-plugin/compare/6f2daf46be91...526694d36b9d

Hide

Permalink

SCM/JIRA link daemon added a comment - 2016-04-03 01:13

Code changed in jenkins
User: recena
Path:
src/main/java/com/cloudbees/hudson/plugins/folder/FolderAddFilter.java
http://jenkins-ci.org/commit/cloudbees-folder-plugin/c3ba1ab0efab2552003752af46d659504b69c3e5
Log:
~~JENKINS-33972~~ View.doCategories was renamed to View.doItemCategories

Show

SCM/JIRA link daemon added a comment - 2016-04-03 01:13 Code changed in jenkins User: recena Path: src/main/java/com/cloudbees/hudson/plugins/folder/FolderAddFilter.java http://jenkins-ci.org/commit/cloudbees-folder-plugin/c3ba1ab0efab2552003752af46d659504b69c3e5 Log: JENKINS-33972 View.doCategories was renamed to View.doItemCategories

Hide

Permalink

SCM/JIRA link daemon added a comment - 2016-04-03 01:13

Code changed in jenkins
User: Jesse Glick
Path:
http://jenkins-ci.org/commit/cloudbees-folder-plugin/ac521be9372a056a799c354e75f5ce33d516b7ff
Log:
Merge pull request #55 from recena/~~JENKINS-33972~~

~~JENKINS-33972~~ View.doCategories was renamed to View.doItemCategories

Heck, merge them both, see if GitHub can handle it!

Compare: https://github.com/jenkinsci/cloudbees-folder-plugin/compare/526694d36b9d...ac521be9372a

Show

SCM/JIRA link daemon added a comment - 2016-04-03 01:13 Code changed in jenkins User: Jesse Glick Path: http://jenkins-ci.org/commit/cloudbees-folder-plugin/ac521be9372a056a799c354e75f5ce33d516b7ff Log: Merge pull request #55 from recena/ JENKINS-33972 JENKINS-33972 View.doCategories was renamed to View.doItemCategories Heck, merge them both, see if GitHub can handle it! Compare: https://github.com/jenkinsci/cloudbees-folder-plugin/compare/526694d36b9d...ac521be9372a

People

Assignee:: Manuel Recena Soto

Reporter:: Oleg Nenashev

Votes:: 0 Vote for this issue

Watchers:: 4 Start watching this issue

Dates

Created:: 2016-04-01 08:28

Updated:: 2016-04-03 01:13

Resolved:: 2016-04-01 17:20