@yuneta/gobj-js 7.26.27 → 7.26.29

package/README.md

@@ -460,7 +460,10 @@ gobj_create_volatil(name, gclass_name, attrs, parent)
 gobj_create_pure_child(name, gclass_name, attrs, parent)
 
 // Start / Stop
-gobj_start(gobj)           // calls mt_start
+gobj_start(gobj)           // calls mt_start; -1 with an ERROR if a
+                           // SDF_REQUIRED attr is empty, as in C
+                           // (BREAKING in 7.26.28: "" string, empty_json()
+                           // list/dict/json, null pointer)
 gobj_stop(gobj)            // calls mt_stop
 gobj_start_children(gobj)
 gobj_stop_children(gobj)
@@ -599,6 +602,9 @@ gobj_search_path(gobj, path)
 
 gobj_walk_gobj_children(gobj, walk_type, cb_walking, user_data, user_data2)
 gobj_walk_gobj_children_tree(gobj, walk_type, cb_walking, user_data, user_data2)
+// A callback may destroy or move (gobj_change_parent()) any gobj: a
+// destroyed one is never handed, a moved one is handed where the walk
+// finds it now, and no gobj is handed twice in one walk (7.26.28).
 ```
 
 ### Persistence
@@ -740,11 +746,16 @@ kw_remove_local_storage_value(key)
 //   kw_set_local_storage_value("k", () => 1)     → -1
 //   kw_set_local_storage_value("k", {w: NaN})    → -1 (it was {"w":null})
 //   kw_set_local_storage_value("k", [1, , 3])    → -1 (a hole: [1,null,3])
+// A full store (read, not written) with `create`: the default, warned
+// once per key (7.26.28: an ERROR on every read).
 
 // Misc utilities
 current_timestamp()          // ISO string
 get_now()                    // Date object
-node_uuid()                  // generate UUID
+node_uuid()                  // uuid of this browser, the SAME for the
+                             // life of the page (kept in localStorage
+                             // "host_uuid"; a page uuid if the store
+                             // cannot keep it; never null: 7.26.28)
 parseBoolean(v)              // coerce to boolean
 empty_string(s)              // true if null/undefined/""
 str_in_list(list, str, ci)   // case-insensitive optional
@@ -1106,7 +1117,8 @@ count as reached: the backoff goes on from where it was (7.26.25), so a server
 that breaks every session is not reconnected at the first delay for ever -- unless
 the session outlived `timeout_retry_max`: a session that long was served, and its
 fault starts the backoff over, as a clean end does (7.26.26). For the old fixed-interval behaviour set `timeout_retry_max` equal to
-`timeout_retry`. The first delay is **at least 1000 ms** (7.26.27): a lower
+`timeout_retry`. The BASE of the first delay is **at least 1000 ms** (7.26.27;
+the ±20% jitter puts the first delay itself between 800 and 1200 ms): a lower
 `timeout_retry` is raised to 1000 with one WARNING, because 0 never doubled
 away from 0 and a server that closes before the ack was reconnected in a loop
 with no wait, hundreds of times a second.

package/dist/gobj-js.cjs.js

@@ -1949,6 +1949,31 @@ function gobj_destroy_children(gobj) {
 	}
 }
 /************************************************************
+*  The SDF_REQUIRED attributes with no value, or null when there
+*  is none: what is empty is asked type by type, as in C.
+************************************************************/
+function gobj_check_required_attrs(gobj) {
+	const hs = gobj_hsdata(gobj);
+	const missing = [];
+	if (!is_array(gobj.gclass.attrs_table)) return null;
+	for (const it of gobj.gclass.attrs_table) {
+		if (!it.name || !(it.flag & sdata_flag_t.SDF_REQUIRED)) continue;
+		const value = hs[it.name];
+		switch (it.type) {
+			case data_type_t.DTP_STRING:
+				if (!is_string(value) || empty_string(value)) missing.push(it.name);
+				break;
+			case data_type_t.DTP_LIST:
+			case data_type_t.DTP_DICT:
+			case data_type_t.DTP_JSON:
+				if (empty_json(value)) missing.push(it.name);
+				break;
+			case data_type_t.DTP_POINTER: if (!value) missing.push(it.name);
+		}
+	}
+	return missing.length ? missing : null;
+}
+/************************************************************
 *
 ************************************************************/
 function gobj_start(gobj) {
@@ -1964,6 +1989,11 @@ function gobj_start(gobj) {
 		log_error(`${gobj_short_name(gobj)}: GObj DISABLED`);
 		return -1;
 	}
+	const required_attrs = gobj_check_required_attrs(gobj);
+	if (required_attrs) {
+		log_error(`${gobj_short_name(gobj)}: Cannot start without all required attributes: ` + JSON.stringify(required_attrs));
+		return -1;
+	}
 	if (__trace_gobj_start_stop__(gobj)) trace_machine(sprintf("⏺ ⏺ start: %s", gobj_full_name(gobj)));
 	gobj.running = true;
 	let ret = 0;
@@ -2121,7 +2151,8 @@ function gobj_play(gobj) {
 	if (!gobj_is_running(gobj)) {
 		if (!(gobj.gclass.gclass_flag & gclass_flag_t.gcflag_required_start_to_play)) {
 			log_warning(`${gobj_short_name(gobj)}: GObj playing without previous start`);
-			gobj_start(gobj);
+			if (start_destroys_it(gobj)) return -1;
+			if (!gobj.running) return -1;
 		} else {
 			log_error(`${gobj_short_name(gobj)}: Cannot play, start not done`);
 			return -1;
@@ -2350,7 +2381,7 @@ function gobj_walk_gobj_children(gobj, walk_type, cb_walking, user_data, user_da
 		log_error(`gobj NULL, destroying, or bad type`);
 		return 0;
 	}
-	return rc_walk_by_list(gobj.dl_children, walk_type, cb_walking, user_data, user_data2);
+	return rc_walk_by_list(gobj, /* @__PURE__ */ new Set(), walk_type, cb_walking, user_data, user_data2);
 }
 /***************************************************************************
 *
@@ -2360,7 +2391,7 @@ function gobj_walk_gobj_children_tree(gobj, walk_type, cb_walking, user_data, us
 		log_error(`gobj NULL, destroying, or bad type`);
 		return 0;
 	}
-	return rc_walk_by_tree(gobj.dl_children, walk_type, cb_walking, user_data, user_data2);
+	return rc_walk_by_tree(gobj, /* @__PURE__ */ new Set(), walk_type, cb_walking, user_data, user_data2);
 }
 /***************************************************************
 *  Walking
@@ -2387,18 +2418,33 @@ function walk_ret(ret) {
 	log_error(`walk callback must return a NUMBER (-1 stop, 0 descend, >0 skip children), got ${typeof ret}: taken as 0`);
 	return 0;
 }
-function rc_walk_by_list(iter_, walk_type, cb_walking, user_data, user_data2) {
-	let iter = [...iter_];
+/***************************************************************
+*  Whether a walk steps over this gobj of the list of `owner`.
+*
+*  Each list is walked over a COPY of it, because a callback may destroy
+*  any gobj of the list, the current one included, or move one with
+*  gobj_change_parent(). One it destroyed is stepped over, as the C walk
+*  does; one it moved is no longer in this list, and is handed where the
+*  walk finds it now (7.26.27 handed it here AND there); and a gobj is
+*  never handed twice in one walk (`seen`), wherever it was moved.
+***************************************************************/
+function walk_steps_over(child, owner, seen) {
+	return gobj_is_destroying(child) || child.parent !== owner || seen.has(child);
+}
+function rc_walk_by_list(owner, seen, walk_type, cb_walking, user_data, user_data2) {
+	let iter = [...owner.dl_children];
 	let child;
 	if (walk_type & walk_type_t.WALK_LAST2FIRST) for (let i = iter.length; i > 0; i--) {
 		child = iter[i - 1];
-		if (gobj_is_destroying(child)) continue;
+		if (walk_steps_over(child, owner, seen)) continue;
+		seen.add(child);
 		let ret = walk_ret(cb_walking(child, user_data, user_data2));
 		if (ret < 0) return ret;
 	}
 	else for (let i = 0; i < iter.length; i++) {
 		child = iter[i];
-		if (gobj_is_destroying(child)) continue;
+		if (walk_steps_over(child, owner, seen)) continue;
+		seen.add(child);
 		let ret = walk_ret(cb_walking(child, user_data, user_data2));
 		if (ret < 0) return ret;
 	}
@@ -2413,24 +2459,23 @@ function rc_walk_by_list(iter_, walk_type, cb_walking, user_data, user_data2) {
 *          or
 *          WALK_LAST2FIRST
 ***************************************************************/
-function rc_walk_by_level(iter_, walk_type, cb_walking, user_data, user_data2) {
-	let iter = [...iter_];
-	let ret = rc_walk_by_list(iter, walk_type, cb_walking, user_data, user_data2);
-	if (ret < 0) return ret;
-	let child;
-	if (walk_type & walk_type_t.WALK_LAST2FIRST) for (let i = iter.length; i > 0; i--) {
-		child = iter[i - 1];
-		if (gobj_is_destroying(child)) continue;
-		ret = rc_walk_by_level(child.dl_children, walk_type, cb_walking, user_data, user_data2);
+function rc_walk_by_level(owner, seen, walk_type, cb_walking, user_data, user_data2) {
+	let iter = [...owner.dl_children];
+	if (walk_type & walk_type_t.WALK_LAST2FIRST) iter.reverse();
+	let handed = [];
+	for (const child of iter) {
+		if (walk_steps_over(child, owner, seen)) continue;
+		seen.add(child);
+		handed.push(child);
+		let ret = walk_ret(cb_walking(child, user_data, user_data2));
 		if (ret < 0) return ret;
 	}
-	else for (let i = 0; i < iter.length; i++) {
-		child = iter[i];
+	for (const child of handed) {
 		if (gobj_is_destroying(child)) continue;
-		ret = rc_walk_by_level(child.dl_children, walk_type, cb_walking, user_data, user_data2);
+		let ret = rc_walk_by_level(child, seen, walk_type, cb_walking, user_data, user_data2);
 		if (ret < 0) return ret;
 	}
-	return ret;
+	return 0;
 }
 /***************************************************************
 *  Walking
@@ -2447,27 +2492,29 @@ function rc_walk_by_level(iter_, walk_type, cb_walking, user_data, user_data2) {
 *          or
 *          WALK_LAST2FIRST
 ***************************************************************/
-function rc_walk_by_tree(iter_, walk_type, cb_walking, user_data, user_data2) {
-	if (walk_type & walk_type_t.WALK_BYLEVEL) return rc_walk_by_level(iter_, walk_type, cb_walking, user_data, user_data2);
-	let iter = [...iter_];
+function rc_walk_by_tree(owner, seen, walk_type, cb_walking, user_data, user_data2) {
+	if (walk_type & walk_type_t.WALK_BYLEVEL) return rc_walk_by_level(owner, seen, walk_type, cb_walking, user_data, user_data2);
+	let iter = [...owner.dl_children];
 	let ret;
 	let child;
 	if (walk_type & walk_type_t.WALK_BOTTOM2TOP) for (let i = iter.length; i > 0; i--) {
 		child = iter[i - 1];
-		if (gobj_is_destroying(child)) continue;
-		ret = rc_walk_by_tree(child.dl_children, walk_type, cb_walking, user_data, user_data2);
+		if (walk_steps_over(child, owner, seen)) continue;
+		ret = rc_walk_by_tree(child, seen, walk_type, cb_walking, user_data, user_data2);
 		if (ret < 0) return ret;
 		if (gobj_is_destroying(child)) continue;
+		seen.add(child);
 		ret = walk_ret(cb_walking(child, user_data, user_data2));
 		if (ret < 0) return ret;
 	}
 	else for (let i = 0; i < iter.length; i++) {
 		child = iter[i];
-		if (gobj_is_destroying(child)) continue;
+		if (walk_steps_over(child, owner, seen)) continue;
+		seen.add(child);
 		ret = walk_ret(cb_walking(child, user_data, user_data2));
 		if (ret < 0) return ret;
 		else if (ret === 0 && !gobj_is_destroying(child)) {
-			ret = rc_walk_by_tree(child.dl_children, walk_type, cb_walking, user_data, user_data2);
+			ret = rc_walk_by_tree(child, seen, walk_type, cb_walking, user_data, user_data2);
 			if (ret < 0) return ret;
 		}
 	}
@@ -2930,12 +2977,20 @@ function gobj_current_state(gobj) {
 function gobj_change_parent(gobj, parent) {
 	if (gobj_is_destroying(gobj)) {
 		log_error("gobj NULL or DESTROYED");
-		return null;
+		return -1;
 	}
 	if (!(parent instanceof GObj)) {
 		log_error(`${gobj_short_name(gobj)}: gobj_change_parent() BAD TYPE of parent`);
 		return -1;
 	}
+	if (gobj_is_destroying(parent)) {
+		log_error(`${gobj_short_name(gobj)}: gobj_change_parent() parent NULL or DESTROYED`);
+		return -1;
+	}
+	for (let p = parent; p; p = p.parent) if (p === gobj) {
+		log_error(`${gobj_short_name(gobj)}: gobj_change_parent() a gobj cannot be its own ancestor: ${gobj_short_name(parent)}`);
+		return -1;
+	}
 	if (gobj.parent && gobj.parent.gclass.gmt.mt_child_removed) gobj.parent.gclass.gmt.mt_child_removed(gobj.parent, gobj);
 	if (gobj.parent) {
 		_remove_child(gobj.parent, gobj);
@@ -6100,7 +6155,10 @@ function warn_local_storage_once(key, msg) {
 *  for ever; a new corrupt entry is a new WARNING. Its text is never
 *  shown (JSON.parse() quotes it in its error, and an entry can hold a
 *  token). A store that cannot be read (blocked) is warned once per
-*  key, and the default is NOT written there. Outside a browser: the
+*  key, and the default is NOT written there; one that cannot be
+*  written (full) is warned once per key too: with `create` it was an
+*  ERROR on every read, the default tried again each time. A key is
+*  warned again after a read that goes well. Outside a browser: the
 *  default.
 ********************************************/
 function kw_get_local_storage_value(key, default_value, create = false) {
@@ -6114,6 +6172,7 @@ function kw_get_local_storage_value(key, default_value, create = false) {
 		warn_local_storage_once(key, `${where} cannot be read (storage blocked?): the default is used`);
 		return default_value;
 	}
+	let went_well = true;
 	let value = null;
 	if (text !== null) try {
 		value = JSON.parse(text);
@@ -6122,17 +6181,25 @@ function kw_get_local_storage_value(key, default_value, create = false) {
 		try {
 			store.removeItem(key);
 			log_warning(`${where} does not hold json: removed, the default is used`);
-			local_storage_warned.delete(key);
 		} catch (e2) {
+			went_well = false;
 			warn_local_storage_once(key, `${where} does not hold json and cannot be removed: the default is used`);
 		}
-		text = void 0;
 	}
-	if (text !== void 0) local_storage_warned.delete(key);
 	if (value === null) {
-		if (create) kw_set_local_storage_value(key, default_value);
-		return default_value;
+		value = default_value;
+		if (create) {
+			const default_text = json_text_of(default_value);
+			if (default_text === void 0) log_error(`${where}: cannot write the default: a value with no json text`);
+			else try {
+				store.setItem(key, default_text);
+			} catch (e) {
+				went_well = false;
+				warn_local_storage_once(key, `${where} cannot be written (storage full or blocked?): the default is used, not kept`);
+			}
+		}
 	}
+	if (went_well) local_storage_warned.delete(key);
 	return value;
 }
 /********************************************
@@ -7372,29 +7439,68 @@ function index_in_list(list, elm) {
 	return -1;
 }
 /************************************************************
+*  A new uuid v4 (RFC 9562).
+*
+*  crypto.randomUUID() exists only in a secure context, so a page
+*  served over http without TLS has none; crypto.getRandomValues()
+*  exists there too. With no crypto at all, Math.random(): not fit
+*  for a secret, and a uuid that names a node is not one.
+************************************************************/
+function new_uuid() {
+	const c = typeof window !== "undefined" && window.crypto || globalThis.crypto;
+	if (c && typeof c.randomUUID === "function") return c.randomUUID();
+	const b = /* @__PURE__ */ new Uint8Array(16);
+	if (c && typeof c.getRandomValues === "function") c.getRandomValues(b);
+	else for (let i = 0; i < b.length; i++) b[i] = Math.floor(Math.random() * 256);
+	b[6] = b[6] & 15 | 64;
+	b[8] = b[8] & 63 | 128;
+	const h = Array.from(b, (x) => x.toString(16).padStart(2, "0")).join("");
+	return `${h.slice(0, 8)}-${h.slice(8, 12)}-${h.slice(12, 16)}-${h.slice(16, 20)}-${h.slice(20)}`;
+}
+/************************************************************
+*  The uuid of this node: ONE for the life of the page.
 *
+*  The one the store keeps ("host_uuid"), made and written there when
+*  there is none. When the store cannot keep it (blocked, full, no
+*  localStorage, outside a browser) the one this page made, warned
+*  once. It goes in the node_uuid attribute of the yuno, the id of the
+*  identity card and the `host` of every message the client sends, so
+*  the first answer is kept and answered again: 7.26.27 made a new
+*  uuid on every call when the store could not keep it, and answered
+*  null without crypto.randomUUID(). A stored value that is not a
+*  uuid (a foreign or corrupt write) is replaced, with a WARNING.
 ************************************************************/
+var uuid_of_this_page = null;
+var UUID_SHAPE = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/i;
 function node_uuid() {
-	let uuid = "";
+	if (uuid_of_this_page) return uuid_of_this_page;
 	const store = local_store();
-	if (store) {
+	if (!store) {
+		uuid_of_this_page = new_uuid();
+		return uuid_of_this_page;
+	}
+	let uuid = null;
+	try {
+		uuid = store.getItem("host_uuid");
+	} catch (e) {
+		warn_local_storage_once("host_uuid", "node_uuid(): localStorage cannot be read (storage blocked?): a uuid of this page only");
+		uuid_of_this_page = new_uuid();
+		return uuid_of_this_page;
+	}
+	if (uuid && !UUID_SHAPE.test(uuid)) {
+		log_warning("node_uuid(): the stored host_uuid is not a uuid: a new one replaces it");
+		uuid = null;
+	}
+	if (!uuid) {
+		uuid = new_uuid();
 		try {
-			uuid = store.getItem("host_uuid");
+			store.setItem("host_uuid", uuid);
 		} catch (e) {
-			uuid = null;
-			warn_local_storage_once("host_uuid", "node_uuid(): localStorage cannot be read (storage blocked?): a uuid of this page only");
-		}
-		if (!uuid && window.crypto?.randomUUID) {
-			uuid = window.crypto.randomUUID();
-			try {
-				store.setItem("host_uuid", uuid);
-			} catch (e) {
-				warn_local_storage_once("host_uuid", "node_uuid(): localStorage cannot be written (storage full or blocked?): a uuid of this page only");
-			}
+			warn_local_storage_once("host_uuid", "node_uuid(): localStorage cannot be written (storage full or blocked?): a uuid of this page only");
 		}
-	} else if (typeof globalThis !== "undefined" && globalThis.crypto?.randomUUID) uuid = globalThis.crypto.randomUUID();
-	else uuid = "00000000-0000-0000-0000-000000000000";
-	return uuid;
+	}
+	uuid_of_this_page = uuid;
+	return uuid_of_this_page;
 }
 /************************************************************
 *   Build a cleaned name
@@ -8679,7 +8785,7 @@ var attrs_table = [
 	SDATA(data_type_t.DTP_STRING, "cert_pem", sdata_flag_t.SDF_PERSIST, "", "SSL server certification, PEM str format"),
 	SDATA(data_type_t.DTP_JSON, "extra_info", sdata_flag_t.SDF_RD, "{}", "dict data set by user, added to the identity card msg."),
 	SDATA(data_type_t.DTP_LIST, "required_services", sdata_flag_t.SDF_RD, "[]", "Services this LINK requires (identity card). Empty = the yuno's `required_services`, as before. A yuno with several links to DIFFERENT backends must set it per link: the yuno-wide list is the union, so every backend is told the service names of all the others."),
-	SDATA(data_type_t.DTP_INTEGER, "timeout_retry", sdata_flag_t.SDF_RD, "5000", "First reconnect delay (ms), at least 1000. It BACKS OFF from here, doubling up to timeout_retry_max, and resets when a session is reached"),
+	SDATA(data_type_t.DTP_INTEGER, "timeout_retry", sdata_flag_t.SDF_RD, "5000", "Base of the first reconnect delay (ms, ±20% jitter), at least 1000. It BACKS OFF from here, doubling up to timeout_retry_max, and resets when a session is reached"),
 	SDATA(data_type_t.DTP_INTEGER, "timeout_retry_max", sdata_flag_t.SDF_RD, "60000", "Cap of the reconnect backoff (ms). Set it equal to timeout_retry for the old fixed-interval behaviour"),
 	SDATA(data_type_t.DTP_INTEGER, "timeout_idack", sdata_flag_t.SDF_RD, "5000", "timeout waiting idAck"),
 	SDATA(data_type_t.DTP_POINTER, "subscriber", 0, 0, "subscriber of output-events. If null then subscriber is the parent"),