@podium/client 5.2.0 → 5.3.0-next.1

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [5.3.0-next.1](https://github.com/podium-lib/client/compare/v5.2.0...v5.3.0-next.1) (2024-11-13)
+
+
+### Features
+
+* track podlet assets ([39022a3](https://github.com/podium-lib/client/commit/39022a3c87184e5f524828591c8185d8a3fc2995))
+
 # [5.2.0](https://github.com/podium-lib/client/compare/v5.1.18...v5.2.0) (2024-11-06)
 
 

package/README.md

@@ -152,7 +152,6 @@ The following values can be provided:
 -   `throwable` - {Boolean} - Defines whether an error should be thrown if a failure occurs during the process of fetching a podium component. Defaults to `false` - Optional.
 -   `excludeBy` - {Object} - Lets you define a set of rules where a `fetch` call will not be resolved if it matches. - Optional.
 -   `includeBy` - {Object} - Inverse of `excludeBy`. Setting both at the same time will throw. - Optional.
--   `earlyHints` - {boolean} - Can be used to disable early hints from being sent to the browser for this resource, see [HTTP Status 103 Early Hints](https://developer.mozilla.org/en-US/docs/Web/HTTP/Status/103).
 
 ##### `excludeBy` and `includeBy`
 

package/lib/http-outgoing.js

@@ -1,6 +1,6 @@
 import { PassThrough } from 'stream';
 import assert from 'assert';
-import { toPreloadAssetObjects, filterAssets } from './utils.js';
+import { filterAssets } from './utils.js';
 
 /**
  * @typedef {object} PodiumClientHttpOutgoingOptions
@@ -70,6 +70,7 @@ export default class PodletClientHttpOutgoing extends PassThrough {
     #uri;
     #js;
     #css;
+    #assetsReceived = false;
 
     /**
      * @constructor
@@ -332,6 +333,26 @@ export default class PodletClientHttpOutgoing extends PassThrough {
         return this.#isFallback;
     }
 
+    get assetsReceived() {
+        return this.#assetsReceived;
+    }
+
+    /**
+     * Set the assetsReceived flag.
+     * This is used to signal to the assets object that the client has received assets for a given podlet so it can track
+     * which podlets have sent their assets.
+     * @param {boolean} value
+     */
+    set assetsReceived(value) {
+        this.#assetsReceived = value;
+        if (this.#assetsReceived) {
+            this.#incoming?.assets?.addReceivedAsset(this.#name, {
+                js: this.js,
+                css: this.css,
+            });
+        }
+    }
+
     pushFallback() {
         // @ts-expect-error Internal property
         this.push(this.#manifest._fallback);
@@ -349,21 +370,8 @@ export default class PodletClientHttpOutgoing extends PassThrough {
                 : filterAssets('fallback', this.#manifest.css);
         this.push(null);
         this.#isFallback = true;
-        // assume the hints from the podlet have failed and fallback assets will be used
-        this.hintsReceived = true;
-    }
-
-    writeEarlyHints(cb = () => {}) {
-        if (this.#incoming.response.writeEarlyHints) {
-            const preloads = toPreloadAssetObjects([
-                ...(this.js || []),
-                ...(this.css || []),
-            ]);
-            const link = preloads.map((preload) => preload.toHeader());
-            if (link.length) {
-                this.#incoming.response.writeEarlyHints({ link }, cb);
-            }
-        }
+        // assume the assets from the podlet have failed and fallback assets will be used
+        this.assetsReceived = true;
     }
 
     get [Symbol.toStringTag]() {

package/lib/resolver.content.js

@@ -267,6 +267,9 @@ export default class PodletClientContentResolver {
                 }),
             );
 
+            // mark assets as received
+            outgoing.assetsReceived = true;
+
             // @ts-ignore
             pipeline([body, outgoing], (err) => {
                 if (err) {

package/lib/resolver.js

@@ -11,7 +11,6 @@ import Cache from './resolver.cache.js';
  * @typedef {object} PodletClientResolverOptions
  * @property {string} clientName
  * @property {import('abslog').AbstractLoggerOptions} [logger]
- * @property {boolean} [earlyHints]
  */
 
 export default class PodletClientResolver {

package/lib/resource.js

@@ -105,6 +105,8 @@ export default class PodiumClientResource {
             throw new TypeError(
                 'you must pass an instance of "HttpIncoming" as the first argument to the .fetch() method',
             );
+        // set expectation to receive a response from this podlet.
+        incoming.assets.addExpectedAsset(this.#options.name);
         const outgoing = new HttpOutgoing(this.#options, reqOptions, incoming);
 
         if (this.#options.excludeBy) {
@@ -192,6 +194,8 @@ export default class PodiumClientResource {
             throw new TypeError(
                 'you must pass an instance of "HttpIncoming" as the first argument to the .stream() method',
             );
+        // set expectation to receive a response from this podlet.
+        incoming.assets.addExpectedAsset(this.#options.name);
         const outgoing = new HttpOutgoing(this.#options, reqOptions, incoming);
         this.#state.setInitializingState();
         this.#resolver.resolve(outgoing);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@podium/client",
-  "version": "5.2.0",
+  "version": "5.3.0-next.1",
   "type": "module",
   "license": "MIT",
   "keywords": [
@@ -40,7 +40,7 @@
     "@hapi/boom": "10.0.1",
     "@metrics/client": "2.5.3",
     "@podium/schemas": "5.1.0",
-    "@podium/utils": "5.3.2",
+    "@podium/utils": "5.4.0",
     "abslog": "2.4.4",
     "http-cache-semantics": "^4.0.3",
     "lodash.clonedeep": "^4.5.0",
@@ -48,22 +48,22 @@
     "undici": "6.20.1"
   },
   "devDependencies": {
+    "@podium/eslint-config": "1.0.0",
+    "@podium/semantic-release-config": "2.0.0",
     "@podium/test-utils": "3.1.0-next.5",
+    "@podium/typescript-config": "1.0.0",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/git": "10.0.1",
     "@semantic-release/github": "10.0.6",
     "@semantic-release/npm": "12.0.1",
     "@semantic-release/release-notes-generator": "13.0.0",
-    "eslint-config-prettier": "9.1.0",
-    "eslint-plugin-prettier": "5.1.3",
-    "express": "4.21.1",
-    "@podium/eslint-config": "1.0.0",
-    "@podium/semantic-release-config": "2.0.0",
-    "@podium/typescript-config": "1.0.0",
     "@sinonjs/fake-timers": "11.3.1",
     "@types/readable-stream": "4.0.18",
     "benchmark": "2.1.4",
     "eslint": "9.6.0",
+    "eslint-config-prettier": "9.1.0",
+    "eslint-plugin-prettier": "5.1.3",
+    "express": "4.21.1",
     "get-stream": "9.0.1",
     "http-proxy": "1.18.1",
     "is-stream": "4.0.1",
@@ -71,6 +71,7 @@
     "prettier": "3.3.2",
     "semantic-release": "24.1.2",
     "tap": "18.7.2",
-    "typescript": "5.6.3"
+    "typescript": "5.6.3",
+    "why-is-node-running": "3.2.1"
   }
 }

package/types/http-outgoing.d.ts

@@ -124,9 +124,15 @@ export default class PodletClientHttpOutgoing extends PassThrough {
      * @see https://podium-lib.io/docs/podlet/fallbacks
      */
     get isFallback(): boolean;
+    /**
+     * Set the assetsReceived flag.
+     * This is used to signal to the assets object that the client has received assets for a given podlet so it can track
+     * which podlets have sent their assets.
+     * @param {boolean} value
+     */
+    set assetsReceived(value: boolean);
+    get assetsReceived(): boolean;
     pushFallback(): void;
-    hintsReceived: boolean;
-    writeEarlyHints(cb?: () => void): void;
     get [Symbol.toStringTag](): string;
     #private;
 }

package/types/resolver.d.ts

@@ -2,7 +2,6 @@
  * @typedef {object} PodletClientResolverOptions
  * @property {string} clientName
  * @property {import('abslog').AbstractLoggerOptions} [logger]
- * @property {boolean} [earlyHints]
  */
 export default class PodletClientResolver {
     /**
@@ -32,6 +31,5 @@ export default class PodletClientResolver {
 export type PodletClientResolverOptions = {
     clientName: string;
     logger?: import("abslog").AbstractLoggerOptions;
-    earlyHints?: boolean;
 };
 import Metrics from '@metrics/client';