[2.2] ResourceWatcher component (final?) #4605

everzet · 2012-06-18T10:15:11Z

Bug fix: no
Feature addition: yes
Backwards compatibility break: no
Symfony2 tests pass: yes
Fixes the following tickets: -

This is final rebased version of #3961, which was a refactoring of #391

Short overview

This component is here for tracking filesystem changes. You're registering directory or file resources to track with specific track name (tracking_id) and start() watcher. Watcher checks for FS changes after specific timespan and if some change occur (file/directory create/update/delete) - watcher dispatches EventDispatcher event with resource_watcher.all, resource_watcher.tracking_id names and FilesystemEvent as argument.

Usage

Simplest possible way of FS tracking

Simplest tracking code would look like this:

<?php

$watcher = new Symfony\Component\ResourceWatcher\ResourceWatcher;

// track for any change inside `config` subfolder:
$watcher->trackByListener(__DIR__.'/config', function($event) {
    echo $event->getTypeString().': '.(string) $event->getResource();
});

// start listening
$watcher->start();

best suitable Tracker and EventDispatcher would be instantiated for you, implicitly

`track()` method

Extended usage looks like that:

<?php

use Symfony\Component\EventDispatcher\EventDispatcher;
use Symfony\Component\ResourceWatcher;
use Symfony\Component\Config\Resource;

$dispatcher = new EventDispatcher;
$tracker = new ResourceWatcher\Tracker\RecursiveIteratorTracker;
$watcher = new ResourceWatcher\ResourceWatcher($tracker, $dispatcher);

// track for any change in `view` subfolder to `twig.templates` tracker:
$watcher->track('twig.templates', __DIR__.'/view');

// track for `*.xml` files creations in `config` subfolder to `routing` tracker:
$watcher->track(
    'routing',
    Resource\DirectoryResource(__DIR__.'/config', '/\.xml$/'),
    ResourceWatcher\Event\FilesystemEvent::CREATE
);

// add `routing` track listener:
$dispatcher->addListener('resource_watcher.routing', function($event) {
    echo $event->getTypeString().': '.(string) $event->getResource();
});

// add all tracks listener (listens to every tracked event):
$dispatcher->addListener('resource_watcher.all', function($event) {
    echo $event->getTypeString().': '.(string) $event->getResource();
});

// start listening
$watcher->start();

`addListener()` method

If you don't want to deal with EventDispatcher, ResourceWatcher can hide this detail for you:

<?php

use Symfony\Component\ResourceWatcher;
use Symfony\Component\Config\Resource;

$tracker = new ResourceWatcher\Tracker\RecursiveIteratorTracker;
$watcher = new ResourceWatcher\ResourceWatcher($tracker);

// track for any change in `view` subfolder to `twig.templates` tracker:
$watcher->track('twig.templates', __DIR__.'/view');

// track for `*.xml` files creations in `config` subfolder to `routing` tracker:
$watcher->track(
    'routing',
    Resource\DirectoryResource(__DIR__.'/config', '/\.xml$/'),
    ResourceWatcher\Event\FilesystemEvent::CREATE
);

// add `routing` track listener:
$watcher->addListener('routing', function($event) {
    echo $event->getTypeString().': '.(string) $event->getResource();
});

// add all tracks listener (listens to every tracked event):
$watcher->addListener('all', function($event) {
    echo $event->getTypeString().': '.(string) $event->getResource();
});

// start listening
$watcher->start();

travisbot · 2012-06-18T10:32:13Z

This pull request fails (merged ba39a816 into 0b8b76b).

travisbot · 2012-06-18T10:42:24Z

This pull request fails (merged 22af887b into 0b8b76b).

kriswallsmith · 2012-06-18T13:00:08Z

src/Symfony/Component/ResourceWatcher/composer.json

