[2.2] [WIP] ResourceWatcher component refactored #3961

everzet · 2012-04-16T14:02:57Z

REBASED TO #4605

Bug fix: no
Feature addition: yes
Backwards compatibility break: no
Symfony2 tests pass: yes (for old tests) and partly (InotifyTracker is not yet finished)
Fixes the following tickets: -

This is refactoring of #391, which:

Uses EventDispatcher component for events routing
Uses inotify naming convention for event types (IN_CREATE, IN_MODIFY, IN_DELETE).

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::IN_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::IN_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();

WIP

InotifyTracker is not ready as i have problems testing it (no Inotify on MacOS). Help here would be highly appreciated - test suite is ready, requirement is to make InotifyTrackerTest green.

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

… myself.

[ResourceWatcher] Few small issues

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.

everzet · 2012-06-09T11:34:46Z

All RecursiveIteratorTracker-related tests pass and i'm quite happy with component. @Dattaya could you check that InotifyTracker still passes to?

@fabpot it's almost ready. We just need to have additional pair of eyes to check everything and that's it :)
@stof could you review?

travisbot · 2012-06-09T11:35:25Z

This pull request passes (merged 3aaf29b into e7470ff).

travisbot · 2012-06-09T11:45:48Z

This pull request passes (merged 2cf953d into e7470ff).

stof · 2012-06-09T12:47:18Z

@everzet this PR conflicts with master according to github

stof · 2012-06-09T13:47:21Z

vendors.php

@@ -63,3 +63,12 @@

    system(sprintf('cd %s && git fetch origin && git reset --hard %s', escapeshellarg($installDir), escapeshellarg($rev)));
 }
+
+// install inotify extension
+system(<<<SH


you should wrap this call as it will fail for Windows users, making the vendors script unusable.

Btw, is it really necessary ? Travis uses Composer now in master

travisbot · 2012-06-10T06:58:46Z

This pull request passes (merged 0564b07 into e7470ff).

stof · 2012-06-11T22:22:36Z

@fabpot what about merging the changes done in the ResourceInterface into 2.1 to allow marking the Config component as stable instead of waiting for 2.2 to do it because of this PR ?
Btw, making the ResourceInterface extend Serializable indeed make sense as the resources are always serialized in the meta files.

Dattaya · 2012-06-13T06:59:35Z

@Dattaya could you check that InotifyTracker still passes to?

yep, it passes

All RecursiveIteratorTracker-related tests pass and i'm quite happy with component.

I think the RecursiveIteratorTracker is great. I'm out of ideas how to break it.

everzet · 2012-06-13T07:34:26Z

@stof @fabpot i could cherry-pick Config component changes from this PR.

stof · 2012-06-13T07:42:07Z

@everzet this is what I had in mind. Let's see what @fabpot think about it.

everzet · 2012-06-13T07:44:51Z

Also as there's still no 1st beta for Symfony 2.1 AFAIK, we could think about including this component (in form of unstabilized one) to 2.1, cuz test suite passes for both trackers (recursive, inotify).

@fabpot @stof what do you think, guys?

everzet · 2012-06-13T08:27:49Z

@stof @Dattaya @stof rebased branch: https://github.com/everzet/symfony/tree/resource-watcher-final

stof · 2012-06-13T08:31:27Z

@everzet why not forcing the push in the branch to update the PR ?

everzet · 2012-06-13T08:38:54Z

@stof to not break history of this PR. i'm thinking about opening another PR instead.

everzet · 2012-06-13T09:11:38Z

@fabpot can we really get rid of this IN_ prefix (that have been added for inotify event names compliance) or should i revert these 2 @Dattaya commits?

stof · 2012-06-13T09:21:42Z

src/Symfony/Component/ResourceWatcher/composer.json

+    ],
+    "require": {
+        "php": ">=5.3.3"
+    },


the component requires symfony/config

I think @stofbot is right. This component does depends on symfony/config...

…ames [ResourceWatcher] Resource watcher tests and event names

fabpot · 2012-06-13T15:30:35Z

@everzet feel free to remove the IN_ prefix.

everzet · 2012-06-18T10:16:02Z

rebased to #4605

everzet and others added 30 commits April 16, 2012 14:43

[ResourceWatcher] resource change event created

a30ef7e

[ResourceWatcher] resource event listener interface described

443c2b4

[ResourceWatcher] created basic resource event listener object

b9f0ab8

[ResourceWatcher] resource state checker interface described

