[2.1] Resource watcher component #391

everzet · 2011-03-25T19:24:17Z

As we've talked in this PR: #256, i've created new Symfony2 component with ability to track resource changes (both files and directories) with 2 basic strategies:

Inotify
Recursive state checking

Component supports them both and use best one by default (if inotify available - it will be used).
Usage example: https://gist.github.com/1406938

avalanche123 · 2011-03-25T19:24:40Z

👍

fabpot · 2011-03-25T19:38:37Z

src/Symfony/Component/ResourceWatcher/Event/EventListener.php

+     *
+     * @param   Event   $event
+     */
+    public function handles(Event $event)


should probably be renamed to supports to be consistent with other parts of the framework.

agree. Changed!

fabpot · 2011-03-25T19:53:29Z

Do we need a standalone component or does it belong to the Config one?

everzet · 2011-03-25T20:00:32Z

I don't think it belongs to Config component. If we had separate Resource component with FileResource and DirectoryResource in it, then ResourceWatcher definetly would have to be part of it. But as part of Config it doesn't make sense to me, cuz it has almost nothing to do with configs itself - ResourceWatcher's functionality is more general.

fabpot · 2011-03-28T14:36:56Z

This feature will be considered for 2.1.

Tell me if there is anything we can do in the current code to ease this addition.

everzet · 2011-03-28T14:40:47Z

Fair enough :-) So, i will keep this PR opened to not forget about it?

everzet · 2011-03-28T14:43:24Z

The one possible change i would propose is moving *Resource-classes into separate Resource component. Because i really don't think, that resources belongs only to Config component - they used in many places and with ResourceWatcher would make sense as standalone filesystem abstraction component. What do you think?

stof · 2011-09-04T13:15:33Z

@everzet @fabpot what is the status of this PR ?

stof · 2011-10-16T18:04:44Z

@fabpot @everzet up

everzet · 2011-10-24T10:51:46Z

@stof needs some things to be fixed and merged. Hopefully will be able to work on it next week :-/

stof · 2011-11-11T14:57:33Z

@everzet any news ?

everzet · 2011-11-13T22:50:37Z

@stof too busy with move preparations. Will try to update this PR in the train to Nantes ;-)

simensen · 2011-11-17T16:34:13Z

The one possible change i would propose is moving *Resource-classes into separate Resource component. Because i really don't think, that resources belongs only to Config component - they used in many places and with ResourceWatcher would make sense as standalone filesystem abstraction component. What do you think?

I actually like this idea. My first pass at trying to figure out the Config component had me wondering why the Resource stuff was in there and not in a more generic place. There are a lot of things there that could be useful in a generic sense that don't have anything to do with configuration other than the fact that Config uses it to do its work.

stof · 2011-11-17T17:03:36Z

@simensen When introducing the Config component, there was not all the Config\Definition stuff. Only the parts related to loading some resources.

everzet · 2011-11-21T16:09:37Z

Almost finished huge refactoring of RecursiveIterator and it's testing on top of rebased API. Will finish this PR thursday-friday.

this is a basic state checker, which checks all files and directories recursively for changes

this resources tracker uses recursive iterator state checker internally

if no tracker were specified in watcher constructor it will use best one (inotify if available and rec otherwise)

…istent with other parts of the framework.

…FilteredChilds method

everzet · 2011-11-30T09:59:08Z

There's a discussion about using EventDispatcher inside this component:
https://gist.github.com/1406938

everzet · 2011-11-30T15:49:31Z

We've agreed on EventDispatcher integration and trackingID parameter for track() (https://gist.github.com/1406938#gistcomment-66197). Anyone have thoughts?

…ist yet * fixed DELETED event when starting to watch a file that does not exist yet * fixed files that are deleted and then re-created

fabpot · 2011-12-05T14:51:04Z

@everzet: I have fixed some small issues here: everzet:resource-watcher-component...PR-391

fabpot · 2011-12-05T15:09:55Z

