Skip to content

Only allow StoreModule at the top-level of constructor bodies. #5057

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 1 commit into from
Nov 2, 2024
Merged

Only allow StoreModule at the top-level of constructor bodies. #5057

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
52 changes: 24 additions & 28 deletions linker/shared/src/main/scala/org/scalajs/linker/checker/ClassDefChecker.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,6 @@ private final class ClassDefChecker(classDef: ClassDef,
val thisType = if (static) NoType else instanceThisType
val bodyEnv = Env.fromParams(params)
.withThisType(thisType)
.withInConstructor(isConstructor)

if (isConstructor)
checkConstructorBody(body, bodyEnv)
Expand All @@ -328,12 +327,13 @@ private final class ClassDefChecker(classDef: ClassDef,

val startEnv = Env.fromParams(classDef.jsClassCaptures.getOrElse(Nil) ++ params ++ restParam)
.withHasNewTarget(true)
.withInConstructor(true)

val envJustBeforeSuper = checkBlockStats(body.beforeSuper, startEnv)
checkTreeOrSpreads(body.superCall.args, envJustBeforeSuper)
val envJustAfterSuper = envJustBeforeSuper.withThisType(instanceThisType)
checkBlockStats(body.afterSuper, envJustAfterSuper)
val afterSuperStoreModulesHandled =
handleStoreModulesAfterSuperCtorCall(body.afterSuper)
checkBlockStats(afterSuperStoreModulesHandled, envJustAfterSuper)
}

private def checkJSMethodDef(methodDef: JSMethodDef): Unit = withPerMethodState {
Expand Down Expand Up @@ -525,12 +525,10 @@ private final class ClassDefChecker(classDef: ClassDef,
* - There is no such `ApplyStatically` anywhere else in the body.
* - `cls` must be the enclosing class or its direct superclass.
* - In the statements before the delegate constructor call, and within
* `args`:
* - `This()` cannot be used except in `Assign(Select(This(), _), _)`,
* i.e., to assign to a field (but not read from one).
* - `StoreModule()` cannot be used.
* `args`, `This()` cannot be used except in `Assign(Select(This(), _), _)`,
* i.e., to assign to a field (but not read from one).
* - After the delegate constructor call, `This` can be used without
* restriction.
* restriction. Moreover, we can have `StoreModule`s at the top-level.
*
* After the optimizer, there may be no delegate constructor call at all.
* This frequently happens as the optimizer inlines super constructor
Expand Down Expand Up @@ -561,7 +559,9 @@ private final class ClassDefChecker(classDef: ClassDef,
if (!postOptimizer)
reportError(i"Constructor must contain a delegate constructor call")

checkBlockStats(bodyStats, bodyEnv)
val bodyStatsStoreModulesHandled =
handleStoreModulesAfterSuperCtorCall(bodyStats)
checkBlockStats(bodyStatsStoreModulesHandled, bodyEnv)
} else {
val (delegateCtorCall: ApplyStatically) :: afterDelegateCtor = rest
val ApplyStatically(_, receiver, cls, MethodIdent(ctor), args) = delegateCtorCall
Expand All @@ -585,11 +585,23 @@ private final class ClassDefChecker(classDef: ClassDef,
}
}

checkBlockStats(afterDelegateCtor, unrestrictedEnv)
val afterDelegateCtorStoreModulesHandled =
handleStoreModulesAfterSuperCtorCall(afterDelegateCtor)
checkBlockStats(afterDelegateCtorStoreModulesHandled, unrestrictedEnv)
}
}
}

private def handleStoreModulesAfterSuperCtorCall(trees: List[Tree]): List[Tree] = {
/* If StoreModule's are allowed, there is nothing left to check about them,
* so we filter them out.
*/
if (classDef.kind.hasModuleAccessor)
trees.filter(!_.isInstanceOf[StoreModule])
else
trees
}

