Add a link script to ease debugging Flex apps #24746

dunglas · 2017-10-29T20:09:28Z

Q	A
Branch?	3.4
Bug fix?	no
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	#24708
License	MIT
Doc PR	symfony/symfony-docs#8730

(Reopened because of mishandling in the previous PR)

It's painful to debug and patch Flex apps because symfony/symfony isn't installed by default (only components are) but PRs must be opened against the monolithic repository.

This tiny tool, inspired by npm link, scan the vendor/ directory of the project, and replace symfony/ dependencies by symlinks to the local clone of the symfony/symfony repositories.

Usage:

git clone git@github.com:symfony/symfony.git
cd symfony
./link /path/to/the/project

nicolas-grekas · 2017-10-29T20:35:28Z

Could that be written in PHP, so that Windows user could use it easily also?

sroze

Definitely 👍. It helped me already!

nicolas-grekas · 2017-11-01T17:52:32Z

@dunglas ok to rewrite it in PHP?

dunglas · 2017-11-01T17:55:43Z

Yes I’ll try.

dunglas · 2017-11-04T18:48:26Z

@nicolas-grekas done.

I don't have a Windows computer. It would be nice that someone test the new version on this OS.

dunglas · 2017-11-04T18:49:35Z

link

+}
+
+$sfPackages = array();
+foreach (glob(__DIR__.'/src/Symfony/{Bundle,Bridge,Component}/*', GLOB_BRACE | GLOB_ONLYDIR | GLOB_NOSORT) as $dir) {


GLOB_BRACE doesn't work on some systems (Solaris), but I think it doesn't matter for this script.

lyrixx

May be we should put this binary in a bin/ folder?

lyrixx · 2017-11-08T17:20:41Z

link

+if ($argc < 2) {
+    echo 'Link dependencies to components to a local clone of the monolithic Symfony repository'.PHP_EOL.PHP_EOL;
+    echo 'Usage: link.php /path/to/the/project'.PHP_EOL;
+    exit;


exit(1); the usage is wrong.

lyrixx · 2017-11-08T17:21:54Z

link

+
+if ($argc < 2) {
+    echo 'Link dependencies to components to a local clone of the monolithic Symfony repository'.PHP_EOL.PHP_EOL;
+    echo 'Usage: link.php /path/to/the/project'.PHP_EOL;


the name of the file is link so Usage: php link /path/

dunglas · 2017-11-09T09:35:42Z

@lyrixx I've added this comment to the root directory for consistency with the phpunit script and because it's easier to find for a new contributor. But we can change that.

ro0NL

works like a charm! (ubuntu)

ro0NL · 2017-11-09T11:59:13Z

link

+}
+
+if (!is_dir("$argv[1]/vendor/symfony")) {
+    echo "The directory \"$argv[1]\" does not exist or the dependencies are not installed, did you forget to run \"composer install\" in your project?";


missing PHP_EOL?

given The directory "foo" does not exist or the dependencies are not installed, did you forget to run "composer install" in your project?user@docker:/some/path$

ro0NL · 2017-11-09T11:59:28Z

link

+    if (isset($sfPackages["symfony/$package"])) {
+        rename($dir, "$dir.back");
+        symlink($sfDir = $sfPackages["symfony/$package"], $dir);
+        echo "\"symfony/$package\" has been linked to \"$sfDir\".";


same.. missing EOL. Output is terrible ;-)

I update (I didn't noticed because I use ZSH 😛).

ro0NL · 2017-11-09T12:03:57Z

link

+
+    $package = basename($dir);
+    if (isset($sfPackages["symfony/$package"])) {
+        rename($dir, "$dir.back");


intended as .bak? https://en.wikipedia.org/wiki/Bak_file

Can/should we have an option to skip backup files, so no double classes are indexed in Phpstorm and such.

i'd prefer a ./link /some/path --backup, but also fine for a --no-backup :)

I don't care about the backup too.
Composer install is really fast when all packages are in cache

Same, I don't see the point of the backup. I'm always doing a rm -rf vendor/symfony/*.back as it also messes up PhpStorm...

It's not for the speed, it's just in case the developper has done some changes in the vendor (common when trying to debug something). Ok for the --no-backup flag.

but this fails when run twice

Oh... maybe after adding another dependency...

but this fails when run twice

No because the second time it will be skipped (the symlink will already exists)

Anyway I'm ok to remove the backup feature if nobody except me finds this hazardous :)

sroze

👍

fabpot · 2017-11-09T14:55:27Z

link

+ */
+
+if (2 !== $argc) {
+    echo 'Link dependencies to components to a local clone of the monolithic Symfony repository.' . PHP_EOL . PHP_EOL;


I would not use "monolithic Symfony repository" as that's not something we are using anywhere else. What about just "the main symfony/symfony Github repository"?

nicolas-grekas

(even on 3.3 as that's the lowest supported Flex)

ro0NL · 2017-11-11T15:51:26Z

@dunglas is it possible to create relative symlinks? That would be convenient with docker.

nicolas-grekas · 2017-11-11T15:53:35Z

@ro0NL technically yes, but not on Windows AFAIK, so there need to be special care here.

ro0NL · 2017-11-11T16:50:35Z

Rigth, but otherwise we could just exec ln -rs ... ... no? That seems to do it :)

nicolas-grekas · 2017-11-11T16:55:00Z

"symlink" works just fine on Linux and Windows, no need for "exec" at all.
The only diff is that the target on Windows has to be a full path.

dunglas · 2017-11-11T18:15:00Z

How does it work with Docker with relative links? You put symfony/symfony in your project’s volume?

What we can do is using relative links on Linux (for Docker) and absolute links on Windows.

ro0NL · 2017-11-11T18:29:18Z

You put symfony/symfony in your project’s volume?

Yep :) basically i mount my entire ~/dev dir on a generic container. So relative to that all paths remain the same.

What we can do is using relative links on Linux (for Docker) and absolute links on Windows.

Sounds good :) im not sure if generating a rel path is a hassle? hence i suggested ln -rs

nicolas-grekas · 2017-11-12T16:05:47Z

link

+        continue;
+    }
+
+    if (!isset($sfPackages[$package])) {


maybe add a message here: "Skipping ..., not a symfony/symfony package."?
also, should we make the script work with symfony/symfony? I'm sure it would help standard edition users.
Also wondering: where should we tell ppl that this script exists and when it should be used?

👍 for symlinking symfony/symfony as well. I think it fits the contributing section. That's what i'd use it for... cloning my symfony fork (so symlinks pointing here), adding symfony as 2nd upstream remote.

👎 for this "Skipping .. not a symfony package", it would be far too verbose and the output would be unreadable IMHO. If you really want to know, as a user, put a echo in the PHP script or something I'd say.

👍 for symfony/symfony tho

You can already rely on composer install --prefer-source for symfony/symfony.

given this tool requires you to have a centralized clone somewhere, it's tempting to link it to multiple projects and switch branches on the fly :) i dont know if thats a supported use case, but if so symfony/symfony should be detected IMHO.

You can already rely on composer install --prefer-source for symfony/symfony.

I do as @ro0NL: one repo for dev, never touch directly inside vendor

GromNaN · 2017-11-12T21:04:59Z

Does the same can be achevied with composer local path repository ? https://getcomposer.org/doc/05-repositories.md#path

ro0NL · 2017-11-15T10:08:05Z

@GromNaN yes, possible :) but i still think this script should work independent from composer.

derrabus · 2017-11-18T10:47:51Z

Works like a charm and it really saves the hack day for me. 👍

ro0NL · 2017-11-18T10:55:55Z

well.. no :)

linked on docker.. but i see if i can patch now :)

ro0NL · 2017-11-18T11:30:10Z

my use case is

$ pwd
/home/me/dev/symfony-src

$ run-on-docker ./link ../project

$sfDir = '/var/www/html/symfony-src/src/Symfony/Component/Debug';
$dir = '../project/vendor/symfony/debug';

for now i did

-    symlink($sfDir = $sfPackages[$package], $dir);
+    exec('ln -rs '.escapeshellarg($sfDir = $sfPackages[$package]).' '.escapeshellarg($dir));

debug -> ../../../symfony-src/src/Symfony/Component/Debug/

dunglas · 2017-11-18T13:15:30Z

@ro0NL why don't you run the link command from inside your container?

ro0NL · 2017-11-18T13:28:15Z

i do that 😉 i wrap docker run CMD

therefor i get /var/www/html/symfony-src/... targets, which should be /home/me/dev/symfony-src/... for the host

dunglas · 2017-11-18T13:38:59Z

@ro0NL ln -r is a (recent) GNU option, it doesn't work on Mac and BSD, and it looks like there is no easy alternative for those systems.

ro0NL · 2017-11-18T13:49:03Z

perhaps worth detecting availability... dunno. Or enable explicitly by link -r.

👍 for merging as is also.. i can change this manually now and then.

ostrolucky · 2017-11-18T14:39:09Z

Please merge with relative links support. We containerize each project we are working on and I believe lot of other people too. It will be very common use case.

dunglas · 2017-11-18T14:56:47Z

We don’t have a solution working both on Linux, BSD and Mac right now.

I suggest to merge this PR as is because it’s a pain to debug Flex apps without, then we can try to add relative links support in another PR.

ro0NL · 2017-11-18T19:44:30Z

We could simply include src/Symfony/Component/Filesystem/Filesystem.php. Using ->makePathRelative as well as ->symlink() perhaps.

I can confirm makePathRelative($sfDir, dirname(realpath($dir)) works (before doing rmdir($dir)).

inso · 2017-11-18T21:35:19Z

link

+
+if (2 !== $argc) {
+    echo 'Link dependencies to components to a local clone of the main symfony/symfony GitHub repository.'.PHP_EOL.PHP_EOL;
+    echo 'Usage: ./link /path/to/the/project'.PHP_EOL;


maybe echo "Usage: $argv[0] /path/to/the/project".PHP_EOL; should be used?

dunglas · 2017-11-18T22:13:31Z

@ro0NL good idea, the same trick was proposed by @lyrixx. It's implemented!

inso · 2017-11-18T22:31:31Z

link

+* file that was distributed with this source code.
+*/
+
+require 'src/Symfony/Component/Filesystem/Filesystem.php';


maybe require __DIR__.'/src/...' ?

inso · 2017-11-18T22:42:46Z

link

+* file that was distributed with this source code.
+*/
+
+require __DIR__.'src/Symfony/Component/Filesystem/Filesystem.php';


sorry, but it seems '/' is missing: __DIR__.'/src/

ro0NL

works otherwise 👍

ro0NL · 2017-11-19T09:09:41Z

link

+    exit(1);
+}
+
+$sfPackages = array('symfony' => __DIR__);


symfony/symfony

ro0NL

real nice 👍 (any reason to not merge into lowest maintained branch?)

dunglas · 2017-11-19T19:10:02Z

@ro0NL, no we'll merge it in the lowest branch directly using gh.

nicolas-grekas · 2017-11-20T18:07:27Z

link

+}
+
+$sfPackages = array('symfony/symfony' => __DIR__);
+foreach (glob(__DIR__.'/src/Symfony/{Bundle,Bridge,Component}/*', GLOB_BRACE | GLOB_ONLYDIR | GLOB_NOSORT) as $dir) {


missing Security sub-components: src/Symfony/{Bundle,Bridge,Component,Component/Security}/*

nicolas-grekas · 2017-11-20T18:08:51Z

👍 for merging this into 2.7, this is a tool for dev

nicolas-grekas · 2017-11-20T18:09:37Z

(squashing + rebasing before merging would be great)

nicolas-grekas · 2017-11-20T21:26:22Z

Thank you @dunglas.

This PR was merged into the 2.7 branch. Discussion ---------- Add a link script to ease debugging Flex apps | Q | A | ------------- | --- | Branch? | 3.4 | Bug fix? | no | New feature? | no  | BC breaks? | no | Deprecations? | no  | Tests pass? | yes | Fixed tickets | #24708 | License | MIT | Doc PR | n/a (Reopened because of mishandling in the previous PR) It's painful to debug and patch Flex apps because `symfony/symfony` isn't installed by default (only components are) but PRs must be opened against the monolithic repository. This tiny tool, inspired by `npm link`, scan the `vendor/` directory of the project, and replace `symfony/` dependencies by symlinks to the local clone of the `symfony/symfony` repositories. Usage: ``` git clone git@github.com:symfony/symfony.git cd symfony ./link /path/to/the/project ``` Commits ------- 381f5d1 Add a "link" script to ease debugging Flex apps

This PR was merged into the 2.7 branch. Discussion ---------- Add example usage of the link script Docs for symfony/symfony#24746. Commits ------- 6051229 Add example usage of the link script

carsonbot added the Status: Needs Review label Oct 29, 2017

carsonbot added Status: Reviewed and removed Status: Needs Review labels Oct 29, 2017

sroze approved these changes Oct 29, 2017

View reviewed changes

nicolas-grekas added this to the 3.4 milestone Oct 30, 2017

dunglas changed the title ~~Add a link.sh script to ease debugging Flex apps~~ Add a link script to ease debugging Flex apps Nov 4, 2017

dunglas commented Nov 4, 2017

View reviewed changes

lyrixx reviewed Nov 8, 2017

View reviewed changes

ro0NL reviewed Nov 9, 2017

View reviewed changes

ro0NL approved these changes Nov 9, 2017

View reviewed changes

sroze approved these changes Nov 9, 2017

View reviewed changes

fabpot reviewed Nov 9, 2017

View reviewed changes

nicolas-grekas approved these changes Nov 9, 2017

View reviewed changes

nicolas-grekas reviewed Nov 12, 2017

View reviewed changes

oallain approved these changes Nov 12, 2017

View reviewed changes

inso reviewed Nov 18, 2017

View reviewed changes

ro0NL reviewed Nov 19, 2017

View reviewed changes

link Outdated

exit(1);

}

$sfPackages = array('symfony' => __DIR__);

Copy link

Contributor

ro0NL Nov 19, 2017

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

symfony/symfony

dunglas force-pushed the linker branch from 6346926 to a8ab233 Compare November 19, 2017 16:15

ro0NL approved these changes Nov 19, 2017

View reviewed changes

nicolas-grekas reviewed Nov 20, 2017

View reviewed changes

Add a "link" script to ease debugging Flex apps

381f5d1

dunglas force-pushed the linker branch from a8ab233 to 381f5d1 Compare November 20, 2017 21:19

dunglas changed the base branch from 3.4 to 2.7 November 20, 2017 21:19

nicolas-grekas merged commit 381f5d1 into symfony:2.7 Nov 20, 2017

dunglas deleted the linker branch November 20, 2017 21:27

dunglas mentioned this pull request Nov 21, 2017

Add example usage of the link script symfony/symfony-docs#8730

Merged

ro0NL mentioned this pull request Dec 26, 2017

[RFC] New link command composer/composer#6940

Closed

jakubtobiasz mentioned this pull request Mar 25, 2024

add link script Sylius/Sylius#16045

Open

Add a link script to ease debugging Flex apps #24746

Add a link script to ease debugging Flex apps #24746

Conversation

dunglas commented Oct 29, 2017 • edited Loading

nicolas-grekas commented Oct 29, 2017 • edited Loading

sroze left a comment

Choose a reason for hiding this comment

nicolas-grekas commented Nov 1, 2017

dunglas commented Nov 1, 2017

dunglas commented Nov 4, 2017

Choose a reason for hiding this comment

lyrixx left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas commented Nov 9, 2017

ro0NL left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ro0NL Nov 9, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sroze Nov 9, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas Nov 9, 2017 • edited Loading

Choose a reason for hiding this comment

dunglas Nov 9, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sroze left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nicolas-grekas left a comment

Choose a reason for hiding this comment

ro0NL commented Nov 11, 2017

nicolas-grekas commented Nov 11, 2017

ro0NL commented Nov 11, 2017

nicolas-grekas commented Nov 11, 2017

dunglas commented Nov 11, 2017

ro0NL commented Nov 11, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dunglas Nov 12, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

GromNaN commented Nov 12, 2017

ro0NL commented Nov 15, 2017

derrabus commented Nov 18, 2017

ro0NL commented Nov 18, 2017

ro0NL commented Nov 18, 2017

dunglas commented Nov 18, 2017

ro0NL commented Nov 18, 2017

dunglas commented Nov 18, 2017

ro0NL commented Nov 18, 2017

ostrolucky commented Nov 18, 2017

dunglas commented Nov 18, 2017

ro0NL commented Nov 18, 2017

Choose a reason for hiding this comment

dunglas commented Nov 18, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ro0NL left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ro0NL left a comment

Choose a reason for hiding this comment

dunglas commented Nov 19, 2017 • edited Loading

Choose a reason for hiding this comment

nicolas-grekas commented Nov 20, 2017

nicolas-grekas commented Nov 20, 2017

nicolas-grekas commented Nov 20, 2017

dunglas commented Oct 29, 2017 •

edited

Loading

nicolas-grekas commented Oct 29, 2017 •

edited

Loading

ro0NL left a comment •

edited

Loading

ro0NL Nov 9, 2017 •

edited

Loading

sroze Nov 9, 2017 •

edited

Loading

dunglas Nov 9, 2017 •

edited

Loading

dunglas Nov 9, 2017 •

edited

Loading

dunglas Nov 12, 2017 •

edited

Loading

dunglas commented Nov 19, 2017 •

edited

Loading