+    "require": {
+        "php":                       ">=5.3.3",
+        "symfony/config":            "self.version",
+        "symfony/event-dispatcher":  "self.version"


Can these versions be more specific? This component may be going into 2.2, but does it require the 2.2 version of these deps?

Nice catch. Nope for event-dispatcher, but yest for config, as PR provides couple of commits into Config.

Hmmm. So, for symfony/config it should stay self.version, IMO.
But what constraint we should put for symfony/event-dispatcher? >=2.1.0, @stof @fabpot ?

I think you can use 2.0 unless you use $event->getName(), which was added in 2.1.

symfony/event-dispatcher@2.0...master

Currently, all Symfony2 components are requiring self.version for the other components to simplify the management of the composer.json files. As long as all components are released together, this works.

and for your suggestion, requiring >=2.1.0 is wrong anyway. It would mark it as compatible with Symfony 4.2 too, which is wrong as nobody can know what such version will be if it exists.

@stof so, we should keep it as it is now (self.version), you think?

@everzet until we change the way it works for all components, yes

ok :) @kriswallsmith ?

👍 for moving away from self.version but I understand these things take time

kriswallsmith · 2012-06-18T13:01:33Z

I'm very excited about this component. Thank you everyone who has worked on it.

travisbot · 2012-06-18T13:45:00Z

This pull request passes (merged 5cbb9e75 into 0b8b76b).

fabpot · 2012-06-19T14:36:05Z

@everzet Can you make another PR for the Config component changes so that I can merge that part into Symfony 2.1? Thanks.

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

… classes

…w state checkers

… it yet

…urces

…heir own method.

…ource->exists()` check

… myself.

Makes sure that directory and the file resources with the same name will have different ids

file resource existence check shouldn't return true if there's directory with same name instead of file.

travisbot · 2012-06-20T08:15:28Z

This pull request passes (merged d1a7fcb into 092b5dd).

everzet · 2012-06-20T08:23:49Z

@fabpot @stof #4619

adrienbrault · 2012-06-20T16:05:33Z

src/Symfony/Component/ResourceWatcher/StateChecker/NewDirectoryStateChecker.php

+    protected function createDirectoryChildCheckers(DirectoryResource $resource)
+    {
+        $checkers = array();
+        foreach ($resource->getFilteredResources() as $resource) {


Isn't array_map more appropriate here ?

It is, but it doesn't really matter :)

stof · 2012-10-13T17:13:12Z

@fabpot @everzet what is the status of this PR ?
@everzet it needs a rebase

stof · 2012-10-13T17:13:55Z

btw, merging it will require fixing the serialization of the resource in AsseticBundle. Currently, it serializes far too much things.

fabpot · 2012-10-13T18:08:03Z

#4619 should be fixed before we can merge this PR.

webmozart · 2013-03-17T20:51:12Z

ping @fabpot

ghost · 2013-04-06T19:04:44Z

will this make 2.3?

stof · 2013-05-17T12:49:14Z

This code has been moved to a separate library: https://github.com/henrikbjorn/Lurker

Reusing the existing resources was causing issues as the component has different needs (see the changes done here on one hand and the discussion about config resources on the other hand). Keeping the config resources with their current purpose will make things easier.

I'm closing this PR in favor of Lurker. People wanting this feature can get Lurker through Composer (even in their 2.2 projects)

everzet mentioned this pull request Jun 18, 2012

[2.2] [WIP] ResourceWatcher component refactored #3961

Closed

kriswallsmith reviewed Jun 18, 2012
View reviewed changes

everzet added 22 commits June 20, 2012 10:08

[ResourceWatcher] resource change event created

f4f97fe

[ResourceWatcher] resource event listener interface described

f543d35

[ResourceWatcher] created basic resource event listener object

5173ca3

[ResourceWatcher] resource state checker interface described

5cb04ad

[ResourceWatcher] created recursive iterator resource state checker

8e840e7

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

[ResourceWatcher] resources tracker interface described

efd9465

[ResourceWatcher] recursive iterator resources tracker created

9c8eb16

this resources tracker uses recursive iterator state checker internally

[ResourceWatcher] resource watcher object created

c0ee08e

[ResourceWatcher] inotify tracker added

42ee8de

[ResourceWatcher] use best tracker by default

f84133b

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…

3df1211

…istent with other parts of the framework.

[ResourceWatcher] fixed non-empty directory events

346a23e

[Config] updated resources API to be more explicit

7a1b9e4

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

0e0e842

…FilteredChilds method

[ResourceWatcher] cleaned code little bit

703e450

[ResourceWatcher] refactored recursive state checkers into 2 separate…

8919d63

… classes

[Config] getFilteredChildResources() method added to DirectoryResource

9077500

[ResourceWatcher] refactored recursive iterator tracker to support ne…

d9de08f

…w state checkers

[Config] updated DirectoryResource tests

38638a7

[Config] update FileResourceTest

2acc262

[ResourceWatcher] removed InotifyTracker as i have no ability to test…

44dd464

… it yet

[Config] added new methods and their tests to File and Directory reso…

7413969

…urces

everzet and others added 16 commits June 20, 2012 10:08

[ResourceWatcher] prevent temp folder flooding by test suite

d236e5c

[ResourceWatcher] Inotify Tracker.

70871b3

[ResourceWatcher] Typos, docblock clear.

ac2c871

[ResourceWatcher] DirectoryStateCheckerTest, onConsecutiveCalls issue.

d30de16

Moved previously added assertions from testTrackDeepDirChanges to t…

5b42fcf

…heir own method.

[ResourceWatcher] NewDirectoryStateChecker: removed unnecessary `$res…

