@gjsify/fetch 0.4.29 → 0.4.31

package/lib/esm/request.js

@@ -1 +1 @@
-import"./_virtual/_rolldown/runtime.js";import{isAbortSignal as e}from"./utils/is.js";import t,{clone as n,extractContentType as r,getTotalBytes as i}from"./body.js";import a from"./headers.js";import{inputStreamToReadable as o,soupSendAsync as s}from"./utils/soup-helpers.js";import{DEFAULT_REFERRER_POLICY as c,determineRequestsReferrer as l,validateReferrerPolicy as u}from"./utils/referrer.js";import{URL as d}from"@gjsify/url";import f from"@girs/soup-3.0";import p from"@girs/glib-2.0";import m from"@girs/gio-2.0";const h=Symbol(`Request internals`),isRequest=e=>typeof e==`object`&&typeof e.url==`string`;var g=class Request extends t{cache;credentials;destination;get headers(){return this[h].headers}integrity;keepalive;get method(){return this[h].method}mode;get redirect(){return this[h].redirect}get referrer(){if(this[h].referrer===`no-referrer`)return``;if(this[h].referrer===`client`)return`about:client`;if(this[h].referrer)return this[h].referrer.toString()}get referrerPolicy(){return this[h].referrerPolicy}set referrerPolicy(e){this[h].referrerPolicy=u(e)}get signal(){return this[h].signal}get url(){return this[h].parsedURL.toString()}get _uri(){return p.Uri.parse(this.url,p.UriFlags.NONE)}get _session(){return this[h].session}get _message(){return this[h].message}get _inputStream(){return this[h].inputStream}get[Symbol.toStringTag](){return`Request`}[h];follow;compress=!1;counter=0;agent=``;highWaterMark=16384;insecureHTTPParser=!1;constructor(t,i){let o=t,s=i||{},c,l={};if(isRequest(t)?(c=new d(o.url),l=o):c=new d(t),c.username!==``||c.password!==``)throw TypeError(`${c} is an url with embedded credentials.`);let u=s.method||l.method||`GET`;if(/^(delete|get|head|options|post|put)$/i.test(u)&&(u=u.toUpperCase()),(i?.body!=null||isRequest(t)&&o.body!==null)&&(u===`GET`||u===`HEAD`))throw TypeError(`Request with GET/HEAD method cannot have body`);let m=i?.body?i.body:isRequest(t)&&o.body!==null?n(t):null;super(m,{size:s.size||0});let g=new a(i?.headers||o.headers||{});if(m!==null&&!g.has(`Content-Type`)){let e=r(m,this);e&&g.set(`Content-Type`,e)}let _=isRequest(t)?o.signal:null;if(i&&`signal`in i&&(_=i.signal),_!=null&&!e(_))throw TypeError(`Expected signal to be an instanceof AbortSignal or EventTarget`);let v=i?.referrer==null?o.referrer:i.referrer;if(v===``)v=`no-referrer`;else if(v){let e=new d(v);v=/^about:(\/\/)?client$/.test(e.toString())?`client`:e}else v=void 0;let y=c.protocol,b=null,x=null;(y===`http:`||y===`https:`)&&(b=new f.Session,x=new f.Message({method:u,uri:p.Uri.parse(c.toString(),p.UriFlags.NONE)})),this[h]={method:u,redirect:i?.redirect||o.redirect||`follow`,headers:g,parsedURL:c,signal:_,referrer:v,referrerPolicy:``,session:b,message:x},this.follow=s.follow===void 0?o.follow===void 0?20:o.follow:s.follow,this.compress=s.compress===void 0?o.compress===void 0?!0:o.compress:s.compress,this.counter=s.counter||o.counter||0,this.agent=s.agent||o.agent,this.highWaterMark=s.highWaterMark||o.highWaterMark||16384,this.insecureHTTPParser=s.insecureHTTPParser||o.insecureHTTPParser||!1,this.referrerPolicy=i?.referrerPolicy||o.referrerPolicy||``}async _send(e){let{session:t,message:n}=this[h];if(!t||!n)throw Error(`Cannot send request: no Soup session (non-HTTP URL?)`);try{t.remove_feature_by_type(f.ContentDecoder.$gtype)}catch{}e.headers._appendToSoupMessage(n);let r=this._rawBodyBuffer;if(r!==null&&r.byteLength>0){let t=e.headers.get(`content-type`)||null;n.set_request_body_from_bytes(t,new p.Bytes(r))}let i=new m.Cancellable;return this[h].inputStream=await s(t,n,p.PRIORITY_DEFAULT,i),this[h].readable=o(this[h].inputStream),{inputStream:this[h].inputStream,readable:this[h].readable,cancellable:i}}clone(){return new Request(this)}async arrayBuffer(){return super.arrayBuffer()}async blob(){return super.blob()}async formData(){return super.formData()}async json(){return super.json()}async text(){return super.text()}};Object.defineProperties(g.prototype,{method:{enumerable:!0},url:{enumerable:!0},headers:{enumerable:!0},redirect:{enumerable:!0},clone:{enumerable:!0},signal:{enumerable:!0},referrer:{enumerable:!0},referrerPolicy:{enumerable:!0}});const getSoupRequestOptions=e=>{let{parsedURL:t}=e[h],n=new a(e[h].headers);n.has(`Accept`)||n.set(`Accept`,`*/*`);let r=null;if(e.body===null&&/^(post|put)$/i.test(e.method)&&(r=`0`),e.body!==null){let t=i(e);typeof t==`number`&&!Number.isNaN(t)&&(r=String(t))}r&&n.set(`Content-Length`,r),e.referrerPolicy===``&&(e.referrerPolicy=c),e.referrer&&e.referrer!==`no-referrer`?e[h].referrer=l(e):e[h].referrer=`no-referrer`,e[h].referrer instanceof d&&n.set(`Referer`,e.referrer),n.has(`User-Agent`)||n.set(`User-Agent`,`gjsify-fetch`),e.compress&&!n.has(`Accept-Encoding`)&&n.set(`Accept-Encoding`,`gzip, deflate`);let{agent:o}=e;return typeof o==`function`&&(o=o(t)),!n.has(`Connection`)&&!o&&n.set(`Connection`,`close`),{parsedURL:t,options:{headers:n}}};export{g as Request,g as default,getSoupRequestOptions};
+import"./_virtual/_rolldown/runtime.js";import{isAbortSignal as e}from"./utils/is.js";import t,{clone as n,extractContentType as r,getTotalBytes as i}from"./body.js";import a from"./headers.js";import{inputStreamToReadable as o,soupSendAsync as s}from"./utils/soup-helpers.js";import{DEFAULT_REFERRER_POLICY as c,determineRequestsReferrer as l,validateReferrerPolicy as u}from"./utils/referrer.js";import{URL as d}from"@gjsify/url";import f from"@girs/soup-3.0";import p from"@girs/glib-2.0";import m from"@girs/gio-2.0";const h=Symbol(`Request internals`);let g=null;function getSharedSession(){if(g===null){g=new f.Session;try{g.remove_feature_by_type(f.ContentDecoder.$gtype)}catch{}}return g}const isRequest=e=>typeof e==`object`&&typeof e.url==`string`;var _=class Request extends t{cache;credentials;destination;get headers(){return this[h].headers}integrity;keepalive;get method(){return this[h].method}mode;get redirect(){return this[h].redirect}get referrer(){if(this[h].referrer===`no-referrer`)return``;if(this[h].referrer===`client`)return`about:client`;if(this[h].referrer)return this[h].referrer.toString()}get referrerPolicy(){return this[h].referrerPolicy}set referrerPolicy(e){this[h].referrerPolicy=u(e)}get signal(){return this[h].signal}get url(){return this[h].parsedURL.toString()}get _uri(){return p.Uri.parse(this.url,p.UriFlags.NONE)}get _session(){return this[h].session}get _message(){return this[h].message}get _inputStream(){return this[h].inputStream}get[Symbol.toStringTag](){return`Request`}[h];follow;compress=!1;counter=0;agent=``;highWaterMark=16384;insecureHTTPParser=!1;constructor(t,i){let o=t,s=i||{},c,l={};if(isRequest(t)?(c=new d(o.url),l=o):c=new d(t),c.username!==``||c.password!==``)throw TypeError(`${c} is an url with embedded credentials.`);let u=s.method||l.method||`GET`;if(/^(delete|get|head|options|post|put)$/i.test(u)&&(u=u.toUpperCase()),(i?.body!=null||isRequest(t)&&o.body!==null)&&(u===`GET`||u===`HEAD`))throw TypeError(`Request with GET/HEAD method cannot have body`);let m=i?.body?i.body:isRequest(t)&&o.body!==null?n(t):null;super(m,{size:s.size||0});let g=new a(i?.headers||o.headers||{});if(m!==null&&!g.has(`Content-Type`)){let e=r(m,this);e&&g.set(`Content-Type`,e)}let _=isRequest(t)?o.signal:null;if(i&&`signal`in i&&(_=i.signal),_!=null&&!e(_))throw TypeError(`Expected signal to be an instanceof AbortSignal or EventTarget`);let v=i?.referrer==null?o.referrer:i.referrer;if(v===``)v=`no-referrer`;else if(v){let e=new d(v);v=/^about:(\/\/)?client$/.test(e.toString())?`client`:e}else v=void 0;let y=c.protocol,b=null,x=null;(y===`http:`||y===`https:`)&&(b=getSharedSession(),x=new f.Message({method:u,uri:p.Uri.parse(c.toString(),p.UriFlags.NONE)})),this[h]={method:u,redirect:i?.redirect||o.redirect||`follow`,headers:g,parsedURL:c,signal:_,referrer:v,referrerPolicy:``,session:b,message:x},this.follow=s.follow===void 0?o.follow===void 0?20:o.follow:s.follow,this.compress=s.compress===void 0?o.compress===void 0?!0:o.compress:s.compress,this.counter=s.counter||o.counter||0,this.agent=s.agent||o.agent,this.highWaterMark=s.highWaterMark||o.highWaterMark||16384,this.insecureHTTPParser=s.insecureHTTPParser||o.insecureHTTPParser||!1,this.referrerPolicy=i?.referrerPolicy||o.referrerPolicy||``}async _send(e){let{session:t,message:n}=this[h];if(!t||!n)throw Error(`Cannot send request: no Soup session (non-HTTP URL?)`);e.headers._appendToSoupMessage(n);let r=this._rawBodyBuffer;if(r!==null&&r.byteLength>0){let t=e.headers.get(`content-type`)||null;n.set_request_body_from_bytes(t,new p.Bytes(r))}let i=new m.Cancellable;return this[h].inputStream=await s(t,n,p.PRIORITY_DEFAULT,i),this[h].readable=o(this[h].inputStream),{inputStream:this[h].inputStream,readable:this[h].readable,cancellable:i}}clone(){return new Request(this)}async arrayBuffer(){return super.arrayBuffer()}async blob(){return super.blob()}async formData(){return super.formData()}async json(){return super.json()}async text(){return super.text()}};Object.defineProperties(_.prototype,{method:{enumerable:!0},url:{enumerable:!0},headers:{enumerable:!0},redirect:{enumerable:!0},clone:{enumerable:!0},signal:{enumerable:!0},referrer:{enumerable:!0},referrerPolicy:{enumerable:!0}});const getSoupRequestOptions=e=>{let{parsedURL:t}=e[h],n=new a(e[h].headers);n.has(`Accept`)||n.set(`Accept`,`*/*`);let r=null;if(e.body===null&&/^(post|put)$/i.test(e.method)&&(r=`0`),e.body!==null){let t=i(e);typeof t==`number`&&!Number.isNaN(t)&&(r=String(t))}r&&n.set(`Content-Length`,r),e.referrerPolicy===``&&(e.referrerPolicy=c),e.referrer&&e.referrer!==`no-referrer`?e[h].referrer=l(e):e[h].referrer=`no-referrer`,e[h].referrer instanceof d&&n.set(`Referer`,e.referrer),n.has(`User-Agent`)||n.set(`User-Agent`,`gjsify-fetch`),e.compress&&!n.has(`Accept-Encoding`)&&n.set(`Accept-Encoding`,`gzip, deflate`);let{agent:o}=e;return typeof o==`function`&&(o=o(t)),!n.has(`Connection`)&&!o&&n.set(`Connection`,`close`),{parsedURL:t,options:{headers:n}}};export{_ as Request,_ as default,getSoupRequestOptions};

