Add RPC logging facade backed by service loader

Author: g-keiser

maven/lib-gwt.sh

@@ -86,7 +86,7 @@ function maven-gwt() {
   zip -q $GWT_EXTRACT_DIR/gwt-user.jar --copy --out $GWT_EXTRACT_DIR/gwt-user-trimmed.jar \
       "com/google/gwt/*" "com/google/web/bindery/*" "javaemul/*" \
       "javax/validation/*" "org/hibernate/validator/*" \
-      "org/w3c/flute/*"
+      "org/w3c/flute/*" "META-INF/services/*"
   mv $GWT_EXTRACT_DIR/gwt-user-trimmed.jar $GWT_EXTRACT_DIR/gwt-user.jar
 
   for i in $gwtLibs

user/build.xml

@@ -163,6 +163,24 @@
           </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">
+        <filterchain>
+          <tokenfilter>
+            <replacestring from="com.google.gwt.user.server.rpc.logging" to="com.google.gwt.user.server.rpc.logging.jakarta"/>
+          </tokenfilter>
+        </filterchain>
+      </move>
+      <move todir="${project.build}/jakarta-src/com/google/gwt/user/server/rpc/logging/jakarta">
+	    <fileset dir="${project.build}/no-servlet-src/com/google/gwt/user/server/rpc/logging">
+	      <include name="**/*.java"/>
+	    </fileset>
+        <filterchain>
+          <tokenfilter>
+            <replacestring from="package com.google.gwt.user.server.rpc.logging" to="package com.google.gwt.user.server.rpc.logging.jakarta"/>
+            <replacestring from="javax.servlet" to="jakarta.servlet"/>
+          </tokenfilter>
+        </filterchain>
+      </move>
       <move todir="${project.build}/jakarta-src/com/google/gwt/user/server/rpc/jakarta">
         <filelist dir="${project.build}/no-servlet-src/com/google/gwt/user/server/rpc">
           <file name="AbstractRemoteServiceServlet.java"/>
@@ -178,6 +196,7 @@
           <tokenfilter>
             <replacestring from="package com.google.gwt.user.server.rpc" to="package com.google.gwt.user.server.rpc.jakarta"/>
             <replacestring from="com.google.gwt.user.server.Util" to="com.google.gwt.user.server.jakarta.Util"/>
+            <replacestring from="com.google.gwt.user.server.rpc.logging" to="com.google.gwt.user.server.rpc.logging.jakarta"/>
             <replacestring from="javax.servlet" to="jakarta.servlet"/>
           </tokenfilter>
         </filterchain>

user/src/META-INF/services/com.google.gwt.user.server.rpc.logging.LoggerProvider

@@ -0,0 +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

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

@@ -16,6 +16,9 @@
 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 java.io.ByteArrayOutputStream;
 import java.io.IOException;
 import java.io.InputStream;
@@ -24,8 +27,6 @@
 import java.nio.charset.StandardCharsets;
 import java.util.Locale;
 import java.util.concurrent.ConcurrentHashMap;
-import java.util.logging.Level;
-import java.util.logging.Logger;
 import java.util.zip.GZIPOutputStream;
 
 import javax.servlet.ServletContext;
@@ -39,7 +40,7 @@
  */
 public class RPCServletUtils {
 
-  private static final Logger logger = Logger.getLogger(RPCServletUtils.class.getName());
+  private static final Logger logger = LogManager.getLogger(RPCServletUtils.class);
 
   public static final String CHARSET_UTF8_NAME = "UTF-8";
 
@@ -374,7 +375,7 @@ public static void writeResponse(
       }
 
       if (caught != null) {
-        logger.log(Level.SEVERE, "Unable to compress response", caught);
+        logger.error("Unable to compress response", caught);
         response.sendError(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
         return;
       }
@@ -405,7 +406,7 @@ public static void writeResponseForUnexpectedFailure(
    */
   public static void writeResponseForUnexpectedFailure(
       HttpServletResponse response, Throwable failure) {
-    logger.log(Level.SEVERE, "Exception while dispatching incoming RPC call", failure);
+    logger.error("Exception while dispatching incoming RPC call", failure);
 
     // Send GENERIC_FAILURE_MSG with 500 status.
     //
@@ -419,7 +420,7 @@ public static void writeResponseForUnexpectedFailure(
         response.getWriter().write(GENERIC_FAILURE_MSG);
       }
     } catch (IOException ex) {
-      logger.log(Level.SEVERE,
+      logger.error(
           "respondWithUnexpectedFailure failed while sending the previous failure to the client",
           ex);
     }

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

@@ -22,6 +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 java.io.IOException;
 import java.io.InputStream;
@@ -30,8 +32,6 @@
 import java.text.ParseException;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.logging.Level;
-import java.util.logging.Logger;
 
 import javax.servlet.ServletConfig;
 import javax.servlet.ServletException;
@@ -47,7 +47,7 @@
 public class RemoteServiceServlet extends AbstractRemoteServiceServlet
     implements SerializationPolicyProvider {
 
-  private static final Logger logger = Logger.getLogger(RemoteServiceServlet.class.getName());
+  private static final Logger logger = LogManager.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.log(Level.SEVERE, "Malformed moduleBaseURL: " + moduleBaseURL, ex);
+        logger.error("Malformed moduleBaseURL: " + moduleBaseURL, ex);
       }
     }
 
@@ -83,7 +83,7 @@ static SerializationPolicy loadSerializationPolicy(HttpServlet servlet,
           + ", 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.log(Level.SEVERE, message);
+      logger.error(message);
     } else {
       // Strip off the context path from the module base URL. It should be a
       // strict prefix.
@@ -102,12 +102,12 @@ static SerializationPolicy loadSerializationPolicy(HttpServlet servlet,
                 null);
             if (serializationPolicy.hasClientFields()) {
               if (ENABLE_ENHANCED_CLASSES) {
-                logger.log(Level.WARNING,
+                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.");
               } else {
-                logger.log(Level.SEVERE,
+                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 " +
@@ -117,19 +117,19 @@ static SerializationPolicy loadSerializationPolicy(HttpServlet servlet,
               }
             }
           } catch (ParseException e) {
-            logger.log(Level.SEVERE,
+            logger.error(
                 "Failed to parse the policy file '"
                 + serializationPolicyFilePath + "'", e);
           } catch (IOException e) {
-            logger.log(Level.SEVERE,
+            logger.error(
                 "Could not read the policy file '"
                 + serializationPolicyFilePath + "'", e);
           }
         } else {
           String message = "The serialization policy file '"
               + serializationPolicyFilePath
               + "' was not found; did you forget to include it in this deployment?";
-          logger.log(Level.SEVERE, message);
+          logger.error(message);
         }
       } finally {
         if (is != null) {
@@ -190,9 +190,22 @@ public RemoteServiceServlet(Object delegate) {
   @Override
   public void init(ServletConfig config) throws ServletException {
     super.init(config);
+    String providerName = getProviderName(config);
+    LogManager.initialize(providerName, config.getServletContext());
     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.
    *
@@ -268,7 +281,7 @@ public final SerializationPolicy getSerializationPolicy(String moduleBaseURL,
 
     if (serializationPolicy == null) {
       // Failed to get the requested serialization policy; use the default
-      logger.log(Level.WARNING,
+      logger.warn(
           "Failed to get the SerializationPolicy '"
               + strongName
               + "' for module '"
@@ -319,8 +332,7 @@ public String processCall(String payload) throws SerializationException {
     try {
       rpcRequest = RPC.decodeRequest(payload, delegate.getClass(), this);
     } catch (IncompatibleRemoteServiceException ex) {
-      logger.log(
-          Level.SEVERE,
+      logger.error(
           "An IncompatibleRemoteServiceException was thrown while processing this call.",
           ex);
       return RPC.encodeResponseForFailedRequest(null, ex);
@@ -359,12 +371,12 @@ public String processCall(RPCRequest rpcRequest) throws SerializationException {
           rpcRequest.getParameters(), rpcRequest.getSerializationPolicy(),
           rpcRequest.getFlags());
     } catch (IncompatibleRemoteServiceException ex) {
-      logger.log(Level.SEVERE,
+      logger.error(
           "An IncompatibleRemoteServiceException was thrown while processing this call.",
           ex);
       return RPC.encodeResponseForFailedRequest(rpcRequest, ex);
     } catch (RpcTokenException tokenException) {
-      logger.log(Level.SEVERE,
+      logger.error(
           "An RpcTokenException was thrown while processing this call.",
           tokenException);
       return RPC.encodeResponseForFailedRequest(rpcRequest, tokenException);
@@ -474,19 +486,7 @@ protected String getCodeServerPolicyUrl(String strongName) {
    * no authentication. It should only be used during development.</p>
    */
   protected SerializationPolicy loadPolicyFromCodeServer(String url) {
-    SerializationPolicyClient.Logger adapter = new SerializationPolicyClient.Logger() {
-
-      @Override
-      public void logInfo(String message) {
-        logger.log(Level.INFO, message);
-      }
-
-      @Override
-      public void logError(String message, Throwable throwable) {
-        logger.log(Level.SEVERE, message, throwable);
-      }
-    };
-    return CODE_SERVER_CLIENT.loadPolicy(url, adapter);
+    return CODE_SERVER_CLIENT.loadPolicy(url);
   }
 
   /**

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

@@ -15,6 +15,9 @@
  */
 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 java.io.IOException;
 import java.io.InputStream;
 import java.net.HttpURLConnection;
@@ -30,6 +33,8 @@
  * (Intended only for development.)
  */
 class SerializationPolicyClient {
+
+  private static final Logger logger = LogManager.getLogger(SerializationPolicyClient.class);
   private final int connectTimeout;
   private final int readTimeout;
 
@@ -43,12 +48,12 @@ class SerializationPolicyClient {
     this.readTimeout = readTimeoutMs;
   }
 
-  SerializationPolicy loadPolicy(String url, Logger logger) {
+  SerializationPolicy loadPolicy(String url) {
     URL urlObj;
     try {
       urlObj = new URL(url);
     } catch (MalformedURLException e) {
-      logger.logError("Can't parse serialization policy URL: " + url, e);
+      logger.error("Can't parse serialization policy URL: " + url, e);
       return null;
     }
 
@@ -66,11 +71,11 @@ SerializationPolicy loadPolicy(String url, Logger logger) {
       conn.connect();
       in = conn.getInputStream();
     } catch (IOException e) {
-      logger.logError("Can't open serialization policy URL: " + url, e);
+      logger.error("Can't open serialization policy URL: " + url, e);
       return null;
     }
 
-    return readPolicy(in, url, logger);
+    return readPolicy(in, url);
   }
 
   /**
@@ -79,34 +84,33 @@ SerializationPolicy loadPolicy(String url, Logger logger) {
    * @param sourceName names the source of the input stream for log messages.
    * @return the policy or null if unavailable.
    */
-  private static SerializationPolicy readPolicy(InputStream in, String sourceName,
-      Logger logger) {
+  private static SerializationPolicy readPolicy(InputStream in, String sourceName) {
     try {
       List<ClassNotFoundException> errs = new ArrayList<ClassNotFoundException>();
       SerializationPolicy policy = SerializationPolicyLoader.loadFromStream(in, errs);
-      logger.logInfo("Downloaded serialization policy from " + sourceName);
+      logger.error("Downloaded serialization policy from " + sourceName);
 
       if (!errs.isEmpty()) {
-        logMissingClasses(logger, errs);
+        logMissingClasses(errs);
       }
       return policy;
 
     } catch (ParseException e) {
-      logger.logError("Can't parse serialization policy from " + sourceName, e);
+      logger.error("Can't parse serialization policy from " + sourceName, e);
       return null;
     } catch (IOException e) {
-      logger.logError("Can't read serialization policy from " + sourceName, e);
+      logger.error("Can't read serialization policy from " + sourceName, e);
       return null;
     } finally {
       try {
         in.close();
       } catch (IOException e) {
-        logger.logError("Can't close serialization policy url: " + sourceName, e);
+        logger.error("Can't close serialization policy url: " + sourceName, e);
       }
     }
   }
 
-  private static void logMissingClasses(Logger logger, List<ClassNotFoundException> errs) {
+  private static void logMissingClasses(List<ClassNotFoundException> errs) {
     StringBuilder message = new StringBuilder();
     message.append("Unable to load server-side classes used by policy:\n");
 
@@ -118,14 +122,7 @@ private static void logMissingClasses(Logger logger, List<ClassNotFoundException
     if (omitted > 0) {
       message.append("  (omitted " + omitted + " more classes)\n");
     }
-    logger.logInfo(message.toString());
+    logger.info(message.toString());
   }
 
-  /**
-   * Destination for the loader's log messages.
-   */
-  interface Logger {
-    void logInfo(String message);
-    void logError(String message, Throwable throwable);
-  }
 }