react-email 4.1.0-canary.7 → 4.1.0-canary.9

package/src/utils/preview/hot-reloading/create-dependency-graph.ts

@@ -0,0 +1,321 @@
+import { existsSync, promises as fs, statSync } from 'node:fs';
+import path from 'node:path';
+import type { EventName } from 'chokidar/handler.js';
+import { isDev } from '../start-dev-server.js';
+import { getImportedModules } from './get-imported-modules.js';
+import { resolvePathAliases } from './resolve-path-aliases.js';
+
+interface Module {
+  path: string;
+
+  dependencyPaths: string[];
+  dependentPaths: string[];
+
+  moduleDependencies: string[];
+}
+
+export type DependencyGraph = Record</* path to module */ string, Module>;
+
+const readAllFilesInsideDirectory = async (directory: string) => {
+  let allFilePaths: string[] = [];
+
+  const topLevelDirents = await fs.readdir(directory, { withFileTypes: true });
+
+  for await (const dirent of topLevelDirents) {
+    const pathToDirent = path.join(directory, dirent.name);
+    if (dirent.isDirectory()) {
+      allFilePaths = allFilePaths.concat(
+        await readAllFilesInsideDirectory(pathToDirent),
+      );
+    } else {
+      allFilePaths.push(pathToDirent);
+    }
+  }
+
+  return allFilePaths;
+};
+
+const isJavascriptModule = (filePath: string) => {
+  const extensionName = path.extname(filePath);
+
+  return ['.js', '.ts', '.jsx', '.tsx', '.mjs', '.cjs'].includes(extensionName);
+};
+
+const checkFileExtensionsUntilItExists = (
+  pathWithoutExtension: string,
+): string | undefined => {
+  if (existsSync(`${pathWithoutExtension}.ts`)) {
+    return `${pathWithoutExtension}.ts`;
+  }
+
+  if (existsSync(`${pathWithoutExtension}.tsx`)) {
+    return `${pathWithoutExtension}.tsx`;
+  }
+
+  if (existsSync(`${pathWithoutExtension}.js`)) {
+    return `${pathWithoutExtension}.js`;
+  }
+
+  if (existsSync(`${pathWithoutExtension}.jsx`)) {
+    return `${pathWithoutExtension}.jsx`;
+  }
+
+  if (existsSync(`${pathWithoutExtension}.mjs`)) {
+    return `${pathWithoutExtension}.mjs`;
+  }
+
+  if (existsSync(`${pathWithoutExtension}.cjs`)) {
+    return `${pathWithoutExtension}.cjs`;
+  }
+};
+
+/**
+ * Creates a stateful dependency graph that is structured in a way that you can get
+ * the dependents of a module from its path.
+ *
+ * Stateful in the sense that it provides a `getter` and an "`updater`". The updater
+ * will receive changes to the files, that can be perceived through some file watching mechanism,
+ * so that it doesn't need to recompute the entire dependency graph but only the parts changed.
+ */
+export const createDependencyGraph = async (directory: string) => {
+  const filePaths = await readAllFilesInsideDirectory(directory);
+  const modulePaths = filePaths.filter(isJavascriptModule);
+  const graph: DependencyGraph = Object.fromEntries(
+    modulePaths.map((path) => [
+      path,
+      {
+        path,
+        dependencyPaths: [],
+        dependentPaths: [],
+        moduleDependencies: [],
+      },
+    ]),
+  );
+
+  const getDependencyPaths = async (filePath: string) => {
+    const contents = await fs.readFile(filePath, 'utf8');
+    const importedPaths = isJavascriptModule(filePath)
+      ? resolvePathAliases(getImportedModules(contents), path.dirname(filePath))
+      : [];
+    const importedPathsRelativeToDirectory = importedPaths.map(
+      (dependencyPath) => {
+        const isModulePath = !dependencyPath.startsWith('.');
+
+        /*
+          path.isAbsolute will return false if the path looks like JavaScript module imports
+          e.g. path.isAbsolute('react-dom/server') will return false, but for our purposes this
+          path is not a relative one.
+        */
+        if (isModulePath || path.isAbsolute(dependencyPath)) {
+          return dependencyPath;
+        }
+
+        let pathToDependencyFromDirectory = path.resolve(
+          /*
+            path.resolve resolves paths differently from what imports on javascript do.
+
+            So if we wouldn't do this, for an email at "/path/to/email.tsx" with a dependency path of "./other-email" 
+            would end up going into /path/to/email.tsx/other-email instead of /path/to/other-email which is the
+            one the import is meant to go to
+          */
+          path.dirname(filePath),
+          dependencyPath,
+        );
+
+        let isDirectory = false;
+        try {
+          // will throw if the the file is not existent
+          isDirectory = statSync(pathToDependencyFromDirectory).isDirectory();
+        } catch (_) {}
+        if (isDirectory) {
+          const pathToSubDirectory = pathToDependencyFromDirectory;
+          const pathWithExtension = checkFileExtensionsUntilItExists(
+            `${pathToSubDirectory}/index`,
+          );
+          if (pathWithExtension) {
+            pathToDependencyFromDirectory = pathWithExtension;
+          } else if (isDev) {
+            // only warn about this on development as it is probably going to be irrelevant otherwise
+            console.warn(
+              `Could not find index file for directory at ${pathToDependencyFromDirectory}. This is probably going to cause issues with both hot reloading and your code.`,
+            );
+          }
+        }
+
+        const extension = path.extname(pathToDependencyFromDirectory);
+        const pathWithEnsuredExtension = (() => {
+          if (
+            extension.length > 0 &&
+            existsSync(pathToDependencyFromDirectory)
+          ) {
+            return pathToDependencyFromDirectory;
+          }
+          return checkFileExtensionsUntilItExists(
+            pathToDependencyFromDirectory.replace(extension, ''),
+          );
+        })();
+
+        if (pathWithEnsuredExtension) {
+          pathToDependencyFromDirectory = pathWithEnsuredExtension;
+        } else if (isDev) {
+          // only warn about this on development as it is probably going to be irrelevant otherwise
+          console.warn(
+            `Could not find file at ${pathToDependencyFromDirectory}`,
+          );
+        }
+
+        return pathToDependencyFromDirectory;
+      },
+    );
+
+    const moduleDependencies = importedPathsRelativeToDirectory.filter(
+      (dependencyPath) =>
+        !dependencyPath.startsWith('.') && !path.isAbsolute(dependencyPath),
+    );
+
+    const nonNodeModuleImportPathsRelativeToDirectory =
+      importedPathsRelativeToDirectory.filter(
+        (dependencyPath) =>
+          dependencyPath.startsWith('.') || path.isAbsolute(dependencyPath),
+      );
+
+    return {
+      dependencyPaths: nonNodeModuleImportPathsRelativeToDirectory,
+      moduleDependencies,
+    };
+  };
+
+  const updateModuleDependenciesInGraph = async (moduleFilePath: string) => {
+    if (graph[moduleFilePath] === undefined) {
+      graph[moduleFilePath] = {
+        path: moduleFilePath,
+        dependencyPaths: [],
+        dependentPaths: [],
+        moduleDependencies: [],
+      };
+    }
+
+    const { moduleDependencies, dependencyPaths: newDependencyPaths } =
+      await getDependencyPaths(moduleFilePath);
+
+    graph[moduleFilePath].moduleDependencies = moduleDependencies;
+
+    // we go through these to remove the ones that don't exist anymore
+    for (const dependencyPath of graph[moduleFilePath].dependencyPaths) {
+      // Looping through only the ones that were on the dependencyPaths but are not
+      // in the newDependencyPaths
+      if (newDependencyPaths.includes(dependencyPath)) continue;
+
+      const dependencyModule = graph[dependencyPath];
+      if (dependencyModule !== undefined) {
+        dependencyModule.dependentPaths =
+          dependencyModule.dependentPaths.filter(
+            (dependentPath) => dependentPath !== moduleFilePath,
+          );
+      }
+    }
+
+    graph[moduleFilePath].dependencyPaths = newDependencyPaths;
+
+    for await (const dependencyPath of newDependencyPaths) {
+      if (graph[dependencyPath] === undefined) {
+        /*
+          This import path might have not been initialized as it can be outside
+          of the original directory we looked into.
+        */
+        await updateModuleDependenciesInGraph(dependencyPath);
+      }
+
+      const dependencyModule = graph[dependencyPath];
+
+      if (dependencyModule === undefined) {
+        throw new Error(
+          `Loading the dependency path ${dependencyPath} did not initialize it at all. This is a bug in React Email.`,
+        );
+      }
+
+      if (!dependencyModule.dependentPaths.includes(moduleFilePath)) {
+        dependencyModule.dependentPaths.push(moduleFilePath);
+      }
+    }
+  };
+
+  for (const filePath of modulePaths) {
+    await updateModuleDependenciesInGraph(filePath);
+  }
+
+  const removeModuleFromGraph = (filePath: string) => {
+    const module = graph[filePath];
+    if (module) {
+      for (const dependencyPath of module.dependencyPaths) {
+        if (graph[dependencyPath]) {
+          graph[dependencyPath]!.dependentPaths = graph[
+            dependencyPath
+          ]!.dependentPaths.filter(
+            (dependentPath) => dependentPath !== filePath,
+          );
+        }
+      }
+      delete graph[filePath];
+    }
+  };
+
+  return [
+    graph,
+    async (event: EventName, pathToModified: string) => {
+      switch (event) {
+        case 'change':
+          if (isJavascriptModule(pathToModified)) {
+            await updateModuleDependenciesInGraph(pathToModified);
+          }
+          break;
+        case 'add':
+          if (isJavascriptModule(pathToModified)) {
+            await updateModuleDependenciesInGraph(pathToModified);
+          }
+          break;
+        case 'addDir': {
+          const filesInsideAddedDirectory =
+            await readAllFilesInsideDirectory(pathToModified);
+          const modulesInsideAddedDirectory =
+            filesInsideAddedDirectory.filter(isJavascriptModule);
+          for await (const filePath of modulesInsideAddedDirectory) {
+            await updateModuleDependenciesInGraph(filePath);
+          }
+          break;
+        }
+        case 'unlink':
+          if (isJavascriptModule(pathToModified)) {
+            removeModuleFromGraph(pathToModified);
+          }
+          break;
+        case 'unlinkDir': {
+          const filesInsideDeletedDirectory =
+            await readAllFilesInsideDirectory(pathToModified);
+          const modulesInsideDeletedDirectory =
+            filesInsideDeletedDirectory.filter(isJavascriptModule);
+          for await (const filePath of modulesInsideDeletedDirectory) {
+            removeModuleFromGraph(filePath);
+          }
+          break;
+        }
+      }
+    },
+    {
+      resolveDependentsOf: function resolveDependentsOf(pathToModule: string) {
+        const moduleEntry = graph[pathToModule];
+        const dependentPaths: Array<string> = [];
+
+        if (moduleEntry) {
+          for (const dependentPath of moduleEntry.dependentPaths) {
+            const dependentsOfDependent = resolveDependentsOf(dependentPath);
+            dependentPaths.push(...dependentsOfDependent);
+            dependentPaths.push(dependentPath);
+          }
+        }
+
+        return dependentPaths;
+      },
+    },
+  ] as const;
+};

