mage-obsidian 1.1.2 → 2.0.0

package/jest.config.js

@@ -1,5 +0,0 @@
-export default {
-    testEnvironment: 'node',
-    transform: {},
-    testPathIgnorePatterns: ['/__tests__/magento_scenarios/','/node_modules/', '/__tests__/__mocks__/', '/__tests__/fixtures/'],
-};

package/src/__tests__/__mocks__/configResolver.js

@@ -1,35 +0,0 @@
-import path from "path";
-import fs from "fs";
-import { jest } from '@jest/globals';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-const createMockConfigResolver = (scenario) => {
-    const configPath = path.resolve(__dirname, `../magento_scenarios/app/etc/mage_obsidian_frontend_modules_${scenario}.json`);
-    const magentoConfigJson = fs.readFileSync(configPath, 'utf-8');
-    const mockMagentoConfig = JSON.parse(magentoConfigJson);
-    for (const key in mockMagentoConfig.modules) {
-        let module = mockMagentoConfig.modules[key];
-        module.src = path.resolve(__dirname, '..', module.src);
-    }
-    for (const key in mockMagentoConfig.themes) {
-        let theme = mockMagentoConfig.themes[key];
-        theme.src = path.resolve(__dirname, '..', theme.src);
-    }
-    return {
-        default: {
-            getMagentoConfig: jest.fn(() => mockMagentoConfig),
-            getModulesConfigArray: jest.fn(() => Object.entries(mockMagentoConfig.modules)),
-            getThemesConfigArray: jest.fn(() => Object.entries(mockMagentoConfig.themes)),
-            getAllMagentoModulesEnabled: jest.fn(() => mockMagentoConfig.allModules),
-            isDev: jest.fn(() => mockMagentoConfig.mode === 'development'),
-            getOutputDirFromTheme: jest.fn((themePath) => `${themePath}/output`),
-            getThemeDefinition: jest.fn((themeName) => mockMagentoConfig.themes[themeName]),
-            getModuleDefinition: jest.fn((moduleName) => mockMagentoConfig.modules[moduleName]),
-        }
-    }
-};
-
-export default createMockConfigResolver;

package/src/__tests__/fixtures/interceptors/emptyTarget.js

@@ -1,2 +0,0 @@
-
-export const someOtherFunction = () => {};

package/src/__tests__/fixtures/interceptors/pluginForNonFunction.js

@@ -1,7 +0,0 @@
-
-export function beforeConfig() {
-    console.log('Should not run');
-}
-export function beforeDefault() {
-    console.log('Should not run');
-}

package/src/__tests__/fixtures/interceptors/pluginModule.js

@@ -1,13 +0,0 @@
-
-export function beforeTargetFunction(arg) {
-    return [`Modified: ${arg}`];
-}
-
-export function afterAnotherFunction(result) {
-    return `${result} - Modified`;
-}
-
-export function beforeDefault() {
-    return ['Default Modified'];
-}
-

package/src/__tests__/fixtures/interceptors/targetModule.js

@@ -1,12 +0,0 @@
-
-export function targetFunction(arg) {
-    return `Original: ${arg}`;
-}
-
-export function anotherFunction() {
-    return 'Another';
-}
-
-export default function defaultExport() {
-    return 'Default';
-}

package/src/__tests__/fixtures/interceptors/targetNonFunction.js

@@ -1,7 +0,0 @@
-
-export const config = {
-    some: 'value'
-};
-export default {
-    main: 'config'
-};

package/src/__tests__/magento_scenarios/app/code/Vendor/ModuleNameA/view/frontend/web/module.config.js

@@ -1,9 +0,0 @@
-export default {
-    tailwind: {
-        theme: { extend: {} },
-        plugins: [],
-        content: [
-            '../templates/**/*.phtml'
-        ]
-    }
-};

package/src/__tests__/magento_scenarios/app/code/Vendor/ModuleNameB/view/frontend/web/css/module.extend.css

@@ -1,2 +0,0 @@
-body {
-}

package/src/__tests__/magento_scenarios/app/code/Vendor/ModuleNameB/view/frontend/web/module.config.js

@@ -1,7 +0,0 @@
-export default {
-    tailwind: {
-        content: [
-            '../templates/**/*.phtml'
-        ]
-    }
-};

