Skip to content

Drop visitorId check and refactor functional tests #190

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

Merged
merged 4 commits into from
Sep 30, 2025
Merged

Drop visitorId check and refactor functional tests #190

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b1c3cbc
chore: remove temporary deprecated suppression
erayaydin Sep 26, 2025
98d2c84
test: drop visitorId check and refactor
erayaydin Sep 28, 2025
f5460fc
chore: use stdout instead of stderr
erayaydin Sep 28, 2025
da816ac
refactor: remove unused variables in check script
erayaydin Sep 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
108 changes: 53 additions & 55 deletions run_checks.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?php

require_once __DIR__.'/vendor/autoload.php';
declare(strict_types=1);

$host = getenv('FP_API_HOST');
$api_key = getenv('FP_PRIVATE_API_KEY');
require_once __DIR__.'/vendor/autoload.php';

use Dotenv\Dotenv;
use Fingerprint\ServerAPI\Api\FingerprintApi;
use Fingerprint\ServerAPI\Configuration;
use Fingerprint\ServerAPI\Model\EventsGetResponse;
Expand All @@ -14,24 +14,31 @@
use Fingerprint\ServerAPI\Webhook\WebhookVerifier;
use GuzzleHttp\Client;

$dotenv = Dotenv\Dotenv::createImmutable(__DIR__);

$dotenv = Dotenv::createImmutable(__DIR__);
$dotenv->safeLoad();

$api_key = $_ENV['FP_PRIVATE_API_KEY'] ?? getenv('FP_PRIVATE_API_KEY') ?? 'Private API Key not defined';
$visitor_id_to_delete = $_ENV['FP_VISITOR_ID_TO_DELETE'] ?? getenv('FP_VISITOR_ID_TO_DELETE') ?? false;
$request_id_to_update = $_ENV['FP_REQUEST_ID_TO_UPDATE'] ?? getenv('FP_REQUEST_ID_TO_UPDATE') ?? false;
$region_env = $_ENV['FP_REGION'] ?? getenv('FP_REGION') ?? 'us';
function env(string $key, ?string $default = null): ?string
{
return $_ENV[$key] ?? getenv($key) ?: $default;
}

$region = Configuration::REGION_GLOBAL;
if ('eu' === $region_env) {
$region = Configuration::REGION_EUROPE;
} elseif ('ap' === $region_env) {
$region = Configuration::REGION_ASIA;
$apiKey = env('FP_PRIVATE_API_KEY');
if (!$apiKey) {
throw new Exception('FP_PRIVATE_API_KEY is not defined.');
}

$regionEnv = env('FP_REGION', 'us');
$visitorIdToDelete = env('FP_VISITOR_ID_TO_DELETE');
$requestIdToUpdate = env('FP_REQUEST_ID_TO_UPDATE');

$region = match(strtolower(trim($regionEnv))) {
'eu' => Configuration::REGION_EUROPE,
'ap' => Configuration::REGION_ASIA,
default => Configuration::REGION_GLOBAL,
};

$config = Configuration::getDefaultConfiguration(
$api_key,
$apiKey,
$region,
);

Expand All @@ -40,25 +47,19 @@
$config
);

// Temporarily suppress a million deprecated ArrayAccess return type warnings for readability
// Our SDK generator does not yet support PHP's new attributes system
// https://github.com/swagger-api/swagger-codegen/issues/11820
error_reporting(error_reporting() & ~E_DEPRECATED);
$start = (new DateTime())->sub(new DateInterval('P3M'));
$end = new DateTime();

