Thanks to visit codestin.com
Credit goes to github.com

Skip to content

ES private class elements #42458

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
rbuckton merged 87 commits into from
Mar 25, 2021
Merged

ES private class elements #42458

Changes from 1 commit
Commits
Show all changes
87 commits
Select commit Hold shift + click to select a range
e3a3fb8
Added support for private identifier methods.
dragomirtitian Jan 15, 2021
4ab27a2
Added tests for private methods.
dragomirtitian Jan 15, 2021
6977b9f
Added check to only not allow private name method signatures in anyth…
dragomirtitian Jan 18, 2021
bc8c07e
Added private accessors tests
dragomirtitian Jan 19, 2021
2760ed8
Transform private methods
mkubilayk Jan 25, 2021
04af85d
Rename shouldTransformPrivateFields
mkubilayk Jan 25, 2021
f048d72
Accept baseline
mkubilayk Jan 25, 2021
f8cfb81
Use a single WeakSet for brand-check
mkubilayk Jan 26, 2021
4aa4c3b
Accept baseline
mkubilayk Jan 26, 2021
0ac1271
Add a test for using private methods in static field initializers
mkubilayk Jan 26, 2021
7da5bd9
Add breaking checker test
mkubilayk Jan 26, 2021
e133f60
Add to instances once per-instance
mkubilayk Jan 26, 2021
aa5dd8a
Accept baseline
mkubilayk Jan 26, 2021
a3889a7
fix: evaluate receiver and rhs expressions before throwing on readonl…
mkubilayk Jan 26, 2021
8952caa
Add a test for evaluating rhs before readonly assignment
mkubilayk Jan 26, 2021
dee87bb
Transpile private accessors
mkubilayk Jan 27, 2021
aec7e9b
Accept baseline
mkubilayk Jan 27, 2021
f3bbf0f
fix: handle readonly/writeonly accessors
mkubilayk Jan 28, 2021
a1b59cd
accept baseline
mkubilayk Jan 28, 2021
6b74498
add a test for private setter without a getter
mkubilayk Jan 28, 2021
d51f6cd
fix: getAllUnscopedEmitHelpers
mkubilayk Jan 28, 2021
c175770
fix: better handling of duplicate names
mkubilayk Jan 29, 2021
4301af5
Fixed wrong error message for private methods in class expressions.
dragomirtitian Feb 1, 2021
3a056b2
change error message
mkubilayk Feb 1, 2021
95df2d1
add a test for async private methods with a higher target
mkubilayk Feb 1, 2021
590124e
fix: setter assignment returns rhs value
mkubilayk Feb 3, 2021
219ea83
add a test for setter assignment return value
mkubilayk Feb 3, 2021
25da8ca
fix: handle duplicate accessors
mkubilayk Feb 3, 2021
a2228be
add tests for duplicate accessors
mkubilayk Feb 3, 2021
ff4f737
docs: add missing parameter docs
mkubilayk Feb 3, 2021
704727c
Fixed failing test.
dragomirtitian Feb 3, 2021
73925dc
baseline-accept: ordering changes
mkubilayk Feb 17, 2021
67fd38d
fix: attach weakSetName to property declaration
mkubilayk Feb 17, 2021
45c2a41
add a test for nested private methods
mkubilayk Feb 17, 2021
356b91d
add a test with any
mkubilayk Feb 17, 2021
b391464
Merge pull request #51 from bloomberg/fix/nested-private-methods
dragomirtitian Feb 18, 2021
5ebb3d6
Added support for static private fields accessors and methods.
dragomirtitian Feb 16, 2021
7006c09
Added error message for private identifiers used with static decorato…
dragomirtitian Feb 16, 2021
b876613
Fixed emit static bug that used private names outside of classes for …
dragomirtitian Feb 18, 2021
31a8c00
Added tests for private static fields methods and accessors.
dragomirtitian Feb 18, 2021
9219e99
Merge remote-tracking branch 'remotes/origin/master' into es-private-…
dragomirtitian Feb 19, 2021
5a27a32
Merge remote-tracking branch 'remotes/bloomberg/es-private-methods-an…
dragomirtitian Feb 19, 2021
964fc27
Fixed error messages and tests after merge.
dragomirtitian Feb 19, 2021
d2ab6fc
Merge branch 'es-private-methods-and-accessors' into es-private-stati…
dragomirtitian Feb 19, 2021
23f6c67
Accept new baseline.
dragomirtitian Feb 19, 2021
374e6f3
Improved duplicate identifier checks for static private class elements.
dragomirtitian Feb 19, 2021
62b4f2f
Added error when using initializers with private static fields when u…
dragomirtitian Feb 23, 2021
b2a692d
Fixed code review issues.
dragomirtitian Feb 24, 2021
363041e
Removed semantically wrong emit on `useDefineForClassFields:true` wit…
dragomirtitian Feb 24, 2021
64757e0
Changed emit for uninitialized private static fields.
dragomirtitian Feb 25, 2021
68a7f80
Added runtime error in helper if a static private field is accessed b…
dragomirtitian Feb 25, 2021
7e7b0b1
Fixed code review comments for private identifier static class elements.
dragomirtitian Feb 25, 2021
30c7f69
add debug.assertNever for unknown node type (#53)
mkubilayk Mar 1, 2021
c924058
Merge remote-tracking branch 'upstream/master' into es-private-method…
mkubilayk Mar 1, 2021
e65116f
Merge remote-tracking branch 'upstream/master' into es-private-method…
mkubilayk Mar 2, 2021
4748c87
Fixed code review issues.
dragomirtitian Mar 3, 2021
09a5aae
Merge branch 'es-private-methods-and-accessors' into es-private-stati…
dragomirtitian Mar 3, 2021
497e47f
Fixed code review issues for private class elements.
dragomirtitian Mar 3, 2021
294cc48
Fixes class shadowing when checking access to a private static class …
dragomirtitian Mar 8, 2021
027bdb3
Merge remote-tracking branch 'remotes/origin/master' into es-private-…
dragomirtitian Mar 8, 2021
7bbc944
Merge remote-tracking branch 'upstream/master'
mkubilayk Mar 17, 2021
dd526e7
fix private methods/accessors in class expr inside a loop
mkubilayk Mar 17, 2021
f6ecfab
collapse switch case
mkubilayk Mar 17, 2021
6c3f661
fix class name
mkubilayk Mar 17, 2021
ef69c6c
simplify getPrivateMethodsAndAccessors
mkubilayk Mar 17, 2021
2a646ed
remove findPreviousAccessorInfo
mkubilayk Mar 17, 2021
d8136f7
lazily create weakSetName identifier
mkubilayk Mar 17, 2021
fbd749c
Merge remote-tracking branch 'remotes/bloomberg/es-private-static-fie…
dragomirtitian Mar 17, 2021
f96eafe
Merge remote-tracking branch 'remotes/bloomberg/es-private-static-fie…
dragomirtitian Mar 17, 2021
2de8a43
Merge branch 'es-private-methods-and-accessors' of https://github.com…
dragomirtitian Mar 18, 2021
7490a36
do not allocate a node if not needed in visitMehodDeclaration (#55)
mkubilayk Mar 18, 2021
c273258
Removed all the emit helpers for private identifier methods accessors…
dragomirtitian Mar 17, 2021
1addbb3
Simplified emit for private identifier class elements.
dragomirtitian Mar 18, 2021
c461b92
do not clone the receiver (#57)
mkubilayk Mar 18, 2021
a61fd5f
leave bad code in for #constructor and duplicate private names (#58)
mkubilayk Mar 19, 2021
89f746a
Added check for WeakSet collision.
dragomirtitian Mar 19, 2021
ff24636
Added error for using a set only accessor.
dragomirtitian Mar 22, 2021
a60e429
Merge pull request #61 from bloomberg/es-private-methods-and-accessor…
dragomirtitian Mar 22, 2021
f5816ab
update keyof tests and ?? (#62)
mkubilayk Mar 23, 2021
3b62d3c
fix emit helpers comments
mkubilayk Mar 23, 2021
7d8a2b9
produce an error if private field helpers are not up to date
mkubilayk Mar 23, 2021
d0d2055
add tests
mkubilayk Mar 23, 2021
93a7ca3
fix setter-only compound assignment
mkubilayk Mar 23, 2021
6da2cdd
Merge pull request #63 from bloomberg/helper-parameter-count
mkubilayk Mar 23, 2021
30805b7
fix tests
mkubilayk Mar 23, 2021
8d77a8e
fix duplicated trailing comments (#64)
mkubilayk Mar 24, 2021
8078ae0
clear receiver pos and setTextRange on helper calls
mkubilayk Mar 24, 2021
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
Prev Previous commit
Next Next commit
fix: attach weakSetName to property declaration 
Signed-off-by: Kubilay Kahveci <[email protected]>
  • Loading branch information
@mkubilayk
mkubilayk committed Feb 17, 2021
commit 67fd38df0474d13cb127526e934cd20cfebebe66
54 changes: 30 additions & 24 deletions src/compiler/transformers/classFields.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,21 +30,25 @@ namespace ts {

interface PrivateIdentifierInstanceMethod {
placement: PrivateIdentifierPlacement.InstanceMethod;
weakSetName: Identifier;
functionName: Identifier;
}

interface PrivateIdentifierInstanceGetterOnly {
placement: PrivateIdentifierPlacement.InstanceGetterOnly;
weakSetName: Identifier;
getterName: Identifier;
}

interface PrivateIdentifierInstanceSetterOnly {
placement: PrivateIdentifierPlacement.InstanceSetterOnly;
weakSetName: Identifier;
setterName: Identifier;
}

interface PrivateIdentifierInstanceGetterAndSetter {
placement: PrivateIdentifierPlacement.InstanceGetterAndSetter;
weakSetName: Identifier;
getterName: Identifier;
setterName: Identifier;
}
Expand All @@ -54,7 +58,6 @@ namespace ts {
* Used for prefixing generated variable names.
*/
className: string;
hasPrivateMethods: boolean;
/**
* Used for brand check on private methods.
*/
Expand Down Expand Up @@ -325,14 +328,14 @@ namespace ts {
case PrivateIdentifierPlacement.InstanceMethod:
return context.getEmitHelperFactory().createClassPrivateMethodGetHelper(
receiver,
getPrivateIdentifierEnvironment().weakSetName,
info.weakSetName,
info.functionName
);
case PrivateIdentifierPlacement.InstanceGetterOnly:
case PrivateIdentifierPlacement.InstanceGetterAndSetter:
return context.getEmitHelperFactory().createClassPrivateAccessorGetHelper(
receiver,
getPrivateIdentifierEnvironment().weakSetName,
info.weakSetName,
info.getterName
);
case PrivateIdentifierPlacement.InstanceSetterOnly:
Expand Down Expand Up @@ -550,7 +553,7 @@ namespace ts {
case PrivateIdentifierPlacement.InstanceGetterAndSetter:
return context.getEmitHelperFactory().createClassPrivateAccessorSetHelper(
receiver,
getPrivateIdentifierEnvironment().weakSetName,
info.weakSetName,
info.setterName,
right
);
Expand All @@ -571,6 +574,10 @@ namespace ts {
if (name && isIdentifier(name)) {
getPrivateIdentifierEnvironment().className = name.escapedText as string;
Copy link
Contributor

@rbuckton rbuckton Mar 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
getPrivateIdentifierEnvironment().className = name.escapedText as string;
getPrivateIdentifierEnvironment().className = idText(name);

Otherwise you'll get the escaped name which turns __Foo into ___Foo.

}

if (some(getPrivateInstanceMethods(node))) {
getPrivateIdentifierEnvironment().weakSetName = createHoistedVariableForClass("instances");
}
}

const result = isClassDeclaration(node) ?
Expand All @@ -588,6 +595,13 @@ namespace ts {
return isPropertyDeclaration(node) || (shouldTransformPrivateElements && node.name && isPrivateIdentifier(node.name));
}

function getPrivateInstanceMethods(node: ClassLikeDeclaration) {
return filter(
Copy link
Contributor

@rbuckton rbuckton Mar 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It would be more efficient to invert this (filter then concat, rather than concat then filter), as this currently creates an array of all of the methods and accessors and then filters them down. You could also do this without the concatenation and only a single walk of the node's members by moving the test for non-static methods/accessors into the filter clause itself.

Copy link
Contributor

@rbuckton rbuckton Mar 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After reviewing utilities.ts, you might want to consider just creating an isNonStaticMethodOrAccessorWithPrivateName function rather than all of the extra functions and closures needed to evaluate this. This implementation generates:

  • Two function definitions that are only used from here (getMethods and getAccessors)
  • Two helper functions that are only used from the two functions above (isStaticMethodDeclaration and isStaticAccessorDeclaration)
  • A closure a piece in each of getMethods and getAccessors to pass the isStatic flag around.
  • An arrow function for the final filter here.

It seems like this complexity could be greatly reduced.

[...getMethods(node, /*isStatic*/ false), ...getAccessors(node, /*isStatic*/ false)],
method => isPrivateIdentifier(method.name)
);
}

function visitClassDeclaration(node: ClassDeclaration) {
if (!forEach(node.members, doesClassElementNeedTransform)) {
return visitEachChild(node, visitor, context);
Expand Down Expand Up @@ -705,7 +719,9 @@ namespace ts {
}
}

createBrandCheckWeakSetForPrivateMethods();
if (some(getPrivateInstanceMethods(node))) {
createBrandCheckWeakSetForPrivateMethods();
}
}

const members: ClassElement[] = [];
Expand All @@ -718,17 +734,9 @@ namespace ts {
}

function createBrandCheckWeakSetForPrivateMethods() {
const env = getPrivateIdentifierEnvironment();
if (!env.hasPrivateMethods) {
return;
}

const weakSetName = createHoistedVariableForClass("instances");
env.weakSetName = weakSetName;

getPendingExpressions().push(
factory.createAssignment(
env.weakSetName,
getPrivateIdentifierEnvironment().weakSetName,
factory.createNewExpression(
factory.createIdentifier("WeakSet"),
/*typeArguments*/ undefined,
Expand Down Expand Up @@ -784,10 +792,7 @@ namespace ts {
properties = filter(properties, property => !!property.initializer || isPrivateIdentifier(property.name));
}

const privateMethods = filter(
[...getMethods(node, /*isStatic*/ false), ...getAccessors(node, /*isStatic*/ false)],
method => isPrivateIdentifier(method.name)
);
const privateMethods = getPrivateInstanceMethods(node);
const needsConstructorBody = some(properties) || some(privateMethods);

// Only generate synthetic constructor when there are property initializers to move.
Expand Down Expand Up @@ -1081,7 +1086,6 @@ namespace ts {
if (!currentPrivateIdentifierEnvironment) {
currentPrivateIdentifierEnvironment = {
className: "",
hasPrivateMethods: false,
weakSetName: factory.createUniqueName("_instances", GeneratedIdentifierFlags.Optimistic),
Copy link
Contributor

@rbuckton rbuckton Mar 15, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does weakSetName always need to be set, or can it be lazily assigned when it is first used to avoid allocating an identifier that might be unnecessary.

identifiers: new Map()
};
Expand All @@ -1096,6 +1100,7 @@ namespace ts {

function addPrivateIdentifierToEnvironment(node: PrivateClassElementDeclaration) {
const text = getTextOfPropertyName(node.name) as string;
const { weakSetName } = getPrivateIdentifierEnvironment();
let info: PrivateIdentifierInfo;
const assignmentExpressions: Expression[] = [];

Expand All @@ -1118,10 +1123,9 @@ namespace ts {
else if (isMethodDeclaration(node)) {
info = {
placement: PrivateIdentifierPlacement.InstanceMethod,
functionName: createHoistedVariableForPrivateName(text)
weakSetName,
functionName: createHoistedVariableForPrivateName(text),
};

getPrivateIdentifierEnvironment().hasPrivateMethods = true;
}
else if (isAccessor(node)) {
const previousInfo = findPreviousAccessorInfo(node);
Expand All @@ -1132,13 +1136,15 @@ namespace ts {
if (previousInfo?.placement === PrivateIdentifierPlacement.InstanceSetterOnly) {
info = {
placement: PrivateIdentifierPlacement.InstanceGetterAndSetter,
weakSetName,
getterName,
setterName: previousInfo.setterName
};
}
else {
info = {
placement: PrivateIdentifierPlacement.InstanceGetterOnly,
weakSetName,
getterName
};
}
Expand All @@ -1149,19 +1155,19 @@ namespace ts {
if (previousInfo?.placement === PrivateIdentifierPlacement.InstanceGetterOnly) {
info = {
placement: PrivateIdentifierPlacement.InstanceGetterAndSetter,
weakSetName,
setterName,
getterName: previousInfo.getterName
};
}
else {
info = {
placement: PrivateIdentifierPlacement.InstanceSetterOnly,
weakSetName,
setterName
};
}
}

getPrivateIdentifierEnvironment().hasPrivateMethods = true;
}
else {
return;
Expand Down