@module-federation/sdk 0.0.0-next-20231219090402 → 0.0.0-next-20231219093556

package/README.md

@@ -0,0 +1,99 @@
+# `@module-federation/sdk` Documentation
+
+- This SDK provides utilities and tools to support the implementation of Module Federation in your projects.
+- It contains utility functions for parsing, encoding, and decoding module names, as well as generating filenames for exposed modules and shared packages.
+- It also includes a logger for debugging and environment detection utilities.
+- Additionally, it provides a function to generate a snapshot from a manifest and environment detection utilities.
+
+## Usage
+
+```javascript
+// The SDK can be used to parse entry strings, encode and decode module names, and generate filenames for exposed modules and shared packages.
+// It also includes a logger for debugging and environment detection utilities.
+// Additionally, it provides a function to generate a snapshot from a manifest and environment detection utilities.
+import { parseEntry, encodeName, decodeName, generateExposeFilename, generateShareFilename, Logger, isBrowserEnv, isDebugMode, getProcessEnv, generateSnapshotFromManifest } from '@module-federation/sdk';
+
+// Parse an entry string into a RemoteEntryInfo object
+parseEntry('entryString');
+
+// Encode a module name with a prefix and optional extension
+encodeName('moduleName', 'prefix');
+
+// Decode a module name with a prefix and optional extension
+decodeName('encodedModuleName', 'prefix');
+
+// Generate a filename for an exposed module
+generateExposeFilename('exposeName', true);
+
+// Generate a filename for a shared package
+generateShareFilename('packageName', true);
+
+// Create a new logger
+const logger = new Logger('identifier');
+
+// Check if the current environment is a browser
+isBrowserEnv();
+
+// Check if the current environment is in debug mode
+isDebugMode();
+
+// Get the process environment
+getProcessEnv();
+
+// Generate a snapshot from a manifest
+generateSnapshotFromManifest(manifest, options);
+```
+
+### parseEntry
+
+- Type: `parseEntry(str: string, devVerOrUrl?: string)`
+- Parses a string into a RemoteEntryInfo object.
+
+### encodeName
+
+- Type: `encodeName(name: string, prefix = '', withExt = false)`
+- Encodes a name with a prefix and optional extension.
+
+### decodeName
+
+- Type: `decodeName(name: string, prefix?: string, withExt?: boolean)`
+- Decodes a name with a prefix and optional extension.
+
+### generateExposeFilename
+
+- Type: `generateExposeFilename(exposeName: string, withExt: boolean)`
+- Generates a filename for an expose.
+
+### generateShareFilename
+
+- Type: `generateShareFilename(pkgName: string, withExt: boolean)`
+- Generates a filename for a shared package.
+
+### Logger
+
+- Type: `new Logger(identifier?: string)`
+- Creates a new logger for debugging.
+
+### isBrowserEnv
+
+- Type: `isBrowserEnv()`
+- Checks if the current environment is a browser.
+
+### isDebugMode
+
+- Type: `isDebugMode()`
+- Checks if the current environment is in debug mode.
+
+### getProcessEnv
+
+- Type: `getProcessEnv()`
+- Gets the process environment.
+
+### generateSnapshotFromManifest
+
+- Type: `generateSnapshotFromManifest(manifest: Manifest, options: IOptions = {})`
+- Generates a snapshot from a manifest.
+
+## Testing
+
+The SDK uses Jest for testing. The configuration can be found in `jest.config.js`. The tests are located in the **tests** directory.

package/__tests__/decodeName.spec.ts

@@ -0,0 +1,11 @@
+import { nameMap } from './resources/constant';
+import { decodeName } from '../src';
+
+describe('decodeName', () => {
+  it('should correct decode transformed name', () => {
+    Object.keys(nameMap).forEach((name) => {
+      const transformedName = nameMap[name];
+      expect(decodeName(transformedName)).toBe(name);
+    });
+  });
+});

package/__tests__/encodeName.spec.ts

