Add system to import functions from remote

[pyrech]

For now, only import from GitHub repositories is supported.

use function Castor\import;

import('github://<user>/<repository>/<path to php file to import>@<version>');

A trust system is embedded to avoid malicious remote execution and ask users if they allow to import remote functions.

See the documentation for how it works: https://github.com/jolicode/castor/blob/remote-imports/doc/15-remote.md

Future ideas:

• Make use of this feature in docker-starter to be able to provide optional infrastructure parts:

import('github://jolicode/docker-starter/worker')

• Provide some "standard" library of common tasks we used at JoliCode:

import('github://jolicode/docker-starter/v4/.castor/qa.php')

[lyrixx]

Very cool

[lyrixx]

Is there a way to not update all tests?

[pyrech]

Did not find a way, so I'm open to any suggestions

[lyrixx]

I would put all the code in a vendor directly (like vendor/.castor, like that there is no need to hook in the stub generation, and we can ship more than some code!

[welcoMattic]

We should document what version could be. A branch? A tag? A commit hash?

[TheoD02]

Hey,

Not a lot of movement here? ^^
What's the status of this PR? What's the reason for this long inactivity ? What's left to do?😄

I'm waiting for this PR to split the common code to share it with different projects 😁

[pyrech]

For the record we sometimes talk internally about this feature we all want. But we do not fully agree on some details, mainly where to store the downloaded files. I hope we can find a solution soon but not sure it will find its way before the release of the v1

[lyrixx]

We had a very good talk with @pyrech and @joelwurtz and here the ADR

The goal is to generate a composer.json, then use composer to download everything.

Default usage, package is published on packagist.org

import('composer://jolicode/jolitypo');

Add this to composer.json

{
    "require": {
        "jolicode/castor": "*",
    }
}

Then execute at runtime

require_once PathHelper::getRoot() . '/.castor/vendor/autoload.php';

More complex usage

import('composer://jolicode/jolitypo',
    file: 'path/to/file.php',
    version: 'v1.2.34',
);

Add this to composer.json

{
    "require": {
        "jolicode/castor": "v1.2.34",
    }
}

Then execute at runtime

require_once PathHelper::getRoot() . '/.castor/vendor/autoload.php';
require_once PathHelper::getRoot() . '/.castor/vendor/jolicode/jolitypo/path/to/file.php';

Package that is not published on packagist.org

import('composer://jolicode/jolitypo',
    file: 'path/to/file.php',
    version: 'v1.2.34',
    vcs: 'https://github.com/jolicode/jolitypo.git',
);

Add this to composer.json

{
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/jolicode/jolitypo.git"
        }
    ],
    "require": {
        "jolicode/castor": "v1.2.34",
    }
}

Then execute at runtime

require_once PathHelper::getRoot() . '/.castor/vendor/autoload.php';
require_once PathHelper::getRoot() . '/.castor/vendor/jolicode/jolitypo/path/to/file.php';

Not a package

import('package://what/you-want',
    file: 'path/to/file.php',
    // version: 'dev-main', // Not allowed here
    source: [
        "url" =>  "https://github.com/soyuka/php-wasm.git",
        "type" => "git",
        "reference" => "main"
    ],
);

Add this to composer.json

{
    "repositories": [
        {
            "type": "package",
            "package": {
                "name": "what/you-want",
                "version": "dev-main",
                "source": {
                    "url": "https://github.com/soyuka/php-wasm.git",
                    "type": "git",
                    "reference": "main"
                }
            }
        },

    ],
    "require": {
        "what/you-want": "*",
    }
}

Then execute at runtime

require_once PathHelper::getRoot() . '/.castor/vendor/autoload.php';

[pyrech]

Closing in favor of #297