2020-07-21 13:20:51 +00:00
|
|
|
import {ApiError} from 'app/common/ApiError';
|
2020-09-11 20:27:09 +00:00
|
|
|
import {DEFAULT_HOME_SUBDOMAIN, isOrgInPathOnly, parseSubdomain} from 'app/common/gristUrls';
|
2020-08-14 16:40:39 +00:00
|
|
|
import * as gutil from 'app/common/gutil';
|
2020-07-21 13:20:51 +00:00
|
|
|
import {DocScope, QueryResult, Scope} from 'app/gen-server/lib/HomeDBManager';
|
|
|
|
import {getUserId, RequestWithLogin} from 'app/server/lib/Authorizer';
|
|
|
|
import {RequestWithOrg} from 'app/server/lib/extractOrg';
|
(core) move more tests to grist-core
Summary:
* Tie build and run-time docker base images to a consistent version (buster)
* Extend the test login system activated by GRIST_TEST_LOGIN to ease porting tests that currently rely on cognito (many)
* Make org resets work in absence of billing endpoints
* When in-memory session caches are used, add missing invalidation steps
* Pass org information through sign-ups/sign-ins more carefully
* For CORS, explicitly trust GRIST_HOST origin when set
* Move some fixtures and tests to core, focussing on tests that cover existing failures or are in the set of tests run on deployments
* Retain regular `test` target to run the test suite directly, without docker
* Add a `test:smoke` target to run a single simple test without `GRIST_TEST_LOGIN` activated
* Add a `test:docker` target to run the tests against a grist-core docker image - since tests rely on certain fixture teams/docs, added `TEST_SUPPORT_API_KEY` and `TEST_ADD_SAMPLES` flags to ease porting
The tests ported were `nbrowser` tests: `ActionLog.ts` (the first test I tend to port to anything, out of habit), `Fork.ts` (exercises a lot of doc creation paths), `HomeIntro.ts` (a lot of DocMenu exercise), and `DuplicateDocument.ts` (covers a feature known to be failing prior to this diff, the CORS tweak resolves it).
Test Plan: Manually tested via `buildtools/build_core.sh`. In follow up, I want to add running the `test:docker` target in grist-core's workflows. In jenkins, only the smoke test is run. There'd be an argument for running all tests, but they include particularly slow tests, and are duplicates of tests already run (in different configuration admittedly), so I'd like to try first just using them in grist-core to gate updates to any packaged version of Grist (the docker image currently).
Reviewers: alexmojaki
Reviewed By: alexmojaki
Subscribers: alexmojaki
Differential Revision: https://phab.getgrist.com/D3176
2021-12-10 22:42:54 +00:00
|
|
|
import {RequestWithGrist} from 'app/server/lib/GristServer';
|
2022-07-04 14:14:55 +00:00
|
|
|
import log from 'app/server/lib/log';
|
2020-07-22 19:45:39 +00:00
|
|
|
import {Permit} from 'app/server/lib/Permit';
|
2020-07-21 13:20:51 +00:00
|
|
|
import {Request, Response} from 'express';
|
|
|
|
import {URL} from 'url';
|
2022-09-28 16:33:53 +00:00
|
|
|
import _ from 'lodash';
|
2020-07-21 13:20:51 +00:00
|
|
|
|
|
|
|
// log api details outside of dev environment (when GRIST_HOSTED_VERSION is set)
|
|
|
|
const shouldLogApiDetails = Boolean(process.env.GRIST_HOSTED_VERSION);
|
|
|
|
|
|
|
|
// Offset to https ports in dev/testing environment.
|
|
|
|
export const TEST_HTTPS_OFFSET = process.env.GRIST_TEST_HTTPS_OFFSET ?
|
|
|
|
parseInt(process.env.GRIST_TEST_HTTPS_OFFSET, 10) : undefined;
|
|
|
|
|
|
|
|
// Database fields that we permit in entities but don't want to cross the api.
|
(core) Grace period and delete-only mode when exceeding row limit
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
2022-03-24 12:05:51 +00:00
|
|
|
const INTERNAL_FIELDS = new Set([
|
|
|
|
'apiKey', 'billingAccountId', 'firstLoginAt', 'filteredOut', 'ownerId', 'gracePeriodStart', 'stripeCustomerId',
|
|
|
|
'stripeSubscriptionId', 'stripePlanId', 'stripeProductId', 'userId', 'isFirstTimeUser', 'allowGoogleLogin',
|
2023-02-20 02:51:40 +00:00
|
|
|
'authSubject', 'usage', 'createdBy'
|
(core) Grace period and delete-only mode when exceeding row limit
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
2022-03-24 12:05:51 +00:00
|
|
|
]);
|
2020-07-21 13:20:51 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Adapt a home-server or doc-worker URL to match the hostname in the request URL. For custom
|
|
|
|
* domains and when GRIST_SERVE_SAME_ORIGIN is set, we replace the full hostname; otherwise just
|
|
|
|
* the base of the hostname. The changes to url are made in-place.
|
|
|
|
*
|
|
|
|
* For dev purposes, port is kept but possibly adjusted for TEST_HTTPS_OFFSET. Note that if port
|
|
|
|
* is different from req's port, it is not considered same-origin for CORS purposes, but would
|
|
|
|
* still receive cookies.
|
|
|
|
*/
|
|
|
|
export function adaptServerUrl(url: URL, req: RequestWithOrg): void {
|
|
|
|
const reqBaseDomain = parseSubdomain(req.hostname).base;
|
|
|
|
|
|
|
|
if (process.env.GRIST_SERVE_SAME_ORIGIN === 'true' || req.isCustomHost) {
|
|
|
|
url.hostname = req.hostname;
|
|
|
|
} else if (reqBaseDomain) {
|
|
|
|
const subdomain: string|undefined = parseSubdomain(url.hostname).org || DEFAULT_HOME_SUBDOMAIN;
|
|
|
|
url.hostname = `${subdomain}${reqBaseDomain}`;
|
|
|
|
}
|
|
|
|
|
|
|
|
// In dev/test environment we can turn on a flag to adjust URLs to use https.
|
|
|
|
if (TEST_HTTPS_OFFSET && url.port && url.protocol === 'http:') {
|
|
|
|
url.port = String(parseInt(url.port, 10) + TEST_HTTPS_OFFSET);
|
|
|
|
url.protocol = 'https:';
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2020-09-11 20:27:09 +00:00
|
|
|
/**
|
|
|
|
* If org is not encoded in domain, prefix it to path - otherwise leave path unchanged.
|
2020-10-19 16:13:20 +00:00
|
|
|
* The domain is extracted from the request, so this method is only useful for constructing
|
|
|
|
* urls that stay within that domain.
|
2020-09-11 20:27:09 +00:00
|
|
|
*/
|
|
|
|
export function addOrgToPathIfNeeded(req: RequestWithOrg, path: string): string {
|
|
|
|
return (isOrgInPathOnly(req.hostname) && req.org) ? `/o/${req.org}${path}` : path;
|
|
|
|
}
|
|
|
|
|
2020-10-19 16:13:20 +00:00
|
|
|
/**
|
|
|
|
* If org is known, prefix it to path unconditionally.
|
|
|
|
*/
|
|
|
|
export function addOrgToPath(req: RequestWithOrg, path: string): string {
|
|
|
|
return req.org ? `/o/${req.org}${path}` : path;
|
|
|
|
}
|
|
|
|
|
2022-03-07 16:40:46 +00:00
|
|
|
/**
|
|
|
|
* Get url to the org associated with the request.
|
|
|
|
*/
|
2022-04-01 21:31:24 +00:00
|
|
|
export function getOrgUrl(req: Request, path: string = '/') {
|
2022-04-27 16:07:08 +00:00
|
|
|
return getOriginUrl(req) + addOrgToPathIfNeeded(req, path);
|
2022-03-07 16:40:46 +00:00
|
|
|
}
|
|
|
|
|
2020-07-21 13:20:51 +00:00
|
|
|
/**
|
|
|
|
* Returns true for requests from permitted origins. For such requests, an
|
|
|
|
* "Access-Control-Allow-Origin" header is added to the response. Vary: Origin
|
|
|
|
* is also set to reflect the fact that the headers are a function of the origin,
|
|
|
|
* to prevent inappropriate caching on the browser's side.
|
|
|
|
*/
|
|
|
|
export function trustOrigin(req: Request, resp: Response): boolean {
|
|
|
|
// TODO: We may want to consider changing allowed origin values in the future.
|
|
|
|
// Note that the request origin is undefined for non-CORS requests.
|
|
|
|
const origin = req.get('origin');
|
|
|
|
if (!origin) { return true; } // Not a CORS request.
|
(core) move more tests to grist-core
Summary:
* Tie build and run-time docker base images to a consistent version (buster)
* Extend the test login system activated by GRIST_TEST_LOGIN to ease porting tests that currently rely on cognito (many)
* Make org resets work in absence of billing endpoints
* When in-memory session caches are used, add missing invalidation steps
* Pass org information through sign-ups/sign-ins more carefully
* For CORS, explicitly trust GRIST_HOST origin when set
* Move some fixtures and tests to core, focussing on tests that cover existing failures or are in the set of tests run on deployments
* Retain regular `test` target to run the test suite directly, without docker
* Add a `test:smoke` target to run a single simple test without `GRIST_TEST_LOGIN` activated
* Add a `test:docker` target to run the tests against a grist-core docker image - since tests rely on certain fixture teams/docs, added `TEST_SUPPORT_API_KEY` and `TEST_ADD_SAMPLES` flags to ease porting
The tests ported were `nbrowser` tests: `ActionLog.ts` (the first test I tend to port to anything, out of habit), `Fork.ts` (exercises a lot of doc creation paths), `HomeIntro.ts` (a lot of DocMenu exercise), and `DuplicateDocument.ts` (covers a feature known to be failing prior to this diff, the CORS tweak resolves it).
Test Plan: Manually tested via `buildtools/build_core.sh`. In follow up, I want to add running the `test:docker` target in grist-core's workflows. In jenkins, only the smoke test is run. There'd be an argument for running all tests, but they include particularly slow tests, and are duplicates of tests already run (in different configuration admittedly), so I'd like to try first just using them in grist-core to gate updates to any packaged version of Grist (the docker image currently).
Reviewers: alexmojaki
Reviewed By: alexmojaki
Subscribers: alexmojaki
Differential Revision: https://phab.getgrist.com/D3176
2021-12-10 22:42:54 +00:00
|
|
|
if (process.env.GRIST_HOST && req.hostname === process.env.GRIST_HOST) { return true; }
|
2022-09-28 16:33:53 +00:00
|
|
|
if (!allowHost(req, new URL(origin)) && !isEnvironmentAllowedHost(new URL(origin))) { return false; }
|
2020-07-21 13:20:51 +00:00
|
|
|
|
|
|
|
// For a request to a custom domain, the full hostname must match.
|
|
|
|
resp.header("Access-Control-Allow-Origin", origin);
|
|
|
|
resp.header("Vary", "Origin");
|
|
|
|
return true;
|
|
|
|
}
|
|
|
|
|
|
|
|
// Returns whether req satisfies the given allowedHost. Unless req is to a custom domain, it is
|
|
|
|
// enough if only the base domains match. Differing ports are allowed, which helps in dev/testing.
|
|
|
|
export function allowHost(req: Request, allowedHost: string|URL) {
|
|
|
|
const mreq = req as RequestWithOrg;
|
2022-04-27 16:07:08 +00:00
|
|
|
const proto = getEndUserProtocol(req);
|
|
|
|
const actualUrl = new URL(getOriginUrl(req));
|
2020-07-21 13:20:51 +00:00
|
|
|
const allowedUrl = (typeof allowedHost === 'string') ? new URL(`${proto}://${allowedHost}`) : allowedHost;
|
|
|
|
if (mreq.isCustomHost) {
|
|
|
|
// For a request to a custom domain, the full hostname must match.
|
2022-09-28 16:33:53 +00:00
|
|
|
return actualUrl.hostname === allowedUrl.hostname;
|
2020-07-21 13:20:51 +00:00
|
|
|
} else {
|
|
|
|
// For requests to a native subdomains, only the base domain needs to match.
|
|
|
|
const allowedDomain = parseSubdomain(allowedUrl.hostname);
|
|
|
|
const actualDomain = parseSubdomain(actualUrl.hostname);
|
2022-12-27 18:35:03 +00:00
|
|
|
return (!_.isEmpty(actualDomain) ?
|
|
|
|
actualDomain.base === allowedDomain.base :
|
|
|
|
allowedUrl.hostname === actualUrl.hostname);
|
2020-07-21 13:20:51 +00:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-09-28 16:33:53 +00:00
|
|
|
export function matchesBaseDomain(domain: string, baseDomain: string) {
|
|
|
|
return domain === baseDomain || domain.endsWith("." + baseDomain);
|
|
|
|
}
|
|
|
|
|
|
|
|
export function isEnvironmentAllowedHost(url: string|URL) {
|
2022-10-25 18:59:17 +00:00
|
|
|
const urlHost = (typeof url === 'string') ? url : url.hostname;
|
2022-09-28 16:33:53 +00:00
|
|
|
return (process.env.GRIST_ALLOWED_HOSTS || "").split(",").some(domain =>
|
|
|
|
domain && matchesBaseDomain(urlHost, domain)
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
2020-07-21 13:20:51 +00:00
|
|
|
export function isParameterOn(parameter: any): boolean {
|
2020-08-14 16:40:39 +00:00
|
|
|
return gutil.isAffirmative(parameter);
|
2020-07-21 13:20:51 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get Scope from request, and make sure it has everything needed for a document.
|
|
|
|
*/
|
|
|
|
export function getDocScope(req: Request): DocScope {
|
|
|
|
const scope = getScope(req);
|
|
|
|
if (!scope.urlId) { throw new Error('document required'); }
|
|
|
|
return scope as DocScope;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Extract information included in the request that may restrict the scope of
|
|
|
|
* that request. Not all requests will support all restrictions.
|
|
|
|
*
|
|
|
|
* - userId - Mandatory. Produced by authentication middleware.
|
|
|
|
* Information returned and actions taken will be limited by what
|
|
|
|
* that user has access to.
|
|
|
|
*
|
|
|
|
* - org - Optional. Extracted by middleware. Limits
|
|
|
|
* information/action to the given org. Not every endpoint
|
|
|
|
* respects this limit. Possible exceptions include endpoints for
|
|
|
|
* listing orgs a user has access to, and endpoints with an org id
|
|
|
|
* encoded in them.
|
|
|
|
*
|
|
|
|
* - urlId - Optional. Embedded as "did" (or "docId") path parameter in endpoints related
|
|
|
|
* to documents. Specifies which document the request pertains to. Can
|
|
|
|
* be a urlId or a docId.
|
|
|
|
*
|
|
|
|
* - includeSupport - Optional. Embedded as "includeSupport" query parameter.
|
|
|
|
* Just a few endpoints support this, it is a very specific "hack" for including
|
|
|
|
* an example workspace in org listings.
|
|
|
|
*
|
|
|
|
* - showRemoved - Optional. Embedded as "showRemoved" query parameter.
|
|
|
|
* Supported by many endpoints. When absent, request is limited
|
|
|
|
* to docs/workspaces that have not been removed. When present, request
|
|
|
|
* is limited to docs/workspaces that have been removed.
|
|
|
|
*/
|
|
|
|
export function getScope(req: Request): Scope {
|
2022-03-24 10:59:47 +00:00
|
|
|
const {specialPermit, docAuth} = (req as RequestWithLogin);
|
|
|
|
const urlId = req.params.did || req.params.docId || docAuth?.docId || undefined;
|
2020-07-21 13:20:51 +00:00
|
|
|
const userId = getUserId(req);
|
|
|
|
const org = (req as RequestWithOrg).org;
|
|
|
|
const includeSupport = isParameterOn(req.query.includeSupport);
|
|
|
|
const showRemoved = isParameterOn(req.query.showRemoved);
|
|
|
|
return {urlId, userId, org, includeSupport, showRemoved, specialPermit};
|
|
|
|
}
|
|
|
|
|
2020-07-22 19:45:39 +00:00
|
|
|
/**
|
|
|
|
* If scope is for the given userId, return a new Scope with the special permit added.
|
|
|
|
*/
|
|
|
|
export function addPermit(scope: Scope, userId: number, specialPermit: Permit): Scope {
|
|
|
|
return {...scope, ...(scope.userId === userId ? {specialPermit} : {})};
|
|
|
|
}
|
|
|
|
|
2022-02-14 21:26:21 +00:00
|
|
|
export interface SendReplyOptions {
|
|
|
|
allowedFields?: Set<string>;
|
|
|
|
}
|
|
|
|
|
2020-07-21 13:20:51 +00:00
|
|
|
// Return a JSON response reflecting the output of a query.
|
|
|
|
// Filter out keys we don't want crossing the api.
|
|
|
|
// Set req to null to not log any information about request.
|
2022-02-14 21:26:21 +00:00
|
|
|
export async function sendReply<T>(
|
|
|
|
req: Request|null,
|
|
|
|
res: Response,
|
|
|
|
result: QueryResult<T>,
|
|
|
|
options: SendReplyOptions = {},
|
|
|
|
) {
|
2022-06-08 17:54:00 +00:00
|
|
|
const data = pruneAPIResult(result.data, options.allowedFields);
|
2020-07-21 13:20:51 +00:00
|
|
|
if (shouldLogApiDetails && req) {
|
|
|
|
const mreq = req as RequestWithLogin;
|
|
|
|
log.rawDebug('api call', {
|
|
|
|
url: req.url,
|
|
|
|
userId: mreq.userId,
|
2022-04-08 18:00:43 +00:00
|
|
|
altSessionId: mreq.altSessionId,
|
2020-07-21 13:20:51 +00:00
|
|
|
email: mreq.user && mreq.user.loginEmail,
|
|
|
|
org: mreq.org,
|
|
|
|
params: req.params,
|
|
|
|
body: req.body,
|
|
|
|
result: data,
|
|
|
|
});
|
|
|
|
}
|
|
|
|
if (result.status === 200) {
|
2022-06-08 17:54:00 +00:00
|
|
|
return res.json(data ?? null); // can't handle undefined
|
2020-07-21 13:20:51 +00:00
|
|
|
} else {
|
|
|
|
return res.status(result.status).json({error: result.errMessage});
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2022-02-14 21:26:21 +00:00
|
|
|
export async function sendOkReply<T>(
|
|
|
|
req: Request|null,
|
|
|
|
res: Response,
|
|
|
|
result?: T,
|
|
|
|
options: SendReplyOptions = {}
|
|
|
|
) {
|
|
|
|
return sendReply(req, res, {status: 200, data: result}, options);
|
2020-07-21 13:20:51 +00:00
|
|
|
}
|
|
|
|
|
2022-02-14 21:26:21 +00:00
|
|
|
export function pruneAPIResult<T>(data: T, allowedFields?: Set<string>): T {
|
2020-07-21 13:20:51 +00:00
|
|
|
// TODO: This can be optimized by pruning data recursively without serializing in between. But
|
|
|
|
// it's fairly fast even with serializing (on the order of 15usec/kb).
|
|
|
|
const output = JSON.stringify(data,
|
|
|
|
(key: string, value: any) => {
|
|
|
|
// Do not include removedAt field if it is not set. It is not relevant to regular
|
|
|
|
// situations where the user is working with non-deleted resources.
|
|
|
|
if (key === 'removedAt' && value === null) { return undefined; }
|
2021-07-15 21:38:21 +00:00
|
|
|
// Don't bother sending option fields if there are no options set.
|
|
|
|
if (key === 'options' && value === null) { return undefined; }
|
2022-02-14 21:26:21 +00:00
|
|
|
// Don't prune anything that is explicitly allowed.
|
|
|
|
if (allowedFields?.has(key)) { return value; }
|
2022-05-18 10:25:14 +00:00
|
|
|
// User connect id is not used in regular configuration, so we remove it from the response, when
|
|
|
|
// it's not filled.
|
|
|
|
if (key === 'connectId' && value === null) { return undefined; }
|
2020-07-21 13:20:51 +00:00
|
|
|
return INTERNAL_FIELDS.has(key) ? undefined : value;
|
|
|
|
});
|
2022-06-08 17:54:00 +00:00
|
|
|
return output !== undefined ? JSON.parse(output) : undefined;
|
2020-07-21 13:20:51 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Access the canonical docId associated with the request. Must have already authorized.
|
|
|
|
*/
|
|
|
|
export function getDocId(req: Request) {
|
|
|
|
const mreq = req as RequestWithLogin;
|
|
|
|
// We should always have authorized by now.
|
|
|
|
if (!mreq.docAuth || !mreq.docAuth.docId) { throw new ApiError(`unknown document`, 500); }
|
|
|
|
return mreq.docAuth.docId;
|
|
|
|
}
|
|
|
|
|
|
|
|
export function optStringParam(p: any): string|undefined {
|
|
|
|
if (typeof p === 'string') { return p; }
|
|
|
|
return undefined;
|
|
|
|
}
|
|
|
|
|
2023-04-06 15:10:29 +00:00
|
|
|
export function stringParam(p: any, name: string, allowed?: readonly string[]): string {
|
2022-02-11 13:10:53 +00:00
|
|
|
if (typeof p !== 'string') {
|
|
|
|
throw new ApiError(`${name} parameter should be a string: ${p}`, 400);
|
|
|
|
}
|
|
|
|
if (allowed && !allowed.includes(p)) {
|
|
|
|
throw new ApiError(`${name} parameter ${p} should be one of ${allowed}`, 400);
|
|
|
|
}
|
2020-12-18 17:37:16 +00:00
|
|
|
return p;
|
2020-07-21 13:20:51 +00:00
|
|
|
}
|
|
|
|
|
2021-11-29 20:12:45 +00:00
|
|
|
export function integerParam(p: any, name: string): number {
|
2020-07-21 13:20:51 +00:00
|
|
|
if (typeof p === 'number') { return Math.floor(p); }
|
2022-07-06 22:36:09 +00:00
|
|
|
if (typeof p === 'string') {
|
|
|
|
const result = parseInt(p, 10);
|
|
|
|
if (isNaN(result)) {
|
|
|
|
throw new ApiError(`${name} parameter cannot be understood as an integer: ${p}`, 400);
|
|
|
|
}
|
|
|
|
return result;
|
|
|
|
}
|
|
|
|
throw new ApiError(`${name} parameter should be an integer: ${p}`, 400);
|
2020-07-21 13:20:51 +00:00
|
|
|
}
|
|
|
|
|
2020-12-18 17:37:16 +00:00
|
|
|
export function optIntegerParam(p: any): number|undefined {
|
|
|
|
if (typeof p === 'number') { return Math.floor(p); }
|
|
|
|
if (typeof p === 'string') { return parseInt(p, 10); }
|
|
|
|
return undefined;
|
|
|
|
}
|
|
|
|
|
(core) support python3 in grist-core, and running engine via docker and/or gvisor
Summary:
* Moves essential plugins to grist-core, so that basic imports (e.g. csv) work.
* Adds support for a `GRIST_SANDBOX_FLAVOR` flag that can systematically override how the data engine is run.
- `GRIST_SANDBOX_FLAVOR=pynbox` is "classic" nacl-based sandbox.
- `GRIST_SANDBOX_FLAVOR=docker` runs engines in individual docker containers. It requires an image specified in `sandbox/docker` (alternative images can be named with `GRIST_SANDBOX` flag - need to contain python and engine requirements). It is a simple reference implementation for sandboxing.
- `GRIST_SANDBOX_FLAVOR=unsandboxed` runs whatever local version of python is specified by a `GRIST_SANDBOX` flag directly, with no sandboxing. Engine requirements must be installed, so an absolute path to a python executable in a virtualenv is easiest to manage.
- `GRIST_SANDBOX_FLAVOR=gvisor` runs the data engine via gvisor's runsc. Experimental, with implementation not included in grist-core. Since gvisor runs on Linux only, this flavor supports wrapping the sandboxes in a single shared docker container.
* Tweaks some recent express query parameter code to work in grist-core, which has a slightly different version of express (smoke test doesn't catch this since in Jenkins core is built within a workspace that has node_modules, and wires get crossed - in a dev environment the problem on master can be seen by doing `buildtools/build_core.sh /tmp/any_path_outside_grist`).
The new sandbox options do not have tests yet, nor does this they change the behavior of grist servers today. They are there to clean up and consolidate a collection of patches I've been using that were getting cumbersome, and make it easier to run experiments.
I haven't looked closely at imports beyond core.
Test Plan: tested manually against regular grist and grist-core, including imports
Reviewers: alexmojaki, dsagal
Reviewed By: alexmojaki
Differential Revision: https://phab.getgrist.com/D2942
2021-07-27 23:43:21 +00:00
|
|
|
export function optJsonParam(p: any, defaultValue: any): any {
|
|
|
|
if (typeof p !== 'string') { return defaultValue; }
|
|
|
|
return gutil.safeJsonParse(p, defaultValue);
|
|
|
|
}
|
2020-12-18 17:37:16 +00:00
|
|
|
|
2020-07-21 13:20:51 +00:00
|
|
|
export interface RequestWithGristInfo extends Request {
|
|
|
|
gristInfo?: string;
|
|
|
|
}
|
2021-07-22 22:21:09 +00:00
|
|
|
|
|
|
|
/**
|
|
|
|
* Returns original request origin. In case, when a client was connected to proxy
|
|
|
|
* or load balancer, it reads protocol from forwarded headers.
|
|
|
|
* More can be read on:
|
|
|
|
* https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Forwarded-Proto
|
|
|
|
* https://docs.aws.amazon.com/elasticloadbalancing/latest/classic/x-forwarded-headers.html
|
|
|
|
*/
|
|
|
|
export function getOriginUrl(req: Request) {
|
2022-04-27 16:07:08 +00:00
|
|
|
const host = req.get('host')!;
|
|
|
|
const protocol = getEndUserProtocol(req);
|
2021-07-22 22:21:09 +00:00
|
|
|
return `${protocol}://${host}`;
|
|
|
|
}
|
(core) move more tests to grist-core
Summary:
* Tie build and run-time docker base images to a consistent version (buster)
* Extend the test login system activated by GRIST_TEST_LOGIN to ease porting tests that currently rely on cognito (many)
* Make org resets work in absence of billing endpoints
* When in-memory session caches are used, add missing invalidation steps
* Pass org information through sign-ups/sign-ins more carefully
* For CORS, explicitly trust GRIST_HOST origin when set
* Move some fixtures and tests to core, focussing on tests that cover existing failures or are in the set of tests run on deployments
* Retain regular `test` target to run the test suite directly, without docker
* Add a `test:smoke` target to run a single simple test without `GRIST_TEST_LOGIN` activated
* Add a `test:docker` target to run the tests against a grist-core docker image - since tests rely on certain fixture teams/docs, added `TEST_SUPPORT_API_KEY` and `TEST_ADD_SAMPLES` flags to ease porting
The tests ported were `nbrowser` tests: `ActionLog.ts` (the first test I tend to port to anything, out of habit), `Fork.ts` (exercises a lot of doc creation paths), `HomeIntro.ts` (a lot of DocMenu exercise), and `DuplicateDocument.ts` (covers a feature known to be failing prior to this diff, the CORS tweak resolves it).
Test Plan: Manually tested via `buildtools/build_core.sh`. In follow up, I want to add running the `test:docker` target in grist-core's workflows. In jenkins, only the smoke test is run. There'd be an argument for running all tests, but they include particularly slow tests, and are duplicates of tests already run (in different configuration admittedly), so I'd like to try first just using them in grist-core to gate updates to any packaged version of Grist (the docker image currently).
Reviewers: alexmojaki
Reviewed By: alexmojaki
Subscribers: alexmojaki
Differential Revision: https://phab.getgrist.com/D3176
2021-12-10 22:42:54 +00:00
|
|
|
|
2022-04-27 16:07:08 +00:00
|
|
|
/**
|
|
|
|
* Get the protocol to use in Grist URLs that are intended to be reachable
|
|
|
|
* from a user's browser. Use the protocol in APP_HOME_URL if available,
|
|
|
|
* otherwise X-Forwarded-Proto is set on the provided request, otherwise
|
|
|
|
* the protocol of the request itself.
|
|
|
|
*/
|
|
|
|
export function getEndUserProtocol(req: Request) {
|
|
|
|
if (process.env.APP_HOME_URL) {
|
|
|
|
return new URL(process.env.APP_HOME_URL).protocol.replace(':', '');
|
|
|
|
}
|
|
|
|
return req.get("X-Forwarded-Proto") || req.protocol;
|
|
|
|
}
|
|
|
|
|
(core) move more tests to grist-core
Summary:
* Tie build and run-time docker base images to a consistent version (buster)
* Extend the test login system activated by GRIST_TEST_LOGIN to ease porting tests that currently rely on cognito (many)
* Make org resets work in absence of billing endpoints
* When in-memory session caches are used, add missing invalidation steps
* Pass org information through sign-ups/sign-ins more carefully
* For CORS, explicitly trust GRIST_HOST origin when set
* Move some fixtures and tests to core, focussing on tests that cover existing failures or are in the set of tests run on deployments
* Retain regular `test` target to run the test suite directly, without docker
* Add a `test:smoke` target to run a single simple test without `GRIST_TEST_LOGIN` activated
* Add a `test:docker` target to run the tests against a grist-core docker image - since tests rely on certain fixture teams/docs, added `TEST_SUPPORT_API_KEY` and `TEST_ADD_SAMPLES` flags to ease porting
The tests ported were `nbrowser` tests: `ActionLog.ts` (the first test I tend to port to anything, out of habit), `Fork.ts` (exercises a lot of doc creation paths), `HomeIntro.ts` (a lot of DocMenu exercise), and `DuplicateDocument.ts` (covers a feature known to be failing prior to this diff, the CORS tweak resolves it).
Test Plan: Manually tested via `buildtools/build_core.sh`. In follow up, I want to add running the `test:docker` target in grist-core's workflows. In jenkins, only the smoke test is run. There'd be an argument for running all tests, but they include particularly slow tests, and are duplicates of tests already run (in different configuration admittedly), so I'd like to try first just using them in grist-core to gate updates to any packaged version of Grist (the docker image currently).
Reviewers: alexmojaki
Reviewed By: alexmojaki
Subscribers: alexmojaki
Differential Revision: https://phab.getgrist.com/D3176
2021-12-10 22:42:54 +00:00
|
|
|
/**
|
|
|
|
* In some configurations, session information may be cached by the server.
|
|
|
|
* When session information changes, give the server a chance to clear its
|
|
|
|
* cache if needed.
|
|
|
|
*/
|
|
|
|
export function clearSessionCacheIfNeeded(req: Request, options?: {
|
|
|
|
email?: string,
|
|
|
|
org?: string|null,
|
|
|
|
sessionID?: string,
|
|
|
|
}) {
|
|
|
|
(req as RequestWithGrist).gristServer?.getSessions().clearCacheIfNeeded(options);
|
|
|
|
}
|