Reading PHP Remote Interpreter Path

Answered

Created April 01, 2022 21:44

Hello,

I'm working on a plugin that is auto configuring a docker compose based remote php interpreter. Registering the Interpreter works quite well now. But I would like to improve the performance and user experience by first checking wether the interpreter is already configured correctly. Therefore I need to read the php interpreter path of a given interpreter. Find some example code below.

PhpInterpretersManagerImpl interpretersManager = PhpInterpretersManagerImpl.getInstance(this.project);
PhpInterpreter interpreter = interpretersManager.findInterpreter(NAME);

PhpSdkAdditionalData additionalData = interpreter.getPhpSdkAdditionalData();

if (!(additionalData instanceof PhpRemoteSdkAdditionalData)) {
    System.out.println("Wrong instance!");
}

Even the PHP Remote Interpreter was saved as a remote interpreter, this code will always run the "wrong instance" part, as getPhpSdkAdditionalData of the loaded instance of the interpreter will always return an instance of PhpSdkAdditionalData.

Is this behavior intended? Do I miss something? How can I compare the configured php version of the interpreter?

Thanks in advance!

Edit:
Of course I already tried to access the path directly on the interpreter:

phpInterpreter.getPathToPhpExecutable()

But this just seems to be a wrapper for the additionalData and always returns an empty string.

8 comments

Kirill Smelov

Created April 05, 2022 10:00

Official comment

Hello! To fetch all configured interpreters you can try to use this code:

PhpInterpretersManagerImpl.getInstance(project).getInterpreters()

If configured remote interpreter exists, one of the return interpreters should match provided predicate.

Nico Löber

Created April 05, 2022 11:10

Hello Kirill Smelov, thank you for your answer!

Sadly this does not solve my problem.
I do get the instacne of the PHP Interpreter, but I can not accesss the path of its configured binary.

The following code snipped

for (PhpInterpreter interpreter : PhpInterpretersManagerImpl.getInstance(project).getInterpreters()) {
    System.out.println(interpreter.getName());
    System.out.println(interpreter.getPathToPhpExecutable());
}

will generate the following output:

DDEV

but I would expect

DDEV
php5.6

as this is the configured binary as you can see in the GUI:

As I already stated above I think the wrong instance of PhpSdkAdditionalData might be the reason, as I would expect an instance of PhpRemoteSdkAdditionalData and the interpreter path seems to be saved in RemoteSdkPropertiesHolder.

I hope I explained my issue more precise now.

Thanks in advance for any help on this!

Nico Löber

Created April 05, 2022 11:24

Okay, I just noticed, this behavior just seems to occur on automatically configured interpreters, not on those created via the GUI.
I guess I miss something when creating the interpreter?
Sorry, I should have noted before, that I did create that interpreter not via the GUI.

final PhpInterpreter phpInterpreter = new PhpInterpreter();
phpInterpreter.setName(NAME);
phpInterpreter.setIsProjectLevel(true);

final PhpRemoteSdkAdditionalData sdkData = new PhpRemoteSdkAdditionalData("php" + description.getPhpVersion());
sdkData.setInterpreterId(phpInterpreter.getId());
sdkData.setHelpersPath(HELPERS_DIR);

final DockerComposeCredentialsHolder credentials = DockerComposeCredentialsType.getInstance().createCredentials();
credentials.setAccountName(DOCKER_NAME);
credentials.setComposeFilePaths(List.of(composeFilePath));
credentials.setComposeServiceName(SERVICE_NAME);
credentials.setRemoteProjectPath(DockerCredentialsEditor.DEFAULT_DOCKER_PROJECT_PATH);
credentials.setEnvs(EnvironmentVariablesData.create(Map.of(COMPOSE_PROJECT_NAME_ENV, "ddev-" + description.getName()), true));

sdkData.setTypeData(new PhpDockerComposeTypeData(PhpDockerComposeStartCommand.EXEC));
sdkData.setCredentials(DockerComposeCredentialsType.getInstance().getCredentialsKey(), credentials);
sdkData.setPathMappings(this.loadPathMappings(sdkData));

phpInterpreter.setPhpSdkAdditionalData(sdkData);

PhpInterpretersManagerImpl interpretersManager = PhpInterpretersManagerImpl.getInstance(this.project);
List<PhpInterpreter> interpreters = interpretersManager.getInterpreters();
interpreters.add(phpInterpreter);
interpretersManager.setInterpreters(interpreters);

Kirill Smelov

Created April 05, 2022 14:06

This should normally work. Can you please provide complete example with setup code and the code that doesn't work?

Nico Löber

Created April 05, 2022 17:12