package/src/__tests__/magento_scenarios/app/code/Vendor/ModuleNameC/view/frontend/web/css/module.extend.css

@@ -1,2 +0,0 @@
-body {
-}

package/src/__tests__/magento_scenarios/app/code/Vendor/ModuleNameC/view/frontend/web/module.config.js

@@ -1,7 +0,0 @@
-export default {
-    tailwind: {
-        content: [
-            '../templates/**/*.phtml'
-        ]
-    }
-};

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-a/Vendor_ModuleNameA/web/module.config.js

@@ -1,2 +0,0 @@
-export default {
-};

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-a/Vendor_ModuleNameB/web/module.config.js

@@ -1,2 +0,0 @@
-export default {
-};

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-a/Vendor_ModuleNameNoConfig/web/module.config.js

@@ -1,2 +0,0 @@
-export default {
-};

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-a/web/css/theme.source.css

@@ -1,6 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;
-
-body {
-}

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-a/web/theme.config.js

@@ -1,5 +0,0 @@
-export default {
-    ignoredCssFromModules: [
-        'Vendor_ModuleNameA',
-    ],
-};

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-b/web/css/theme.source.css

@@ -1,6 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;
-
-body {
-}

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-b/web/theme.config.js

@@ -1,5 +0,0 @@
-export default {
-    ignoredCssFromModules: [
-        'Vendor_ModuleNameNoConfig'
-    ]
-}

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-c/Vendor_ModuleNameB/web/module.config.js

@@ -1,2 +0,0 @@
-export default {
-};

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-c/web/css/theme.source.css

@@ -1,6 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;
-
-body {
-}

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-c/web/theme.config.js

@@ -1,2 +0,0 @@
-export default {
-}

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-d/web/css/theme.source.css

@@ -1,6 +0,0 @@
-@tailwind base;
-@tailwind components;
-@tailwind utilities;
-
-body {
-}

package/src/__tests__/magento_scenarios/app/design/frontend/Vendor/theme-d/web/theme.config.js

@@ -1,3 +0,0 @@
-export default {
-    includeCssSourceFromParentThemes: false,
-}

package/src/__tests__/magento_scenarios/app/etc/mage_obsidian_frontend_modules_a.json

@@ -1,53 +0,0 @@
-{
-    "modules": {
-        "Vendor_ModuleNameA": {
-            "src": "magento_scenarios\/app\/code\/Vendor\/ModuleNameA"
-        },
-        "Vendor_ModuleNameB": {
-            "src": "magento_scenarios\/app\/code\/Vendor\/ModuleNameB"
-        },
-        "Vendor_ModuleNameC": {
-            "src": "magento_scenarios\/app\/code\/Vendor\/ModuleNameC"
-        }
-    },
-    "themes": {
-        "Vendor\/theme-a": {
-            "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-a",
-            "parent": null
-        },
-        "Vendor\/theme-b": {
-          "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-b",
-          "parent": "Vendor\/theme-a"
-        },
-        "Vendor\/theme-c": {
-          "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-c",
-          "parent": "Vendor\/theme-b"
-        },
-        "Vendor\/theme-d": {
-          "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-d",
-          "parent": null
-        }
-    },
-    "allModules": [
-      "Vendor_ModuleNameA",
-      "Vendor_ModuleNameB",
-      "Vendor_ModuleNameC"
-    ],
-    "VUE_COMPONENTS_PATH": "components",
-    "JS_PATH": "js",
-    "FOLDERS_TO_WATCH": [
-        "components",
-        "js"
-    ],
-    "ALLOWED_EXTENSIONS": [
-        "js",
-        "vue",
-        "cjs",
-        "ts"
-    ],
-    "MODULE_CSS_EXTEND_FILE": "module.extend.css",
-    "MODULE_CONFIG_FILE": "module.config.js",
-    "THEME_CONFIG_FILE": "theme.config.js",
-    "THEME_CSS_SOURCE_FILE": "theme.source.css",
-    "LIB_PATH": "lib"
-}

package/src/__tests__/magento_scenarios/app/etc/mage_obsidian_frontend_modules_b.json

