issue 415 adding retry and refresh (#416)

* issue 415 adding retry and refresh

* fixing command list test and updating changelog

Signed-off-by: Brian Fitzpatrick <[email protected]>

Author: bfitzpat

CHANGELOG.md

@@ -4,7 +4,8 @@ All notable changes to the "vscode-didact" extension will be documented in this
 
 ## 0.3.2
 
-- TBD
+- adding *vscode.didact.refresh* command to refresh the currently active Didact window
+- adding retry in case the uri for a tutorial isn't quite available yet
 
 ## 0.3.1
 

package.json

@@ -109,6 +109,10 @@
 				"command": "vscode.didact.verifyCommands",
 				"title": "Validate Didact File",
 				"when": "resourceFilename =~ /[.](didact)[.](md|adoc)$/"
+			},
+			{
+				"command": "vscode.didact.refresh",
+				"title": "Didact: Refresh Current Didact Window"
 			}
 		],
 		"keybindings": [

src/didactPanel.ts

@@ -159,6 +159,10 @@ export class DidactPanel {
 		this._panel.webview.postMessage(jsonMsg);
 	}	
 
+	public async refreshPanel() : Promise<void> {
+		this.configure(true);
+	}
+
 	async configure(flag = false): Promise<void> {
 		this._update(flag);
 		await this.sendSetStateMessage();

src/extension.ts

@@ -62,6 +62,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<void>
 	context.subscriptions.push(vscode.commands.registerCommand(extensionFunctions.PASTE_TO_ACTIVE_EDITOR_COMMAND, extensionFunctions.pasteClipboardToActiveEditorOrPreviouslyUsedOne));
 	context.subscriptions.push(vscode.commands.registerCommand(extensionFunctions.PASTE_TO_EDITOR_FOR_FILE_COMMAND, extensionFunctions.pasteClipboardToEditorForFile));
 	context.subscriptions.push(vscode.commands.registerCommand(extensionFunctions.PASTE_TO_NEW_FILE_COMMAND, extensionFunctions.pasteClipboardToNewTextFile));
+	context.subscriptions.push(vscode.commands.registerCommand(extensionFunctions.REFRESH_DIDACT, extensionFunctions.refreshDidactWindow));
 
 	// set up the vscode URI handler
 	vscode.window.registerUriHandler({

src/extensionFunctions.ts

@@ -68,6 +68,7 @@ export const FILE_TO_CLIPBOARD_COMMAND = 'vscode.didact.copyFileTextToClipboardC
 export const PASTE_TO_ACTIVE_EDITOR_COMMAND = 'vscode.didact.copyClipboardToActiveTextEditor';
 export const PASTE_TO_EDITOR_FOR_FILE_COMMAND = 'vscode.didact.copyClipboardToEditorForFile';
 export const PASTE_TO_NEW_FILE_COMMAND = 'vscode.didact.copyClipboardToNewFile';
+export const REFRESH_DIDACT = 'vscode.didact.refresh';
 
 export const EXTENSION_ID = "redhat.vscode-didact";
 
@@ -433,6 +434,11 @@ export async function reloadDidact(): Promise<void>{
 	await vscode.commands.executeCommand(START_DIDACT_COMMAND, _didactFileUri);
 }
 
+export async function refreshDidactWindow(): Promise<void>{
+	sendTextToOutputChannel(`Refreshing Didact window`);
+	await didactManager.active()?.refreshPanel();
+}
+
 // send a message back to the webview - used for requirements testing mostly
 function postRequirementsResponseMessage(requirement: string, booleanResponse: boolean): void {
 	if (requirement) {
@@ -457,19 +463,33 @@ export async function getWebviewContent() : Promise<string|void> {
 	}
 	if (_didactFileUri) {
 		if (_didactFileUri.scheme === 'file') {
-			return await getDataFromFile(_didactFileUri).catch( (error) => {
-				showFileUnavailable(error);
-			});
+			return await loadFileWithRetry(_didactFileUri);
 		} else if (_didactFileUri.scheme === 'http' || _didactFileUri.scheme === 'https'){
-			const urlToFetch = _didactFileUri.toString();
-			return await getDataFromUrl(urlToFetch).catch( (error) => {
-				showFileUnavailable(error);
-			});
+			return await loadFileFromHTTPWithRetry(_didactFileUri);
 		}
 	}
 	return undefined;
 }
 
+async function loadFileWithRetry ( uri:vscode.Uri ) : Promise<string | void | undefined> {
+	return await getDataFromFile(uri).catch( async (error) => {
+		await utils.delay(3000);
+		return await getDataFromFile(uri).catch( async (error) => {
+			showFileUnavailable(error);
+		});
+	});
+}
+
+async function loadFileFromHTTPWithRetry ( uri:vscode.Uri ) : Promise<string | void | undefined> {
+	const urlToFetch = uri.toString();
+	return await getDataFromUrl(urlToFetch).catch( async (error) => {
+		await utils.delay(3000);
+		return await getDataFromUrl(urlToFetch).catch( async (error) => {
+			showFileUnavailable(error);
+		});
+	});
+}
+
 export function isAsciiDoc() : boolean {
 	let uriToTest : vscode.Uri | undefined;
 	if (!_didactFileUri) {

src/test/suite/didactUriCompletionItemProvider.test.ts

@@ -110,7 +110,7 @@ suite("Didact URI completion provider tests", function () {
 	test("that the command processing for a command prefix returns expected results", async () => {
 		const match = provider.findMatchForCommandVariable('didact://?commandId=vscode.didact.');
 		const completionList = await provider.processCommands(match);
-		expect(completionList.items).to.have.lengthOf(26)
+		expect(completionList.items).to.have.lengthOf(27)
 	});
 
 	test("that the command processing for one command returns one expected result", async () => {