Merge branch 'master' into prettier

core/core.js

@@ -103,6 +103,11 @@ let gGlobalSettings = {
 
 let kPingInterval = 60 * 1000;
 
+/**
+ * TODOC
+ * @param {*} out
+ * @param {*} error
+ */
 function printError(out, error) {
 	if (error.stackTrace) {
 		out.print(error.fileName + ':' + error.lineNumber + ': ' + error.message);
@@ -115,6 +120,12 @@ function printError(out, error) {
 	}
 }
 
+/**
+ * TODOC
+ * @param {*} handlers
+ * @param {*} argv
+ * @returns
+ */
 function invoke(handlers, argv) {
 	let promises = [];
 	if (handlers) {
@@ -135,6 +146,12 @@ function invoke(handlers, argv) {
 	return Promise.all(promises);
 }
 
+/**
+ * TODOC
+ * @param {*} eventName
+ * @param {*} argv
+ * @returns
+ */
 function broadcastEvent(eventName, argv) {
 	let promises = [];
 	for (let process of Object.values(gProcesses)) {
@@ -144,7 +161,11 @@ function broadcastEvent(eventName, argv) {
 	}
 	return Promise.all(promises);
 }
-
+/**
+ * TODOC
+ * @param {*} message
+ * @returns
+ */
 function broadcast(message) {
 	let sender = this;
 	let promises = [];
@@ -161,6 +182,12 @@ function broadcast(message) {
 	return Promise.all(promises);
 }
 
+/**
+ * TODOC
+ * @param {*} caller
+ * @param {*} process
+ * @returns
+ */
 function getUser(caller, process) {
 	return {
 		key: process.key,
@@ -171,6 +198,12 @@ function getUser(caller, process) {
 	};
 }
 
+/**
+ * TODOC
+ * @param {*} user
+ * @param {*} process
+ * @returns
+ */
 function getApps(user, process) {
 	if (
 		process.credentials &&
@@ -195,12 +228,26 @@ function getApps(user, process) {
 	return {};
 }
 
+/**
+ * TODOC
+ * @param {*} from
+ * @param {*} to
+ * @param {*} message
+ * @returns
+ */
 function postMessageInternal(from, to, message) {
 	if (to.eventHandlers['message']) {
 		return invoke(to.eventHandlers['message'], [getUser(from, from), message]);
 	}
 }
 
+/**
+ * TODOC
+ * @param {*} blobId
+ * @param {*} session
+ * @param {*} options
+ * @returns
+ */
 async function getSessionProcessBlob(blobId, session, options) {
 	let actualOptions = {timeout: kPingInterval};
 	if (options) {
@@ -211,7 +258,15 @@ async function getSessionProcessBlob(blobId, session, options) {
 	return getProcessBlob(blobId, 'session_' + session, actualOptions);
 }
 
+/**
+ * TODOC
+ * @param {*} blobId
+ * @param {*} key
+ * @param {*} options
+ * @returns
+ */
 async function getProcessBlob(blobId, key, options) {
+	// TODO(tasiaiso): break this down ?
 	let process = gProcesses[key];
 	if (!process && !(options && 'create' in options && !options.create)) {
 		let resolveReady;
@@ -678,6 +733,11 @@ async function getProcessBlob(blobId, key, options) {
 	return process;
 }
 
+/**
+ * TODOC
+ * @param {*} settings
+ * @returns
+ */
 function setGlobalSettings(settings) {
 	gGlobalSettings = settings;
 	try {
@@ -687,6 +747,12 @@ function setGlobalSettings(settings) {
 	}
 }
 
+/**
+ * TODOC
+ * @param {*} data
+ * @param {*} bytes
+ * @returns
+ */
 function startsWithBytes(data, bytes) {
 	if (data.byteLength >= bytes.length) {
 		let dataBytes = new Uint8Array(data.slice(0, bytes.length));
@@ -699,11 +765,21 @@ function startsWithBytes(data, bytes) {
 	}
 }
 
+/**
+ * TODOC
+ * @param {*} path
+ * @returns
+ */
 function guessTypeFromName(path) {
 	let extension = path.split('.').pop();
 	return k_mime_types[extension];
 }
 
+/**
+ * TODOC
+ * @param {*} data
+ * @returns
+ */
 function guessTypeFromMagicBytes(data) {
 	for (let magic of k_magic_bytes) {
 		if (startsWithBytes(data, magic.bytes)) {
@@ -712,6 +788,14 @@ function guessTypeFromMagicBytes(data) {
 	}
 }
 
+/**
+ * TODOC
+ * @param {*} response
+ * @param {*} data
+ * @param {*} type
+ * @param {*} headers
+ * @param {*} status_code
+ */
 function sendData(response, data, type, headers, status_code) {
 	if (data) {
 		response.writeHead(
@@ -741,6 +825,11 @@ function sendData(response, data, type, headers, status_code) {
 	}
 }
 
+/**
+ * TODOC
+ * @param {*} id
+ * @returns
+ */
 async function getBlobOrContent(id) {
 	if (!id) {
 		return;
@@ -752,6 +841,18 @@ async function getBlobOrContent(id) {
 }
 
 let g_handler_index = 0;
+
+/**
+ * TODOC
+ * @param {*} response
+ * @param {*} handler_blob_id
+ * @param {*} path
+ * @param {*} query
+ * @param {*} headers
+ * @param {*} packageOwner
+ * @param {*} packageName
+ * @returns
+ */
 async function useAppHandler(
 	response,
 	handler_blob_id,
@@ -797,7 +898,16 @@ async function useAppHandler(
 	return result;
 }
 
+/**
+ * TODOC
+ * @param {*} request
+ * @param {*} response
+ * @param {*} blobId
+ * @param {*} uri
+ * @returns
+ */
 async function blobHandler(request, response, blobId, uri) {
+	// TODO(tasiaiso): break this down ?
 	for (let i in k_static_files) {
 		if (uri === k_static_files[i].uri && k_static_files[i].path) {
 			let stat = await File.stat('core/' + k_static_files[i].path);
@@ -1079,6 +1189,9 @@ ssb.addEventListener('connections', function () {
 	broadcastEvent('onConnectionsChanged', []);
 });
 
+/**
+ * TODOC
+ */
 async function loadSettings() {
 	let data = {};
 	try {
@@ -1097,6 +1210,9 @@ async function loadSettings() {
 	gGlobalSettings = data;
 }
 
+/**
+ * TODOC
+ */
 function sendStats() {
 	let apps = Object.values(gProcesses)
 		.filter((process) => process.app && process.stats)
@@ -1112,6 +1228,11 @@ function sendStats() {
 	}
 }
 
+/**
+ * TODOC
+ * @param {*} process
+ * @param {*} enabled
+ */
 function enableStats(process, enabled) {
 	process.stats = enabled;
 	if (!gStatsTimer) {
@@ -1120,6 +1241,9 @@ function enableStats(process, enabled) {
 	}
 }
 
+/**
+ * TODOC
+ */
 loadSettings()
 	.then(function () {
 		if (tildefriends.https_port && gGlobalSettings.http_redirect) {
@@ -1213,6 +1337,14 @@ loadSettings()
 		exit(1);
 	});
 
+/**
+ * TODOC
+ * @param {*} user
+ * @param {*} packageOwner
+ * @param {*} packageName
+ * @param {*} permission
+ * @param {*} allow
+ */
 function storePermission(user, packageOwner, packageName, permission, allow) {
 	if (!gGlobalSettings.userPermissions) {
 		gGlobalSettings.userPermissions = {};