@@ -1,50 +0,0 @@
-{
-    "modules": {
-        "Vendor_ModuleNameA": {
-            "src": "magento_scenarios\/app\/code\/Vendor\/ModuleNameA"
-        },
-        "Vendor_ModuleNameC": {
-            "src": "magento_scenarios\/app\/code\/Vendor\/ModuleNameC"
-        }
-    },
-    "themes": {
-        "Vendor\/theme-a": {
-            "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-a",
-            "parent": null
-        },
-        "Vendor\/theme-b": {
-          "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-b",
-          "parent": "Vendor\/theme-a"
-        },
-        "Vendor\/theme-c": {
-          "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-c",
-          "parent": "Vendor\/theme-b"
-        },
-        "Vendor\/theme-d": {
-          "src": "magento_scenarios\/app\/design\/frontend\/Vendor\/theme-d",
-          "parent": null
-        }
-    },
-    "allModules": [
-      "Vendor_ModuleNameA",
-      "Vendor_ModuleNameB",
-      "Vendor_ModuleNameNoConfig"
-    ],
-    "VUE_COMPONENTS_PATH": "components",
-    "JS_PATH": "js",
-    "FOLDERS_TO_WATCH": [
-        "components",
-        "js"
-    ],
-    "ALLOWED_EXTENSIONS": [
-        "js",
-        "vue",
-        "cjs",
-        "ts"
-    ],
-    "MODULE_CSS_EXTEND_FILE": "module.extend.css",
-    "MODULE_CONFIG_FILE": "module.config.js",
-    "THEME_CONFIG_FILE": "theme.config.js",
-    "THEME_CSS_SOURCE_FILE": "theme.source.css",
-    "LIB_PATH": "lib"
-}

package/src/__tests__/service/generateInterceptors.test.js

