Skip to content

Cache trans_default_domain lookups by scope to improve performance and reduce redundant calculations in Twig files. #2760

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
Haehnchen merged 1 commit into from
Apr 25, 2026
Merged

Cache trans_default_domain lookups by scope to improve performance and reduce redundant calculations in Twig files. #2760

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
68 changes: 40 additions & 28 deletions src/main/java/fr/adrienbrault/idea/symfony2plugin/templating/util/TwigUtil.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,7 @@
import java.io.File;
import java.text.Collator;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
Expand Down Expand Up @@ -121,6 +122,8 @@ public enum NamespaceType {
private static final Key<CachedValue<List<String>>> SYMFONY_TEMPLATE_INCLUDE_LIST = new Key<>("SYMFONY_TEMPLATE_INCLUDE_LIST");
private static final Key<CachedValue<List<String>>> SYMFONY_TEMPLATE_EMBED_LIST = new Key<>("SYMFONY_TEMPLATE_EMBED_LIST");
private static final Key<CachedValue<List<String>>> SYMFONY_TEMPLATE_EXTENDS_LIST = new Key<>("SYMFONY_TEMPLATE_EXTENDS_LIST");
// File-held cache for trans_default_domain lookups; TextRange separates file and embed scopes.
private static final Key<CachedValue<Map<TextRange, Optional<String>>>> TWIG_TRANS_DEFAULT_DOMAIN_ON_SCOPE = new Key<>("TWIG_TRANS_DEFAULT_DOMAIN_ON_SCOPE");

private static final Key<CachedValue<List<String>>> SYMFONY_TEMPLATE_FORM_THEME_LIST = new Key<>("SYMFONY_TEMPLATE_FORM_THEME_LIST");

Expand Down Expand Up @@ -327,49 +330,75 @@ public static Map<String, Collection<PsiElement>> getTemplateAnnotationFilesWith
public static String getTransDefaultDomainOnScope(@NotNull PsiElement position) {
// {% embed 'foo.html.twig' with { foo: '<caret>'|trans } %}
PsiElement parent = position.getParent();
if(parent != null && parent.getNode().getElementType() == TwigElementTypes.LITERAL) {
if (parent != null && parent.getNode().getElementType() == TwigElementTypes.LITERAL) {
PsiElement parent2 = parent.getParent();
if(parent2 != null && parent2.getNode().getElementType() == TwigElementTypes.EMBED_TAG) {
if (parent2 != null && parent2.getNode().getElementType() == TwigElementTypes.EMBED_TAG) {
PsiElement firstParent = PsiTreeUtil.findFirstParent(parent, true, psiElement -> {
IElementType elementType = psiElement.getNode().getElementType();
return elementType != TwigElementTypes.EMBED_TAG && elementType != TwigElementTypes.EMBED_STATEMENT;
});

if(firstParent != null) {
if (firstParent != null) {
position = firstParent;
}
}
}

// find embed or file scope
PsiElement scope = getTransDefaultDomainScope(position);
if(scope == null) {
if (scope == null) {
return null;
}

for (PsiElement psiElement : scope.getChildren()) {
// Store one cache map on the file; a file may contain multiple embed scopes.
PsiFile containingFile = scope.getContainingFile();
Map<TextRange, Optional<String>> cachedDomains = CachedValuesManager.getManager(scope.getProject())
.getCachedValue(
containingFile,
TWIG_TRANS_DEFAULT_DOMAIN_ON_SCOPE,
() -> CachedValueProvider.Result.create(
new ConcurrentHashMap<>(),
PsiModificationTracker.getInstance(scope.getProject()).forLanguage(TwigLanguage.INSTANCE)
),
false
);

// filter parent trans_default_domain, it should be in file context
if(psiElement instanceof TwigCompositeElement && psiElement.getNode().getElementType() == TwigElementTypes.TAG) {
// Use the scope range as key, so the file scope and each embed block can cache different domains.
Optional<String> cachedDomain = cachedDomains.computeIfAbsent(
scope.getTextRange(),
ignored -> Optional.ofNullable(computeTransDefaultDomainOnScope(scope))
);

return cachedDomain.orElse(null);
}

/**
* Fetches the first default translation domain in a Twig file/embed scope.
* Example: {% trans_default_domain "validators" %} resolves to "validators".
* Embed: {% embed "card.html.twig" %}{% trans_default_domain "admin" %}{% endembed %} resolves to "admin" inside the embed block.
*/
@Nullable
private static String computeTransDefaultDomainOnScope(@NotNull PsiElement scope) {
for (PsiElement psiElement : scope.getChildren()) {
// filter parent trans_default_domain, it should be in file context
if (psiElement instanceof TwigCompositeElement && psiElement.getNode().getElementType() == TwigElementTypes.TAG) {
final String[] fileTransDomain = {null};
psiElement.acceptChildren(new PsiRecursiveElementWalkingVisitor() {
@Override
public void visitElement(PsiElement element) {
if(TwigPattern.getTransDefaultDomainPattern().accepts(element)) {
if (TwigPattern.getTransDefaultDomainPattern().accepts(element)) {
String text = PsiElementUtils.trimQuote(element.getText());
if(StringUtils.isNotBlank(text)) {
if (StringUtils.isNotBlank(text)) {
fileTransDomain[0] = text;
}
}
super.visitElement(element);
}
});

if(fileTransDomain[0] != null) {
if (fileTransDomain[0] != null) {
return fileTransDomain[0];
}

}
}

Expand Down Expand Up @@ -399,23 +428,6 @@ public static PsiElement getTwigFunctionParameterIdentifierPsi(@NotNull PsiEleme
return null;
}

/**
* Search Twig element to find use trans_default_domain and returns given string parameter
*/
@Nullable
public static String getTransDefaultDomainOnScopeOrInjectedElement(@NotNull PsiElement position) {
if(position.getContainingFile().getContainingFile().getFileType() == TwigFileType.INSTANCE) {
return getTransDefaultDomainOnScope(position);
}

PsiElement element = getElementOnTwigViewProvider(position);
if(element != null) {
return getTransDefaultDomainOnScope(element);
}

return null;
}

/**
* File Scope:
* {% trans_default_domain "foo" %}
Expand Down
Loading