Delay calling pushState() until the xhr succeeds. Fixes #319

Author: AlexHill

jquery.pjax.js

@@ -221,7 +221,7 @@ function pjax(options) {
 
     var allowed = fire('pjax:error', [xhr, textStatus, errorThrown, options])
     if (options.type == 'GET' && textStatus !== 'abort' && allowed) {
-      locationReplace(container.url)
+      hardLoad(container.url)
     }
   }
 
@@ -238,16 +238,17 @@ function pjax(options) {
 
     // If there is a layout version mismatch, hard load the new url
     if (currentVersion && latestVersion && currentVersion !== latestVersion) {
-      locationReplace(container.url)
+      hardLoad(container.url)
       return
     }
 
     // If the new response is missing a body, hard load the page
     if (!container.contents) {
-      locationReplace(container.url)
+      hardLoad(container.url)
       return
     }
 
+    // Update browser location and history
     pjax.state = {
       id: options.id || uniqueId(),
       url: container.url,
@@ -257,7 +258,9 @@ function pjax(options) {
       timeout: options.timeout
     }
 
-    if (options.push || options.replace) {
+    if (options.push) {
+      window.history.pushState(pjax.state, container.title, container.url)
+    } else if (options.replace) {
       window.history.replaceState(pjax.state, container.title, container.url)
     }
 
@@ -335,8 +338,6 @@ function pjax(options) {
     if (options.push && !options.replace) {
       // Cache current container element before replacing it
       cachePush(pjax.state.id, context.clone().contents())
-
-      window.history.pushState(null, "", stripPjaxParam(options.requestUrl))
     }
 
     fire('pjax:start', [xhr, options])
@@ -360,15 +361,20 @@ function pjaxReload(container, options) {
   return pjax($.extend(defaults, optionsFor(container, options)))
 }
 
-// Internal: Hard replace current state with url.
-//
-// Work for around WebKit
-//   https://bugs.webkit.org/show_bug.cgi?id=93506
+// Internal: Hard load a URL, optionally replacing the current
+// history instead of adding a new history item. Used to load
+// fallbacks, reload layout on version changes, etc.
 //
 // Returns nothing.
-function locationReplace(url) {
-  window.history.replaceState(null, "", "#")
-  window.location.replace(url)
+function hardLoad(url, replace) {
+  if (!!replace) {
+    // Work for around WebKit
+    //   https://bugs.webkit.org/show_bug.cgi?id=93506
+    window.history.replaceState(null, "", "#")
+    window.location.replace(url)
+  } else{
+      window.location.assign(url)
+  }
 }
 
 
@@ -451,7 +457,7 @@ function onPjaxPopstate(event) {
       // scroll position.
       container[0].offsetHeight
     } else {
-      locationReplace(location.href)
+      hardLoad(location.href, true)
     }
   }
   initialPop = false

test/app.rb

@@ -83,6 +83,15 @@ def title(str)
   erb :boom, :layout => !pjax?
 end
 
+get '/referer_timeout.html' do
+  if pjax?
+    sleep 1
+    erb :referer, :layout => false
+  else
+    erb :referer
+  end
+end
+
 get '/:page.html' do
   erb :"#{params[:page]}", :layout => !pjax?
 end

test/unit/pjax.js

@@ -264,10 +264,6 @@ if ($.support.pjax) {
       data: { foo: 1, bar: 2 },
       container: "#main"
     })
-
-    // URL is set immediately
-    equal(frame.location.pathname, "/env.html")
-    equal(frame.location.search, "?foo=1&bar=2")
   })
 
   asyncTest("GET data is merged into query string", function() {
@@ -287,10 +283,6 @@ if ($.support.pjax) {
       data: { bar: 2 },
       container: "#main"
     })
-
-    // URL is set immediately
-    equal(frame.location.pathname, "/env.html")
-    equal(frame.location.search, "?foo=1&bar=2")
   })
 
 
@@ -695,7 +687,7 @@ if ($.support.pjax) {
     var frame = this.frame
 
     frame.$("#main").on("pjax:complete", function() {
-      equal(frame.location.pathname, "/boom.html")
+      equal(frame.location.pathname, "/home.html")
       start()
     })
     frame.$("#main").on("pjax:error", function(event, xhr) {

test/unit/pjax_fallback.js

@@ -99,6 +99,21 @@ asyncTest("sends correct HTTP referer"+s, function() {
   })
 })
 
+asyncTest("sends correct HTTP referer after failed request"+s, function() {
+  var frame = this.frame
+
+  $('iframe')[0].onload = function() {
+    var referer = frame.document.getElementById("referer").textContent
+    ok(referer.match("/home.html"), referer)
+    start()
+  }
+
+  frame.$.pjax({
+    url: "/referer_timeout.html",
+    container: "#main"
+  })
+})
+
 asyncTest("adds entry to browser history"+s, function() {
   var frame = this.frame
   var count = 0