L.S.,

I got the following error: ReflectionException in Container.php line 734: Class Kyranb\Footprints\Middleware\CaptureAttributionDataMiddleware does not exist in Container.php line 734 at ReflectionClass->__construct('Kyranb\Footprints\Middleware\CaptureAttributionDataMiddleware') in Container.php line 734 at Container->build('Kyranb\Footprints\Middleware\CaptureAttributionDataMiddleware', array()) in Container.php line 629 at Container->make('Kyranb\Footprints\Middleware\CaptureAttributionDataMiddleware', array()) in Application.php line 697 at Application->make('Kyranb\Footprints\Middleware\CaptureAttributionDataMiddleware') in Pipeline.php line 126 at Pipeline->Illuminate\Pipeline\{closure}(object(Request)) at call_user_func(object(Closure), object(Request)) in Pipeline.php line 32 at Pipeline->Illuminate\Routing\{closure}(object(Request)) in VerifyCsrfToken.php line 64 at VerifyCsrfToken->handle(object(Request), object(Closure)) at call_user_func_array(array(object(VerifyCsrfToken), 'handle'), array(object(Request), object(Closure))) in Pipeline.php line 136 at Pipeline->Illuminate\Pipeline\{closure}(object(Request)) at call_user_func(object(Closure), object(Request)) in Pipeline.php line 32 at Pipeline->Illuminate\Routing\{closure}(object(Request)) at call_user_func(object(Closure), object(Request)) in Pipeline.php line 102 at Pipeline->then(object(Closure)) in Router.php line 726 at Router->runRouteWithinStack(object(Route), object(Request)) in Router.php line 699 at Router->dispatchToRoute(object(Request)) in Router.php line 675 at Router->dispatch(object(Request)) in Kernel.php line 246 at Kernel->Illuminate\Foundation\Http\{closure}(object(Request)) at call_user_func(object(Closure), object(Request)) in Pipeline.php line 52 at Pipeline->Illuminate\Routing\{closure}(object(Request)) in InputTrimmer.php line 20 at InputTrimmer->handle(object(Request), object(Closure)) at call_user_func_array(array(object(InputTrimmer), 'handle'), array(object(Request), object(Closure))) in Pipeline.php line 136 at Pipeline->Illuminate\Pipeline\{closure}(object(Request)) at call_user_func(object(Closure), object(Request)) in Pipeline.php line 32

One way to solve it is using php artisan optimize --force

Do you have an idea about what could go wrong?

` protected $middleware = [ \Kyranb\Footprints\FootprintsServiceProvider::class, ];

protected $routeMiddleware = [ ... 'capture.attribution' => \Kyranb\Footprints\Middleware\CaptureAttributionDataMiddleware::class, ... ]; `

