Merge pull request #269 from financialforcedev/chore-update-version-v…

…1.6.0

chore: update version v1.6.0

BUILDING.md

@@ -28,13 +28,13 @@ npm ci
 
 ### Build and bundle
 
-Run the folloing command to do a quick build of the bundles. This will skip some of the typechecking.
+Run the following command to do a quick build of the bundles. This will skip the minfication step.
 
 ```zsh
 npm run build:dev
 ```
 
-or to do a build with full typechecking of all `.d.ts` files, use:
+or to do a production ready build, use:
 
 ```zsh
 npm run build

CHANGELOG.md

@@ -5,31 +5,33 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## [1.6.0] - 2023-05-19
 
 ## Added
 
-- Breadcrumbs shown above the calltree when clicking a row ([#142][#142])
-- `Log: Show Apex Log Analysis` code lens to the top of the currently open log file ([#199][#199])
-  - This is a faster way to open the analysis
-- Support for more file types when showing the analysis ([#199][#199])
-  - The analysis can now be shown for any `.log` or `.txt` file that starts with the Apex debug log header
-  - e.g `57.0 APEX_CODE,FINE;APEX_PROFILING,FINE;CALLOUT,NONE;DB,FINEST;NBA,INFO;SYSTEM,DEBUG;VALIDATION,INFO;VISUALFORCE,FINE;WAVE,INFO;WORKFLOW,INFO`
 - Redesigned Database tab ([#219][#219])
   - All columns are sortable ascending /descending by clicking the header
   - Added columns DML/ SOQL, Row Count, Total Time
   - Added specific columns for SOQL Selectivity + Aggregations
   - Added detail panel which is shown by clicking a row which shows the call stack for the specific DML / SOQL, clicking a link will go to the main call tree tab
+  - The detail panel also shows a list of potential SOQL performance issues
   - Totals shown at the bottom of each column
+  - SOQL/ DML is grouped by name by default, grouping can be removed to show the SOQL/ DML as a flat list
+- `Log: Show Apex Log Analysis` code lens to the top of the currently open log file ([#199][#199])
+  - This is a faster way to open the analysis
+- Support for more file types when opening the analysis ([#199][#199])
+  - The analysis can now be shown for any `.log` or `.txt` file that starts with the Apex debug log header
+  - e.g `57.0 APEX_CODE,FINE;APEX_PROFILING,FINE;CALLOUT,NONE;DB,FINEST;NBA,INFO;SYSTEM,DEBUG;VALIDATION,INFO;VISUALFORCE,FINE;WAVE,INFO;WORKFLOW,INFO`
 - The row count to the timeline tooltip for events which have one e.g `SOQL_EXECUTE_BEGIN`, `DML_BEGIN`, `SOSL_EXECUTE_BEGIN` ([#129][#129])
+- Calltree - Breadcrumbs shown at the top when clicking a row ([#142][#142])
 - Calltree - displaying variable value as well as variable names for `VARIABLE_ASSIGNMENT` events ([#235][#235])
 - Calltree - pretty formatting of JSON in `VARIABLE_ASSIGNMENT` events ([#235][#235])
 
 ### Changed
 
 - Goto code from click to CMD/CTRL and click. Breadcrumbs are shown on click instead ([#142][#142])
-- End time of events that have a start before `MAXIMUM DEBUG LOG SIZE REACHED` but no end event, will now have their duration end before the `MAXIMUM DEBUG LOG SIZE REACHED` instead of extending to the very end of the log ([#264][#264])
-  - This provides a more accurate view of what is happening in these cases since we can not know what occured in the `MAXIMUM DEBUG LOG SIZE REACHED` gap.
+- End time of events that start before `MAXIMUM DEBUG LOG SIZE REACHED` but have no matching end event, will now have their duration end before the `MAXIMUM DEBUG LOG SIZE REACHED` instead of extending to the very end of the log ([#264][#264])
+  - This provides more accurate durations overall because we can not know what occured during the `MAXIMUM DEBUG LOG SIZE REACHED` gap.
 
 ### Fixed
 

CONTRIBUTING.md

@@ -1,35 +1,49 @@
 # Contributing
 
-🎉🥳 Thank you for contributing 🥳🎉  
-Please read and follow the [code of conduct](./CODE_OF_CONTDUCT) whilst interating with this project.
+🎉🥳 Thank you for contributing 🥳🎉\
 
-First things first, before raising an issue check the [open issues](https://github.com/financialforcedev/debug-log-analyzer/issues), there may already be something similar to what you are looking for.  
+Please read and follow the [code of conduct](./CODE_OF_CONTDUCT) whilst interacting with this project.
+
+First things first, before raising an issue check the [open issues](https://github.com/financialforcedev/debug-log-analyzer/issues), there may already be something similar to what you are looking for.
 If there is not, open an issue before contributing, it allows us to provide help and advice or just avoid duplicate effort.
 
 ## Getting the Code
 
 1. Create a fork of the project
 2. Clone your fork `git clone [email protected]:<username>/debug-log-analyzer.git`
-3. Create a topic branch in your fork from main e.g (`feat-11-some-description` or `bug-11-some-description`)
+3. Create a topic branch in your fork from main e.g (`feat-some-description` or `bug-some-description`)
 4. Edit the code in your fork.
 5. Create a pull request back to main, we will suggest any changes and get it merged.
 
-## Build
+### Dependencies
 
-In the directory you cloned the project to
+From a terminal, where you have cloned the repository, execute the following command to install the required dependencies:
 
 ```zsh
