2021-07-15 00:45:53 +00:00
|
|
|
from user import User
|
|
|
|
import test_engine
|
|
|
|
import testsamples
|
|
|
|
|
|
|
|
class TestUser(test_engine.EngineTestCase):
|
|
|
|
# pylint: disable=no-member
|
|
|
|
def setUp(self):
|
|
|
|
super(TestUser, self).setUp()
|
|
|
|
self.load_sample(testsamples.sample_students)
|
|
|
|
|
|
|
|
def test_constructor_sets_user_attributes(self):
|
|
|
|
data = {
|
|
|
|
'Access': 'owners',
|
|
|
|
'Name': 'Foo Bar',
|
|
|
|
'Email': 'email@example.com',
|
|
|
|
'UserID': 1,
|
2022-10-03 14:45:44 +00:00
|
|
|
'UserRef': '1',
|
2021-07-15 00:45:53 +00:00
|
|
|
'LinkKey': {
|
|
|
|
'Param1': 'Param1Value',
|
|
|
|
'Param2': 'Param2Value'
|
|
|
|
},
|
|
|
|
'Origin': 'https://getgrist.com',
|
(core) add a `user.SessionID` value for trigger formulas and granular access rules
Summary:
This makes a `user.SessionID` value available in information about the user, for use with trigger formulas and granular access rules. The ID should be constant within a browser session for anonymous user. For logged in users it simply reflects their user id.
This ID makes it possible to write access rules and trigger formulas that allow different anonymous users to create, view, and edit their own records in a document.
For example, you could have a brain-storming document for puns, and allow anyone to add to it (without logging in), letting people edit their own records, but not showing the records to others until they are approved by a moderator. Without something like this, we could only let anonymous people add one field of a record, and not have a secure way to let them edit that field or others in the same record.
Also adds a `user.IsLoggedIn` flag in passing.
Test Plan: Added a test, updated tests. The test added is a mini-moderation doc, don't use it for real because it allows users to edit their entries after a moderator has approved them.
Reviewers: georgegevoian
Reviewed By: georgegevoian
Subscribers: dsagal
Differential Revision: https://phab.getgrist.com/D3273
2022-02-22 15:42:06 +00:00
|
|
|
'StudentInfo': ['Students', 1],
|
|
|
|
'SessionID': 'u1',
|
(core) add initial support for special shares
Summary:
This gives a mechanism for controlling access control within a document that is distinct from (though implemented with the same machinery as) granular access rules.
It was hard to find a good way to insert this that didn't dissolve in a soup of complications, so here's what I went with:
* When reading rules, if there are shares, extra rules are added.
* If there are shares, all rules are made conditional on a "ShareRef" user property.
* "ShareRef" is null when a doc is accessed in normal way, and the row id of a share when accessed via a share.
There's no UI for controlling shares (George is working on it for forms), but you can do it by editing a `_grist_Shares` table in a document. Suppose you make a fresh document with a single page/table/widget, then to create an empty share you can do:
```
gristDocPageModel.gristDoc.get().docData.sendAction(['AddRecord', '_grist_Shares', null, {linkId: 'xyz', options: '{"publish": true}'}])
```
If you look at the home db now there should be something in the `shares` table:
```
$ sqlite3 -table landing.db "select * from shares"
+----+------------------------+------------------------+--------------+---------+
| id | key | doc_id | link_id | options |
+----+------------------------+------------------------+--------------+---------+
| 1 | gSL4g38PsyautLHnjmXh2K | 4qYuace1xP2CTcPunFdtan | xyz | ... |
+----+------------------------+------------------------+--------------+---------+
```
If you take the key from that (gSL4g38PsyautLHnjmXh2K in this case) and replace the document's urlId in its URL with `s.<key>` (in this case `s.gSL4g38PsyautLHnjmXh2K` then you can use the regular document landing page (it will be quite blank initially) or API endpoint via the share.
E.g. for me `http://localhost:8080/o/docs/s0gSL4g38PsyautLHnjmXh2K/share-inter-3` accesses the doc.
To actually share some material - useful commands:
```
gristDocPageModel.gristDoc.get().docData.getMetaTable('_grist_Views_section').getRecords()
gristDocPageModel.gristDoc.get().docData.sendAction(['UpdateRecord', '_grist_Views_section', 1, {shareOptions: '{"publish": true, "form": true}'}])
gristDocPageModel.gristDoc.get().docData.getMetaTable('_grist_Pages').getRecords()
gristDocPageModel.gristDoc.get().docData.sendAction(['UpdateRecord', '_grist_Pages', 1, {shareRef: 1}])
```
For a share to be effective, at least one page needs to have its shareRef set to the rowId of the share, and at least one widget on one of those pages needs to have its shareOptions set to {"publish": "true", "form": "true"} (meaning turn on sharing, and include form sharing), and the share itself needs {"publish": true} on its options.
I think special shares are kind of incompatible with public sharing, since by their nature (allowing access to all endpoints) they easily expose the docId, and changing that would be hard.
Test Plan: tests added
Reviewers: dsagal, georgegevoian
Reviewed By: dsagal, georgegevoian
Subscribers: jarek, dsagal
Differential Revision: https://phab.getgrist.com/D4144
2024-01-03 16:53:20 +00:00
|
|
|
'IsLoggedIn': True,
|
|
|
|
'ShareRef': None
|
2021-07-15 00:45:53 +00:00
|
|
|
}
|
|
|
|
u = User(data, self.engine.tables)
|
|
|
|
self.assertEqual(u.Name, 'Foo Bar')
|
|
|
|
self.assertEqual(u.Email, 'email@example.com')
|
|
|
|
self.assertEqual(u.UserID, 1)
|
|
|
|
self.assertEqual(u.LinkKey.Param1, 'Param1Value')
|
|
|
|
self.assertEqual(u.LinkKey.Param2, 'Param2Value')
|
|
|
|
self.assertEqual(u.Access, 'owners')
|
|
|
|
self.assertEqual(u.Origin, 'https://getgrist.com')
|
|
|
|
self.assertEqual(u.StudentInfo.id, 1)
|
|
|
|
self.assertEqual(u.StudentInfo.firstName, 'Barack')
|
|
|
|
self.assertEqual(u.StudentInfo.lastName, 'Obama')
|
|
|
|
self.assertEqual(u.StudentInfo.schoolName, 'Columbia')
|
|
|
|
|
|
|
|
def test_setting_is_sample_substitutes_attributes_with_samples(self):
|
|
|
|
data = {
|
|
|
|
'Access': 'owners',
|
|
|
|
'Name': None,
|
|
|
|
'Email': 'email@getgrist.com',
|
|
|
|
'UserID': 1,
|
2022-10-03 14:45:44 +00:00
|
|
|
'UserRef': '1',
|
2021-07-15 00:45:53 +00:00
|
|
|
'LinkKey': {
|
|
|
|
'Param1': 'Param1Value',
|
|
|
|
'Param2': 'Param2Value'
|
|
|
|
},
|
|
|
|
'Origin': 'https://getgrist.com',
|
(core) add a `user.SessionID` value for trigger formulas and granular access rules
Summary:
This makes a `user.SessionID` value available in information about the user, for use with trigger formulas and granular access rules. The ID should be constant within a browser session for anonymous user. For logged in users it simply reflects their user id.
This ID makes it possible to write access rules and trigger formulas that allow different anonymous users to create, view, and edit their own records in a document.
For example, you could have a brain-storming document for puns, and allow anyone to add to it (without logging in), letting people edit their own records, but not showing the records to others until they are approved by a moderator. Without something like this, we could only let anonymous people add one field of a record, and not have a secure way to let them edit that field or others in the same record.
Also adds a `user.IsLoggedIn` flag in passing.
Test Plan: Added a test, updated tests. The test added is a mini-moderation doc, don't use it for real because it allows users to edit their entries after a moderator has approved them.
Reviewers: georgegevoian
Reviewed By: georgegevoian
Subscribers: dsagal
Differential Revision: https://phab.getgrist.com/D3273
2022-02-22 15:42:06 +00:00
|
|
|
'StudentInfo': ['Students', 1],
|
|
|
|
'SessionID': 'u1',
|
(core) add initial support for special shares
Summary:
This gives a mechanism for controlling access control within a document that is distinct from (though implemented with the same machinery as) granular access rules.
It was hard to find a good way to insert this that didn't dissolve in a soup of complications, so here's what I went with:
* When reading rules, if there are shares, extra rules are added.
* If there are shares, all rules are made conditional on a "ShareRef" user property.
* "ShareRef" is null when a doc is accessed in normal way, and the row id of a share when accessed via a share.
There's no UI for controlling shares (George is working on it for forms), but you can do it by editing a `_grist_Shares` table in a document. Suppose you make a fresh document with a single page/table/widget, then to create an empty share you can do:
```
gristDocPageModel.gristDoc.get().docData.sendAction(['AddRecord', '_grist_Shares', null, {linkId: 'xyz', options: '{"publish": true}'}])
```
If you look at the home db now there should be something in the `shares` table:
```
$ sqlite3 -table landing.db "select * from shares"
+----+------------------------+------------------------+--------------+---------+
| id | key | doc_id | link_id | options |
+----+------------------------+------------------------+--------------+---------+
| 1 | gSL4g38PsyautLHnjmXh2K | 4qYuace1xP2CTcPunFdtan | xyz | ... |
+----+------------------------+------------------------+--------------+---------+
```
If you take the key from that (gSL4g38PsyautLHnjmXh2K in this case) and replace the document's urlId in its URL with `s.<key>` (in this case `s.gSL4g38PsyautLHnjmXh2K` then you can use the regular document landing page (it will be quite blank initially) or API endpoint via the share.
E.g. for me `http://localhost:8080/o/docs/s0gSL4g38PsyautLHnjmXh2K/share-inter-3` accesses the doc.
To actually share some material - useful commands:
```
gristDocPageModel.gristDoc.get().docData.getMetaTable('_grist_Views_section').getRecords()
gristDocPageModel.gristDoc.get().docData.sendAction(['UpdateRecord', '_grist_Views_section', 1, {shareOptions: '{"publish": true, "form": true}'}])
gristDocPageModel.gristDoc.get().docData.getMetaTable('_grist_Pages').getRecords()
gristDocPageModel.gristDoc.get().docData.sendAction(['UpdateRecord', '_grist_Pages', 1, {shareRef: 1}])
```
For a share to be effective, at least one page needs to have its shareRef set to the rowId of the share, and at least one widget on one of those pages needs to have its shareOptions set to {"publish": "true", "form": "true"} (meaning turn on sharing, and include form sharing), and the share itself needs {"publish": true} on its options.
I think special shares are kind of incompatible with public sharing, since by their nature (allowing access to all endpoints) they easily expose the docId, and changing that would be hard.
Test Plan: tests added
Reviewers: dsagal, georgegevoian
Reviewed By: dsagal, georgegevoian
Subscribers: jarek, dsagal
Differential Revision: https://phab.getgrist.com/D4144
2024-01-03 16:53:20 +00:00
|
|
|
'IsLoggedIn': True,
|
|
|
|
'ShareRef': None
|
2021-07-15 00:45:53 +00:00
|
|
|
}
|
|
|
|
u = User(data, self.engine.tables, is_sample=True)
|
|
|
|
self.assertEqual(u.StudentInfo.id, 0)
|
|
|
|
self.assertEqual(u.StudentInfo.firstName, '')
|
|
|
|
self.assertEqual(u.StudentInfo.lastName, '')
|
|
|
|
self.assertEqual(u.StudentInfo.schoolName, '')
|