@@ -1,196 +0,0 @@
-
-import { jest } from '@jest/globals';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
-const fixturesDir = path.resolve(__dirname, '../fixtures/interceptors');
-const targetModulePath = path.join(fixturesDir, 'targetModule.js');
-const pluginModulePath = path.join(fixturesDir, 'pluginModule.js');
-const targetNonFunctionPath = path.join(fixturesDir, 'targetNonFunction.js');
-const pluginForNonFunctionPath = path.join(fixturesDir, 'pluginForNonFunction.js');
-
-describe('generateInterceptors', () => {
-    let generateInterceptorsService;
-    let themeResolverMock;
-    let moduleResolverMock;
-    let interceptorManager;
-
-    beforeEach(async () => {
-        jest.resetModules();
-
-        themeResolverMock = {
-            getThemeConfig: jest.fn(),
-        };
-
-        moduleResolverMock = {
-            getModuleConfigByThemeConfig: jest.fn(),
-            getAllJsVueFilesWithInheritanceCached: jest.fn(),
-            getAllJsVueFilesWithInheritance: jest.fn(),
-        };
-
-        jest.unstable_mockModule('../../service/themeResolverSync.js', () => ({
-            default: themeResolverMock
-        }));
-
-        jest.unstable_mockModule('../../service/moduleResolver.js', () => ({
-            default: moduleResolverMock
-        }));
-
-        jest.unstable_mockModule('../../service/configResolver.js', () => ({
-            default: {
-                resolveLibRealPath: jest.fn().mockReturnValue('/mocked/path/to/interceptorManager')
-            }
-        }));
-
-        // Import real interceptorManager to reset state
-        interceptorManager = (await import('../../service/interceptorManager.js')).default;
-        interceptorManager.interceptors = {};
-
-        generateInterceptorsService = (await import('../../service/generateInterceptors.js')).default;
-    });
-
-    test('should generate interceptors correctly', async () => {
-        const themeName = 'Vendor/theme-test';
-
-        themeResolverMock.getThemeConfig.mockReturnValue({
-            src: '/path/to/theme'
-        });
-
-        moduleResolverMock.getModuleConfigByThemeConfig.mockResolvedValue({
-            interceptors: {
-                'TestPlugin': {
-                    name: 'TestPlugin',
-                    target: 'Vendor_TargetModule::js/target.js',
-                    interceptor: 'Vendor_PluginModule::js/plugin.js',
-                    sortOrder: 10,
-                    active: true
-                }
-            }
-        });
-
-        const allFilesMap = {
-            'Vendor_TargetModule/js/target': targetModulePath,
-            'Vendor_PluginModule/js/plugin': pluginModulePath
-        };
-
-        moduleResolverMock.getAllJsVueFilesWithInheritanceCached.mockReturnValue(allFilesMap);
-
-        const result = await generateInterceptorsService.generateInterceptors(themeName);
-
-        const targetIdentifier = 'Vendor_TargetModule::js/target.js';
-        // Use bracket access check to avoid Jest treating '.' as nested property
-        expect(result[targetIdentifier]).toBeDefined();
-
-        const interceptorData = result[targetIdentifier];
-        expect(interceptorData).toHaveProperty('proxy');
-        expect(interceptorData).toHaveProperty('source');
-        expect(interceptorData).toHaveProperty('targetPath', targetModulePath);
-        expect(interceptorData.interceptors).toHaveLength(1);
-        expect(interceptorData.interceptors[0].name).toBe('TestPlugin');
-
-        // Verify Source Code Generation
-        const source = interceptorData.source;
-        expect(source).toContain(`import * as originalModule from '/@fs${targetModulePath}?originalIntercepted';`);
-        expect(source).toContain(`import * as interceptor_0 from '/@fs${pluginModulePath}';`);
-        expect(source).toContain(`interceptorManager.addInterceptor('${targetIdentifier}::targetFunction', 'TestPlugin', 'before', interceptor_0.beforeTargetFunction, 10);`);
-        expect(source).toContain(`interceptorManager.addInterceptor('${targetIdentifier}::default', 'TestPlugin', 'before', interceptor_0.beforeDefault, 10);`);
-        expect(source).toContain(`export const targetFunction = proxy.targetFunction;`);
-
-        // Verify Proxy Behavior
-        const proxy = interceptorData.proxy;
-        const resultFunc = await proxy.targetFunction('test');
-        expect(resultFunc).toBe('Original: Modified: test');
-
-        const resultAnother = await proxy.anotherFunction();
-        expect(resultAnother).toBe('Another - Modified');
-
-        const resultDefault = await proxy.default();
-        expect(resultDefault).toBe('Default'); // The mock plugin returns ['Default Modified'] but the original function ignores args and returns 'Default'. 
-        // Wait, before interceptor modifies arguments. 
-        // targetModule.js: export default function defaultExport() { return 'Default'; }
-        // It doesn't take arguments, so modifying arguments won't change output unless we check arguments.
-        // But we just want to verify it was registered.
-
-    });
-
-    test('should handle missing target module gracefully', async () => {
-        themeResolverMock.getThemeConfig.mockReturnValue({});
-        moduleResolverMock.getModuleConfigByThemeConfig.mockResolvedValue({
-            'Vendor_TargetModule': { interceptors: [] }
-        });
-        moduleResolverMock.getAllJsVueFilesWithInheritanceCached.mockReturnValue({});
-
-        const result = await generateInterceptorsService.generateInterceptors('Vendor/theme-missing');
-        expect(result).toEqual({});
-    });
-
-    test('should throw error if plugin targets non-existent method', async () => {
-        const themeName = 'Vendor/theme-test';
-        themeResolverMock.getThemeConfig.mockReturnValue({});
-        moduleResolverMock.getModuleConfigByThemeConfig.mockResolvedValue({
-            interceptors: {
-                'BadPlugin': {
-                    name: 'BadPlugin',
-                    target: 'Vendor_TargetModule::js/target.js',
-                    interceptor: 'Vendor_PluginModule::js/plugin.js',
-                    sortOrder: 10
-                }
-            }
-        });
-
-        const emptyTargetModulePath = path.join(fixturesDir, 'emptyTarget.js');
-        
-        const allFilesMap = {
-            'Vendor_TargetModule/js/target': emptyTargetModulePath,
-            'Vendor_PluginModule/js/plugin': pluginModulePath
-        };
-        
-        moduleResolverMock.getAllJsVueFilesWithInheritanceCached.mockReturnValue(allFilesMap);
-
-        // We expect the promise to reject because generateInterceptors throws on invalid target method
-        await expect(generateInterceptorsService.generateInterceptors(themeName))
-            .rejects
-            .toThrow(/does not export/);
-    });
-
-    test('should skip interception for non-function exports', async () => {
-        const themeName = 'Vendor/theme-test';
-
-        themeResolverMock.getThemeConfig.mockReturnValue({
-            src: '/path/to/theme'
-        });
-
-        moduleResolverMock.getModuleConfigByThemeConfig.mockResolvedValue({
-            interceptors: {
-                'TestPlugin': {
-                    name: 'TestPlugin',
-                    target: 'Vendor_TargetModule::js/targetNonFunction.js',
-                    interceptor: 'Vendor_PluginModule::js/pluginForNonFunction.js',
-                    sortOrder: 10,
-                    active: true
-                }
-            }
-        });
-
-        const allFilesMap = {
-            'Vendor_TargetModule/js/targetNonFunction': targetNonFunctionPath,
-            'Vendor_PluginModule/js/pluginForNonFunction': pluginForNonFunctionPath
-        };
-
-        moduleResolverMock.getAllJsVueFilesWithInheritanceCached.mockReturnValue(allFilesMap);
-
-        const consoleSpy = jest.spyOn(console, 'warn').mockImplementation(() => {});
-
-        const result = await generateInterceptorsService.generateInterceptors(themeName);
-
-        const targetIdentifier = 'Vendor_TargetModule::js/targetNonFunction.js';
-        
-        // Since both 'config' and 'default' are objects, and we are trying to intercept them,
-        // they should be skipped. If all are skipped, the targetIdentifier should not be in result.
-        expect(result[targetIdentifier]).toBeUndefined();
-        expect(consoleSpy).toHaveBeenCalledWith(expect.stringContaining('is not a function'));
-
-        consoleSpy.mockRestore();
-    });
-});