package/src/utils/preview/hot-reloading/get-imported-modules.spec.ts

@@ -0,0 +1,151 @@
+import { promises as fs } from 'node:fs';
+import { getImportedModules } from './get-imported-modules.js';
+
+vi.mock('@babel/traverse', async () => {
+  const traverse = await vi.importActual('@babel/traverse');
+  return { default: traverse };
+});
+
+describe('getImportedModules()', () => {
+  it('should work with this test file', async () => {
+    const contents = await fs.readFile(import.meta.filename, 'utf8');
+
+    expect(getImportedModules(contents)).toEqual([
+      'node:fs',
+      './get-imported-modules.js',
+    ]);
+  });
+
+  it('should work with direct exports', () => {
+    const contents = `export * from './component-a';
+    export { ComponentB } from './component-b'; 
+
+    import { ComponentC } from './component-c';
+    export { ComponentC }`;
+    expect(getImportedModules(contents)).toEqual([
+      './component-a',
+      './component-b',
+      './component-c',
+    ]);
+  });
+
+  it('should work with regular imports and double quotes', () => {
+    const contents = `import {
+  Body,
+  Button,
+  Container,
+  Column,
+  Head,
+  Heading,
+  Hr,
+  Html,
+  Img,
+  Link,
+  Preview,
+  Row,
+  Section,
+  Text,
+} from "@react-email/components";
+import { Tailwind } from "@react-email/tailwind";
+import { Component } from '../../my-component';
+
+import * as React from "react";
+    `;
+    expect(getImportedModules(contents)).toEqual([
+      '@react-email/components',
+      '@react-email/tailwind',
+      '../../my-component',
+      'react',
+    ]);
+  });
+
+  it('should work with regular imports and single quotes', () => {
+    const contents = `import {
+  Body,
+  Button,
+  Container,
+  Column,
+  Head,
+  Heading,
+  Hr,
+  Html,
+  Img,
+  Link,
+  Preview,
+  Row,
+  Section,
+  Text,
+} from '@react-email/components';
+import { Tailwind } from '@react-email/tailwind';
+import { Component } from '../../my-component';
+
+import * as React from 'react';
+    `;
+    expect(getImportedModules(contents)).toEqual([
+      '@react-email/components',
+      '@react-email/tailwind',
+      '../../my-component',
+      'react',
+    ]);
+  });
+
+  it('should work with commonjs require with double quotes', () => {
+    const contents = `const {
+  Body,
+  Button,
+  Container,
+  Column,
+  Head,
+  Heading,
+  Hr,
+  Html,
+  Img,
+  Link,
+  Preview,
+  Row,
+  Section,
+  Text,
+} = require("@react-email/components");
+const { Tailwind } = require("@react-email/tailwind");
+const { Component } = require("../../my-component");
+
+const React = require("react");
+    `;
+    expect(getImportedModules(contents)).toEqual([
+      '@react-email/components',
+      '@react-email/tailwind',
+      '../../my-component',
+      'react',
+    ]);
+  });
+
+  it('should work with commonjs require with single quotes', () => {
+    const contents = `const {
+  Body,
+  Button,
+  Container,
+  Column,
+  Head,
+  Heading,
+  Hr,
+  Html,
+  Img,
+  Link,
+  Preview,
+  Row,
+  Section,
+  Text,
+} = require('@react-email/components');
+const { Tailwind } = require('@react-email/tailwind');
+const { Component } = require('../../my-component');
+
+const React = require('react');
+    `;
+    expect(getImportedModules(contents)).toEqual([
+      '@react-email/components',
+      '@react-email/tailwind',
+      '../../my-component',
+      'react',
+    ]);
+  });
+});

