chore: add context parameters to updateModules hook

examples/vue3/farm.config.ts

@@ -1,6 +1,7 @@
 import { defineConfig } from "@farmfe/core";
 // import Vue from "unplugin-vue/farm";
-import Vue from "unplugin-vue/vite";
+// import Vue from "unplugin-vue/vite";
+import Vue from "@vitejs/plugin-vue";
 import fs from 'fs'
 
 export default defineConfig({

examples/vue3/package.json

@@ -13,7 +13,6 @@
     "@module-federation/vite": "^1.1.1",
     "unplugin-auto-import": "^0.16.7",
     "unplugin-vue-router": "^0.7.0",
-    "unplugin-vue": "/Users/adny/typescript/unplugin-vue",
     "vue": "^3.4.0",
     "vue-router": "^4.4.3"
   },

examples/vue3/src/App.vue

@@ -9,7 +9,7 @@ import HelloWorld from "./components/HelloWorld.vue";
       <img src="./assets/logo.png" class="logo" alt="Farm logo" /> </a>
     <a href="https://vuejs.org/" target="_blank">
       <img src="./assets/vue.svg" class="logo vue" alt="Vue logo" />
-    </a>2222
+    </a>
   </div>
   <HelloWorld msg="Farm + Vue" />
 </template>

packages/core/src/config/index.ts

@@ -1,5 +1,6 @@
 import { createHash } from 'node:crypto';
 import fs from 'node:fs';
+import { readFile } from 'node:fs/promises';
 import { createRequire } from 'node:module';
 import path from 'node:path';
 import { pathToFileURL } from 'node:url';
@@ -45,6 +46,7 @@ import { normalizePersistentCache } from './normalize-config/normalize-persisten
 import { parseUserConfig } from './schema.js';
 
 import { externalAdapter } from '../plugin/js/external-adapter.js';
+import { ViteModuleGraphAdapter } from '../plugin/js/vite-server-adapter.js';
 import { convertErrorMessage } from '../utils/error.js';
 import { resolveHostname } from '../utils/http.js';
 import merge from '../utils/merge.js';
@@ -69,6 +71,8 @@ import type {
   FarmCliOptions,
   Format,
   HmrOptions,
+  ModuleContext,
+  ModuleNode,
   NormalizedServerConfig,
   ResolvedCompilation,
   ResolvedUserConfig,
@@ -909,8 +913,9 @@ export async function resolvePlugins(
 ) {
   const { jsPlugins: rawJsPlugins, rustPlugins } =
     await resolveFarmPlugins(userConfig);
-  const jsPlugins = await resolveAndFilterAsyncPlugins(rawJsPlugins);
-
+  const jsPlugins = (await resolveAndFilterAsyncPlugins(rawJsPlugins)).map(
+    wrapPluginUpdateModules
+  );
   const vitePlugins = (userConfig?.vitePlugins ?? []).filter(Boolean);
 
   const vitePluginAdapters = vitePlugins.length
@@ -1109,3 +1114,41 @@ function getNamespaceName(rootPath: string) {
   }
   return FARM_DEFAULT_NAMESPACE;
 }
+
+function wrapPluginUpdateModules(plugin: JsPlugin): JsPlugin {
+  if (!plugin.updateModules?.executor) {
+    return plugin;
+  }
+  const originalExecutor = plugin.updateModules.executor;
+  const moduleGraph = new ViteModuleGraphAdapter(plugin.name);
+
+  plugin.updateModules.executor = async ({ paths }, ctx) => {
+    moduleGraph.context = ctx;
+    for (const [file, type] of paths) {
+      const mods = moduleGraph.getModulesByFile(
+        file
+      ) as unknown as ModuleNode[];
+
+      const filename = normalizePath(file);
+      const moduleContext: ModuleContext = {
+        file: filename,
+        timestamp: Date.now(),
+        type,
+        paths,
+        modules: (mods ?? []).map(
+          (m) =>
+            ({
+              ...m,
+              id: normalizePath(m.id),
+              file: normalizePath(m.file)
+            }) as ModuleNode
+        ),
+        read: function (): string | Promise<string> {
+          return readFile(file, 'utf-8');
+        }
+      };
+      return originalExecutor.call(plugin, moduleContext);
+    }
+  };
+  return plugin;
+}

packages/core/src/config/types.ts

@@ -278,3 +278,22 @@ export type EnvResult = Record<
   `$__farm_regex:(global(This)?\\.)?process\\.env\\.${string}`,
   string
 >;
+
+export interface ModuleNode {
+  url: string;
+  /**
+   * Resolved file system path + query
+   */
+  id: string | null;
+  file: string | null;
+  type: 'js' | 'css';
+}
+
+export interface ModuleContext {
+  file: string;
+  timestamp: number;
+  type: string;
+  modules: ModuleNode[];
+  paths: string[];
+  read: (file: string) => string | Promise<string>;
+}

packages/core/src/plugin/js/js-plugin-schema.ts

@@ -14,6 +14,18 @@ const CallbackSchemaNotArgs = z
   .function()
   .returns(z.union([z.void(), z.promise(z.void())]));
 
+const updateModulesCallbackSchema = z
+  .function()
+  .returns(
+    z.union([
+      z.array(z.any()),
+      z.promise(z.array(z.any())),
+      z.void(),
+      z.promise(z.void())
+    ])
+  )
+  .optional();
+
 // name schema
 export const nameSchema = z.string().min(1);
 
@@ -469,7 +481,7 @@ export const createUpdateFinishedSchema = (name: string) => {
 export const createUpdateModulesSchema = (name: string) => {
   return z
     .object({
-      executor: CallbackSchemaNotArgs
+      executor: updateModulesCallbackSchema
     })
     .refine(
       (data) => {

packages/core/src/plugin/js/vite-plugin-adapter.ts

@@ -624,6 +624,7 @@ export class VitePluginAdapter implements JsPlugin {
             const mods = moduleGraph.getModulesByFile(
               file
             ) as unknown as ModuleNode[];
+
             const filename = normalizePath(file);
             const ctx: HmrContext = {
               file: filename,
@@ -641,7 +642,6 @@ export class VitePluginAdapter implements JsPlugin {
               },
               server: this._viteDevServer as unknown as ViteDevServer
             };
-            console.log(ctx.modules);
 
             const updateMods: ModuleNode[] = await hook?.(ctx);
 

packages/core/src/plugin/type.ts

@@ -1,4 +1,10 @@
-import { Compiler, ResolvedUserConfig, Server, UserConfig } from '../index.js';
+import {
+  Compiler,
+  ModuleContext,
+  ResolvedUserConfig,
+  Server,
+  UserConfig
+} from '../index.js';
 
 import {
   Config,
@@ -249,10 +255,7 @@ export interface JsPlugin {
   updateFinished?: { executor: Callback<Record<string, never>, void> };
 
   updateModules?: {
-    executor: Callback<
-      { paths: [string, string][] },
-      string[] | undefined | null | void
-    >;
+    executor: Callback<ModuleContext, string[] | undefined | null | void>;
   };
 }
 

packages/core/src/server/hmr-engine.ts

@@ -73,7 +73,7 @@ export class HmrEngine {
       if (this._updateQueue.length > 0) {
         await this.recompileAndSendResult();
       }
-      if (this.app.resolvedUserConfig?.server.writeToDisk) {
+      if (this.app.config?.server.writeToDisk) {
         this.app.compiler.writeResourcesToDisk();
       }
     });
@@ -180,9 +180,7 @@ export class HmrEngine {
             {
               type: 'error',
               err: ${errorStr},
-              overlay: ${
-                (this.app.resolvedUserConfig.server.hmr as HmrOptions).overlay
-              }
+              overlay: ${(this.app.config.server.hmr as HmrOptions).overlay}
             }
           `);
         });