I've just tested inotify support and there are some issues. I will have to investigate further.

everzet · 2011-12-05T16:16:31Z

@fabpot ok. I'll merge your changes this evening.

everzet · 2011-12-06T00:49:17Z

Merged.

stof · 2011-12-12T20:39:35Z

@everzet @fabpot what's the state of this PR ?

fabpot · 2011-12-13T14:56:15Z

I have tested it and it works fine. I still need to work on it to be sure that the features are the same for both the plain PHP implementation and the inotify implementation (I fear that this is not the case right now).

fabpot · 2011-12-30T13:34:57Z

After working a bit more with the code, it's definitely not ready for merge. Before merging, we need to work on the following topics:

add more tests for the Trackers (to be sure that all implementation work in the same way) -- I have added the basic structure in the symfony/PR-291 branch.
probably change/tweak the current Event names based on the ones from inotify (http://en.wikipedia.org/wiki/Inotify)
add support for the EventDispatcher as mentioned above

everzet · 2011-12-30T14:08:48Z

@fabpot agree. Will work on EventDispatcher integration and events refactoring.

burn2delete · 2012-03-15T18:20:53Z

Just wondering if this has been updated to work wirth 2.1 yet? Or if it will even get in? I see alot of potential for a component like this!!!

alvarezmario · 2012-03-15T19:09:26Z

@everzet said on twitter the he will try to finish the component, to be included in the 2.1 release and @fabpot was agree. So I guess we just have to wait.

dlsniper · 2012-03-25T20:03:27Z

I could help with coding of this component if needed, someone like @fabpot or @everzet please let me know what's left to do for this and if I should do anything for it.

Kind regards.

stof · 2012-04-04T02:22:56Z

@everzet the branch needs to be rebased as it conflicts. And tests needs to be moved.

@everzet @fabpot what is missing here to be able to merge it ?

everzet · 2012-04-04T10:32:22Z

@stof multiplatform test suite, EventDispatcher integration and event instances refactoring

i'll try to finish/rebase it this week

everzet · 2012-04-16T14:03:40Z

Closed if favor of newly created #3961

Update version constraint on simplesamlphp/simplesamlphp/2018-12-20.yaml

fabpot reviewed Mar 25, 2011
View reviewed changes

everzet added 15 commits November 25, 2011 14:50

[ResourceWatcher] resource change event created

55cc03b

[ResourceWatcher] resource event listener interface described

9eec6a1

[ResourceWatcher] created basic resource event listener object

2435265

[ResourceWatcher] resource state checker interface described

27afac8

[ResourceWatcher] created recursive iterator resource state checker

d1249df

this is a basic state checker, which checks all files and directories recursively for changes

[ResourceWatcher] resources tracker interface described

c8bfa18

[ResourceWatcher] recursive iterator resources tracker created

73b3ea0

this resources tracker uses recursive iterator state checker internally

[ResourceWatcher] resource watcher object created

150bc5a

[ResourceWatcher] inotify tracker added

f78ff91

[ResourceWatcher] use best tracker by default

fe664a6

if no tracker were specified in watcher constructor it will use best one (inotify if available and rec otherwise)

[ResourceWatcher] renamed Event::handes to Event::supports to be cons…

d40d2e0

…istent with other parts of the framework.

[ResourceWatcher] fixed non-empty directory events

d661a16

[Config] updated resources API to be more explicit

dcb58fa

[Config] moved DirectoryResource childs retrieving to the special get…

d9b88bd

…FilteredChilds method

[ResourceWatcher] cleaned code little bit

62a116d

[ResourceWatcher] return of the InotifyTracker

51172e2

fabpot added 5 commits December 5, 2011 13:46

[ResourceWatcher] removed unneeded code

f0f9fd9

[ResourceWatcher] added an exception when inotify is not available

cb8a3d1

[Config] made ResourceInterface extends Serializable

879ddff

[ResourceWatcher] removed dead code

a62c413

[ResourceWatcher] added the possibility to watch files that do not ex…

fbb5849

…ist yet * fixed DELETED event when starting to watch a file that does not exist yet * fixed files that are deleted and then re-created

fabpot added 2 commits December 29, 2011 15:42

[ResourceWatcher] added exception classes for the component

51b8613

-

11611e9

weaverryan mentioned this pull request Mar 25, 2012

[ResourceWatcher] Bootstrapped documentation symfony/symfony-docs#1180

Closed

khepin mentioned this pull request Mar 27, 2012

[Translator] Does not track changes to files without clearing the cache in dev env #3653

Closed

everzet mentioned this pull request Apr 16, 2012

[2.2] [WIP] ResourceWatcher component refactored #3961

Closed

everzet closed this Apr 16, 2012

everzet mentioned this pull request Jun 18, 2012

[2.2] ResourceWatcher component (final?) #4605

Closed

jderusse pushed a commit to jderusse/symfony that referenced this pull request Mar 30, 2020

Merge pull request symfony#391 from bradjones1/patch-1

937d6eb

Update version constraint on simplesamlphp/simplesamlphp/2018-12-20.yaml

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2.1] Resource watcher component #391

