Skip to content

Return information about the error if loadExtension fails #2899

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 19, 2017
Merged

Return information about the error if loadExtension fails #2899

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d7227a8
Add actual error when loading extension
nadyaA Jun 16, 2017
7f97506
PR comments
nadyaA Jun 16, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion lib/services/extensibility-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ export class ExtensibilityService implements IExtensibilityService {
return { extensionName };
} catch (error) {
this.$logger.warn(`Error while loading ${extensionName} is: ${error.message}`);
const err = <IExtensionLoadingError>new Error(`Unable to load extension ${extensionName}. You will not be able to use the functionality that it adds.`);
const err = <IExtensionLoadingError>new Error(`Unable to load extension ${extensionName}. You will not be able to use the functionality that it adds. Error: ${error.message}`);
err.extensionName = extensionName;
throw err;
}
Expand Down
20 changes: 13 additions & 7 deletions test/services/extensibility-service.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,7 @@ describe("extensibilityService", () => {
};

const expectedResults: any[] = _.map(extensionNames, extensionName => ({ extensionName }));
expectedResults[0] = new Error("Unable to load extension extension1. You will not be able to use the functionality that it adds.");
expectedResults[0] = new Error("Unable to load extension extension1. You will not be able to use the functionality that it adds. Error: Unable to load module.");
const extensibilityService: IExtensibilityService = testInjector.resolve(ExtensibilityService);
const promises = extensibilityService.loadExtensions();
assert.deepEqual(promises.length, extensionNames.length);
Expand All @@ -258,6 +258,7 @@ describe("extensibilityService", () => {
const testInjector = getTestInjector();
const extensionNames = ["extension1", "extension2", "extension3"];
const fs: IFileSystem = testInjector.resolve("fs");
const expectedErrorMessage = `Unable to read ${constants.NODE_MODULES_FOLDER_NAME} dir.`;
fs.exists = (pathToCheck: string): boolean => path.basename(pathToCheck) === "extensions" || path.basename(pathToCheck) === constants.PACKAGE_JSON_FILE_NAME;
fs.readJson = (filename: string, encoding?: string): any => {
const dependencies: any = {};
Expand All @@ -272,7 +273,7 @@ describe("extensibilityService", () => {
fs.readDirectory = (dir: string): string[] => {
isReadDirCalled = true;
assert.deepEqual(path.basename(dir), constants.NODE_MODULES_FOLDER_NAME);
throw new Error(`Unable to read ${constants.NODE_MODULES_FOLDER_NAME} dir.`);
throw new Error(expectedErrorMessage);
};

const extensibilityService: IExtensibilityService = testInjector.resolve(ExtensibilityService);
Expand All @@ -283,7 +284,7 @@ describe("extensibilityService", () => {
await loadExtensionPromise.then(res => { throw new Error("Shouldn't get here!"); },
err => {
const extensionName = extensionNames[index];
assert.deepEqual(err.message, `Unable to load extension ${extensionName}. You will not be able to use the functionality that it adds.`);
assert.deepEqual(err.message, `Unable to load extension ${extensionName}. You will not be able to use the functionality that it adds. Error: ${expectedErrorMessage}`);
assert.deepEqual(err.extensionName, extensionName);
});
};
Expand All @@ -295,6 +296,9 @@ describe("extensibilityService", () => {
it("rejects all promises when unable to install extensions to extension dir (simulate EPERM error)", async () => {
const testInjector = getTestInjector();
const extensionNames = ["extension1", "extension2", "extension3"];
const expectedErrorMessages = ["Unable to install to node_modules dir.",
"expected 'extension2' to deeply equal 'extension1'",
"expected 'extension3' to deeply equal 'extension1'"];
const fs: IFileSystem = testInjector.resolve("fs");
fs.exists = (pathToCheck: string): boolean => path.basename(pathToCheck) === "extensions" || path.basename(pathToCheck) === constants.PACKAGE_JSON_FILE_NAME;
fs.readJson = (filename: string, encoding?: string): any => {
Expand All @@ -315,10 +319,11 @@ describe("extensibilityService", () => {

let isNpmInstallCalled = false;
const npm: INodePackageManager = testInjector.resolve("npm");
const expectedErrorMessage = `Unable to install to ${constants.NODE_MODULES_FOLDER_NAME} dir.`;
npm.install = async (packageName: string, pathToSave: string, config?: any): Promise<any> => {
assert.deepEqual(packageName, extensionNames[0]);
isNpmInstallCalled = true;
throw new Error(`Unable to install to ${constants.NODE_MODULES_FOLDER_NAME} dir.`);
throw new Error(expectedErrorMessage);
};

const extensibilityService: IExtensibilityService = testInjector.resolve(ExtensibilityService);
Expand All @@ -327,11 +332,12 @@ describe("extensibilityService", () => {
for (let index = 0; index < promises.length; index++) {
const loadExtensionPromise = promises[index];
await loadExtensionPromise.then(res => {
console.log("######### res = ", res); throw new Error("Shouldn't get here!");
throw new Error("Shouldn't get here!");
},

err => {
const extensionName = extensionNames[index];
assert.deepEqual(err.message, `Unable to load extension ${extensionName}. You will not be able to use the functionality that it adds.`);
assert.deepEqual(err.message, `Unable to load extension ${extensionName}. You will not be able to use the functionality that it adds. Error: ${expectedErrorMessages[index]}`);
assert.deepEqual(err.extensionName, extensionName);
});
};
Expand Down Expand Up @@ -604,7 +610,7 @@ describe("extensibilityService", () => {
await extensibilityService.loadExtension(extensionName);
} catch (err) {
isErrorRaised = true;
assert.deepEqual(err.message, `Unable to load extension ${extensionName}. You will not be able to use the functionality that it adds.`);
assert.deepEqual(err.message, `Unable to load extension ${extensionName}. You will not be able to use the functionality that it adds. Error: ${expectedErrorMessage}`);
assert.deepEqual(err.extensionName, extensionName);
}

Expand Down