-cd lana
 npm ci
-npm run compile
 ```
 
-> NOTE: This will rebuild the whole project, to build only the `lana` folder use `npm run local-compile` and `npm run log-viewer` for the `log-viewer` folder.
+### Build
+
+```zsh
+npm run build
+```
+
+> NOTE: This will rebuild the whole project, to do a quick build (skipping minification) run `npm run build:dev`
+
+### Watch
+
+During development run the watch command to make builds for changes quickly. execute the following command:
+
+```zsh
+npm run watch
+```
+
+This will do a full build of the bundles and then watch for file changes in the `lana` and `log-viewer` source, compiling those changes incrementally, for a fast dev experience.
 
 ## Tests
 
 ```zsh
-cd log-viewer
 npm run test
 ```
 
@@ -38,5 +52,6 @@ npm run test
 To create a VSIX (VSCode install bundle)
 
 ```zsh
-vsce package
+cd lana
+vsce package --no-dependencies
 ```

README.md

@@ -99,13 +99,13 @@ settings.json
 
 ```json
 "lana.timeline.colors": {
-  "Code Unit": "#6BAD68",
-  "SOQL": "#4B9D6E",
-  "Method": "#328C72",
-  "Flow": "#237A72",
-  "DML": "#22686D",
-  "Workflow": "#285663",
-  "System Method": "#2D4455"
+  "Code Unit": "#88AE58",
+  "Workflow": "#51A16E",
+  "Method": "#2B8F81",
+  "Flow": "#337986",
+  "DML": "#285663",
+  "SOQL": "#5D4963",
+  "System Method": "#5C3444"
 }
 ```
 

lana/package.json

@@ -1,8 +1,8 @@
 {
   "name": "lana",
   "displayName": "Apex Log Analyzer",
-  "version": "1.5.2",
-  "description": "Analyzer for Salesforce debug logs - Visualize code execution via a Flame chart and identify performance and SOQL/DML problems via Method and Database analysis",
+  "version": "1.6.0",
+  "description": "Analyzer for Salesforce debug logs - Visualize code execution via a Flame graph and identify performance and SOQL/DML problems via Method and Database analysis",
   "keywords": [
     "apex",
     "apexlog",
@@ -104,37 +104,37 @@
           "properties": {
             "Code Unit": {
               "type": "string",
-              "default": "#6BAD68",
+              "default": "#88AE58",
               "description": "Hex color for Code Unit timeline events."
             },
-            "SOQL": {
+            "Workflow": {
               "type": "string",
-              "default": "#4B9D6E",
-              "description": "Hex color for SOQL timeline events."
+              "default": "#51A16E",
+              "description": "Hex color for Workflow timeline events."
             },
             "Method": {
               "type": "string",
-              "default": "#328C72",
+              "default": "#2B8F81",
               "description": "Hex color for Method timeline events."
             },
             "Flow": {
               "type": "string",
-              "default": "#237A72",
+              "default": "#337986",
               "description": "Hex color for Flow timeline events."
             },
             "DML": {
               "type": "string",
-              "default": "#22686D",
+              "default": "#285663",
               "description": "Hex color for DML timeline events."
             },
-            "Workflow": {
+            "SOQL": {
               "type": "string",
-              "default": "#285663",
-              "description": "Hex color for Workflow timeline events."
+              "default": "#5D4963",
+              "description": "Hex color for SOQL timeline events."
             },
             "System Method": {
               "type": "string",
-              "default": "#2D4455",
+              "default": "#5C3444",
               "description": "Hex color for System Method timeline events."
             }
           },