update to use environment variable

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

Author: bfitzpat

src/extension.ts

@@ -23,7 +23,7 @@ import { clearRegisteredTutorials, getOpenAtStartupSetting,
 	addNewTutorialWithNameAndCategoryForDidactUri, 
 	removeTutorialByNameAndCategory, 
 	registerEmbeddedTutorials,
-	appendAdditionalTutorials} from './utils';
+	appendAdditionalTutorialsFromEnv} from './utils';
 import { DidactUriCompletionItemProvider } from './didactUriCompletionItemProvider';
 import { DidactPanelSerializer } from './didactPanelSerializer';
 import { didactManager, VIEW_TYPE } from './didactManager';
@@ -118,7 +118,7 @@ export async function activate(context: vscode.ExtensionContext): Promise<any> {
 	}
 
 	// append any additional tutorials if we have them
-	await appendAdditionalTutorials();
+	await appendAdditionalTutorialsFromEnv();
 
 	// create the view
 	createIntegrationsView();

src/test/suite/registry.test.ts

@@ -1,5 +1,5 @@
 import * as assert from 'assert';
-import {getRegisteredTutorials, getDidactCategories, getTutorialsForCategory, getUriForDidactNameAndCategory, registerTutorialWithCategory, clearRegisteredTutorials, registerTutorialWithArgs, setAppendRegisteredSetting, getAppendRegisteredSetting, appendAdditionalTutorials} from '../../utils';
+import {getRegisteredTutorials, getDidactCategories, getTutorialsForCategory, getUriForDidactNameAndCategory, registerTutorialWithCategory, clearRegisteredTutorials, registerTutorialWithArgs, DIDACT_APPEND_REGISTERED_SETTING, getAppendRegisteredSettingFromEnv, appendAdditionalTutorialsFromEnv} from '../../utils';
 import {before} from 'mocha';
 import * as vscode from 'vscode';
 import { ADD_TUTORIAL_TO_REGISTRY, getContext, REGISTER_TUTORIAL } from '../../extensionFunctions';
@@ -115,22 +115,22 @@ suite('Didact registry test suite', () => {
 		assert.ok(foundTutorial, `Did not find new-tutorial-4 registered via JSON`);
 	});
 
+	test('append registry from environment variable', async() => {
+		const tutsToAppend : String = '[{"name":"AppendMe2","category":"AppendedCat2","sourceUri":"https%3A%2F%2Fraw.githubusercontent.com%2Fredhat-developer%2Fvscode-didact%2Fmaster%2Fexamples%2Fregistry.example.didact.md"}]';
+		getContext().environmentVariableCollection.append(DIDACT_APPEND_REGISTERED_SETTING, tutsToAppend.toString());
+
+		const envVarJson = getAppendRegisteredSettingFromEnv();
+		console.log(`envVar = ` + envVarJson);
+		assert.ok(envVarJson, `Did not find envVarJson`);
 
-	test('append to registry', async() => {
 		const registry = getRegisteredTutorials();
 		assert.notStrictEqual(registry, undefined);
 
-		const tutName = `AppendMe`;
-		const tutsToAppend : String = '[{"name":"AppendMe","category":"AppendedCat","sourceUri":"https%3A%2F%2Fraw.githubusercontent.com%2Fredhat-developer%2Fvscode-didact%2Fmaster%2Fexamples%2Fregistry.example.didact.md"}]';
-		await setAppendRegisteredSetting(tutsToAppend);
-
-		const appendToRegistry = getAppendRegisteredSetting();
-		assert.notStrictEqual(appendToRegistry, undefined);
-
-		await appendAdditionalTutorials();
+		const tutName = `AppendMe2`;
+		await appendAdditionalTutorialsFromEnv();
 		const foundTutorial = verifyTutorialInRegistry(tutName);
 		assert.ok(foundTutorial, `Did not find ${tutName} registered after appending to tutorial list from settings`);
-	});	
+	});
 
 	test('Clear all the tutorials', async() => {
 		const registry = getRegisteredTutorials();

src/utils.ts

@@ -502,18 +502,17 @@ export function getFileExtension(pathAsString: string) : string | undefined {
 	return undefined;
 }
 
-export function getAppendRegisteredSetting() : string | undefined {
-	return extensionFunctions.getContext().workspaceState.get(DIDACT_APPEND_REGISTERED_SETTING);
-}
-
-export async function setAppendRegisteredSetting(json: any): Promise<void> {
-	await extensionFunctions.getContext().workspaceState.update(DIDACT_APPEND_REGISTERED_SETTING, json);
+export async function getAppendRegisteredSettingFromEnv() : Promise<string | undefined> {
+	const envVar = extensionFunctions.getContext().environmentVariableCollection.get(DIDACT_APPEND_REGISTERED_SETTING);
+	if (!envVar) {
+		return;
+	}
+	return envVar.value;
 }
 
-export async function appendAdditionalTutorials() : Promise<void> {
+export async function appendAdditionalTutorialsFromEnv() : Promise<void> {
 	try {
-		await extensionFunctions.sendTextToOutputChannel(`Starting Didact tutorials append process`);
-		const appendTutorialsAtStartup: string | undefined = getAppendRegisteredSetting();
+		const appendTutorialsAtStartup: string | undefined = await getAppendRegisteredSettingFromEnv();
 		if (appendTutorialsAtStartup) {
 			await extensionFunctions.sendTextToOutputChannel(`Didact tutorials appended at startup via ${DIDACT_APPEND_REGISTERED_SETTING} with ${appendTutorialsAtStartup}`);
 			const jsonTutorials = JSON.parse(appendTutorialsAtStartup);