2020-07-21 13:20:51 +00:00
|
|
|
import * as log from 'app/server/lib/log';
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Starting to whittle down the options used when creating a sandbox, to leave more
|
|
|
|
* freedom in how the sandbox works.
|
|
|
|
*/
|
|
|
|
export interface ISandboxCreationOptions {
|
|
|
|
comment?: string; // an argument to add in command line when possible, so it shows in `ps`
|
|
|
|
|
|
|
|
logCalls?: boolean;
|
|
|
|
logMeta?: log.ILogMeta;
|
|
|
|
logTimes?: boolean;
|
|
|
|
|
|
|
|
// This batch of options is used by SafePythonComponent, so are important for importers.
|
|
|
|
entryPoint?: string; // main script to call - leave undefined for default
|
|
|
|
sandboxMount?: string; // if defined, make this path available read-only as "/sandbox"
|
|
|
|
importMount?: string; // if defined, make this path available read-only as "/importdir"
|
2021-03-18 22:40:02 +00:00
|
|
|
|
2021-08-26 03:12:34 +00:00
|
|
|
preferredPythonVersion?: '2' | '3';
|
2020-07-21 13:20:51 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
export interface ISandbox {
|
|
|
|
shutdown(): Promise<unknown>; // TODO: tighten up this type.
|
|
|
|
pyCall(funcName: string, ...varArgs: unknown[]): Promise<any>;
|
|
|
|
reportMemoryUsage(): Promise<void>;
|
|
|
|
}
|
|
|
|
|
|
|
|
export interface ISandboxCreator {
|
|
|
|
create(options: ISandboxCreationOptions): ISandbox;
|
|
|
|
}
|