b53dd92

…ource->exists()` check

[ResourceWatcher] Ran CS Fixer against code + fixed some CS issues by…

c5724e7

… myself.

[Config] added type prefixes to resource ids

3102e21

Makes sure that directory and the file resources with the same name will have different ids

[Config] use is_file in FileResource::exists()

64cecb6

file resource existence check shouldn't return true if there's directory with same name instead of file.

[ResourceWatcher] ResourceWatcher functional test, small addition.

beda449

[ResourceWatcher] Get rid of FilesystemEvent events' "IN_" prefix.

39f829e

[ResourceWatcher] added composer configuration

f34669a

added symfony/config as resource watcher dependency

480c270

added ext-inotify to suggest block

9699c30

[ResourceWatcher] added event dispatcher as dependency

b2f0704

[ResourceWatcher] added missing contributors

d1a7fcb

adrienbrault reviewed Jun 20, 2012
View reviewed changes

stof mentioned this pull request Oct 13, 2012

[Config] additions from ResourceWatcher #5744

Closed

cordoval mentioned this pull request Jan 23, 2013

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

Closed

mpdude mentioned this pull request Feb 20, 2013

Assetic is not aware of asset dependencies kriswallsmith/assetic#79

Closed

stof closed this May 17, 2013

ro0NL mentioned this pull request May 10, 2019

[Filesystem] Add watch method to watch filesystem for changes #31462

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[2.2] ResourceWatcher component (final?) #4605

[2.2] ResourceWatcher component (final?) #4605

everzet commented Jun 18, 2012

travisbot commented Jun 18, 2012

travisbot commented Jun 18, 2012

kriswallsmith Jun 18, 2012

everzet Jun 18, 2012

everzet Jun 18, 2012

kriswallsmith Jun 18, 2012

stof Jun 18, 2012

everzet Jun 18, 2012

stof Jun 18, 2012

everzet Jun 18, 2012

kriswallsmith Jun 18, 2012

kriswallsmith commented Jun 18, 2012

travisbot commented Jun 18, 2012

fabpot commented Jun 19, 2012

travisbot commented Jun 20, 2012

everzet commented Jun 20, 2012

adrienbrault Jun 20, 2012

everzet Jun 20, 2012

stof commented Oct 13, 2012

stof commented Oct 13, 2012

fabpot commented Oct 13, 2012

webmozart commented Mar 17, 2013

ghost commented Apr 6, 2013

stof commented May 17, 2013

[2.2] ResourceWatcher component (final?) #4605

[2.2] ResourceWatcher component (final?) #4605

Conversation

everzet commented Jun 18, 2012

Short overview

Usage

Simplest possible way of FS tracking

track() method

addListener() method

travisbot commented Jun 18, 2012

travisbot commented Jun 18, 2012

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

kriswallsmith commented Jun 18, 2012

travisbot commented Jun 18, 2012

fabpot commented Jun 19, 2012

travisbot commented Jun 20, 2012

everzet commented Jun 20, 2012

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stof commented Oct 13, 2012

stof commented Oct 13, 2012

fabpot commented Oct 13, 2012

webmozart commented Mar 17, 2013

ghost commented Apr 6, 2013

stof commented May 17, 2013

`track()` method

`addListener()` method