@@ -0,0 +1,10 @@
+import { nameMap } from './resources/constant';
+import { encodeName } from '../src';
+
+describe('encodeName', () => {
+  it('should correct transform name', () => {
+    Object.keys(nameMap).forEach((name) => {
+      expect(encodeName(name)).toBe(nameMap[name]);
+    });
+  });
+});

package/__tests__/generateSnapshotFromManifest.spec.ts

@@ -0,0 +1,147 @@
+import { manifest, snapshot } from './resources/manifestSnapshotMap';
+import { generateSnapshotFromManifest } from '../src/generateSnapshotFromManifest';
+
+describe('generateSnapshotFromManifest', () => {
+  it('return basic app snapshot with only manifest params in dev', () => {
+    const remoteSnapshot = generateSnapshotFromManifest(
+      manifest.devAppManifest,
+    );
+    expect(remoteSnapshot).toEqual(snapshot.devAppSnapshot);
+  });
+
+  it('return modulePath while expose.path existed', () => {
+    const remoteSnapshot = generateSnapshotFromManifest(
+      manifest.devAppManifest,
+    );
+    expect(remoteSnapshot).toEqual(snapshot.devAppSnapshot);
+    manifest.devAppManifest.exposes.forEach((expose) => {
+      if (expose.path) {
+        expect(
+          Boolean(
+            remoteSnapshot.modules.find((m) => m.modulePath === expose.path),
+          ),
+        ).toEqual(true);
+      }
+    });
+  });
+
+  it('return basic app snapshot with manifest params and version in dev', () => {
+    const remoteSnapshot = generateSnapshotFromManifest(
+      manifest.devAppManifest,
+      { version: 'http://localhost:2006/vmok-manifest.json' },
+    );
+    expect(remoteSnapshot).toEqual(snapshot.devAppSnapshotWithVersion);
+  });
+
+  it('return basic app snapshot with only manifest params in dev with getPublicPath', () => {
+    const remoteSnapshot = generateSnapshotFromManifest(
+      manifest.devAppManifestWithGetPublicPath,
+    );
+    expect(remoteSnapshot).toEqual(snapshot.devAppSnapshotWithGetPublicPath);
+  });
+
+  it('return app snapshot with manifest params in dev with overrides', () => {
+    const remoteSnapshot = generateSnapshotFromManifest(
+      manifest.devAppManifest,
+      {
+        overrides: {
+          '@garfish/micro-app-sub4': 'http://localhost:8080/vmok-manifest.json',
+          '@garfish/micro-app-sub3': '1.0.3',
+        },
+      },
+    );
+    expect(remoteSnapshot).toEqual(snapshot.devAppSnapshotWithOverrides);
+  });
+
+  it('return app snapshot with manifest params in dev with part remotes', () => {
+    const remoteSnapshot = generateSnapshotFromManifest(
+      manifest.devAppManifest,
+      {
+        remotes: {
+          '@garfish/micro-app-sub3': '1.0.3',
+        },
+      },
+    );
+    expect(remoteSnapshot).toEqual(snapshot.devAppSnapshotWithPartRemotes);
+  });
+
+  it('return app snapshot with manifest params in dev with remotes', () => {
+    const remoteSnapshot = generateSnapshotFromManifest(
+      manifest.devAppManifest,
+      {
+        remotes: {
+          '@garfish/micro-app-sub4': '1.2.3',
+          '@garfish/micro-app-sub3': '1.0.3',
+        },
+      },
+    );
+    expect(remoteSnapshot).toEqual(snapshot.devAppSnapshotWithRemotes);
+  });
+
+  it('return app snapshot with manifest params in dev with remotes and overrides', () => {
+    const remoteSnapshot = generateSnapshotFromManifest(
+      manifest.devAppManifest,
+      {
+        remotes: {
+          '@garfish/micro-app-sub4': '1.2.3',
+          '@garfish/micro-app-sub3': '1.0.3',
+        },
+        overrides: {
+          '@garfish/micro-app-sub4': 'http://localhost:8080/vmok-manifest.json',
+          '@garfish/micro-app-sub3': '1.0.4',
+        },
+      },
+    );
+    expect(remoteSnapshot).toEqual(
+      snapshot.devAppSnapshotWithRemotesAndOverrides,
+    );
+  });
+
+  it('return app snapshot with manifest params in dev with all params', () => {
+    const remoteSnapshot = generateSnapshotFromManifest(
+      manifest.devAppManifest,
+      {
+        remotes: {
+          '@garfish/micro-app-sub4': '1.2.3',
+          '@garfish/micro-app-sub3': '1.0.3',
+        },
+        overrides: {
+          '@garfish/micro-app-sub4': 'http://localhost:8080/vmok-manifest.json',
+          '@garfish/micro-app-sub3': '1.0.4',
+        },
+      },
+    );
+    expect(remoteSnapshot).toEqual(snapshot.devAppSnapshotWithAllParams);
+  });
+
+  it('return basic app snapshot with only manifest params in prod', () => {
+    const remoteSnapshot = generateSnapshotFromManifest(
+      manifest.prodAppManifest,
+    );
+    expect(remoteSnapshot).toEqual(snapshot.prodAppSnapshot);
+  });
+
+  it('return basic app snapshot with only manifest params in prod with getPublicPath', () => {
+    const remoteSnapshot = generateSnapshotFromManifest(
+      manifest.prodAppManifestWithGetPublicPath,
+    );
+    expect(remoteSnapshot).toEqual(snapshot.prodAppSnapshotWithGetPublicPath);
+  });
+
+  it('return app snapshot with manifest params in prod with all params', () => {
+    const remoteSnapshot = generateSnapshotFromManifest(
+      manifest.prodAppManifest,
+      {
+        remotes: {
+          '@garfish/micro-app-sub4': '1.2.3',
+          '@garfish/micro-app-sub3': '1.0.3',
+        },
+        overrides: {
+          '@garfish/micro-app-sub4': 'http://localhost:8080/vmok-manifest.json',
+          '@garfish/micro-app-sub3': '1.0.4',
+        },
+      },
+    );
+    expect(remoteSnapshot).toEqual(snapshot.prodAppSnapshotWithAllParams);
+  });
+});

