admin: Refactor synchronization status report + display last git error

admin/api/settings.go

@@ -8,7 +8,6 @@ import (
 	"net/http"
 	"os"
 	"path"
-	"reflect"
 	"strconv"
 	"time"
 
@@ -26,7 +25,6 @@ func declareSettingsRoutes(router *gin.RouterGroup) {
 	router.GET("/challenge.json", getChallengeInfo)
 	router.PUT("/challenge.json", saveChallengeInfo)
 
-	router.GET("/settings-ro.json", getROSettings)
 	router.GET("/settings.json", getSettings)
 	router.PUT("/settings.json", saveSettings)
 	router.DELETE("/settings.json", func(c *gin.Context) {
@@ -98,24 +96,6 @@ func fullGeneration(c *gin.Context) {
 	})
 }
 
-func getROSettings(c *gin.Context) {
-	syncMtd := "Disabled"
-	if sync.GlobalImporter != nil {
-		syncMtd = sync.GlobalImporter.Kind()
-	}
-
-	var syncId *string
-	if sync.GlobalImporter != nil {
-		syncId = sync.GlobalImporter.Id()
-	}
-
-	c.JSON(http.StatusOK, gin.H{
-		"sync-type": reflect.TypeOf(sync.GlobalImporter).Name(),
-		"sync-id":   syncId,
-		"sync":      syncMtd,
-	})
-}
-
 func GetChallengeInfo() (*settings.ChallengeInfo, error) {
 	var challengeinfo string
 	var err error

admin/api/sync.go

@@ -7,6 +7,7 @@ import (
 	"net/url"
 	"os"
 	"path"
+	"reflect"
 	"strings"
 
 	"srs.epita.fr/fic-server/admin/generation"
@@ -17,6 +18,8 @@ import (
 	"go.uber.org/multierr"
 )
 
+var lastSyncError = ""
+
 func flatifySyncErrors(errs error) (ret []string) {
 	for _, err := range multierr.Errors(errs) {
 		ret = append(ret, err.Error())
@@ -27,12 +30,37 @@ func flatifySyncErrors(errs error) (ret []string) {
 func declareSyncRoutes(router *gin.RouterGroup) {
 	apiSyncRoutes := router.Group("/sync")
 
+	// Return the global sync status
+	apiSyncRoutes.GET("/status", func(c *gin.Context) {
+		syncMtd := "Disabled"
+		if sync.GlobalImporter != nil {
+			syncMtd = sync.GlobalImporter.Kind()
+		}
+
+		var syncId *string
+		if sync.GlobalImporter != nil {
+			syncId = sync.GlobalImporter.Id()
+		}
+
+		c.JSON(http.StatusOK, gin.H{
+			"sync-type": reflect.TypeOf(sync.GlobalImporter).Name(),
+			"sync-id":   syncId,
+			"sync":      syncMtd,
+			"pullMutex": !sync.OneGitPullStatus(),
+			"syncMutex": !sync.OneDeepSyncStatus() && !sync.OneThemeDeepSyncStatus(),
+			"progress":  sync.DeepSyncProgress,
+			"lastError": lastSyncError,
+		})
+	})
+
 	// Base sync checks if the local directory is in sync with remote one.
 	apiSyncRoutes.POST("/base", func(c *gin.Context) {
 		err := sync.GlobalImporter.Sync()
 		if err != nil {
+			lastSyncError = err.Error()
 			c.JSON(http.StatusExpectationFailed, gin.H{"errmsg": err.Error()})
 		} else {
+			lastSyncError = ""
 			c.JSON(http.StatusOK, true)
 		}
 	})
@@ -45,15 +73,10 @@ func declareSyncRoutes(router *gin.RouterGroup) {
 	})
 
 	// Deep sync: a fully recursive synchronization (can be limited by theme).
-	apiSyncRoutes.GET("/deep", func(c *gin.Context) {
-		if sync.DeepSyncProgress == 0 {
-			c.AbortWithStatusJSON(http.StatusTooEarly, gin.H{"errmsg": "Pas de synchronisation en cours"})
-			return
-		}
-		c.JSON(http.StatusOK, gin.H{"progress": sync.DeepSyncProgress})
-	})
 	apiSyncRoutes.POST("/deep", func(c *gin.Context) {
-		c.JSON(http.StatusOK, sync.SyncDeep(sync.GlobalImporter))
+		r := sync.SyncDeep(sync.GlobalImporter)
+		lastSyncError = ""
+		c.JSON(http.StatusOK, r)
 	})
 
 	apiSyncDeepRoutes := apiSyncRoutes.Group("/deep/:thid")
@@ -66,6 +89,7 @@ func declareSyncRoutes(router *gin.RouterGroup) {
 		}
 		sync.EditDeepReport(&sync.SyncReport{Exercices: st}, false)
 		sync.DeepSyncProgress = 255
+		lastSyncError = ""
 		c.JSON(http.StatusOK, st)
 	})
 	apiSyncDeepRoutes.POST("", func(c *gin.Context) {
@@ -79,6 +103,7 @@ func declareSyncRoutes(router *gin.RouterGroup) {
 		}
 		sync.EditDeepReport(&sync.SyncReport{Themes: map[string][]string{theme.Name: st}}, false)
 		sync.DeepSyncProgress = 255
+		lastSyncError = ""
 		c.JSON(http.StatusOK, st)
 	})
 
@@ -90,6 +115,7 @@ func declareSyncRoutes(router *gin.RouterGroup) {
 
 	apiSyncRoutes.POST("/themes", func(c *gin.Context) {
 		_, errs := sync.SyncThemes(sync.GlobalImporter)
+		lastSyncError = ""
 		c.JSON(http.StatusOK, flatifySyncErrors(errs))
 	})
 

admin/static/js/app.js

@@ -230,9 +230,6 @@ angular.module("FICApp")
 	.factory("File", function ($resource) {
 		return $resource("api/files/:fileId", { fileId: '@id' })
 	})
-	.factory("ROSettings", function ($resource) {
-		return $resource("api/settings-ro.json")
-	})
 	.factory("Settings", function ($resource) {
 		return $resource("api/settings.json", null, {
 			'update': { method: 'PUT' },
@@ -787,9 +784,8 @@ angular.module("FICApp")
 		template: `<span class="badge {{ $ctrl.color }}">{{ $ctrl.status.hash }}</span> <small>{{ $ctrl.status.text }}</small>`
 	})
 
-	.controller("SyncController", function ($scope, $rootScope, ROSettings, $location, $http, $interval) {
+	.controller("SyncController", function ($scope, $rootScope, $location, $http, $interval) {
 		$scope.displayDangerousActions = false;
-		$scope.configro = ROSettings.get();
 
 		var needRefreshSyncReportWhenReady = false;
 		var refreshSyncReport = function () {
@@ -800,30 +796,28 @@ angular.module("FICApp")
 		};
 		refreshSyncReport()
 
+		$scope.deepSyncInProgress = false;
+
 		var progressInterval = $interval(function () {
-			$http.get("api/sync/deep").then(function (response) {
+			$http.get("api/sync/status").then(function (response) {
 				if (response.data.progress && response.data.progress != 255)
 					needRefreshSyncReportWhenReady = true;
 				else if (needRefreshSyncReportWhenReady)
 					refreshSyncReport();
 				if (response.data && response.data.progress) {
 					$scope.syncPercent = Math.floor(response.data.progress * 100 / 255);
-					$scope.syncProgress = Math.floor(response.data.progress * 100 / 255) + " %";
+					$scope.deepSyncInProgress = response.data.pullMutex && response.data.syncMutex;
 				} else {
-					$scope.syncProgress = response.data;
 					$scope.syncPercent = 0;
 				}
+				$scope.syncStatus = response.data;
 			}, function (response) {
 				$scope.syncPercent = 0;
-				if (response.data && response.data.errmsg)
+				$scope.syncStatus = response.data;
-					$scope.syncProgress = response.data.errmsg;
-				else
-					$scope.syncProgress = response.data;
 			})
 		}, 1500);
 		$scope.$on('$destroy', function () { $interval.cancel(progressInterval); });
 
-		$scope.deepSyncInProgress = false;
 		$scope.deepSync = function (theme) {
 			if (theme) {
 				question = 'Faire une synchronisation intégrale du thème ' + theme.name + ' ?'

admin/static/views/sync.html

@@ -32,17 +32,25 @@
   <div class="card-body">
     <dl class="row">
       <dt class="col-2">Type</dt>
-      <dd class="col-10" ng-bind="configro['sync-type']"></dd>
+      <dd class="col-10" ng-bind="syncStatus['sync-type']"></dd>
       <dt class="col-2">Synchronisation</dt>
-      <dd class="col-10" title="{{ configro['sync'] }}" ng-bind="configro.sync"></dd>
+      <dd class="col-10" title="{{ syncStatus['sync'] }}" ng-bind="syncStatus.sync"></dd>
-      <dt class="col-2" ng-if="configro['sync-id']">ID</dt>
+      <dt class="col-2" ng-if="syncStatus['sync-id']">ID</dt>
-      <dd class="col-10" ng-if="configro['sync-id']">{{ configro['sync-id'] }}</dd>
+      <dd class="col-10" ng-if="syncStatus['sync-id']">
-      <dt class="col-2" ng-if="configro['sync']">Statut</dt>
+        {{ syncStatus['sync-id'] }}
-      <dd class="col-10" ng-if="configro['sync']">{{ syncProgress }}</dd>
+        <button ng-if="syncStatus['sync-type'] === 'GitImporter'" type="button" class="btn btn-sm btn-dark" ng-click="baseSync()" ng-disabled="deepSyncInProgress"><span class="glyphicon glyphicon-repeat" aria-hidden="true"></span> Pull</button>
+      </dd>
+      <dt class="col-2" ng-if="syncStatus['sync']">Statut</dt>
+      <dd class="col-10" ng-if="syncStatus['sync']">
+        <span ng-if="(syncStatus.syncMutex !== undefined && syncStatus.syncMutex) || (syncPercent > 0 && syncPercent < 100)">{{ syncPercent }}&nbsp;%</span>
+        <span class="badge badge-pill" ng-class="{'badge-success': !syncStatus.pullMutex, 'badge-danger': syncStatus.pullMutex}" ng-if="syncStatus.pullMutex !== undefined">Pull</span>
+        <span class="badge badge-pill" ng-class="{'badge-success': !syncStatus.syncMutex, 'badge-danger': syncStatus.syncMutex}" ng-if="syncStatus.syncMutex !== undefined">Synchronisation</span>
+      </dd>
     </dl>
 
-    <div class="d-flex justify-content-around" ng-if="configro.sync">
+    <pre style="background: black; color: white;" class="p-2" ng-if="syncStatus.lastError">{{ syncStatus.lastError }}</pre>
-      <button ng-if="configro['sync-type'] === 'GitImporter'" type="button" class="btn btn-info" ng-click="baseSync()" ng-disabled="deepSyncInProgress"><span class="glyphicon glyphicon-repeat" aria-hidden="true"></span> Pull</button>
+
+    <div class="d-flex justify-content-around" ng-if="syncStatus.sync">
       <div class="btn-group dropright">
 	<button type="button" class="btn btn-secondary" ng-click="deepSync()" ng-disabled="deepSyncInProgress"><span class="glyphicon glyphicon-import" aria-hidden="true"></span> Synchronisation intégrale</button>
 	<button type="button" class="btn btn-secondary dropdown-toggle dropdown-toggle-split" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false" ng-disabled="deepSyncInProgress">

admin/sync/full.go

@@ -24,6 +24,22 @@ var oneThemeDeepSync sync.Mutex
 // DeepSyncProgress expose the progression of the depp synchronization (0 = 0%, 255 = 100%).
 var DeepSyncProgress uint8
 
+func OneDeepSyncStatus() bool {
+	if oneDeepSync.TryLock() {
+		oneDeepSync.Unlock()
+		return true
+	}
+	return false
+}
+
+func OneThemeDeepSyncStatus() bool {
+	if oneThemeDeepSync.TryLock() {
+		oneThemeDeepSync.Unlock()
+		return true
+	}
+	return false
+}
+
 type SyncReport struct {
 	DateStart    time.Time           `json:"_started"`
 	DateEnd      time.Time           `json:"_ended"`

admin/sync/importer_git_common.go

@@ -12,6 +12,14 @@ var gitRemoteRe = regexp.MustCompile(`^(?:(?:git@|https://)([\w.@]+)(?:/|:))((?:
 
 var oneGitPull sync.Mutex
 
+func OneGitPullStatus() bool {
+	if oneGitPull.TryLock() {
+		oneGitPull.Unlock()
+		return true
+	}
+	return false
+}
+
 func countFileInDir(dirname string) (int, error) {
 	files, err := os.ReadDir(dirname)
 	if err != nil {