Add whitelistQueryParams option

Author: jotto

handler.js

@@ -42,19 +42,26 @@ const resetPrerenderCloud = () => {
   //    that is, you treat /docs/ differently than /docs (trailing slash) which is rare
   // prerendercloud.set("removeTrailingSlash", true);
 
-  // 5. botsOnly
+  // 5. whitelistQueryParams (recommended)
+  //    improves cache hit rate by dropping query params not in the whitelist
+  //    must be a function that returns null or array
+  //    * default (null) preserves all query params
+  //    * empty array drops all query params
+  // prerendercloud.set("whitelistQueryParams", req => ["page"]);
+
+  // 6. botsOnly
   //    generally not recommended due to potential google SEO cloaking penalties no one fully understands
   // prerendercloud.set("botsOnly", true);
 
-  // 6. removeScriptsTag (not recommended)
+  // 7. removeScriptsTag (not recommended)
   //    Removes all scripts/JS, useful if:
   //      - trying to get under 1MB Lambda@Edge limit
   //      - having problems with your JS app taking over from the pre-rendered content
   //    Huge caveat: this also means your app will no longer be a "single-page app" since
   //    all of the JavaScript will be gone
   // prerendercloud.set("removeScriptTags", true);
 
-  // 7. disableServerCache
+  // 8. disableServerCache
   //    Disable the cache on prerender.cloud (default is enabled with 5 minute duration).
   //    It probably makes sense to disable the prerender.cloud server cache
   //    since CloudFront is caching things for you.
@@ -67,7 +74,7 @@ const resetPrerenderCloud = () => {
   //           things down unnecessarily)
   // prerendercloud.set('disableServerCache', true);
 
-  // 8. see all configuration options here: https://github.com/sanfrancesco/prerendercloud-nodejs
+  // 9. see all configuration options here: https://github.com/sanfrancesco/prerendercloud-nodejs
 
   // for tests
   if (prerenderCloudOption) prerenderCloudOption(prerendercloud);

lib/ViewerRequestInterface.js

@@ -23,7 +23,7 @@ module.exports = class ViewerRequestInterface {
   createReq() {
     const req = {
       method: this.cloudFrontRequest.method,
-      originalUrl: this.cloudFrontRequest.uri,
+      originalUrl: this.originalUrl,
       url: this.originalUrl,
       headers: {
         host: util.getHeader(this.cloudFrontRequest, "host"),
@@ -42,27 +42,41 @@ module.exports = class ViewerRequestInterface {
       setHeader: (key, val) => {
         this.headers[key] = val;
       },
-      end: body => {
-        // since the user-agent header will be overwritten with CloudFront
-        // we use this to hint at the real one, but:
-        // 1. it will not affect the cache-key
-        // 2. prerender.cloud will only see it once (after that, the req will be cached in CloudFront)
-        // 3. we don't need this for anything other than the potential for user stats/analytics in prerender.cloud
-        //    (i.e. the user can see the user-agent of the request that triggered the first CloudFront request)
-        this.cloudFrontRequest.headers[util.USER_AGENT_PLACEHOLDER] = [
-          {
-            key: util.USER_AGENT_PLACEHOLDER,
-            value: util.getHeader(this.cloudFrontRequest, "user-agent")
-          }
-        ];
+      writeHead(_status, _headers) {}
+    };
 
-        this.cloudFrontRequest.uri = util.createUri(this.originalUrl, true);
+    res.end = body => {
+      // since the user-agent header will be overwritten with CloudFront
+      // we use this to hint at the real one, but:
+      // 1. it will not affect the cache-key
+      // 2. prerender.cloud will only see it once (after that, the req will be cached in CloudFront)
+      // 3. we don't need this for anything other than the potential for user stats/analytics in prerender.cloud
+      //    (i.e. the user can see the user-agent of the request that triggered the first CloudFront request)
+      this.cloudFrontRequest.headers[util.USER_AGENT_PLACEHOLDER] = [
+        {
+          key: util.USER_AGENT_PLACEHOLDER,
+          value: util.getHeader(this.cloudFrontRequest, "user-agent")
+        }
+      ];
 
-        console.log({ shouldPrerender: true, uri: this.originalUrl });
+      const origCloudFrontUri = this.cloudFrontRequest.uri;
 
-        this.callback(null, this.cloudFrontRequest);
-      },
-      writeHead(_status, _headers) {}
+      // res.prerender.url.requestedPath is set by https://github.com/sanfrancesco/prerendercloud-nodejs
+      // specifically for this Lambda lib - it's the requested path after applying the whitelistQueryParams
+      this.cloudFrontRequest.uri = util.createUri(
+        res.prerender.url.requestedPath,
+        true
+      );
+
+      console.log({
+        shouldPrerender: true,
+        cloudFrontUriAfterEncode: this.cloudFrontRequest.uri,
+        requestedUriAfterWhitelist: res.prerender.url.requestedPath,
+        originalCloudFrontUri: origCloudFrontUri,
+        originalCloudFrontQuerystring: this.cloudFrontRequest.querystring
+      });
+
+      this.callback(null, this.cloudFrontRequest);
     };
 
     res.headers = {};

package.json

@@ -6,6 +6,6 @@
     "serverless": "1.24.1"
   },
   "dependencies": {
-    "prerendercloud": "1.27.0"
+    "prerendercloud": "1.30.1"
   }
 }

yarn.lock

@@ -1300,9 +1300,9 @@ prepend-http@^2.0.0:
   version "2.0.0"
   resolved "https://registry.yarnpkg.com/prepend-http/-/prepend-http-2.0.0.tgz#e92434bfa5ea8c19f41cdfd401d741a3c819d897"
 
-prerendercloud@1.27.0:
-  version "1.27.0"
-  resolved "https://registry.yarnpkg.com/prerendercloud/-/prerendercloud-1.27.0.tgz#992c64a1420aeb20c02b2c19dd740d64a5ad8cff"
+prerendercloud@1.30.1:
+  version "1.30.1"
+  resolved "https://registry.yarnpkg.com/prerendercloud/-/prerendercloud-1.30.1.tgz#2e960a9b3865a588623f49007833be704aa9187d"
   dependencies:
     debug "^2.2.0"
     got-lite "^8.0.1"