Display release notes using webview (#3321)

* Display release notes using webview

* Use const and fix string

* Check for version upgrade before showing release notes

* Changelog entry

* Use node-fetch instead of web-request

* Remove spurious state update

Author: rohanjr

compiler/daml-extension/package.json

@@ -135,17 +135,20 @@
         "build": "node ./node_modules/typescript/bin/tsc -p ./"
     },
     "dependencies": {
-        "vscode-languageclient": "6.0.0-next.1",
-        "which": "1.3.1",
-        "tmp": "0.0.29",
+        "@types/node-fetch": "^2.5.3",
         "@types/tmp": "0.0.29",
-        "@types/which": "1.3.1"
+        "@types/which": "1.3.1",
+        "fp-ts": "^2.1.1",
+        "node-fetch": "^2.6.0",
+        "tmp": "0.0.29",
+        "vscode-languageclient": "6.0.0-next.1",
+        "which": "1.3.1"
     },
     "devDependencies": {
         "@bazel/hide-bazel-files": "0.32.2",
-        "typescript": "3.6.3",
         "@types/node": "12.7.11",
         "@types/vscode": "1.33",
+        "typescript": "3.6.3",
         "vsce": "1.66.0"
     }
 }

compiler/daml-extension/src/extension.ts

@@ -11,14 +11,16 @@ import * as os from 'os';
 import * as cp from 'child_process';
 import * as tmp from 'tmp';
 import { LanguageClient, LanguageClientOptions, RequestType, NotificationType, TextDocumentIdentifier, TextDocument, ExecuteCommandRequest } from 'vscode-languageclient';
-import { Uri, Event, TextDocumentContentProvider, ViewColumn, EventEmitter, window, QuickPickOptions, ExtensionContext, env, WorkspaceConfiguration } from 'vscode'
+import { Uri, Event, TextDocumentContentProvider, ViewColumn, EventEmitter, window, QuickPickOptions, ExtensionContext, env, WorkspaceConfiguration } from 'vscode';
 import * as which from 'which';
 import * as util from 'util';
-
+import fetch, { Response } from 'node-fetch';
+import { getOrd } from 'fp-ts/lib/Array';
+import { ordNumber } from 'fp-ts/lib/Ord';
 
 let damlRoot: string = path.join(os.homedir(), '.daml');
 
-let versionContextKey = 'version'
+const versionContextKey = 'version'
 
 var damlLanguageClient: LanguageClient;
 // Extension activation
