[xwiki-devs] [Notice] Going to merge changes related to URL parsing - Need opinion on API removal
Hi devs, I've worked a bit on the xwiki-platform-url module again and I've refactored more of the XWiki class to use it. I would like to commit this: * Changes for platform: https://github.com/xwiki/xwiki-platform/commit/1505a9030084 * Changes for enterprise: https://github.com/xwiki/xwiki-enterprise/commit/f3b14e42c5a8 In doing so I've removed several public methods from com.xpn.xwiki.XWiki (the internal XWiki class): * public XWikiDocument getDocumentFromPath(String path, XWikiContext context) throws XWikiException * public DocumentReference getDocumentReferenceFromPath(String path, XWikiContext context) * public String getDocumentNameFromPath(String path, XWikiContext context) * public String getDocumentName(XWikiRequest request, XWikiContext context) These are no longer needed since the xwiki-platform-url module provides better replacements. Now even if the removal of these methods don't break CLIRR (since com.xpn.xwiki.XWiki is internal) we need to decide if it's ok to just remove them or if I should move them to the legacy module. I'm asking because it's quite some work (as the previous code relied on classes from the xwiki-platform-url module that don't exist anymore and I would need to also move the code from these removed classes to the legacy module to ensure the same behavior as before). All in all I probably need 1 to 2 days to put all that in the legacy modules. WDYT? Should I do it or is it acceptable that I don't? Note that this is for 5.1M1. Thanks -Vincent
On Tue, Apr 30, 2013 at 1:00 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
I've worked a bit on the xwiki-platform-url module again and I've refactored more of the XWiki class to use it. I would like to commit this: * Changes for platform: https://github.com/xwiki/xwiki-platform/commit/1505a9030084 * Changes for enterprise: https://github.com/xwiki/xwiki-enterprise/commit/f3b14e42c5a8
In doing so I've removed several public methods from com.xpn.xwiki.XWiki (the internal XWiki class):
* public XWikiDocument getDocumentFromPath(String path, XWikiContext context) throws XWikiException * public DocumentReference getDocumentReferenceFromPath(String path, XWikiContext context) * public String getDocumentNameFromPath(String path, XWikiContext context) * public String getDocumentName(XWikiRequest request, XWikiContext context)
These are no longer needed since the xwiki-platform-url module provides better replacements.
Now even if the removal of these methods don't break CLIRR (since com.xpn.xwiki.XWiki is internal) we need to decide if it's ok to just remove them or if I should move them to the legacy module.
I'm asking because it's quite some work (as the previous code relied on classes from the xwiki-platform-url module that don't exist anymore and I would need to also move the code from these removed classes to the legacy module to ensure the same behavior as before). All in all I probably need 1 to 2 days to put all that in the legacy modules.
WDYT? Should I do it or is it acceptable that I don't? Note that this is for 5.1M1.
Thanks -Vincent
_______________________________________________ devs mailing list [email protected] http://lists.xwiki.org/mailman/listinfo/devs
com.xpn.xwiki.XWiki is not really as internal as what we put in "internal" packages in new module. From all java modules POV like plugins or component that use old API it is API, I did not even know it was skipped by CLIRR and IMO that's wrong. -- Thomas Mortagne
On Apr 30, 2013, at 1:12 PM, Thomas Mortagne <[email protected]> wrote:
On Tue, Apr 30, 2013 at 1:00 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
I've worked a bit on the xwiki-platform-url module again and I've refactored more of the XWiki class to use it. I would like to commit this: * Changes for platform: https://github.com/xwiki/xwiki-platform/commit/1505a9030084 * Changes for enterprise: https://github.com/xwiki/xwiki-enterprise/commit/f3b14e42c5a8
In doing so I've removed several public methods from com.xpn.xwiki.XWiki (the internal XWiki class):
* public XWikiDocument getDocumentFromPath(String path, XWikiContext context) throws XWikiException * public DocumentReference getDocumentReferenceFromPath(String path, XWikiContext context) * public String getDocumentNameFromPath(String path, XWikiContext context) * public String getDocumentName(XWikiRequest request, XWikiContext context)
These are no longer needed since the xwiki-platform-url module provides better replacements.
Now even if the removal of these methods don't break CLIRR (since com.xpn.xwiki.XWiki is internal) we need to decide if it's ok to just remove them or if I should move them to the legacy module.
I'm asking because it's quite some work (as the previous code relied on classes from the xwiki-platform-url module that don't exist anymore and I would need to also move the code from these removed classes to the legacy module to ensure the same behavior as before). All in all I probably need 1 to 2 days to put all that in the legacy modules.
WDYT? Should I do it or is it acceptable that I don't? Note that this is for 5.1M1.
Thanks -Vincent
com.xpn.xwiki.XWiki is not really as internal as what we put in "internal" packages in new module. From all java modules POV like plugins or component that use old API it is API, I did not even know it was skipped by CLIRR and IMO that's wrong.
This is why I'm asking… But it's still relatively internal and these methods are pretty internal ones. Thanks -Vincent
On Apr 30, 2013, at 7:47 PM, Vincent Massol <[email protected]> wrote:
On Apr 30, 2013, at 1:12 PM, Thomas Mortagne <[email protected]> wrote:
On Tue, Apr 30, 2013 at 1:00 PM, Vincent Massol <[email protected]> wrote:
Hi devs,
I've worked a bit on the xwiki-platform-url module again and I've refactored more of the XWiki class to use it. I would like to commit this: * Changes for platform: https://github.com/xwiki/xwiki-platform/commit/1505a9030084 * Changes for enterprise: https://github.com/xwiki/xwiki-enterprise/commit/f3b14e42c5a8
In doing so I've removed several public methods from com.xpn.xwiki.XWiki (the internal XWiki class):
* public XWikiDocument getDocumentFromPath(String path, XWikiContext context) throws XWikiException * public DocumentReference getDocumentReferenceFromPath(String path, XWikiContext context) * public String getDocumentNameFromPath(String path, XWikiContext context) * public String getDocumentName(XWikiRequest request, XWikiContext context)
These are no longer needed since the xwiki-platform-url module provides better replacements.
Now even if the removal of these methods don't break CLIRR (since com.xpn.xwiki.XWiki is internal) we need to decide if it's ok to just remove them or if I should move them to the legacy module.
I'm asking because it's quite some work (as the previous code relied on classes from the xwiki-platform-url module that don't exist anymore and I would need to also move the code from these removed classes to the legacy module to ensure the same behavior as before). All in all I probably need 1 to 2 days to put all that in the legacy modules.
WDYT? Should I do it or is it acceptable that I don't? Note that this is for 5.1M1.
Thanks -Vincent
com.xpn.xwiki.XWiki is not really as internal as what we put in "internal" packages in new module. From all java modules POV like plugins or component that use old API it is API, I did not even know it was skipped by CLIRR and IMO that's wrong.
This is why I'm asking… But it's still relatively internal and these methods are pretty internal ones.
ok, thanks to Thomas I have stopped being lazy and I've put in legacy all deprecated methods so that there's now no breakages at all :) Going to merge on master in a few minutes. Thanks -Vincent
participants (2)
-
Thomas Mortagne -
Vincent Massol