package/lib/request.js

@@ -12,6 +12,56 @@ import Body, { clone, extractContentType, getTotalBytes } from './body.js';
 import { isAbortSignal } from './utils/is.js';
 import { validateReferrerPolicy, determineRequestsReferrer, DEFAULT_REFERRER_POLICY } from './utils/referrer.js';
 const INTERNALS = Symbol('Request internals');
+/**
+ * Process-wide shared `Soup.Session`.
+ *
+ * Why a singleton and not a fresh `new Soup.Session()` per request:
+ *
+ * libsoup's connection manager keeps each open connection registered on a
+ * per-host list (`SoupHost.conns`). That list is only emptied when the
+ * connection's `disconnected` signal is processed on the main loop. When a
+ * `Soup.Session` is *finalized* its connection manager is torn down
+ * (`soup_connection_manager_free` → `soup_host_free`), which asserts the host
+ * has no live connections — `g_warn_if_fail (host->conns == NULL)`. If a
+ * session is dropped while a connection is still registered (the disconnect
+ * hasn't been pumped yet), libsoup prints:
+ *
+ *     (gjs:…): libsoup-CRITICAL **: runtime check failed: (host->conns == NULL)
+ *
+ * Under GJS this is a SpiderMonkey-GC race: a per-request session (the old
+ * behavior — one `new Soup.Session()` per `Request`) becomes garbage as soon as
+ * the `Response` body is read, and a GC sweep can finalize it on the very same
+ * turn the connection is still being cleaned up. The same class of GLib/Soup
+ * BoxedInstance GC race is mitigated elsewhere in gjsify (e.g. `@gjsify/timers`
+ * uses `GLib.timeout_add` instead of holding `GLib.Source` boxed instances).
+ *
+ * Holding one long-lived session at module scope keeps it permanently reachable
+ * (never GC-finalized for the lifetime of the program), so the teardown path
+ * that fires the assertion is never reached mid-flight. It also lets libsoup
+ * pool and reuse keep-alive connections across requests — a real win for
+ * heavy fetch users like `@gjsify/npm-registry` during `gjsify install`.
+ *
+ * Lazily created so merely importing `@gjsify/fetch` (e.g. for `Headers`/
+ * `Request`/`Response` types on Node, or in a browser bundle) does not
+ * instantiate a Soup object.
+ */
+let sharedSession = null;
+function getSharedSession() {
+    if (sharedSession === null) {
+        sharedSession = new Soup.Session();
+        // Soup auto-adds a ContentDecoder to new sessions, but it decodes the
+        // body without removing the Content-Encoding header, causing
+        // double-decompression when index.ts also runs DecompressionStream.
+        // Remove it once here so our JS-level decompression handles everything.
+        try {
+            sharedSession.remove_feature_by_type(Soup.ContentDecoder.$gtype);
+        }
+        catch {
+            /* not present */
+        }
+    }
+    return sharedSession;
+}
 /**
  * Check if `obj` is an instance of Request.
  */
