Skip to content

PHPLIB-1378 Replace example printfs with a callable #1723

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 1 commit into from
Jun 5, 2025
Merged

PHPLIB-1378 Replace example printfs with a callable #1723

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
53 changes: 37 additions & 16 deletions examples/command_logger.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

namespace MongoDB\Examples\CommandLogger;

use Closure;
use Exception;
use MongoDB\BSON\Document;
use MongoDB\Client;
use MongoDB\Driver\Monitoring\CommandFailedEvent;
Expand All @@ -24,37 +26,56 @@ function toJSON(object $document): string

class CommandLogger implements CommandSubscriber
{
public function commandStarted(CommandStartedEvent $event): void
/** @param Closure(object):void $handleOutput */
public function __construct(private readonly Closure $handleOutput)
{
printf("%s command started\n", $event->getCommandName());
}

printf("command: %s\n", toJson($event->getCommand()));
echo "\n";
public function commandStarted(CommandStartedEvent $event): void
{
$this->handleOutput->__invoke($event);
}

public function commandSucceeded(CommandSucceededEvent $event): void
{
printf("%s command succeeded\n", $event->getCommandName());
printf("reply: %s\n", toJson($event->getReply()));
echo "\n";
$this->handleOutput->__invoke($event);
}

public function commandFailed(CommandFailedEvent $event): void
{
printf("%s command failed\n", $event->getCommandName());
printf("reply: %s\n", toJson($event->getReply()));

$exception = $event->getError();
printf("exception: %s\n", $exception::class);
printf("exception.code: %d\n", $exception->getCode());
printf("exception.message: %s\n", $exception->getMessage());
echo "\n";
$this->handleOutput->__invoke($event);
}
}

$client = new Client(getenv('MONGODB_URI') ?: 'mongodb://127.0.0.1/');

$client->addSubscriber(new CommandLogger());
$handleOutput = function (object $event): void {
switch ($event::class) {
case CommandStartedEvent::class:
printf("%s command started\n", $event->getCommandName());
printf("command: %s\n", toJson($event->getCommand()));
break;
case CommandSucceededEvent::class:
printf("%s command succeeded\n", $event->getCommandName());
printf("reply: %s\n", toJson($event->getReply()));
break;
case CommandFailedEvent::class:
printf("%s command failed\n", $event->getCommandName());
printf("reply: %s\n", toJson($event->getReply()));

$exception = $event->getError();
printf("exception: %s\n", $exception::class);
printf("exception.code: %d\n", $exception->getCode());
printf("exception.message: %s\n", $exception->getMessage());
break;
default:
throw new Exception('Event type not supported');
}

echo "\n";
};

$client->addSubscriber(new CommandLogger($handleOutput));

$collection = $client->test->command_logger;
$collection->drop();
Expand Down
160 changes: 97 additions & 63 deletions examples/sdam_logger.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@

namespace MongoDB\Examples;

use Closure;
use Exception;
use MongoDB\BSON\Document;
use MongoDB\Client;
use MongoDB\Driver\Monitoring\SDAMSubscriber;
Expand All @@ -28,102 +30,54 @@ function toJSON(array|object $document): string