package/src/__tests__/service/inheritModuleResolver.test.js

@@ -1,61 +0,0 @@
-import { jest } from '@jest/globals';
-import createMockConfigResolver from '../__mocks__/configResolver.js';
-import path from 'path';
-import { fileURLToPath } from 'url';
-
-const __filename = fileURLToPath(import.meta.url);
-const __dirname = path.dirname(__filename);
-
-let scenarios = [
-    {
-        scenario: 'a',
-        themes: [
-            { code: 'Vendor/theme-a', codeImport: 'Vendor_ModuleNameA::js/test', expected: '/TEST/web/js/test.js' },
-            { code: 'Vendor/theme-a', codeImport: 'Vendor_ModuleNameA::js/test.vue', expected: '/TEST/web/js/test.js' },
-            { code: 'Vendor/theme-a', codeImport: 'Vendor_ModuleNameA::js/test.css', expected: undefined },
-            { code: 'Vendor/theme-a', codeImport: 'Vendor_ModuleNameB::js/test', expected: undefined },
-            { code: 'Vendor/theme-a', codeImport: null, expected: undefined },
-            { code: 'Vendor/theme-b', codeImport: 'Vendor_ModuleNameA::js/unknown', expected: undefined }
-        ]
-    }
-];
-
-function mockConfigAndModules(scenario) {
-    jest.unstable_mockModule('#service/configResolver.js', () => ({
-        __esModule: true,
-        default: createMockConfigResolver(scenario).default,
-    }));
-
-    jest.unstable_mockModule('#service/moduleResolver.js', () => ({
-        __esModule: true,
-        default: {
-            getAllJsVueFilesWithInheritanceCached: jest.fn(() => ({
-                'Vendor_ModuleNameA/js/test': '/TEST/web/js/test.js',
-            })),
-        }
-    }));
-}
-
-async function setupInheritModuleResolver(scenario) {
-    mockConfigAndModules(scenario);
-    const { default: inheritModuleResolverFactory } = await import('#service/inheritModuleResolver.js');
-    return inheritModuleResolverFactory();
-}
-
-describe('inherit-resolver', () => {
-    let inheritModuleResolver;
-
-    beforeEach(() => {
-        jest.resetModules();
-    });
-
-    test.each(scenarios.flatMap(({ scenario, themes }) =>
-        themes.map(({ code, codeImport, expected }) => ([scenario, code, codeImport, expected]))
-    ))('Scenario "%s", Theme "%s", Import "%s"', async (scenario, code, codeImport, expected) => {
-        process.env.CURRENT_THEME = code;
-        inheritModuleResolver = await setupInheritModuleResolver(scenario);
-        const result = await inheritModuleResolver.resolveId.handler(codeImport);
-
-        expect(result).toEqual(expected);
-    });
-});