// FingerprintApi->searchEvents usage example
try {
// 3 month from now
$start = (new DateTime())->sub(new DateInterval('P3M'));
$end = new DateTime();

/** @var SearchEventsResponse $result */
list($result, $response) = $client->searchEvents(10, start: $start->getTimestamp() * 1000, end: $end->getTimestamp() * 1000);
if (!is_countable($result->getEvents()) || count($result->getEvents()) === 0) {
throw new Exception('No events found');
}
$identification_data = $result->getEvents()[0]->getProducts()->getIdentification()->getData();
$visitor_id = $identification_data->getVisitorId();
$request_id = $identification_data->getRequestId();
$identificationData = $result->getEvents()[0]->getProducts()->getIdentification()->getData();
$visitorId = $identificationData->getVisitorId();
$requestId = $identificationData->getRequestId();
fwrite(STDOUT, sprintf("\n\nGot events: %s \n", $response->getBody()->getContents()));
} catch (Exception $e) {
fwrite(STDERR, sprintf("\n\nException when calling FingerprintApi->searchEvents: %s\n", $e->getMessage()));
Expand All @@ -69,8 +70,8 @@
// FingerprintApi->getVisits usage example
try {
/** @var VisitorsGetResponse $result */
list($result, $response) = $client->getVisits($visitor_id);
if ($result->getVisitorId() !== $visitor_id) {
list($result, $response) = $client->getVisits($visitorId);
if ($result->getVisitorId() !== $visitorId) {
throw new Exception('Argument visitorId is not equal to deserialized getVisitorId');
}
fwrite(STDOUT, sprintf("Got visits: %s \n", $response->getBody()->getContents()));
Expand All @@ -81,9 +82,9 @@
}

// FingerprintApi->deleteVisitorData usage example
if ($visitor_id_to_delete) {
if ($visitorIdToDelete) {
try {
list($model, $response) = $client->deleteVisitorData($visitor_id_to_delete);
list($model, $response) = $client->deleteVisitorData($visitorIdToDelete);
fwrite(STDOUT, sprintf("Visitor data deleted: %s \n", $response->getBody()->getContents()));
} catch (Exception $e) {
fwrite(STDERR, sprintf("Exception when calling FingerprintApi->deleteVisitorData: %s\n", $e->getMessage()));
Expand All @@ -94,8 +95,8 @@
// FingerprintApi->getEvent usage example
try {
/** @var EventsGetResponse $result */
list($result, $response) = $client->getEvent($request_id);
if ($result->getProducts()->getIdentification()->getData()->getRequestId() !== $request_id) {
list($result, $response) = $client->getEvent($requestId);
if ($result->getProducts()->getIdentification()->getData()->getRequestId() !== $requestId) {
throw new Exception('Argument requestId is not equal to deserialized getRequestId');
}
fwrite(STDOUT, sprintf("\n\nGot event: %s \n", $response->getBody()->getContents()));
Expand All @@ -106,24 +107,24 @@
}

// FingerprintApi->updateEvent usage example
if ($request_id_to_update) {
if ($requestIdToUpdate) {
try {
$body = new EventsUpdateRequest([
'linked_id' => date('Y-m-d H:i:s'),
]);
list($model, $response) = $client->updateEvent($body, $request_id_to_update);
list($model, $response) = $client->updateEvent($body, $requestIdToUpdate);
fwrite(STDOUT, sprintf("\n\nEvent updated: %s \n", $response->getBody()->getContents()));
} catch (Exception $e) {
fwrite("\n\nException when calling FingerprintApi->updateEvent: %s\n", $e->getMessage());
fwrite(STDOUT, sprintf("\n\nException when calling FingerprintApi->updateEvent: %s\n", $e->getMessage()));
exit(1);
}
}

// Call API asynchronously examples
$eventPromise = $client->getEventAsync($request_id);
$eventPromise->then(function ($tuple) use ($request_id) {
$eventPromise = $client->getEventAsync($requestId);
$eventPromise->then(function ($tuple) use ($requestId) {
list($result, $response) = $tuple;
if ($result->getProducts()->getIdentification()->getData()->getRequestId() !== $request_id) {
if ($result->getProducts()->getIdentification()->getData()->getRequestId() !== $requestId) {
throw new Exception('Argument requestId is not equal to deserialized getRequestId');
}
fwrite(STDOUT, sprintf("\n\nGot async event: %s \n", $response->getBody()->getContents()));
Expand All @@ -133,10 +134,10 @@
exit(1);
})->wait();

$visitsPromise = $client->getVisitsAsync($visitor_id);
$visitsPromise->then(function ($tuple) use ($visitor_id) {
$visitsPromise = $client->getVisitsAsync($visitorId);
$visitsPromise->then(function ($tuple) use ($visitorId) {
list($result, $response) = $tuple;
if ($result->getVisitorId() !== $visitor_id) {
if ($result->getVisitorId() !== $visitorId) {
throw new Exception('Argument visitorId is not equal to deserialized getVisitorId');
}
fwrite(STDOUT, sprintf("\n\nGot async visits: %s \n", $response->getBody()->getContents()));
Expand All @@ -152,37 +153,34 @@
$webhookHeader = 'v1=1b2c16b75bd2a870c114153ccda5bcfca63314bc722fa160d690de133ccbb9db';
$isValidWebhookSign = WebhookVerifier::IsValidWebhookSignature($webhookHeader, $webhookData, $webhookSecret);
if ($isValidWebhookSign) {
fwrite(STDOUT, sprintf("\n\nVerified webhook signature\n"));
fwrite(STDOUT, "\n\nVerified webhook signature\n");
} else {
fwrite(STDERR, sprintf("\n\nWebhook signature verification failed\n"));
fwrite(STDERR, "\n\nWebhook signature verification failed\n");

exit(1);
}

// Check that old events still match expected format
try {
list($result_old) = $client->searchEvents(1, start: $start->getTimestamp() * 1000, end: $end->getTimestamp() * 1000, reverse: true);
if (!is_countable($result_old->getEvents()) || count($result_old->getEvents()) === 0) {
list($resultOld) = $client->searchEvents(1, start: $start->getTimestamp() * 1000, end: $end->getTimestamp() * 1000, reverse: true);
if (!is_countable($resultOld->getEvents()) || count($resultOld->getEvents()) === 0) {
throw new Exception('No old events found');
}
$identification_data_old = $result_old->getEvents()[0]->getProducts()->getIdentification()->getData();
$visitor_id_old = $identification_data_old->getVisitorId();
$request_id_old = $identification_data_old->getRequestId();
$identificationDataOld = $resultOld->getEvents()[0]->getProducts()->getIdentification()->getData();
$visitorIdOld = $identificationDataOld->getVisitorId();
$requestIdOld = $identificationDataOld->getRequestId();

if ($visitor_id === $visitor_id_old || $request_id === $request_id_old) {
if ($requestId === $requestIdOld) {
throw new Exception('Old events are identical to new');
}

list($result, $response) = $client->getEvent($request_id_old);
list($result, $response) = $client->getVisits($visitor_id_old);
fwrite(STDERR, sprintf("\n\nOld events are good\n"));
list($result, $response) = $client->getEvent($requestIdOld);
list($result, $response) = $client->getVisits($visitorIdOld);
fwrite(STDOUT, "\n\nOld events are good\n");
} catch (Exception $e) {
fwrite(STDERR, sprintf("\n\nException when trying to read old data: %s\n", $e->getMessage()));
}

// Enable the deprecated ArrayAccess return type warning again if needed
error_reporting(error_reporting() | E_DEPRECATED);

fwrite(STDOUT, "\n\nChecks passed\n");

exit(0);
Loading