babel-loader/test/metadata.test.js at main · babel/babel-loader · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
import test from "node:test";
import assert from "node:assert/strict";
import path from "node:path";
import fs from "node:fs";
import createTestDirectory from "./helpers/createTestDirectory.js";
import { bundlers } from "./helpers/bundlers.js";
import { fileURLToPath } from "node:url";

const __dirname = path.dirname(fileURLToPath(import.meta.url));
const cacheDir = path.join(__dirname, "output/cache/cachefiles");
const babelLoader = path.join(__dirname, "../lib");

function babelMetadataProvierPlugin() {
  return {
    name: "babel-metadata-provider-plugin",
    visitor: {
      Program(_, pass) {
        pass.file.metadata = { hello: "world" };
      },
    },
  };
}

class MetadataSubscriberPlugin {
  static subscriber = Symbol("subscriber");
  constructor(subscriberCallback) {
    this.subscriberCallback = subscriberCallback;
  }
  apply(compiler) {
    compiler.hooks.compilation.tap("plugin", compilation => {
      compiler.webpack.NormalModule.getCompilationHooks(compilation).loader.tap(
        "plugin",
        context => {
          context[MetadataSubscriberPlugin.subscriber] =
            this.subscriberCallback;
        },
      );
    });
  }
}

for (const bundler of bundlers) {
  test.describe(bundler.name, () => {
    const outputDir = path.join(__dirname, "output/metadata", bundler.name);

    // Create a separate directory for each test so that the tests
    // can run in parallel
    const context = { directory: undefined };
    test.beforeEach(async t => {
      const directory = await createTestDirectory(outputDir, t.name);
      context.directory = directory;
    });

    test.afterEach(() =>
      fs.rmSync(context.directory, { recursive: true, force: true }),
    );

    test("should obtain metadata from the transform result", async () => {
      let actualMetadata;

      const config = {
        mode: "development",
        entry: "./test/fixtures/basic.js",
        output: {
          path: context.directory,
          filename: "[id].metadata.js",
        },
        plugins: [
          new MetadataSubscriberPlugin(metadata => (actualMetadata = metadata)),
        ],
        module: {
          rules: [
            {
              test: /\.js/,
              loader: babelLoader,
              options: {
                metadataSubscribers: [MetadataSubscriberPlugin.subscriber],
                plugins: [babelMetadataProvierPlugin],
                babelrc: false,
                configFile: false,
              },
              exclude: /node_modules/,
            },
          ],
        },
      };

      const stats = await bundler.compileAsync(config);
      assert.equal(stats.compilation.errors.length, 0);
      assert.equal(stats.compilation.warnings.length, 0);

      assert.deepEqual(actualMetadata, { hello: "world" });
    });

    test("should obtain metadata from the transform result with cache", async () => {
      let actualMetadata;

      const config = {
        mode: "development",
        entry: "./test/fixtures/basic.js",
        output: {
          path: context.directory,
          filename: "[id].metadata.js",
        },
        plugins: [
          new MetadataSubscriberPlugin(metadata => (actualMetadata = metadata)),
        ],
        module: {
          rules: [
            {
              test: /\.js/,
              loader: babelLoader,
              options: {
                cacheDirectory: cacheDir,
                metadataSubscribers: [MetadataSubscriberPlugin.subscriber],
                plugins: [babelMetadataProvierPlugin],
                babelrc: false,
                configFile: false,
              },
              exclude: /node_modules/,
            },
          ],
        },
      };

      const stats = await bundler.compileAsync(config);
      assert.equal(stats.compilation.errors.length, 0);
      assert.equal(stats.compilation.warnings.length, 0);

      assert.deepEqual(actualMetadata, { hello: "world" });
    });
  });
}