Add ServletContext parameter to RpcLogger methods, allow only one initialization of RpcLoggerProvider

Various other improvements as suggested by niloc32

Author: g-keiser

user/build.xml

@@ -163,7 +163,7 @@
           </tokenfilter>
         </filterchain>
       </move>
-      <move file="${project.build}/no-servlet-src/META-INF/services/com.google.gwt.user.server.rpc.logging.LoggerProvider" tofile="${project.build}/jakarta-src/META-INF/services/com.google.gwt.user.server.rpc.logging.jakarta.LoggerProvider">
+      <move file="${project.build}/no-servlet-src/META-INF/services/com.google.gwt.user.server.rpc.logging.RpcLoggerProvider" tofile="${project.build}/jakarta-src/META-INF/services/com.google.gwt.user.server.rpc.logging.jakarta.RpcLoggerProvider">
         <filterchain>
           <tokenfilter>
             <replacestring from="com.google.gwt.user.server.rpc.logging" to="com.google.gwt.user.server.rpc.logging.jakarta"/>

…t.user.server.rpc.logging.LoggerProvider …ser.server.rpc.logging.RpcLoggerProvideruser/src/META-INF/services/com.google.gwt.user.server.rpc.logging.LoggerProvider renamed to user/src/META-INF/services/com.google.gwt.user.server.rpc.logging.RpcLoggerProvider user/src/META-INF/services/com.google.gwt.user.server.rpc.logging.LoggerProvider renamed to user/src/META-INF/services/com.google.gwt.user.server.rpc.logging.RpcLoggerProvider

@@ -1,4 +1,4 @@
 com.google.gwt.user.server.rpc.logging.JulLoggerProvider
 com.google.gwt.user.server.rpc.logging.Log4jProvider
 com.google.gwt.user.server.rpc.logging.PlatformLoggerProvider
-# No no-args constructor: com.google.gwt.user.server.rpc.logging.ServletContextLoggerProvider
+com.google.gwt.user.server.rpc.logging.ServletContextLoggerProvider

user/src/com/google/gwt/user/server/rpc/AbstractRemoteServiceServlet.java

@@ -19,6 +19,7 @@
 
 import java.io.IOException;
 
+import javax.servlet.ServletContext;
 import javax.servlet.ServletException;
 import javax.servlet.http.HttpServlet;
 import javax.servlet.http.HttpServletRequest;
@@ -104,7 +105,9 @@ protected void doUnexpectedFailure(Throwable e) {
        */
       throw new RuntimeException("Unable to report failure", e);
     }
-    RPCServletUtils.writeResponseForUnexpectedFailure(getThreadLocalResponse(), e);
+    ServletContext servletContext = getServletContext();
+    RPCServletUtils.writeResponseForUnexpectedFailure(servletContext,
+        getThreadLocalResponse(), e);
   }
 
   /**

user/src/com/google/gwt/user/server/rpc/RPCServletUtils.java

@@ -15,9 +15,8 @@
  */
 package com.google.gwt.user.server.rpc;
 
-
-import com.google.gwt.user.server.rpc.logging.LogManager;
-import com.google.gwt.user.server.rpc.logging.Logger;
+import com.google.gwt.user.server.rpc.logging.RpcLogManager;
+import com.google.gwt.user.server.rpc.logging.RpcLogger;
 
 import java.io.ByteArrayOutputStream;
 import java.io.IOException;
