mirror of
https://github.com/gristlabs/grist-core.git
synced 2024-09-30 00:40:48 +00:00
59436d2bca
Summary: Builds upon https://phab.getgrist.com/D3328 - Add HomeDB column `Document.gracePeriodStart` - When the row count moves above the limit, set it to the current date. When it moves below, set it to null. - Add DataLimitStatus type indicating if the document is approaching the limit, is in a grace period, or is in delete only mode if the grace period started at least 14 days ago. Compute it in ActiveDoc and send it to client when opening. - Only allow certain user actions when in delete-only mode. Follow-up tasks related to this diff: - When DataLimitStatus in the client is non-empty, show a banner to the appropriate users. - Only send DataLimitStatus to users with the appropriate access. There's no risk landing this now since real users will only see null until free team sites are released. - Update DataLimitStatus immediately in the client when it changes, e.g. when user actions are applied or the product is changed. Right now it's only sent when the document loads. - Update row limit, grace period start, and data limit status in ActiveDoc when the product changes, i.e. the user upgrades/downgrades. - Account for data size when computing data limit status, not just row counts. See also the tasks mentioned in https://phab.getgrist.com/D3331 Test Plan: Extended FreeTeam nbrowser test, testing the 4 statuses. Reviewers: georgegevoian Reviewed By: georgegevoian Differential Revision: https://phab.getgrist.com/D3331
60 lines
3.2 KiB
TypeScript
60 lines
3.2 KiB
TypeScript
export interface SnapshotWindow {
|
|
count: number;
|
|
unit: 'month' | 'year';
|
|
}
|
|
|
|
// A product is essentially a list of flags and limits that we may enforce/support.
|
|
export interface Features {
|
|
vanityDomain?: boolean; // are user-selected domains allowed (unenforced) (default: true)
|
|
|
|
workspaces?: boolean; // are workspaces shown in web interface (default: true)
|
|
// (this was intended as something we can turn off to shut down
|
|
// web access to content while leaving access to billing)
|
|
|
|
/**
|
|
* Some optional limits. Since orgs can change plans, limits will typically be checked
|
|
* at the point of creation. E.g. adding someone new to a document, or creating a
|
|
* new document. If, after an operation, the limit would be exceeded, that operation
|
|
* is denied. That means it is possible to exceed limits if the limits were not in
|
|
* place when shares/docs were originally being added. The action that would need
|
|
* to be taken when infringement is pre-existing is not so obvious.
|
|
*/
|
|
|
|
maxSharesPerDoc?: number; // Maximum number of users that can be granted access to a
|
|
// particular doc. Doesn't count users granted access at
|
|
// workspace or organization level. Doesn't count billable
|
|
// users if applicable (default: unlimited)
|
|
|
|
maxSharesPerDocPerRole?: {[role: string]: number}; // As maxSharesPerDoc, but
|
|
// for specific roles. Roles are named as in app/common/roles.
|
|
// Applied independently to maxSharesPerDoc.
|
|
// (default: unlimited)
|
|
maxSharesPerWorkspace?: number; // Maximum number of users that can be granted access to
|
|
// a particular workspace. Doesn't count users granted access
|
|
// at organizational level, or billable users (default: unlimited)
|
|
|
|
maxDocsPerOrg?: number; // Maximum number of documents allowed per org.
|
|
// (default: unlimited)
|
|
maxWorkspacesPerOrg?: number; // Maximum number of workspaces allowed per org.
|
|
// (default: unlimited)
|
|
|
|
readOnlyDocs?: boolean; // if set, docs can only be read, not written.
|
|
|
|
snapshotWindow?: SnapshotWindow; // if set, controls how far back snapshots are kept.
|
|
|
|
baseMaxRowsPerDocument?: number; // If set, establishes a default maximum on the
|
|
// number of rows (total) in a single document.
|
|
// Actual max for a document may be higher.
|
|
baseMaxApiUnitsPerDocumentPerDay?: number; // Similar for api calls.
|
|
|
|
gracePeriodDays?: number; // Duration of the grace period in days, before entering delete-only mode
|
|
}
|
|
|
|
// Check whether it is possible to add members at the org level. There's no flag
|
|
// for this right now, it isn't enforced at the API level, it is just a bluff.
|
|
// For now, when maxWorkspacesPerOrg is 1, we should assume members can't be added
|
|
// to org (even though this is not enforced).
|
|
export function canAddOrgMembers(features: Features): boolean {
|
|
return features.maxWorkspacesPerOrg !== 1;
|
|
}
|