package/__tests__/parseEntry.spec.ts

@@ -0,0 +1,36 @@
+import { parseEntry } from '../src';
+
+describe('parseEntry', () => {
+  it('get correct entryInfo by parsing normal entry', () => {
+    const entry = '@byted/app1:1.2.0';
+
+    const entryInfo = parseEntry(entry);
+
+    expect(entryInfo).toMatchObject({
+      version: '1.2.0',
+      name: '@byted/app1',
+    });
+  });
+
+  it('get correct entryInfo by parsing none version entry', () => {
+    const entry = '@byted/app1';
+
+    const entryInfo = parseEntry(entry);
+
+    expect(entryInfo).toMatchObject({
+      version: '*',
+      name: '@byted/app1',
+    });
+  });
+
+  it('get correct entryInfo by parsing local version entry', () => {
+    const entry = '@byted/app1:http://localhost:8080/vmok-manifest.json';
+
+    const entryInfo = parseEntry(entry);
+
+    expect(entryInfo).toMatchObject({
+      name: '@byted/app1',
+      entry: 'http://localhost:8080/vmok-manifest.json',
+    });
+  });
+});

package/__tests__/resources/constant.ts

@@ -0,0 +1,6 @@
+export const nameMap = {
+  '@byted/app1': 'scope_byted__app1',
+  '@byted-garfish/app1': 'scope_byted_garfish__app1',
+  '@byted-garfish/app1-demo': 'scope_byted_garfish__app1_demo',
+  '@byted-garfish/module-1': 'scope_byted_garfish__module_1',
+};

package/__tests__/resources/getId.ts

@@ -0,0 +1,5 @@
+function getId(): number {
+  return Math.random();
+}
+
+export default getId;