@scayle/storefront-nuxt 8.1.5 → 8.2.0

package/CHANGELOG.md

@@ -1,5 +1,24 @@
 # @scayle/storefront-nuxt
 
+## 8.2.0
+
+### Minor Changes
+
+- `storefront-nuxt` now includes experimental support for OpenTelemetry spans covering the bootstrapping and redirects middlewares. This aims to provide better insights into their performance impact. Please note that this is an experimental feature and its implementation and API might change in future releases.
+
+### Patch Changes
+
+- Updated dependency `@scayle/h3-session@^0.5.0` to `@scayle/h3-session@0.5.0`
+
+## 8.1.6
+
+### Patch Changes
+
+**Dependencies**
+
+- Updated dependency to @scayle/h3-session@0.5.0
+- Updated dependency to @scayle/unstorage-compression-driver@0.2.2
+
 ## 8.1.5
 
 ### Patch Changes

package/dist/module.json

@@ -1,6 +1,6 @@
 {
   "name": "@scayle/storefront-nuxt",
-  "version": "8.1.5",
+  "version": "8.2.0",
   "configKey": "storefront",
   "compatibility": {
     "nuxt": "^3.9.0"

package/dist/module.mjs

@@ -45,7 +45,7 @@ export default {
 }`;
 }
 const PACKAGE_NAME = "@scayle/storefront-nuxt";
-const PACKAGE_VERSION = "8.1.5";
+const PACKAGE_VERSION = "8.2.0";
 const logger = createConsola({
   fancy: true,
   formatOptions: {

package/dist/runtime/server/middleware/bootstrap.js

@@ -5,6 +5,7 @@ import {
   useSession,
   unsignCookie
 } from "@scayle/h3-session";
+import { trace, SpanStatusCode } from "@opentelemetry/api";
 import { buildContext } from "../../context.js";
 import { useCacheStorage, useSessionStorage } from "../utils/cacheStorage.js";
 import {
@@ -24,6 +25,10 @@ const generateSessionId = (event) => {
   }
   return userId ? `${userId}:${randomUUID()}` : randomUUID();
 };
+const tracer = trace.getTracer(
+  "storefront-nuxt",
+  "__sfc_version"
+);
 async function getOldSessionData(event, cookieName, store, secret) {
   const rawCookie = getCookie(event, cookieName);
   const normalizedSecrets = Array.isArray(secret) ? secret : [secret];
@@ -134,50 +139,73 @@ async function bootstrap(event, $shopConfig, $storefrontConfig, apiBasePath, con
   });
 }
 export default defineEventHandler(async (event) => {
-  try {
-    const { path, originalPath } = getBootstrapPath(event);
-    if (path.startsWith("/__nuxt")) {
-      return;
-    }
-    if (path === "/favicon.ico") {
-      return;
-    }
-    const config = useRuntimeConfig(event);
-    const $storefrontConfig = config.storefront;
-    if (path === `${$storefrontConfig.apiBasePath ?? "/api"}/up`) {
-      return;
-    }
-    const $shopConfig = getCurrentShopConfigForRequest(
-      event,
-      $storefrontConfig,
-      config.app
-    );
-    if (!$shopConfig) {
-      event.context.$log.debug(
-        "Could not find shop config for this request",
-        path
-      );
-      return;
-    }
-    const apiBasePath = getApiBasePath(
-      $storefrontConfig,
-      $shopConfig,
-      config.app.baseURL
-    );
-    if (!event.context.$rpcContext) {
-      event.context.$log.debug("Bootstrapping request: " + path);
-      await bootstrap(
-        event,
-        $shopConfig,
-        $storefrontConfig,
-        apiBasePath,
-        config
-      );
-    }
-    if ($storefrontConfig.redirects?.enabled && !path.startsWith(apiBasePath) && originalPath !== "/__nuxt_error") {
-      await useRedirects(event);
-    }
-  } catch (e) {
-    console.error(e);
+  const { path, originalPath } = getBootstrapPath(event);
+  if (path.startsWith("/__nuxt")) {
+    return;
   }
+  if (path === "/favicon.ico") {
+    return;
+  }
+  const config = useRuntimeConfig(event);
+  const $storefrontConfig = config.storefront;
+  if (path === `${$storefrontConfig.apiBasePath ?? "/api"}/up`) {
+    return;
+  }
+  await tracer.startActiveSpan(
+    `storefront-nuxt.middleware/bootstrap`,
+    {
+      attributes: {
+        path,
+        originalPath
+      }
+    },
+    async (span) => {
+      try {
+        const $shopConfig = getCurrentShopConfigForRequest(
+          event,
+          $storefrontConfig,
+          config.app
+        );
+        if (!$shopConfig) {
+          event.context.$log.debug(
+            "Could not find shop config for this request",
+            path
+          );
+          return;
+        }
+        const apiBasePath = getApiBasePath(
+          $storefrontConfig,
+          $shopConfig,
+          config.app.baseURL
+        );
+        if (!event.context.$rpcContext) {
+          event.context.$log.debug("Bootstrapping request: " + path);
+          await bootstrap(
+            event,
+            $shopConfig,
+            $storefrontConfig,
+            apiBasePath,
+            config
+          );
+        }
+        if ($storefrontConfig.redirects?.enabled && !path.startsWith(apiBasePath) && originalPath !== "/__nuxt_error") {
+          await tracer.startActiveSpan(
+            `storefront-nuxt.middleware/redirects`,
+            {},
+            async (innerSpan) => {
+              await useRedirects(event);
+              innerSpan.end();
+            }
+          );
+        }
+      } catch (e) {
+        console.error(e);
+        span.setStatus({ code: SpanStatusCode.ERROR });
+        if (e instanceof Error) {
+          span.recordException(e);
+        }
+      }
+      span.end();
+    }
+  );
 });

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@scayle/storefront-nuxt",
   "type": "module",
-  "version": "8.1.5",
+  "version": "8.2.0",
   "description": "Nuxt integration for the SCAYLE Commerce Engine and Storefront API",
   "author": "SCAYLE Commerce Engine",
   "license": "MIT",
@@ -72,9 +72,9 @@
   "dependencies": {
     "@nuxt/kit": "^3.12.2",
     "@opentelemetry/api": "^1.9.0",
-    "@scayle/h3-session": "^0.4.2",
+    "@scayle/h3-session": "0.5.0",
     "@scayle/storefront-core": "8.1.2",
-    "@scayle/unstorage-compression-driver": "^0.2.0",
+    "@scayle/unstorage-compression-driver": "^0.2.2",
     "@vueuse/core": "12.0.0",
     "consola": "^3.2.3",
     "core-js": "^3.37.1",
@@ -105,7 +105,7 @@
     "h3": "1.13.0",
     "nitropack": "2.9.7",
     "node-mocks-http": "1.16.2",
-    "nuxi": "3.16.0",
+    "nuxi": "3.17.0",
     "nuxt": "3.14.1592",
     "publint": "0.2.12",
     "vue-tsc": "2.1.10",