Hi Kirill Smelov,

I prepared the following startup activity to reproduce the problem.

1. Adapt the package name of the class and register the startup action in PHPStorm

2. Run the IDE with this code executed. You should see a new valid and working PHP Interpreter is added.

3. Restart your IDE

Result:

You will see the output "DDEV" without any interpreter path on your terminal (See System.out.println in lines 29, 31)
Also the php interpreter looks broken now if you open it in settings dialog.

Expected Result:

I would expect to see the interpreter name DDEV and its interpreter path php8.0 in the output.

The interpreter is found but all the settings are gone. When opening this issue I thought the problem would be accessing the data but now I think I did some mistake persisting them. Do you have any idea on how to fix this? Thanks!

Code

package de.php_perfect.intellij.ddev;

import com.intellij.docker.remote.DockerComposeCredentialsHolder;
import com.intellij.docker.remote.DockerComposeCredentialsType;
import com.intellij.docker.remote.DockerCredentialsEditor;
import com.intellij.openapi.project.Project;
import com.intellij.openapi.startup.StartupActivity;
import com.jetbrains.php.config.interpreters.PhpInterpreter;
import com.jetbrains.php.config.interpreters.PhpInterpretersManagerImpl;
import com.jetbrains.php.config.interpreters.PhpInterpretersPhpInfoCacheImpl;
import com.jetbrains.php.config.phpInfo.PhpInfo;
import com.jetbrains.php.config.phpInfo.PhpInfoUtil;
import com.jetbrains.php.remote.docker.compose.PhpDockerComposeStartCommand;
import com.jetbrains.php.remote.docker.compose.PhpDockerComposeTypeData;
import com.jetbrains.php.remote.interpreter.PhpRemoteSdkAdditionalData;
import org.jetbrains.annotations.NotNull;

import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.List;

public class PostStartupActivity implements StartupActivity, StartupActivity.DumbAware {
    @Override
    public void runActivity(@NotNull Project project) {
        PhpInterpretersManagerImpl interpretersManager = PhpInterpretersManagerImpl.getInstance(project);
        PhpInterpreter existingInterpreter = interpretersManager.findInterpreter("DDEV");

        if(existingInterpreter != null) {
            System.out.println(existingInterpreter.getName());
            // Reading the interpreter path
            System.out.println(existingInterpreter.getPathToPhpExecutable());

            return;
        }

        final PhpInterpreter phpInterpreter = new PhpInterpreter();
        phpInterpreter.setName("DDEV");
        phpInterpreter.setIsProjectLevel(true);

        // Setting the interpreter path
        final PhpRemoteSdkAdditionalData sdkData = new PhpRemoteSdkAdditionalData("php8.0");
        sdkData.setInterpreterId(phpInterpreter.getId());
        sdkData.setHelpersPath("/opt/.phpstorm_helpers");

        final Path path = Paths.get(project.getBasePath(), ".ddev/.ddev-docker-compose-full.yaml");
        final DockerComposeCredentialsHolder credentials = DockerComposeCredentialsType.getInstance().createCredentials();
        credentials.setAccountName("Docker");
        credentials.setComposeFilePaths(List.of(path.toString()));
        credentials.setComposeServiceName("web");
        credentials.setRemoteProjectPath(DockerCredentialsEditor.DEFAULT_DOCKER_PROJECT_PATH);

        sdkData.setTypeData(new PhpDockerComposeTypeData(PhpDockerComposeStartCommand.EXEC));
        sdkData.setCredentials(DockerComposeCredentialsType.getInstance().getCredentialsKey(), credentials);

        phpInterpreter.setPhpSdkAdditionalData(sdkData);

        List<PhpInterpreter> interpreters = interpretersManager.getInterpreters();
        interpreters.add(phpInterpreter);
        interpretersManager.setInterpreters(interpreters);

        PhpInfo phpInfo = PhpInfoUtil.getPhpInfo(project, phpInterpreter, null);
        PhpInterpretersPhpInfoCacheImpl.getInstance(project).setPhpInfo(phpInterpreter.getName(), phpInfo);
    }
}

Nico Löber

Created April 11, 2022 10:08

Kirill Smelov do you have any news on this? I still couldn't find my mistake.

Kirill Smelov

Created April 14, 2022 16:01

Can you please try to explicitly set interpreter home path? It's used during deserialization of interpreters on IDE startup to decide on type of SDK

interpreter.setHomePath(sdkData.getSdkId());

after setting sdk additional data?

Nico Löber

Created April 14, 2022 16:51

This did the trick, it finally works!

Thank you so much, Kirill Smelov!

Please sign in to leave a comment.