@heymantle/litho 0.0.14 → 0.0.15

package/dist/cjs/tests/visual/stories.spec.js

@@ -0,0 +1,637 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+var _test = require("@playwright/test");
+var _fs = require("fs");
+var _path = require("path");
+var _url = require("url");
+function _array_like_to_array(arr, len) {
+    if (len == null || len > arr.length) len = arr.length;
+    for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
+    return arr2;
+}
+function _array_with_holes(arr) {
+    if (Array.isArray(arr)) return arr;
+}
+function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) {
+    try {
+        var info = gen[key](arg);
+        var value = info.value;
+    } catch (error) {
+        reject(error);
+        return;
+    }
+    if (info.done) {
+        resolve(value);
+    } else {
+        Promise.resolve(value).then(_next, _throw);
+    }
+}
+function _async_to_generator(fn) {
+    return function() {
+        var self = this, args = arguments;
+        return new Promise(function(resolve, reject) {
+            var gen = fn.apply(self, args);
+            function _next(value) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value);
+            }
+            function _throw(err) {
+                asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err);
+            }
+            _next(undefined);
+        });
+    };
+}
+function _iterable_to_array_limit(arr, i) {
+    var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"];
+    if (_i == null) return;
+    var _arr = [];
+    var _n = true;
+    var _d = false;
+    var _s, _e;
+    try {
+        for(_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true){
+            _arr.push(_s.value);
+            if (i && _arr.length === i) break;
+        }
+    } catch (err) {
+        _d = true;
+        _e = err;
+    } finally{
+        try {
+            if (!_n && _i["return"] != null) _i["return"]();
+        } finally{
+            if (_d) throw _e;
+        }
+    }
+    return _arr;
+}
+function _non_iterable_rest() {
+    throw new TypeError("Invalid attempt to destructure non-iterable instance.\\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method.");
+}
+function _object_destructuring_empty(o) {
+    if (o === null || o === void 0) throw new TypeError("Cannot destructure " + o);
+    return o;
+}
+function _sliced_to_array(arr, i) {
+    return _array_with_holes(arr) || _iterable_to_array_limit(arr, i) || _unsupported_iterable_to_array(arr, i) || _non_iterable_rest();
+}
+function _unsupported_iterable_to_array(o, minLen) {
+    if (!o) return;
+    if (typeof o === "string") return _array_like_to_array(o, minLen);
+    var n = Object.prototype.toString.call(o).slice(8, -1);
+    if (n === "Object" && o.constructor) n = o.constructor.name;
+    if (n === "Map" || n === "Set") return Array.from(n);
+    if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _array_like_to_array(o, minLen);
+}
+function _ts_generator(thisArg, body) {
+    var f, y, t, _ = {
+        label: 0,
+        sent: function() {
+            if (t[0] & 1) throw t[1];
+            return t[1];
+        },
+        trys: [],
+        ops: []
+    }, g = Object.create((typeof Iterator === "function" ? Iterator : Object).prototype);
+    return g.next = verb(0), g["throw"] = verb(1), g["return"] = verb(2), typeof Symbol === "function" && (g[Symbol.iterator] = function() {
+        return this;
+    }), g;
+    function verb(n) {
+        return function(v) {
+            return step([
+                n,
+                v
+            ]);
+        };
+    }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while(g && (g = 0, op[0] && (_ = 0)), _)try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [
+                op[0] & 2,
+                t.value
+            ];
+            switch(op[0]){
+                case 0:
+                case 1:
+                    t = op;
+                    break;
+                case 4:
+                    _.label++;
+                    return {
+                        value: op[1],
+                        done: false
+                    };
+                case 5:
+                    _.label++;
+                    y = op[1];
+                    op = [
+                        0
+                    ];
+                    continue;
+                case 7:
+                    op = _.ops.pop();
+                    _.trys.pop();
+                    continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) {
+                        _ = 0;
+                        continue;
+                    }
+                    if (op[0] === 3 && (!t || op[1] > t[0] && op[1] < t[3])) {
+                        _.label = op[1];
+                        break;
+                    }
+                    if (op[0] === 6 && _.label < t[1]) {
+                        _.label = t[1];
+                        t = op;
+                        break;
+                    }
+                    if (t && _.label < t[2]) {
+                        _.label = t[2];
+                        _.ops.push(op);
+                        break;
+                    }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop();
+                    continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) {
+            op = [
+                6,
+                e
+            ];
+            y = 0;
+        } finally{
+            f = t = 0;
+        }
+        if (op[0] & 5) throw op[1];
+        return {
+            value: op[0] ? op[1] : void 0,
+            done: true
+        };
+    }
+}
+function _ts_values(o) {
+    var s = typeof Symbol === "function" && Symbol.iterator, m = s && o[s], i = 0;
+    if (m) return m.call(o);
+    if (o && typeof o.length === "number") return {
+        next: function() {
+            if (o && i >= o.length) o = void 0;
+            return {
+                value: o && o[i++],
+                done: !o
+            };
+        }
+    };
+    throw new TypeError(s ? "Object is not iterable." : "Symbol.iterator is not defined.");
+}
+// ES module equivalent of __dirname
+var __dirname = (0, _path.dirname)((0, _url.fileURLToPath)(require("url").pathToFileURL(__filename).toString()));
+// Check if we should only update missing baselines
+var UPDATE_MISSING_ONLY = process.env.UPDATE_MISSING_ONLY === 'true';
+// Get the snapshots directory path
+var SNAPSHOTS_DIR = (0, _path.join)(__dirname, 'stories.spec.js-snapshots');
+// Stories to skip (e.g., ones with heavy animations, interactive-only content, or external images)
+var SKIP_STORIES = [
+    // Image stories use picsum.photos with random images - not deterministic
+    'litho-image--default',
+    'litho-image--rounded-prop',
+    'litho-image--border-radius',
+    'litho-image--responsive-image',
+    'litho-image--with-load-callback',
+    'litho-image--profile-cards',
+    'litho-image--product-showcase',
+    'litho-image--image-gallery',
+    'litho-image--banner-images'
+];
+// Get all stories from Storybook's index
+function getStories(baseURL) {
+    return _async_to_generator(function() {
+        var response, data, stories, _iteratorNormalCompletion, _didIteratorError, _iteratorError, _iterator, _step, _step_value, id, entry;
+        return _ts_generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    return [
+                        4,
+                        fetch("".concat(baseURL, "/index.json"))
+                    ];
+                case 1:
+                    response = _state.sent();
+                    return [
+                        4,
+                        response.json()
+                    ];
+                case 2:
+                    data = _state.sent();
+                    stories = [];
+                    _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+                    try {
+                        for(_iterator = Object.entries(data.entries)[Symbol.iterator](); !(_iteratorNormalCompletion = (_step = _iterator.next()).done); _iteratorNormalCompletion = true){
+                            _step_value = _sliced_to_array(_step.value, 2), id = _step_value[0], entry = _step_value[1];
+                            // Skip docs entries
+                            if (entry.type === 'docs') continue;
+                            // Skip stories in the skip list
+                            if (SKIP_STORIES.includes(id)) continue;
+                            stories.push({
+                                id: id,
+                                title: entry.title,
+                                name: entry.name
+                            });
+                        }
+                    } catch (err) {
+                        _didIteratorError = true;
+                        _iteratorError = err;
+                    } finally{
+                        try {
+                            if (!_iteratorNormalCompletion && _iterator.return != null) {
+                                _iterator.return();
+                            }
+                        } finally{
+                            if (_didIteratorError) {
+                                throw _iteratorError;
+                            }
+                        }
+                    }
+                    return [
+                        2,
+                        stories
+                    ];
+            }
+        });
+    })();
+}
+// Check if baseline exists for a story
+function baselineExists(storyId) {
+    var baselinePath = (0, _path.join)(SNAPSHOTS_DIR, "".concat(storyId, ".png"));
+    return (0, _fs.existsSync)(baselinePath);
+}
+// Helper to screenshot a single story
+function screenshotStory(page, storyId) {
+    return _async_to_generator(function() {
+        var storyURL, screenshotName;
+        return _ts_generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    // Skip if baseline exists and we're only updating missing ones
+                    if (UPDATE_MISSING_ONLY && baselineExists(storyId)) {
+                        return [
+                            2,
+                            {
+                                skipped: true
+                            }
+                        ];
+                    }
+                    // Navigate to the story iframe URL
+                    storyURL = "/iframe.html?id=".concat(storyId, "&viewMode=story");
+                    return [
+                        4,
+                        page.goto(storyURL)
+                    ];
+                case 1:
+                    _state.sent();
+                    // Wait for the page to load (don't use networkidle - Storybook keeps connections open)
+                    return [
+                        4,
+                        page.waitForLoadState('load')
+                    ];
+                case 2:
+                    _state.sent();
+                    // Wait for Storybook root element to be present
+                    return [
+                        4,
+                        page.waitForSelector('#storybook-root', {
+                            state: 'attached'
+                        })
+                    ];
+                case 3:
+                    _state.sent();
+                    // Wait for fonts to load
+                    return [
+                        4,
+                        page.evaluate(function() {
+                            return document.fonts.ready;
+                        })
+                    ];
+                case 4:
+                    _state.sent();
+                    // Wait for all images to load
+                    return [
+                        4,
+                        page.evaluate(function() {
+                            var images = Array.from(document.images);
+                            return Promise.all(images.map(function(img) {
+                                if (img.complete) return Promise.resolve();
+                                return new Promise(function(resolve) {
+                                    img.addEventListener('load', resolve);
+                                    img.addEventListener('error', resolve); // Don't fail on broken images
+                                });
+                            }));
+                        })
+                    ];
+                case 5:
+                    _state.sent();
+                    // Wait for document to have stable height (content fully rendered)
+                    // This is critical for fullPage screenshots to capture the correct height
+                    return [
+                        4,
+                        page.waitForFunction(function() {
+                            return new Promise(function(resolve) {
+                                var lastHeight = document.body.scrollHeight;
+                                var checks = 0;
+                                var interval = setInterval(function() {
+                                    var currentHeight = document.body.scrollHeight;
+                                    if (currentHeight === lastHeight && currentHeight > 0) {
+                                        checks++;
+                                        if (checks >= 5) {
+                                            clearInterval(interval);
+                                            resolve(true);
+                                        }
+                                    } else {
+                                        lastHeight = currentHeight;
+                                        checks = 0;
+                                    }
+                                }, 100);
+                                // Timeout after 5 seconds
+                                setTimeout(function() {
+                                    clearInterval(interval);
+                                    resolve(true);
+                                }, 5000);
+                            });
+                        })
+                    ];
+                case 6:
+                    _state.sent();
+                    // Additional wait for any lazy-loaded content
+                    return [
+                        4,
+                        page.waitForTimeout(500)
+                    ];
+                case 7:
+                    _state.sent();
+                    // Disable animations and hide scrollbars for consistent screenshots
+                    return [
+                        4,
+                        page.addStyleTag({
+                            content: "\n      *, *::before, *::after {\n        animation-duration: 0s !important;\n        animation-delay: 0s !important;\n        transition-duration: 0s !important;\n        transition-delay: 0s !important;\n      }\n      /* Hide scrollbars to prevent width variations */\n      html, body {\n        scrollbar-width: none !important;\n        -ms-overflow-style: none !important;\n      }\n      html::-webkit-scrollbar, body::-webkit-scrollbar {\n        display: none !important;\n        width: 0 !important;\n        height: 0 !important;\n      }\n    "
+                        })
+                    ];
+                case 8:
+                    _state.sent();
+                    // Small wait for any re-renders after disabling animations
+                    return [
+                        4,
+                        page.waitForTimeout(100)
+                    ];
+                case 9:
+                    _state.sent();
+                    // Take screenshot and compare
+                    screenshotName = "".concat(storyId, ".png");
+                    return [
+                        4,
+                        (0, _test.expect)(page).toHaveScreenshot(screenshotName, {
+                            fullPage: true,
+                            animations: 'disabled'
+                        })
+                    ];
+                case 10:
+                    _state.sent();
+                    return [
+                        2
+                    ];
+            }
+        });
+    })();
+}
+// Fetch stories once before all tests
+var storiesList = null;
+_test.test.beforeAll(function(param, testInfo) {
+    var ref = _object_destructuring_empty(param);
+    return _async_to_generator(function() {
+        var baseURL;
+        return _ts_generator(this, function(_state) {
+            switch(_state.label){
+                case 0:
+                    baseURL = testInfo.project.use.baseURL || 'http://127.0.0.1:6006';
+                    return [
+                        4,
+                        getStories(baseURL)
+                    ];
+                case 1:
+                    storiesList = _state.sent();
+                    return [
+                        2
+                    ];
+            }
+        });
+    })();
+});
+_test.test.describe('Visual Regression Tests', function() {
+    (0, _test.test)('should have stories to test', function() {
+        return _async_to_generator(function() {
+            return _ts_generator(this, function(_state) {
+                // This test runs first to ensure stories are loaded
+                (0, _test.expect)(storiesList).not.toBeNull();
+                (0, _test.expect)(storiesList.length).toBeGreaterThan(0);
+                return [
+                    2
+                ];
+            });
+        })();
+    });
+});
+// Generate individual tests for each story
+// Note: We use a wrapper test that iterates because Playwright needs
+// static test definitions at collection time
+_test.test.describe('Component Screenshots', function() {
+    // Disable retries - we handle errors ourselves and continue through all stories
+    _test.test.describe.configure({
+        retries: 0
+    });
+    (0, _test.test)('capture all component stories', function(param, testInfo) {
+        var page = param.page;
+        return _async_to_generator(function() {
+            var baseURL, completed, skipped, failed, failures, _iteratorNormalCompletion, _didIteratorError, _iteratorError, _loop, _iterator, _step, err, _iteratorNormalCompletion1, _didIteratorError1, _iteratorError1, _iterator1, _step1, f;
+            return _ts_generator(this, function(_state) {
+                switch(_state.label){
+                    case 0:
+                        // 20 minutes for all stories (500+ stories at ~2s each in CI)
+                        _test.test.setTimeout(1200000);
+                        baseURL = testInfo.project.use.baseURL || 'http://127.0.0.1:6006';
+                        if (!!storiesList) return [
+                            3,
+                            2
+                        ];
+                        return [
+                            4,
+                            getStories(baseURL)
+                        ];
+                    case 1:
+                        storiesList = _state.sent();
+                        _state.label = 2;
+                    case 2:
+                        // Run each story, collecting failures to report at the end
+                        completed = 0;
+                        skipped = 0;
+                        failed = 0;
+                        failures = [];
+                        _iteratorNormalCompletion = true, _didIteratorError = false, _iteratorError = undefined;
+                        _state.label = 3;
+                    case 3:
+                        _state.trys.push([
+                            3,
+                            8,
+                            9,
+                            10
+                        ]);
+                        _loop = function() {
+                            var story;
+                            return _ts_generator(this, function(_state) {
+                                switch(_state.label){
+                                    case 0:
+                                        story = _step.value;
+                                        return [
+                                            4,
+                                            _test.test.step("".concat(story.title, " - ").concat(story.name), function() {
+                                                return _async_to_generator(function() {
+                                                    var result, error;
+                                                    return _ts_generator(this, function(_state) {
+                                                        switch(_state.label){
+                                                            case 0:
+                                                                _state.trys.push([
+                                                                    0,
+                                                                    2,
+                                                                    ,
+                                                                    3
+                                                                ]);
+                                                                return [
+                                                                    4,
+                                                                    screenshotStory(page, story.id)
+                                                                ];
+                                                            case 1:
+                                                                result = _state.sent();
+                                                                if (result === null || result === void 0 ? void 0 : result.skipped) {
+                                                                    skipped++;
+                                                                    console.log("  [".concat(completed + skipped + failed, "/").concat(storiesList.length, "] SKIPPED: ").concat(story.id));
+                                                                } else {
+                                                                    completed++;
+                                                                    console.log("  [".concat(completed + skipped + failed, "/").concat(storiesList.length, "] ✓ ").concat(story.id));
+                                                                }
+                                                                return [
+                                                                    3,
+                                                                    3
+                                                                ];
+                                                            case 2:
+                                                                error = _state.sent();
+                                                                failed++;
+                                                                failures.push({
+                                                                    story: story.id,
+                                                                    error: error.message
+                                                                });
+                                                                console.log("  [".concat(completed + skipped + failed, "/").concat(storiesList.length, "] ✗ ").concat(story.id, ": ").concat(error.message.split('\n')[0]));
+                                                                return [
+                                                                    3,
+                                                                    3
+                                                                ];
+                                                            case 3:
+                                                                return [
+                                                                    2
+                                                                ];
+                                                        }
+                                                    });
+                                                })();
+                                            })
+                                        ];
+                                    case 1:
+                                        _state.sent();
+                                        return [
+                                            2
+                                        ];
+                                }
+                            });
+                        };
+                        _iterator = storiesList[Symbol.iterator]();
+                        _state.label = 4;
+                    case 4:
+                        if (!!(_iteratorNormalCompletion = (_step = _iterator.next()).done)) return [
+                            3,
+                            7
+                        ];
+                        return [
+                            5,
+                            _ts_values(_loop())
+                        ];
+                    case 5:
+                        _state.sent();
+                        _state.label = 6;
+                    case 6:
+                        _iteratorNormalCompletion = true;
+                        return [
+                            3,
+                            4
+                        ];
+                    case 7:
+                        return [
+                            3,
+                            10
+                        ];
+                    case 8:
+                        err = _state.sent();
+                        _didIteratorError = true;
+                        _iteratorError = err;
+                        return [
+                            3,
+                            10
+                        ];
+                    case 9:
+                        try {
+                            if (!_iteratorNormalCompletion && _iterator.return != null) {
+                                _iterator.return();
+                            }
+                        } finally{
+                            if (_didIteratorError) {
+                                throw _iteratorError;
+                            }
+                        }
+                        return [
+                            7
+                        ];
+                    case 10:
+                        console.log("\n========================================");
+                        console.log("Completed: ".concat(completed, ", Skipped: ").concat(skipped, ", Failed: ").concat(failed, ", Total: ").concat(storiesList.length));
+                        if (failures.length > 0) {
+                            console.log("\nFailed stories:");
+                            _iteratorNormalCompletion1 = true, _didIteratorError1 = false, _iteratorError1 = undefined;
+                            try {
+                                for(_iterator1 = failures[Symbol.iterator](); !(_iteratorNormalCompletion1 = (_step1 = _iterator1.next()).done); _iteratorNormalCompletion1 = true){
+                                    f = _step1.value;
+                                    console.log("  - ".concat(f.story));
+                                }
+                            } catch (err) {
+                                _didIteratorError1 = true;
+                                _iteratorError1 = err;
+                            } finally{
+                                try {
+                                    if (!_iteratorNormalCompletion1 && _iterator1.return != null) {
+                                        _iterator1.return();
+                                    }
+                                } finally{
+                                    if (_didIteratorError1) {
+                                        throw _iteratorError1;
+                                    }
+                                }
+                            }
+                            throw new Error("".concat(failures.length, " story screenshot(s) failed. See logs above for details."));
+                        }
+                        return [
+                            2
+                        ];
+                }
+            });
+        })();
+    });
+});