@appland/appmap 3.100.1 → 3.102.0

package/built/lib/loadAppMapConfig.js.map

@@ -1 +1 @@
-{"version":3,"file":"loadAppMapConfig.js","sourceRoot":"","sources":["../../src/lib/loadAppMapConfig.ts"],"names":[],"mappings":";;AAAA,0CAAuC;AACvC,qCAA+B;AAsChB,KAAK,UAAU,gBAAgB,CAC5C,QAAQ,GAAG,YAAY;;IAEvB,IAAI,gBAAoC,CAAC;IACzC,IAAI;QACF,gBAAgB,GAAG,MAAM,IAAA,mBAAQ,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;KACtD;IAAC,OAAO,CAAC,EAAE;QACV,OAAO;KACR;IAED,MAAM,eAAe,GAAG,IAAA,cAAI,EAAC,gBAAgB,CAAQ,CAAC;IACtD,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC,OAAO,eAAe,KAAK,QAAQ,CAAC;QAAE,OAAO;IAEvE,MAAM,YAAY,GAAG,eAA+B,CAAC;IACrD,YAAY,CAAC,MAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,OAAO,0CAAE,MAAM,CAAC,CAAC;IAE5C,OAAO,YAAY,CAAC;AACtB,CAAC;AAjBD,mCAiBC;AAED,SAAS,YAAY,CAAC,GAAoC;IACxD,IAAI,CAAC,GAAG;QAAE,OAAO;IAEjB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAClC,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,MAAM,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QAClF,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;QAChB,GAAG,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;KAC3B;AACH,CAAC"}
+{"version":3,"file":"loadAppMapConfig.js","sourceRoot":"","sources":["../../src/lib/loadAppMapConfig.ts"],"names":[],"mappings":";;AAAA,0CAAuC;AACvC,qCAA+B;AA2ChB,KAAK,UAAU,gBAAgB,CAC5C,QAAQ,GAAG,YAAY;;IAEvB,IAAI,gBAAoC,CAAC;IACzC,IAAI;QACF,gBAAgB,GAAG,MAAM,IAAA,mBAAQ,EAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;KACtD;IAAC,OAAO,CAAC,EAAE;QACV,OAAO;KACR;IAED,MAAM,eAAe,GAAG,IAAA,cAAI,EAAC,gBAAgB,CAAQ,CAAC;IACtD,IAAI,CAAC,eAAe,IAAI,CAAC,CAAC,OAAO,eAAe,KAAK,QAAQ,CAAC;QAAE,OAAO;IAEvE,MAAM,YAAY,GAAG,eAA+B,CAAC;IACrD,YAAY,CAAC,MAAA,YAAY,aAAZ,YAAY,uBAAZ,YAAY,CAAE,OAAO,0CAAE,MAAM,CAAC,CAAC;IAE5C,OAAO,YAAY,CAAC;AACtB,CAAC;AAjBD,mCAiBC;AAED,SAAS,YAAY,CAAC,GAAoC;IACxD,IAAI,CAAC,GAAG;QAAE,OAAO;IAEjB,KAAK,MAAM,GAAG,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE;QAClC,MAAM,KAAK,GAAG,GAAG,CAAC,GAAG,CAAC,CAAC;QACvB,MAAM,YAAY,GAAG,GAAG,CAAC,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,WAAW,EAAE,CAAC,CAAC;QAClF,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;QAChB,GAAG,CAAC,YAAY,CAAC,GAAG,KAAK,CAAC;KAC3B;AACH,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appland/appmap",
-  "version": "3.100.1",
+  "version": "3.102.0",
   "description": "",
   "bin": "built/cli.js",
   "engines": {

package/resources/change-report/changed-appmaps/details.hbs

@@ -19,7 +19,7 @@ Review changes
   {{/each}}
 
   {{#if pruned}}
-Because there are so many changed AppMaps, some of them are not listed in this report.
+Because there are many changed AppMaps, some of them are not listed in this report.
   {{/if}}
 </details>
 {{/if}}

package/resources/change-report/changed-appmaps/heading.hbs

@@ -1,6 +1,6 @@
 | [Changed AppMaps](#changed-appmaps) |
   {{~#unless (length changedAppMaps) }}
-  :white_check_mark: No changes
+  :zero: No changes
   {{~else}}
   :twisted_rightwards_arrows: {{length changedAppMaps}} changes
   {{~/unless}}

package/resources/change-report/failed-tests/details.hbs

@@ -52,6 +52,6 @@ The error occurred at [{{failureLocation}}]({{ source_url failureLocation }}):
 
   {{/each}}
   {{#if pruned}}
-Because there are so many failed tests, some of them are not listed in this report.
+Because there are many failed tests, some of them are not listed in this report.
   {{/if}}
 {{/if}}

package/resources/change-report/findings/details.hbs

@@ -51,30 +51,26 @@
 
 </details>
 {{/inline}}
-{{#with findingDiff}}
-  {{#if (length newFindings resolvedFindings)}}
-<h2 id="findings">Findings</h2>
+{{#if (length findingDiff.newFindings findingDiff.resolvedFindings)}}
+<h2 id="{{ metadata.anchor }}">{{ metadata.title }}</h2>
+  {{#if (length findingDiff.newFindings) }}
 
-    {{#with newFindings}}
-### :beetle: New findings ({{ length this}})
+### {{metadata.emoji}} New problems detected ({{ length findingDiff.newFindings }})
 
-      {{#each this}}
+    {{#each findingDiff.newFindings}}
 {{> finding}}
-      {{/each}}
-
-    {{/with}}
+    {{/each}}
+  {{/if}}
+  {{#if (length findingDiff.resolvedFindings) }}
 
-    {{#with resolvedFindings}}
-### :tada: Resolved findings ({{ length this}})
+### :tada: Problems resolved ({{ length findingDiff.resolvedFindings}})
 
-      {{#each this}}
+    {{#each findingDiff.resolvedFindings}}
 {{> finding}}
-      {{/each}}
-
-    {{/with}}
+    {{/each}}
+  {{/if}}
+  {{#if findingDiff.pruned}}
 
-    {{#if pruned}}
-Because there are so many new and resolved findings, some of them are not listed in this report.
-    {{/if}}
+Because there are many new and resolved {{ metadata.name }}, some of them are not listed in this report.
   {{/if}}
-{{/with}}
+{{/if}}

package/resources/change-report/findings/heading.hbs

@@ -1,13 +1,11 @@
-| [Findings](#findings) |
-  {{~#with findingDiff}}
-  {{~#unless (length newFindings resolvedFindings) }}
-  :white_check_mark: None
+| [{{ metadata.title }}](#{{ metadata.anchor }}) |
+  {{~#unless (length findingDiff.newFindings findingDiff.resolvedFindings) }}
+  :white_check_mark: None detected
   {{~/unless}}
-  {{~#if (length newFindings) }}
-  :beetle: {{length newFindings}} new
+  {{~#if (length findingDiff.newFindings) }}
+  {{ metadata.emoji }} {{length findingDiff.newFindings}} new
   {{~/if}}
-  {{~#if (length resolvedFindings) }}
-  :tada: {{length resolvedFindings}} resolved
+  {{~#if (length findingDiff.resolvedFindings) }}
+  :tada: {{length findingDiff.resolvedFindings}} resolved
   {{~/if}}
-  {{~/with}}
   |

package/resources/change-report/new-appmaps/details.hbs

@@ -6,6 +6,6 @@
 
   {{/each}}
   {{#if pruned}}
-Because there are so many new AppMaps, some of them are not listed in this report.
+Because there are many new AppMaps, some of them are not listed in this report.
   {{/if}}
 {{/if}}

package/resources/change-report/new-appmaps/heading.hbs

@@ -1,3 +1,3 @@
 | [New AppMaps](#new-appmaps) |
-  {{~#unless newAppMaps.length }} :white_check_mark: None {{else}} :star: {{newAppMaps.length}} new {{/unless~}}
-  |
+  {{~#with (group_appmaps_by_recorder_name newAppMaps) }} :star: {{#each @this}}{{#unless @first }}, {{/unless}}{{ count }} new {{ recorderName }}{{#if isTest}} {{ pluralize count 'test' }}{{/if}}{{/each}} {{else}} :zero: No new AppMaps {{/with~}}
+|

package/resources/change-report/openapi-diff/details.hbs

@@ -37,7 +37,7 @@
     {{/if}}
 
     {{#if pruned}}
-Because there are so many OpenAPI changes, some of them are not listed in this report,
+Because there are many OpenAPI changes, some of them are not listed in this report,
 and the full diff has not been printed either.
     {{else}}
 <details>

package/resources/change-report/openapi-diff/heading.hbs

@@ -3,6 +3,6 @@
   {{~#if differenceCount }}
     {{~#if breakingDifferenceCount }} 🚧 {{breakingDifferenceCount}} breaking{{~/if}}
     {{~#if nonBreakingDifferenceCount }}{{#if breakingDifferenceCount }},{{~/if}} :wrench: {{nonBreakingDifferenceCount}} non-breaking{{/if~}}
-  {{~else}} :white_check_mark: No API changes
+  {{~else}} :zero: No API changes
   {{~/if}} |
 {{~/with}}

package/resources/change-report/removed-appmaps/details.hbs

@@ -6,6 +6,6 @@
 
   {{/each}}
   {{#if pruned}}
-Because there are so many removed AppMaps, some of them are not listed in this report.
+Because there are many removed AppMaps, some of them are not listed in this report.
   {{/if}}
 {{/if}}

package/resources/change-report/removed-appmaps/heading.hbs

@@ -1,3 +1,5 @@
 {{#if removedAppMaps.length ~}}
-| [Removed AppMaps](#removed-appmaps) | :heavy_multiplication_x: {{removedAppMaps.length}} removed |
+| [Removed AppMaps](#removed-appmaps) | 
+  {{~#with (group_appmaps_by_recorder_name removedAppMaps) }} :heavy_multiplication_x: {{#each @this}}{{#unless @first }}, {{/unless}}{{ count }} removed {{ recorderName }}{{#if isTest}} {{ pluralize count 'test' }}{{/if}}{{/each}} {{/with~}}
+  |
 {{~/if}}

package/resources/inventory-report/welcome/welcome.hbs

@@ -1,59 +1,82 @@
-##  Welcome to AppMap!
+##  AppMap configuration report
 
-This is a report of the AppMap data in your project. Let's start with a look at how the
-AppMap data is created in this project. In CI, AppMaps are generally created by recording
-test cases. Here's how the AppMaps in this project were created:
-
-| Recorder | Number of AppMaps |
-| --- | --- |
-{{#each appmapCountByRecorderName}}
-| {{@key}} | {{@this}} |
-{{/each}}
+Success! Your project has been successfully configured to record AppMaps when
+you run your tests.
 
-Continue reading for information about:
+> **[Continue with AppMap Setup >>](https://getappmap.com/github/configuration_report)**
 
-- [Runtime analysis](#runtime-analysis)
-- [REST API analysis](#rest-api-analysis)
-- [SQL profile](#sql-profile)
+<hr/>
 
-#### Runtime Analysis
+<details>
+<summary>
+View details
+</summary>
 
-AppMap includes a runtime analysis capability that analyzes the AppMap data for security vulnerabilities,
-performance problems, and code anti-patterns. On each pull request, you'll get a report of
-the new and resolved issues for the repo.
+<h3><a id="data-sources">AppMap data sources</a></h3>
 
-{{#if (length findingCountByImpactDomain) }}
-AppMap has performed a preliminary analysis of this repo, and detected some problems. Here's a
-summary:
+In GitHub Actions and other CI systems, AppMaps are created by recording
+test cases. Here's how the AppMaps in this project were created:
 
-| Impact Domain | Number of Problems |
+{{#if (eq (length appmapCountByRecorderName) 1) }}
+| Number of AppMaps | Type of recording |
 | --- | --- |
-  {{#each findingCountByImpactDomain}}
-| {{@key}} | {{@this}} |
-  {{/each}}
-
-{{~else~}}
-No security vulnerabilities or performance problems were detected in this repo. Keep up the good work :slightly_smiling_face:
+{{#each appmapCountByRecorderName}}
+| {{@this}} | {{@key}} |
+{{/each}}
+{{else}}
+```mermaid
+pie showData
+  title Sources of AppMap data in this project
+{{#each appmapCountByRecorderName}}
+  "{{@key}}" : {{@this}}
+{{/each}}
+```
 {{/if}}
 
-AppMap runtime analysis is configurable. [Learn more about configuring AppMap runtime analysis](https://appmap.io/docs/guides/configuring-analysis.html).
+<h3><a id="code-profile">Code profile</a></h3>
 
-#### REST API analysis
+Your _appmap.yml_ configuration file specifies all the code that you want AppMap to instrument and record.
+By default, sub-modules of any requested code are recorded as well. In this project, the packages specified
+in _appmap.yml_ are:
 
-When you record AppMaps that include HTTP server requests, AppMap can automatically generate OpenAPI definitions. 
+```yaml
+{{{ format_as_yaml appmapConfig.packages }}}```
 
-{{#if (length appmapCountByHTTPServerRequestCount) }}
+By applying this configuration to your {{ appmapConfig.language }} project, AppMap has recorded the 
+following packages and modules:
 
-This project has AppMaps that contain HTTP server requests. Here's a profile of the AppMaps that
-include HTTP server requests:
+{{#each (packages_matching_configuration packages appmapConfig.packages) }}`{{ @this }}` {{/each}}
 
-| Number of HTTP server requests | Number of AppMaps |
-| --- | --- |
-| None | {{ coalesce appmapCountByHTTPServerRequestCount.[0] 'No AppMaps' }} |
-| Between 1 and 5 | {{ sum_values_by_key_range appmapCountByHTTPServerRequestCount 1 5 }} |
-| More than 5 | {{ sum_values_by_key_range appmapCountByHTTPServerRequestCount 5 }} |
+<h3><a id="ws-api-profile">Web service API profile</a></h3>
 
-At a high level, here are the REST resources that are provided by this project:
+When you record AppMaps that include HTTP server requests, AppMap automatically generates OpenAPI definitions
+based on the observed data.
+
+{{#if (length appmapCountByHTTPServerRequestCount) }}
+
+**{{ format_as_percentage 
+  (divide
+    (subtract 
+      (sum (values appmapCountByRecorderName))
+      (coalesce appmapCountByHTTPServerRequestCount.[0] 0)
+    )
+    (sum (values appmapCountByRecorderName))
+  ) 
+  }}** of the AppMaps in this project contain **at least one** HTTP server request.
+
+
+**{{ format_as_percentage 
+  (divide
+    (subtract 
+      (sum (values appmapCountByRecorderName))
+      (coalesce appmapCountByHTTPServerRequestCount.[0] 0)
+      (coalesce appmapCountByHTTPServerRequestCount.[1] 0)
+    )
+    (sum (values appmapCountByRecorderName))
+  ) 
+  }}** of the AppMaps in this project contain **more than one** HTTP server request.
+
+Here's **a summary of the web service routes** that are provided by this project:
 
 {{#each routeCountByResource}}`{{@key}}` {{/each}}
 
@@ -69,47 +92,59 @@ As you change your code and tests, AppMap will automatically update the OpenAPI
 You'll see a summary of the REST API changes in each pull request.
 
 {{~else~}}
-This project doesn't have any AppMaps that contain HTTP server requests. If this is unexpected,
-you can add some test cases that exercise the HTTP server. The more of these type of tests you add,
+This project doesn't have any AppMaps that contain HTTP server requests. If your app provides
+web service APIs, and you don't see any HTTP server requests here, you can add some test cases that 
+exercise the HTTP server. The more of these type of tests you add,
 the better the AppMap data will be for generating OpenAPI definitions and comparing the API
 changes in each pull request.
 {{/if}}
 
-#### SQL profile
+<h3><a id="sql-profile">SQL profile</a></h3>
 
 When your code makes a SQL query, AppMap records the SQL query in detail. It even parses the queries
 to figure out which tables your app is using, and how it's using them.
 
 {{#if (length appmapCountBySQLQueryCount) }}
 
-Here's a summary of how many SQL queries are in the AppMaps of this project:
 
-| SQL queries | Number of AppMaps |
-| --- | --- |
-| None | {{ coalesce appmapCountBySQLQueryCount.[0] 'No AppMaps' }} |
-| Between 1 and 5 | {{ sum_values_by_key_range appmapCountBySQLQueryCount 1 5 }} |
-| More than 5 | {{ sum_values_by_key_range appmapCountBySQLQueryCount 5 }} |
+**{{ format_as_percentage 
+  (divide
+    (subtract 
+      (sum (values appmapCountByRecorderName))
+      (coalesce appmapCountBySQLQueryCount.[0] 0)
+    )
+    (sum (values appmapCountByRecorderName))
+  ) 
+  }}** of the AppMaps in this project contain **at least one** SQL query.
+
+
+**{{ format_as_percentage 
+  (divide
+    (subtract 
+      (sum (values appmapCountByRecorderName))
+      (coalesce appmapCountBySQLQueryCount.[0] 0)
+      (coalesce appmapCountBySQLQueryCount.[1] 0)
+    )
+    (sum (values appmapCountByRecorderName))
+  ) 
+  }}** of the AppMaps in this project contain **more than one** SQL query.
 
 {{#if (length sqlTables) }}
 
-And here are all the SQL tables that are used by this project:
+Here are the SQL tables that are present in the observed queries:
 
 {{#each sqlTables}}`{{@this}}` {{/each}}
 {{/if}}
 
 {{~else~}}
-This project doesn't have any AppMaps of SQL queries. If this is unexpected,
-you can add some test cases that interact with the database. The more of these type of tests you add,
+This project doesn't have any AppMaps of SQL queries. If your app uses a database,
+and you don't see SQL queries here, you can add some test cases that interact with the database. The more of these type of tests you add,
 the better the AppMap data will be for analyzing the SQL changes in each pull request.
 {{/if}}
 
-<!--
-  ## External services profile 
-
-  TODO
-
-## Code organization
+### Learn more
 
-The app contains `{{ length packages }}` code packages.
--->
+To learn more about AppMap, visit
+[appmap.io/docs](https://appmap.io/docs).
 
+</details>

package/resources/inventory-report/default/inventory.hbs

@@ -1,89 +0,0 @@
-##  AppMap data profile
-
-#### How is AppMap data created in this project?
-
-| Recorder | Number of AppMaps |
-| --- | --- |
-{{#each appmapCountByRecorderName}}
-| {{@key}} | {{@this}} |
-{{/each}}
-
-
-## Code quality
-
-#### Findings
-
-| Impact Domain | Number of Findings |
-| --- | --- |
-{{#each findingCountByImpactDomain}}
-| {{@key}} | {{@this}} |
-{{/each}}
-
-
-## Server API profile
-
-{{#if (length appmapCountByHTTPServerRequestCount) }}
-
-#### How many AppMaps have HTTP server requests, and how many do they have?
-
-| Number of HTTP server requests | Number of AppMaps |
-| --- | --- |
-| None | {{ coalesce appmapCountByHTTPServerRequestCount.[0] 'No AppMaps' }} |
-| Between 1 and 5 | {{ sum_values_by_key_range appmapCountByHTTPServerRequestCount 1 5 }} |
-| More than 5 | {{ sum_values_by_key_range appmapCountByHTTPServerRequestCount 5 }} |
-
-#### What are the HTTP server routes of the project?
-
-| Route prefix | Number of routes |
-| --- | --- |
-  {{#each routeCountByResource}}
-| {{@key}} | {{@this}} |
-  {{/each}}
-
-#### What HTTP content types are served by the project?
-
-| Response Content Type | Number of Routes |
-| --- | --- |
-  {{#each routeCountByContentType}}
-| {{@key}} | {{@this}} |
-  {{/each}}
-
-{{~else~}}
-This project doesn't have any AppMaps of HTTP server requests.
-{{/if}}
-
-## SQL profile
-
-#### How many AppMaps have SQL queries, and how many do they have?
-
-{{#if (length appmapCountBySQLQueryCount) }}
-| SQL queries | Number of AppMaps |
-| --- | --- |
-| None | {{ coalesce appmapCountBySQLQueryCount.[0] 'No AppMaps' }} |
-| Between 1 and 5 | {{ sum_values_by_key_range appmapCountBySQLQueryCount 1 5 }} |
-| More than 5 | {{ sum_values_by_key_range appmapCountBySQLQueryCount 5 }} |
-
-#### What SQL tables are used by this project?
-
-{{#if (length sqlTables) }}
-| Table name | 
-| --- |
-  {{#each sqlTables}}
-| {{@this}} |
-  {{/each}}
-{{/if}}
-
-{{~else~}}
-This project doesn't have any AppMaps of SQL queries.
-{{/if}}
-
-<!--
-  ## External services profile 
-
-  TODO
--->
-
-## Code organization
-
-The app contains `{{ length packages }}` code packages.
-