November 2012 - xwiki-devs@xwiki.org

[xwiki-devs] Fixing translations for XWiki 4.3 - Help Needed!
by Silvia Rusu 26 Nov '12

26 Nov '12

Hi! RalucaM and myself have been working on/reviewing French translations for XWiki 4.3 and we've posted a report illustrating the issues we found here http://www.xwiki.org/xwiki/bin/view/TestReports/TranslationsReport43 Sorin will be reviewing each entry to see whether translations or keys are missing and will probably ping you on IRC for help :) It would be very useful however if you could look at the reported issues and make some of the needed fixes, especially if you're a native French speaker. Edi has already helped us with the Workspaces App keys. Thanks a lot! Please reply to the current thread and specify the fixes you've made, or edit the document directly and write [fixed] in front of the entry you handled. We won't be able to include the translations in the 4.3 final release, but it would be wonderful if we could have a 4.3.1, or even include them in 4.4. Here is the link again: http://www.xwiki.org/xwiki/bin/view/TestReports/TranslationsReport43 Translation wiki: http://l10n.xwiki.org/xwiki/bin/view/L10N/ Thanks, Silvia

2 1

[xwiki-devs] [Proposal] Deprecate Util.getResourceAsStream() + modify ServletEnvironment.getResourceAsStream()
by Vincent Massol 26 Nov '12

26 Nov '12

Hi devs, I'd like to deprecate Util.getResourceAsStream(): public static InputStream getResourceAsStream(String resource) { File file = new File(resource); try { if (file.exists()) { return new FileInputStream(file); } } catch (Exception e) { // Probably running under -security, which prevents calling File.exists() LOGGER.debug("Failed load resource [" + resource + "] using a file path"); } try { Environment environment = Utils.getComponent(Environment.class); InputStream res = environment.getResourceAsStream(resource); if (res != null) { return res; } } catch (Exception e) { LOGGER.debug("Failed to load resource [" + resource + "] using the application context"); } return Thread.currentThread().getContextClassLoader().getResourceAsStream(resource); } Instead I'd like to propose to use the new Environment.getResourceAsStream(). However I'd also like to modify the ServletEnvironment.getResourceAsStream() implementation so that it also looks in the classloader if not found in the resources directory (defaulting to the current thread context class loader for the classloader to use since this is set in a servlet container). Thanks -Vincent

1 0

[xwiki-devs] Sencha Ex JS
by Nweike Onwuyali 26 Nov '12

26 Nov '12

Hello, Is it possible to use Sencha JS as a front-end resource to build in-wiki applications ? Nweike Onwuyali ............................. excuse my typos & brevity. Sent from a mobile device

3 2

[xwiki-devs] Using xwiki as a social networking site
by Nweike Onwuyali 25 Nov '12

25 Nov '12

Hello all, I am new to xwiki Can I use xwiki to build a social networking site like elgg Nweike Onwuyali ............................. excuse my typos & brevity. Sent from a mobile device

2 1

[xwiki-devs] [VOTE] Commit a Release application into platform
by Vincent Massol 23 Nov '12

23 Nov '12

Hi devs, I'd like to rename the "Release Plans" app (http://dev.xwiki.org/xwiki/bin/view/ReleasePlans/WebHome) into "Releases" (i.e. remove the "plan" part) and then commit in platform as an application. Here's my +1 Thanks -Vincent PS: This action goes in the direction of creating a list of useful applications/extensions for a Project Development Flavor (see other mail).

6 5

[xwiki-devs] A note on Selenium behaviour
by Marius Dumitru Florea 23 Nov '12

23 Nov '12

