Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Don't block user when component not on Page using AJAX
Re-instate the behavior that was in versions < 8.0 that a component added to an AjaxRequestTarget but is not part of the page, would be ignored (or failed to refresh with an error in the JavaScript console). So instead of always throwing an error, we only do so in DEVELOPMENT mode causing an error page, and in DEPLOYMENT mode we only log the fault, but don't break the application hard for the user: the component refresh is ignored, just as it would've been in versions prior to 8. Fixes WICKET-6528
- Loading branch information
Showing
5 changed files
with
241 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
6 changes: 6 additions & 0 deletions
6
...rc/test/java/org/apache/wicket/ajax/markup/html/ComponentNotOnPage$LastSelectedPanel.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <html xmlns="http://www.w3.org/1999/xhtml" xmlns:wicket="http://wicket.apache.org"> | ||
| <wicket:panel> | ||
| <a href="#" wicket:id="refresh">Refresh</a> | ||
| </wicket:panel> | ||
| </html> |
15 changes: 15 additions & 0 deletions
15
wicket-core/src/test/java/org/apache/wicket/ajax/markup/html/ComponentNotOnPage.html
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,15 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <html xmlns="http://www.w3.org/1999/xhtml" | ||
| xmlns:wicket="http://wicket.apache.org"> | ||
| <head> | ||
| <title>Stateless Wicket</title> | ||
| </head> | ||
| <body> | ||
| <ul> | ||
| <li wicket:id="listview"> | ||
| <a href="#" wicket:id="link"></a> | ||
| </li> | ||
| </ul> | ||
| <div wicket:id="refresher"></div> | ||
| </body> | ||
| </html> |
89 changes: 89 additions & 0 deletions
89
wicket-core/src/test/java/org/apache/wicket/ajax/markup/html/ComponentNotOnPage.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.wicket.ajax.markup.html; | ||
|
|
||
| import java.util.Arrays; | ||
|
|
||
| import org.apache.wicket.ajax.AjaxRequestTarget; | ||
| import org.apache.wicket.markup.html.WebMarkupContainer; | ||
| import org.apache.wicket.markup.html.WebPage; | ||
| import org.apache.wicket.markup.html.list.ListItem; | ||
| import org.apache.wicket.markup.html.list.ListView; | ||
| import org.apache.wicket.markup.html.panel.EmptyPanel; | ||
| import org.apache.wicket.markup.html.panel.Panel; | ||
|
|
||
| /** | ||
| * Test page for triggering the component is not on page error from AjaxRequestHandler. | ||
| */ | ||
| public class ComponentNotOnPage extends WebPage | ||
| { | ||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| @Override | ||
| protected void onInitialize() | ||
| { | ||
| super.onInitialize(); | ||
|
|
||
| add(new EmptyPanel("refresher")); | ||
|
|
||
| add(new ListView<Integer>("listview", Arrays.asList(1, 2, 3, 4, 5)) | ||
| { | ||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| @Override | ||
| protected void populateItem(ListItem<Integer> item) | ||
| { | ||
| item.setOutputMarkupId(true); | ||
|
|
||
| item.add(new AjaxLink<Void>("link") | ||
| { | ||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| @Override | ||
| public void onClick(AjaxRequestTarget target) | ||
| { | ||
| LastSelectedPanel lastSelected = new LastSelectedPanel("refresher", item); | ||
| ComponentNotOnPage.this.replace(lastSelected); | ||
| target.add(lastSelected); | ||
| } | ||
| }); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| public static class LastSelectedPanel extends Panel | ||
| { | ||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| public LastSelectedPanel(String id, WebMarkupContainer refresher) | ||
| { | ||
| super(id); | ||
|
|
||
| setOutputMarkupId(true); | ||
| add(new AjaxLink<Void>("refresh") | ||
| { | ||
| private static final long serialVersionUID = 1L; | ||
|
|
||
| @Override | ||
| public void onClick(AjaxRequestTarget target) | ||
| { | ||
| target.add(refresher); | ||
| } | ||
| }); | ||
| } | ||
| } | ||
| } |
103 changes: 103 additions & 0 deletions
103
wicket-core/src/test/java/org/apache/wicket/ajax/markup/html/ComponentNotOnPageTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one or more | ||
| * contributor license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright ownership. | ||
| * The ASF licenses this file to You under the Apache License, Version 2.0 | ||
| * (the "License"); you may not use this file except in compliance with | ||
| * the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
| package org.apache.wicket.ajax.markup.html; | ||
|
|
||
| import org.apache.wicket.RuntimeConfigurationType; | ||
| import org.apache.wicket.mock.MockApplication; | ||
| import org.apache.wicket.protocol.http.WebApplication; | ||
| import org.apache.wicket.util.tester.WicketTestCase; | ||
| import org.junit.Assert; | ||
| import org.junit.Test; | ||
|
|
||
| /** | ||
| * Tests for checking whether or not a component is attached to the component hierarchy when | ||
| * updating through AJAX. | ||
| */ | ||
| public class ComponentNotOnPageTest extends WicketTestCase | ||
| { | ||
| private RuntimeConfigurationType configuration = RuntimeConfigurationType.DEVELOPMENT; | ||
|
|
||
| /** | ||
| * Overrides the application factory to enable changing the configuration type of Wicket. | ||
| */ | ||
| @Override | ||
| protected WebApplication newApplication() | ||
| { | ||
| return new MockApplication() | ||
| { | ||
| @Override | ||
| public RuntimeConfigurationType getConfigurationType() | ||
| { | ||
| return configuration; | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * When running in development mode Wicket should trigger an exception signaling the error on | ||
| * the developers part that a component that is not part of the page is being refreshed in the | ||
| * AJAX response, resulting in a no-op (which is not the intended result). | ||
| */ | ||
| @Test(expected = IllegalArgumentException.class) | ||
| public void responseTargetInDevelopmentModeShouldFail() | ||
| { | ||
| configuration = RuntimeConfigurationType.DEVELOPMENT; | ||
|
|
||
| try | ||
| { | ||
| // this should not fail | ||
| ComponentNotOnPage page = tester.startPage(ComponentNotOnPage.class); | ||
| tester.clickLink("listview:0:link", true); | ||
| tester.startPage(page); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| Assert.fail("Unexpected exception: " + e); | ||
| } | ||
|
|
||
| // this should fail | ||
| tester.clickLink("refresher:refresh", true); | ||
| } | ||
|
|
||
| /** | ||
| * When running in deployment mode Wicket should <b>not</b> trigger an exception signaling the | ||
| * error on the developers part that a component that is not part of the page is being refreshed | ||
| * in the AJAX response, resulting in a no-op (which is not the intended result). Instead Wicket | ||
| * should signal the error in the log, but not prevent the user of the application to continue | ||
| * (which happened in Wicket 7). | ||
| */ | ||
| @Test | ||
| public void responseTargetInDeploymentModeShouldNotFail() | ||
| { | ||
| configuration = RuntimeConfigurationType.DEPLOYMENT; | ||
|
|
||
| try | ||
| { | ||
| // this should not fail | ||
| ComponentNotOnPage page = tester.startPage(ComponentNotOnPage.class); | ||
| tester.clickLink("listview:0:link", true); | ||
| tester.startPage(page); | ||
| } | ||
| catch (Exception e) | ||
| { | ||
| Assert.fail("Unexpected exception: " + e); | ||
| } | ||
|
|
||
| // this shouldn't fail as well | ||
| tester.clickLink("refresher:refresh", true); | ||
| } | ||
| } |