class SDAMLogger implements SDAMSubscriber
{
/** @param Closure(object):void $handleOutput */
public function __construct(private readonly Closure $handleOutput)
{
}

public function serverChanged(ServerChangedEvent $event): void
{
printf(
"serverChanged: %s:%d changed from %s to %s\n",
$event->getHost(),
$event->getPort(),
$event->getPreviousDescription()->getType(),
$event->getNewDescription()->getType(),
);

printf("previous hello response: %s\n", toJson($event->getPreviousDescription()->getHelloResponse()));
printf("new hello response: %s\n", toJson($event->getNewDescription()->getHelloResponse()));
echo "\n";
$this->handleOutput->__invoke($event);
}

public function serverClosed(ServerClosedEvent $event): void
{
printf(
"serverClosed: %s:%d was removed from topology %s\n",
$event->getHost(),
$event->getPort(),
(string) $event->getTopologyId(),
);
echo "\n";
$this->handleOutput->__invoke($event);
}

public function serverHeartbeatFailed(ServerHeartbeatFailedEvent $event): void
{
printf(
"serverHeartbeatFailed: %s:%d heartbeat failed after %dµs\n",
$event->getHost(),
$event->getPort(),
$event->getDurationMicros(),
);

$error = $event->getError();

printf("error: %s(%d): %s\n", $error::class, $error->getCode(), $error->getMessage());
echo "\n";
$this->handleOutput->__invoke($event);
}

public function serverHeartbeatStarted(ServerHeartbeatStartedEvent $event): void
{
printf(
"serverHeartbeatStarted: %s:%d heartbeat started\n",
$event->getHost(),
$event->getPort(),
);
echo "\n";
$this->handleOutput->__invoke($event);
}

public function serverHeartbeatSucceeded(ServerHeartbeatSucceededEvent $event): void
{
printf(
"serverHeartbeatSucceeded: %s:%d heartbeat succeeded after %dµs\n",
$event->getHost(),
$event->getPort(),
$event->getDurationMicros(),
);

printf("reply: %s\n", toJson($event->getReply()));
echo "\n";
$this->handleOutput->__invoke($event);
}

public function serverOpening(ServerOpeningEvent $event): void
{
printf(
"serverOpening: %s:%d was added to topology %s\n",
$event->getHost(),
$event->getPort(),
(string) $event->getTopologyId(),
);
echo "\n";
$this->handleOutput->__invoke($event);
}

public function topologyChanged(TopologyChangedEvent $event): void
{
printf(
"topologyChanged: %s changed from %s to %s\n",
(string) $event->getTopologyId(),
$event->getPreviousDescription()->getType(),
$event->getNewDescription()->getType(),
);
echo "\n";
$this->handleOutput->__invoke($event);
}

public function topologyClosed(TopologyClosedEvent $event): void
{
printf("topologyClosed: %s was closed\n", (string) $event->getTopologyId());
echo "\n";
$this->handleOutput->__invoke($event);
}

public function topologyOpening(TopologyOpeningEvent $event): void
{
printf("topologyOpening: %s was opened\n", (string) $event->getTopologyId());
echo "\n";
$this->handleOutput->__invoke($event);
}
}

Expand All @@ -132,7 +86,87 @@ public function topologyOpening(TopologyOpeningEvent $event): void
* (including subscribers) are freed. */
$client = new Client(getenv('MONGODB_URI') ?: 'mongodb://127.0.0.1/', [], ['disableClientPersistence' => true]);

$client->getManager()->addSubscriber(new SDAMLogger());
$handleOutput = function (object $event): void {
switch ($event::class) {
case ServerChangedEvent::class:
printf(
"serverChanged: %s:%d changed from %s to %s\n",
$event->getHost(),
$event->getPort(),
$event->getPreviousDescription()->getType(),
$event->getNewDescription()->getType(),
);

printf("previous hello response: %s\n", toJson($event->getPreviousDescription()->getHelloResponse()));
printf("new hello response: %s\n", toJson($event->getNewDescription()->getHelloResponse()));
break;
case ServerClosedEvent::class:
printf(
"serverClosed: %s:%d was removed from topology %s\n",
$event->getHost(),
$event->getPort(),
$event->getTopologyId()->__toString(),
);
break;
case ServerHeartbeatFailedEvent::class:
printf(
"serverHeartbeatFailed: %s:%d heartbeat failed after %dµs\n",
$event->getHost(),
$event->getPort(),
$event->getDurationMicros(),
);

$error = $event->getError();

printf("error: %s(%d): %s\n", $error::class, $error->getCode(), $error->getMessage());
break;
case ServerHeartbeatStartedEvent::class:
printf(
"serverHeartbeatStarted: %s:%d heartbeat started\n",
$event->getHost(),
$event->getPort(),
);
break;
case ServerHeartbeatSucceededEvent::class:
printf(
"serverHeartbeatSucceeded: %s:%d heartbeat succeeded after %dµs\n",
$event->getHost(),
$event->getPort(),
$event->getDurationMicros(),
);

printf("reply: %s\n", toJson($event->getReply()));
break;
case ServerOpeningEvent::class:
printf(
"serverOpening: %s:%d was added to topology %s\n",
$event->getHost(),
$event->getPort(),
$event->getTopologyId()->__toString(),
);
break;
case TopologyChangedEvent::class:
printf(
"topologyChanged: %s changed from %s to %s\n",
$event->getTopologyId()->__toString(),
$event->getPreviousDescription()->getType(),
$event->getNewDescription()->getType(),
);
break;
case TopologyClosedEvent::class:
printf("topologyClosed: %s was closed\n", $event->getTopologyId()->__toString());
break;
case TopologyOpeningEvent::class:
printf("topologyOpening: %s was opened\n", $event->getTopologyId()->__toString());
break;
default:
throw new Exception('Event type not supported');
}

echo "\n";
};

$client->getManager()->addSubscriber(new SDAMLogger($handleOutput));

$client->test->command(['ping' => 1]);

Expand Down