Hi devs, While debugging the failing Selenium tests, most of which are flickers, I "discovered" a behaviour that I was not aware of. It looks like when you ask Selenium to click on an element from the page it does the following: * locate the element in the DOM * compute the bounding rectangle (and thus determine if the element is visible) * scroll the element into view if needed * move the mouse in the center of the bounding rectangle * fire a click event with the mouse coordinates There are two important things to note: (1) The click event is not bound to the element. The browser behaves as if the user clicked at that position (x, y) on the page, on whatever is displayed on top. (2) The click command doesn't seem to be atomic (i.e. the element position can change between the moment its bounding rectangle is computed and the moment the click event is fired). This allows for the following to happen: (i) The floating content/edit menu can silently prevent elements to be clicked (if the page is scrolled and the element is at the top of the window and the middle of the element is right beneath the floating menu). (ii) Clicking on buttons before the page layout is stable can fail silently. For instance, clicking on Save & View before the WYSIWYG edit mode is fully loaded can fail silently because the position of the button is not stable. Moreover, it seems that the mouse position is "remembered" between page loads and the browser reacts to it. For instance, if you click on "Back to edit" in preview mode (and don't move the mouse) the mouse can end up above the edit menu thus opening it which in turn prevents you from clicking on the Link menu from the WYSIWYG editor tool bar (you end up in Object or Class edit mode..). I'm not sure if this is something introduced in a recent version of Selenium or if it was triggered when I enabled native events. Thanks, Marius

2 2

[xwiki-devs] [PROPOSAL] Actions2.0
by Caleb James DeLisle 22 Nov '12

22 Nov '12

Hi, A couple weeks ago I proposed a technique for allowing servlets to be registered with the component manager. There was some tentative agreement that the idea had merit so I began researching it. In the process of trying to solve this problem I think I have stumbled on a workable Actions2.0 model. The really short version: @Component @Named("sayhello") public class HelloWorldAction implements Action { @Action.Runner public void run(ClientPrintWriter cpw) { cpw.println("Hello World!"); } } The Action router gets a request for localhost:8080/xwiki/sayhello/ and loads your Action from the ComponentManager, it examines the class and sees your annotated method and looks at it's arguments, since the method takes a ClientPrintWriter, the action router gets a list of all ActionProviders from the ComponentManager and examines them to find one which provides it. It then uses the same technique to recursively resolves that provider's requirements. Once all requirements have been satisfied, the router calls each provider and finally your Action, each time passing the required dependencies using the Method#invoke() function. Here's an example of an ActionProvider which provides a PrintWriter: @Component @Named("ServletPrintWriterProvider") public class ServletPrintWriterProvider implements ActionProvider { @Action.Runner public void run(ServletResponse resp, Callback<ClientPrintWriter> cpwCallback) { cpwCallback.call(new PrintWriter(resp.getOutputStream())); } } Obviously one could be registered which worked with Portlet, or even command line invocation. HelloWorldAction doesn't require much. Benefits of this design: 1. You only get what you need. Why should I wait for the XWikiContext or the ExecutionContext to be populated so that I can serve the user a static piece of js or a favicon? 2. Legacy code can coexist with modern code. If there is an ActionProvider which provides an XWikiContext then all legacy code is about 8 lines away from comparability. Same is true for code which absolutely needs a ServletRequest and ServletResponse, they just need to require them. 3. This API doesn't try to own you. You're not tied down to a context with specific values in it. If you are requiring a PotatoeContext and it turns out not to be good enough, write a CarrotContext and begin requiring that, the Action model is still the same. Devil's Advocacy: 1. Why does it map implementations by their classes? What if someone wants to register 2 providers of OutputStream? * Notice I used ClientPrintWriter rather than PrintWriter in the example. If you write a provider, it is best practice to extend a class or interface and provide your extension so that anyone who is using your provider will have to 'import' the class which you provide. I want to avoid this: Object x = context.get("IHaveNoIdeaWhereThisIsDefined"); We can change this without breaking the API by adding optional "hints" to the @Action.Runner annotation. 2. Good job cjd, you just rewrote the ComponentManager. * I spent quite some time wrestling with whether this should be done in the CM, from a pragmatic PoV, the problem is you end up needing to create things on a per-request basis which abuses the ECM and will hold the initialization (global) lock for a long time. From a design PoV it's wrong because dependency injection is meant to inject long lived (often singleton) machinery objects whereas this is for request scoped data objects. 3. Why the silly Callbacks? * An obvious thought is that an ActionProvider should just have a get() method like any other provider which returns the object in question. The pragmatic issue with that is suppose you need to do something expensive like hit the database to get an object and you get another object for free while doing it, do you throw the other one away and then when the caller needs the other one, they call another provider and do the expensive operation over again? This solution allows a provider to pull in multiple callbacks and call each one, thus providing multiple objects. A second more subtle reason is that ActionProviders are allowed to return their provisions asynchronously which means we could implement some very exciting optimizations at the storage level. We don't have to do that route but I don't want to close the door on it. 4. Nobody has ever done this before * That's why it's going to work. Actually this design draws heavily on Asynchronous Module Definition which is explained here: http://requirejs.org/docs/whyamd.html 5. Magic! Arrest this sorcerer! * It's valid to call this magic. It's also valid to call any kind of dependency injection magic. @Inject private InterfaceWhichDoesNotExplainMuch youWillNeverFigureOutWhereTheImplementationIs; is as bad as this or worse. One way we can minimize the magic and keep the benefits is to make our ActionProviders provide custom classes which are defined close to the ActionProvider. ViewingUser or CurrentDocumentAuthorUser are much more self explanatory than injecting "User" even if both classes extend User. 5. ... * Help me try to break this design. Where's the code: Coming soon, I have most of a PoC hacked together but it currently has a slightly different API which I scrapped in favor of the one defined here. I just want to get discussion going as early as possible. Prove me wrong Caleb