• [x] Fixes minor bug about footprint being a pure function (introduced in #41 dammit!)
• [x] Now only supporting PHP7.4+ and Laravel7+
• [x] Delete unused Facade
• [x] Implement return type casting and typed properties
• [x] Implement Github actions (stolen 100% from https://github.com/spatie/laravel-http-logger 🙏 )
• [x] Update Laravel version in package image @kyranb ?

This PR implements modifications to the middleware and now does the tracking pre-controller (issue #40) while it also introduces a new request macro $request->footprint() which uses a new Fingerprinter class.

Missing:

• ~Update README.md as the interfaces have changed~ (was not needed)
• [x] Find a way to make the footprint() macro configurable (perhaps a new Footprinting class which implements a FootprintingInterface?)

@kyranb This is inspired from you suggestion on a fingerprint method. I think for this to be really useful then it should be possible to change the logic used for generating the footprint. Do you have any suggestions how we can do that? Making this configurable would be a good way for SPAs to do some customisation like providing the footprint as a query parameter from the SPA.

I'm noticing that Visits "user_id" is never being set in my system. My registration is unconventional (occurs when another resource is created), and I'm wondering if this might be the cause.

Are we listening for an event on User created in this package?

Any help is greatly appreciated!

Hi,

I think there might be an issue when manually creating a User through Eloquent (e.g. User::create($data)). In TrackRegistrationAttribution.php there is this boot method:

 public static function bootTrackRegistrationAttribution()
    {
        // Add an observer that upon registration will automatically sync up prior visits.
        static::created(function (Model $model) {
            $model->trackRegistration();
        });
    }

Which calls this:

    /**
     * Assign earlier visits using current request.
     */
    public function trackRegistration(Request $request): void
    {
        $job = new AssignPreviousVisits($request->footprint(), $this);

        if (config('footprints.async') == true) {
            dispatch($job);
        } else {
            $job->handle();
        }
    }

But there is no Request so it fails with error:

Too few arguments to function App\Models\User::trackRegistration(), 0 passed

~DRAFT PR: until #37 and #38 are merged.~

This PR refactors the logging jobs by passing them any class that implements the TrackableInterface instead of just the id of the eloquent model.

This allows for much greater flexibility and would allow for tracking multiple models (closes #21) while it also makes it possible to make modifications like matching based on ip and headers (essentially closing #19).

Note this is a breaking change and notes about upgrading has been included in README.md

@kyranb would you be willing to consider a PR implementing implementing what is described below?

Description

Currently there is a concept of "Custom Parameters" (defined in the configuration: footprints.custom_parameters) which should make it possible to log extra stuff that might be relevant. However we are limited to request inputs since this is implemented like so:

// https://github.com/kyranb/Footprints/blob/master/src/Middleware/CaptureAttributionDataMiddleware.php
    /**
     * @return array
     */
    protected function getCustomParameter()
    {
        $arr = [];

        if (config('footprints.custom_parameters')) {
            foreach (config('footprints.custom_parameters') as $parameter) {
                $arr[$parameter] = $this->request->input($parameter); // <--- Only inputs
            }
        }

        return $arr;
    }

Cons

Now we all know that cookies are not always the best way to track users. In many applications where it was not possible to track a cookie then I assume that it would be sufficient to match previous visits based on the IP address of the user (for many applications you will never see multiple users from the same IP address) or slightly better would be a combination of IP address and the User-agent provided in the headers. Now none of these approaches are possible using the package right now.

Suggestion

These suggestions would each constitute a breaking change, so I am proposing that all of them are implemented in the same go:

Adding IP

I suggest adding the IP of the request ($request->ip()) in CaptureAttributionDataMiddleware since this is simple and could be used for matching in many cases. This would also need to be added to the Visit model and to the migration.

Note that I am not proposing to save the headers as described as an option in the initial description.

Introducing CaptureHandler

I suggest modifying the CaptureAttributionDataMiddleware so that everything except the handle method is moved to a separate class called CaptureHandler which implements a new interface called CaptureHandlerInterface.

The point being that a developer can easily swap out the Handler for another concrete implementation and hence save the request in any way or shape they find useful. This would also solve #21.

Moving authenticated user

Since we are already introducing breaking changes then I suggest moving the TrackVisit.php#L26:

    public function handle()
    {
        $user = [];
        $user[config('footprints.column_name')] = Auth::user() ? Auth::user()->id : null; // <-- Moving to CaptureHandler enable modifications

        $visit = Visit::create(array_merge([
        ....

to the new CaptureHandler (previously CaptureAttributionDataMiddleware.php#L106:

which would partially solve #30

The TrackUser function is using the authenticated user id even if we are using a different model:

$user[config('footprints.column_name')] = Auth::user() ? Auth::user()->id : null;

Fix https://github.com/kyranb/Footprints/issues/28

"The subdirectory name MUST match the case of the sub-namespace names."

https://www.php-fig.org/psr/psr-4/

It would be nice if we could track multiple models instead of just one. Using a morphables, you could have model_type and model_id columns. This is useful when we have registration for several different models.

Hey,

I have just upgraded to Laravel 5.4 and seem to be getting an issue. The error is Closure object cannot have properties. The issue seems to be related to asyncTrackVisit in CaptureAttributionDataMiddleware.

Anyone else seen this or knows how to fix it?

Hi guys. I think I found a problem with the Footprinter.php file.

on the line 21 we have this function

public function footprint(Request $request): string
{
        $this->request = $request;

        if ($request->hasCookie(config('footprints.cookie_name'))) {
            return $request->cookie(config('footprints.cookie_name'));
        }

        // This will add the cookie to the response
        Cookie::queue(
            config('footprints.cookie_name'),
            $footprint = substr($this->fingerprint(), 0, 255),
            config('footprints.attribution_duration'),
            null,
            config('footprints.cookie_domain')
        );

        return $footprint;
}

the problem is in the line 32 because laravel make a cookie encryptation and then the first request returns the value stored in the variable $footprint

but the second request returns the cookie value encrypted

my solution was to add the cookie name in the EncryptCookies middleware and so we prevent laravel from changing the value.