@modern-js/plugin-data-loader 2.31.2 → 2.32.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # @modern-js/plugin-data-loader
 
+## 2.32.0
+
+### Minor Changes
+
+- a030aff: feat: support loader context
+  feat: 支持 loader context
+- 4323e68: feat: support client-data file
+  feat: 支持 client-data 文件
+
+### Patch Changes
+
+- 6076166: fix: packaging errors found by publint
+
+  fix: 修复 publint 检测到的 packaging 问题
+
+- 3c91100: chore(builder): using unified version of webpack-chain
+
+  chore(builder): 使用统一的 webpack-chain 版本
+
+- 5255eba: feat: report time for server loader
+  feat: 上报 server loader 执行的时间
+- Updated dependencies [e5a3fb4]
+- Updated dependencies [6076166]
+- Updated dependencies [a030aff]
+- Updated dependencies [3c91100]
+- Updated dependencies [5255eba]
+  - @modern-js/utils@2.32.0
+
 ## 2.31.2
 
 ### Patch Changes

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021 Modern.js
+Copyright (c) 2021-present Modern.js
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/dist/cjs/cli/loader.js

@@ -8,6 +8,8 @@ Object.defineProperty(exports, "default", {
     return loader;
   }
 });
+const _util = require("util");
+const _logger = require("@modern-js/utils/logger");
 const _generateClient = require("./generateClient");
 async function loader(source) {
   var _this__compiler;
@@ -33,6 +35,18 @@ async function loader(source) {
   if (!options.mapFile) {
     return source;
   }
+  if (options.clientData) {
+    const readFile = (0, _util.promisify)(this.fs.readFile);
+    try {
+      const clientDataPath = this.resourcePath.includes(".loader.") ? this.resourcePath.replace(".loader.", ".data.client.") : this.resourcePath.replace(".data.", ".data.client.");
+      const clientDataContent = await readFile(clientDataPath);
+      return clientDataContent;
+    } catch (error) {
+      if (process.env.NODE_ENV === "development") {
+        _logger.logger.error(`Failed to read the clientData file ${options.clientData}`);
+      }
+    }
+  }
   const code = (0, _generateClient.generateClient)({
     mapFile: options.mapFile,
     loaderId: options.loaderId

package/dist/cjs/runtime/index.js

@@ -25,7 +25,9 @@ const _remixrouter = require("@modern-js/utils/runtime/remix-router");
 const _nestedroutes = require("@modern-js/utils/runtime/nested-routes");
 const _lodash = require("@modern-js/utils/lodash");
 const _runtimenode = require("@modern-js/utils/runtime-node");
-const _constants = require("../common/constants");
+const _time = require("@modern-js/utils/universal/time");
+const _constants = require("@modern-js/utils/universal/constants");
+const _constants1 = require("../common/constants");
 const _response = require("./response");
 (0, _node.installGlobals)();
 const redirectStatusCodes = /* @__PURE__ */ new Set([
@@ -94,7 +96,7 @@ const sendLoaderResponse = async (res, nodeResponse) => {
 };
 const handleRequest = async ({ context, serverRoutes, routes: routesConfig }) => {
   const { method, query } = context;
-  const routeId = query[_constants.LOADER_ID_PARAM];
+  const routeId = query[_constants1.LOADER_ID_PARAM];
   const entry = (0, _runtimenode.matchEntry)(context.path, serverRoutes);
   if (!routeId || !entry) {
     return;
@@ -103,16 +105,20 @@ const handleRequest = async ({ context, serverRoutes, routes: routesConfig }) =>
     throw new Error("CSR data loader request only support http GET method");
   }
   const basename = entry.urlPath;
-  const routes = (0, _nestedroutes.transformNestedRoutes)(routesConfig);
+  const end = (0, _time.time)();
+  const { res, logger, reporter } = context;
+  const routes = (0, _nestedroutes.transformNestedRoutes)(routesConfig, reporter);
   const { queryRoute } = (0, _remixrouter.createStaticHandler)(routes, {
     basename
   });
-  const { res, logger } = context;
   const request = createLoaderRequest(context);
+  const requestContext = (0, _runtimenode.createRequestContext)();
+  requestContext.set(_runtimenode.reporterCtx, reporter);
   let response;
   try {
     response = await queryRoute(request, {
-      routeId
+      routeId,
+      requestContext
     });
     if (isResponse(response) && isRedirectResponse(response.status)) {
       response = convertModernRedirectResponse(response.headers, basename);
@@ -127,7 +133,7 @@ const handleRequest = async ({ context, serverRoutes, routes: routesConfig }) =>
         response = convertModernRedirectResponse(new Headers(init.headers), basename);
       } else {
         const headers = new Headers(init.headers);
-        headers.set("Content-Type", `${_constants.CONTENT_TYPE_DEFERRED}; charset=UTF-8`);
+        headers.set("Content-Type", `${_constants1.CONTENT_TYPE_DEFERRED}; charset=UTF-8`);
         init.headers = headers;
         response = new _node.Response(body, init);
       }
@@ -149,5 +155,7 @@ const handleRequest = async ({ context, serverRoutes, routes: routesConfig }) =>
       }
     });
   }
+  const cost = end();
+  reporter.reportTiming(`${_constants.LOADER_REPORTER_NAME}-navigation`, cost);
   await sendLoaderResponse(res, response);
 };

package/dist/esm/cli/loader.js

@@ -1,53 +1,93 @@
 import { _ as _async_to_generator } from "@swc/helpers/_/_async_to_generator";
 import { _ as _sliced_to_array } from "@swc/helpers/_/_sliced_to_array";
 import { _ as _ts_generator } from "@swc/helpers/_/_ts_generator";
+import { promisify } from "util";
+import { logger } from "@modern-js/utils/logger";
 import { generateClient } from "./generateClient";
 export default function loader(source) {
   return _loader.apply(this, arguments);
 }
 function _loader() {
   _loader = _async_to_generator(function(source) {
-    var _this__compiler, target, resourceQuery, options, code;
+    var _this__compiler, target, resourceQuery, options, readFile, clientDataPath, clientDataContent, error, code;
     return _ts_generator(this, function(_state) {
-      this.cacheable();
-      target = (_this__compiler = this._compiler) === null || _this__compiler === void 0 ? void 0 : _this__compiler.options.target;
-      if (target === "node") {
-        return [
-          2,
-          source
-        ];
+      switch (_state.label) {
+        case 0:
+          this.cacheable();
+          target = (_this__compiler = this._compiler) === null || _this__compiler === void 0 ? void 0 : _this__compiler.options.target;
+          if (target === "node") {
+            return [
+              2,
+              source
+            ];
+          }
+          if (target === "webworker") {
+            return [
+              2,
+              source
+            ];
+          }
+          resourceQuery = this.resourceQuery;
+          options = resourceQuery.slice(1).split("&").map(function(item) {
+            return item.split("=");
+          }).reduce(function(pre, cur) {
+            var _cur = _sliced_to_array(cur, 2), key = _cur[0], value = _cur[1];
+            if (!key || !value) {
+              return pre;
+            }
+            pre[key] = value;
+            return pre;
+          }, {});
+          if (!options.mapFile) {
+            return [
+              2,
+              source
+            ];
+          }
+          if (!options.clientData)
+            return [
+              3,
+              4
+            ];
+          readFile = promisify(this.fs.readFile);
+          _state.label = 1;
+        case 1:
+          _state.trys.push([
+            1,
+            3,
+            ,
+            4
+          ]);
+          clientDataPath = this.resourcePath.includes(".loader.") ? this.resourcePath.replace(".loader.", ".data.client.") : this.resourcePath.replace(".data.", ".data.client.");
+          return [
+            4,
+            readFile(clientDataPath)
+          ];
+        case 2:
+          clientDataContent = _state.sent();
+          return [
+            2,
+            clientDataContent
+          ];
+        case 3:
+          error = _state.sent();
+          if (process.env.NODE_ENV === "development") {
+            logger.error("Failed to read the clientData file ".concat(options.clientData));
+          }
+          return [
+            3,
+            4
+          ];
+        case 4:
+          code = generateClient({
+            mapFile: options.mapFile,
+            loaderId: options.loaderId
+          });
+          return [
+            2,
+            code
+          ];
       }
-      if (target === "webworker") {
-        return [
-          2,
-          source
-        ];
-      }
-      resourceQuery = this.resourceQuery;
-      options = resourceQuery.slice(1).split("&").map(function(item) {
-        return item.split("=");
-      }).reduce(function(pre, cur) {
-        var _cur = _sliced_to_array(cur, 2), key = _cur[0], value = _cur[1];
-        if (!key || !value) {
-          return pre;
-        }
-        pre[key] = value;
-        return pre;
-      }, {});
-      if (!options.mapFile) {
-        return [
-          2,
-          source
-        ];
-      }
-      code = generateClient({
-        mapFile: options.mapFile,
-        loaderId: options.loaderId
-      });
-      return [
-        2,
-        code
-      ];
     });
   });
   return _loader.apply(this, arguments);

package/dist/esm/runtime/index.js

@@ -6,7 +6,9 @@ import { installGlobals, writeReadableStreamToWritable, Response as NodeResponse
 import { createStaticHandler, ErrorResponse, UNSAFE_DEFERRED_SYMBOL as DEFERRED_SYMBOL } from "@modern-js/utils/runtime/remix-router";
 import { transformNestedRoutes } from "@modern-js/utils/runtime/nested-routes";
 import { isPlainObject } from "@modern-js/utils/lodash";
-import { matchEntry } from "@modern-js/utils/runtime-node";
+import { matchEntry, createRequestContext, reporterCtx } from "@modern-js/utils/runtime-node";
+import { time } from "@modern-js/utils/universal/time";
+import { LOADER_REPORTER_NAME } from "@modern-js/utils/universal/constants";
 import { CONTENT_TYPE_DEFERRED, LOADER_ID_PARAM } from "../common/constants";
 import { createDeferredReadableStream } from "./response";
 installGlobals();
@@ -155,7 +157,7 @@ var sendLoaderResponse = function() {
 }();
 export var handleRequest = function() {
   var _ref = _async_to_generator(function(param) {
-    var context, serverRoutes, routesConfig, method, query, routeId, entry, basename, routes, queryRoute, res, logger, request, response, deferredData, body, init, headers, error, _logger, message;
+    var context, serverRoutes, routesConfig, method, query, routeId, entry, basename, end, res, logger, reporter, routes, queryRoute, request, requestContext, response, deferredData, body, init, headers, error, _logger, message, cost;
     return _ts_generator(this, function(_state) {
       switch (_state.label) {
         case 0:
@@ -172,12 +174,15 @@ export var handleRequest = function() {
             throw new Error("CSR data loader request only support http GET method");
           }
           basename = entry.urlPath;
-          routes = transformNestedRoutes(routesConfig);
+          end = time();
+          res = context.res, logger = context.logger, reporter = context.reporter;
+          routes = transformNestedRoutes(routesConfig, reporter);
           queryRoute = createStaticHandler(routes, {
             basename: basename
           }).queryRoute;
-          res = context.res, logger = context.logger;
           request = createLoaderRequest(context);
+          requestContext = createRequestContext();
+          requestContext.set(reporterCtx, reporter);
           _state.label = 1;
         case 1:
           _state.trys.push([
@@ -189,7 +194,8 @@ export var handleRequest = function() {
           return [
             4,
             queryRoute(request, {
-              routeId: routeId
+              routeId: routeId,
+              requestContext: requestContext
             })
           ];
         case 2:
@@ -237,6 +243,8 @@ export var handleRequest = function() {
             4
           ];
         case 4:
+          cost = end();
+          reporter.reportTiming("".concat(LOADER_REPORTER_NAME, "-navigation"), cost);
           return [
             4,
             sendLoaderResponse(res, response)

package/dist/esm-node/cli/loader.js

@@ -1,3 +1,5 @@
+import { promisify } from "util";
+import { logger } from "@modern-js/utils/logger";
 import { generateClient } from "./generateClient";
 export default async function loader(source) {
   var _this__compiler;
@@ -23,6 +25,18 @@ export default async function loader(source) {
   if (!options.mapFile) {
     return source;
   }
+  if (options.clientData) {
+    const readFile = promisify(this.fs.readFile);
+    try {
+      const clientDataPath = this.resourcePath.includes(".loader.") ? this.resourcePath.replace(".loader.", ".data.client.") : this.resourcePath.replace(".data.", ".data.client.");
+      const clientDataContent = await readFile(clientDataPath);
+      return clientDataContent;
+    } catch (error) {
+      if (process.env.NODE_ENV === "development") {
+        logger.error(`Failed to read the clientData file ${options.clientData}`);
+      }
+    }
+  }
   const code = generateClient({
     mapFile: options.mapFile,
     loaderId: options.loaderId

package/dist/esm-node/runtime/index.js

@@ -2,7 +2,9 @@ import { installGlobals, writeReadableStreamToWritable, Response as NodeResponse
 import { createStaticHandler, ErrorResponse, UNSAFE_DEFERRED_SYMBOL as DEFERRED_SYMBOL } from "@modern-js/utils/runtime/remix-router";
 import { transformNestedRoutes } from "@modern-js/utils/runtime/nested-routes";
 import { isPlainObject } from "@modern-js/utils/lodash";
-import { matchEntry } from "@modern-js/utils/runtime-node";
+import { matchEntry, createRequestContext, reporterCtx } from "@modern-js/utils/runtime-node";
+import { time } from "@modern-js/utils/universal/time";
+import { LOADER_REPORTER_NAME } from "@modern-js/utils/universal/constants";
 import { CONTENT_TYPE_DEFERRED, LOADER_ID_PARAM } from "../common/constants";
 import { createDeferredReadableStream } from "./response";
 installGlobals();
@@ -81,16 +83,20 @@ export const handleRequest = async ({ context, serverRoutes, routes: routesConfi
     throw new Error("CSR data loader request only support http GET method");
   }
   const basename = entry.urlPath;
-  const routes = transformNestedRoutes(routesConfig);
+  const end = time();
+  const { res, logger, reporter } = context;
+  const routes = transformNestedRoutes(routesConfig, reporter);
   const { queryRoute } = createStaticHandler(routes, {
     basename
   });
-  const { res, logger } = context;
   const request = createLoaderRequest(context);
+  const requestContext = createRequestContext();
+  requestContext.set(reporterCtx, reporter);
   let response;
   try {
     response = await queryRoute(request, {
-      routeId
+      routeId,
+      requestContext
     });
     if (isResponse(response) && isRedirectResponse(response.status)) {
       response = convertModernRedirectResponse(response.headers, basename);
@@ -127,5 +133,7 @@ export const handleRequest = async ({ context, serverRoutes, routes: routesConfi
       }
     });
   }
+  const cost = end();
+  reporter.reportTiming(`${LOADER_REPORTER_NAME}-navigation`, cost);
   await sendLoaderResponse(res, response);
 };

package/dist/types/cli/loader.d.ts

@@ -1,5 +1,9 @@
+/// <reference types="node" />
 import type { LoaderContext } from 'webpack';
-export default function loader(this: LoaderContext<{
+type Context = {
   mapFile: string;
   loaderId?: string;
-}>, source: string): Promise<string>;
+  clientData?: boolean;
+};
+export default function loader(this: LoaderContext<Context>, source: string): Promise<string | Buffer | undefined>;
+export {};

package/package.json

@@ -15,28 +15,28 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.31.2",
+  "version": "2.32.0",
   "engines": {
     "node": ">=14.17.6"
   },
-  "jsnext:source": "./src/index.ts",
-  "types": "./dist/types/index.d.ts",
-  "main": "./dist/cjs/index.js",
-  "module": "./dist/esm/index.js",
+  "jsnext:source": "./src/runtime/index.ts",
+  "types": "./dist/types/runtime/index.d.ts",
+  "main": "./dist/cjs/runtime/index.js",
+  "module": "./dist/esm/runtime/index.js",
   "exports": {
     "./loader": {
-      "jsnext:source": "./src/cli/loader.ts",
       "types": "./dist/types/cli/loader.d.ts",
+      "jsnext:source": "./src/cli/loader.ts",
       "default": "./dist/cjs/cli/loader.js"
     },
     "./server": {
-      "jsnext:source": "./src/server/index.ts",
       "types": "./dist/types/server/index.d.ts",
+      "jsnext:source": "./src/server/index.ts",
       "default": "./dist/cjs/server/index.js"
     },
     "./runtime": {
-      "jsnext:source": "./src/runtime/index.ts",
       "types": "./dist/types/runtime/index.d.ts",
+      "jsnext:source": "./src/runtime/index.ts",
       "default": "./dist/esm/runtime/index.js"
     }
   },
@@ -58,7 +58,7 @@
     "@remix-run/node": "^1.12.0",
     "path-to-regexp": "^6.2.0",
     "@swc/helpers": "0.5.1",
-    "@modern-js/utils": "2.31.2"
+    "@modern-js/utils": "2.32.0"
   },
   "devDependencies": {
     "@types/babel__core": "^7.20.0",
@@ -72,14 +72,13 @@
     "ts-jest": "^29.1.0",
     "typescript": "^5",
     "webpack": "^5.88.1",
-    "webpack-chain": "^6.5.1",
     "react": "^18",
     "react-dom": "^18",
-    "@modern-js/types": "2.31.2",
-    "@modern-js/server-core": "2.31.2",
-    "@modern-js/core": "2.31.2",
-    "@scripts/build": "2.31.1",
-    "@scripts/jest-config": "2.31.1"
+    "@modern-js/types": "2.32.0",
+    "@modern-js/core": "2.32.0",
+    "@modern-js/server-core": "2.32.0",
+    "@scripts/build": "2.32.0",
+    "@scripts/jest-config": "2.32.0"
   },
   "peerDependencies": {
     "react": ">=17.0.0"