discourse/frontend/asset-processor/babel-resolve-plugin-imports.test.mjs

/* eslint-disable qunit/require-expect */
import { transformSync } from "@babel/core";
import { expect, test } from "vitest";
import BabelResolvePluginImports from "./babel-resolve-plugin-imports.js";

function compile(input) {
  return transformSync(input, {
    configFile: false,
    plugins: [BabelResolvePluginImports],
  }).code;
}

test("rewrites cross-plugin imports to the compatModules map", () => {
  expect(
    compile(`
import SharedThing, { somethingShared, other as renamed } from "discourse/plugins/other/lib/shared";
import * as Helpers from "discourse/plugins/other/lib/helpers";

SharedThing();
somethingShared(1);
renamed.property;
Helpers.doThing();
  `)
  ).toMatchInlineSnapshot(`
    "import _plugin_other from "discourse/plugins/other";
    (0, (_plugin_other["lib/shared"] || _plugin_other["lib/shared/index"]).default)();
    (0, (_plugin_other["lib/shared"] || _plugin_other["lib/shared/index"]).somethingShared)(1);
    (_plugin_other["lib/shared"] || _plugin_other["lib/shared/index"]).other.property;
    (_plugin_other["lib/helpers"] || _plugin_other["lib/helpers/index"]).doThing();"
  `);
});

test("de-dupes the default import per plugin", () => {
  expect(
    compile(`
import { a } from "discourse/plugins/other/lib/one";
import { b } from "discourse/plugins/other/lib/two";

a();
b();
  `)
  ).toMatchInlineSnapshot(`
    "import _plugin_other from "discourse/plugins/other";
    (0, (_plugin_other["lib/one"] || _plugin_other["lib/one/index"]).a)();
    (0, (_plugin_other["lib/two"] || _plugin_other["lib/two/index"]).b)();"
  `);
});

test("expands shorthand object properties inline", () => {
  expect(
    compile(`
import { foo, bar } from "discourse/plugins/other/lib/shared";

foo();
const obj = { bar };
  `)
  ).toMatchInlineSnapshot(`
    "import _plugin_other from "discourse/plugins/other";
    (0, (_plugin_other["lib/shared"] || _plugin_other["lib/shared/index"]).foo)();
    const obj = {
      bar: (_plugin_other["lib/shared"] || _plugin_other["lib/shared/index"]).bar
    };"
  `);
});

test("throws when a cross-plugin import is re-exported", () => {
  expect(() =>
    compile(`
import { foo } from "discourse/plugins/other/lib/shared";
export { foo };
  `)
  ).toThrow(/Re-exporting a cross-plugin import is not supported/);
});

test("imports are required by default, consolidating to the plain specifier", () => {
  expect(
    compile(`
import ChatChannel from "discourse/plugins/chat/models/chat-channel";

ChatChannel.create();
  `)
  ).toMatchInlineSnapshot(`
    "import _plugin_chat from "discourse/plugins/chat";
    (_plugin_chat["models/chat-channel"] || _plugin_chat["models/chat-channel/index"]).default.create();"
  `);
});

test('`discourseImport: "optional"` consolidates to the `?` specifier', () => {
  expect(
    compile(`
import ChatChannel from "discourse/plugins/chat/models/chat-channel" with { discourseImport: "optional" };

ChatChannel.create();
  `)
  ).toMatchInlineSnapshot(`
    "import _plugin_chat_optional from "discourse/plugins/chat?";
    (_plugin_chat_optional["models/chat-channel"] || _plugin_chat_optional["models/chat-channel/index"]).default.create();"
  `);
});

test("optional and required imports of the same plugin get separate specifiers", () => {
  expect(
    compile(`
import { a } from "discourse/plugins/chat/lib/one" with { discourseImport: "optional" };
import { b } from "discourse/plugins/chat/lib/two";

a();
b();
  `)
  ).toMatchInlineSnapshot(`
    "import _plugin_chat_optional from "discourse/plugins/chat?";
    import _plugin_chat from "discourse/plugins/chat";
    (0, (_plugin_chat_optional["lib/one"] || _plugin_chat_optional["lib/one/index"]).a)();
    (0, (_plugin_chat["lib/two"] || _plugin_chat["lib/two/index"]).b)();"
  `);
});

test('`discourseImport: "required"` consolidates to the plain specifier', () => {
  expect(
    compile(`
import ChatChannel from "discourse/plugins/chat/models/chat-channel" with { discourseImport: "required" };

ChatChannel.create();
  `)
  ).toMatchInlineSnapshot(`
    "import _plugin_chat from "discourse/plugins/chat";
    (_plugin_chat["models/chat-channel"] || _plugin_chat["models/chat-channel/index"]).default.create();"
  `);
});

test("recognises the quoted attribute key form", () => {
  expect(
    compile(`
import ChatChannel from "discourse/plugins/chat/models/chat-channel" with { "discourseImport": "required" };

ChatChannel.create();
  `)
  ).toMatchInlineSnapshot(`
    "import _plugin_chat from "discourse/plugins/chat";
    (_plugin_chat["models/chat-channel"] || _plugin_chat["models/chat-channel/index"]).default.create();"
  `);
});

test("throws on an unknown `discourseImport` value", () => {
  expect(() =>
    compile(`
import ChatChannel from "discourse/plugins/chat/models/chat-channel" with { discourseImport: "maybe" };
ChatChannel.create();
  `)
  ).toThrow(/Invalid `discourseImport` import attribute "maybe"/);
});

test("leaves relative and core imports untouched", () => {
  expect(
    compile(`
import sibling from "./sibling";
import concatClass from "discourse/helpers/concat-class";
  `)
  ).toMatchInlineSnapshot(`
    "import sibling from "./sibling";
    import concatClass from "discourse/helpers/concat-class";"
  `);
});