/
db-schema.coffee
1115 lines (1048 loc) · 43.8 KB
/
db-schema.coffee
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
###############################################################################
#
# SageMathCloud: A collaborative web-based interface to Sage, IPython, LaTeX and the Terminal.
#
# Copyright (C) 2016, Sagemath Inc.
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program. If not, see <http://www.gnu.org/licenses/>.
#
###############################################################################
###
The schema below determines the PostgreSQL database schema. The notation is as follows:
schema.table_name =
desc: 'A description of this table.' # will be used only for tooling
primary_key : 'the_table_primary_key'
durability : 'hard' or 'soft' # optional -- if given, specify the table durability; 'hard' is the default
fields : # every field *must* be listed here or user queries won't work.
the_table_primary_key :
type : 'uuid'
desc : 'This is the primary key of the table.'
...
pg_indexes : [array of column names] # also some more complicated ways to define indexes; see the examples.
user_query : # queries that are directly exposed to the client via a friendly "fill in what result looks like" query language
get : # describes get query for reading data from this table
pg_where : # this gets run first on the table before
'account_id' - replaced by user's account_id
'project_id' - filled in by project_id, which must be specified in the query itself;
(if table not anonymous then project_id must be a project that user has read access to)
'project_id-public' - filled in by project_id, which must be specified in the query itself;
(if table not anonymous then project_id must be of a project with at east one public path)
'all_projects_read' - filled in with list of all the id's of projects this user has read access to
'collaborators' - filled in by account_id's of all collaborators of this user
an arbitrary function - gets called with an object with these keys:
account_id, table, query, multi, options, changes
fields : # these are the fields any user is allowed to see, subject to the all constraint above
field_name : either null or a default_value
another_field : 10 # means will default to 10 if undefined in database
this_field : null # no default filled in
settings :
strip : false # defaults for a field that is an object -- these get filled in if missing in db
wrap : true
set : # describes more dangerous *set* queries that the user can make via the query language
pg_where : # initially restrict what user can set
'account_id' - user account_id
- list of project_id's that the user has write access to
fields : # user must always give the primary key in set queries
account_id : 'account_id' # means that this field will automatically be filled in with account_id
project_id : 'project_write' # means that this field *must* be a project_id that the user has *write* access to
foo : true # user is allowed (but not required) to set this
bar : true # means user is allowed to set this
To specify more than one user query against a table, make a new table as above, omitting
everything except the user_query section, and include a virtual section listing the actual
table to query:
virtual : 'original_table'
For example,
schema.collaborators =
primary_key : 'account_id'
anonymous : false
virtual : 'accounts'
user_query:
get : ...
Finally, putting
anonymous : true
makes it so non-signed-in-users may query the table (read only) for data, e.g.,
schema.stats =
primary_key: 'id'
anonymous : true # allow user access, even if not signed in
fields:
id : true
...
###
misc = require('./misc')
{DEFAULT_QUOTAS} = require('./upgrade-spec')
schema = exports.SCHEMA = {}
schema.account_creation_actions =
desc : 'Actions to carry out when accounts are created, triggered by the email address of the user.'
primary_key : 'id'
fields :
id :
type : 'uuid'
action :
type : 'map'
desc : 'Describes the action to carry out when an account is created with the given email_address.'
email_address :
type : 'string'
desc : 'Email address of user.'
expire :
type : 'timestamp'
desc : 'When this action should be expired.'
pg_indexes : ['email_address']
schema.accounts =
desc : 'All user accounts.'
primary_key : 'account_id'
fields :
account_id :
type : 'uuid',
desc : 'The uuid that determines the user account'
created :
type : 'timestamp'
desc : 'When the account was created.'
created_by :
type : 'string'
pg_type : 'inet'
desc : 'IP address that created the account.'
creation_actions_done :
type : 'boolean'
desc : 'Set to true after all creation actions (e.g., add to projects) associated to this account are succesfully completed.'
password_hash :
type : 'string'
pg_type : 'VARCHAR(173)'
desc : 'hash of the password'
deleted :
type : 'boolean'
desc : "True if the account has been deleted."
email_address :
type : 'string'
pg_type : "VARCHAR(254)" # see http://stackoverflow.com/questions/386294/what-is-the-maximum-length-of-a-valid-email-address
desc : 'The email address of the user. This is optional, since users may instead be associated to passport logins.'
unique : true # only one record in database can have this email address (if given)
email_address_before_delete :
type : 'string'
desc : 'The email address of the user before they deleted their account.'
passports :
type : 'map'
desc : 'Map from string ("[strategy]-[id]") derived from passport name and id to the corresponding profile'
editor_settings :
type : 'map'
desc : 'Description of configuration settings for the editor. See the user_query get defaults.'
other_settings :
type : 'map'
desc : 'Miscellaneous overall configuration settings for SMC, e.g., confirm close on exit?'
first_name :
type : 'string'
pg_type : "VARCHAR(254)" # some limit (actually around 3000) is required for indexing
desc : 'The first name of this user.'
last_name :
type : 'string'
pg_type : "VARCHAR(254)"
desc : 'The last name of this user.'
banned :
type : 'boolean'
desc : 'Whether or not this user is banned.'
terminal :
type : 'map'
desc : 'Settings for the terminal, e.g., font_size, etc. (see get query)'
autosave :
type : 'integer'
desc : 'File autosave interval in seconds'
evaluate_key :
type : 'string'
desc : 'Key used to evaluate code in Sage worksheet.'
font_size :
type : 'integer'
desc : 'Default font-size for the editor, jupyter, etc. (px)'
last_active :
type : 'timestamp'
desc : 'When this user was last active.'
stripe_customer_id :
type : 'string'
desc : 'The id of this customer in the stripe billing system.'
stripe_customer :
type : 'map'
desc : 'Information about customer from the point of view of stripe (exactly what is returned by stripe.customers.retrieve).'
profile :
type : 'map'
desc : 'Information related to displaying this users location and presence in a document or chatroom.'
groups :
type : 'array'
pg_type : 'TEXT[]'
desc : "Array of groups that this user belongs to; usually empty. The only group right now is 'admin', which grants admin rights."
pg_indexes : [
'(lower(first_name) text_pattern_ops)',
'(lower(last_name) text_pattern_ops)',
'created_by',
'created',
]
user_query :
get :
throttle_changes : 500
pg_where : ['account_id = $::UUID':'account_id']
fields :
account_id : null
email_address : null
editor_settings :
strip_trailing_whitespace : false
show_trailing_whitespace : true
line_wrapping : true
line_numbers : true
smart_indent : true
electric_chars : true
match_brackets : true
auto_close_brackets : true
code_folding : true
match_xml_tags : true
auto_close_xml_tags : true
spaces_instead_of_tabs : true
multiple_cursors : true
track_revisions : true
extra_button_bar : true
first_line_number : 1
indent_unit : 4
tab_size : 4
bindings : "standard"
theme : "default"
undo_depth : 300
other_settings :
confirm_close : true
mask_files : true
page_size : 50
standby_timeout_m : 10
default_file_sort : 'time'
first_name : ''
last_name : ''
terminal :
font_size : 14
color_scheme : 'default'
font : 'monospace'
autosave : 45
evaluate_key : 'Shift-Enter'
font_size : 14
passports : {}
groups : []
last_active : null
stripe_customer : null
profile :
image : undefined
color : undefined
set :
fields :
account_id : 'account_id'
editor_settings : true
other_settings : true
first_name : true
last_name : true
terminal : true
autosave : true
evaluate_key : true
font_size : true
profile : true
check_hook : (db, obj, account_id, project_id, cb) ->
# Hook to truncate some text fields to at most 254 characters, to avoid
# further trouble down the line.
for field in ['first_name', 'last_name', 'email_address']
if obj[field]?
obj[field] = obj[field].slice(0,254)
cb()
schema.blobs =
desc : 'Table that stores blobs mainly generated as output of Sage worksheets.'
primary_key : 'id'
fields :
id :
type : 'uuid'
desc : 'The uuid of this blob, which is a uuid derived from the Sha1 hash of the blob content.'
blob :
type : 'Buffer'
desc : 'The actual blob content'
expire :
type : 'timestamp'
desc : 'When to expire this blob (when delete_expired is called on the database).'
created :
type : 'timestamp'
desc : 'When the blob was created.'
project_id :
type : 'string'
desc : 'The uuid of the project that created the blob.'
last_active :
type : 'timestamp'
desc : 'When the blob was last pulled from the database.'
count :
type : 'number'
desc : 'How many times the blob has been pulled from the database.'
size :
type : 'number'
desc : 'The size in bytes of the blob.'
gcloud :
type : 'string'
desc : 'name of a bucket that contains the actual blob, if available.'
backup :
type : 'boolean'
desc : 'if true, then this blob was saved to an offsite backup'
compress :
type : 'string'
desc : "optional compression used: 'gzip', 'zlib', 'snappy'"
user_query :
get :
instead_of_query : (database, obj, account_id, cb) ->
if not obj.id?
cb("id must be specified")
return
database.get_blob
uuid : obj.id
cb : (err, blob) ->
if err
cb(err)
else
cb(undefined, {id:obj.id, blob:blob})
fields :
id : null
blob : null
set :
fields :
id : true
blob : true
project_id : 'project_write'
ttl : 0
required_fields :
id : true
blob : true
project_id : true
instead_of_change : (database, old_val, new_val, account_id, cb) ->
database.save_blob
uuid : new_val.id
blob : new_val.blob
ttl : new_val.ttl
project_id : new_val.project_id
check : true # can't trust the user!
cb : cb
schema.central_log =
desc : 'Table for logging system stuff that happens. Meant to help in running and understanding the system better.'
primary_key : 'id'
durability : 'soft' # loss of some log data not serious, since used only for analytics
fields :
id :
type : 'uuid'
event :
type : 'string'
value :
type : 'map'
time :
type : 'timestamp'
pg_indexes : ['time', 'event']
schema.client_error_log =
primary_key : 'id'
durability : 'soft' # loss of some log data not serious, since used only for analytics
fields:
id :
type : 'uuid'
event :
type : 'string'
error :
type : 'string'
account_id :
type : 'uuid'
time :
type : 'timestamp'
pg_indexes : ['time', 'event']
schema.webapp_errors =
primary_key : 'id'
durability : 'soft' # loss of some log data not serious, since used only for analytics
fields:
id : type : 'uuid'
account_id : type : 'uuid'
name : type : 'string'
message : type : 'string'
comment : type : 'string'
stacktrace : type : 'string'
file : type : 'string'
path : type : 'string'
lineNumber : type : 'integer'
columnNumber : type : 'integer'
severity : type : 'string'
browser : type : 'string'
mobile : type : 'boolean'
responsive : type : 'boolean'
user_agent : type : 'string'
path : type : 'text'
smc_version : type : 'string'
build_date : type : 'string'
smc_git_rev : type : 'string'
uptime : type : 'string'
start_time : type : 'timestamp'
time : type : 'timestamp'
pg_indexes : ['time', 'name', 'account_id', 'smc_git_rev', 'smc_version', 'start_time', 'browser']
schema.collaborators =
primary_key : 'account_id'
anonymous : false
virtual : 'accounts'
user_query:
get :
pg_where : ["account_id = ANY(SELECT DISTINCT jsonb_object_keys(users)::UUID FROM projects WHERE users ? $::TEXT)": 'account_id']
pg_changefeed : 'collaborators'
fields :
account_id : null
first_name : ''
last_name : ''
last_active : null
profile : null
schema.compute_servers =
primary_key : 'host'
fields :
host :
type : 'string'
pg_type : 'VARCHAR(63)'
dc :
type : 'string'
port :
type : 'integer'
secret :
type : 'string'
experimental :
type : 'boolean'
member_host :
type : 'boolean'
status :
type : 'map'
desc : 'something like {stuff:?,...,timestamp:?}'
date : ['timestamp']
schema.file_access_log =
primary_key : 'id'
durability : 'soft' # loss of some log data not serious, since used only for analytics
fields:
id :
type : 'uuid'
project_id :
type : 'uuid'
account_id :
type : 'uuid'
filename :
type : 'string'
time :
type : 'timestamp'
pg_indexes : ['project_id', 'account_id', 'filename', 'time']
# TODO: for postgres rewrite after done we MIGHT completely redo file_use to eliminate
# the id field, use project_id, path as a compound primary key, and maybe put users in
# another table with a relation. There is also expert discussion about this table in the
# Hacker News discussion of my PostgreSQL vs ... blog post.
schema.file_use =
primary_key: 'id'
durability : 'soft' # loss of some log data not serious, since used only for showing notifications
unique_writes: true # there is no reason for a user to write the same record twice
fields:
id :
type : 'string'
pg_type : 'CHAR(40)'
project_id :
type : 'uuid'
path :
type : 'string'
users :
type : 'map'
desc : '{account_id1: {action1: timestamp1, action2:timestamp2}, account_id2: {...}}'
date : 'all'
last_edited :
type : 'timestamp'
pg_indexes : ['project_id', 'last_edited']
user_query:
get :
pg_where : ['projects', 'last_edited IS NOT NULL']
pg_changefeed: 'projects'
options : [{order_by : '-last_edited'}, {limit : 200}] # limit is kind of arbitrary; not sure what to do.
throttle_changes : 3000
fields :
id : null
project_id : null
path : null
users : null
last_edited : null
set :
fields :
id : (obj, db) -> db.sha1(obj.project_id, obj.path)
project_id : 'project_write'
path : true
users : true
last_edited : true
required_fields :
id : true
project_id : true
path : true
check_hook : (db, obj, account_id, project_id, cb) ->
# hook to note that project is being used (CRITICAL: do not pass path
# into db.touch since that would cause another write to the file_use table!)
# CRITICAL: Only do this if what edit or chat for this user is very recent.
# Otherwise we touch the project just for seeing notifications or opening
# the file, which is confusing and wastes a lot of resources.
x = obj.users?[account_id]
recent = misc.minutes_ago(3)
if x? and (x.edit >= recent or x.chat >= recent)
db.touch(project_id:obj.project_id, account_id:account_id)
cb?()
schema.hub_servers =
primary_key : 'host'
durability : 'soft' # loss of some log data not serious, since ephemeral and expires quickly anyways
fields:
host :
type : 'string'
pg_type : 'VARCHAR(63)'
port :
type : 'integer'
clients :
type : 'integer'
expire :
type : 'timestamp'
schema.instances =
primary_key: 'name'
fields:
name :
type : 'string'
gce :
type : 'map'
gce_sha1 :
type : 'string'
requested_preemptible :
type : 'boolean'
requested_status :
type : 'string'
desc : "One of 'RUNNING', 'TERMINATED'"
action :
type : 'map'
desc : "{action:'start', started:timestamp, finished:timestamp, params:?, error:?, rule:?}"
date : ['started', 'finished']
schema.instance_actions_log =
primary_key: 'id'
fields:
id :
type : 'uuid'
name :
type : 'string'
desc : 'hostname of vm'
pg_type : 'VARCHAR(63)'
action :
type : 'map'
desc : 'same as finished action object for instances above'
date : ['started', 'finished']
schema.passport_settings =
primary_key:'strategy'
fields:
strategy :
type : 'string'
conf :
type : 'map'
schema.password_reset =
primary_key: 'id'
fields:
id :
type : 'uuid'
email_address :
type : 'string'
expire :
type : 'timestamp'
schema.password_reset_attempts =
primary_key: 'id'
durability : 'soft' # loss not serious, since used only for analytics and preventing attacks
fields:
id :
type : 'uuid'
email_address :
type : 'string'
ip_address :
type : 'string'
pg_type : 'inet'
time :
type : 'timestamp'
pg_indexes: ['time']
schema.project_log =
primary_key: 'id'
durability : 'soft' # dropping a log entry (e.g., "foo opened a file") wouldn't matter much
fields :
id :
type : 'uuid'
desc : 'which'
project_id :
type : 'uuid'
desc : 'where'
time :
type : 'timestamp'
desc : 'when'
account_id :
type : 'uuid'
desc : 'who'
event :
type : 'map'
desc : 'what'
pg_indexes : ['project_id', 'time']
user_query:
get :
pg_where : 'projects'
pg_changefeed: 'projects'
options : [{order_by : '-time'}, {limit : 400}]
throttle_changes : 2000
fields :
id : null
project_id : null
time : null
account_id : null
event : null
set :
fields :
id : (obj) -> obj.id ? misc.uuid()
project_id : 'project_write'
account_id : 'account_id'
time : true
event : true
schema.projects =
primary_key: 'project_id'
fields :
project_id :
type : 'uuid',
desc : 'The project id, which is the primary key that determines the project.'
title :
type : 'string'
desc : 'The short title of the project. Should use no special formatting, except hashtags.'
description :
type : 'string'
desc : 'A longer textual description of the project. This can include hashtags and should be formatted using markdown.' # markdown rendering possibly not implemented
users :
type : 'map'
desc : "This is a map from account_id's to {hide:bool, group:['owner',...], upgrades:{memory:1000, ...}}."
invite :
type : 'map'
desc : "Map from email addresses to {time:when invite sent, error:error message if there was one}"
date : ['time']
invite_requests :
type : 'map'
desc : "This is a map from account_id's to {timestamp:?, message:'i want to join because...'}."
date : ['timestamp']
deleted :
type : 'boolean'
desc : 'Whether or not this project is deleted.'
host :
type : 'map'
desc : "This is a map {host:'hostname_of_server', assigned:timestamp of when assigned to that server}."
date : ['assigned']
settings :
type : 'map'
desc : 'This is a map that defines the free base quotas that a project has. It is of the form {cores: 1.5, cpu_shares: 768, disk_quota: 1000, memory: 2000, mintime: 36000000, network: 0}. WARNING: some of the values are strings not numbers in the database right now, e.g., disk_quota:"1000".'
status :
type : 'map'
desc : 'This is a map computed by the status command run inside a project, and slightly enhanced by the compute server, which gives extensive status information about a project. It has the form {console_server.pid: [pid of the console server, if running], console_server.port: [port if it is serving], disk_MB: [MB of used disk], installed: [whether code is installed], local_hub.pid: [pid of local hub server process], local_hub.port: [port of local hub process], memory: {count:?, pss:?, rss:?, swap:?, uss:?} [output by smem], raw.port: [port that the raw server is serving on], sage_server.pid: [pid of sage server process], sage_server.port: [port of the sage server], secret_token: [long random secret token that is needed to communicate with local_hub], state: "running" [see COMPUTE_STATES below], version: [version number of local_hub code]}'
state :
type : 'map'
desc : 'Info about the state of this project of the form {error: "", state: "running", time: timestamp}, where time is when the state was last computed. See COMPUTE_STATES below.'
date : ['time']
last_edited :
type : 'timestamp'
desc : 'The last time some file was edited in this project. This is the last time that the file_use table was updated for this project.'
last_active :
type : 'map'
desc : "Map from account_id's to the timestamp of when the user with that account_id touched this project."
date : 'all'
created :
type : 'timestamp'
desc : 'When the account was created.'
action_request :
type : 'map'
desc : "Request state change action for project: {action:['restart', 'stop', 'save', 'close'], started:timestamp, err:?, finished:timestamp}"
date : ['started', 'finished']
storage :
type : 'map'
desc : "This is a map {host:'hostname_of_server', assigned:when first saved here, saved:when last saved here}."
date : ['assigned', 'saved']
last_backup :
type : 'timestamp'
desc : "Timestamp of last off-disk successful backup using bup to Google cloud storage"
storage_request :
type : 'map'
desc : "{action:['save', 'close', 'move', 'open'], requested:timestap, pid:?, target:?, started:timestamp, finished:timestamp, err:?}"
date : ['started', 'finished', 'requested']
course :
type : 'map'
desc : '{project_id:[id of project that contains .course file], path:[path to .course file], pay:?, email_address:[optional email address of student -- used if account_id not known], account_id:[account id of student]}, where pay is either not set (or equals falseish) or is a timestamp by which the students must move the project to a members only server.'
date : ['pay']
run :
type : 'boolean'
desc : 'If true, we try to run this project on kubernetes; if false, we delete it from running on kubernetes.'
storage_server :
type : 'integer'
desc : 'Number of the Kubernetes storage server with the data for this project: one of 0, 1, 2, ...'
storage_ready :
type : 'boolean'
desc : 'Whether storage is ready to be used on the storage server. Do NOT try to start project until true; this gets set by storage daemon when it notices the that run is true.'
disk_size :
type : 'integer'
desc : 'Size in megabytes of the project disk.'
resources :
type : 'map'
desc : 'Object of the form {requests:{memory:"30Mi",cpu:"5m"}, limits:{memory:"100Mi",cpu:"300m"}} which is passed to the k8s resources section for this pod.'
preemptible :
type : 'boolean'
desc : 'If true, allow to run on preemptible nodes.'
idle_timeout :
type : 'integer'
desc : 'If given and nonzero, project will be killed if it is idle for this many **minutes**, where idle *means* that last_edited has not been updated.'
pg_indexes : [
'last_edited',
'USING GIN (users)' # so get_collaborator_ids is fast
'USING GIN (host jsonb_path_ops)' # so get_projects_on_compute_server is fast
]
user_query:
get :
pg_where : 'projects'
pg_changefeed: 'projects'
throttle_changes : 2000
fields :
project_id : null
title : ''
description : ''
users : {}
invite : null # who has been invited to this project via email
invite_requests: null # who has requested to be invited
deleted : null
host : null
settings : DEFAULT_QUOTAS
status : null
state : null
last_edited : null
last_active : null
action_request : null # last requested action -- {action:?, time:?, started:?, finished:?, err:?}
course : null
set :
fields :
project_id : 'project_write'
title : true
description : true
deleted : true
invite_requests: true # project collabs can modify this (e.g., to remove from it once user added or rejected)
users : (obj, db, account_id) -> db._user_set_query_project_users(obj, account_id)
action_request : true # used to request that an action be performed, e.g., "save"; handled by before_change
before_change : (database, old_val, new_val, account_id, cb) ->
database._user_set_query_project_change_before(old_val, new_val, account_id, cb)
on_change : (database, old_val, new_val, account_id, cb) ->
database._user_set_query_project_change_after(old_val, new_val, account_id, cb)
project_query:
get :
pg_where : ["project_id = $::UUID" : 'project_id']
fields :
project_id : null
title : null
description : null
set :
fields :
project_id : 'project_id'
title : true
description : true
# Table that enables set queries to the course field of a project. Only
# project owners are allowed to use this table. The point is that this makes
# it possible for the owner of the project to set things, but not for the
# collaborators to set those things.
schema.projects_owner =
virtual : 'projects'
fields :
project_id : true
course : true
user_query :
set :
fields :
project_id : 'project_owner'
course : true
# Table that enables any signed-in user to set an invite request.
# Later: we can make an index so that users can see all outstanding requests they have made easily.
# How to test this from the browser console:
# project_id = '4e0f5bfd-3f1b-4d7b-9dff-456dcf8725b8' // id of a project you have
# invite_requests = {}; invite_requests[smc.client.account_id] = {timestamp:new Date(), message:'please invite me'}
# smc.client.query({cb:console.log, query:{project_invite_requests:{project_id:project_id, invite_requests:invite_requests}}}) // set it
# smc.redux.getStore('projects').get_project(project_id).invite_requests // see requests for this project
#
# CURRENTLY NOT USED.
schema.project_invite_requests =
virtual : 'projects'
primary_key: 'project_id'
fields :
project_id : true
invite_requests : true # {account_id:{timestamp:?, message:?}, ...}
user_query :
set :
fields :
project_id : true
invite_requests : true
before_change : (database, old_val, new_val, account_id, cb) ->
cb() # actual function will be database._user... as below.
#database._user_set_query_project_invite_requests(old_val, new_val, account_id, cb)
# For now don't check anything -- this is how we will make it secure later.
# This will:
# - that user setting this is signed in
# - ensure user only modifies their own entry (for their own id).
# - enforce some hard limit on number of outstanding invites (say 30).
# - enforce limit on size of invite message.
# - sanity check on timestamp
# - with an index as mentioned above we could limit the number of projects
# to which a single user has requested to be invited.
# Table that provides extended read info about a single project
# but *ONLY* for admin.
schema.projects_admin =
primary_key : schema.projects.primary_key
virtual : 'projects'
fields : schema.projects.fields
user_query:
get :
admin : true # only admins can do get queries on this table
# (without this, users who have read access could read)
pg_where : ['project_id = $::UUID':'project_id']
fields : schema.projects.user_query.get.fields
# Get publicly available information about a project.
#
schema.public_projects =
anonymous : true
virtual : 'projects'
user_query :
get :
pg_where : ['project_id = $::UUID':'project_id-public']
fields :
project_id : true
title : true
description : true
schema.public_paths =
primary_key : 'id'
anonymous : true # allow user *read* access, even if not signed in
fields:
id :
type : 'string'
pg_type : 'CHAR(40)'
desc : 'sha1 hash derived from project_id and path'
project_id :
type : 'uuid'
path :
type : 'string'
description :
type : 'string'
disabled :
type : 'boolean'
desc : 'if true then disabled'
pg_indexes : ['project_id']
user_query:
get :
pg_where : ["project_id = $::UUID": 'project_id']
throttle_changes : 2000
fields :
id : null
project_id : null
path : null
description : null
disabled : null # if true then disabled
set :
fields :
id : (obj, db) -> db.sha1(obj.project_id, obj.path)
project_id : 'project_write'
path : true
description : true
disabled : true
required_fields :
id : true
project_id : true
path : true
schema.remember_me =
primary_key : 'hash'
durability : 'soft' # dropping this would just require a user to login again
fields :
hash :
type : 'string'
pg_type : 'CHAR(127)'
value :
type : 'map'
account_id :
type : 'uuid'
expire :
type : 'timestamp'
pg_indexes : ['account_id']
schema.server_settings =
primary_key : 'name'
anonymous : false
fields :
name :
type : 'string'
value :
type : 'string'
user_query:
# NOTE: can *set* but cannot get!
set:
admin : true
fields:
name : null
value : null
# Default settings to customize a given site, typically a private install of SMC.
exports.site_settings_conf =
site_name:
name : "Site name"
desc : "The heading name of your site."
default : "SageMathCloud"
site_description:
name : "Site description"
desc : "The description of your site."
default : ""
terms_of_service:
name : "Terms of service link text"
desc : "The text displayed for the terms of service link (make empty to not require)."
default : 'By clicking Sign up! you agree to our <a target="_blank" href="/policies/terms.html">Terms of Service</a>.'
account_creation_email_instructions:
name : 'Account creation instructions'
desc : "Instructions displayed next to the box where a user creates their account using their name and email address."
default : 'Create an Account'
help_email:
name : "Help email address"
desc : "Email address that user is directed to use for support requests"
default : "help@sagemath.com"
commercial:
name : "Commercial UI elements ('yes' or 'no')"
desc : "Whether or not to include user interface elements related to for-pay upgrades and features. Set to 'yes' to include these elements."
default : "no"
site_settings_fields = misc.keys(exports.site_settings_conf)
schema.site_settings =
virtual : 'server_settings'
anonymous : false
user_query:
# NOTE: can set and get only fields in site_settings_fields, but not any others.
get:
pg_where: ['name = ANY($)': site_settings_fields]
admin : true
fields :
name : null
value : null
set:
admin : true
fields:
name : (obj, db) ->
if obj.name in site_settings_fields
return obj.name
throw Error("setting name='#{obj.name}' not allowed")
value : null
schema.stats =
primary_key : 'id'
durability : 'soft' # ephemeral stats whose slight loss wouldn't matter much
anonymous : true # allow user read access, even if not signed in
fields:
id :
type : 'uuid'
time :
type : 'timestamp'
pg_check : 'NOT NULL'
accounts :
type : 'integer'
pg_check : 'NOT NULL CHECK (accounts >= 0)'
accounts_created :
type : 'map'
projects :
type : 'integer'