Skip to content

Fix namespace import/export helper usage under '--esModuleInterop' #39490

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 3 commits into from
Jul 13, 2020
Merged

Fix namespace import/export helper usage under '--esModuleInterop' #39490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5c5f180
Fix namespace import/export helper usage
rbuckton Jul 8, 2020
ae2f006
Fix default import/export helper usage
rbuckton Jul 9, 2020
5ad8532
Merge branch 'master' into fix37113
rbuckton Jul 13, 2020
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
35 changes: 34 additions & 1 deletion src/compiler/checker.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35258,6 +35258,12 @@ namespace ts {
checkCollisionWithRequireExportsInGeneratedCode(node, node.name!);
checkCollisionWithGlobalPromiseInGeneratedCode(node, node.name!);
checkAliasSymbol(node);
if (node.kind === SyntaxKind.ImportSpecifier &&
idText(node.propertyName || node.name) === "default" &&
compilerOptions.esModuleInterop &&
moduleKind !== ModuleKind.System && moduleKind < ModuleKind.ES2015) {
checkExternalEmitHelpers(node, ExternalEmitHelpers.ImportDefault);
}
}

function checkImportDeclaration(node: ImportDeclaration) {
Expand All @@ -35277,6 +35283,10 @@ namespace ts {
if (importClause.namedBindings) {
if (importClause.namedBindings.kind === SyntaxKind.NamespaceImport) {
checkImportBinding(importClause.namedBindings);
if (moduleKind !== ModuleKind.System && moduleKind < ModuleKind.ES2015 && compilerOptions.esModuleInterop) {
// import * as ns from "foo";
checkExternalEmitHelpers(node, ExternalEmitHelpers.ImportStar);
}
}
else {
const moduleExisted = resolveExternalModuleName(node, node.moduleSpecifier);
Expand All @@ -35287,6 +35297,7 @@ namespace ts {
}
}
}

}

function checkImportEqualsDeclaration(node: ImportEqualsDeclaration) {
Expand Down Expand Up @@ -35354,6 +35365,7 @@ namespace ts {
}
else {
// export * from "foo"
// export * as ns from "foo";
const moduleSymbol = resolveExternalModuleName(node, node.moduleSpecifier!);
if (moduleSymbol && hasExportAssignmentSymbol(moduleSymbol)) {
error(node.moduleSpecifier, Diagnostics.Module_0_uses_export_and_cannot_be_used_with_export_Asterisk, symbolToString(moduleSymbol));
Expand All @@ -35362,7 +35374,18 @@ namespace ts {
checkAliasSymbol(node.exportClause);
}
if (moduleKind !== ModuleKind.System && moduleKind < ModuleKind.ES2015) {
checkExternalEmitHelpers(node, ExternalEmitHelpers.ExportStar);
if (node.exportClause) {
// export * as ns from "foo";
// For ES2015 modules, we emit it as a pair of `import * as a_1 ...; export { a_1 as ns }` and don't need the helper.
// We only use the helper here when in esModuleInterop
if (compilerOptions.esModuleInterop) {
checkExternalEmitHelpers(node, ExternalEmitHelpers.ImportStar);
}
}
else {
// export * from "foo"
checkExternalEmitHelpers(node, ExternalEmitHelpers.ExportStar);
}
}
}
}
Expand Down Expand Up @@ -35434,6 +35457,14 @@ namespace ts {
}
}
}
else {
if (compilerOptions.esModuleInterop &&
moduleKind !== ModuleKind.System &&
moduleKind < ModuleKind.ES2015 &&
idText(node.propertyName || node.name) === "default") {
checkExternalEmitHelpers(node, ExternalEmitHelpers.ImportDefault);
}
}
}