package/src/utils/preview/hot-reloading/get-imported-modules.ts

@@ -0,0 +1,49 @@
+import { parse } from '@babel/parser';
+
+import traverseModule from '@babel/traverse';
+
+const traverse =
+  // we keep this check here so that this still works with the dev:preview
+  // script's use of tsx
+  typeof traverseModule === 'function'
+    ? traverseModule
+    : traverseModule.default;
+
+export const getImportedModules = (contents: string) => {
+  const importedPaths: string[] = [];
+  const parsedContents = parse(contents, {
+    sourceType: 'unambiguous',
+    strictMode: false,
+    errorRecovery: true,
+    plugins: ['jsx', 'typescript', 'decorators'],
+  });
+
+  traverse(parsedContents, {
+    ImportDeclaration({ node }) {
+      importedPaths.push(node.source.value);
+    },
+    ExportAllDeclaration({ node }) {
+      importedPaths.push(node.source.value);
+    },
+    ExportNamedDeclaration({ node }) {
+      if (node.source) {
+        importedPaths.push(node.source.value);
+      }
+    },
+    TSExternalModuleReference({ node }) {
+      importedPaths.push(node.expression.value);
+    },
+    CallExpression({ node }) {
+      if ('name' in node.callee && node.callee.name === 'require') {
+        if (node.arguments.length === 1) {
+          const importPathNode = node.arguments[0]!;
+          if (importPathNode!.type === 'StringLiteral') {
+            importedPaths.push(importPathNode.value);
+          }
+        }
+      }
+    },
+  });
+
+  return importedPaths;
+};