1 0

[xwiki-devs] [Brainstorming] Colocated Functional Test (CFT)
by Vincent Massol 22 Nov '12

22 Nov '12

Hi devs, I've started an experiment to have colocated functional tests (CFT), which means having the functional tests located where the functional domain sources are located instead of in XE. For example for the linkchecker module we have the following directories: xwiki-platform-linkchecker/ |_ xwiki-platform-linkchecker-refresher (JAR) |_ xwiki-platform-linkchecker-ui (XAR) |_ xwiki-platform-linkchecker-tests (functional tests) The rationale for this was: * Have everything about a functional domain self-contained (source and all tests) * Making it easy to run only tests for a given functional domain * Move page objects to the functional domain too Here are some findings about this experiment: A - It takes about 30 seconds to generate the adhoc packaging and start XWiki. This would be done for each module having functional tests compared to only once if all tests were executed in XE B- The package mojo created to generate a full packaging is quite nice and I plan to reuse it in lots of other places in our build (distributions, database, places where we need XWiki configuration files) C- We will not be able to run platform builds in Maven multithreaded mode since it would mean that several XWiki instance could be started at the same time on the same port D- The colocated functional test module Solutions/ideas: * One idea to overcome A and C would to have the following setup: ** Keep functional test modules colocated but have them generate a test JAR ** Still allow running functional tests from the colocated module (this makes it easy to verify no regression was introduced when making changes to a given domain) ** Have functional tests in XE depend on the colocated functional test module JARs and configure Jenkins to run all functional tests from XE only * Another solution to overcome C is to auto-discover the port to use in our XWiki startup script (and save it in a file so that the stop script can use it). I think the first proposal is the best one and brings the best of the 2 worlds. WDYT? Thanks -Vincent

4 10

[xwiki-devs] Application Board update release
by Thomas Delafosse 20 Nov '12

20 Nov '12

Hello, I made a pull request for the Bulletin Board Application (cf. http://jira.xwiki.org/browse/XBB-6?page=com.atlassian.streams.streams-jira-…) could you please apply it ? Could you also give me an account on http://nexus.xwiki.org, so I could release this update once it has been applied ? Cheers, Thomas

2 1

[xwiki-devs] [VOTE] Retire old query plugin
by Thomas Mortagne 19 Nov '12

19 Nov '12

Hi devs, Following the discussion on http://markmail.org/message/uck6w56gqus2mxsw I would like to extract the query plugin from xwiki-platform-legacy-oldcore and move it to retired repository. The good things is that we will get rid of 3 jars in standard XE by doing this. I plan to do it in 4.4M1. WDYT ? Here is my +1 -- Thomas Mortagne

9 19