Skip to content
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

Bugfix/765: Fixed stack overflow error for line-marker providers #813

Merged
merged 9 commits into from
Nov 29, 2021
Merged

Bugfix/765: Fixed stack overflow error for line-marker providers #813

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
0bb3c44
Bugfix-765: Code refactoring
bohdan-harniuk Nov 29, 2021
7d69766
Bugfix-765: Fixed bug for the PluginLineMarkerProvider
bohdan-harniuk Nov 29, 2021
1d17fa7
Bugfix-765: Code refactoring
bohdan-harniuk Nov 29, 2021
7df117b
Bugfix-765: Fixed bug for the PluginTargetLineMarkerProvider
bohdan-harniuk Nov 29, 2021
7293944
Bugfix-765: Code refactoring
bohdan-harniuk Nov 29, 2021
e90e77c
Bugfix-765: Fixed bug for the WebApiLineMarkerProvider
bohdan-harniuk Nov 29, 2021
ce56e41
Bugfix-765: Code refactoring
bohdan-harniuk Nov 29, 2021
504cbab
Bugfix-765: Code refactoring
bohdan-harniuk Nov 29, 2021
f452d79
Bugfix-765: Code refactoring
bohdan-harniuk Nov 29, 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
173 changes: 111 additions & 62 deletions src/com/magento/idea/magento2plugin/linemarker/php/PluginLineMarkerProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

package com.magento.idea.magento2plugin.linemarker.php;

import com.intellij.codeInsight.daemon.LineMarkerInfo;
Expand All @@ -17,156 +18,204 @@
import com.jetbrains.php.lang.psi.elements.PhpClass;
import com.magento.idea.magento2plugin.project.Settings;
import com.magento.idea.magento2plugin.stubs.indexes.PluginIndex;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.apache.commons.lang.WordUtils;
import org.jetbrains.annotations.NotNull;
import org.jetbrains.annotations.Nullable;

import java.util.*;

