[Filesystem] Fixed makePathRelative #22321

ausi · 2017-04-06T18:37:17Z

Q	A
Branch?	2.7
Bug fix?	yes
New feature?	no
BC breaks?	no
Deprecations?	no
Tests pass?	yes
Fixed tickets	n/a
License	MIT
Doc PR	n/a

Updating to Symfony 3.2.7 @agoat noticed a bug with Filesystem::makePathRelative() in contao/core-bundle#751:

In Symfony 3.2.6 makePathRelative('aa/cc', 'bb/cc') returned correctly ../../aa/cc
In Symfony 3.2.7 the same method call returns ./

I think this issue was introduced with #22133.

While working on the fix I noticed some other issues too:

An unnecessary if construct that did nothing, fc745f4
Missing normalization of ./ path segments, 15982d4
../ got ignored at the beginning of relative paths, 9586e88
The documentation of the method only allowed absolute paths, but there are already unit tests (FilesystemTest.php:1097) that test the behavior of relative paths, cec473e

This pull request fixes all these issues and adds tests for them.

If `0 === $depth` evaluates to true `str_repeat('../', $depth)` would result in the empty string anyway, so there is no need to handle this case.

agoat · 2017-04-06T20:15:03Z

+1

LinkingYou · 2017-04-06T21:48:46Z

+1

xabbuh · 2017-04-07T12:25:23Z

src/Symfony/Component/Filesystem/Filesystem.php

-     * @param string $endPath   Absolute path of target
-     * @param string $startPath Absolute path where traversal begins
+     * @param string $endPath   Path of target
+     * @param string $startPath Path where traversal begins


This is a BC break. The method expects the paths to be absolute as documented.

Well, then this should definitely be mentioned in the documentation. There's no hint that only absolute paths are targeted besides this inline doc comment.

Why is this a BC break? Absolute paths work the same way as they did before.

Relative paths worked in the past and there are already unit tests (FilesystemTest.php:1097) that test the behavior of relative paths, so I think they should be allowed in the documentation of the method.

If relative paths should not be supported, I think we would have to throw an exception if a relative path gets passed, but that would be a BC break I think.

It should support relative paths for some reasons:

It worked before 3.2.7!

Absolute paths will still work (No BC break).

As @loilo mentioned, the documentation doesn't tell that only absolute paths can be used.

It makes life easier (Otherwise everyone have to do extra checks on absolute paths, before using this method).

I didn't see that test case initially. I'm this case, we IMO should indeed support this and update the docblock as suggested. But I think we should indeed think about deprecating this behaviour.

Adding the “Absolute” back should then be part of #24202 I think. Otherwise I would have to remove the unit tests as @chalasr wrote in #22321 (comment)

I see it different here: "Absolute" should still be part of the docblock to make our intent clear that we want this method to receive absolute paths. People who not look at the tests do not need to know that this currently works with relative paths too.

@chalasr explicitly wrote:

Tests should respect the contract which is to pass an absolute path.

Please discuss this with @chalasr first. I don’t want to change this pull request every two weeks. If you both agree, I can change the doccomment to whatever you want :)

Just discussed with @xabbuh and we come to the conclusion that the docblock clearly states the passed path must be absolute, that has been decided when introducing the method and should not be changed now.
Given we have a test in place for relative paths, let's improve the current implementation regarding relative paths as done here, so we can officially deprecate passing relative paths to the method in #24202 (or officially support any path, changing the docblock, but I don't think it's the right direction as currently discussed on the PR) and move forward.

I restored the original doccomment in 193cdf8 now.
@chalasr @xabbuh is this pull request now ready to be approved?

xabbuh · 2017-04-07T12:26:30Z

src/Symfony/Component/Filesystem/Tests/FilesystemTest.php

@@ -878,6 +879,17 @@ public function providePathsForMakePathRelative()
            array('C:/aa/bb/../../cc', 'C:/aa/../dd/..', 'cc/'),
            array('C:/../aa/bb/cc', 'C:/aa/dd/..', 'bb/cc/'),
            array('C:/../../aa/../bb/cc', 'C:/aa/dd/..', '../bb/cc/'),
+            array('aa/bb', 'aa/cc', '../bb/'),


This is not something that is supported. The docblock states that the paths have to be absolute.