@@ -31,8 +33,8 @@ export async function activate(context: vscode.ExtensionContext) {
     // Get telemetry consent
     const consent = getTelemetryConsent(config, context);
 
-    // Check extension version to publish release notes on updates
-    checkVersion(context);
+    // Check extension version to display release notes on updates
+    showReleaseNotesIfNewVersion(context);
 
     damlLanguageClient = createLanguageClient(config, await consent);
     damlLanguageClient.registerProposedFeatures();
@@ -97,17 +99,55 @@ export async function activate(context: vscode.ExtensionContext) {
 }
 
 // Compare the extension version with the one stored in the global state.
-// This will be used to show release notes when the version has changed.
-async function checkVersion(context: ExtensionContext) {
-    let packageFile = path.join(context.extensionPath, 'package.json');
-    let packageData = await util.promisify(fs.readFile)(packageFile, "utf8");
-    let extensionVersion = JSON.parse(packageData).version;
-    let recordedVersion = context.globalState.get(versionContextKey);
-    if (!recordedVersion || recordedVersion != extensionVersion ) {
+// If they are different, we assume the user has updated the extension and
+// we display the release notes for the new SDK release in a new tab.
+// This should only occur the first time the user uses the extension after
+// an update.
+async function showReleaseNotesIfNewVersion(context: ExtensionContext) {
+    const packageFile = path.join(context.extensionPath, 'package.json');
+    const packageData = await util.promisify(fs.readFile)(packageFile, "utf8");
+    const extensionVersion = JSON.parse(packageData).version;
+    const recordedVersion = String(context.globalState.get(versionContextKey));
+    if (!recordedVersion || checkVersionUpgrade(recordedVersion, extensionVersion)) {
+        // We have a new version of the extension so show the release notes
+        // and update the current version so we don't show them again until
+        // the next update.
+        showReleaseNotes(extensionVersion);
         await context.globalState.update(versionContextKey, extensionVersion);
     }
 }
 
+// Check that `version2` is an upgrade from `version1`,
+// i.e. that the components of the version number have increased
+// (checked from major to minor version numbers).
+function checkVersionUpgrade(version1: string, version2: string) {
+    const comps1 = version1.split(".").map(Number);
+    const comps2 = version2.split(".").map(Number);
+    const o = getOrd(ordNumber);
+    return o.compare(comps2, comps1) > 0;
+}
+
+// Show the release notes from the DAML Blog.
+// We display the HTML in a new editor tab using a "webview":
+// https://code.visualstudio.com/api/extension-guides/webview
+async function showReleaseNotes(version: string) {
+    const releaseNotesUrl = 'https://blog.daml.com/release-notes/';
+    if (version) {
+        const url = releaseNotesUrl + version;
+        fetch(url).then(async (result: Response) => {
+            if (result.ok) {
+                const panel = vscode.window.createWebviewPanel(
+                    'releaseNotes', // Identifies the type of the webview. Used internally
+                    `Release Notes for DAML SDK ${version}`, // Title of the panel displayed to the user
+                    vscode.ViewColumn.One, // Editor column to show the new webview panel in
+                    {} // No webview options for now
+                );
+                panel.webview.html = await result.text();
+            }
+        });
+    }
+}
+
 function getViewColumnForShowResource(): ViewColumn {
     const active = vscode.window.activeTextEditor;
     if (!active || !active.viewColumn) { return ViewColumn.One; }

compiler/daml-extension/yarn.lock

@@ -7,6 +7,13 @@
   resolved "https://registry.yarnpkg.com/@bazel/hide-bazel-files/-/hide-bazel-files-0.32.2.tgz#a482855eafbccb56b1fce0d92ff922c2c6e0a90c"
   integrity sha512-585XY53mhMZaCjEQJ+aDqkmydWZbuXsKrZsSpoW9YeAVEH0poQY3YhdyCPmMVBo7/l1mkrqpFuOK5BpECfwdtA==
 
+"@types/node-fetch@^2.5.3":
+  version "2.5.3"
+  resolved "https://registry.yarnpkg.com/@types/node-fetch/-/node-fetch-2.5.3.tgz#b84127facd93642b1fb6439bc630ba0612e3ec50"
+  integrity sha512-X3TNlzZ7SuSwZsMkb5fV7GrPbVKvHc2iwHmslb8bIxRKWg2iqkfm3F/Wd79RhDpOXR7wCtKAwc5Y2JE6n/ibyw==
+  dependencies:
+    "@types/node" "*"
+
 "@types/node@*":
   version "12.6.2"
   resolved "https://registry.yarnpkg.com/@types/node/-/node-12.6.2.tgz#a5ccec6abb6060d5f20d256fb03ed743e9774999"
@@ -200,6 +207,11 @@ fd-slicer@~1.1.0:
   dependencies:
     pend "~1.2.0"
 
+fp-ts@^2.1.1:
+  version "2.1.1"
+  resolved "https://registry.yarnpkg.com/fp-ts/-/fp-ts-2.1.1.tgz#c910544499d7c959351bb4260ee7c44a544084c1"
+  integrity sha512-YcWhMdDCFCja0MmaDroTgNu+NWWrrnUEn92nvDgrtVy9Z71YFnhNVIghoHPt8gs82ijoMzFGeWKvArbyICiJgw==
+
 fs.realpath@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/fs.realpath/-/fs.realpath-1.0.0.tgz#1504ad2523158caa40db4a2787cb01411994ea4f"
@@ -297,6 +309,11 @@ mute-stream@~0.0.4:
   resolved "https://registry.yarnpkg.com/mute-stream/-/mute-stream-0.0.8.tgz#1630c42b2251ff81e2a283de96a5497ea92e5e0d"
   integrity sha512-nnbWWOkoWyUsTjKrhgD0dcz22mdkSnpYqbEjIm2nhwhuxlSkpywJmBo8h0ZqJdkp73mb90SssHkN4rsRaBAfAA==
 
+node-fetch@^2.6.0:
+  version "2.6.0"
+  resolved "https://registry.yarnpkg.com/node-fetch/-/node-fetch-2.6.0.tgz#e633456386d4aa55863f676a7ab0daa8fdecb0fd"
+  integrity sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==
+
 nth-check@~1.0.1:
   version "1.0.2"
   resolved "https://registry.yarnpkg.com/nth-check/-/nth-check-1.0.2.tgz#b2bd295c37e3dd58a3bf0700376663ba4d9cf05c"

unreleased.rst

@@ -32,3 +32,4 @@ HEAD — ongoing
   match the behavior of corresponding functions without the underscore suffix but ignore the result which can be more convenient and
   efficient.
 - [DAML Compiler] The compiler now accepts single-constructor enum types. For example ``data A = A`` or ``data Foo = Bar``.
+- [DAML SDK] Display release notes in the IDE when the DAML extension is upgraded.