From 029e3b155738ca07925b752a1c22eea0729a13b8 Mon Sep 17 00:00:00 2001
From: Brian Gough <bjg@network-theory.co.uk>
Date: Mon, 20 Nov 2017 12:25:09 +0000
Subject: [PATCH] fix the cancellation of spelling requests

---
 .../ide/editor/directives/aceEditor.coffee      |  4 ++--
 .../spell-check/SpellCheckManager.coffee        | 17 ++++++++++++-----
 2 files changed, 14 insertions(+), 7 deletions(-)

diff --git a/services/web/public/coffee/ide/editor/directives/aceEditor.coffee b/services/web/public/coffee/ide/editor/directives/aceEditor.coffee
index 577a3a0e75..2b805ef996 100644
--- a/services/web/public/coffee/ide/editor/directives/aceEditor.coffee
+++ b/services/web/public/coffee/ide/editor/directives/aceEditor.coffee
@@ -35,7 +35,7 @@ define [
 			url = ace.config._moduleUrl(args...) + "?fingerprint=#{window.aceFingerprint}"
 			return url
 
-	App.directive "aceEditor", ($timeout, $compile, $rootScope, event_tracking, localStorage, $cacheFactory, labels, graphics, preamble, $http) ->
+	App.directive "aceEditor", ($timeout, $compile, $rootScope, event_tracking, localStorage, $cacheFactory, labels, graphics, preamble, $http, $q) ->
 		monkeyPatchSearch($rootScope, $compile)
 
 		return  {
@@ -97,7 +97,7 @@ define [
 
 				if scope.spellCheck # only enable spellcheck when explicitly required
 					spellCheckCache =  $cacheFactory("spellCheck-#{scope.name}", {capacity: 1000})
-					spellCheckManager = new SpellCheckManager(scope, editor, element, spellCheckCache, $http)
+					spellCheckManager = new SpellCheckManager(scope, editor, element, spellCheckCache, $http, $q)
 				undoManager           = new UndoManager(scope, editor, element)
 				highlightsManager     = new HighlightsManager(scope, editor, element)
 				cursorPositionManager = new CursorPositionManager(scope, editor, element, localStorage)
diff --git a/services/web/public/coffee/ide/editor/directives/aceEditor/spell-check/SpellCheckManager.coffee b/services/web/public/coffee/ide/editor/directives/aceEditor/spell-check/SpellCheckManager.coffee
index 5d420a29b4..acbd636531 100644
--- a/services/web/public/coffee/ide/editor/directives/aceEditor/spell-check/SpellCheckManager.coffee
+++ b/services/web/public/coffee/ide/editor/directives/aceEditor/spell-check/SpellCheckManager.coffee
@@ -5,9 +5,9 @@ define [
 	Range = ace.require("ace/range").Range
 
 	class SpellCheckManager
-		constructor: (@$scope, @editor, @element, @cache, @$http) ->
+		constructor: (@$scope, @editor, @element, @cache, @$http, @$q) ->
 			$(document.body).append @element.find(".spell-check-menu")
-			
+			@inProgressRequest = null
 			@updatedLines = []
 			@highlightedWordManager = new HighlightedWordManager(@editor)
 
@@ -23,8 +23,8 @@ define [
 
 			@editor.on "changeSession", (e) =>
 				@highlightedWordManager.reset()
-				# if @inProgressRequest?
-				# 	@inProgressRequest.abort()
+				if @inProgressRequest?
+					@inProgressRequest.abort()
 
 				if @$scope.spellCheckEnabled and @$scope.spellCheckLanguage and @$scope.spellCheckLanguage != ""
 					@runSpellCheckSoon(200)
@@ -235,11 +235,18 @@ define [
 		apiRequest: (endpoint, data, callback = (error, result) ->)->
 			data.token = window.user.id
 			data._csrf = window.csrfToken
-			@$http.post("/spelling" + endpoint, data)
+			# use angular timeout option to cancel request if doc is changed
+			requestHandler = @$q.defer()
+			options = {timeout: requestHandler.promise}
+			httpRequest = @$http.post("/spelling" + endpoint, data, options)
 			.then (response) =>
 				callback(null, response.data)
 			.catch (response) =>
 				callback(new Error('api failure'))
+			# provide a method to cancel the request
+			abortRequest = () ->
+				requestHandler.resolve()
+			return { abort: abortRequest }
 
 		blacklistedCommandRegex: ///
 			\\                    # initial backslash