private def checkBlockStats(stats: List[Tree], env: Env): Env = {
stats.foldLeft(env) { (prevEnv, stat) =>
checkTree(stat, prevEnv)
Expand Down Expand Up @@ -717,14 +729,7 @@ private final class ClassDefChecker(classDef: ClassDef,
case _: LoadModule =>

case StoreModule() =>
if (!classDef.kind.hasModuleAccessor)
reportError(i"Illegal StoreModule inside class of kind ${classDef.kind}")
if (!env.inConstructor)
reportError(i"Illegal StoreModule outside of constructor")
if (env.thisType == NoType) // can happen before JSSuperConstructorCall in JSModuleClass
reportError(i"Cannot find `this` in scope for StoreModule()")
if (env.isThisRestricted)
reportError(i"Restricted use of `this` for StoreModule() before super constructor call")
reportError(i"Illegal StoreModule")

case Select(qualifier, _) =>
checkTree(qualifier, env)
Expand Down Expand Up @@ -1063,8 +1068,6 @@ object ClassDefChecker {
val locals: Map[LocalName, LocalDef],
/** Return types by label. */
val returnLabels: Set[LabelName],
/** Whether we are in a constructor of the class. */
val inConstructor: Boolean,
/** Whether usages of `this` are restricted in this scope. */
val isThisRestricted: Boolean
) {
Expand All @@ -1082,9 +1085,6 @@ object ClassDefChecker {
def withLabel(label: LabelName): Env =
copy(returnLabels = returnLabels + label)

def withInConstructor(inConstructor: Boolean): Env =
copy(inConstructor = inConstructor)

def withIsThisRestricted(isThisRestricted: Boolean): Env =
copy(isThisRestricted = isThisRestricted)

Expand All @@ -1093,11 +1093,9 @@ object ClassDefChecker {
thisType: Type = thisType,
locals: Map[LocalName, LocalDef] = locals,
returnLabels: Set[LabelName] = returnLabels,
inConstructor: Boolean = inConstructor,
isThisRestricted: Boolean = isThisRestricted
): Env = {
new Env(hasNewTarget, thisType, locals, returnLabels, inConstructor,
isThisRestricted)
new Env(hasNewTarget, thisType, locals, returnLabels, isThisRestricted)
}
}

Expand All @@ -1108,7 +1106,6 @@ object ClassDefChecker {
thisType = NoType,
locals = Map.empty,
returnLabels = Set.empty,
inConstructor = false,
isThisRestricted = false
)
}
Expand All @@ -1123,7 +1120,6 @@ object ClassDefChecker {
thisType = NoType,
paramLocalDefs.toMap,
Set.empty,
inConstructor = false,
isThisRestricted = false
)
}
Expand Down
40 changes: 36 additions & 4 deletions linker/shared/src/test/scala/org/scalajs/linker/checker/ClassDefCheckerTest.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -516,7 +516,7 @@ class ClassDefCheckerTest {
})(EOH, UNV)
)
),
"Illegal StoreModule inside class of kind Class"
"Illegal StoreModule"
)

assertError(
Expand All @@ -533,7 +533,24 @@ class ClassDefCheckerTest {
})(EOH, UNV)
)
),
"Restricted use of `this` for StoreModule() before super constructor call"
"Illegal StoreModule"
)

assertError(
classDef(
"Foo",
kind = ClassKind.ModuleClass,
superClass = Some(ObjectClass),
methods = List(
MethodDef(ctorFlags, NoArgConstructorName, NON, Nil, NoType, Some {
Block(
superCtorCall,
If(BooleanLiteral(true), StoreModule(), Skip())(NoType)
)
})(EOH, UNV)
)
),
"Illegal StoreModule"
)

assertError(
Expand All @@ -550,7 +567,7 @@ class ClassDefCheckerTest {
})(EOH, UNV)
)
),
"Illegal StoreModule outside of constructor"
"Illegal StoreModule"
)

assertError(
Expand All @@ -564,7 +581,22 @@ class ClassDefCheckerTest {
EOH, UNV)
)
),
"Cannot find `this` in scope for StoreModule()"
"Illegal StoreModule"
)

assertError(
classDef(
"Foo",
kind = ClassKind.JSModuleClass,
superClass = Some("scala.scalajs.js.Object"),
jsConstructor = Some(
JSConstructorDef(JSCtorFlags, Nil, None,
JSConstructorBody(Nil, JSSuperConstructorCall(Nil),
If(BooleanLiteral(true), StoreModule(), Skip())(NoType) :: Undefined() :: Nil))(
EOH, UNV)
)
),
"Illegal StoreModule"
)
}

Expand Down