First pass at workspaces.

experimental/webtry/DESIGN.md

 Design
 ======
 
 
 Overview
 --------
 Allows trying out Skia code in the browser.
 
 
 Security
@@ skipping 18 matching lines @@
   * No preprocessor use is allowed (no lines can begin with #includes).
 
 
 Architecture
 ------------
 
 
 The server runs on GCE, and consists of a Go Web Server that calls out to the
 c++ compiler and executes code in a chroot jail. See the diagram below:
 
-                             
-     +–––––––––––––+         
-     |             |         
-     |  Browser    |         
-     |             |         
-     +––––––+––––––+         
-            |                
-     +––––––+––––––+         
-     |             |         
-     |             |         
-     | Web Server  |         
-     |             |         
-     |   (Go)      |         
-     |             |         
-     |             |         
-     +–––––––+–––––+         
-             |               
-     +–––––––+––––––––––+    
-     | chroot jail      |    
-     |  +––––––––––––––+|    
-     |  | seccomp      ||    
-     |  |  +––––––––––+||    
-     |  |  |User code |||    
-     |  |  |          |||    
-     |  |  +––––––––––+||    
-     |  +––––––––––––––+|    
-     |                  |    
-     +––––––––––––––––––+    
-                             
+    +–––––––––––––+
+    |             |
+    |  Browser    |
+    |             |
+    +––––––+––––––+
+           |
+    +––––––+––––––+
+    |             |
+    |             |
+    | Web Server  |
+    |             |
+    |   (Go)      |
+    |             |
+    |             |
+    +–––––––+–––––+
+            |
+    +–––––––+––––––––––+
+    | chroot jail      |
+    |  +––––––––––––––+|
+    |  | seccomp      ||
+    |  |  +––––––––––+||
+    |  |  |User code |||
+    |  |  |          |||
+    |  |  +––––––––––+||
+    |  +––––––––––––––+|
+    |                  |
+    +––––––––––––––––––+
 
 The user code is expanded into a simple template and linked against libskia
 and a couple other .o files that contain main() and the code that sets up the
 seccomp and rlimit restrictions. This code also sets up the SkCanvas that is
 handed to the user code. Any code the user submits is restricted to running in
 a single function that looks like this:
 
 
     void draw(SkCanvas* canvas) {
       // User code goes here.
@@ skipping 62 matching lines @@
 
     // If this gets changed also update the sqlite create statement in webtry.go.
 
     CREATE TABLE webtry (
       code      TEXT      DEFAULT ''                 NOT NULL,
       create_ts TIMESTAMP DEFAULT CURRENT_TIMESTAMP  NOT NULL,
       hash      CHAR(64)  DEFAULT ''                 NOT NULL,
       PRIMARY KEY(hash)
     );
 
+    CREATE TABLE workspace (
+      name      CHAR(64)  DEFAULT ''                 NOT NULL,
+      create_ts TIMESTAMP DEFAULT CURRENT_TIMESTAMP  NOT NULL,
+      PRIMARY KEY(name)
+    );
+
+    CREATE TABLE workspacetry (
+      name      CHAR(64)  DEFAULT ''                 NOT NULL,
+      create_ts TIMESTAMP DEFAULT CURRENT_TIMESTAMP  NOT NULL,
+      hash      CHAR(64)  DEFAULT ''                 NOT NULL,
+      hidden    INTEGER   DEFAULT 0                  NOT NULL,
+
+      FOREIGN KEY (name) REFERENCES workspace(name)
+    );
+
 Common queries webtry.go will use:
 
     INSERT INTO webtry (code, hash) VALUES('int i = 0;...', 'abcdef...');
 
     SELECT code, create_ts, hash FROM webtry WHERE hash='abcdef...';
 
     SELECT code, create_ts, hash FROM webtry ORDER BY create_ts DESC LIMIT 2;
 
     // To change the password for the webtry sql client:
     SET PASSWORD for 'webtry'@'%' = PASSWORD('<password is in valentine>');
 
     // Run before and after to confirm the password changed:
     SELECT Host, User, Password FROM mysql.user;
 
+Common queries for workspaces:
+
+    SELECT hash, create_ts FROM workspace ORDER BY create_ts DESC;
+
+    INSERT INTO workspace (name, hash) VALUES('autumn-river-12354', 'abcdef...');
+
+    SELECT name FROM workspace GROUP BY name;
+
 Password for the database will be stored in the metadata instance, if the
-metadata server can't be found, i.e. running locally, then data will not be
-stored.  To see the current password stored in metadata and the fingerprint:
+metadata server can't be found, i.e. running locally, then a local sqlite
+database will be used. To see the current password stored in metadata and the
+fingerprint:
 
     gcutil  --project=google.com:skia-buildbots    getinstance skia-webtry-b
 
 To set the mysql password that webtry is to use:
 
     gcutil  --project=google.com:skia-buildbots   setinstancemetadata skia-webtry-b --metadata=password:'[mysql client webtry password]' --fingerprint=[some fingerprint]
 
 To retrieve the password from the running instance just GET the right URL from
 the metadata server:
 
     curl "http://metadata/computeMetadata/v1/instance/attributes/password" -H "X-Google-Metadata-Request: True"
 
 N.B. If you need to change the MySQL password that webtry uses, you must change
 it both in MySQL and the value stored in the metadata server.
 
+Workspaces
+----------
+
+Workspaces are implemented by the workspace and workspacetry tables. The
+workspace table keeps the unique list of all workspaces. The workspacetry table
+keeps track of all the tries that have occured in a workspace. Right now the
+hidden column of workspacetry is not used, it's for future functionality.
+
 Installation
 ------------
 See the README file.