fix!: Use dedicated mapping for Vaadin push endpoint (#15188)

Removes pushUrl configuration option, and instead maps push always to a dedicated path (/VAADIN/push).

Related-to #14641

Author: tepi

flow-client/src/main/java/com/vaadin/client/communication/AtmospherePushConnection.java

@@ -188,10 +188,15 @@ public AtmospherePushConnection(Registry registry) {
             }
 
         });
-        if (getPushConfiguration().getPushUrl() == null) {
-            url = registry.getApplicationConfiguration().getServiceUrl();
-        } else {
-            url = getPushConfiguration().getPushUrl();
+        url = getPushConfiguration().getPushUrl();
+        // If a specific serviceUrl is defined, prepend pushUrl with it
+        String serviceUrl = registry.getApplicationConfiguration()
+                .getServiceUrl();
+        if (!serviceUrl.equals(".")) {
+            if (!serviceUrl.endsWith("/")) {
+                serviceUrl += "/";
+            }
+            url = serviceUrl + url;
         }
         runWhenAtmosphereLoaded(
                 () -> Scheduler.get().scheduleDeferred(this::connect));

flow-client/src/main/java/com/vaadin/client/communication/PushConfiguration.java

@@ -25,6 +25,7 @@
 import com.vaadin.client.flow.reactive.Reactive;
 import com.vaadin.flow.internal.nodefeature.NodeFeatures;
 import com.vaadin.flow.internal.nodefeature.PushConfigurationMap;
+import com.vaadin.flow.server.Constants;
 
 /**
  * Provides the push configuration stored in the root node with an easier to use
@@ -88,19 +89,12 @@ private NodeMap getConfigurationMap() {
     }
 
     /**
-     * Gets the push URL configured on the server.
+     * Gets the fixed push URL.
      *
-     * @return the push URL configured on the server or null if none has been
-     *         configured
+     * @return the fixed push URL (VAADIN/push)
      */
     public String getPushUrl() {
-        if (getConfigurationMap()
-                .hasPropertyValue(PushConfigurationMap.PUSH_URL_KEY)) {
-            return (String) getConfigurationMap()
-                    .getProperty(PushConfigurationMap.PUSH_URL_KEY).getValue();
-        }
-
-        return null;
+        return Constants.PUSH_MAPPING;
     }
 
     /**

flow-server/src/main/java/com/vaadin/flow/component/PushConfiguration.java

@@ -138,27 +138,6 @@ public interface PushConfiguration extends Serializable {
      */
     void setParameter(String parameter, String value);
 
-    /**
-     * Sets the URL to use for push requests.
-     * <p>
-     * This is only used when overriding the URL to use. Setting this to null
-     * (the default) will use the default URL.
-     *
-     * @param pushUrl
-     *            The push URL to use
-     */
-    void setPushUrl(String pushUrl);
-
-    /**
-     * Returns the URL to use for push requests.
-     * <p>
-     * This is only used when overriding the URL to use. Returns null (the
-     * default) when the default URL is used.
-     *
-     * @return the URL to use for push requests, or null to use to default
-     */
-    String getPushUrl();
-
     /**
      * Sets the factory that will be used to create new instances of
      * {@link PushConnection}.
@@ -235,16 +214,6 @@ public void setPushMode(PushMode pushMode) {
         }
     }
 
-    @Override
-    public void setPushUrl(String pushUrl) {
-        getPushConfigurationMap().setPushUrl(pushUrl);
-    }
-
-    @Override
-    public String getPushUrl() {
-        return getPushConfigurationMap().getPushUrl();
-    }
-
     @Override
     public Transport getTransport() {
         return getPushConfigurationMap().getTransport();

flow-server/src/main/java/com/vaadin/flow/function/DeploymentConfiguration.java

@@ -123,14 +123,6 @@ public interface DeploymentConfiguration
      */
     PushMode getPushMode();
 
-    /**
-     * Returns the URL that bidirectional ("push") client-server communication
-     * should use.
-     *
-     * @return The push URL to use
-     */
-    String getPushURL();
-
     /**
      * Gets the properties configured for the deployment, e.g. as init
      * parameters to the servlet.

flow-server/src/main/java/com/vaadin/flow/internal/BootstrapHandlerHelper.java

@@ -17,6 +17,7 @@
 
 import java.io.Serializable;
 
+import com.vaadin.flow.server.Constants;
 import com.vaadin.flow.server.HandlerHelper;
 import com.vaadin.flow.server.VaadinRequest;
 import com.vaadin.flow.server.VaadinSession;
@@ -66,12 +67,8 @@ public static String getServiceUrl(VaadinRequest vaadinRequest) {
      */
     public static String getPushURL(VaadinSession vaadinSession,
             VaadinRequest vaadinRequest) {
-        String serviceUrl = getServiceUrl(vaadinRequest);
+        String pushURL = Constants.PUSH_MAPPING;
 
-        String pushURL = vaadinSession.getConfiguration().getPushURL();
-        if (pushURL == null) {
-            pushURL = serviceUrl;
-        }
         String contextPath = vaadinRequest.getService()
                 .getContextRootRelativePath(vaadinRequest);
 

flow-server/src/main/java/com/vaadin/flow/internal/nodefeature/PushConfigurationMap.java

@@ -58,7 +58,6 @@ public PushConfigurationParametersMap(StateNode node) {
     public static final String FALLBACK_TRANSPORT_KEY = "fallbackTransport";
     public static final String PUSHMODE_KEY = "pushMode";
     public static final String ALWAYS_USE_XHR_TO_SERVER = "alwaysXhrToServer";
-    public static final String PUSH_URL_KEY = "pushUrl";
     public static final String PARAMETERS_KEY = "parameters";
 
     /**
@@ -138,16 +137,6 @@ public PushMode getPushMode() {
         return PushMode.valueOf(get(PUSHMODE_KEY).toString());
     }
 
-    @Override
-    public void setPushUrl(String pushUrl) {
-        put(PUSH_URL_KEY, pushUrl);
-    }
-
-    @Override
-    public String getPushUrl() {
-        return getOrDefault(PUSH_URL_KEY, null);
-    }
-
     @Override
     public String getParameter(String key) {
         return (String) getParameters().get(key);

flow-server/src/main/java/com/vaadin/flow/server/BootstrapHandler.java

@@ -1525,7 +1525,6 @@ protected BootstrapContext createAndInitUI(Class<? extends UI> uiClass,
                 .orElseGet(deploymentConfiguration::getPushMode);
         setupPushConnectionFactory(pushConfiguration, context);
         pushConfiguration.setPushMode(pushMode);
-        pushConfiguration.setPushUrl(deploymentConfiguration.getPushURL());
         push.map(Push::transport).ifPresent(pushConfiguration::setTransport);
 
         // Set thread local here so it is available in init

flow-server/src/main/java/com/vaadin/flow/server/Constants.java

@@ -130,13 +130,6 @@ public final class Constants implements Serializable {
     @Deprecated
     public static final String SERVLET_PARAMETER_PUSH_MODE = InitParameters.SERVLET_PARAMETER_PUSH_MODE;
 
-    /**
-     * @deprecated Use {@link InitParameters#SERVLET_PARAMETER_PUSH_URL}
-     *             instead.
-     */
-    @Deprecated
-    public static final String SERVLET_PARAMETER_PUSH_URL = InitParameters.SERVLET_PARAMETER_PUSH_URL;
-
     /**
      * @deprecated Use {@link InitParameters#SERVLET_PARAMETER_SYNC_ID_CHECK}
      *             instead.
@@ -372,6 +365,11 @@ public final class Constants implements Serializable {
      */
     public static final String VAADIN_MAPPING = "VAADIN/";
 
+    /**
+     * The path used in the vaadin servlet for handling push.
+     */
+    public static final String PUSH_MAPPING = VAADIN_MAPPING + "push";
+
     /**
      * The static build resources folder.
      */

flow-server/src/main/java/com/vaadin/flow/server/DefaultDeploymentConfiguration.java

@@ -92,7 +92,6 @@ public class DefaultDeploymentConfiguration
     private int webComponentDisconnect;
     private boolean closeIdleSessions;
     private PushMode pushMode;
-    private String pushURL;
     private boolean syncIdCheck;
     private boolean sendUrlsAsParameters;
     private boolean requestTiming;
@@ -129,7 +128,6 @@ public DefaultDeploymentConfiguration(ApplicationConfiguration parentConfig,
         checkWebComponentDisconnectTimeout();
         checkCloseIdleSessions();
         checkPushMode();
-        checkPushURL();
         checkSyncIdCheck();
         checkSendUrlsAsParameters();
 
@@ -257,16 +255,6 @@ public PushMode getPushMode() {
         return pushMode;
     }
 
-    /**
-     * {@inheritDoc}
-     * <p>
-     * The default mode is <code>""</code> which uses the servlet URL.
-     */
-    @Override
-    public String getPushURL() {
-        return pushURL;
-    }
-
     /**
      * Log a warning if Vaadin is not running in production mode.
      */
@@ -404,11 +392,6 @@ private void checkPushMode() {
         }
     }
 
-    private void checkPushURL() {
-        pushURL = getStringProperty(InitParameters.SERVLET_PARAMETER_PUSH_URL,
-                "");
-    }
-
     private void checkSyncIdCheck() {
         syncIdCheck = getBooleanProperty(
                 InitParameters.SERVLET_PARAMETER_SYNC_ID_CHECK,

flow-server/src/main/java/com/vaadin/flow/server/InitParameters.java

@@ -56,7 +56,6 @@ public class InitParameters implements Serializable {
     public static final String SERVLET_PARAMETER_WEB_COMPONENT_DISCONNECT = "webComponentDisconnect";
     public static final String SERVLET_PARAMETER_CLOSE_IDLE_SESSIONS = "closeIdleSessions";
     public static final String SERVLET_PARAMETER_PUSH_MODE = "pushMode";
-    public static final String SERVLET_PARAMETER_PUSH_URL = "pushURL";
     public static final String SERVLET_PARAMETER_SYNC_ID_CHECK = "syncIdCheck";
     public static final String SERVLET_PARAMETER_SEND_URLS_AS_PARAMETERS = "sendUrlsAsParameters";
     public static final String SERVLET_PARAMETER_PUSH_SUSPEND_TIMEOUT_LONGPOLLING = "pushLongPollingSuspendTimeout";