Merge pull request #148 from OneNoteDev/feature/patch-permission-optimization

Remove unecessary subsequent PATCH permission checks

Author: leakymemory

src/scripts/clipperUI/clipper.tsx

@@ -612,6 +612,7 @@ class ClipperClass extends ComponentBase<ClipperState, {}> {
 			let userInfoReturned = updatedUser && !!updatedUser.user;
 			if (userInfoReturned) {
 				// Sign in succeeded
+				Clipper.storeValue(ClipperStorageKeys.hasPatchPermissions, "true");
 				Clipper.logger.logUserFunnel(Log.Funnel.Label.AuthSignInCompleted);
 			}
 			handleSignInEvent.setCustomProperty(Log.PropertyName.Custom.UserInformationReturned, userInfoReturned);

src/scripts/clipperUI/saveToOneNote.ts

@@ -371,17 +371,28 @@ export class SaveToOneNote {
 		});
 	}
 
-	private static checkIfUserHasPermissionToPatch(): Promise<any> {
-		let patchPermissionCheckEvent = new Log.Event.PromiseEvent(Log.Event.Label.PatchPermissionCheck);
+	private static checkIfUserHasPermissionToPatch(): Promise<void> {
 		return new Promise<any>((resolve, reject) => {
-			SaveToOneNote.getPages({ top: 1, sectionId: this.clipperState.saveLocation }).then((getPagesResponse) => {
-				resolve(getPagesResponse);
-			}, (error) => {
-				patchPermissionCheckEvent.setStatus(Log.Status.Failed);
-				patchPermissionCheckEvent.setFailureInfo({ error: error });
-				reject(error);
-			}).then(() => {
-				Clipper.logger.logEvent(patchPermissionCheckEvent);
+			Clipper.getStoredValue(ClipperStorageKeys.hasPatchPermissions, (hasPermissions) => {
+				// We have checked their permissions successfully in the past, or the user signed in on this device (with the latest scope)
+				if (hasPermissions) {
+					resolve();
+				} else {
+					// As of v3.2.9, we have added a new scope for MSA to allow for PATCHing, however currently-logged-in users will not have
+					// this scope, so this call is a workaround to check for permissions, but is very unperformant. We need to investigate a
+					// quicker way of doing this ... perhaps exposing an endpoint that we can use for this sole purpose.
+					let patchPermissionCheckEvent = new Log.Event.PromiseEvent(Log.Event.Label.PatchPermissionCheck);
+					SaveToOneNote.getPages({ top: 1, sectionId: this.clipperState.saveLocation }).then(() => {
+						Clipper.storeValue(ClipperStorageKeys.hasPatchPermissions, "true");
+						resolve();
+					}, (error) => {
+						patchPermissionCheckEvent.setStatus(Log.Status.Failed);
+						patchPermissionCheckEvent.setFailureInfo({ error: error });
+						reject(error);
+					}).then(() => {
+						Clipper.logger.logEvent(patchPermissionCheckEvent);
+					});
+				}
 			});
 		});
 	}

src/scripts/storage/clipperStorageKeys.ts

@@ -5,6 +5,7 @@ export module ClipperStorageKeys {
 	export var displayLanguageOverride = "displayLocaleOverride";
 	export var doNotPromptRatings = "doNotPromptRatings";
 	export var flightingInfo = "flightingInfo";
+	export var hasPatchPermissions = "hasPatchPermissions";
 	export var lastBadRatingDate = "lastBadRatingDate";
 	export var lastBadRatingVersion = "lastBadRatingVersion";
 	export var lastClippedDate = "lastClippedDate";