@@ -165,7 +215,11 @@ export class Request extends Body {
         let session = null;
         let message = null;
         if (scheme === 'http:' || scheme === 'https:') {
-            session = new Soup.Session();
+            // Reuse the process-wide shared session (see getSharedSession docs):
+            // a per-request session that gets GC-finalized while a connection is
+            // still registered on its host triggers libsoup's
+            // `host->conns == NULL` CRITICAL.
+            session = getSharedSession();
             message = new Soup.Message({
                 method,
                 uri: GLib.Uri.parse(parsedURL.toString(), GLib.UriFlags.NONE),
@@ -207,16 +261,9 @@ export class Request extends Body {
         if (!session || !message) {
             throw new Error('Cannot send request: no Soup session (non-HTTP URL?)');
         }
-        // Soup auto-adds ContentDecoder to new sessions, but it decodes the body
-        // without removing the Content-Encoding header, causing double-decompression
-        // if we also run DecompressionStream below. Remove it so our JS-level
-        // decompression in index.ts handles everything correctly.
-        try {
-            session.remove_feature_by_type(Soup.ContentDecoder.$gtype);
-        }
-        catch {
-            /* not present */
-        }
+        // ContentDecoder is removed once on the shared session in
+        // getSharedSession() (so the Content-Encoding header survives for our
+        // JS-level DecompressionStream in index.ts). Nothing per-request here.
         options.headers._appendToSoupMessage(message);
         // Attach the request body to the Soup message (needed for POST/PUT/PATCH).
         // Use _rawBodyBuffer to read the body without consuming the stream (the

package/lib/soup-session.gjs.spec.d.ts

@@ -0,0 +1,2 @@
+declare const _default: () => Promise<void>;
+export default _default;

package/lib/soup-session.gjs.spec.js

@@ -0,0 +1,118 @@
+// Soup.Session lifecycle for GJS for @gjsify/fetch — original regression test.
+//
+// Regression: @gjsify/fetch used to create a fresh `new Soup.Session()` inside
+// every Request constructor. Once the Response body was read, that per-request
+// session became unreachable and SpiderMonkey could finalize it on the next GC
+// sweep while a libsoup connection was still registered on its host. libsoup's
+// connection-manager teardown then asserted `host->conns == NULL` and printed:
+//
+//   (gjs:…): libsoup-CRITICAL **: runtime check failed: (host->conns == NULL)
+//
+// on stderr during heavy fetch use (notably @gjsify/npm-registry's packument/
+// tarball fetches inside `gjsify install`). The fix holds ONE process-wide
+// `Soup.Session` at module scope so it is never GC-finalized mid-flight.
+//
+// This file is GJS-only (`.gjs.spec.ts`). The suite body runs under
+// `on('Gjs', …)`, so it is a no-op on Node. To keep the Node bundle free of
+// `gi://*` / `system` imports (the same `test.mts` aggregator drives
+// `test:node`), all GJS runtime objects are read from `globalThis.imports`
+// (the GJS bootstrap) rather than statically imported — type-only imports give
+// us the real shapes at compile time and are stripped at runtime.
+import { describe, it, expect, on } from '@gjsify/unit';
+export default async () => {
+    await on('Gjs', async () => {
+        // Read GJS runtime objects lazily (no static gi:// import → Node bundle
+        // stays clean). `imports` is the GJS bootstrap global.
+        const gjs = globalThis.imports;
+        const Soup = gjs.gi.Soup;
+        const GLib = gjs.gi.GLib;
+        const Gio = gjs.gi.Gio;
+        const System = gjs.system;
+        // Request + fetch are installed as globals by `@gjsify/fetch/register`,
+        // pulled into the test bundle by test.mts.
+        const RequestCtor = globalThis.Request;
+        const fetchFn = globalThis.fetch;
+        await describe('@gjsify/fetch — Soup.Session lifecycle (host->conns regression)', async () => {
+            await it('reuses one shared Soup.Session across HTTP requests (no per-request session)', () => {
+                // Two distinct HTTP Requests must share the very same Soup.Session
+                // instance. A per-request session is what triggered the GC race;
+                // a shared singleton can never be finalized while in use.
+                const a = new RequestCtor('http://example.com/a');
+                const b = new RequestCtor('https://example.org/b');
+                expect(a._session).toBeTruthy();
+                expect(b._session).toBeTruthy();
+                expect(a._session === b._session).toBe(true);
+                expect(a._session instanceof Soup.Session).toBe(true);
+            });
+            await it('non-HTTP requests do not allocate a Soup.Session', () => {
+                const dataReq = new RequestCtor('data:text/plain,hi');
+                expect(dataReq._session).toBeNull();
+            });
+            await it('many fetches + GC against a local server emit no host->conns / libsoup-CRITICAL warning', async () => {
+                // Exercise the live fetch path in-process first (the exact
+                // lifecycle: fetch → read body → drop refs → GC).
+                const server = new Soup.Server({});
+                server.add_handler(null, (_srv, msg) => {
+                    msg.set_status(200, null);
+                    msg.set_response('application/json', Soup.MemoryUse.COPY, new TextEncoder().encode('{"ok":true}'));
+                });
+                server.listen_local(0, Soup.ServerListenOptions.IPV4_ONLY);
+                const base = server.get_uris()[0].to_string();
+                for (let i = 0; i < 12; i++) {
+                    const res = await fetchFn(base);
+                    await res.json();
+                    System.gc();
+                }
+                System.gc();
+                System.gc();
+                // Stronger assertion: run the same loop in a child gjs process and
+                // capture its stderr, so we can assert the libsoup warning is
+                // absent (GJS cannot redirect its own fd 2). The worker imports
+                // this package's built bundle by absolute path. If the bundle is
+                // not built (running specs from src only), skip the subprocess —
+                // the shared-session invariant above is the load-bearing check.
+                const pkgRoot = GLib.path_get_dirname(GLib.path_get_dirname(GLib.filename_from_uri(import.meta.url)[0]));
+                const fetchEntry = `${pkgRoot}/lib/esm/index.js`;
+                if (!GLib.file_test(fetchEntry, GLib.FileTest.EXISTS)) {
+                    expect(true).toBe(true);
+                    return;
+                }
+                const worker = `
+                    imports.gi.versions.Soup = '3.0';
+                    const { Soup, GLib } = imports.gi;
+                    const System = imports.system;
+                    const { default: fetch } = await import(${JSON.stringify('file://' + fetchEntry)});
+                    const server = new Soup.Server({});
+                    server.add_handler(null, (_s, msg) => {
+                        msg.set_status(200, null);
+                        msg.set_response('application/json', Soup.MemoryUse.COPY,
+                            new TextEncoder().encode('{"ok":true}'));
+                    });
+                    server.listen_local(0, Soup.ServerListenOptions.IPV4_ONLY);
+                    const base = server.get_uris()[0].to_string();
+                    for (let i = 0; i < 20; i++) {
+                        const res = await fetch(base);
+                        await res.json();
+                        System.gc();
+                    }
+                    System.gc(); System.gc();
+                `;
+                const proc = Gio.Subprocess.new(['gjs', '-m', '-c', worker], Gio.SubprocessFlags.STDERR_PIPE | Gio.SubprocessFlags.STDOUT_SILENCE);
+                const stderrBytes = await new Promise((resolve, reject) => {
+                    proc.communicate_async(null, null, (p, r) => {
+                        try {
+                            const [, , stderr] = p.communicate_finish(r);
+                            resolve(stderr ? stderr.toArray() : new Uint8Array());
+                        }
+                        catch (e) {
+                            reject(e instanceof Error ? e : new Error(String(e)));
+                        }
+                    });
+                });
+                const stderr = new TextDecoder().decode(stderrBytes);
+                expect(stderr.includes('host->conns')).toBe(false);
+                expect(stderr.includes('libsoup-CRITICAL')).toBe(false);
+            });
+        });
+    });
+};

package/lib/utils/referrer.d.ts

@@ -13,7 +13,13 @@ import type Request from '../request.js';
  * @param url
  * @param originOnly
  */
-export declare function stripURLForUseAsAReferrer(url: null | URL | 'no-referrer', originOnly?: boolean): URL | "no-referrer";
+export declare function stripURLForUseAsAReferrer(url: null | URL | 'no-referrer', originOnly?: boolean): "no-referrer" | (URL & {
+    username: string;
+    password: string;
+    hash: string;
+    pathname: string;
+    search: string;
+});
 /**
  * @see {@link https://w3c.github.io/webappsec-referrer-policy/#enumdef-referrerpolicy enum ReferrerPolicy}
  */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@gjsify/fetch",
-    "version": "0.4.29",
+    "version": "0.4.31",
     "description": "Web and Node.js fetch module for Gjs",
     "module": "lib/esm/index.js",
     "types": "lib/index.d.ts",
@@ -48,8 +48,8 @@
         "fetch"
     ],
     "devDependencies": {
-        "@gjsify/cli": "^0.4.29",
-        "@gjsify/unit": "^0.4.29",
+        "@gjsify/cli": "^0.4.31",
+        "@gjsify/unit": "^0.4.31",
         "@types/node": "^25.9.1",
         "typescript": "^6.0.3"
     },
@@ -58,9 +58,9 @@
         "@girs/gjs": "4.0.1",
         "@girs/glib-2.0": "2.88.0-4.0.1",
         "@girs/soup-3.0": "3.6.6-4.0.1",
-        "@gjsify/formdata": "^0.4.29",
-        "@gjsify/http": "^0.4.29",
-        "@gjsify/url": "^0.4.29",
-        "@gjsify/utils": "^0.4.29"
+        "@gjsify/formdata": "^0.4.31",
+        "@gjsify/http": "^0.4.31",
+        "@gjsify/url": "^0.4.31",
+        "@gjsify/utils": "^0.4.31"
     }
 }