Add support for query strings

Author: jotto

README.md

@@ -134,7 +134,6 @@ You can also sign into AWS and go to CloudFormation and manually remove things.
     * We're waiting for the Lambda@Edge to add a feature to address this
 3. Redirects (301/302 status codes)
     * if you use `<meta name="prerender-status-code" content="301">` to initiate a redirect, your CloudFront TTL must be zero, otherwise CloudFront will cache the body/response and return status code 200 with the body from the redirected path
-4. No support for query strings yet
 
 ## Troubleshooting
 

lib/ViewerRequestInterface.js

@@ -12,6 +12,10 @@ module.exports = class ViewerRequestInterface {
   }
   constructor(cloudFrontRequest, callback) {
     this.cloudFrontRequest = cloudFrontRequest;
+    const querystring = this.cloudFrontRequest.querystring
+      ? `?${this.cloudFrontRequest.querystring}`
+      : "";
+    this.originalUrl = this.cloudFrontRequest.uri + querystring;
     this.callback = callback;
     this.headers = {};
   }
@@ -20,7 +24,7 @@ module.exports = class ViewerRequestInterface {
     const req = {
       method: this.cloudFrontRequest.method,
       originalUrl: this.cloudFrontRequest.uri,
-      url: this.cloudFrontRequest.uri,
+      url: this.originalUrl,
       headers: {
         host: util.getHeader(this.cloudFrontRequest, "host"),
         "user-agent": util.getHeader(this.cloudFrontRequest, "user-agent")
@@ -52,12 +56,9 @@ module.exports = class ViewerRequestInterface {
           }
         ];
 
-        this.cloudFrontRequest.uri = util.createUri(
-          this.cloudFrontRequest.uri,
-          true
-        );
+        this.cloudFrontRequest.uri = util.createUri(this.originalUrl, true);
 
-        console.log({shouldPrerender: true, uri: this.cloudFrontRequest.uri});
+        console.log({ shouldPrerender: true, uri: this.originalUrl });
 
         this.callback(null, this.cloudFrontRequest);
       },
@@ -70,18 +71,20 @@ module.exports = class ViewerRequestInterface {
   createNext() {
     return () => {
       if (util.isHtml(this.cloudFrontRequest.uri)) {
-        console.log({rewriteToIndexHtml: true});
+        console.log({ rewriteToIndexHtml: true });
         this.cloudFrontRequest.uri = "/index.html";
       } else {
-        console.log({rewriteToIndexHtml: false});
+        console.log({ rewriteToIndexHtml: false });
       }
 
+      // the URI will not include query string when not pre-rendering
+      // (because if not pre-rendering, we don't want to mutate the URI field)
       this.cloudFrontRequest.uri = util.createUri(
         this.cloudFrontRequest.uri,
         false
       );
 
-      console.log({shouldPrerender: false, uri: this.cloudFrontRequest.uri});
+      console.log({ shouldPrerender: false, uri: this.cloudFrontRequest.uri });
       this.callback(null, this.cloudFrontRequest);
     };
   }

spec/viewerRequestSpec.js

@@ -3,7 +3,8 @@ const nock = require("nock");
 
 const util = require("../lib/util");
 
-const createUriShouldPrerender = uri => util.createUri(uri, true);
+const createUriShouldPrerender = (uri, querystring) =>
+  util.createUri(uri + (querystring ? `?${querystring}` : ""), true);
 const createUriShouldNotPrerender = uri => util.createUri(uri, false);
 
 describe("viewerRequest", function() {
@@ -20,16 +21,19 @@ describe("viewerRequest", function() {
     });
   }
 
-  function withUserAgentAndUri(userAgent, uri) {
+  function withUserAgentAndUri(userAgent, uri, querystring) {
     beforeEach(function() {
       this.event.Records[0].cf.request.uri = uri;
       this.event.Records[0].cf.request.headers[
         "user-agent"
       ][0].value = userAgent;
+      if (querystring) {
+        this.event.Records[0].cf.request.querystring = querystring;
+      }
     });
   }
 
-  function itPrerenders(userAgent, uri) {
+  function itPrerenders(userAgent, uri, querystring) {
     it("modifies request object with base64 encoded JSON string that has path and user-agent", function() {
       expect(this.cb).toHaveBeenCalledWith(null, {
         headers: {
@@ -40,21 +44,23 @@ describe("viewerRequest", function() {
           ]
         },
         clientIp: "2001:cdba::3257:9652",
-        uri: createUriShouldPrerender(uri),
+        uri: createUriShouldPrerender(uri, querystring),
+        querystring: querystring || "",
         method: "GET"
       });
     });
   }
 
-  function itDoesNotPrerender(userAgent, uri) {
+  function itDoesNotPrerender(userAgent, uri, querystring) {
     it("modifies request object with base64 encoded JSON string that has path and user-agent", function() {
       expect(this.cb).toHaveBeenCalledWith(null, {
         headers: {
           host: [{ value: "d123.cf.net", key: "Host" }],
           "user-agent": [{ value: userAgent, key: "User-Agent" }]
         },
         clientIp: "2001:cdba::3257:9652",
-        uri: createUriShouldNotPrerender(uri),
+        uri: createUriShouldNotPrerender(uri), // the URI will not include query string when not pre-rendering
+        querystring: querystring || "",
         method: "GET"
       });
     });
@@ -83,7 +89,8 @@ describe("viewerRequest", function() {
               },
               clientIp: "2001:cdba::3257:9652",
               uri: "/index.html",
-              method: "GET"
+              method: "GET",
+              querystring: ""
             }
           }
         }
@@ -113,6 +120,12 @@ describe("viewerRequest", function() {
 
           itPrerenders("curl", "/index/");
         });
+        describe("with query string", function() {
+          withUserAgentAndUri("curl", "/index.html", "a=b&c=d");
+          runHandlerWithViewerRequestEvent();
+
+          itPrerenders("curl", "/index.html", "a=b&c=d");
+        });
       });
       describe("non html files", function() {
         withUserAgentAndUri("curl", "/app.js");
@@ -143,6 +156,20 @@ describe("viewerRequest", function() {
 
           itDoesNotPrerender("prerendercloud random-suffix", "/index.html");
         });
+        describe("with query string", function() {
+          withUserAgentAndUri(
+            "prerendercloud random-suffix",
+            "/index/",
+            "a=b&c=d"
+          );
+          runHandlerWithViewerRequestEvent();
+
+          itDoesNotPrerender(
+            "prerendercloud random-suffix",
+            "/index.html",
+            "a=b&c=d"
+          );
+        });
       });
 
       // even though shouldPrerender is false, the uri is not HTML so it preserves uri for cache-key