@appland/appmap 3.84.2 → 3.86.0

package/resources/change-report.hbs

@@ -0,0 +1,259 @@
+# AppMap
+
+{{#*inline "api-change"}}
+{{title}} {{#each sourceSpecEntityDetails}}`{{location}}`{{/each}} {{#each destinationSpecEntityDetails}}`{{location}}`{{/each}}
+{{~/inline}}
+
+{{#*inline "sequence-diagram-diff-link"}}
+{{#if sequenceDiagramDiff}}[{{sequenceDiagramDiff}}]({{ appmap_diff_url sequenceDiagramDiff}}){{/if}}{{#unless sequenceDiagramDiff}}No structural changes detected{{/unless}}
+{{~/inline}}
+
+{{#*inline "finding-source-diff"}}
+{{#if (has_source_diff appmap) }}
+
+The following code changes are related to this finding:
+
+```diff
+{{{source_diff appmap}}}
+```
+{{else}}
+
+No relevant code changes found.
+{{/if}}
+{{/inline}}
+
+{{#*inline "finding-stack" }}
+{{#with stack }}
+{{#each this }}
+{{#if (source_url this)}}
+* [{{this}}]({{ source_url this }})
+{{else}}
+* {{ this }}
+{{/if}}
+{{/each}}
+{{/with}}
+
+{{/inline}}
+
+{{#*inline "finding"}}
+
+### {{ ruleTitle }}
+
+<details>
+<summary>
+  Finding details
+</summary>
+
+| Field | Value |
+| --- | --- |
+| Message | {{ message }} |
+| AppMap | [{{appmap}}]({{~ appmap_url 'head' appmap }}) |
+
+##### Related code changes
+
+{{~> finding-source-diff}}
+
+##### Stack trace
+
+{{> finding-stack}}
+
+</details>
+{{/inline}}
+
+| Summary | Status |
+| --- | --- |
+| [Test failures](#test-failures) | {{#if testFailures.length}}:warning: {{testFailures.length}} failed{{else}}:white_check_mark: All tests passed{{/if}} |
+| [API changes](#api-changes) | 
+  {{~#unless apiDiff.differenceCount }}
+  :white_check_mark: No API changes
+  {{~/unless}}
+  {{~#if apiDiff.differenceCount }}
+  {{~#if apiDiff.breakingDifferenceCount }}🚧 {{apiDiff.breakingDifferenceCount}} breaking{{~/if}}
+  {{~#if apiDiff.nonBreakingDifferenceCount }}{{#if apiDiff.breakingDifferenceCount }},&nbsp;{{~/if}}:wrench: {{apiDiff.nonBreakingDifferenceCount}} non-breaking{{~/if}}
+  {{~/if}}
+  |
+| [Findings](#findings) |
+  {{~#with findingDiff}}
+  {{~#unless (length new resolved) }}
+  :white_check_mark: None
+  {{~/unless}}
+  {{~#if (length new) }}
+  :beetle: {{length new}} new
+  {{~/if}}
+  {{~#if (length resolved) }}
+  :tada: {{length resolved}} resolved
+  {{~/if}}
+  {{~/with}}
+  |
+| [New AppMaps](#new-appmaps) | 
+  {{~#unless newAppMaps.length }}
+  :white_check_mark: None
+  {{~else}}
+  :star: {{newAppMaps.length}} new
+  {{~/unless}}
+  |
+| [Changed code behavior](#changed-code-behavior) |
+  {{~#unless sequenceDiagramDiffSnippetCount }}
+  :white_check_mark: No changes
+  {{~else}}
+  :twisted_rightwards_arrows: {{sequenceDiagramDiffSnippetCount}} changes
+  {{~/unless}}
+  |
+
+{{#if testFailures.length}}
+## :warning: Test failures
+
+{{#each testFailures}}
+
+<details>
+<summary>
+{{ testLocation }}
+</summary>
+
+<p/>
+
+[{{testLocation}}]({{ source_url testLocation }}) failed with error:
+
+```
+{{{failureMessage}}}
+```
+
+{{#if failureLocation}}
+The error occurred at [{{failureLocation}}]({{ source_url failureLocation }}):
+{{/if}}
+
+{{#if testSnippet}}
+{{#with testSnippet}}
+```{{language}}
+{{{codeFragment}}}
+```
+{{/with}}
+{{/if}}
+
+{{#if (has_source_diff appmap)}}
+
+The following code changes may be related to this test failure:
+
+```diff
+{{{source_diff appmap}}}
+```
+{{else}}
+
+No relevant code changes found.
+{{/if}}
+
+| Diagram | Link |
+| --- | --- |
+{{#if changedAppMap}}
+{{#with changedAppMap}}
+| Sequence diagram diff | {{> sequence-diagram-diff-link }} |
+{{/with}}
+{{/if}}
+| AppMap | [{{appmap}}]({{ appmap_url 'head' appmap }}) |
+
+</details>
+
+{{/each}}
+{{/if}}
+
+{{#if apiDiff.differenceCount }}
+
+## 🔄 API changes
+
+{{#if apiDiff.breakingDifferences}}
+### 🚧 Breaking changes
+
+{{#each apiDiff.breakingDifferences}}
+  - {{> api-change }}
+{{/each}}
+{{/if}}
+
+{{#if apiDiff.nonBreakingDifferences}}
+### :wrench: Non-breaking changes
+
+{{#each apiDiff.nonBreakingDifferences}}
+  - {{> api-change }}
+{{/each}}
+{{/if}}
+
+{{#if apiDiff.unclassifiedDifferences}}
+### Unclassified changes
+
+{{#each apiDiff.unclassifiedDifferences}}
+  - {{> api-change }}
+{{/each}}
+{{/if}}
+
+<details>
+<summary>
+  Detailed OpenAPI diff
+</summary>
+
+```diff
+{{{apiDiff.sourceDiff}}}
+```
+</details>
+
+{{/if}}
+
+{{#with findingDiff}}
+{{#if (length new resolved)}}
+
+<h2 id="findings">Findings</h2>
+
+{{#with new}}
+### :beetle: New findings ({{ length this}})
+
+{{#each this}}
+{{> finding}}
+{{/each}}
+
+{{/with}}
+
+{{#with resolved}}
+### :tada: Resolved findings ({{ length this}})
+
+{{#each this}}
+{{> finding}}
+{{/each}}
+
+{{/with}}
+
+{{/if}}
+{{/with}}
+
+{{#if newAppMaps.length }}
+
+<h2 id="new-appmaps">New AppMaps</h2>
+
+{{#each newAppMaps}}
+
+[{{this}}]({{ appmap_url 'head' this }})
+
+{{/each}}
+
+{{/if}}
+
+{{#if sequenceDiagramDiffSnippetCount }}
+## :twisted_rightwards_arrows: Changed code behavior
+
+<details>
+
+<summary>
+Review {{ sequenceDiagramDiffSnippetCount }} changes
+</summary>
+
+{{#each sequenceDiagramDiff}}
+
+```
+{{{@key}}}
+```
+
+{{#each this}}
+- [{{.}}]({{ appmap_diff_url . }})
+{{/each}}
+
+{{/each}}
+
+</details>
+{{/if}}

package/built/cmds/archive/updateSequenceDiagrams.js

@@ -1,49 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const models_1 = require("@appland/models");
-const sequence_diagram_1 = require("@appland/sequence-diagram");
-const promises_1 = require("fs/promises");
-const path_1 = require("path");
-const utils_1 = require("../../utils");
-const fileTooLargeError_1 = __importDefault(require("../../fingerprint/fileTooLargeError"));
-const CountNumProcessed_1 = require("./CountNumProcessed");
-const reportAppMapProcessingError_1 = __importDefault(require("./reportAppMapProcessingError"));
-const buildFilter_1 = __importDefault(require("./buildFilter"));
-async function updateSequenceDiagrams(dir, maxAppMapSizeInBytes, compareFilter) {
-    const specOptions = {
-        loops: true,
-    };
-    const oversizedAppMaps = new Array();
-    const generateDiagram = async (appmapFileName) => {
-        var _a, _b;
-        // Determine size of file appmapFileName in bytes
-        const stats = await (0, promises_1.stat)(appmapFileName);
-        if (stats.size > maxAppMapSizeInBytes) {
-            oversizedAppMaps.push(appmapFileName);
-            throw new fileTooLargeError_1.default(appmapFileName, stats.size, maxAppMapSizeInBytes);
-        }
-        const fullAppMap = (0, models_1.buildAppMap)()
-            .source(await (0, promises_1.readFile)(appmapFileName, 'utf8'))
-            .build();
-        const language = ((_b = (_a = fullAppMap.metadata) === null || _a === void 0 ? void 0 : _a.language) === null || _b === void 0 ? void 0 : _b.name) || 'unknown';
-        const filter = (0, buildFilter_1.default)(language, compareFilter);
-        const filteredAppMap = filter.filter(fullAppMap, []);
-        const specification = sequence_diagram_1.Specification.build(filteredAppMap, specOptions);
-        const diagram = (0, sequence_diagram_1.buildDiagram)(appmapFileName, filteredAppMap, specification);
-        const diagramOutput = (0, sequence_diagram_1.format)(sequence_diagram_1.FormatType.JSON, diagram, appmapFileName);
-        const indexDir = (0, path_1.join)((0, path_1.dirname)(appmapFileName), (0, path_1.basename)(appmapFileName, '.appmap.json'));
-        const diagramFileName = (0, path_1.join)(indexDir, 'sequence.json');
-        await (0, promises_1.writeFile)(diagramFileName, diagramOutput.diagram);
-    };
-    const counter = new CountNumProcessed_1.CountNumProcessed();
-    const options = new utils_1.ProcessFileOptions(dir);
-    options.fileCountFn = counter.setCount();
-    options.errorFn = (0, reportAppMapProcessingError_1.default)('Sequence diagram');
-    await (0, utils_1.processFiles)('**/*.appmap.json', generateDiagram, options);
-    return { numGenerated: counter.count, oversizedAppMaps };
-}
-exports.default = updateSequenceDiagrams;
-//# sourceMappingURL=updateSequenceDiagrams.js.map

package/built/cmds/archive/updateSequenceDiagrams.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"updateSequenceDiagrams.js","sourceRoot":"","sources":["../../../src/cmds/archive/updateSequenceDiagrams.ts"],"names":[],"mappings":";;;;;AAAA,4CAA8C;AAC9C,gEAMmC;AACnC,0CAAwD;AACxD,+BAA+C;AAC/C,uCAA+D;AAC/D,4FAAoE;AACpE,2DAAwD;AACxD,gGAAwE;AACxE,gEAAsD;AAGvC,KAAK,UAAU,sBAAsB,CAClD,GAAW,EACX,oBAA4B,EAC5B,aAA4B;IAE5B,MAAM,WAAW,GAAG;QAClB,KAAK,EAAE,IAAI;KACc,CAAC;IAE5B,MAAM,gBAAgB,GAAG,IAAI,KAAK,EAAU,CAAC;IAE7C,MAAM,eAAe,GAAG,KAAK,EAAE,cAAsB,EAAE,EAAE;;QACvD,iDAAiD;QACjD,MAAM,KAAK,GAAG,MAAM,IAAA,eAAI,EAAC,cAAc,CAAC,CAAC;QACzC,IAAI,KAAK,CAAC,IAAI,GAAG,oBAAoB,EAAE;YACrC,gBAAgB,CAAC,IAAI,CAAC,cAAc,CAAC,CAAC;YACtC,MAAM,IAAI,2BAAiB,CAAC,cAAc,EAAE,KAAK,CAAC,IAAI,EAAE,oBAAoB,CAAC,CAAC;SAC/E;QAED,MAAM,UAAU,GAAG,IAAA,oBAAW,GAAE;aAC7B,MAAM,CAAC,MAAM,IAAA,mBAAQ,EAAC,cAAc,EAAE,MAAM,CAAC,CAAC;aAC9C,KAAK,EAAE,CAAC;QAEX,MAAM,QAAQ,GAAG,CAAA,MAAA,MAAA,UAAU,CAAC,QAAQ,0CAAE,QAAQ,0CAAE,IAAI,KAAI,SAAS,CAAC;QAClE,MAAM,MAAM,GAAG,IAAA,qBAAW,EAAC,QAAoB,EAAE,aAAa,CAAC,CAAC;QAChE,MAAM,cAAc,GAAG,MAAM,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC;QACrD,MAAM,aAAa,GAAG,gCAAa,CAAC,KAAK,CAAC,cAAc,EAAE,WAAW,CAAC,CAAC;QACvE,MAAM,OAAO,GAAG,IAAA,+BAAY,EAAC,cAAc,EAAE,cAAc,EAAE,aAAa,CAAC,CAAC;QAC5E,MAAM,aAAa,GAAG,IAAA,yBAAM,EAAC,6BAAU,CAAC,IAAI,EAAE,OAAO,EAAE,cAAc,CAAC,CAAC;QACvE,MAAM,QAAQ,GAAG,IAAA,WAAI,EAAC,IAAA,cAAO,EAAC,cAAc,CAAC,EAAE,IAAA,eAAQ,EAAC,cAAc,EAAE,cAAc,CAAC,CAAC,CAAC;QACzF,MAAM,eAAe,GAAG,IAAA,WAAI,EAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;QACxD,MAAM,IAAA,oBAAS,EAAC,eAAe,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IAC1D,CAAC,CAAC;IAEF,MAAM,OAAO,GAAG,IAAI,qCAAiB,EAAE,CAAC;IACxC,MAAM,OAAO,GAAG,IAAI,0BAAkB,CAAC,GAAG,CAAC,CAAC;IAC5C,OAAO,CAAC,WAAW,GAAG,OAAO,CAAC,QAAQ,EAAE,CAAC;IACzC,OAAO,CAAC,OAAO,GAAG,IAAA,qCAA2B,EAAC,kBAAkB,CAAC,CAAC;IAClE,MAAM,IAAA,oBAAY,EAAC,kBAAkB,EAAE,eAAe,EAAE,OAAO,CAAC,CAAC;IAEjE,OAAO,EAAE,YAAY,EAAE,OAAO,CAAC,KAAK,EAAE,gBAAgB,EAAE,CAAC;AAC3D,CAAC;AAzCD,yCAyCC"}

package/built/cmds/sequenceDiagram/buildSequenceDiagramFromAppMap.js

@@ -1,11 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.buildSequenceDiagramFromAppMapFile = void 0;
-const sequence_diagram_1 = require("@appland/sequence-diagram");
-const models_1 = require("@appland/models");
-function buildSequenceDiagramFromAppMapFile(fileName, appMapData) {
-    const appmap = (0, models_1.buildAppMap)(appMapData).build();
-    return (0, sequence_diagram_1.buildDiagram)(fileName, appmap, sequence_diagram_1.Specification.build(appmap, {}));
-}
-exports.buildSequenceDiagramFromAppMapFile = buildSequenceDiagramFromAppMapFile;
-//# sourceMappingURL=buildSequenceDiagramFromAppMap.js.map

package/built/cmds/sequenceDiagram/buildSequenceDiagramFromAppMap.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"buildSequenceDiagramFromAppMap.js","sourceRoot":"","sources":["../../../src/cmds/sequenceDiagram/buildSequenceDiagramFromAppMap.ts"],"names":[],"mappings":";;;AAAA,gEAAiF;AACjF,4CAA8C;AAE9C,SAAgB,kCAAkC,CAAC,QAAgB,EAAE,UAAe;IAClF,MAAM,MAAM,GAAG,IAAA,oBAAW,EAAC,UAAU,CAAC,CAAC,KAAK,EAAE,CAAC;IAC/C,OAAO,IAAA,+BAAY,EAAC,QAAQ,EAAE,MAAM,EAAE,gCAAa,CAAC,KAAK,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,CAAC;AACzE,CAAC;AAHD,gFAGC"}