937882b

[ResourceWatcher] created recursive iterator resource state checker

2b4be01

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

[ResourceWatcher] resources tracker interface described

cb11c9b

[ResourceWatcher] recursive iterator resources tracker created

d97d728

this resources tracker uses recursive iterator state checker internally

[ResourceWatcher] resource watcher object created

752dc6c

[ResourceWatcher] inotify tracker added

893acfb

[ResourceWatcher] use best tracker by default

8dd8e9f

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…

51d54c7

…istent with other parts of the framework.

[ResourceWatcher] fixed non-empty directory events

38c92ea

[Config] updated resources API to be more explicit

f3389ce

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

c3a710b

…FilteredChilds method

[ResourceWatcher] cleaned code little bit

690507b

[ResourceWatcher] refactored recursive state checkers into 2 separate…

f7e2267

… classes

[Config] getFilteredChildResources() method added to DirectoryResource

7f720a4

[ResourceWatcher] refactored recursive iterator tracker to support ne…

b8349ec

…w state checkers

[Config] updated DirectoryResource tests

3d0e65b

[Config] update FileResourceTest

ab746a3

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

f3dafd6

… it yet

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

ed39212

…urces

[ResourceWatcher] updated ResourceWatcher and TrackerInterface

bd5079f

[ResourceWatcher] added time information to events

bcbf12d

[ResourceWatcher] updated FileStateChecker to match FileResource API

adbac59

[ResourceWatcher] refactored DirectoryStateChecker

fa5a603

[ResourceWatcher] refactored RecursiveIteratorTracker

2132e24

[ResourceWatcher] updated StateCheckerInterface

8510398

[ResourceWatcher] return of the InotifyTracker

c9fa57f

[ResourceWatcher] removed unneeded code

688b8c6

Dattaya and others added 4 commits May 27, 2012 10:52

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

0bec395

… myself.

Merge pull request #5 from Dattaya/resource-watcher-issues

0564b07

[ResourceWatcher] Few small issues

[Config] added type prefixes to resource ids

3aaf29b

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

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

2cf953d

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

[ResourceWatcher] added php-inotify extension setup to vendors.php

4c4c55f

stof reviewed Jun 9, 2012
View reviewed changes

[ResourceWatcher] added composer configuration

e20cff0

stof reviewed Jun 13, 2012
View reviewed changes

Dattaya and others added 4 commits June 13, 2012 12:35

[ResourceWatcher] ResourceWatcher functional test, small addition.

a4e903e

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

633268d

Merge pull request #6 from Dattaya/resource-watcher-tests-and-event-n…

8a9e652

…ames [ResourceWatcher] Resource watcher tests and event names

added symfony/config as resource watcher dependency

019d5a6

everzet mentioned this pull request Jun 18, 2012

[2.2] ResourceWatcher component (final?) #4605

Closed

everzet closed this Jun 18, 2012

Uh oh!

[2.2] [WIP] ResourceWatcher component refactored #3961

[2.2] [WIP] ResourceWatcher component refactored #3961

Uh oh!

Conversation

everzet commented Apr 16, 2012

REBASED TO #4605

Short overview

Usage

Simplest possible way of FS tracking

track() method

addListener() method

WIP

Uh oh!

everzet commented Jun 9, 2012

Uh oh!

travisbot commented Jun 9, 2012

Uh oh!

travisbot commented Jun 9, 2012

Uh oh!

stof commented Jun 9, 2012

Uh oh!

stof Jun 9, 2012

Choose a reason for hiding this comment

Uh oh!

travisbot commented Jun 10, 2012

Uh oh!

stof commented Jun 11, 2012

Uh oh!

Dattaya commented Jun 13, 2012

Uh oh!

everzet commented Jun 13, 2012

Uh oh!

stof commented Jun 13, 2012

Uh oh!

everzet commented Jun 13, 2012

Uh oh!

everzet commented Jun 13, 2012

Uh oh!

stof commented Jun 13, 2012

Uh oh!

everzet commented Jun 13, 2012

Uh oh!

everzet commented Jun 13, 2012

Uh oh!

stof Jun 13, 2012

Choose a reason for hiding this comment

Uh oh!

everzet Jun 13, 2012

Choose a reason for hiding this comment

Uh oh!

fabpot commented Jun 13, 2012

Uh oh!

everzet commented Jun 18, 2012

rebased to #4605

Uh oh!

Uh oh!

`track()` method

`addListener()` method