[DRAFT] Workspace layer refactor

localtypings/projectheader.d.ts

@@ -28,23 +28,30 @@ declare namespace pxt.workspace {
         tutorialCompleted?: pxt.tutorial.TutorialCompletionInfo;
         // workspace guid of the extension under test
         extensionUnderTest?: string;
-        cloudSync?: boolean; // Mark a header for syncing with a cloud provider
+        // id of cloud user who created this project
+        cloudUserId?: string;
     }
 
     export interface Header extends InstallHeader {
         id: string; // guid (generated by us)
         path?: string; // for workspaces that require it
-        recentUse: number; // seconds since epoch
-        modificationTime: number; // seconds since epoch
+        recentUse: number; // seconds since epoch UTC (cloud safe)
+        modificationTime: number; // seconds since epoch UTC (cloud safe)
         icon?: string; // icon uri
 
         isDeleted: boolean; // mark whether or not a header has been deleted
         saveId?: any; // used to determine whether a project has been edited while we're saving to cloud
+
+        // TODO @darzu: remove all of these?
 
-        // For cloud providers
-        blobId: string;       // id of the cloud blob holding this script
-        blobVersion: string;  // version of the cloud blob
-        blobCurrent: boolean; // has the current version of the script been pushed to cloud
+        // For cloud providers -- DEPRECATED
+        blobId_: string;       // id of the cloud blob holding this script
+        blobVersion_: string;  // version of the cloud blob
+        blobCurrent_: boolean; // has the current version of the script been pushed to cloud
+
+        cloudVersion: string;     // The cloud-assigned version number (e.g. etag)
+        // TODO @darzu: "cloudCurrent" seems very bad. This is a stateful notation and it is hard to reason about whether or not this is true.
+        cloudCurrent: boolean;    // Has the current version of the project been pushed to cloud
 
         // Used for Updating projects
         backupRef?: string; // guid of backed-up project (present if an update was interrupted)

localtypings/pxtpackage.d.ts

@@ -2,6 +2,7 @@ declare namespace pxt {
 
     type CodeCardType = "file" | "example" | "codeExample" | "tutorial" | "side" | "template" | "package" | "hw" | "forumUrl" | "forumExample" | "sharedExample";
     type CodeCardEditorType = "blocks" | "js" | "py";
+    type CodeCardCloudState = "local" | "cloud";
 
     interface Map<T> {
         [index: string]: T;
@@ -159,6 +160,7 @@ declare namespace pxt {
         cardType?: CodeCardType;
         editor?: CodeCardEditorType;
         otherActions?: CodeCardAction[];
+        cloudState?: CodeCardCloudState;
 
         header?: string;
 

pxteditor/editor.ts

@@ -215,12 +215,11 @@ namespace pxt.editor {
         importExampleAsync(options: ExampleImportOptions): Promise<void>;
         showScriptManager(): void;
         importProjectDialog(): void;
-        cloudSync(): boolean;
-        cloudSignInDialog(): void;
-        cloudSignOut(): void;
         removeProject(): void;
         editText(): void;
 
+        hasCloudSync(): boolean;
+
         getPreferredEditor(): string;
         saveAndCompile(): void;
         updateHeaderName(name: string): void;

pxteditor/localStorage.ts

@@ -1,4 +1,5 @@
 namespace pxt.storage {
+    // TODO @darzu: why is this different from the WorkspaceProvider api?
     interface IStorage {
         removeItem(key: string): void;
         getItem(key: string): string;

pxteditor/workspace.ts

@@ -3,6 +3,8 @@
 namespace pxt.workspace {
     export type ScriptText = pxt.Map<string>;
 
+
+    // TODO @darzu: ugh. why is there a "Project" that is different from a "File". They are nearly identical...
     export interface Project {
         header?: Header;
         text?: ScriptText;
@@ -14,17 +16,28 @@ namespace pxt.workspace {
         url: string;
     }
 
+    // TODO @darzu: why is version "any" ? that's really annoying to reason about. used as: string | ScriptText
+    // TODO @darzu: _rev is a string; modificationTime is an int
     export type Version = any;
 
     export interface File {
         header: Header;
         text: ScriptText;
+        // This version field is reserved for the storage mechanism. E.g. PouchDB requires a _rev field containing
+        //  the currently stored version.
         version: Version;
     }
 
     export interface WorkspaceProvider {
-        listAsync(): Promise<Header[]>; // called from workspace.syncAsync (including upon startup)
+        listAsync(): Promise<Header[]>;
+        /*
+        Tries to get the corrisponding File with the current version if it exists.
+        If it does not exist, returns undefined.
+        */
         getAsync(h: Header): Promise<File>;
+        /*
+        If text is empty, then only update the header.
+        */
         setAsync(h: Header, prevVersion: Version, text?: ScriptText): Promise<Version>;
         deleteAsync?: (h: Header, prevVersion: Version) => Promise<void>;
         resetAsync(): Promise<void>;
@@ -54,9 +67,12 @@ namespace pxt.workspace {
             id: U.guidGen(),
             recentUse: modTime,
             modificationTime: modTime,
-            blobId: null,
-            blobVersion: null,
-            blobCurrent: false,
+            blobId_: null,
+            blobVersion_: null,
+            blobCurrent_: false,
+            cloudUserId: null,
+            cloudCurrent: false,
+            cloudVersion: null,
             isDeleted: false,
         }
         return header

pxtlib/util.ts

@@ -1409,6 +1409,10 @@ namespace ts.pxtc.Util {
                 return res
             })
     }
+
+    export function unreachable(...ns: never[]): never {
+        throw new Error("Type error: this code should be unreachable");
+    }
 }
 
 namespace ts.pxtc.BrowserImpl {

webapp/src/app.tsx

@@ -6,8 +6,8 @@
 
 import * as React from "react";
 import * as ReactDOM from "react-dom";
-import * as workspace from "./workspace";
-import * as cloudsync from "./cloudsync";
+import * as workspace from "./workspaces/workspace";
+import * as cloudsync from "./workspaces/cloudsync";
 import * as data from "./data";
 import * as pkg from "./package";
 import * as core from "./core";
@@ -95,7 +95,7 @@ function setEditor(editor: ProjectView) {
 }
 
 export class ProjectView
-    extends data.Component<IAppProps, IAppState>
+    extends auth.Component<IAppProps, IAppState>
     implements IProjectView {
     editor: srceditor.Editor;
     editorFile: pkg.File;
@@ -173,7 +173,6 @@ export class ProjectView
         this.openDeviceSerial = this.openDeviceSerial.bind(this);
         this.toggleGreenScreen = this.toggleGreenScreen.bind(this);
         this.toggleSimulatorFullscreen = this.toggleSimulatorFullscreen.bind(this);
-        this.cloudSignInComplete = this.cloudSignInComplete.bind(this);
         this.toggleSimulatorCollapse = this.toggleSimulatorCollapse.bind(this);
         this.showKeymap = this.showKeymap.bind(this);
         this.toggleKeymap = this.toggleKeymap.bind(this);
@@ -264,8 +263,13 @@ export class ProjectView
             }
             this.saveFileAsync().done();
         } else if (active) {
+            // TODO @darzu: new code path maybe:
+            // workspace.syncAsync().then(changed => this.reloadAsync())
+            // reloadAsync: this.loadHeaderAsync()
+            // OR: subscribe to data api, on change, reload
+
             data.invalidate("header:*")
-            if (workspace.isHeadersSessionOutdated()
+            if (workspace.isHeadersSessionOutdated() // TODO @darzu: sync check point
                 || workspace.isHeaderSessionOutdated(this.state.header)) {
                 pxt.debug('workspace: changed, reloading...')
                 let id = this.state.header ? this.state.header.id : '';
@@ -1300,6 +1304,7 @@ export class ProjectView
             return checkAsync.then(() => this.openHome());
 
         let p = Promise.resolve();
+        // TODO @darzu: sync checkpoint
         if (workspace.isHeadersSessionOutdated()) { // reload header before loading
             pxt.log(`sync before load`)
             p = p.then(() => workspace.syncAsync().then(() => { }))
@@ -1335,7 +1340,11 @@ export class ProjectView
             if (editorState.searchBar === undefined) editorState.searchBar = oldEditorState.searchBar;
         }
 
-        if (!h.cloudSync && this.cloudSync()) h.cloudSync = true;
+        // If user is signed in, sync this project to the cloud.
+        if (this.hasCloudSync()) {
+            // TODO @darzu: this might not be where we want to attach the user to the project
+            h.cloudUserId = this.getUser()?.id;
+        }
 
         return compiler.newProjectAsync()
             .then(() => h.backupRef ? workspace.restoreFromBackupAsync(h) : Promise.resolve())
@@ -1442,6 +1451,7 @@ export class ProjectView
                 }
 
                 // update recentUse on the header
+                // TODO @darzu: this is saving hte project without text...
                 return workspace.saveAsync(h)
             }).then(() => this.loadTutorialFiltersAsync())
             .finally(() => {
@@ -2006,62 +2016,6 @@ export class ProjectView
             })
     }
 
-    ///////////////////////////////////////////////////////////
-    ////////////             Cloud                 ////////////
-    ///////////////////////////////////////////////////////////
-
-    cloudSync() {
-        return this.hasSync();
-    }
-
-    cloudSignInDialog() {
-        const providers = cloudsync.providers();
-        if (providers.length == 0)
-            return;
-        if (providers.length == 1)
-            providers[0].loginAsync().then(() => {
-                this.cloudSignInComplete();
-            })
-        else {
-            // TODO: Revisit in new cloud sync
-            //this.signInDialog.show();
-        }
-    }
-
-    cloudSignOut() {
-        core.confirmAsync({
-            header: lf("Sign out"),
-            body: lf("You are signing out. Make sure that you commited all your changes, local projects will be deleted."),
-            agreeClass: "red",
-            agreeIcon: "sign out",
-            agreeLbl: lf("Sign out"),
-        }).then(r => {
-            if (r) {
-                const inEditor = !!this.state.header;
-                // Reset the cloud workspace
-                return workspace.resetCloudAsync()
-                    .then(() => {
-                        if (inEditor) {
-                            this.openHome();
-                        }
-                        if (this.home) {
-                            this.home.forceUpdate();
-                        }
-                    })
-            }
-            return Promise.resolve();
-        });
-    }
-
-    cloudSignInComplete() {
-        pxt.log('cloud sign in complete');
-        initLogin();
-        cloudsync.syncAsync()
-            .then(() => {
-                this.forceUpdate();
-            }).done();
-    }
-
     ///////////////////////////////////////////////////////////
     ////////////             Home                 /////////////
     ///////////////////////////////////////////////////////////
@@ -2251,7 +2205,7 @@ export class ProjectView
             pubCurrent: false,
             target: pxt.appTarget.id,
             targetVersion: pxt.appTarget.versions.target,
-            cloudSync: this.cloudSync(),
+            cloudUserId: this.getUser()?.id,
             temporary: options.temporary,
             tutorial: options.tutorial,
             extensionUnderTest: options.extensionUnderTest
@@ -3090,6 +3044,10 @@ export class ProjectView
         }
     }
 
+    hasCloudSync() {
+        return this.isLoggedIn();
+    }
+
     showScriptManager() {
         this.scriptManagerDialog.show();
     }
@@ -3327,13 +3285,15 @@ export class ProjectView
     }
 
     showResetDialog() {
+        console.log("showResetDialog (1)")
         dialogs.showResetDialogAsync().done(r => {
             if (!r) return Promise.resolve();
             return Promise.resolve()
                 .then(() => {
                     return pxt.winrt.releaseAllDevicesAsync();
                 })
                 .then(() => {
+                    console.log("showResetDialog (2)")
                     return this.resetWorkspace();
                 });
         });
@@ -4540,12 +4500,19 @@ document.addEventListener("DOMContentLoaded", () => {
     const isSandbox = pxt.shell.isSandboxMode() || pxt.shell.isReadOnly();
     const isController = pxt.shell.isControllerMode();
     const theme = pxt.appTarget.appTheme;
-    if (query["ws"]) workspace.setupWorkspace(query["ws"]);
+    // TODO @darzu: this is bad. we shouldn't be choosing a workspace in two places (see "chooseWorkspace")
+    if (query["ws"]) {
+        workspace.setupWorkspace(query["ws"] as workspace.WorkspaceKind)
+    }
     else if ((theme.allowParentController || isController) && pxt.BrowserUtils.isIFrame()) workspace.setupWorkspace("iframe");
     else if (isSandbox) workspace.setupWorkspace("mem");
     else if (pxt.winrt.isWinRT()) workspace.setupWorkspace("uwp");
     else if (pxt.BrowserUtils.isIpcRenderer()) workspace.setupWorkspace("idb");
-    else if (pxt.BrowserUtils.isLocalHost() || pxt.BrowserUtils.isPxtElectron()) workspace.setupWorkspace("fs");
+    // TODO @darzu: uncomment. this disables filesystem workspace
+    //else if (pxt.BrowserUtils.isLocalHost() || pxt.BrowserUtils.isPxtElectron()) workspace.setupWorkspace("fs");
+    else {
+        workspace.setupWorkspace("browser");
+    }
     Promise.resolve()
         .then(async () => {
             const href = window.location.href;

webapp/src/auth.ts

@@ -465,12 +465,18 @@ export async function initialUserPreferences(): Promise<UserPreferences | undefi
     return initialUserPreferences_;
 }
 
-function loggedInSync(): boolean {
+export function loggedInSync(): boolean {
     if (!hasIdentity()) { return false; }
     const state = getState();
     return !!state.profile?.id;
 }
 
+export function user(): UserProfile {
+    if (!hasIdentity()) { return null; }
+    const state = getState();
+    return { ...state.profile };
+}
+
 async function fetchUserAsync(): Promise<UserProfile | undefined> {
     const state = getState();
 
@@ -637,5 +643,5 @@ data.mountVirtualApi(MODULE, { getSync: authApiHandler });
 
 
 // ClouddWorkspace must be included after we mount our virtual APIs.
-import * as cloudWorkspace from "./cloudworkspace";
+import * as cloudWorkspace from "./cloud";
 cloudWorkspace.init();

webapp/src/blocks.tsx

@@ -8,7 +8,7 @@ import * as toolboxeditor from "./toolboxeditor"
 import * as compiler from "./compiler"
 import * as toolbox from "./toolbox";
 import * as snippets from "./blocksSnippets";
-import * as workspace from "./workspace";
+import * as workspace from "./workspaces/workspace";
 import * as simulator from "./simulator";
 import * as dialogs from "./dialogs";
 import * as blocklyFieldView from "./blocklyFieldView";