core: refactor environment variable handling in JS

Replace tjs.environ + tjs.getenv + tjs.setenv + tjs.unsetenv with
tjs.env, an object which does all of that under the hood.

Ref: https://github.com/wintercg/proposal-cli-api?tab=readme-ov-file#environment-variables

Author: saghul

docs/types/txikijs.d.ts

@@ -132,41 +132,21 @@ declare global {
 
         /**
         * Object containing environment variables.
+        * Setting and deleting properties on this object causes
+        * environment variables to be set / deleted.
         */
         type Environment = { [index: string]: string };
 
         /**
         * System environment variables.
         */
-        const environ: Environment;
+        const env: Environment;
 
         /**
         * Returns the current system hostname.
         */
         function gethostname(): string;
 
-        /**
-        * Gets the environment variable of the given name.
-        *
-        * @param name Name of the environment variable to get.
-        */
-        function getenv(name: string): string;
-        
-        /**
-        * Sets the given environment variable to the given value.
-        *
-        * @param name Name of the environment variable to be set.
-        * @param value Value to be set to.
-        */
-        function setenv(name: string, value: string): void;
-        
-        /**
-        * Unsets the given environment variable.
-        *
-        * @param name Name of the environment variable to unset.
-        */
-        function unsetenv(name: string): void;
-        
         /**
         * String representation of the current platform.
         */

examples/process.js

@@ -27,7 +27,7 @@ logStatus(status);
 status = await proc.wait();
 logStatus(status);
 
-args = [exe, '-e', 'console.log(JSON.stringify(tjs.environ))'];
+args = [exe, '-e', 'console.log(JSON.stringify(tjs.env))'];
 proc = tjs.spawn(args, { env: { FOO: 'BAR', SPAM: 'EGGS'} });
 console.log(`proc PID: ${proc.pid}`);
 status = await proc.wait();

src/bundles/c/core/core.c

@@ -0,0 +1,35 @@
+const core = globalThis[Symbol.for('tjs.internal.core')];
+
+const env = new Proxy({}, {
+    ownKeys() {
+        return core._envKeys();
+    },
+    get(_, prop) {
+        if (prop === Symbol.toStringTag) {
+            return JSON.stringify(core._environ(), null, 2);
+        } else if (prop === 'toJSON') {
+            return () => core._environ();
+        } else if (typeof prop === 'string') {
+            try {
+                return core._getenv(prop);
+            } catch (_) { /* Ignored. */ }
+        }
+
+        return undefined;
+    },
+    set(_, prop, val) {
+        core._setenv(prop, val);
+
+        return true;
+    },
+    deleteProperty(_, prop) {
+        core._unsetenv(prop);
+
+        return true;
+    },
+    has(_, key) {
+        return key in core._envKeys();
+    }
+});
+
+export default env;

src/bundles/c/core/polyfills.c

@@ -1,6 +1,7 @@
 const core = globalThis[Symbol.for('tjs.internal.core')];
 
 import { alert, confirm, prompt } from './alert-confirm-prompt.js';
+import env from './env.js';
 import { open, mkdir, mkstemp, rm } from './fs.js';
 import pathModule from './path.js';
 import { PosixSocket } from './posix-socket.js';
@@ -29,7 +30,6 @@ const noExport = [
     'XMLHttpRequest',
     'clearInterval',
     'clearTimeout',
-    'environ',
     'evalFile',
     'evalScript',
     'ffi_load_native',
@@ -90,13 +90,6 @@ Object.defineProperty(tjs, 'prompt', {
 });
 
 // Getters.
-Object.defineProperty(tjs, 'environ', {
-    enumerable: true,
-    configurable: false,
-    get() {
-        return core.environ();
-    }
-});
 Object.defineProperty(tjs, 'pid', {
     enumerable: true,
     configurable: false,
@@ -112,6 +105,14 @@ Object.defineProperty(tjs, 'ppid', {
     }
 });
 
+// Environment.
+Object.defineProperty(tjs, 'env', {
+    enumerable: true,
+    configurable: false,
+    writable: false,
+    value: env
+});
+
 // FS.
 Object.defineProperty(tjs, 'open', {
     enumerable: true,

src/bundles/c/core/run-main.c

@@ -195,7 +195,7 @@ const win32 = {
         // absolute path, get cwd for that drive, or the process cwd if
         // the drive cwd is not available. We're sure the device is not
         // a UNC path at this points, because UNC paths are always absolute.
-        path = tjs.environ[`=${resolvedDevice}`] || tjs.cwd();
+        path = tjs.env[`=${resolvedDevice}`] || tjs.cwd();
 
         // Verify that a cwd was found and that it actually points
         // to our drive. If not, default to the drive's root.

src/js/core/env.js

@@ -90,7 +90,7 @@ const kStorageDb = Symbol('kStorageDb');
 function initDb() {
     const path = globalThis[Symbol.for('tjs.internal.modules.path')];
 
-    const TJS_HOME = tjs.environ.TJS_HOME ?? path.join(tjs.homedir(), '.tjs');
+    const TJS_HOME = tjs.env.TJS_HOME ?? path.join(tjs.homedir(), '.tjs');
     const localStorageDb = path.join(TJS_HOME, 'localStorage.sqlite');
     const flags = sqlite3.SQLITE_OPEN_CREATE | sqlite3.SQLITE_OPEN_READWRITE;
 

src/js/core/index.js

@@ -2,7 +2,7 @@
 
 const pathModule = globalThis[Symbol.for('tjs.internal.modules.path')];
 
-const verbose = Boolean(tjs.environ.VERBOSE_TESTS);
+const verbose = Boolean(tjs.env.VERBOSE_TESTS);
 const TIMEOUT = 10 * 1000;
 
 const colors = {
@@ -118,7 +118,7 @@ export async function runTests(d) {
     }
 
     let failed = 0;
-    const testConcurrency = tjs.environ.TJS_TEST_CONCURRENCY ?? tjs.availableParallelism();
+    const testConcurrency = tjs.env.TJS_TEST_CONCURRENCY ?? tjs.availableParallelism();
     const running = new Set();
 
     // eslint-disable-next-line no-constant-condition

src/js/core/path.js

@@ -105,6 +105,25 @@ static JSValue tjs_environ(JSContext *ctx, JSValueConst this_val, int argc, JSVa
     return obj;
 }
 
+static JSValue tjs_envKeys(JSContext *ctx, JSValueConst this_val, int argc, JSValueConst *argv) {
+    uv_env_item_t *env;
+    int envcount, r;
+
+    r = uv_os_environ(&env, &envcount);
+    if (r != 0)
+        return tjs_throw_errno(ctx, r);
+
+    JSValue obj = JS_NewArray(ctx);
+
+    for (int i = 0; i < envcount; i++) {
+        JS_SetPropertyUint32(ctx, obj, i, JS_NewString(ctx, env[i].name));
+    }
+
+    uv_os_free_environ(env, envcount);
+
+    return obj;
+}
+
 static JSValue tjs_getenv(JSContext *ctx, JSValueConst this_val, int argc, JSValueConst *argv) {
     if (!JS_IsString(argv[0]))
         return JS_ThrowTypeError(ctx, "expected a string");
@@ -475,9 +494,11 @@ static const JSCFunctionListEntry tjs_os_funcs[] = {
     TJS_CFUNC_DEF("uname", 0, tjs_uname),
     TJS_CFUNC_DEF("uptime", 0, tjs_uptime),
     TJS_CFUNC_DEF("guessHandle", 1, tjs_guess_handle),
-    TJS_CFUNC_DEF("getenv", 0, tjs_getenv),
-    TJS_CFUNC_DEF("setenv", 2, tjs_setenv),
-    TJS_CFUNC_DEF("unsetenv", 1, tjs_unsetenv),
+    TJS_CFUNC_DEF("_getenv", 0, tjs_getenv),
+    TJS_CFUNC_DEF("_setenv", 2, tjs_setenv),
+    TJS_CFUNC_DEF("_unsetenv", 1, tjs_unsetenv),
+    TJS_CFUNC_DEF("_envKeys", 0, tjs_envKeys),
+    TJS_CFUNC_DEF("_environ", 0, tjs_environ),
     TJS_CFUNC_DEF("chdir", 1, tjs_chdir),
     TJS_CFUNC_DEF("cwd", 0, tjs_cwd),
     TJS_CFUNC_DEF("homedir", 0, tjs_homedir),
@@ -487,7 +508,6 @@ static const JSCFunctionListEntry tjs_os_funcs[] = {
     TJS_CFUNC_DEF("loadavg", 0, tjs_loadavg),
     TJS_CFUNC_DEF("networkInterfaces", 0, tjs_network_interfaces),
     TJS_CFUNC_DEF("gethostname", 0, tjs_gethostname),
-    TJS_CFUNC_DEF("environ", 0, tjs_environ),
     TJS_CFUNC_DEF("getPid", 0, tjs_getpid),
     TJS_CFUNC_DEF("getPpid", 0, tjs_getppid),
     TJS_CFUNC_DEF("userInfo", 0, tjs_userInfo),

src/js/polyfills/storage.js

@@ -1,18 +1,9 @@
 import assert from 'tjs:assert';
 
 
-assert.throws(() => { tjs.getenv() }, Error, 'must pass a string');
-assert.throws(() => { tjs.getenv(1234) }, Error, 'must pass a string');
-assert.ok(tjs.getenv('PATH'));
-
-assert.throws(() => { tjs.setenv() }, Error, 'must pass a string');
-assert.throws(() => { tjs.setenv('FOO') }, Error, 'must pass a string');
-tjs.setenv('FOO', 123);
-assert.eq(tjs.environ.FOO, '123');
-tjs.setenv('FOO', 'BAR');
-assert.eq(tjs.environ.FOO, 'BAR');
-
-assert.throws(() => { tjs.unsetenv() }, Error, 'must pass a string');
-assert.throws(() => { tjs.unsetenv(1234) }, Error, 'must pass a string');
-tjs.unsetenv('FOO');
-assert.eq(tjs.environ.FOO, undefined);
+tjs.env.FOO = 123;
+assert.eq(tjs.env.FOO, '123');
+tjs.env.FOO = 'BAR';
+assert.eq(tjs.env.FOO, 'BAR');
+delete tjs.env.FOO;
+assert.eq(tjs.env.FOO, undefined);

src/js/run-main/run-tests.js

@@ -2,7 +2,7 @@ import assert from 'tjs:assert';
 import path from 'tjs:path';
 
 
-if (tjs.environ.TJS_HOME) {
+if (tjs.env.TJS_HOME) {
     // This is the second test.
     assert.eq(window.localStorage.getItem('foo'), '123');