refactor: split runtime utils into a seperate package (#4636)

* refactor: split runtime utils into a seperate package * chore: update lockfile * chore: changeset
web-infra-dev · Sep 14, 2023 · 6a1d46e · 6a1d46e
1 parent 578f94f
commit 6a1d46e
Show file tree

Hide file tree

Showing 68 changed files with 431 additions and 181 deletions.
diff --git a/.changeset/thin-ducks-sort.md b/.changeset/thin-ducks-sort.md
@@ -0,0 +1,14 @@
+---
+'@modern-js/plugin-router-v5': patch
+'@modern-js/plugin-data-loader': patch
+'@modern-js/runtime': patch
+'@modern-js/create-request': patch
+'@modern-js/runtime-utils': patch
+'@modern-js/app-tools': patch
+'@modern-js/prod-server': patch
+'@modern-js/server': patch
+'@modern-js/utils': patch
+---
+
+refactor: split runtime utils into a seperate package
+refactor: runtime utils 单独拆分成一个包
diff --git a/packages/cli/plugin-data-loader/package.json b/packages/cli/plugin-data-loader/package.json
@@ -63,6 +63,7 @@
   "dependencies": {
     "@babel/core": "^7.22.15",
     "@modern-js/utils": "workspace:*",
+    "@modern-js/runtime-utils": "workspace:*",
     "@remix-run/node": "^1.12.0",
     "path-to-regexp": "^6.2.0",
     "@swc/helpers": "0.5.1"

diff --git a/packages/cli/plugin-data-loader/src/cli/createRequest.ts b/packages/cli/plugin-data-loader/src/cli/createRequest.ts
@@ -1,8 +1,8 @@
 /* eslint-disable node/prefer-global/url */
 // Todo move this file to `runtime/` dir
 import { compile } from 'path-to-regexp';
-import { redirect } from '@modern-js/utils/runtime/router';
-import { type UNSAFE_DeferredData as DeferredData } from '@modern-js/utils/runtime/remix-router';
+import { redirect } from '@modern-js/runtime-utils/router';
+import { type UNSAFE_DeferredData as DeferredData } from '@modern-js/runtime-utils/remix-router';
 import {
   LOADER_ID_PARAM,
   DIRECT_PARAM,

diff --git a/packages/cli/plugin-data-loader/src/cli/data.ts b/packages/cli/plugin-data-loader/src/cli/data.ts
@@ -13,7 +13,7 @@
 import {
   UNSAFE_DeferredData as DeferredData,
   AbortedDeferredError,
-} from '@modern-js/utils/runtime/remix-router';
+} from '@modern-js/runtime-utils/remix-router';
 
 const DEFERRED_VALUE_PLACEHOLDER_PREFIX = '__deferred_promise:';
 export async function parseDeferredReadableStream(

diff --git a/packages/cli/plugin-data-loader/src/runtime/index.ts b/packages/cli/plugin-data-loader/src/runtime/index.ts
@@ -10,16 +10,16 @@ import {
   ErrorResponse,
   UNSAFE_DEFERRED_SYMBOL as DEFERRED_SYMBOL,
   type UNSAFE_DeferredData as DeferredData,
-} from '@modern-js/utils/runtime/remix-router';
-import { transformNestedRoutes } from '@modern-js/utils/runtime/nested-routes';
+} from '@modern-js/runtime-utils/remix-router';
+import { transformNestedRoutes } from '@modern-js/runtime-utils/browser';
 import { isPlainObject } from '@modern-js/utils/lodash';
 import {
   matchEntry,
   ServerContext,
   createRequestContext,
   reporterCtx,
-} from '@modern-js/utils/runtime-node';
-import { time } from '@modern-js/utils/universal/time';
+} from '@modern-js/runtime-utils/node';
+import { time } from '@modern-js/runtime-utils/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';

diff --git a/packages/cli/plugin-data-loader/src/runtime/response.ts b/packages/cli/plugin-data-loader/src/runtime/response.ts
@@ -11,8 +11,8 @@ import { TextEncoder } from 'util';
 import {
   type UNSAFE_DeferredData as DeferredData,
   type TrackedPromise,
-} from '@modern-js/utils/runtime/remix-router';
-import { serializeJson } from '@modern-js/utils/runtime-node';
+} from '@modern-js/runtime-utils/remix-router';
+import { serializeJson } from '@modern-js/runtime-utils/node';
 
 function isTrackedPromise(value: any): value is TrackedPromise {
   return (

diff --git a/packages/cli/plugin-data-loader/src/server/index.ts b/packages/cli/plugin-data-loader/src/server/index.ts
@@ -4,7 +4,7 @@ import fs from 'fs';
 import type { ServerPlugin } from '@modern-js/server-core';
 import type { ServerRoute } from '@modern-js/types';
 import { MAIN_ENTRY_NAME, SERVER_BUNDLE_DIRECTORY } from '@modern-js/utils';
-import { matchEntry, ServerContext } from '@modern-js/utils/runtime-node';
+import { matchEntry, ServerContext } from '@modern-js/runtime-utils/node';
 
 export default (): ServerPlugin => ({
   name: '@modern-js/plugin-data-loader',

diff --git a/packages/runtime/plugin-router-v5/package.json b/packages/runtime/plugin-router-v5/package.json
@@ -80,6 +80,7 @@
     "@modern-js/core": "workspace:*",
     "@modern-js/runtime": "workspace:*",
     "@modern-js/utils": "workspace:*",
+    "@modern-js/runtime-utils": "workspace:*",
     "@scripts/build": "workspace:*",
     "@scripts/jest-config": "workspace:*",
     "@testing-library/react": "^13.4.0",

diff --git a/packages/runtime/plugin-router-v5/src/runtime/plugin.tsx b/packages/runtime/plugin-router-v5/src/runtime/plugin.tsx
@@ -16,7 +16,7 @@ import {
 import hoistNonReactStatics from 'hoist-non-react-statics';
 import { RuntimeReactContext, isBrowser } from '@modern-js/runtime';
 import type { Plugin } from '@modern-js/runtime';
-import { parsedJSONFromElement } from '@modern-js/utils/runtime-browser';
+import { parsedJSONFromElement } from '@modern-js/runtime-utils/browser';
 import { renderRoutes, getLocation, urlJoin } from './utils';
 import { modifyRoutesHook } from './hooks';
 

diff --git a/packages/runtime/plugin-runtime/package.json b/packages/runtime/plugin-runtime/package.json
@@ -169,6 +169,7 @@
     "@modern-js/plugin": "workspace:*",
     "@modern-js/types": "workspace:*",
     "@modern-js/utils": "workspace:*",
+    "@modern-js/runtime-utils": "workspace:*",
     "@remix-run/node": "^1.12.0",
     "@types/loadable__component": "^5.13.4",
     "@types/react-helmet": "^6.1.2",

diff --git a/packages/runtime/plugin-runtime/src/router/runtime/DeferredDataScripts.node.tsx b/packages/runtime/plugin-runtime/src/router/runtime/DeferredDataScripts.node.tsx
@@ -1,12 +1,12 @@
 /* eslint-disable react/no-danger */
-import { type TrackedPromise } from '@modern-js/utils/runtime/remix-router';
+import { type TrackedPromise } from '@modern-js/runtime-utils/remix-router';
 import { Suspense, useEffect, useRef, useMemo, useContext } from 'react';
 import {
   Await,
   UNSAFE_DataRouterContext as DataRouterContext,
   useAsyncError,
-} from '@modern-js/utils/runtime/router';
-import { serializeJson } from '@modern-js/utils/runtime-node';
+} from '@modern-js/runtime-utils/router';
+import { serializeJson } from '@modern-js/runtime-utils/node';
 import { JSX_SHELL_STREAM_END_MARK } from '../../common';
 import { serializeErrors } from './utils';
 

diff --git a/packages/runtime/plugin-runtime/src/router/runtime/PrefetchLink.tsx b/packages/runtime/plugin-runtime/src/router/runtime/PrefetchLink.tsx
@@ -14,7 +14,7 @@ import {
   useMatches,
   NavLink as RouterNavLink,
   NavLinkProps as RouterNavLinkProps,
-} from '@modern-js/utils/runtime/router';
+} from '@modern-js/runtime-utils/router';
 import { RuntimeReactContext } from '../../core';
 import { RouteAssets, RouteManifest } from './types';
 

diff --git a/packages/runtime/plugin-runtime/src/router/runtime/hooks.ts b/packages/runtime/plugin-runtime/src/router/runtime/hooks.ts
@@ -1,5 +1,5 @@
 import { createWaterfall } from '@modern-js/plugin';
-import { RouteObject } from '@modern-js/utils/runtime/router';
+import { RouteObject } from '@modern-js/runtime-utils/router';
 
 const modifyRoutes = createWaterfall<RouteObject[]>();
 

diff --git a/packages/runtime/plugin-runtime/src/router/runtime/index.ts b/packages/runtime/plugin-runtime/src/router/runtime/index.ts
@@ -1,4 +1,4 @@
-import { useRouteLoaderData as useRouteData } from '@modern-js/utils/runtime/router';
+import { useRouteLoaderData as useRouteData } from '@modern-js/runtime-utils/router';
 import { routerPlugin } from './plugin';
 import type { SingleRouteConfig, RouterConfig } from './types';
 
@@ -79,7 +79,7 @@ export type {
   Search,
   ShouldRevalidateFunction,
   To,
-} from '@modern-js/utils/runtime/router';
+} from '@modern-js/runtime-utils/router';
 
 // Note: Keep in sync with react-router-dom exports!
 export {
@@ -148,4 +148,4 @@ export {
   defer,
   json,
   redirect,
-} from '@modern-js/utils/runtime/router';
+} from '@modern-js/runtime-utils/router';
diff --git a/packages/runtime/plugin-runtime/src/router/runtime/plugin.node.tsx b/packages/runtime/plugin-runtime/src/router/runtime/plugin.node.tsx
@@ -1,16 +1,16 @@
 import React, { useContext } from 'react';
-import { createStaticHandler } from '@modern-js/utils/runtime/remix-router';
+import { createStaticHandler } from '@modern-js/runtime-utils/remix-router';
 import {
   createStaticRouter,
   StaticRouterProvider,
-} from '@modern-js/utils/runtime-node/router';
+} from '@modern-js/runtime-utils/node/router';
 import hoistNonReactStatics from 'hoist-non-react-statics';
-import { createRoutesFromElements } from '@modern-js/utils/runtime/router';
+import { createRoutesFromElements } from '@modern-js/runtime-utils/router';
 import {
   createRequestContext,
   reporterCtx,
-} from '@modern-js/utils/runtime-node';
-import { time } from '@modern-js/utils/universal/time';
+} from '@modern-js/runtime-utils/node';
+import { time } from '@modern-js/runtime-utils/time';
 import { LOADER_REPORTER_NAME } from '@modern-js/utils/universal/constants';
 import { RuntimeReactContext } from '../../core';
 import type { Plugin } from '../../core';