public class PluginLineMarkerProvider implements LineMarkerProvider {
@Nullable

private static final String TOOLTIP_TEXT = "Navigate to plugins";
private static final int MIN_PLUGIN_METHOD_NAME_LENGTH = 6;

@Override
public LineMarkerInfo getLineMarkerInfo(@NotNull PsiElement psiElement) {
public @Nullable LineMarkerInfo<?> getLineMarkerInfo(final @NotNull PsiElement psiElement) {
return null;
}

@Override
public void collectSlowLineMarkers(@NotNull List<? extends PsiElement> psiElements, @NotNull Collection<? super LineMarkerInfo<?>> collection) {
if (psiElements.size() > 0) {
if (!Settings.isEnabled(psiElements.get(0).getProject())) {
return;
}
public void collectSlowLineMarkers(
final @NotNull List<? extends PsiElement> psiElements,
final @NotNull Collection<? super LineMarkerInfo<?>> collection
) {
if (psiElements.isEmpty()) {
return;
}
PluginClassCache pluginClassCache = new PluginClassCache();
ClassPluginCollector classPluginCollector = new ClassPluginCollector(pluginClassCache);
MethodPluginCollector methodPluginCollector = new MethodPluginCollector(pluginClassCache);

for (PsiElement psiElement : psiElements) {
if (!Settings.isEnabled(psiElements.get(0).getProject())) {
return;
}
final PluginClassCache pluginClassCache = new PluginClassCache();
final ClassPluginCollector classPluginCollector = new ClassPluginCollector(
pluginClassCache
);
final MethodPluginCollector methodPluginCollector = new MethodPluginCollector(
pluginClassCache
);

for (final PsiElement psiElement : psiElements) {
if (psiElement instanceof PhpClass || psiElement instanceof Method) {
List<? extends PsiElement> results;
final List<? extends PsiElement> results;

if (psiElement instanceof PhpClass) {
results = classPluginCollector.collect((PhpClass) psiElement);
} else {
results = methodPluginCollector.collect((Method) psiElement);
}

if (results.size() > 0 ) {
collection.add(NavigationGutterIconBuilder
.create(AllIcons.Nodes.Plugin)
.setTargets(results)
.setTooltipText("Navigate to plugins")
.createLineMarkerInfo(PsiTreeUtil.getDeepestFirst(psiElement))
if (!results.isEmpty()) {
collection.add(
NavigationGutterIconBuilder
.create(AllIcons.Nodes.Plugin)
.setTargets(results)
.setTooltipText(TOOLTIP_TEXT)
.createLineMarkerInfo(PsiTreeUtil.getDeepestFirst(psiElement))
);
}
}
}
}

private static class PluginClassCache {
private HashMap<String, List<PhpClass>> classPluginsMap = new HashMap<String, List<PhpClass>>();

List<PhpClass> getPluginsForClass(@NotNull PhpClass phpClass, @NotNull String classFQN) {
List<PhpClass> results = new ArrayList<>();
private final Map<String, List<PhpClass>> classPluginsMap = new HashMap<>();

public List<PhpClass> getPluginsForClass(final @NotNull PhpClass phpClass) {
final List<PhpClass> pluginsForClass = getPluginsForClass(
phpClass,
phpClass.getPresentableFQN()
);

for (final PhpClass parent : phpClass.getSupers()) {
if (classPluginsMap.containsKey(parent.getFQN().substring(1))) {
continue;
}
pluginsForClass.addAll(getPluginsForClass(parent));
}

return pluginsForClass;
}

public List<PhpClass> getPluginsForClass(
final @NotNull PhpClass phpClass,
final @NotNull String classFQN
) {
if (classPluginsMap.containsKey(classFQN)) {
return classPluginsMap.get(classFQN);
}

List<Set<String>> plugins = FileBasedIndex.getInstance()
.getValues(PluginIndex.KEY, classFQN, GlobalSearchScope.allScope(phpClass.getProject()));
final List<Set<String>> plugins = FileBasedIndex.getInstance()
.getValues(
PluginIndex.KEY,
classFQN,
GlobalSearchScope.allScope(phpClass.getProject())
);
final List<PhpClass> results = new ArrayList<>();

if (plugins.size() == 0) {
if (plugins.isEmpty()) {
classPluginsMap.put(classFQN, results);

return results;
}
final PhpIndex phpIndex = PhpIndex.getInstance(phpClass.getProject());

PhpIndex phpIndex = PhpIndex.getInstance(phpClass.getProject());

for (Set<String> pluginClassNames: plugins) {
for (String pluginClassName: pluginClassNames) {
for (final Set<String> pluginClassNames : plugins) {
for (final String pluginClassName: pluginClassNames) {
results.addAll(phpIndex.getClassesByFQN(pluginClassName));
}
}
classPluginsMap.put(classFQN, results);

return results;
}

List<PhpClass> getPluginsForClass(@NotNull PhpClass phpClass)
{
List<PhpClass> pluginsForClass = getPluginsForClass(phpClass, phpClass.getPresentableFQN());
for (PhpClass parent: phpClass.getSupers()) {
pluginsForClass.addAll(getPluginsForClass(parent));
public List<Method> getPluginMethods(final List<PhpClass> plugins) {
final List<Method> methodList = new ArrayList<>();

for (final PhpClass plugin: plugins) {
methodList.addAll(getPluginMethods(plugin));
}

return pluginsForClass;
return methodList;
}

List<Method> getPluginMethods(@NotNull PhpClass plugin) {
List<Method> methodList = new ArrayList<Method>();
for (Method method : plugin.getMethods()) {
public List<Method> getPluginMethods(final @NotNull PhpClass pluginClass) {
final List<Method> methodList = new ArrayList<>();

for (final Method method : pluginClass.getMethods()) {
if (method.getAccess().isPublic()) {
String pluginMethodName = method.getName();
if (pluginMethodName.length() > 6) {
final String pluginMethodName = method.getName();

if (pluginMethodName.length() > MIN_PLUGIN_METHOD_NAME_LENGTH) {
methodList.add(method);
}
}
}
return methodList;
}

List<Method> getPluginMethods(List<PhpClass> plugins) {
List<Method> methodList = new ArrayList<Method>();
for (PhpClass plugin: plugins) {
methodList.addAll(getPluginMethods(plugin));
}
return methodList;
}
}

private static class ClassPluginCollector implements Collector<PhpClass, PhpClass> {
private PluginLineMarkerProvider.PluginClassCache pluginClassCache;

ClassPluginCollector(PluginLineMarkerProvider.PluginClassCache pluginClassCache) {
private final PluginLineMarkerProvider.PluginClassCache pluginClassCache;

public ClassPluginCollector(
final PluginLineMarkerProvider.PluginClassCache pluginClassCache
) {
this.pluginClassCache = pluginClassCache;
}

@Override
public List<PhpClass> collect(@NotNull PhpClass psiElement) {
public List<PhpClass> collect(final @NotNull PhpClass psiElement) {
return pluginClassCache.getPluginsForClass(psiElement);
}
}

private static class MethodPluginCollector implements Collector<Method, Method> {
private PluginLineMarkerProvider.PluginClassCache pluginClassCache;

MethodPluginCollector(PluginLineMarkerProvider.PluginClassCache pluginClassCache) {
private final PluginLineMarkerProvider.PluginClassCache pluginClassCache;

public MethodPluginCollector(
final PluginLineMarkerProvider.PluginClassCache pluginClassCache
) {
this.pluginClassCache = pluginClassCache;
}

@Override
public List<Method> collect(@NotNull Method psiElement) {
List<Method> results = new ArrayList<>();
public List<Method> collect(final @NotNull Method psiElement) {
final List<Method> results = new ArrayList<>();

final PhpClass methodClass = psiElement.getContainingClass();

PhpClass methodClass = psiElement.getContainingClass();
if (methodClass == null) {
return results;
}
final List<PhpClass> pluginsList = pluginClassCache.getPluginsForClass(methodClass);
final List<Method> pluginMethods = pluginClassCache.getPluginMethods(pluginsList);

List<PhpClass> pluginsList = pluginClassCache.getPluginsForClass(methodClass);
List<Method> pluginMethods = pluginClassCache.getPluginMethods(pluginsList);
final String classMethodName = WordUtils.capitalize(psiElement.getName());

String classMethodName = WordUtils.capitalize(psiElement.getName());
for (Method pluginMethod: pluginMethods) {
for (final Method pluginMethod: pluginMethods) {
if (isPluginMethodName(pluginMethod.getName(), classMethodName)) {
results.add(pluginMethod);
}
}

return results;
}

private boolean isPluginMethodName(String pluginMethodName, String classMethodName) {
return pluginMethodName.substring(5).equals(classMethodName) || pluginMethodName.substring(6).equals(classMethodName);
private boolean isPluginMethodName(
final String pluginMethodName,
final String classMethodName
) {
return pluginMethodName.substring(5).equals(classMethodName)
|| pluginMethodName.substring(6).equals(classMethodName);
}
}

Expand Down
Loading