8000 [Filesystem] Add third argument `$lockFile` to `Filesystem::appendToFile()` by fwolfsjaeger · Pull Request #43796 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[Filesystem] Add third argument $lockFile to Filesystem::appendToFile() #43796

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

Jump to bottom
Merged
merged 1 commit into from
Oct 28, 2021
Merged

[Filesystem] Add third argument $lockFile to Filesystem::appendToFile() #43796

merged 1 commit into from
Oct 28, 2021

Conversation

fwolfsjaeger
Copy link
Contributor
Q A
Branch? 5.4
Bug fix? no
New feature? yes
Deprecations? no
Tickets n/a
License MIT
Doc PR n/a

I have to set the LOCK_EX flag for file_put_contents() as I'm writing to the same file from parallel threads. Therefor I've added a third argument to Filesystem::appendToFile() named $flags.

@carsonbot carsonbot added this to the 5.4 milestone Oct 28, 2021
@carsonbot
Copy link
8000 carsonbot commented Oct 28, 2021

Hey!

I see that this is your first PR. That is great! Welcome!

Symfony has a contribution guide which I suggest you to read.

In short:

  • Always add tests
  • Keep backward compatibility (see https://symfony.com/bc).
  • Bug fixes must be submitted against the lowest maintained branch where they apply (see https://symfony.com/releases)
  • Features and deprecations must be submitted against the 5.4 branch.

Review the GitHub status checks of your pull request and try to solve the reported issues. If some tests are failing, try to see if they are failing because of this change.

When two Symfony core team members approve this change, it will be merged and you will become an official Symfony contributor!
If this PR is merged in a lower version branch, it will be merged up to all maintained branches within a few days.

I am going to sit back now and wait for the reviews.

Cheers!

Carsonbot

@derrabus
Copy link
Member

By accepting FILE_* flags, we would leak implementation details. I believe, locking the file while appending content to it might be a common use case, so we might as well add a boolean parameter for that.

@fwolfsjaeger fwolfsjaeger changed the title [Filesystem] Add third argument $flags to Filesystem::appendToFile() [Filesystem] Add third argument $lockFile to Filesystem::appendToFile() Oct 28, 2021
@fwolfsjaeger fwolfsjaeger force-pushed the filesystem-5.4 branch 2 times, most recently from 0663cb3 to 6c20d9d Compare October 28, 2021 10:16
derrabus
derrabus approved these changes Oct 28, 2021
View reviewed changes
Copy link
Member
@derrabus derrabus left a comment

Choose a reason for hiding this comment

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

Writing a test for this is probably difficult, isn't it. 🤔

@fwolfsjaeger
Copy link
Contributor Author

To test this you'd need 2 threads running in parallel, plus a write-operation that takes long enough to check if the file is locked in the second thread. I don't think this is doable with PHPUnit.

nicolas-grekas
nicolas-grekas approved these changes Oct 28, 2021
View reviewed changes
@nicolas-grekas
Copy link
Member

Thank you @fwolfsjaeger.

@nicolas-grekas nicolas-grekas merged commit cab3c11 into symfony:5.4 Oct 28, 2021
@fwolfsjaeger fwolfsjaeger deleted the filesystem-5.4 branch October 28, 2021 13:41
@nicolas-grekas nicolas-grekas mentioned this pull request Oct 28, 2021
Closed
This was referenced Nov 5, 2021
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@nicolas-grekas nicolas-grekas nicolas-grekas approved these changes

@derrabus derrabus derrabus approved these changes

@chalasr chalasr chalasr approved these changes

Assignees
No one assigned
Labels
Feature Filesystem Status: Reviewed
Projects
None yet
Milestone
5.4
Development

Successfully merging this pull request may close these issues.
5 participants
@fwolfsjaeger @carsonbot @derrabus @nicolas-grekas @chalasr
0