diff --git a/packages/runtime/plugin-runtime/src/router/runtime/plugin.tsx b/packages/runtime/plugin-runtime/src/router/runtime/plugin.tsx
@@ -7,10 +7,10 @@ import {
   useMatches,
   useLocation,
   RouteObject,
-} from '@modern-js/utils/runtime/router';
+} from '@modern-js/runtime-utils/router';
 import hoistNonReactStatics from 'hoist-non-react-statics';
-import { parsedJSONFromElement } from '@modern-js/utils/runtime-browser';
-import type { RouterSubscriber } from '@modern-js/utils/runtime/remix-router';
+import { parsedJSONFromElement } from '@modern-js/runtime-utils/browser';
+import type { RouterSubscriber } from '@modern-js/runtime-utils/remix-router';
 import { Plugin, RuntimeReactContext } from '../../core';
 import { modifyRoutes as modifyRoutesHook } from './hooks';
 import { deserializeErrors, renderRoutes, urlJoin } from './utils';

diff --git a/packages/runtime/plugin-runtime/src/router/runtime/server.ts b/packages/runtime/plugin-runtime/src/router/runtime/server.ts
@@ -1 +1 @@
-export * from '@modern-js/utils/runtime-node/router';
+export * from '@modern-js/runtime-utils/node/router';
diff --git a/packages/runtime/plugin-runtime/src/router/runtime/types.ts b/packages/runtime/plugin-runtime/src/router/runtime/types.ts
@@ -2,9 +2,9 @@ import type {
   RouteProps,
   RouteObject,
   Params,
-} from '@modern-js/utils/runtime/router';
+} from '@modern-js/runtime-utils/router';
 import { PageRoute, NestedRoute } from '@modern-js/types';