package/src/utils/preview/hot-reloading/resolve-path-aliases.spec.ts

@@ -0,0 +1,11 @@
+import path from 'node:path';
+import { resolvePathAliases } from './resolve-path-aliases.js';
+
+test('resolveImports()', async () => {
+  expect(
+    resolvePathAliases(
+      ['@/some-file'],
+      path.resolve(import.meta.dirname, './test'),
+    ),
+  ).toEqual(['./some-file']);
+});

package/src/utils/preview/hot-reloading/resolve-path-aliases.ts

@@ -0,0 +1,32 @@
+import path from 'node:path';
+import { createMatchPath, loadConfig } from 'tsconfig-paths';
+
+export const resolvePathAliases = (
+  importPaths: string[],
+  projectPath: string,
+) => {
+  const configLoadResult = loadConfig(projectPath);
+
+  if (configLoadResult.resultType === 'success') {
+    const matchPath = createMatchPath(
+      configLoadResult.absoluteBaseUrl,
+      configLoadResult.paths,
+    );
+    return importPaths.map((importedPath) => {
+      const unaliasedPath = matchPath(importedPath, undefined, undefined, [
+        '.tsx',
+        '.ts',
+        '.js',
+        '.jsx',
+        '.cjs',
+        '.mjs',
+      ]);
+      if (unaliasedPath) {
+        return `./${path.relative(projectPath, unaliasedPath)}`;
+      }
+      return importedPath;
+    });
+  }
+
+  return importPaths;
+};

package/src/utils/preview/hot-reloading/setup-hot-reloading.ts

