@atlaspack/inspector 0.0.19-canary.3998

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright (c) 2024 Atlassian US., Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,126 @@
+# @atlaspack/inspector
+
+> _experimental quality, lacks verification and testing of certain features_
+
+## Usage
+
+Run a production build, then:
+
+```
+npm install -g @atlaspack/inspector
+inspector --target $APP_DIRECTORY/.atlaspack-cache
+```
+
+## Overview
+
+`@atlaspack/inspector` provides a UI for looking at `atlaspack` cache data, including bundle
+sizes and reasons why certain files are included in bundles.
+
+## Usage
+
+- this will only work with a cache that is built with the same version of `atlaspack/*` packages
+  the inspector is using
+- the `cachePerformanceImprovements` feature-flag must have been enabled when building the cache
+
+```
+atlaspack-inspector --target ./my-project-directory
+# or
+atlaspack-inspector --target ./my-project-directory/.atlaspack-cache
+```
+
+Please see "Building" and "Developing" to how to build this project.
+
+## Feature overview
+
+### Treemaps
+
+`@atlaspack/inspector` renders tree-maps using the [FoamTree](https://get.carrotsearch.com/foamtree/)
+library. Users can open tree-maps of the largest scale applications bundle graphs.
+
+![Treemap](screenshots/treemap.png)
+
+- Clicking a bundle will focus on all related bundles
+- Double clicking a bundle will open it for analysis on a drill-down page
+
+### Treemap drill-down
+
+![Bottom-up](screenshots/bottom-up.png)
+
+When on the drill-down page, clicking a directory will "open" its contents and allow the developer
+to drill-down on the sizes.
+
+The bottom panel will render tables with different ways of traversing the data and understanding
+why a certain directory or dependency has been included into the bundle.
+
+### Cache analysis
+
+![Cache inspector](screenshots/cache-inspector.png)
+
+A separate route shows raw cache information. At the moment this is simply a view where an `atlaspack`
+developer can open individual cache entries, but ideally it'd be expanded to render more semantic
+information about the cache, such as relationships between cache nodes.
+
+## Building
+
+To build the inspector, first build the `atlaspack` repository:
+
+```
+yarn run build
+```
+
+Then build the inspector back-end and front-end with:
+
+```
+yarn workspace @atlaspack/inspector prepack
+```
+
+## Developing
+
+### Example starting the server in development mode
+
+```
+yarn workspace @atlaspack/inspector dev --target $PWD/.parcel-cache
+```
+
+### Example starting the frontend in development mode
+
+```
+yarn workspace @atlaspack/inspector-frontend dev
+```
+
+## Testing
+
+There are few unit-tests for the back-end and express integration tests in `test/backend`.
+Those will use `mocha`, `sinon` and `superagent`, mostly for consistency with the rest of this repository.
+
+End-to-end tests are mostly visual regression tests on `test/e2e-test`. Those tests will build a project,
+spawn an inspector server and open its front-end on a web-browser, then check it is rendering correctly.
+
+### Running unit tests:
+
+```
+yarn workspace @atlaspack/inspector test:unit
+```
+
+### Running playwright end-to-end tests:
+
+```
+yarn playwright install-deps
+yarn playwright install
+
+yarn build
+yarn workspace @atlaspack/inspector test:e2e
+```
+
+# @atlaspack/inspector front-end
+
+The inspector front-end is using `@atlaskit/*` packages from the Atlassian design system.
+
+Its tech-stack at the moment is:
+
+- `react`
+- `react-router`
+- `mobx`
+- `CSS modules`
+- `foamtree`
+- `react-query`, and other `tanstack` packages

package/bin/atlaspack-inspector.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+require('../lib/backend/cli.js');

package/lib/backend/cli.js

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const index_1 = require("./index");
+(0, index_1.main)();

package/lib/backend/config/logger.js

@@ -0,0 +1,16 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.logger = void 0;
+const pino_1 = __importDefault(require("pino"));
+const pino_pretty_1 = __importDefault(require("pino-pretty"));
+/**
+ * Pino is used for logging.
+ *
+ * - https://github.com/pinojs/pino
+ */
+exports.logger = (0, pino_1.default)({
+    level: process.env.PINO_LEVEL ?? 'info',
+}, (0, pino_pretty_1.default)());

package/lib/backend/config/middleware/cacheDataMiddleware.js

@@ -0,0 +1,60 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getAssetGraph = exports.getRequestTracker = exports.getTreemap = exports.getBundleGraph = exports.getCache = void 0;
+exports.getCacheDataKey = getCacheDataKey;
+exports.cacheDataMiddleware = cacheDataMiddleware;
+const HTTPError_1 = require("../../errors/HTTPError");
+function getCacheDataKey(res, key, missingKeyError) {
+    const cacheData = res.locals.cacheData;
+    if (!cacheData[key]) {
+        throw new HTTPError_1.HTTPError(missingKeyError ?? `${key} not found`, 500);
+    }
+    return cacheData[key];
+}
+const getCache = (res) => getCacheDataKey(res, 'cache');
+exports.getCache = getCache;
+let missingErrorHelp = `
+Please make sure to run "atlaspack build --feature-flag cachePerformanceImprovements=true" before running the inspector.
+Or your application's build command.
+`.trim();
+const getBundleGraph = (res) => getCacheDataKey(res, 'bundleGraph', `
+BundleGraph not found in cache. The bundle graph is the data structure that contains all the information about the
+bundles in the application.
+
+This could happen if you are trying to run the inspector against a cache which has no builds or where a build terminated
+with errors before bundling.
+
+${missingErrorHelp}`.trim());
+exports.getBundleGraph = getBundleGraph;
+const getTreemap = (res) => getCacheDataKey(res, 'treemap', `
+Treemap not found in cache. The treemap data can only be generated if the cache contains a bundle graph and request tracker.
+
+This could happen if you are trying to run the inspector against a cache which has no builds or where a build terminated
+with errors before writing the cache or finishing bundling.
+
+${missingErrorHelp}`.trim());
+exports.getTreemap = getTreemap;
+const getRequestTracker = (res) => getCacheDataKey(res, 'requestTracker', `
+RequestTracker not found in cache. The request tracker is the data structure that contains all the information about the
+build tasks made during the build.
+
+This could happen if you are trying to run the inspector against a cache which has no builds or where a build terminated
+with errors before writing the cache.
+
+${missingErrorHelp}`.trim());
+exports.getRequestTracker = getRequestTracker;
+const getAssetGraph = (res) => getCacheDataKey(res, 'assetGraph', `
+AssetGraph not found in cache. The asset graph is the data structure that contains all the information about the
+assets in the application.
+
+This could happen if you are trying to run the inspector against a cache which has no builds or where a build terminated
+with errors before transforming and resolving assets.
+
+${missingErrorHelp}`.trim());
+exports.getAssetGraph = getAssetGraph;
+function cacheDataMiddleware(cacheData) {
+    return async (_req, res, next) => {
+        res.locals.cacheData = await cacheData;
+        next();
+    };
+}

package/lib/backend/config/middleware/errorHandlingMiddleware.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.errorHandlingMiddleware = errorHandlingMiddleware;
+const HTTPError_1 = require("../../errors/HTTPError");
+const logger_1 = require("../logger");
+/**
+ * A middleware that sets status codes for {@link HTTPError} instances.
+ */
+function errorHandlingMiddleware(err, _req, res, _next) {
+    if (err instanceof HTTPError_1.HTTPError) {
+        res.status(err.status).json({ error: err.message, status: err.status });
+    }
+    else {
+        logger_1.logger.error(err, 'Internal server error');
+        res.status(500).json({ error: 'Internal server error', status: 500 });
+    }
+}

package/lib/backend/config/middleware/errorHandlingMiddleware.test.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const assert_1 = __importDefault(require("assert"));
+const express_1 = __importDefault(require("express"));
+const supertest_1 = __importDefault(require("supertest"));
+const errorHandlingMiddleware_1 = require("./errorHandlingMiddleware");
+const HTTPError_1 = require("../../errors/HTTPError");
+jest.mock('../logger');
+describe('errorHandlingMiddleware integration', function () {
+    let app;
+    beforeEach(() => {
+        app = (0, express_1.default)();
+        // Add test routes that throw errors
+        app.get('/http-error', (req, res, next) => {
+            next(new HTTPError_1.HTTPError('Custom not found', 404));
+        });
+        app.get('/server-error', (req, res, next) => {
+            next(new Error('Something went wrong'));
+        });
+        app.get('/bad-request', (req, res, next) => {
+            next(new HTTPError_1.HTTPError('Bad request error', 400));
+        });
+        // Add error handling middleware
+        app.use(errorHandlingMiddleware_1.errorHandlingMiddleware);
+    });
+    it('should handle HTTPError with custom status and message', async () => {
+        const response = await (0, supertest_1.default)(app).get('/http-error').expect(404);
+        assert_1.default.deepEqual(response.body, { error: 'Custom not found', status: 404 });
+    });
+    it('should handle regular Error as 500 internal server error', async () => {
+        const response = await (0, supertest_1.default)(app).get('/server-error').expect(500);
+        assert_1.default.deepEqual(response.body, {
+            error: 'Internal server error',
+            status: 500,
+        });
+    });
+    it('should handle different HTTPError status codes', async () => {
+        const response = await (0, supertest_1.default)(app).get('/bad-request').expect(400);
+        assert_1.default.deepEqual(response.body, { error: 'Bad request error', status: 400 });
+    });
+});

package/lib/backend/config/middleware/loggingMiddleware.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loggingMiddleware = loggingMiddleware;
+const logger_1 = require("../logger");
+/**
+ * Log HTTP status codes and durations with `pino`.
+ */
+function loggingMiddleware() {
+    return (req, res, next) => {
+        const start = Date.now();
+        next();
+        res.on('finish', () => {
+            const duration = Date.now() - start;
+            logger_1.logger.debug({
+                method: req.method,
+                statusCode: res.statusCode,
+                url: req.url,
+                duration,
+            }, `[${res.statusCode}] ${req.method} ${req.url} ${duration}ms`);
+        });
+    };
+}

package/lib/backend/controllers/BundleGraphController.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.makeBundleGraphController = makeBundleGraphController;
+/* eslint-disable monorepo/no-internal-import */
+const express_1 = require("express");
+const buildJsonGraph_1 = require("../services/buildJsonGraph");
+const cacheDataMiddleware_1 = require("../config/middleware/cacheDataMiddleware");
+const buildTreemap_1 = require("../services/buildTreemap");
+function makeBundleGraphController({ projectRoot, repositoryRoot, }) {
+    const router = (0, express_1.Router)();
+    router.get('/api/bundle-graph', (req, res) => {
+        const bundleGraph = (0, cacheDataMiddleware_1.getBundleGraph)(res);
+        const requestTracker = (0, cacheDataMiddleware_1.getRequestTracker)(res);
+        const writeBundleRequestsByBundleId = (0, buildTreemap_1.getWriteBundleRequestsByBundleId)(requestTracker);
+        const jsonGraph = (0, buildJsonGraph_1.buildJsonGraph)(bundleGraph._graph, typeof req.query.rootNodeId === 'string' ? req.query.rootNodeId : null, (node) => node.type !== 'asset' && node.type !== 'dependency', (node) => {
+            const writeBundleRequest = writeBundleRequestsByBundleId.get(node.id);
+            const { size, filePath } = (0, buildTreemap_1.findBundleInfo)({
+                writeBundleRequest,
+                projectRoot,
+                repositoryRoot,
+                node,
+            });
+            return {
+                size,
+                filePath,
+            };
+        });
+        res.json(jsonGraph);
+    });
+    router.get('/api/bundle-graph/related-bundles', (req, res) => {
+        const bundleGraph = (0, cacheDataMiddleware_1.getBundleGraph)(res);
+        const bundleId = req.query.bundle;
+        const bundle = bundleGraph._graph.getNode(bundleGraph._graph.getNodeIdByContentKey(bundleId));
+        const childBundles = bundleGraph.getChildBundles(bundle).map((b) => ({
+            id: b.id,
+        }));
+        res.json({
+            childBundles,
+        });
+    });
+    return router;
+}