There was already an existing unit test (FilesystemTest.php:1097) that tested relative paths.

Let's not add new ones. Tests should respect the contract which is to pass an absolute path.

@chalasr the function always supported relative paths (before 3.2.7). There are even pre-existing test cases for that.

Tests should respect the contract which is to pass an absolute path.

@chalasr Should I remove the pre-existing relative path tests then too? Or should I just remove the relative path tests that I added?

Can you please provide a new link to this test? Previous one is outdated and I can't find it

Yes, it’s line 1102 in the current master branch:

symfony/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php

Line 1102 in 8088661

array('var/lib/symfony/', 'var/lib/symfony/src/Symfony/Component', '../../../'),

Indeed, it should be removed (we did revert a similar test for the very same reason #22133 (comment)). It's safe to do it here I think.

Done in a2a1d0d

@chalasr Actually, the example that you gave was a test I mistakenly added in that very same PR. So it was never part of a merge. :)

xabbuh · 2017-04-09T09:01:12Z

src/Symfony/Component/Filesystem/Filesystem.php

@@ -358,34 +358,37 @@ public function makePathRelative($endPath, $startPath)
            $startPath = str_replace('\\', '/', $startPath);
        }

+        $stripDriveLetter = function ($path) {
+            if (strlen($path) > 2 && substr($path, 1, 2) === ':/' && ctype_alpha($path[0])) {


instead of substr() I suggest to use ':' === $path[1] && '/' === $path[2]

I used substr() because it’s done that way in isAbsolutePath() Filesystem.php:587. Should I change it though?

Should I change the substr() to ':' === $path[1] && '/' === $path[2] to get this pull request approved?

👍 for @xabbuh's suggestion

Done in bce33c4

ausi · 2017-06-09T09:39:14Z

@xabbuh any updates on this? Can I do something to get this bugfix merged?

robfrawley · 2017-06-10T02:47:04Z

Overall, I love the bug fixes introduced in this PR with regard to relative paths. That said, it seems weird to allow empty input and expect any meaningful output.

Start	End	Expected
`""`	`""`	`"./"`
`"aa/"`	`""`	`"../"`
`""`	`"aa/"`	`"aa/"`

Does this really make sense? Should passing empty strings be deprecated? I wouldn't say that most people would expect these outputs and it would likely just hide a bug within their API usage, IMHO.

ausi · 2017-06-10T08:13:08Z

I think it should be allowed to pass an empty string. If "aa/" is a valid path then "" should be too, otherwise every developer that uses this method has to handle empty strings themselves. Your three examples are prefectly fine for me, did you expect any different output?

But I think there are cases that cannot produce a meaningful result, like start "../../" and end "../". For these cases it might make sense to throw an exception.

ausi · 2017-08-07T12:23:00Z

Is there anything I can do to get these fixes merged?

chalasr · 2017-08-08T22:55:55Z

src/Symfony/Component/Filesystem/Filesystem.php

-     * @param string $endPath   Absolute path of target
-     * @param string $startPath Absolute path where traversal begins
+     * @param string $endPath   Path of target
+     * @param string $startPath Path where traversal begins


This should be reverted, if we have to support it fully that should be discussed separately and done on 3.4, as said above.

chalasr · 2017-08-08T22:59:19Z

src/Symfony/Component/Filesystem/Tests/FilesystemTest.php

@@ -878,6 +879,17 @@ public function providePathsForMakePathRelative()
            array('C:/aa/bb/../../cc', 'C:/aa/../dd/..', 'cc/'),
            array('C:/../aa/bb/cc', 'C:/aa/dd/..', 'bb/cc/'),
            array('C:/../../aa/../bb/cc', 'C:/aa/dd/..', '../bb/cc/'),
+            array('aa/bb', 'aa/cc', '../bb/'),


Let's not add new ones. Tests should respect the contract which is to pass an absolute path.

This reverts commit cec473e.

xabbuh · 2017-08-10T07:05:40Z

Does the PR now still solve anything at all? I miss a new test case that would fail otherwise.

ausi · 2017-08-10T07:09:34Z

Yes, it still solves all the issues described in the initial issue comment. Especially the BC break that was introduced in 3.2.7. I removed the test cases because @chalasr requested that I should add them in a feature pull request for version 3.4.

xabbuh · 2017-08-10T07:17:56Z

Well, but it doesn't make sense to introduce a bugfix that in fact implements a feature that should be part of 3.4. So we need to decide whether not fully supporting relative path arguments was a BC break (because we had tests for relative paths despite the API docs telling the opposite) or if that is a new feature. And then there should be one PR containing proper tests for what the code change does achieve.

ping @symfony/deciders

ausi · 2017-08-10T07:36:24Z

I agree, that’s why my pull request included the doccomment change and the tests in the first place.

IMO the “feature” that relative paths are supported was always there (including a unit test) and got broken in 3.2.7.

Should I remove 193cdf8 and a2a1d0d from this pull request?

kubawerlos · 2017-08-10T13:01:36Z

src/Symfony/Component/Filesystem/Tests/FilesystemTest.php

@@ -845,7 +845,6 @@ public function providePathsForMakePathRelative()
            array('/var/lib/symfony/src/Symfony/', '/var/lib/symfony/src/Symfony/Component/', '../'),


Can we have simple case array('aa', 'bb', '../aa/'), as this is example of what installRequirementsFile from Sensio\Bundle\DistributionBundle\Composer\ScriptHandler is breaking in composer script in latest Symfony?

Yes, this does work with my fixes. But if relative paths should be supported at all is currently in discussion as you can see in the comments of this pull request.

xelaris · 2017-08-14T22:48:00Z

As mentioned by @kubawerlos the SensioDistributionBundle relies on support for relative paths, when calling Filesystem::makePathRelative with symfony-var-dir and symfony-bin-dir from the extra settings in the composer.json (usually "var" and "bin").
When composer 1.5.0 was released a week ago, the version of symfony/filesystem included changed from v2.8.18 to v2.8.26. Since then the SensioDistributionBundle generates wrong require statements for SymfonyRequirements.php. Corresponding issues (sensiolabs/SensioDistributionBundle#324 and composer/composer#6599) were created in these repositories.

ausi · 2017-09-10T10:01:33Z

So there are already two known projects that got broken because of this issue. Wouldn’t it make sense to merge this?

Should I remove 193cdf8 and a2a1d0d from this pull request?

I removed these commits now from this pull request.

kubawerlos · 2017-09-10T11:56:24Z

Haven't been tracing this, but in Symfony 3.3.8 it's back to correct paths.

ausi · 2017-09-10T15:51:08Z

@kubawerlos I don’t see any change to the makePathRelative() method since version 3.2.7, could you point to the commit where it got fixed?

What is the result of makePathRelative('aa/cc', 'bb/cc') in your installation?

kubawerlos · 2017-09-10T16:12:33Z

@ausi just found it, it was fixed directly in SensioDistributionBundle, so the problem still exists here.

ausi · 2017-09-16T16:07:41Z

@chalasr your review status still shows up as “requested changes”, are there any changes I’ve forgotton?

fabpot · 2017-09-17T15:15:08Z

Thank you @ausi.

@agoat

This PR was squashed before being merged into the 2.7 branch (closes #22321). Discussion ---------- [Filesystem] Fixed makePathRelative | Q | A | ------------- | --- | Branch? | 2.7 | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | n/a | License | MIT | Doc PR | n/a Updating to Symfony 3.2.7 @agoat noticed a bug with `Filesystem::makePathRelative()` in contao/core-bundle#751: - In Symfony 3.2.6 `makePathRelative('aa/cc', 'bb/cc')` returned correctly `../../aa/cc` - In Symfony 3.2.7 the same method call returns `./` I think this issue was introduced with #22133. While working on the fix I noticed some other issues too: - An unnecessary if construct that did nothing, fc745f4 - Missing normalization of `./` path segments, 15982d4 - `../` got ignored at the beginning of relative paths, 9586e88 - The documentation of the method only allowed absolute paths, but there are already unit tests ([FilesystemTest.php:1097](https://github.com/symfony/symfony/blob/ab93feae3f9a16c4f18c5736435d18fa36338d2c/src/Symfony/Component/Filesystem/Tests/FilesystemTest.php#L1097)) that test the behavior of relative paths, cec473e This pull request fixes all these issues and adds tests for them. Commits ------- 2bc1150 [Filesystem] Fixed makePathRelative

ausi added 5 commits April 6, 2017 20:04

Remove unnecessary if construct

fc745f4

If `0 === $depth` evaluates to true `str_repeat('../', $depth)` would result in the empty string anyway, so there is no need to handle this case.

Do not strip the beginning of relative paths, only drive letters

3a29c1d

Normalize ./ path segments

15982d4

Do not strip ../ segments from the beginning of relative paths

9586e88

Fix parameter description

cec473e

carsonbot added Status: Needs Review Bug labels Apr 6, 2017

ausi mentioned this pull request Apr 6, 2017

Contao not working with Symfony 3.2.7 contao/core-bundle#751

Closed

ausi changed the title ~~Fix/make path relative~~ [Filesystem] Fixed makePathRelative Apr 6, 2017

agoat mentioned this pull request Apr 6, 2017

Use the same path roots when calling makePathRelative contao/core-bundle#752

Merged

leofeyer approved these changes Apr 7, 2017

View reviewed changes

ausi added 3 commits April 7, 2017 09:00

Fixed compatibility with PHP 5.3

1b795d7

Fixed coding style

fea3bb0

Fixed compatibility with PHP 5.3

28b29ee

ausi mentioned this pull request Apr 7, 2017

Breaking Change introduced in Symonfy Filesystem #22328

Closed

nicolas-grekas added this to the 2.7 milestone Apr 7, 2017

xabbuh requested changes Apr 7, 2017

View reviewed changes

leofeyer mentioned this pull request Apr 7, 2017

[Filesystem] normalize paths before making them relative #22133

Merged

xabbuh reviewed Apr 9, 2017

View reviewed changes

chalasr requested changes Aug 8, 2017

View reviewed changes

Revert "Fix parameter description"

193cdf8

This reverts commit cec473e.

kubawerlos reviewed Aug 10, 2017

View reviewed changes

xelaris mentioned this pull request Aug 14, 2017

After update 1.4.2 → 1.5.1 in Symfony some script is broken composer/composer#6599

Closed

ausi force-pushed the fix/make-path-relative branch from a2a1d0d to 28b29ee Compare September 10, 2017 09:56

ausi referenced this pull request in sensiolabs/SensioDistributionBundle Sep 13, 2017

fixed makePathRelative usage

bf582cc

xabbuh mentioned this pull request Sep 14, 2017

[Filesystem] deprecate relative paths in makePathRelative() #24202

Merged

ausi added 2 commits September 14, 2017 17:10

Don’t use substr()

bce33c4

Coding style

23b4a56

xabbuh approved these changes Sep 15, 2017

View reviewed changes

fabpot approved these changes Sep 17, 2017

View reviewed changes

fabpot closed this Sep 17, 2017

This was referenced Oct 5, 2017

Release v2.7.35 #24450

Merged

Release v2.8.28 #24451

Merged

Release v3.3.10 #24452

Merged

		@@ -845,7 +845,6 @@ public function providePathsForMakePathRelative()
		array('/var/lib/symfony/src/Symfony/', '/var/lib/symfony/src/Symfony/Component/', '../'),

[Filesystem] Fixed makePathRelative #22321

[Filesystem] Fixed makePathRelative #22321

Conversation

ausi commented Apr 6, 2017 • edited Loading

agoat commented Apr 6, 2017

LinkingYou commented Apr 6, 2017

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

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

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

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

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

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

Choose a reason for hiding this comment

ausi commented Jun 9, 2017

robfrawley commented Jun 10, 2017

ausi commented Jun 10, 2017

ausi commented Aug 7, 2017

chalasr Aug 8, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xabbuh commented Aug 10, 2017

ausi commented Aug 10, 2017

xabbuh commented Aug 10, 2017

ausi commented Aug 10, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

xelaris commented Aug 14, 2017

ausi commented Sep 10, 2017

kubawerlos commented Sep 10, 2017

ausi commented Sep 10, 2017

kubawerlos commented Sep 10, 2017

ausi commented Sep 16, 2017

fabpot commented Sep 17, 2017

ausi commented Apr 6, 2017 •

edited

Loading

chalasr Aug 8, 2017 •

edited

Loading