smc-hub
Version:
CoCalc: Backend webserver component
362 lines (361 loc) • 18.2 kB
JavaScript
"use strict";
/*
Compute client for use in Kubernetes cluster by the hub.
This **modifies the database** to get "something out there (manage-actions) to"
start and stop the project, copy files between projects, etc.
*/
var __extends = (this && this.__extends) || (function () {
var extendStatics = function (d, b) {
extendStatics = Object.setPrototypeOf ||
({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||
function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };
return extendStatics(d, b);
};
return function (d, b) {
if (typeof b !== "function" && b !== null)
throw new TypeError("Class extends value " + String(b) + " is not a constructor or null");
extendStatics(d, b);
function __() { this.constructor = d; }
d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
};
})();
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (_) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
var base_1 = require("./base");
var database_1 = require("smc-hub/servers/database");
var async_utils_1 = require("smc-util/async-utils");
var misc_1 = require("smc-util/misc");
var logger_1 = __importDefault(require("smc-hub/logger"));
var winston = logger_1.default("project-control-kucalc");
var Project = /** @class */ (function (_super) {
__extends(Project, _super);
function Project(project_id) {
return _super.call(this, project_id) || this;
}
Project.prototype.get = function (columns) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, async_utils_1.callback2(database_1.database.get_project, {
project_id: this.project_id,
columns: columns,
})];
case 1: return [2 /*return*/, _a.sent()];
}
});
});
};
Project.prototype.state = function () {
var _a, _b;
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_c) {
switch (_c.label) {
case 0: return [4 /*yield*/, this.get(["state"])];
case 1: return [2 /*return*/, (_b = (_a = (_c.sent())) === null || _a === void 0 ? void 0 : _a.state) !== null && _b !== void 0 ? _b : {}];
}
});
});
};
Project.prototype.status = function () {
var _a, _b;
return __awaiter(this, void 0, void 0, function () {
var status;
return __generator(this, function (_c) {
switch (_c.label) {
case 0: return [4 /*yield*/, this.get(["status"])];
case 1:
status = (_b = (_a = (_c.sent())) === null || _a === void 0 ? void 0 : _a.status) !== null && _b !== void 0 ? _b : {};
// In KuCalc the ports for various services are hardcoded constants,
// and not actually storted in the database, so we put them here.
// This is also hardcoded in kucalc's addons/project/image/init/init.sh (!)
status["hub-server.port"] = 6000;
status["browser-server.port"] = 6001;
return [2 /*return*/, status];
}
});
});
};
Project.prototype.start = function () {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (this.stateChanging != null)
return [2 /*return*/];
winston.info("start " + this.project_id);
return [4 /*yield*/, this.state()];
case 1:
if ((_a.sent()).state == "running") {
winston.debug("start -- already running");
return [2 /*return*/];
}
_a.label = 2;
case 2:
_a.trys.push([2, , 6, 7]);
this.stateChanging = { state: "starting" };
return [4 /*yield*/, this.siteLicenseHook()];
case 3:
_a.sent();
return [4 /*yield*/, this.actionRequest("start")];
case 4:
_a.sent();
return [4 /*yield*/, this.waitUntilProject(function (project) { var _a, _b; return ((_a = project.state) === null || _a === void 0 ? void 0 : _a.state) == "running" || ((_b = project.action_request) === null || _b === void 0 ? void 0 : _b.finished); }, 120)];
case 5:
_a.sent();
return [3 /*break*/, 7];
case 6:
this.stateChanging = undefined;
return [7 /*endfinally*/];
case 7: return [2 /*return*/];
}
});
});
};
Project.prototype.stop = function () {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (this.stateChanging != null)
return [2 /*return*/];
winston.info("stop ", this.project_id);
return [4 /*yield*/, this.state()];
case 1:
if ((_a.sent()).state != "running") {
return [2 /*return*/];
}
_a.label = 2;
case 2:
_a.trys.push([2, , 5, 6]);
this.stateChanging = { state: "stopping" };
return [4 /*yield*/, this.actionRequest("stop")];
case 3:
_a.sent();
return [4 /*yield*/, this.waitUntilProject(function (project) {
var _a;
return (project.state != null &&
project.state != "running" &&
project.state != "stopping") ||
((_a = project.action_request) === null || _a === void 0 ? void 0 : _a.finished);
}, 60)];
case 4:
_a.sent();
return [3 /*break*/, 6];
case 5:
this.stateChanging = undefined;
return [7 /*endfinally*/];
case 6: return [2 /*return*/];
}
});
});
};
Project.prototype.copyPath = function (opts) {
return __awaiter(this, void 0, void 0, function () {
var dbg, copyID, d, offset;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
dbg = this.dbg("copyPath");
dbg(JSON.stringify(opts));
if (opts.path == null) {
throw Error("path must be specified");
}
opts.target_project_id = opts.target_project_id
? opts.target_project_id
: this.project_id;
opts.target_path = opts.target_path ? opts.target_path : opts.path;
// check UUID are valid
if (!misc_1.is_valid_uuid_string(opts.target_project_id)) {
throw Error("target_project_id=" + opts.target_project_id + " is invalid");
}
copyID = misc_1.uuid();
dbg("copyID=" + copyID);
if (opts.scheduled && opts.scheduled instanceof Date) {
d = new Date(opts.scheduled);
offset = d.getTimezoneOffset() / 60;
opts.scheduled = new Date(d.getTime() - offset);
opts.wait_until_done = false;
dbg("opts.scheduled = " + opts.scheduled);
}
dbg("write query requesting the copy to happen to the database");
return [4 /*yield*/, async_utils_1.callback2(database_1.database._query, {
query: "INSERT INTO copy_paths",
values: {
"id ::UUID": copyID,
"time ::TIMESTAMP": new Date(),
"source_project_id ::UUID": this.project_id,
"source_path ::TEXT": opts.path,
"target_project_id ::UUID": opts.target_project_id,
"target_path ::TEXT": opts.target_path,
"overwrite_newer ::BOOLEAN": opts.overwrite_newer,
"public ::BOOLEAN": opts.public,
"delete_missing ::BOOLEAN": opts.delete_missing,
"backup ::BOOLEAN": opts.backup,
"bwlimit ::TEXT": opts.bwlimit,
"timeout ::NUMERIC": opts.timeout,
"scheduled ::TIMESTAMP": opts.scheduled,
},
})];
case 1:
_a.sent();
if (!(opts.wait_until_done == true)) return [3 /*break*/, 3];
dbg("waiting for the copy request to complete...");
return [4 /*yield*/, this.waitUntilCopyFinished(copyID, 60 * 4)];
case 2:
_a.sent();
dbg("finished");
return [2 /*return*/, ""];
case 3:
dbg("NOT waiting for copy to complete");
return [2 /*return*/, copyID];
}
});
});
};
Project.prototype.getProjectSynctable = function () {
var _this = this;
// this is all in coffeescript, hence the any type above.
return database_1.database.synctable({
table: "projects",
columns: ["state", "action_request"],
where: { "project_id = $::UUID": this.project_id },
// where_function is a fast easy test for matching:
where_function: function (project_id) { return project_id == _this.project_id; },
});
};
Project.prototype.actionRequest = function (action) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, async_utils_1.callback2(database_1.database._query, {
query: "UPDATE projects",
where: { "project_id = $::UUID": this.project_id },
jsonb_set: {
action_request: {
action: action,
time: new Date(),
started: undefined,
finished: undefined,
},
},
})];
case 1:
_a.sent();
return [2 /*return*/];
}
});
});
};
Project.prototype.waitUntilProject = function (until, timeout // in seconds
) {
return __awaiter(this, void 0, void 0, function () {
var synctable;
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
synctable = undefined;
_a.label = 1;
case 1:
_a.trys.push([1, , 3, 4]);
synctable = this.getProjectSynctable();
return [4 /*yield*/, async_utils_1.callback2(synctable.wait, {
until: function () { var _a, _b; return until((_b = (_a = synctable.get(_this.project_id)) === null || _a === void 0 ? void 0 : _a.toJS()) !== null && _b !== void 0 ? _b : {}); },
timeout: timeout,
})];
case 2:
_a.sent();
return [3 /*break*/, 4];
case 3:
synctable === null || synctable === void 0 ? void 0 : synctable.close();
return [7 /*endfinally*/];
case 4: return [2 /*return*/];
}
});
});
};
Project.prototype.getCopySynctable = function (copyID) {
return database_1.database.synctable({
table: "copy_paths",
columns: ["started", "error", "finished"],
where: { "id = $::UUID": copyID },
where_function: function (id) { return id == copyID; },
});
};
Project.prototype.waitUntilCopyFinished = function (copyID, timeout // in seconds
) {
return __awaiter(this, void 0, void 0, function () {
var synctable, err;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
synctable = undefined;
_a.label = 1;
case 1:
_a.trys.push([1, , 3, 4]);
synctable = this.getCopySynctable(copyID);
return [4 /*yield*/, async_utils_1.callback2(synctable.wait, {
until: function () { return synctable.getIn([copyID, "finished"]); },
timeout: timeout,
})];
case 2:
_a.sent();
err = synctable.getIn([copyID, "error"]);
if (err) {
throw Error(err);
}
return [3 /*break*/, 4];
case 3:
synctable === null || synctable === void 0 ? void 0 : synctable.close();
return [7 /*endfinally*/];
case 4: return [2 /*return*/];
}
});
});
};
return Project;
}(base_1.BaseProject));
function get(project_id) {
var _a;
return (_a = base_1.getProject(project_id)) !== null && _a !== void 0 ? _a : new Project(project_id);
}
exports.default = get;
//# sourceMappingURL=kucalc.js.map