-import type { RequestContext } from '@modern-js/utils/runtime-node';
+import type { RequestContext } from '@modern-js/runtime-utils/node';
 
 declare global {
   interface Window {

diff --git a/packages/runtime/plugin-runtime/src/router/runtime/utils.tsx b/packages/runtime/plugin-runtime/src/router/runtime/utils.tsx
@@ -1,5 +1,5 @@
 import React from 'react';
-import { Route, isRouteErrorResponse } from '@modern-js/utils/runtime/router';
+import { Route, isRouteErrorResponse } from '@modern-js/runtime-utils/router';
 import type {
   Reporter,
   NestedRoute,
@@ -10,8 +10,8 @@ import {
   ErrorResponse,
   type StaticHandlerContext,
   type Router,
-} from '@modern-js/utils/runtime/remix-router';
-import { renderNestedRoute } from '@modern-js/utils/runtime/nested-routes';
+} from '@modern-js/runtime-utils/remix-router';
+import { renderNestedRoute } from '@modern-js/runtime-utils/browser';
 import { RouterConfig } from './types';
 import { DefaultNotFound } from './DefaultNotFound';
 import DeferredDataScripts from './DeferredDataScripts';

diff --git a/packages/runtime/plugin-runtime/src/router/runtime/withRouter.tsx b/packages/runtime/plugin-runtime/src/router/runtime/withRouter.tsx
@@ -5,7 +5,7 @@ import {
   useLocation,
   useNavigate,
   useParams,
-} from '@modern-js/utils/runtime/router';
+} from '@modern-js/runtime-utils/router';
 
 export interface WithRouterProps {
   location: ReturnType<typeof useLocation>;

diff --git a/packages/runtime/plugin-runtime/src/runtimeContext.ts b/packages/runtime/plugin-runtime/src/runtimeContext.ts
@@ -3,7 +3,7 @@ import {
   type StaticHandlerContext,
   type Router,
   type RouterState,
-} from '@modern-js/utils/runtime/remix-router';
+} from '@modern-js/runtime-utils/remix-router';
 import { createContext } from 'react';
 import { createLoaderManager } from './core/loader/loaderManager';
 import { runtime } from './core/plugin';

diff --git a/packages/runtime/plugin-runtime/src/ssr/cli/index.ts b/packages/runtime/plugin-runtime/src/ssr/cli/index.ts
@@ -105,9 +105,9 @@ export const ssrPlugin = (): CliPlugin<AppTools> => ({
         return {
           source: {
             alias: {
-              // ensure that all packages use the same storage in @modern-js/utils/runtime-node
-              '@modern-js/utils/runtime-node$': require.resolve(
-                '@modern-js/utils/runtime-node',
+              // ensure that all packages use the same storage in @modern-js/runtime-utils/node
+              '@modern-js/runtime-utils/node$': require.resolve(
+                '@modern-js/runtime-utils/node',
               ),
               '@modern-js/runtime/plugins': pluginsExportsUtils.getPath(),
             },

diff --git a/packages/runtime/plugin-runtime/src/ssr/index.tsx b/packages/runtime/plugin-runtime/src/ssr/index.tsx
@@ -1,6 +1,6 @@
 import { loadableReady } from '@loadable/component';
 import hoistNonReactStatics from 'hoist-non-react-statics';
-import { parsedJSONFromElement } from '@modern-js/utils/runtime-browser';
+import { parsedJSONFromElement } from '@modern-js/runtime-utils/browser';
 import type { Plugin } from '../core';
 import {
   RenderLevel,

diff --git a/packages/runtime/plugin-runtime/src/ssr/prefetch.tsx b/packages/runtime/plugin-runtime/src/ssr/prefetch.tsx
@@ -1,5 +1,5 @@
 import { renderToStaticMarkup } from 'react-dom/server';
-import { run } from '@modern-js/utils/runtime-node';
+import { run } from '@modern-js/runtime-utils/node';
 import { ChunkExtractor } from '@loadable/server';
 import { RuntimeContext } from '../core';
 import { SSRPluginConfig } from './serverRender/types';

diff --git a/packages/runtime/plugin-runtime/src/ssr/serverRender/renderToStream/buildTemplate.after.ts b/packages/runtime/plugin-runtime/src/ssr/serverRender/renderToStream/buildTemplate.after.ts
@@ -1,4 +1,4 @@
-import { serializeJson } from '@modern-js/utils/runtime-node';
+import { serializeJson } from '@modern-js/runtime-utils/node';
 import { RenderLevel, RuntimeContext } from '../types';
 import { attributesToString } from '../utils';
 import { BuildTemplateCb, buildTemplate } from './buildTemplate.share';

diff --git a/packages/runtime/plugin-runtime/src/ssr/serverRender/renderToStream/bulidTemplate.before.ts b/packages/runtime/plugin-runtime/src/ssr/serverRender/renderToStream/bulidTemplate.before.ts
@@ -1,6 +1,6 @@
 import ReactHelmet, { HelmetData } from 'react-helmet';
 // Todo: This import will introduce router code, like remix, even if router config is false
-import { matchRoutes } from '@modern-js/utils/runtime/router';
+import { matchRoutes } from '@modern-js/runtime-utils/router';
 import helmetReplace from '../helmet';
 import { RuntimeContext } from '../types';
 import { CSS_CHUNKS_PLACEHOLDER } from '../utils';

diff --git a/packages/runtime/plugin-runtime/src/ssr/serverRender/renderToStream/index.ts b/packages/runtime/plugin-runtime/src/ssr/serverRender/renderToStream/index.ts
@@ -1,6 +1,6 @@
 import { createElement } from 'react';
-import { run } from '@modern-js/utils/runtime-node';
-import { time } from '@modern-js/utils/universal/time';
+import { run } from '@modern-js/runtime-utils/node';
+import { time } from '@modern-js/runtime-utils/time';
 import { PreRender } from '../../react/prerender';
 import { ServerRenderOptions } from '../types';
 import { SSRErrors, SSRTimings } from '../tracker';

diff --git a/packages/runtime/plugin-runtime/src/ssr/serverRender/renderToString/entry.ts b/packages/runtime/plugin-runtime/src/ssr/serverRender/renderToString/entry.ts
@@ -1,8 +1,8 @@
 import React from 'react';
-import { serializeJson } from '@modern-js/utils/runtime-node';
+import { serializeJson } from '@modern-js/runtime-utils/node';
 import ReactHelmet, { HelmetData } from 'react-helmet';
 // Todo: This import will introduce router code, like remix, even if router config is false
-import { time } from '@modern-js/utils/universal/time';
+import { time } from '@modern-js/runtime-utils/time';
 import { serializeErrors } from '../../../router/runtime/utils';
 import helmetReplace from '../helmet';
 import {

diff --git a/packages/runtime/plugin-runtime/src/ssr/serverRender/renderToString/index.ts b/packages/runtime/plugin-runtime/src/ssr/serverRender/renderToString/index.ts
@@ -1,5 +1,5 @@
-import { run } from '@modern-js/utils/runtime-node';
-import { time } from '@modern-js/utils/universal/time';
+import { run } from '@modern-js/runtime-utils/node';
+import { time } from '@modern-js/runtime-utils/time';
 import { ServerRenderOptions } from '../types';
 import { PreRender } from '../../react/prerender';
 import { SSRTimings } from '../tracker';

diff --git a/packages/runtime/plugin-runtime/tests/router/prefetch.test.tsx b/packages/runtime/plugin-runtime/tests/router/prefetch.test.tsx
@@ -3,7 +3,7 @@ import {
   createMemoryRouter,
   LoaderFunctionArgs,
   RouterProvider,
-} from '@modern-js/utils/runtime/router';
+} from '@modern-js/runtime-utils/router';
 import { render, fireEvent, act, waitFor } from '@testing-library/react';
 import { Link } from '../../src/router';
 import { RuntimeReactContext } from '../../src';

diff --git a/packages/runtime/plugin-runtime/tests/ssr/index.test.ts b/packages/runtime/plugin-runtime/tests/ssr/index.test.ts
@@ -1,4 +1,4 @@
-import { time } from '@modern-js/utils/universal/time';
+import { time } from '@modern-js/runtime-utils/time';
 import plugin from '../../src/ssr';
 import cliPlugin from '../../src/ssr/cli';
 import { formatClient, formatServer } from '../../src/ssr/utils';

diff --git a/packages/server/create-request/package.json b/packages/server/create-request/package.json
@@ -68,6 +68,7 @@
   },
   "dependencies": {
     "@modern-js/utils": "workspace:*",
+    "@modern-js/runtime-utils": "workspace:*",
     "node-fetch": "^2.6.1",
     "path-to-regexp": "^6.2.0",
     "query-string": "^7.1.1",

diff --git a/packages/server/create-request/src/node.ts b/packages/server/create-request/src/node.ts
@@ -1,6 +1,6 @@
 import nodeFetch from 'node-fetch';
 import { compile, pathToRegexp, Key } from 'path-to-regexp';
-import { useHeaders } from '@modern-js/utils/runtime-node';
+import { useHeaders } from '@modern-js/runtime-utils/node';
 import { stringify } from 'query-string';
 import { handleRes } from './handleRes';
 import type {

diff --git a/packages/server/create-request/tests/node.test.ts b/packages/server/create-request/tests/node.test.ts
@@ -2,7 +2,7 @@
  * @jest-environment node
  */
 import nock from 'nock';
-import { run } from '@modern-js/utils/runtime-node';
+import { run } from '@modern-js/runtime-utils/node';
 // 如果通过 default 引入会报 "Property exprName of TSTypeQuery expected node to be of a type ["TSEntityName","TSImportType"] but instead got "MemberExpression"
 import * as fetch from 'node-fetch';
 import { Response } from 'node-fetch';

diff --git a/packages/server/prod-server/package.json b/packages/server/prod-server/package.json
@@ -73,6 +73,7 @@
     "@modern-js/plugin": "workspace:*",
     "@modern-js/server-core": "workspace:*",
     "@modern-js/utils": "workspace:*",
+    "@modern-js/runtime-utils": "workspace:*",
     "@swc/helpers": "0.5.1",
     "cookie": "^0.4.2",
     "etag": "^1.8.1",

diff --git a/packages/server/prod-server/src/libs/preload/parseLinks.ts b/packages/server/prod-server/src/libs/preload/parseLinks.ts
@@ -6,8 +6,8 @@ import {
   fs,
 } from '@modern-js/utils';
 import { parse as htmlParse } from 'node-html-parser';
-import { matchRoutes } from '@modern-js/utils/runtime/remix-router';
-import { matchEntry } from '@modern-js/utils/runtime-node';
+import { matchRoutes } from '@modern-js/runtime-utils/remix-router';
+import { matchEntry } from '@modern-js/runtime-utils/node';
 
 export interface Link {
   uri: string;

diff --git a/packages/server/prod-server/src/server/modernServer.ts b/packages/server/prod-server/src/server/modernServer.ts
@@ -16,7 +16,7 @@ import {
   LoaderHandler,
 } from '@modern-js/server-core';
 import { type ModernServerContext, type ServerRoute } from '@modern-js/types';
-import { time } from '@modern-js/utils/universal/time';
+import { time } from '@modern-js/runtime-utils/time';
 import type { ContextOptions } from '../libs/context';
 import {
   ModernServerOptions,

diff --git a/packages/server/server/package.json b/packages/server/server/package.json
@@ -52,6 +52,7 @@
     "@modern-js/server-utils": "workspace:*",
     "@modern-js/types": "workspace:*",
     "@modern-js/utils": "workspace:*",
+    "@modern-js/runtime-utils": "workspace:*",
     "@swc/helpers": "0.5.1",
     "connect-history-api-fallback": "^2.0.0",
     "http-compression": "1.0.6",