Release 2.2.2 (#33)

* fix caching of flag metadata and improve formatting of hover display

* int

* prepare 2.2.2

* fix typo

Author: Arnold Trakhtenberg

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to the "launchdarkly" extension will be documented in this file.
 
+## [2.2.2] = 2020-02-24
+
+### Changed
+
+- Improved formatting and readability of hover display
+- Feature flag metadata used for hover is now cached
+
 ## [2.2.1] - 2020-02-21
 
 ### Added

package.json

@@ -2,7 +2,7 @@
 	"name": "launchdarkly",
 	"displayName": "LaunchDarkly",
 	"description": "View LaunchDarkly feature flags in your editor.",
-	"version": "2.2.1",
+	"version": "2.2.2",
 	"publisher": "launchdarkly",
 	"engines": {
 		"vscode": "^1.34.0"

src/api.ts

@@ -39,7 +39,7 @@ export class LaunchDarklyAPI {
 		const envParam = envKey ? '?env=' + envKey : '';
 		const options = this.createOptions(`flags/${projectKey}/${flagKey + envParam}`);
 		const data = await rp(options);
-		return JSON.parse(data);
+		return new Flag(JSON.parse(data));
 	}
 
 	private createOptions(path: string) {

src/flagStore.ts

@@ -122,17 +122,21 @@ export class FlagStore {
 			this.store.get(DATA_KIND, key, async (res: FlagConfiguration) => {
 				if (!res) {
 					resolve(null);
+					return;
 				}
-				if (!flag || flag.environments[this.config.env].version < res.version) {
+
+				if (!flag || flag.environmentVersion(this.config.env) < res.version) {
 					try {
 						flag = await this.api.getFeatureFlag(this.config.project, key, this.config.env);
 						this.flagMetadata[key] = flag;
-						resolve({ flag, config: res });
 					} catch (e) {
 						console.error(`Could not retrieve feature flag metadata for ${key}: ${e}`);
 						reject(e);
+						return;
 					}
 				}
+
+				resolve({ flag, config: res });
 			});
 		});
 	}

src/models.ts

@@ -2,6 +2,7 @@ export class Resource {
 	name: string;
 	key: string;
 	tags: Array<string>;
+	_version: number;
 }
 
 export class Project extends Resource {
@@ -16,6 +17,18 @@ export class Environment extends Resource {
 
 export class Flag extends Resource {
 	environments: Map<String, Environment>;
+
+	constructor(init?: Partial<Flag>) {
+		super();
+		Object.assign(this, init);
+	}
+
+	environmentVersion(env: string): number {
+		if (!this.environments[env]) {
+			return -1;
+		}
+		return this._version + this.environments[env].version;
+	}
 }
 
 export class FlagConfiguration {

src/providers.ts

@@ -12,6 +12,7 @@ import {
 	Position,
 	Range,
 	TextDocument,
+	MarkdownString,
 } from 'vscode';
 import * as url from 'url';
 import opn = require('opn');
@@ -113,13 +114,13 @@ class LaunchDarklyHoverProvider implements HoverProvider {
 	public provideHover(document: TextDocument, position: Position): Thenable<Hover> {
 		return new Promise(async (resolve, reject) => {
 			if (this.config.enableHover) {
-				let candidate = document.getText(document.getWordRangeAtPosition(position, FLAG_KEY_REGEX));
+				const candidate = document.getText(document.getWordRangeAtPosition(position, FLAG_KEY_REGEX));
 				try {
-					let data =
+					const data =
 						(await this.flagStore.getFeatureFlag(candidate)) ||
 						(await this.flagStore.getFeatureFlag(kebabCase(candidate)));
 					if (data) {
-						let hover = generateHoverString(data.flag, data.config);
+						const hover = generateHoverString(data.flag, data.config);
 						resolve(new Hover(hover));
 						return;
 					}
@@ -180,19 +181,31 @@ const openFlagInBrowser = async (config: Configuration, flagKey: string, flagSto
 };
 
 export function generateHoverString(flag: Flag, c: FlagConfiguration) {
-	return `**LaunchDarkly feature flag**\n
-	Name: ${flag.name}
-	Key: ${c.key}
-	Enabled: ${c.on}
-	Default variation: ${JSON.stringify(c.variations[c.fallthrough.variation])}
-	Off variation: ${JSON.stringify(c.variations[c.offVariation])}
-	${plural(c.prerequisites.length, 'prerequisite', 'prerequisites')}
-	${plural(
-		c.targets.reduce((acc, curr) => acc + curr.values.length, 0),
-		'user target',
-		'user targets',
-	)}
-	${plural(c.rules.length, 'rule', 'rules')}`;
+	const fields = [
+		['Name', flag.name],
+		['Key', c.key],
+		['Enabled', c.on],
+		['Default variation', JSON.stringify(c.variations[c.fallthrough.variation], null, 2)],
+		['Off variation', JSON.stringify(c.variations[c.offVariation], null, 2)],
+		[plural(c.prerequisites.length, 'prerequisite', 'prerequisites')],
+		[
+			plural(
+				c.targets.reduce((acc, curr) => acc + curr.values.length, 0),
+				'user target',
+				'user targets',
+			),
+		],
+		[plural(c.rules.length, 'rule', 'rules')],
+	];
+	let hoverString = new MarkdownString(`**LaunchDarkly feature flag**`);
+	fields.forEach(field => {
+		hoverString = hoverString.appendText('\n' + `${field[0]}`);
+		if (field.length == 2) {
+			hoverString = hoverString.appendText(`: `);
+			hoverString = hoverString.appendCodeblock(`${field[1]}`);
+		}
+	});
+	return hoverString;
 }
 
 function plural(count: number, singular: string, plural: string) {

test/providers.test.ts

@@ -5,12 +5,13 @@ import * as vscode from 'vscode';
 import * as providers from '../src/providers';
 import { Flag, FlagConfiguration } from '../src/models';
 
-const flag: Flag = {
+const flag = new Flag ({
 	name: "Test",
 	key: "test",
 	tags: [],
 	environments: null,
-}
+	_version: 1,
+});
 
 const flagConfig: FlagConfiguration = {
 	key: 'test',
@@ -31,8 +32,8 @@ let testPath = path.join(__dirname, '..', '..', 'test');
 suite('provider utils tests', () => {
 	test('generateHoverString', () => {
 		assert.equal(
-			`**LaunchDarkly feature flag**\n\n\tName: Test\n\tKey: test\n\tEnabled: true\n\tDefault variation: "SomeVariation"\n\tOff variation: {"thisIsJson":"AnotherVariation"}\n\t1 prerequisite\n\t3 user targets\n\t0 rules`,
-			providers.generateHoverString(flag, flagConfig),
+			"**LaunchDarkly feature flag**\n\nName: \n```\nTest\n```\n\n\nKey: \n```\ntest\n```\n\n\nEnabled: \n```\ntrue\n```\n\n\nDefault variation: \n```\n\"SomeVariation\"\n```\n\n\nOff variation: \n```\n{\n  \"thisIsJson\": \"AnotherVariation\"\n}\n```\n\n\n1 prerequisite\n\n3 user targets\n\n0 rules",
+			providers.generateHoverString(flag, flagConfig).value,
 		);
 	});