pxt-core 7.3.22 → 7.3.26

package/built/pxt.js

@@ -97885,7 +97885,7 @@ var pxt;
             constructor() {
                 this.initialUserPreferences_ = undefined;
                 this.initialAuthCheck_ = undefined;
-                this.prefPatchOps = [];
+                this.patchQueue = [];
                 pxt.Util.assert(!_client);
                 // Set global instance.
                 _client = this;
@@ -98075,63 +98075,85 @@ var pxt;
                 }
                 return result.success;
             }
-            async patchUserPreferencesAsync(ops, immediate = false) {
-                ops = Array.isArray(ops) ? ops : [ops];
-                ops = ops.filter(op => !!op);
+            async patchUserPreferencesAsync(patchOps, opts = {}) {
+                const defaultSuccessAsync = async () => ({ success: true, res: await this.userPreferencesAsync() });
+                patchOps = Array.isArray(patchOps) ? patchOps : [patchOps];
+                patchOps = patchOps.filter(op => !!op);
+                if (!patchOps.length) {
+                    return await defaultSuccessAsync();
+                }
+                const patchDiff = (pSrc, ops, filter) => {
+                    // Apply patches to pDst and return the diff as a set of new patch ops.
+                    const pDst = pxt.U.deepCopy(pSrc);
+                    ts.pxtc.jsonPatch.patchInPlace(pDst, ops);
+                    let diff = ts.pxtc.jsonPatch.diff(pSrc, pDst);
+                    // Run caller-provided filter
+                    if (diff.length && filter) {
+                        diff = diff.filter(filter);
+                    }
+                    return diff;
+                };
+                // Process incoming patch operations to produce a more fine-grained set of diffs. Incoming patches may be overly destructive
+                // Apply the patch in isolation and get the diff from original
                 const curPref = await this.userPreferencesAsync();
-                if (!ops.length) {
-                    return { success: true, res: curPref };
+                const diff = patchDiff(curPref, patchOps, opts.filter);
+                if (!diff.length) {
+                    return await defaultSuccessAsync();
                 }
-                ts.pxtc.jsonPatch.patchInPlace(curPref, ops);
+                // Apply the new diff to the current state
+                ts.pxtc.jsonPatch.patchInPlace(curPref, diff);
                 await this.setUserPreferencesAsync(curPref);
-                // If we're not logged in, non-persistent local state is all we'll use
+                // If the user is not logged in, non-persistent local state is all we'll use (no sync to cloud)
                 if (!await this.loggedInAsync()) {
-                    return { success: true, res: curPref };
+                    return await defaultSuccessAsync();
                 }
-                // If the user is logged in, save to cloud, but debounce the api call as this can be called frequently from skillmaps
-                // Replace matching patches in the queue
-                ops.forEach((incoming, iIncoming) => {
-                    this.prefPatchOps.some((existing, iExisting) => {
-                        if (!ts.pxtc.jsonPatch.opsAreEqual(existing, incoming))
-                            return false;
-                        // Patches are equivalent, replace in queue
-                        this.prefPatchOps[iExisting] = incoming;
-                        // Clear from incoming so we don't add it below
-                        ops[iIncoming] = null;
-                        return true;
-                    });
-                });
-                // Add remaining ops to the queue
-                ops.filter(op => !!op).forEach(op => this.prefPatchOps.push(op));
+                // If the user is logged in, sync to cloud, but debounce the api call as this can be called frequently from skillmaps
+                // Queue the patch for sync with backend
+                this.patchQueue.push({ ops: patchOps, filter: opts.filter });
                 clearTimeout(debouncePreferencesChangedTimeout);
-                const savePrefs = async () => {
+                const syncPrefs = async () => {
                     debouncePreferencesChangedStarted = 0;
-                    // Clear queued patch ops before send.
-                    const prefPatchOps = this.prefPatchOps;
-                    this.prefPatchOps = [];
-                    const result = await this.apiAsync('/api/user/preferences', prefPatchOps, 'PATCH');
-                    if (result.success) {
-                        pxt.debug("Updating local user preferences w/ cloud data after result of POST");
-                        // Set user profile from returned value so we stay in-sync
-                        this.setUserPreferencesAsync(result.resp);
+                    if (!this.patchQueue.length) {
+                        return await defaultSuccessAsync();
+                    }
+                    // Fetch latest prefs from remote
+                    const getResult = await this.apiAsync('/api/user/preferences');
+                    if (!getResult.success) {
+                        pxt.reportError("identity", "failed to fetch preferences for patch", getResult);
+                        return { success: false, res: undefined };
+                    }
+                    // Apply queued patches to the remote state in isolation and develop a final diff to send to the backend
+                    const remotePrefs = pxt.U.deepCopy(getResult.resp) || auth.DEFAULT_USER_PREFERENCES();
+                    const patchQueue = this.patchQueue;
+                    this.patchQueue = []; // Reset the queue
+                    patchQueue.forEach(patch => {
+                        const diff = patchDiff(remotePrefs, patch.ops, patch.filter);
+                        ts.pxtc.jsonPatch.patchInPlace(remotePrefs, diff);
+                    });
+                    // Diff the original and patched remote states to get a final set of patch operations
+                    const finalOps = pxtc.jsonPatch.diff(getResult.resp, remotePrefs);
+                    const patchResult = await this.apiAsync('/api/user/preferences', finalOps, 'PATCH');
+                    if (patchResult.success) {
+                        // Set user profile from returned value so we stay in sync
+                        this.setUserPreferencesAsync(patchResult.resp);
                     }
                     else {
-                        pxt.reportError("identity", "update preferences failed", result);
+                        pxt.reportError("identity", "failed to patch preferences", patchResult);
                     }
-                    return { success: result.success, res: result.resp };
+                    return { success: patchResult.success, res: patchResult.resp };
                 };
-                if (immediate) {
-                    return await savePrefs();
+                if (opts.immediate) {
+                    return await syncPrefs();
                 }
                 else {
                     if (!debouncePreferencesChangedStarted) {
                         debouncePreferencesChangedStarted = pxt.U.now();
                     }
                     if (PREFERENCES_DEBOUNCE_MAX_MS < pxt.U.now() - debouncePreferencesChangedStarted) {
-                        return await savePrefs();
+                        return await syncPrefs();
                     }
                     else {
-                        debouncePreferencesChangedTimeout = setTimeout(savePrefs, PREFERENCES_DEBOUNCE_MS);
+                        debouncePreferencesChangedTimeout = setTimeout(syncPrefs, PREFERENCES_DEBOUNCE_MS);
                         return { success: false, res: undefined }; // This needs to be implemented correctly to return a promise with the debouncer
                     }
                 }
@@ -99214,6 +99236,18 @@ var ts;
                 return r;
             }
             Util.toSet = toSet;
+            function deepCopy(src) {
+                if (typeof src !== "object" || src === null) {
+                    return src;
+                }
+                const dst = Array.isArray(src) ? [] : {};
+                for (const key in src) {
+                    const value = src[key];
+                    dst[key] = deepCopy(value);
+                }
+                return dst;
+            }
+            Util.deepCopy = deepCopy;
             function toArray(a) {
                 if (Array.isArray(a)) {
                     return a;

package/built/pxtlib.d.ts

@@ -129,8 +129,11 @@ declare namespace pxt.auth {
             username?: string;
             avatarUrl?: string;
         }): Promise<boolean>;
-        private prefPatchOps;
-        patchUserPreferencesAsync(ops: ts.pxtc.jsonPatch.PatchOperation | ts.pxtc.jsonPatch.PatchOperation[], immediate?: boolean): Promise<SetPrefResult>;
+        private patchQueue;
+        patchUserPreferencesAsync(patchOps: ts.pxtc.jsonPatch.PatchOperation | ts.pxtc.jsonPatch.PatchOperation[], opts?: {
+            immediate?: boolean;
+            filter?: (op: ts.pxtc.jsonPatch.PatchOperation) => boolean;
+        }): Promise<SetPrefResult>;
         hasUserId(): boolean;
         private fetchUserAsync;
         private setUserProfileAsync;
@@ -302,6 +305,7 @@ declare namespace ts.pxtc.Util {
     export function groupBy<T>(arr: T[], f: (t: T) => string): pxt.Map<T[]>;
     export function toDictionary<T>(arr: T[], f: (t: T) => string): pxt.Map<T>;
     export function toSet<T>(arr: T[], f: (t: T) => string): pxt.Map<boolean>;
+    export function deepCopy(src: any): any;
     export interface ArrayLike<T> {
         [index: number]: T;
         length: number;

package/built/pxtlib.js

@@ -199,7 +199,7 @@ var pxt;
             constructor() {
                 this.initialUserPreferences_ = undefined;
                 this.initialAuthCheck_ = undefined;
-                this.prefPatchOps = [];
+                this.patchQueue = [];
                 pxt.Util.assert(!_client);
                 // Set global instance.
                 _client = this;
@@ -389,63 +389,85 @@ var pxt;
                 }
                 return result.success;
             }
-            async patchUserPreferencesAsync(ops, immediate = false) {
-                ops = Array.isArray(ops) ? ops : [ops];
-                ops = ops.filter(op => !!op);
+            async patchUserPreferencesAsync(patchOps, opts = {}) {
+                const defaultSuccessAsync = async () => ({ success: true, res: await this.userPreferencesAsync() });
+                patchOps = Array.isArray(patchOps) ? patchOps : [patchOps];
+                patchOps = patchOps.filter(op => !!op);
+                if (!patchOps.length) {
+                    return await defaultSuccessAsync();
+                }
+                const patchDiff = (pSrc, ops, filter) => {
+                    // Apply patches to pDst and return the diff as a set of new patch ops.
+                    const pDst = pxt.U.deepCopy(pSrc);
+                    ts.pxtc.jsonPatch.patchInPlace(pDst, ops);
+                    let diff = ts.pxtc.jsonPatch.diff(pSrc, pDst);
+                    // Run caller-provided filter
+                    if (diff.length && filter) {
+                        diff = diff.filter(filter);
+                    }
+                    return diff;
+                };
+                // Process incoming patch operations to produce a more fine-grained set of diffs. Incoming patches may be overly destructive
+                // Apply the patch in isolation and get the diff from original
                 const curPref = await this.userPreferencesAsync();
-                if (!ops.length) {
-                    return { success: true, res: curPref };
+                const diff = patchDiff(curPref, patchOps, opts.filter);
+                if (!diff.length) {
+                    return await defaultSuccessAsync();
                 }
-                ts.pxtc.jsonPatch.patchInPlace(curPref, ops);
+                // Apply the new diff to the current state
+                ts.pxtc.jsonPatch.patchInPlace(curPref, diff);
                 await this.setUserPreferencesAsync(curPref);
-                // If we're not logged in, non-persistent local state is all we'll use
+                // If the user is not logged in, non-persistent local state is all we'll use (no sync to cloud)
                 if (!await this.loggedInAsync()) {
-                    return { success: true, res: curPref };
+                    return await defaultSuccessAsync();
                 }
-                // If the user is logged in, save to cloud, but debounce the api call as this can be called frequently from skillmaps
-                // Replace matching patches in the queue
-                ops.forEach((incoming, iIncoming) => {
-                    this.prefPatchOps.some((existing, iExisting) => {
-                        if (!ts.pxtc.jsonPatch.opsAreEqual(existing, incoming))
-                            return false;
-                        // Patches are equivalent, replace in queue
-                        this.prefPatchOps[iExisting] = incoming;
-                        // Clear from incoming so we don't add it below
-                        ops[iIncoming] = null;
-                        return true;
-                    });
-                });
-                // Add remaining ops to the queue
-                ops.filter(op => !!op).forEach(op => this.prefPatchOps.push(op));
+                // If the user is logged in, sync to cloud, but debounce the api call as this can be called frequently from skillmaps
+                // Queue the patch for sync with backend
+                this.patchQueue.push({ ops: patchOps, filter: opts.filter });
                 clearTimeout(debouncePreferencesChangedTimeout);
-                const savePrefs = async () => {
+                const syncPrefs = async () => {
                     debouncePreferencesChangedStarted = 0;
-                    // Clear queued patch ops before send.
-                    const prefPatchOps = this.prefPatchOps;
-                    this.prefPatchOps = [];
-                    const result = await this.apiAsync('/api/user/preferences', prefPatchOps, 'PATCH');
-                    if (result.success) {
-                        pxt.debug("Updating local user preferences w/ cloud data after result of POST");
-                        // Set user profile from returned value so we stay in-sync
-                        this.setUserPreferencesAsync(result.resp);
+                    if (!this.patchQueue.length) {
+                        return await defaultSuccessAsync();
+                    }
+                    // Fetch latest prefs from remote
+                    const getResult = await this.apiAsync('/api/user/preferences');
+                    if (!getResult.success) {
+                        pxt.reportError("identity", "failed to fetch preferences for patch", getResult);
+                        return { success: false, res: undefined };
+                    }
+                    // Apply queued patches to the remote state in isolation and develop a final diff to send to the backend
+                    const remotePrefs = pxt.U.deepCopy(getResult.resp) || auth.DEFAULT_USER_PREFERENCES();
+                    const patchQueue = this.patchQueue;
+                    this.patchQueue = []; // Reset the queue
+                    patchQueue.forEach(patch => {
+                        const diff = patchDiff(remotePrefs, patch.ops, patch.filter);
+                        ts.pxtc.jsonPatch.patchInPlace(remotePrefs, diff);
+                    });
+                    // Diff the original and patched remote states to get a final set of patch operations
+                    const finalOps = pxtc.jsonPatch.diff(getResult.resp, remotePrefs);
+                    const patchResult = await this.apiAsync('/api/user/preferences', finalOps, 'PATCH');
+                    if (patchResult.success) {
+                        // Set user profile from returned value so we stay in sync
+                        this.setUserPreferencesAsync(patchResult.resp);
                     }
                     else {
-                        pxt.reportError("identity", "update preferences failed", result);
+                        pxt.reportError("identity", "failed to patch preferences", patchResult);
                     }
-                    return { success: result.success, res: result.resp };
+                    return { success: patchResult.success, res: patchResult.resp };
                 };
-                if (immediate) {
-                    return await savePrefs();
+                if (opts.immediate) {
+                    return await syncPrefs();
                 }
                 else {
                     if (!debouncePreferencesChangedStarted) {
                         debouncePreferencesChangedStarted = pxt.U.now();
                     }
                     if (PREFERENCES_DEBOUNCE_MAX_MS < pxt.U.now() - debouncePreferencesChangedStarted) {
-                        return await savePrefs();
+                        return await syncPrefs();
                     }
                     else {
-                        debouncePreferencesChangedTimeout = setTimeout(savePrefs, PREFERENCES_DEBOUNCE_MS);
+                        debouncePreferencesChangedTimeout = setTimeout(syncPrefs, PREFERENCES_DEBOUNCE_MS);
                         return { success: false, res: undefined }; // This needs to be implemented correctly to return a promise with the debouncer
                     }
                 }
@@ -1528,6 +1550,18 @@ var ts;
                 return r;
             }
             Util.toSet = toSet;
+            function deepCopy(src) {
+                if (typeof src !== "object" || src === null) {
+                    return src;
+                }
+                const dst = Array.isArray(src) ? [] : {};
+                for (const key in src) {
+                    const value = src[key];
+                    dst[key] = deepCopy(value);
+                }
+                return dst;
+            }
+            Util.deepCopy = deepCopy;
             function toArray(a) {
                 if (Array.isArray(a)) {
                     return a;