[2.1] Resource watcher component #391

everzet commented Mar 25, 2011

avalanche123 commented Mar 25, 2011

fabpot Mar 25, 2011

everzet Mar 25, 2011

fabpot commented Mar 25, 2011

everzet commented Mar 25, 2011

fabpot commented Mar 28, 2011

everzet commented Mar 28, 2011

everzet commented Mar 28, 2011

stof commented Sep 4, 2011

stof commented Oct 16, 2011

everzet commented Oct 24, 2011

stof commented Nov 11, 2011

everzet commented Nov 13, 2011

simensen commented Nov 17, 2011

stof commented Nov 17, 2011

everzet commented Nov 21, 2011

everzet commented Nov 30, 2011

everzet commented Nov 30, 2011

fabpot commented Dec 5, 2011

fabpot commented Dec 5, 2011

everzet commented Dec 5, 2011

everzet commented Dec 6, 2011

stof commented Dec 12, 2011

fabpot commented Dec 13, 2011

fabpot commented Dec 30, 2011

everzet commented Dec 30, 2011

burn2delete commented Mar 15, 2012

alvarezmario commented Mar 15, 2012

dlsniper commented Mar 25, 2012

stof commented Apr 4, 2012

everzet commented Apr 4, 2012

everzet commented Apr 16, 2012

[2.1] Resource watcher component #391

[2.1] Resource watcher component #391

Conversation

everzet commented Mar 25, 2011

avalanche123 commented Mar 25, 2011

fabpot Mar 25, 2011

Choose a reason for hiding this comment

everzet Mar 25, 2011

Choose a reason for hiding this comment

fabpot commented Mar 25, 2011

everzet commented Mar 25, 2011

fabpot commented Mar 28, 2011

everzet commented Mar 28, 2011

everzet commented Mar 28, 2011

stof commented Sep 4, 2011

stof commented Oct 16, 2011

everzet commented Oct 24, 2011

stof commented Nov 11, 2011

everzet commented Nov 13, 2011

simensen commented Nov 17, 2011

stof commented Nov 17, 2011

everzet commented Nov 21, 2011

everzet commented Nov 30, 2011

everzet commented Nov 30, 2011

fabpot commented Dec 5, 2011

fabpot commented Dec 5, 2011

everzet commented Dec 5, 2011

everzet commented Dec 6, 2011

stof commented Dec 12, 2011

fabpot commented Dec 13, 2011

fabpot commented Dec 30, 2011

everzet commented Dec 30, 2011

burn2delete commented Mar 15, 2012

alvarezmario commented Mar 15, 2012

dlsniper commented Mar 25, 2012

stof commented Apr 4, 2012

everzet commented Apr 4, 2012

everzet commented Apr 16, 2012