assets: resolve missing asset as 404 fix #1105

Author: jknack

doc/routes.md

@@ -241,6 +241,17 @@ assets.cdn = "http://d7471vfo50fqt.cloudfront.net"
 A ```GET``` to ```/assets/js/index.js``` will be redirected to: ```http://d7471vfo50fqt.cloudfront.net/assets/js/index.js```
 
 
+All these assets features are controlled globally from `.conf` file or individually:
+
+```java
+{
+  assets("/assets/**")
+    .etag(true)
+    .cdn("http://d7471vfo50fqt.cloudfront.net")
+    .maxAge("365d");
+}
+```
+
 ### assets module
 
 There is also a powerful and all-round awesome [assets](/doc/assets) module. This module can validate, concatenate, minify or compress JavaScript and CSS assets.

jooby/src/main/java/org/jooby/Jooby.java

@@ -1922,22 +1922,19 @@ private Route.Filter filter(final Class<? extends Route.Filter> filter) {
   }
 
   @Override
-  public Definition assets(final String path, final Path basedir) {
-    AssetHandler handler = new AssetHandler(basedir);
-    configureAssetHandler(handler);
-    return assets(path, handler);
+  public Route.AssetDefinition assets(final String path, final Path basedir) {
+    return assets(path, new AssetHandler(basedir));
   }
 
   @Override
-  public Route.Definition assets(final String path, final String location) {
-    AssetHandler handler = new AssetHandler(location);
-    configureAssetHandler(handler);
-    return assets(path, handler);
+  public Route.AssetDefinition assets(final String path, final String location) {
+    return assets(path, new AssetHandler(location));
   }
 
   @Override
-  public Route.Definition assets(final String path, final AssetHandler handler) {
-    return appendDefinition(GET, path, handler);
+  public Route.AssetDefinition assets(final String path, final AssetHandler handler) {
+    Route.AssetDefinition route = appendDefinition(GET, path, handler, Route.AssetDefinition::new);
+    return configureAssetHandler(route);
   }
 
   @Override
@@ -1963,9 +1960,22 @@ public Route.Collection use(final String path, final Class<?> routeClass) {
    * @return The same route definition.
    */
   private Route.Definition appendDefinition(String method, String pattern, Route.Filter filter) {
+    return appendDefinition(method, pattern, filter, Route.Definition::new);
+  }
+
+  /**
+   * Keep track of routes in the order user define them.
+   *
+   * @param method Route method.
+   * @param pattern Route pattern.
+   * @param filter Route filter.
+   * @param creator Route creator.
+   * @return The same route definition.
+   */
+  private <T extends Route.Definition> T appendDefinition(String method, String pattern,
+      Route.Filter filter, Throwing.Function4<String, String, Route.Filter, Boolean, T> creator) {
     String pathPattern = prefixPath(pattern).orElse(pattern);
-    Route.Definition route = new Route.Definition(method, pathPattern, filter,
-        caseSensitiveRouting);
+    T route = creator.apply(method, pathPattern, filter, caseSensitiveRouting);
     if (prefix != null) {
       route.prefix = prefix;
       // reset name will update the name if prefix != null
@@ -3493,7 +3503,7 @@ private static Logger logger(final Jooby app) {
     return LoggerFactory.getLogger(app.getClass());
   }
 
-  public void configureAssetHandler(final AssetHandler handler) {
+  private Route.AssetDefinition configureAssetHandler(final Route.AssetDefinition handler) {
     onStart(r -> {
       Config conf = r.require(Config.class);
       handler
@@ -3502,6 +3512,7 @@ public void configureAssetHandler(final AssetHandler handler) {
           .etag(conf.getBoolean("assets.etag"))
           .maxAge(conf.getString("assets.cache.maxAge"));
     });
+    return handler;
   }
 
   /**

jooby/src/main/java/org/jooby/Route.java

@@ -213,17 +213,19 @@
 import com.google.inject.Key;
 import com.google.inject.TypeLiteral;
 import static java.util.Objects.requireNonNull;
+import org.jooby.funzy.Throwing;
+import org.jooby.handlers.AssetHandler;
 import org.jooby.internal.RouteImpl;
 import org.jooby.internal.RouteMatcher;
 import org.jooby.internal.RoutePattern;
 import org.jooby.internal.RouteSourceImpl;
 import org.jooby.internal.SourceProvider;
-import org.jooby.funzy.Throwing;
 
 import javax.annotation.Nonnull;
 import javax.annotation.Nullable;
 import java.lang.reflect.Array;
 import java.lang.reflect.Method;
+import java.time.Duration;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collections;
@@ -2050,7 +2052,136 @@ public interface Filter {
      * @throws Throwable If something goes wrong.
      */
     void handle(Request req, Response rsp, Route.Chain chain) throws Throwable;
+  }
+
+  /**
+   * Allow to customize an asset handler.
+   *
+   * @author edgar
+   */
+  class AssetDefinition extends Definition {
+
+    private Boolean etag;
+
+    private String cdn;
+
+    private Object maxAge;
+
+    private Boolean lastModifiedSince;
+
+    private Integer statusCode;
+
+    /**
+     * Creates a new route definition.
+     *
+     * @param method A HTTP verb or <code>*</code>.
+     * @param pattern A path pattern.
+     * @param handler A callback to execute.
+     * @param caseSensitiveRouting Configure case for routing algorithm.
+     */
+    public AssetDefinition(final String method, final String pattern,
+        final Route.Filter handler, boolean caseSensitiveRouting) {
+      super(method, pattern, handler, caseSensitiveRouting);
+    }
+
+    @Nonnull
+    @Override
+    public AssetHandler filter() {
+      return (AssetHandler) super.filter();
+    }
+
+    /**
+     * Indicates what to do when an asset is missing (not resolved). Default action is to resolve them
+     * as <code>404 (NOT FOUND)</code> request.
+     *
+     * If you specify a status code <= 0, missing assets are ignored and the next handler on pipeline
+     * will be executed.
+     *
+     * @param statusCode HTTP code or 0.
+     * @return This route definition.
+     */
+    public AssetDefinition onMissing(final int statusCode) {
+      if (this.statusCode == null) {
+        filter().onMissing(statusCode);
+        this.statusCode = statusCode;
+      }
+      return this;
+    }
+
+    /**
+     * @param etag Turn on/off etag support.
+     * @return This route definition.
+     */
+    public AssetDefinition etag(final boolean etag) {
+      if (this.etag == null) {
+        filter().etag(etag);
+        this.etag = etag;
+      }
+      return this;
+    }
+
+    /**
+     * @param enabled Turn on/off last modified support.
+     * @return This route definition.
+     */
+    public AssetDefinition lastModified(final boolean enabled) {
+      if (this.lastModifiedSince == null) {
+        filter().lastModified(enabled);
+        this.lastModifiedSince = enabled;
+      }
+      return this;
+    }
 
+    /**
+     * @param cdn If set, every resolved asset will be serve from it.
+     * @return This route definition.
+     */
+    public AssetDefinition cdn(final String cdn) {
+      if (this.cdn == null) {
+        filter().cdn(cdn);
+        this.cdn = cdn;
+      }
+      return this;
+    }
+
+    /**
+     * @param maxAge Set the cache header max-age value.
+     * @return This route definition.
+     */
+    public AssetDefinition maxAge(final Duration maxAge) {
+      if (this.maxAge == null) {
+        filter().maxAge(maxAge);
+        this.maxAge = maxAge;
+      }
+      return this;
+    }
+
+    /**
+     * @param maxAge Set the cache header max-age value in seconds.
+     * @return This route definition.
+     */
+    public AssetDefinition maxAge(final long maxAge) {
+      if (this.maxAge == null) {
+        filter().maxAge(maxAge);
+        this.maxAge = maxAge;
+      }
+      return this;
+    }
+
+    /**
+     * Parse value as {@link Duration}. If the value is already a number then it uses as seconds.
+     * Otherwise, it parse expressions like: 8m, 1h, 365d, etc...
+     *
+     * @param maxAge Set the cache header max-age value in seconds.
+     * @return This route definition.
+     */
+    public AssetDefinition maxAge(final String maxAge) {
+      if (this.maxAge == null) {
+        filter().maxAge(maxAge);
+        this.maxAge = maxAge;
+      }
+      return this;
+    }
   }
 
   /**

jooby/src/main/java/org/jooby/Router.java

@@ -203,24 +203,20 @@
  */
 package org.jooby;
 
+import org.jooby.Route.Mapper;
+import org.jooby.funzy.Try;
+import org.jooby.handlers.AssetHandler;
+
+import javax.annotation.Nonnull;
 import java.net.URLDecoder;
 import java.nio.file.Path;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.List;
 import java.util.Optional;
 import java.util.concurrent.Executor;
-import java.util.function.Consumer;
 import java.util.function.Predicate;
 
-import com.google.common.escape.Escaper;
-import com.google.common.net.PercentEscaper;
-import org.jooby.Route.Mapper;
-import org.jooby.funzy.Try;
-import org.jooby.handlers.AssetHandler;
-
-import javax.annotation.Nonnull;
-
 /**
  * Route DSL. Constructs and creates several flavors of jooby routes.
  *
@@ -2009,7 +2005,7 @@ default Route.Definition delete(Route.ZeroArgHandler handler) {
    * @return A new route definition.
    */
   @Nonnull
-  default Route.Definition assets(final String path) {
+  default Route.AssetDefinition assets(final String path) {
     return assets(path, "/");
   }
 
@@ -2043,7 +2039,7 @@ default Route.Definition assets(final String path) {
    * @return A new route definition.
    */
   @Nonnull
-  Route.Definition assets(final String path, Path basedir);
+  Route.AssetDefinition assets(final String path, Path basedir);
 
   /**
    * Static files handler. Like {@link #assets(String)} but let you specify a different classpath
@@ -2089,7 +2085,7 @@ default Route.Definition assets(final String path) {
    * @return A new route definition.
    */
   @Nonnull
-  Route.Definition assets(String path, String location);
+  Route.AssetDefinition assets(String path, String location);
 
   /**
    * Send static files, like {@link #assets(String)} but let you specify a custom
@@ -2100,7 +2096,7 @@ default Route.Definition assets(final String path) {
    * @return A new route definition.
    */
   @Nonnull
-  Route.Definition assets(String path, AssetHandler handler);
+  Route.AssetDefinition assets(String path, AssetHandler handler);
 
   /**
    * <p>

jooby/src/main/java/org/jooby/handlers/AssetHandler.java

@@ -208,6 +208,7 @@
 import com.typesafe.config.ConfigValueFactory;
 import static java.util.Objects.requireNonNull;
 import org.jooby.Asset;
+import org.jooby.Err;
 import org.jooby.Jooby;
 import org.jooby.MediaType;
 import org.jooby.Request;
@@ -284,6 +285,8 @@ private interface Loader {
 
   private boolean lastModified = true;
 
+  private int statusCode = 404;
+
   /**
    * <p>
    * Creates a new {@link AssetHandler}. The handler accepts a location pattern, that serve for
@@ -436,6 +439,21 @@ public AssetHandler maxAge(final String maxAge) {
     return this;
   }
 
+  /**
+   * Indicates what to do when an asset is missing (not resolved). Default action is to resolve them
+   * as <code>404 (NOT FOUND)</code> request.
+   *
+   * If you specify a status code <= 0, missing assets are ignored and the next handler on pipeline
+   * will be executed.
+   *
+   * @param statusCode HTTP code or 0.
+   * @return This handler.
+   */
+  public AssetHandler onMissing(final int statusCode) {
+    this.statusCode = statusCode;
+    return this;
+  }
+
   @Override
   public void handle(final Request req, final Response rsp) throws Throwable {
     String path = req.path();
@@ -461,6 +479,8 @@ public void handle(final Request req, final Response rsp) throws Throwable {
           doHandle(req, rsp, asset);
         }
       }
+    } else if (statusCode > 0) {
+      throw new Err(statusCode);
     }
   }
 

modules/coverage-report/src/test/java/org/jooby/AssetResolveNextFeature.java

@@ -6,7 +6,8 @@
 public class AssetResolveNextFeature extends ServerFeature {
 
   {
-    assets("/assets/**", "/");
+    assets("/assets/**", "/")
+        .onMissing(0);
 
     assets("/assets/js/*-*.js", "/META-INF/resources/webjars/{0}/{1}/{0}.js");
   }