github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-21 20:47:08 -05:00
Code Issues Projects Releases Packages Wiki Activity

Improve UX of triggering autocompile.

Browse source 
If a user is making infrequent edits (i.e. if reading and making small
changes), then waiting 5 seconds for a recompile is bad. Therefore we track
the time since the last recompile and use this to decide whether a recompile
should be run. This reduces the time to recompile, unless the user is typing
for a significant amount of time.
This commit is contained in:
Alasdair Smith 2017-09-08 10:42:54 +01:00
parent e2523c569e
commit 4a490aafbf
1 changed files with 18 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
services/web/public/coffee/ide/pdf/controllers/PdfController.coffee
View file

@ -6,6 +6,7 @@ define [
"services/log-hints-feedback" "services/log-hints-feedback"
], (App, Ace, HumanReadableLogs, BibLogParser) -> ], (App, Ace, HumanReadableLogs, BibLogParser) ->
AUTO_COMPILE_TIMEOUT = 5000 AUTO_COMPILE_TIMEOUT = 5000
OP_ACKNOWLEDGEMENT_TIMEOUT = 1100
App.controller "PdfController", ($scope, $http, ide, $modal, synctex, event_tracking, logHintsFeedback, localStorage) -> App.controller "PdfController", ($scope, $http, ide, $modal, synctex, event_tracking, logHintsFeedback, localStorage) ->
# enable per-user containers by default # enable per-user containers by default
@ -74,14 +75,26 @@ define [
$scope.pdf.view = 'errors' $scope.pdf.view = 'errors'
$scope.pdf.renderingError = true $scope.pdf.renderingError = true
autoCompileTimeout = null
triggerAutoCompile = () -> triggerAutoCompile = () ->
if (!ide.$scope.hasLintingError) return if autoCompileTimeout
$scope.recompile(isBackgroundAutoCompile: true)
timeSinceLastCompile = Date.now() - $scope.recompiledAt
if timeSinceLastCompile >= AUTO_COMPILE_TIMEOUT
if (!ide.$scope.hasLintingError)
$scope.recompile(isBackgroundAutoCompile: true)
else
# Extend remainder of timeout
autoCompileTimeout = setTimeout () ->
autoCompileTimeout = null
triggerAutoCompile()
, AUTO_COMPILE_TIMEOUT - timeSinceLastCompile
autoCompileListener = null autoCompileListener = null
toggleAutoCompile = (enabling) -> toggleAutoCompile = (enabling) ->
if enabling if enabling
autoCompileListener = ide.$scope.$on "ide:opAcknowledged", _.debounce(triggerAutoCompile, AUTO_COMPILE_TIMEOUT) autoCompileListener = ide.$scope.$on "ide:opAcknowledged", _.debounce(triggerAutoCompile, OP_ACKNOWLEDGEMENT_TIMEOUT)
else else
autoCompileListener() if autoCompileListener autoCompileListener() if autoCompileListener
autoCompileListener = null autoCompileListener = null
@ -422,6 +435,8 @@ define [
$scope.pdf.renderingError = false $scope.pdf.renderingError = false
$scope.pdf.error = true $scope.pdf.error = true
$scope.pdf.view = 'errors' $scope.pdf.view = 'errors'
.finally () ->
$scope.recompiledAt = Date.now()
# This needs to be public. # This needs to be public.
ide.$scope.recompile = $scope.recompile ide.$scope.recompile = $scope.recompile