@@ -0,0 +1,121 @@
+import type http from 'node:http';
+import path from 'node:path';
+import { watch } from 'chokidar';
+import debounce from 'debounce';
+import { type Socket, Server as SocketServer } from 'socket.io';
+import type { HotReloadChange } from '../../types/hot-reload-change.js';
+import { createDependencyGraph } from './create-dependency-graph.js';
+
+export const setupHotreloading = async (
+  devServer: http.Server,
+  emailDirRelativePath: string,
+) => {
+  let clients: Socket[] = [];
+  const io = new SocketServer(devServer);
+
+  io.on('connection', (client) => {
+    clients.push(client);
+
+    client.on('disconnect', () => {
+      clients = clients.filter((item) => item !== client);
+    });
+  });
+
+  // used to keep track of all changes
+  // and send them at once to the preview app through the web socket
+  let changes = [] as HotReloadChange[];
+
+  const reload = debounce(() => {
+    // we detect these using the useHotreload hook on the Next app
+    clients.forEach((client) => {
+      client.emit(
+        'reload',
+        changes.filter((change) =>
+          // Ensures only changes inside the emails directory are emitted
+          path
+            .resolve(absolutePathToEmailsDirectory, change.filename)
+            .startsWith(absolutePathToEmailsDirectory),
+        ),
+      );
+    });
+
+    changes = [];
+  }, 150);
+
+  const absolutePathToEmailsDirectory = path.resolve(
+    process.cwd(),
+    emailDirRelativePath,
+  );
+
+  const [dependencyGraph, updateDependencyGraph, { resolveDependentsOf }] =
+    await createDependencyGraph(absolutePathToEmailsDirectory);
+
+  const watcher = watch('', {
+    ignoreInitial: true,
+    cwd: absolutePathToEmailsDirectory,
+  });
+
+  const getFilesOutsideEmailsDirectory = () =>
+    Object.keys(dependencyGraph).filter((p) =>
+      path.relative(absolutePathToEmailsDirectory, p).startsWith('..'),
+    );
+  let filesOutsideEmailsDirectory = getFilesOutsideEmailsDirectory();
+  // adds in to be watched separately all of the files that are outside of
+  // the user's emails directory
+  for (const p of filesOutsideEmailsDirectory) {
+    watcher.add(p);
+  }
+
+  const exit = async () => {
+    await watcher.close();
+  };
+  process.on('SIGINT', exit);
+  process.on('uncaughtException', exit);
+
+  watcher.on('all', async (event, relativePathToChangeTarget) => {
+    const file = relativePathToChangeTarget.split(path.sep);
+    if (file.length === 0) {
+      return;
+    }
+    const pathToChangeTarget = path.resolve(
+      absolutePathToEmailsDirectory,
+      relativePathToChangeTarget,
+    );
+
+    await updateDependencyGraph(event, pathToChangeTarget);
+
+    const newFilesOutsideEmailsDirectory = getFilesOutsideEmailsDirectory();
+    // updates the files outside of the user's emails directory by unwatching
+    // the inexistent ones and watching the new ones
+    //
+    // this is necessary to avoid the issue mentioned here https://github.com/resend/react-email/issues/1433#issuecomment-2177515290
+    for (const p of filesOutsideEmailsDirectory) {
+      if (!newFilesOutsideEmailsDirectory.includes(p)) {
+        watcher.unwatch(p);
+      }
+    }
+    for (const p of newFilesOutsideEmailsDirectory) {
+      if (!filesOutsideEmailsDirectory.includes(p)) {
+        watcher.add(p);
+      }
+    }
+    filesOutsideEmailsDirectory = newFilesOutsideEmailsDirectory;
+
+    changes.push({
+      event,
+      filename: relativePathToChangeTarget,
+    });
+
+    // These dependents are dependents resolved recursively, so even dependents of dependents
+    // will be notified of this change so that we ensure that things are updated in the preview.
+    for (const dependentPath of resolveDependentsOf(pathToChangeTarget)) {
+      changes.push({
+        event: 'change' as const,
+        filename: path.relative(absolutePathToEmailsDirectory, dependentPath),
+      });
+    }
+    reload();
+  });
+
+  return watcher;
+};

package/src/utils/preview/hot-reloading/test/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "paths": {
+      "@/*": ["./*"]
+    }
+  },
+  "include": ["**/*.ts", "**/*.tsx"]
+}

package/src/utils/preview/index.ts

@@ -0,0 +1,2 @@
+export * from './hot-reloading/setup-hot-reloading.js';
+export * from './start-dev-server.js';