@@ -40,7 +39,7 @@
  */
 public class RPCServletUtils {
 
-  private static final Logger logger = LogManager.getLogger(RPCServletUtils.class);
+  private static final RpcLogger logger = RpcLogManager.getLogger(RPCServletUtils.class);
 
   public static final String CHARSET_UTF8_NAME = "UTF-8";
 
@@ -67,9 +66,11 @@ public class RPCServletUtils {
 
   private static final String CONTENT_ENCODING_GZIP = "gzip";
 
-  private static final String CONTENT_TYPE_APPLICATION_JSON_UTF8 = "application/json; charset=utf-8";
+  private static final String CONTENT_TYPE_APPLICATION_JSON_UTF8 =
+      "application/json; charset=utf-8";
 
-  private static final String GENERIC_FAILURE_MSG = "The call failed on the server; see server log for details";
+  private static final String GENERIC_FAILURE_MSG =
+      "The call failed on the server; see server log for details";
 
   private static final String GWT_RPC_CONTENT_TYPE = "text/x-gwt-rpc";
 
@@ -324,14 +325,6 @@ public static boolean shouldGzipResponseContent(HttpServletRequest request,
         && exceedsUncompressedContentLengthLimit(responseContent);
   }
 
-  @Deprecated
-  public static void writeResponse(ServletContext servletContext,
-      HttpServletResponse response, String responseContent, boolean gzipResponse)
-      throws IOException {
-	  writeResponse(response, responseContent, gzipResponse);
-  }
-
-
   /**
    * Write the response content into the {@link HttpServletResponse}. If
    * <code>gzipResponse</code> is <code>true</code>, the response content will
@@ -344,7 +337,7 @@ public static void writeResponse(ServletContext servletContext,
    * @throws IOException if reading, writing, or closing the response's output
    *           stream fails
    */
-  public static void writeResponse(
+  public static void writeResponse(ServletContext servletContext,
       HttpServletResponse response, String responseContent, boolean gzipResponse)
       throws IOException {
 
@@ -375,7 +368,7 @@ public static void writeResponse(
       }
 
       if (caught != null) {
-        logger.error("Unable to compress response", caught);
+        logger.error("Unable to compress response", caught, servletContext);
         response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
         return;
       }
@@ -390,13 +383,6 @@ public static void writeResponse(
     response.getOutputStream().write(responseBytes);
   }
 
-  @Deprecated
-  public static void writeResponseForUnexpectedFailure(
-      ServletContext servletContext, HttpServletResponse response,
-      Throwable failure) {
-    writeResponseForUnexpectedFailure(response, failure);
-  }
-
   /**
    * Called when the servlet itself has a problem, rather than the invoked
    * third-party method. It writes a simple 500 message back to the client.
@@ -405,8 +391,9 @@ public static void writeResponseForUnexpectedFailure(
    * @param failure
    */
   public static void writeResponseForUnexpectedFailure(
-      HttpServletResponse response, Throwable failure) {
-    logger.error("Exception while dispatching incoming RPC call", failure);
+      ServletContext servletContext, HttpServletResponse response,
+      Throwable failure) {
+    logger.error("Exception while dispatching incoming RPC call", failure, servletContext);
 
     // Send GENERIC_FAILURE_MSG with 500 status.
     //
@@ -422,7 +409,7 @@ public static void writeResponseForUnexpectedFailure(
     } catch (IOException ex) {
       logger.error(
           "respondWithUnexpectedFailure failed while sending the previous failure to the client",
-          ex);
+          ex, servletContext);
     }
   }
 
@@ -448,7 +435,8 @@ private static void checkCharacterEncodingIgnoreCase(
        * properly parsed character encoding string if we decide to make this
        * change.
        */
-      if (characterEncoding.toLowerCase(Locale.ROOT).contains(expectedCharSet.toLowerCase(Locale.ROOT))) {
+      if (characterEncoding.toLowerCase(Locale.ROOT)
+          .contains(expectedCharSet.toLowerCase(Locale.ROOT))) {
         encodingOkay = true;
       }
     }

user/src/com/google/gwt/user/server/rpc/RemoteServiceServlet.java

@@ -22,8 +22,8 @@
 import com.google.gwt.user.client.rpc.IncompatibleRemoteServiceException;
 import com.google.gwt.user.client.rpc.RpcTokenException;
 import com.google.gwt.user.client.rpc.SerializationException;
-import com.google.gwt.user.server.rpc.logging.LogManager;
-import com.google.gwt.user.server.rpc.logging.Logger;
+import com.google.gwt.user.server.rpc.logging.RpcLogManager;
+import com.google.gwt.user.server.rpc.logging.RpcLogger;
 
 import java.io.IOException;
 import java.io.InputStream;
@@ -47,7 +47,7 @@
 public class RemoteServiceServlet extends AbstractRemoteServiceServlet
     implements SerializationPolicyProvider {
 
-  private static final Logger logger = LogManager.getLogger(RemoteServiceServlet.class);
+  private static final RpcLogger logger = RpcLogManager.getLogger(RemoteServiceServlet.class);
 
   /**
    * Loads a serialization policy stored as a servlet resource in the same
@@ -66,7 +66,7 @@ static SerializationPolicy loadSerializationPolicy(HttpServlet servlet,
         modulePath = new URL(moduleBaseURL).getPath();
       } catch (MalformedURLException ex) {
         // log the information, we will default
-        logger.error("Malformed moduleBaseURL: " + moduleBaseURL, ex);
+        logger.error("Malformed moduleBaseURL: " + moduleBaseURL, ex, servlet.getServletContext());
       }
     }
 
@@ -82,15 +82,16 @@ static SerializationPolicy loadSerializationPolicy(HttpServlet servlet,
           + modulePath
           + ", is not in the same web application as this servlet, "
           + contextPath
-          + ".  Your module may not be properly configured or your client and server code maybe out of date.";
-      logger.error(message);
+          + ".  Your module may not be properly configured " +
+          "or your client and server code maybe out of date.";
+      logger.error(message, servlet.getServletContext());
     } else {
       // Strip off the context path from the module base URL. It should be a
       // strict prefix.
       String contextRelativePath = modulePath.substring(contextPath.length());
 
-      String serializationPolicyFilePath = SerializationPolicyLoader.getSerializationPolicyFileName(contextRelativePath
-          + strongName);
+      String serializationPolicyFilePath = SerializationPolicyLoader.getSerializationPolicyFileName(
+          contextRelativePath + strongName);
 
       // Open the RPC resource file and read its contents.
       InputStream is = servlet.getServletContext().getResourceAsStream(
@@ -102,34 +103,32 @@ static SerializationPolicy loadSerializationPolicy(HttpServlet servlet,
                 null);
             if (serializationPolicy.hasClientFields()) {
               if (ENABLE_ENHANCED_CLASSES) {
-                logger.warn(
-                    "Service deserializes enhanced JPA/JDO classes, which is " +
-                        "unsafe. See https://github.com/gwtproject/gwt/issues/9709 for more " +
-                        "detail on the vulnerability that this presents.");
+                logger.warn("Service deserializes enhanced JPA/JDO classes, which is " +
+                       "unsafe. See https://github.com/gwtproject/gwt/issues/9709 for more " +
+                       "detail on the vulnerability that this presents.",
+                    servlet.getServletContext());
               } else {
-                logger.error(
-                    "Service deserializes enhanced JPA/JDO classes, which is " +
-                        "unsafe. Review build logs to see which classes are affected, or set " +
-                        ENABLE_GWT_ENHANCED_CLASSES_PROPERTY + " to true to allow using this " +
-                        "service. See https://github.com/gwtproject/gwt/issues/9709 for more " +
-                        "detail.");
+                logger.error("Service deserializes enhanced JPA/JDO classes, which is " +
+                       "unsafe. Review build logs to see which classes are affected, or set " +
+                       ENABLE_GWT_ENHANCED_CLASSES_PROPERTY + " to true to allow using this " +
+                       "service. See https://github.com/gwtproject/gwt/issues/9709 for more " +
+                       "detail.",
+                    servlet.getServletContext());
                 serializationPolicy = null;
               }
             }
           } catch (ParseException e) {
-            logger.error(
-                "Failed to parse the policy file '"
-                + serializationPolicyFilePath + "'", e);
+            logger.error("Failed to parse the policy file '"
+                + serializationPolicyFilePath + "'", e, servlet.getServletContext());
           } catch (IOException e) {
-            logger.error(
-                "Could not read the policy file '"
-                + serializationPolicyFilePath + "'", e);
+            logger.error("Could not read the policy file '"
+                + serializationPolicyFilePath + "'", e, servlet.getServletContext());
           }
         } else {
           String message = "The serialization policy file '"
               + serializationPolicyFilePath
               + "' was not found; did you forget to include it in this deployment?";
-          logger.error(message);
+          logger.error(message, servlet.getServletContext());
         }
       } finally {
         if (is != null) {
@@ -152,7 +151,8 @@ static SerializationPolicy loadSerializationPolicy(HttpServlet servlet,
    * A cache of moduleBaseURL and serialization policy strong name to
    * {@link SerializationPolicy}.
    */
-  private final Map<String, SerializationPolicy> serializationPolicyCache = new HashMap<String, SerializationPolicy>();
+  private final Map<String, SerializationPolicy> serializationPolicyCache =
+      new HashMap<String, SerializationPolicy>();
 
   /**
    * The implementation of the service.
@@ -185,27 +185,17 @@ public RemoteServiceServlet(Object delegate) {
   }
 
   /**
-   * Overridden to load the gwt.codeserver.port system property.
+   * Overridden to load the gwt.codeserver.port system property and initialize the
+   * {@link RpcLogManager} with a provider name from system properties or the servlet config.
    */
   @Override
   public void init(ServletConfig config) throws ServletException {
     super.init(config);
-    String providerName = getProviderName(config);
-    LogManager.initialize(providerName, config.getServletContext());
+    String providerName = RpcLogManager.getProviderName(config);
+    RpcLogManager.initialize(providerName);
     codeServerPort = getCodeServerPort();
   }
 
-  private String getProviderName(ServletConfig config) {
-      String parameterName = "gwt.rpc.logging";
-      if (System.getProperty(parameterName) != null) {
-          return System.getProperty(parameterName);
-      } else if (config.getInitParameter(parameterName) != null) {
-          return config.getInitParameter(parameterName);
-      } else {
-          return config.getServletContext().getInitParameter(parameterName);
-      }
-  }
-
   /**
    * Returns the value of the gwt.codeserver.port system property, or zero if not defined.
    *
@@ -281,12 +271,13 @@ public final SerializationPolicy getSerializationPolicy(String moduleBaseURL,
 
     if (serializationPolicy == null) {
       // Failed to get the requested serialization policy; use the default
-      logger.warn(
-          "Failed to get the SerializationPolicy '"
+      logger.warn("Failed to get the SerializationPolicy '"
               + strongName
               + "' for module '"
               + moduleBaseURL
-              + "'; a legacy, 1.3.3 compatible, serialization policy will be used.  You may experience SerializationExceptions as a result.");
+              + "'; a legacy, 1.3.3 compatible, serialization policy will be used.  " +
+              "You may experience SerializationExceptions as a result.",
+              getServletContext());
       serializationPolicy = RPC.getDefaultSerializationPolicy();
     }
 
@@ -334,7 +325,7 @@ public String processCall(String payload) throws SerializationException {
     } catch (IncompatibleRemoteServiceException ex) {
       logger.error(
           "An IncompatibleRemoteServiceException was thrown while processing this call.",
-          ex);
+          ex, getServletContext());
       return RPC.encodeResponseForFailedRequest(null, ex);
     }
     return processCall(rpcRequest);
@@ -373,12 +364,12 @@ public String processCall(RPCRequest rpcRequest) throws SerializationException {
     } catch (IncompatibleRemoteServiceException ex) {
       logger.error(
           "An IncompatibleRemoteServiceException was thrown while processing this call.",
-          ex);
+          ex,
+          getServletContext());
       return RPC.encodeResponseForFailedRequest(rpcRequest, ex);
     } catch (RpcTokenException tokenException) {
-      logger.error(
-          "An RpcTokenException was thrown while processing this call.",
-          tokenException);
+      logger.error("An RpcTokenException was thrown while processing this call.",
+          tokenException, getServletContext());
       return RPC.encodeResponseForFailedRequest(rpcRequest, tokenException);
     }
   }
@@ -486,7 +477,7 @@ protected String getCodeServerPolicyUrl(String strongName) {
    * no authentication. It should only be used during development.</p>
    */
   protected SerializationPolicy loadPolicyFromCodeServer(String url) {
-    return CODE_SERVER_CLIENT.loadPolicy(url);
+    return CODE_SERVER_CLIENT.loadPolicy(url, getServletContext());
   }
 
   /**
@@ -550,6 +541,6 @@ private void writeResponse(HttpServletRequest request,
     boolean gzipEncode = RPCServletUtils.acceptsGzipEncoding(request)
         && shouldCompressResponse(request, response, responsePayload);
 
-    RPCServletUtils.writeResponse(response, responsePayload, gzipEncode);
+    RPCServletUtils.writeResponse(getServletContext(), response, responsePayload, gzipEncode);
   }
 }