Merge pull request #49 from FrenjaminBanklin/issue/48-lock-in-creator

Adjust 'this person can edit this widget' checks on My Widgets page, locks widget instances in creator.

package.json

@@ -44,7 +44,7 @@
         "statements": 40,
         "branches": 29,
         "functions": 45,
-        "lines": 39
+        "lines": 40
       }
     }
   },

src/js/controllers/ctrl-create.js

@@ -158,11 +158,15 @@ app.controller('createCtrl', function(
 		}
 	}
 
-	const checkUserPublishPerms = () => {
+	const checkUserPublishPerms = widgetData => {
 		const deferred = $q.defer()
 		widgetSrv.canBePublishedByCurrentUser(widget_id).then(canPublish => {
 			$scope.canPublish = canPublish
-			deferred.resolve()
+
+			if (!widgetData.is_draft && !canPublish)
+				deferred.reject('Widget type can not be edited by students after publishing.')
+
+			deferred.resolve(widgetData)
 		})
 		return deferred.promise
 	}
@@ -563,10 +567,11 @@ ${msg.toLowerCase()}`,
 		getQset().then(() => {
 			if (!$scope.invalid) {
 				$q(resolve => resolve(inst_id))
+					.then(widgetSrv.lockWidget)
 					.then(widgetSrv.getWidget)
+					.then(checkUserPublishPerms)
 					.then(embed)
 					.then(initCreator)
-					.then(checkUserPublishPerms)
 					.then(showButtons)
 					.then(startHeartBeat)
 					.catch(onInitFail)
@@ -576,9 +581,9 @@ ${msg.toLowerCase()}`,
 		// initialize a new creator
 		$q(resolve => resolve(widget_id))
 			.then(widgetSrv.getWidgetInfo)
+			.then(checkUserPublishPerms)
 			.then(embed)
 			.then(initCreator)
-			.then(checkUserPublishPerms)
 			.then(showButtons)
 			.then(startHeartBeat)
 			.catch(onInitFail)

src/js/controllers/ctrl-my-widgets.js

@@ -70,7 +70,6 @@ app.controller('MyWidgetsController', function(
 			.all([
 				userServ.get(),
 				selectedWidgetSrv.getUserPermissions(),
-				selectedWidgetSrv.getPublishPermission(),
 				selectedWidgetSrv.getDateRanges()
 			])
 			.then(data => {
@@ -81,7 +80,6 @@ app.controller('MyWidgetsController', function(
 
 				$scope.user = data[0]
 				$scope.perms = data[1]
-				$scope.canPublish = data[2]
 				populateAccess()
 
 				$timeout.cancel(loadScoresTimout)
@@ -137,7 +135,6 @@ app.controller('MyWidgetsController', function(
 		$scope.selected.shareable = false
 		$scope.selected.hasScores = false
 		$scope.perms.collaborators = []
-		$scope.canPublish = false
 
 		// TODO
 		$scope.perms.error = false
@@ -263,7 +260,6 @@ app.controller('MyWidgetsController', function(
 	$scope.perms = {
 		collaborators: []
 	}
-	$scope.canPublish = false
 	$scope.show = {
 		collaborationModal: false,
 		availabilityModal: false,
@@ -272,7 +268,8 @@ app.controller('MyWidgetsController', function(
 		exportModal: false,
 		deleteDialog: false,
 		embedToggle: false,
-		editPublishedWarning: false
+		editPublishedWarning: false,
+		restrictedPublishWarning: false
 	}
 	$scope.SCORE_TAB_GRAPH = 0
 	$scope.SCORE_TAB_INDIVIDUAL = 1

src/js/controllers/ctrl-selectedwidget.js

@@ -54,21 +54,28 @@ app.controller('SelectedWidgetController', function(
 		})
 	}
 
-	const _editWidget = () => {
-		if ($scope.selected.editable) {
-			Materia.Coms.Json.send('widget_instance_lock', [$scope.selected.widget.id]).then(success => {
-				if (success) {
-					if ($scope.selected.widget.is_draft) {
-						window.location = $scope.selected.edit
-					} else {
-						$scope.show.editPublishedWarning = true
-					}
+	const _editWidgetPromise = () => {
+		return Materia.Coms.Json.send('widget_instance_edit_perms_verify', [
+			$scope.selected.widget.id
+		]).then(response => {
+			if (response.is_locked) {
+				$scope.alert.msg =
+					'This widget is currently locked, you will be able to edit this widget when it is no longer being edited by somebody else.'
+			} else {
+				if ($scope.selected.widget.is_draft) {
+					window.location = $scope.selected.edit
 				} else {
-					$scope.alert.msg =
-						'This widget is currently locked, you will be able to edit this widget when it is no longer being edited by somebody else.'
+					if (response.can_publish) $scope.show.editPublishedWarning = true
+					else $scope.show.restrictedPublishWarning = true
 				}
-				Please.$apply()
-			})
+			}
+			Please.$apply()
+		})
+	}
+
+	const _editWidget = () => {
+		if ($scope.selected.editable) {
+			_editWidgetPromise()
 		}
 
 		return false
@@ -225,4 +232,11 @@ app.controller('SelectedWidgetController', function(
 	$scope.enableOlderScores = _enableOlderScores
 
 	$scope.alert = Alert
+
+	/* develblock:start */
+	// these method are exposed for testing
+	$scope.jestTest = {
+		_editWidgetPromise
+	}
+	/* develblock:end */
 })

src/js/controllers/ctrl-selectedwidget.test.js

@@ -34,6 +34,8 @@ describe('adminWidgetController', () => {
 			$on: jest.fn()
 		}
 
+		Namespace('Materia.Coms.Json').send = jest.fn()
+
 		var controller = $controller('SelectedWidgetController', { $scope })
 	})
 
@@ -67,4 +69,35 @@ describe('adminWidgetController', () => {
 		$scope.hideModal.bind(this)()
 		expect(this.$parent.hideModal).toHaveBeenCalled()
 	})
+
+	it('does nothing if a widget is not editable', () => {
+		$scope.selected = {
+			editable: false
+		}
+
+		$scope.editWidget()
+
+		expect(Materia.Coms.Json.send).not.toHaveBeenCalled()
+	})
+
+	it('sets an alert message if the widget is locked already', () => {
+		$scope.selected = {
+			editable: true,
+			widget: {
+				id: 1
+			}
+		}
+
+		Namespace('Materia.Coms.Json').send = jest.fn().mockResolvedValueOnce({
+			is_locked: true,
+			can_publish: true
+		})
+
+		return $scope.jestTest._editWidgetPromise().then(() => {
+			expect(Materia.Coms.Json.send).toHaveBeenCalledWith('widget_instance_edit_perms_verify', [1])
+			expect($scope.alert.msg).toBe(
+				'This widget is currently locked, you will be able to edit this widget when it is no longer being edited by somebody else.'
+			)
+		})
+	})
 })

src/js/services/srv-selectedwidget.js

@@ -76,15 +76,6 @@ app.service('selectedWidgetSrv', function($rootScope, $q, OBJECT_TYPES) {
 		})
 	}
 
-	const getPublishPermission = (widget_id = null) => {
-		if (widget_id === null) widget_id = _widget.widget.id
-		const deferred = $q.defer()
-		Materia.Coms.Json.send('widget_publish_perms_verify', [widget_id]).then(response => {
-			deferred.resolve(response)
-		})
-		return deferred.promise
-	}
-
 	const getPlayLogsForSemester = (term, year) => {
 		const deferred = $q.defer()
 
@@ -227,7 +218,6 @@ app.service('selectedWidgetSrv', function($rootScope, $q, OBJECT_TYPES) {
 		getSelectedId,
 		getScoreSummaries,
 		getUserPermissions,
-		getPublishPermission,
 		getPlayLogsForSemester,
 		getDateRanges,
 		getSemesterFromTimestamp,

src/js/services/srv-widget.js

@@ -53,6 +53,20 @@ app.service('widgetSrv', function(selectedWidgetSrv, dateTimeServ, $q, $rootScop
 		return Materia.Coms.Json.send('widgets_get', [[id]]).then(widgets => widgets[0])
 	}
 
+	const lockWidget = (id = null) => {
+		const deferred = $q.defer()
+		Materia.Coms.Json.send('widget_instance_lock', [id]).then(success => {
+			if (success) {
+				deferred.resolve(id)
+			} else {
+				deferred.reject(
+					'This widget is currently locked, you will be able to edit this widget when it is no longer being edited by somebody else.'
+				)
+			}
+		})
+		return deferred.promise
+	}
+
 	const getWidgetsByType = (type = 'featured') => {
 		return Materia.Coms.Json.send('widgets_get_by_type', [type])
 	}
@@ -234,14 +248,20 @@ app.service('widgetSrv', function(selectedWidgetSrv, dateTimeServ, $q, $rootScop
 	}
 
 	const canBePublishedByCurrentUser = widget_id => {
-		return selectedWidgetSrv.getPublishPermission(widget_id)
+		const deferred = $q.defer()
+		Materia.Coms.Json.send('widget_publish_perms_verify', [widget_id]).then(response => {
+			deferred.resolve(response)
+		})
+
+		return deferred.promise
 	}
 
 	return {
 		getWidgets,
 		getWidgetsByType,
 		getWidget,
 		getWidgetInfo,
+		lockWidget,
 		sortWidgets,
 		saveWidget,
 		removeWidget,

src/js/services/srv-widget.test.js

@@ -63,6 +63,7 @@ describe('widgetSrv', () => {
 		expect(_service.getWidgetsByType).toBeDefined()
 		expect(_service.getWidget).toBeDefined()
 		expect(_service.getWidgetInfo).toBeDefined()
+		expect(_service.lockWidget).toBeDefined()
 		expect(_service.sortWidgets).toBeDefined()
 		expect(_service.saveWidget).toBeDefined()
 		expect(_service.removeWidget).toBeDefined()
@@ -401,4 +402,49 @@ describe('widgetSrv', () => {
 		$scope.$digest() // processes promise
 		expect(_selectedWidgetSrv.notifyAccessDenied).toHaveBeenCalled()
 	})
+
+	it('rejects with a message when a widget is already locked', () => {
+		mockSendPromiseOnce(false)
+
+		let promiseSpy = jest.fn()
+		let promiseCatch = jest.fn()
+		_service
+			.lockWidget(1)
+			.then(promiseSpy)
+			.catch(promiseCatch)
+		$scope.$digest() // processes promise
+
+		expect(Materia.Coms.Json.send).toHaveBeenCalledWith('widget_instance_lock', [1])
+		expect(promiseSpy).not.toHaveBeenCalled()
+		expect(promiseCatch).toHaveBeenCalledWith(
+			'This widget is currently locked, you will be able to edit this widget when it is no longer being edited by somebody else.'
+		)
+	})
+
+	it('locks a widget', () => {
+		mockSendPromiseOnce(true)
+
+		let promiseSpy = jest.fn()
+		let promiseCatch = jest.fn()
+		_service
+			.lockWidget(1)
+			.then(promiseSpy)
+			.catch(promiseCatch)
+		$scope.$digest() // processes promise
+
+		expect(Materia.Coms.Json.send).toHaveBeenCalledWith('widget_instance_lock', [1])
+		expect(promiseSpy).toHaveBeenCalledWith(1)
+		expect(promiseCatch).not.toHaveBeenCalled()
+	})
+
+	it('checks whether a widget can be published by the current user', () => {
+		mockSendPromiseOnce(true)
+
+		let promiseSpy = jest.fn()
+		_service.canBePublishedByCurrentUser(1).then(promiseSpy)
+		$scope.$digest() // processes promise
+
+		expect(Materia.Coms.Json.send).toHaveBeenCalledWith('widget_publish_perms_verify', [1])
+		expect(promiseSpy).toHaveBeenCalledWith(true)
+	})
 })