function checkExportAssignment(node: ExportAssignment) {
Expand Down Expand Up @@ -37624,6 +37655,8 @@ namespace ts {
case ExternalEmitHelpers.AsyncDelegator: return "__asyncDelegator";
case ExternalEmitHelpers.AsyncValues: return "__asyncValues";
case ExternalEmitHelpers.ExportStar: return "__exportStar";
case ExternalEmitHelpers.ImportStar: return "__importStar";
case ExternalEmitHelpers.ImportDefault: return "__importDefault";
case ExternalEmitHelpers.MakeTemplateObject: return "__makeTemplateObject";
case ExternalEmitHelpers.ClassPrivateFieldGet: return "__classPrivateFieldGet";
case ExternalEmitHelpers.ClassPrivateFieldSet: return "__classPrivateFieldSet";
Expand Down
26 changes: 26 additions & 0 deletions src/compiler/factory/emitHelpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@ namespace ts {
createImportStarHelper(expression: Expression): Expression;
createImportStarCallbackHelper(): Expression;
createImportDefaultHelper(expression: Expression): Expression;
createExportStarHelper(moduleExpression: Expression, exportsExpression?: Expression): Expression;
// Class Fields Helpers
createClassPrivateFieldGetHelper(receiver: Expression, privateField: Identifier): Expression;
createClassPrivateFieldSetHelper(receiver: Expression, privateField: Identifier, value: Expression): Expression;
Expand Down Expand Up @@ -69,6 +70,7 @@ namespace ts {
createImportStarHelper,
createImportStarCallbackHelper,
createImportDefaultHelper,
createExportStarHelper,
// Class Fields Helpers
createClassPrivateFieldGetHelper,
createClassPrivateFieldSetHelper,
Expand Down Expand Up @@ -366,6 +368,16 @@ namespace ts {
);
}

function createExportStarHelper(moduleExpression: Expression, exportsExpression: Expression = factory.createIdentifier("exports")) {
context.requestEmitHelper(exportStarHelper);
context.requestEmitHelper(createBindingHelper);
return factory.createCallExpression(
getUnscopedHelperName("__exportStar"),
/*typeArguments*/ undefined,
[moduleExpression, exportsExpression]
);
}

// Class Fields Helpers

function createClassPrivateFieldGetHelper(receiver: Expression, privateField: Identifier) {
Expand Down Expand Up @@ -815,6 +827,19 @@ namespace ts {
};`
};

// emit output for the __export helper function
export const exportStarHelper: UnscopedEmitHelper = {
name: "typescript:export-star",
importName: "__exportStar",
scoped: false,
dependencies: [createBindingHelper],
priority: 2,
text: `
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};`
};

// Class fields helpers
export const classPrivateFieldGetHelper: UnscopedEmitHelper = {
name: "typescript:classPrivateFieldGet",
Expand Down Expand Up @@ -864,6 +889,7 @@ namespace ts {
generatorHelper,
importStarHelper,
importDefaultHelper,
exportStarHelper,
classPrivateFieldGetHelper,
classPrivateFieldSetHelper,
createBindingHelper,
Expand Down
44 changes: 12 additions & 32 deletions src/compiler/transformers/module/module.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -700,7 +700,6 @@ namespace ts {

const promise = factory.createNewExpression(factory.createIdentifier("Promise"), /*typeArguments*/ undefined, [func]);
if (compilerOptions.esModuleInterop) {
context.requestEmitHelper(importStarHelper);
return factory.createCallExpression(factory.createPropertyAccessExpression(promise, factory.createIdentifier("then")), /*typeArguments*/ undefined, [emitHelpers().createImportStarCallbackHelper()]);
}
return promise;
Expand All @@ -715,7 +714,6 @@ namespace ts {
const promiseResolveCall = factory.createCallExpression(factory.createPropertyAccessExpression(factory.createIdentifier("Promise"), "resolve"), /*typeArguments*/ undefined, /*argumentsArray*/ []);
let requireCall: Expression = factory.createCallExpression(factory.createIdentifier("require"), /*typeArguments*/ undefined, arg ? [arg] : []);
if (compilerOptions.esModuleInterop) {
context.requestEmitHelper(importStarHelper);
requireCall = emitHelpers().createImportStarHelper(requireCall);
}

Expand Down Expand Up @@ -755,8 +753,7 @@ namespace ts {
return innerExpr;
}
if (getExportNeedsImportStarHelper(node)) {
context.requestEmitHelper(importStarHelper);
return factory.createCallExpression(context.getEmitHelperFactory().getUnscopedHelperName("__importStar"), /*typeArguments*/ undefined, [innerExpr]);
return emitHelpers().createImportStarHelper(innerExpr);
}
return innerExpr;
}
Expand All @@ -766,11 +763,9 @@ namespace ts {
return innerExpr;
}
if (getImportNeedsImportStarHelper(node)) {
context.requestEmitHelper(importStarHelper);
return emitHelpers().createImportStarHelper(innerExpr);
}
if (getImportNeedsImportDefaultHelper(node)) {
context.requestEmitHelper(importDefaultHelper);
return emitHelpers().createImportDefaultHelper(innerExpr);
}
return innerExpr;
Expand Down Expand Up @@ -1015,18 +1010,21 @@ namespace ts {
setOriginalNode(
setTextRange(
factory.createExpressionStatement(
context.getEmitHelperFactory().createCreateBindingHelper(generatedName, factory.createStringLiteralFromNode(specifier.propertyName || specifier.name), specifier.propertyName ? factory.createStringLiteralFromNode(specifier.name) : undefined)
emitHelpers().createCreateBindingHelper(generatedName, factory.createStringLiteralFromNode(specifier.propertyName || specifier.name), specifier.propertyName ? factory.createStringLiteralFromNode(specifier.name) : undefined)
),
specifier),
specifier
)
);
}
else {
const exportNeedsImportDefault =
!!compilerOptions.esModuleInterop &&
!(getEmitFlags(node) & EmitFlags.NeverApplyImportHelper) &&
idText(specifier.propertyName || specifier.name) === "default";
const exportedValue = factory.createPropertyAccessExpression(
generatedName,
specifier.propertyName || specifier.name
);
exportNeedsImportDefault ? emitHelpers().createImportDefaultHelper(generatedName) : generatedName,
specifier.propertyName || specifier.name);
statements.push(
setOriginalNode(
setTextRange(
Expand All @@ -1051,9 +1049,9 @@ namespace ts {
factory.createExpressionStatement(
createExportExpression(
factory.cloneNode(node.exportClause.name),
moduleKind !== ModuleKind.AMD ?
getHelperExpressionForExport(node, createRequireCall(node)) :
factory.createIdentifier(idText(node.exportClause.name))
getHelperExpressionForExport(node, moduleKind !== ModuleKind.AMD ?
createRequireCall(node) :
factory.createIdentifier(idText(node.exportClause.name)))
)
),
node
Expand All @@ -1069,7 +1067,7 @@ namespace ts {
return setOriginalNode(
setTextRange(
factory.createExpressionStatement(
createExportStarHelper(context, moduleKind !== ModuleKind.AMD ? createRequireCall(node) : generatedName)
emitHelpers().createExportStarHelper(moduleKind !== ModuleKind.AMD ? createRequireCall(node) : generatedName)
),
node),
node
Expand Down Expand Up @@ -1857,24 +1855,6 @@ namespace ts {
}
}

// emit output for the __export helper function
const exportStarHelper: UnscopedEmitHelper = {
name: "typescript:export-star",
importName: "__exportStar",
scoped: false,
dependencies: [createBindingHelper],
priority: 2,
text: `
var __exportStar = (this && this.__exportStar) || function(m, exports) {
for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
};`
};

function createExportStarHelper(context: TransformationContext, module: Expression) {
context.requestEmitHelper(exportStarHelper);
return context.factory.createCallExpression(context.getEmitHelperFactory().getUnscopedHelperName("__exportStar"), /*typeArguments*/ undefined, [module, context.factory.createIdentifier("exports")]);
}

// emit helper for dynamic import
const dynamicImportUMDHelper: EmitHelper = {
name: "typescript:dynamicimport-sync-require",
Expand Down
2 changes: 2 additions & 0 deletions src/compiler/transformers/utilities.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,8 @@ namespace ts {
uniqueExports.set(idText(name), true);
exportedNames = append(exportedNames, name);
}
// we use the same helpers for `export * as ns` as we do for `import * as ns`
hasImportStar = true;
}
}
}
Expand Down
10 changes: 6 additions & 4 deletions src/compiler/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6436,10 +6436,12 @@ namespace ts {
AsyncDelegator = 1 << 14, // __asyncDelegator (used by ES2017 async generator yield* transformation)
AsyncValues = 1 << 15, // __asyncValues (used by ES2017 for..await..of transformation)
ExportStar = 1 << 16, // __exportStar (used by CommonJS/AMD/UMD module transformation)
MakeTemplateObject = 1 << 17, // __makeTemplateObject (used for constructing template string array objects)
ClassPrivateFieldGet = 1 << 18, // __classPrivateFieldGet (used by the class private field transformation)
ClassPrivateFieldSet = 1 << 19, // __classPrivateFieldSet (used by the class private field transformation)
CreateBinding = 1 << 20, // __createBinding (use by the module transform for (re)exports and namespace imports)
ImportStar = 1 << 17, // __importStar (used by CommonJS/AMD/UMD module transformation)
ImportDefault = 1 << 18, // __importStar (used by CommonJS/AMD/UMD module transformation)
MakeTemplateObject = 1 << 19, // __makeTemplateObject (used for constructing template string array objects)
ClassPrivateFieldGet = 1 << 20, // __classPrivateFieldGet (used by the class private field transformation)
ClassPrivateFieldSet = 1 << 21, // __classPrivateFieldSet (used by the class private field transformation)
CreateBinding = 1 << 22, // __createBinding (use by the module transform for (re)exports and namespace imports)
FirstEmitHelper = Extends,
LastEmitHelper = CreateBinding,

Expand Down
3 changes: 1 addition & 2 deletions src/testRunner/compilerRunner.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -159,13 +159,12 @@ namespace Harness {
let configuredName = "";
const keys = Object
.keys(configurationOverrides)
.map(k => k.toLowerCase())
.sort();
for (const key of keys) {
if (configuredName) {
configuredName += ",";
}
configuredName += `${key}=${configurationOverrides[key].toLowerCase()}`;
configuredName += `${key.toLowerCase()}=${configurationOverrides[key].toLowerCase()}`;
}
if (configuredName) {
const extname = vpath.extname(this.justName);
Expand Down
23 changes: 23 additions & 0 deletions tests/baselines/reference/esModuleInteropTslibHelpers.errors.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
tests/cases/compiler/file2.ts(1,1): error TS2354: This syntax requires an imported helper but module 'tslib' cannot be found.


==== tests/cases/compiler/refs.d.ts (0 errors) ====
declare module "path";
==== tests/cases/compiler/file.ts (0 errors) ====
import path from "path";
path.resolve("", "../");
export class Foo { }
==== tests/cases/compiler/file2.ts (1 errors) ====
import * as path from "path";
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
!!! error TS2354: This syntax requires an imported helper but module 'tslib' cannot be found.
path.resolve("", "../");
export class Foo2 { }
==== tests/cases/compiler/file3.ts (0 errors) ====
import {default as resolve} from "path";
resolve("", "../");
export class Foo3 { }
==== tests/cases/compiler/file4.ts (0 errors) ====
import {Bar, default as resolve} from "path";
resolve("", "../");
export { Bar }
21 changes: 20 additions & 1 deletion tests/baselines/reference/exportAsNamespace2(module=amd).js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,11 +24,30 @@ define(["require", "exports"], function (require, exports) {
exports.b = 2;
});
//// [1.js]
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
define(["require", "exports", "./0"], function (require, exports, ns) {
"use strict";
exports.__esModule = true;
exports.ns = void 0;
exports.ns = ns;
exports.ns = __importStar(ns);
ns.a;
ns.b;
});
Expand Down
21 changes: 20 additions & 1 deletion tests/baselines/reference/exportAsNamespace3(module=amd).js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,30 @@ define(["require", "exports"], function (require, exports) {
exports.b = 2;
});
//// [1.js]
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
define(["require", "exports", "./0"], function (require, exports, ns) {
"use strict";
exports.__esModule = true;
exports.ns = void 0;
exports.ns = ns;
exports.ns = __importStar(ns);
ns.a;
ns.b;
var ns = { a: 1, b: 2 };
Expand Down
Loading