mirror of
https://gitlab.com/Chill-Projet/chill-bundles.git
synced 2025-07-26 10:37:45 +00:00
Merge branch '124-sync-user-absence-ms-graph' into 'master'
Feature: sync user absence with microsoft graph api Closes #124 See merge request Chill-Projet/chill-bundles!571
This commit is contained in:
commit
9423f4d055
5
.changes/unreleased/Feature-20230706-213428.yaml
Normal file
5
.changes/unreleased/Feature-20230706-213428.yaml
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
kind: Feature
|
||||||
|
body: 'Sync user absence / presence through microsoft outlook / graph api. '
|
||||||
|
time: 2023-07-06T21:34:28.973144334+02:00
|
||||||
|
custom:
|
||||||
|
Issue: "124"
|
6
.changes/unreleased/Fixed-20230706-220125.yaml
Normal file
6
.changes/unreleased/Fixed-20230706-220125.yaml
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
kind: Fixed
|
||||||
|
body: 'Command to subscribe on MS Graph users calendars: improve the loop to be more
|
||||||
|
efficient'
|
||||||
|
time: 2023-07-06T22:01:25.847374805+02:00
|
||||||
|
custom:
|
||||||
|
Issue: ""
|
@ -18,9 +18,12 @@ declare(strict_types=1);
|
|||||||
|
|
||||||
namespace Chill\CalendarBundle\Command;
|
namespace Chill\CalendarBundle\Command;
|
||||||
|
|
||||||
|
use Chill\CalendarBundle\Exception\UserAbsenceSyncException;
|
||||||
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\EventsOnUserSubscriptionCreator;
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\EventsOnUserSubscriptionCreator;
|
||||||
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MapCalendarToUser;
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MapCalendarToUser;
|
||||||
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MSGraphUserRepository;
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MSGraphUserRepository;
|
||||||
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MSUserAbsenceSync;
|
||||||
|
use Chill\MainBundle\Repository\UserRepositoryInterface;
|
||||||
use DateInterval;
|
use DateInterval;
|
||||||
use DateTimeImmutable;
|
use DateTimeImmutable;
|
||||||
use Doctrine\ORM\EntityManagerInterface;
|
use Doctrine\ORM\EntityManagerInterface;
|
||||||
@ -30,32 +33,17 @@ use Symfony\Component\Console\Input\InputInterface;
|
|||||||
use Symfony\Component\Console\Input\InputOption;
|
use Symfony\Component\Console\Input\InputOption;
|
||||||
use Symfony\Component\Console\Output\OutputInterface;
|
use Symfony\Component\Console\Output\OutputInterface;
|
||||||
|
|
||||||
class MapAndSubscribeUserCalendarCommand extends Command
|
final class MapAndSubscribeUserCalendarCommand extends Command
|
||||||
{
|
{
|
||||||
private EntityManagerInterface $em;
|
|
||||||
|
|
||||||
private EventsOnUserSubscriptionCreator $eventsOnUserSubscriptionCreator;
|
|
||||||
|
|
||||||
private LoggerInterface $logger;
|
|
||||||
|
|
||||||
private MapCalendarToUser $mapCalendarToUser;
|
|
||||||
|
|
||||||
private MSGraphUserRepository $userRepository;
|
|
||||||
|
|
||||||
public function __construct(
|
public function __construct(
|
||||||
EntityManagerInterface $em,
|
private readonly EntityManagerInterface $em,
|
||||||
EventsOnUserSubscriptionCreator $eventsOnUserSubscriptionCreator,
|
private readonly EventsOnUserSubscriptionCreator $eventsOnUserSubscriptionCreator,
|
||||||
LoggerInterface $logger,
|
private readonly LoggerInterface $logger,
|
||||||
MapCalendarToUser $mapCalendarToUser,
|
private readonly MapCalendarToUser $mapCalendarToUser,
|
||||||
MSGraphUserRepository $userRepository
|
private readonly UserRepositoryInterface $userRepository,
|
||||||
|
private readonly MSUserAbsenceSync $userAbsenceSync,
|
||||||
) {
|
) {
|
||||||
parent::__construct('chill:calendar:msgraph-user-map-subscribe');
|
parent::__construct('chill:calendar:msgraph-user-map-subscribe');
|
||||||
|
|
||||||
$this->em = $em;
|
|
||||||
$this->eventsOnUserSubscriptionCreator = $eventsOnUserSubscriptionCreator;
|
|
||||||
$this->logger = $logger;
|
|
||||||
$this->mapCalendarToUser = $mapCalendarToUser;
|
|
||||||
$this->userRepository = $userRepository;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
public function execute(InputInterface $input, OutputInterface $output): int
|
public function execute(InputInterface $input, OutputInterface $output): int
|
||||||
@ -67,83 +55,109 @@ class MapAndSubscribeUserCalendarCommand extends Command
|
|||||||
/** @var DateInterval $interval the interval before the end of the expiration */
|
/** @var DateInterval $interval the interval before the end of the expiration */
|
||||||
$interval = new DateInterval('P1D');
|
$interval = new DateInterval('P1D');
|
||||||
$expiration = (new DateTimeImmutable('now'))->add(new DateInterval($input->getOption('subscription-duration')));
|
$expiration = (new DateTimeImmutable('now'))->add(new DateInterval($input->getOption('subscription-duration')));
|
||||||
$total = $this->userRepository->countByMostOldSubscriptionOrWithoutSubscriptionOrData($interval);
|
$users = $this->userRepository->findAllAsArray('fr');
|
||||||
$created = 0;
|
$created = 0;
|
||||||
$renewed = 0;
|
$renewed = 0;
|
||||||
|
|
||||||
$this->logger->info(self::class . ' the number of user to get - renew', [
|
$this->logger->info(self::class . ' start user to get - renew', [
|
||||||
'total' => $total,
|
|
||||||
'expiration' => $expiration->format(DateTimeImmutable::ATOM),
|
'expiration' => $expiration->format(DateTimeImmutable::ATOM),
|
||||||
]);
|
]);
|
||||||
|
|
||||||
while ($offset < $total) {
|
foreach ($users as $u) {
|
||||||
$users = $this->userRepository->findByMostOldSubscriptionOrWithoutSubscriptionOrData(
|
++$offset;
|
||||||
$interval,
|
|
||||||
$limit,
|
|
||||||
$offset
|
|
||||||
);
|
|
||||||
|
|
||||||
foreach ($users as $user) {
|
if (false === $u['enabled']) {
|
||||||
if (!$this->mapCalendarToUser->hasUserId($user)) {
|
continue;
|
||||||
$this->mapCalendarToUser->writeMetadata($user);
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($this->mapCalendarToUser->hasUserId($user)) {
|
|
||||||
// we first try to renew an existing subscription, if any.
|
|
||||||
// if not, or if it fails, we try to create a new one
|
|
||||||
if ($this->mapCalendarToUser->hasActiveSubscription($user)) {
|
|
||||||
$this->logger->debug(self::class . ' renew a subscription for', [
|
|
||||||
'userId' => $user->getId(),
|
|
||||||
'username' => $user->getUsernameCanonical(),
|
|
||||||
]);
|
|
||||||
|
|
||||||
['secret' => $secret, 'id' => $id, 'expiration' => $expirationTs]
|
|
||||||
= $this->eventsOnUserSubscriptionCreator->renewSubscriptionForUser($user, $expiration);
|
|
||||||
$this->mapCalendarToUser->writeSubscriptionMetadata($user, $expirationTs, $id, $secret);
|
|
||||||
|
|
||||||
if (0 !== $expirationTs) {
|
|
||||||
++$renewed;
|
|
||||||
} else {
|
|
||||||
$this->logger->warning(self::class . ' could not renew subscription for a user', [
|
|
||||||
'userId' => $user->getId(),
|
|
||||||
'username' => $user->getUsernameCanonical(),
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
if (!$this->mapCalendarToUser->hasActiveSubscription($user)) {
|
|
||||||
$this->logger->debug(self::class . ' create a subscription for', [
|
|
||||||
'userId' => $user->getId(),
|
|
||||||
'username' => $user->getUsernameCanonical(),
|
|
||||||
]);
|
|
||||||
|
|
||||||
['secret' => $secret, 'id' => $id, 'expiration' => $expirationTs]
|
|
||||||
= $this->eventsOnUserSubscriptionCreator->createSubscriptionForUser($user, $expiration);
|
|
||||||
$this->mapCalendarToUser->writeSubscriptionMetadata($user, $expirationTs, $id, $secret);
|
|
||||||
|
|
||||||
if (0 !== $expirationTs) {
|
|
||||||
++$created;
|
|
||||||
} else {
|
|
||||||
$this->logger->warning(self::class . ' could not create subscription for a user', [
|
|
||||||
'userId' => $user->getId(),
|
|
||||||
'username' => $user->getUsernameCanonical(),
|
|
||||||
]);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
++$offset;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->em->flush();
|
$user = $this->userRepository->find($u['id']);
|
||||||
$this->em->clear();
|
|
||||||
|
if (null === $user) {
|
||||||
|
$this->logger->error("could not find user by id", ['uid' => $u['id']]);
|
||||||
|
$output->writeln("could not find user by id : " . $u['id']);
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!$this->mapCalendarToUser->hasUserId($user)) {
|
||||||
|
$user = $this->mapCalendarToUser->writeMetadata($user);
|
||||||
|
|
||||||
|
// if user still does not have userid, continue
|
||||||
|
if (!$this->mapCalendarToUser->hasUserId($user)) {
|
||||||
|
$this->logger->warning("user does not have a counterpart on ms api", ['userId' => $user->getId(), 'email' => $user->getEmail()]);
|
||||||
|
$output->writeln(sprintf("giving up for user with email %s and id %s", $user->getEmail(), $user->getId()));
|
||||||
|
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// sync user absence
|
||||||
|
try {
|
||||||
|
$this->userAbsenceSync->syncUserAbsence($user);
|
||||||
|
} catch (UserAbsenceSyncException $e) {
|
||||||
|
$this->logger->error("could not sync user absence", ['userId' => $user->getId(), 'email' => $user->getEmail(), 'exception' => $e->getTraceAsString(), "message" => $e->getMessage()]);
|
||||||
|
$output->writeln(sprintf("Could not sync user absence: id: %s and email: %s", $user->getId(), $user->getEmail()));
|
||||||
|
throw $e;
|
||||||
|
}
|
||||||
|
|
||||||
|
// we first try to renew an existing subscription, if any.
|
||||||
|
// if not, or if it fails, we try to create a new one
|
||||||
|
if ($this->mapCalendarToUser->hasActiveSubscription($user)) {
|
||||||
|
$this->logger->debug(self::class . ' renew a subscription for', [
|
||||||
|
'userId' => $user->getId(),
|
||||||
|
'username' => $user->getUsernameCanonical(),
|
||||||
|
]);
|
||||||
|
|
||||||
|
['secret' => $secret, 'id' => $id, 'expiration' => $expirationTs]
|
||||||
|
= $this->eventsOnUserSubscriptionCreator->renewSubscriptionForUser($user, $expiration);
|
||||||
|
$this->mapCalendarToUser->writeSubscriptionMetadata($user, $expirationTs, $id, $secret);
|
||||||
|
|
||||||
|
if (0 !== $expirationTs) {
|
||||||
|
++$renewed;
|
||||||
|
} else {
|
||||||
|
$this->logger->warning(self::class . ' could not renew subscription for a user', [
|
||||||
|
'userId' => $user->getId(),
|
||||||
|
'username' => $user->getUsernameCanonical(),
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!$this->mapCalendarToUser->hasActiveSubscription($user)) {
|
||||||
|
$this->logger->debug(self::class . ' create a subscription for', [
|
||||||
|
'userId' => $user->getId(),
|
||||||
|
'username' => $user->getUsernameCanonical(),
|
||||||
|
]);
|
||||||
|
|
||||||
|
['secret' => $secret, 'id' => $id, 'expiration' => $expirationTs]
|
||||||
|
= $this->eventsOnUserSubscriptionCreator->createSubscriptionForUser($user, $expiration);
|
||||||
|
$this->mapCalendarToUser->writeSubscriptionMetadata($user, $expirationTs, $id, $secret);
|
||||||
|
|
||||||
|
if (0 !== $expirationTs) {
|
||||||
|
++$created;
|
||||||
|
} else {
|
||||||
|
$this->logger->warning(self::class . ' could not create subscription for a user', [
|
||||||
|
'userId' => $user->getId(),
|
||||||
|
'username' => $user->getUsernameCanonical(),
|
||||||
|
]);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
if (0 === $offset % $limit) {
|
||||||
|
$this->em->flush();
|
||||||
|
$this->em->clear();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$this->em->flush();
|
||||||
|
$this->em->clear();
|
||||||
|
|
||||||
$this->logger->warning(self::class . ' process executed', [
|
$this->logger->warning(self::class . ' process executed', [
|
||||||
'created' => $created,
|
'created' => $created,
|
||||||
'renewed' => $renewed,
|
'renewed' => $renewed,
|
||||||
]);
|
]);
|
||||||
|
|
||||||
|
$output->writeln("users synchronized");
|
||||||
|
|
||||||
return 0;
|
return 0;
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -152,7 +166,7 @@ class MapAndSubscribeUserCalendarCommand extends Command
|
|||||||
parent::configure();
|
parent::configure();
|
||||||
|
|
||||||
$this
|
$this
|
||||||
->setDescription('MSGraph: collect user metadata and create subscription on events for users')
|
->setDescription('MSGraph: collect user metadata and create subscription on events for users, and sync the user absence-presence')
|
||||||
->addOption(
|
->addOption(
|
||||||
'renew-before-end-interval',
|
'renew-before-end-interval',
|
||||||
'r',
|
'r',
|
||||||
|
@ -0,0 +1,20 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Chill is a software for social workers
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view
|
||||||
|
* the LICENSE file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Chill\CalendarBundle\Exception;
|
||||||
|
|
||||||
|
class UserAbsenceSyncException extends \LogicException
|
||||||
|
{
|
||||||
|
public function __construct(string $message = "", int $code = 20_230_706, ?\Throwable $previous = null)
|
||||||
|
{
|
||||||
|
parent::__construct($message, $code, $previous);
|
||||||
|
}
|
||||||
|
}
|
@ -1,84 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Chill is a software for social workers.
|
|
||||||
*
|
|
||||||
* For the full copyright and license information, please view
|
|
||||||
* the LICENSE file that was distributed with this source code.
|
|
||||||
*/
|
|
||||||
|
|
||||||
declare(strict_types=1);
|
|
||||||
|
|
||||||
/*
|
|
||||||
* Chill is a software for social workers
|
|
||||||
*
|
|
||||||
* For the full copyright and license information, please view
|
|
||||||
* the LICENSE file that was distributed with this source code.
|
|
||||||
*/
|
|
||||||
|
|
||||||
namespace Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph;
|
|
||||||
|
|
||||||
use Chill\MainBundle\Entity\User;
|
|
||||||
use DateInterval;
|
|
||||||
use Doctrine\ORM\EntityManagerInterface;
|
|
||||||
use Doctrine\ORM\Query\ResultSetMapping;
|
|
||||||
use Doctrine\ORM\Query\ResultSetMappingBuilder;
|
|
||||||
use function strtr;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* Contains classes and methods for fetching users with some calendar metadatas.
|
|
||||||
*/
|
|
||||||
class MSGraphUserRepository
|
|
||||||
{
|
|
||||||
private const MOST_OLD_SUBSCRIPTION_OR_ANY_MS_GRAPH = <<<'SQL'
|
|
||||||
select
|
|
||||||
{select}
|
|
||||||
from users u
|
|
||||||
where
|
|
||||||
NOT attributes ?? 'msgraph'
|
|
||||||
OR NOT attributes->'msgraph' ?? 'subscription_events_expiration'
|
|
||||||
OR (attributes->'msgraph' ?? 'subscription_events_expiration' AND (attributes->'msgraph'->>'subscription_events_expiration')::int < EXTRACT(EPOCH FROM (NOW() + :interval::interval)))
|
|
||||||
LIMIT :limit OFFSET :offset
|
|
||||||
;
|
|
||||||
SQL;
|
|
||||||
|
|
||||||
private EntityManagerInterface $entityManager;
|
|
||||||
|
|
||||||
public function __construct(EntityManagerInterface $entityManager)
|
|
||||||
{
|
|
||||||
$this->entityManager = $entityManager;
|
|
||||||
}
|
|
||||||
|
|
||||||
public function countByMostOldSubscriptionOrWithoutSubscriptionOrData(DateInterval $interval): int
|
|
||||||
{
|
|
||||||
$rsm = new ResultSetMapping();
|
|
||||||
$rsm->addScalarResult('c', 'c');
|
|
||||||
|
|
||||||
$sql = strtr(self::MOST_OLD_SUBSCRIPTION_OR_ANY_MS_GRAPH, [
|
|
||||||
'{select}' => 'COUNT(u) AS c',
|
|
||||||
'LIMIT :limit OFFSET :offset' => '',
|
|
||||||
]);
|
|
||||||
|
|
||||||
return $this->entityManager->createNativeQuery($sql, $rsm)->setParameters([
|
|
||||||
'interval' => $interval,
|
|
||||||
])->getSingleScalarResult();
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @return array|User[]
|
|
||||||
*/
|
|
||||||
public function findByMostOldSubscriptionOrWithoutSubscriptionOrData(DateInterval $interval, int $limit = 50, int $offset = 0): array
|
|
||||||
{
|
|
||||||
$rsm = new ResultSetMappingBuilder($this->entityManager);
|
|
||||||
$rsm->addRootEntityFromClassMetadata(User::class, 'u');
|
|
||||||
|
|
||||||
return $this->entityManager->createNativeQuery(
|
|
||||||
strtr(self::MOST_OLD_SUBSCRIPTION_OR_ANY_MS_GRAPH, ['{select}' => $rsm->generateSelectClause()]),
|
|
||||||
$rsm
|
|
||||||
)->setParameters([
|
|
||||||
'interval' => $interval,
|
|
||||||
'limit' => $limit,
|
|
||||||
'offset' => $offset,
|
|
||||||
])->getResult();
|
|
||||||
}
|
|
||||||
}
|
|
@ -0,0 +1,69 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Chill is a software for social workers
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view
|
||||||
|
* the LICENSE file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph;
|
||||||
|
|
||||||
|
use Chill\CalendarBundle\Exception\UserAbsenceSyncException;
|
||||||
|
use Chill\MainBundle\Entity\User;
|
||||||
|
use Psr\Log\LoggerInterface;
|
||||||
|
use Symfony\Component\Clock\ClockInterface;
|
||||||
|
use Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface;
|
||||||
|
use Symfony\Contracts\HttpClient\Exception\DecodingExceptionInterface;
|
||||||
|
use Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface;
|
||||||
|
use Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface;
|
||||||
|
use Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface;
|
||||||
|
use Symfony\Contracts\HttpClient\HttpClientInterface;
|
||||||
|
|
||||||
|
final readonly class MSUserAbsenceReader implements MSUserAbsenceReaderInterface
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
private HttpClientInterface $machineHttpClient,
|
||||||
|
private MapCalendarToUser $mapCalendarToUser,
|
||||||
|
private ClockInterface $clock,
|
||||||
|
) {
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @throw UserAbsenceSyncException when the data cannot be reached or is not valid from microsoft
|
||||||
|
*/
|
||||||
|
public function isUserAbsent(User $user): bool|null
|
||||||
|
{
|
||||||
|
$id = $this->mapCalendarToUser->getUserId($user);
|
||||||
|
|
||||||
|
if (null === $id) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
$automaticRepliesSettings = $this->machineHttpClient
|
||||||
|
->request('GET', 'users/' . $id . '/mailboxSettings/automaticRepliesSetting')
|
||||||
|
->toArray(true);
|
||||||
|
} catch (ClientExceptionInterface|DecodingExceptionInterface|RedirectionExceptionInterface|TransportExceptionInterface $e) {
|
||||||
|
throw new UserAbsenceSyncException("Error receiving response for mailboxSettings", 0, $e);
|
||||||
|
} catch (ServerExceptionInterface $e) {
|
||||||
|
throw new UserAbsenceSyncException("Server error receiving response for mailboxSettings", 0, $e);
|
||||||
|
}
|
||||||
|
|
||||||
|
if (!array_key_exists("status", $automaticRepliesSettings)) {
|
||||||
|
throw new \LogicException("no key \"status\" on automatic replies settings: " . json_encode($automaticRepliesSettings, JSON_THROW_ON_ERROR));
|
||||||
|
}
|
||||||
|
|
||||||
|
return match ($automaticRepliesSettings['status']) {
|
||||||
|
'disabled' => false,
|
||||||
|
'alwaysEnabled' => true,
|
||||||
|
'scheduled' =>
|
||||||
|
RemoteEventConverter::convertStringDateWithoutTimezone($automaticRepliesSettings['scheduledStartDateTime']['dateTime']) < $this->clock->now()
|
||||||
|
&& RemoteEventConverter::convertStringDateWithoutTimezone($automaticRepliesSettings['scheduledEndDateTime']['dateTime']) > $this->clock->now(),
|
||||||
|
default => throw new UserAbsenceSyncException("this status is not documented by Microsoft")
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@ -0,0 +1,22 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Chill is a software for social workers
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view
|
||||||
|
* the LICENSE file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph;
|
||||||
|
|
||||||
|
use Chill\MainBundle\Entity\User;
|
||||||
|
|
||||||
|
interface MSUserAbsenceReaderInterface
|
||||||
|
{
|
||||||
|
/**
|
||||||
|
* @throw UserAbsenceSyncException when the data cannot be reached or is not valid from microsoft
|
||||||
|
*/
|
||||||
|
public function isUserAbsent(User $user): bool|null;
|
||||||
|
}
|
@ -0,0 +1,50 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Chill is a software for social workers
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view
|
||||||
|
* the LICENSE file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph;
|
||||||
|
|
||||||
|
use Chill\MainBundle\Entity\User;
|
||||||
|
use Psr\Log\LoggerInterface;
|
||||||
|
use Symfony\Component\Clock\ClockInterface;
|
||||||
|
|
||||||
|
readonly class MSUserAbsenceSync
|
||||||
|
{
|
||||||
|
public function __construct(
|
||||||
|
private MSUserAbsenceReaderInterface $absenceReader,
|
||||||
|
private ClockInterface $clock,
|
||||||
|
private LoggerInterface $logger,
|
||||||
|
) {
|
||||||
|
}
|
||||||
|
|
||||||
|
public function syncUserAbsence(User $user): void
|
||||||
|
{
|
||||||
|
$absence = $this->absenceReader->isUserAbsent($user);
|
||||||
|
|
||||||
|
if (null === $absence) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($absence === $user->isAbsent()) {
|
||||||
|
// nothing to do
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->logger->info("will change user absence", ['userId' => $user->getId()]);
|
||||||
|
|
||||||
|
if ($absence) {
|
||||||
|
$this->logger->debug("make user absent", ['userId' => $user->getId()]);
|
||||||
|
$user->setAbsenceStart($this->clock->now());
|
||||||
|
} else {
|
||||||
|
$this->logger->debug("make user present", ['userId' => $user->getId()]);
|
||||||
|
$user->setAbsenceStart(null);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
@ -23,6 +23,8 @@ use Chill\CalendarBundle\Command\MapAndSubscribeUserCalendarCommand;
|
|||||||
use Chill\CalendarBundle\Controller\RemoteCalendarConnectAzureController;
|
use Chill\CalendarBundle\Controller\RemoteCalendarConnectAzureController;
|
||||||
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MachineHttpClient;
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MachineHttpClient;
|
||||||
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MachineTokenStorage;
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MachineTokenStorage;
|
||||||
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MSUserAbsenceReaderInterface;
|
||||||
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MSUserAbsenceSync;
|
||||||
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraphRemoteCalendarConnector;
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraphRemoteCalendarConnector;
|
||||||
use Chill\CalendarBundle\RemoteCalendar\Connector\NullRemoteCalendarConnector;
|
use Chill\CalendarBundle\RemoteCalendar\Connector\NullRemoteCalendarConnector;
|
||||||
use Chill\CalendarBundle\RemoteCalendar\Connector\RemoteCalendarConnectorInterface;
|
use Chill\CalendarBundle\RemoteCalendar\Connector\RemoteCalendarConnectorInterface;
|
||||||
@ -37,17 +39,13 @@ class RemoteCalendarCompilerPass implements CompilerPassInterface
|
|||||||
public function process(ContainerBuilder $container)
|
public function process(ContainerBuilder $container)
|
||||||
{
|
{
|
||||||
$config = $container->getParameter('chill_calendar');
|
$config = $container->getParameter('chill_calendar');
|
||||||
$connector = null;
|
|
||||||
|
|
||||||
if (!$config['remote_calendars_sync']['enabled']) {
|
if (true === $config['remote_calendars_sync']['microsoft_graph']['enabled']) {
|
||||||
$connector = NullRemoteCalendarConnector::class;
|
|
||||||
}
|
|
||||||
|
|
||||||
if ($config['remote_calendars_sync']['microsoft_graph']['enabled']) {
|
|
||||||
$connector = MSGraphRemoteCalendarConnector::class;
|
$connector = MSGraphRemoteCalendarConnector::class;
|
||||||
|
|
||||||
$container->setAlias(HttpClientInterface::class . ' $machineHttpClient', MachineHttpClient::class);
|
$container->setAlias(HttpClientInterface::class . ' $machineHttpClient', MachineHttpClient::class);
|
||||||
} else {
|
} else {
|
||||||
|
$connector = NullRemoteCalendarConnector::class;
|
||||||
// remove services which cannot be loaded
|
// remove services which cannot be loaded
|
||||||
$container->removeDefinition(MapAndSubscribeUserCalendarCommand::class);
|
$container->removeDefinition(MapAndSubscribeUserCalendarCommand::class);
|
||||||
$container->removeDefinition(AzureGrantAdminConsentAndAcquireToken::class);
|
$container->removeDefinition(AzureGrantAdminConsentAndAcquireToken::class);
|
||||||
@ -55,16 +53,14 @@ class RemoteCalendarCompilerPass implements CompilerPassInterface
|
|||||||
$container->removeDefinition(MachineTokenStorage::class);
|
$container->removeDefinition(MachineTokenStorage::class);
|
||||||
$container->removeDefinition(MachineHttpClient::class);
|
$container->removeDefinition(MachineHttpClient::class);
|
||||||
$container->removeDefinition(MSGraphRemoteCalendarConnector::class);
|
$container->removeDefinition(MSGraphRemoteCalendarConnector::class);
|
||||||
|
$container->removeDefinition(MSUserAbsenceReaderInterface::class);
|
||||||
|
$container->removeDefinition(MSUserAbsenceSync::class);
|
||||||
}
|
}
|
||||||
|
|
||||||
if (!$container->hasAlias(Azure::class) && $container->hasDefinition('knpu.oauth2.client.azure')) {
|
if (!$container->hasAlias(Azure::class) && $container->hasDefinition('knpu.oauth2.client.azure')) {
|
||||||
$container->setAlias(Azure::class, 'knpu.oauth2.provider.azure');
|
$container->setAlias(Azure::class, 'knpu.oauth2.provider.azure');
|
||||||
}
|
}
|
||||||
|
|
||||||
if (null === $connector) {
|
|
||||||
throw new RuntimeException('Could not configure remote calendar');
|
|
||||||
}
|
|
||||||
|
|
||||||
foreach ([
|
foreach ([
|
||||||
NullRemoteCalendarConnector::class,
|
NullRemoteCalendarConnector::class,
|
||||||
MSGraphRemoteCalendarConnector::class, ] as $serviceId) {
|
MSGraphRemoteCalendarConnector::class, ] as $serviceId) {
|
||||||
|
@ -0,0 +1,176 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Chill is a software for social workers
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view
|
||||||
|
* the LICENSE file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Chill\CalendarBundle\Tests\RemoteCalendar\Connector\MSGraph;
|
||||||
|
|
||||||
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MapCalendarToUser;
|
||||||
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MSUserAbsenceReader;
|
||||||
|
use Chill\MainBundle\Entity\User;
|
||||||
|
use PHPUnit\Framework\TestCase;
|
||||||
|
use Prophecy\PhpUnit\ProphecyTrait;
|
||||||
|
use Symfony\Component\Clock\MockClock;
|
||||||
|
use Symfony\Component\HttpClient\MockHttpClient;
|
||||||
|
use Symfony\Component\HttpClient\Response\MockResponse;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @internal
|
||||||
|
* @coversNothing
|
||||||
|
*/
|
||||||
|
class MSUserAbsenceReaderTest extends TestCase
|
||||||
|
{
|
||||||
|
use ProphecyTrait;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @dataProvider provideDataTestUserAbsence
|
||||||
|
*/
|
||||||
|
public function testUserAbsenceReader(string $mockResponse, bool $expected, string $message): void
|
||||||
|
{
|
||||||
|
$user = new User();
|
||||||
|
$client = new MockHttpClient([new MockResponse($mockResponse)]);
|
||||||
|
$mapUser = $this->prophesize(MapCalendarToUser::class);
|
||||||
|
$mapUser->getUserId($user)->willReturn('1234');
|
||||||
|
$clock = new MockClock(new \DateTimeImmutable('2023-07-07T12:00:00'));
|
||||||
|
|
||||||
|
$absenceReader = new MSUserAbsenceReader($client, $mapUser->reveal(), $clock);
|
||||||
|
|
||||||
|
self::assertEquals($expected, $absenceReader->isUserAbsent($user), $message);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function testIsUserAbsentWithoutRemoteId(): void
|
||||||
|
{
|
||||||
|
$user = new User();
|
||||||
|
$client = new MockHttpClient();
|
||||||
|
|
||||||
|
$mapUser = $this->prophesize(MapCalendarToUser::class);
|
||||||
|
$mapUser->getUserId($user)->willReturn(null);
|
||||||
|
$clock = new MockClock(new \DateTimeImmutable('2023-07-07T12:00:00'));
|
||||||
|
|
||||||
|
$absenceReader = new MSUserAbsenceReader($client, $mapUser->reveal(), $clock);
|
||||||
|
|
||||||
|
self::assertNull($absenceReader->isUserAbsent($user), "when no user found, absence should be null");
|
||||||
|
}
|
||||||
|
|
||||||
|
public function provideDataTestUserAbsence(): iterable
|
||||||
|
{
|
||||||
|
// contains data that was retrieved from microsoft graph api on 2023-07-06
|
||||||
|
|
||||||
|
yield [
|
||||||
|
<<<'JSON'
|
||||||
|
{
|
||||||
|
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('4feb0ae3-7ffb-48dd-891e-c86b2cdeefd4')/mailboxSettings/automaticRepliesSetting",
|
||||||
|
"status": "disabled",
|
||||||
|
"externalAudience": "none",
|
||||||
|
"internalReplyMessage": "Je suis en congé.",
|
||||||
|
"externalReplyMessage": "",
|
||||||
|
"scheduledStartDateTime": {
|
||||||
|
"dateTime": "2023-07-06T12:00:00.0000000",
|
||||||
|
"timeZone": "UTC"
|
||||||
|
},
|
||||||
|
"scheduledEndDateTime": {
|
||||||
|
"dateTime": "2023-07-07T12:00:00.0000000",
|
||||||
|
"timeZone": "UTC"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
JSON,
|
||||||
|
false,
|
||||||
|
"User is present"
|
||||||
|
];
|
||||||
|
|
||||||
|
yield [
|
||||||
|
<<<'JSON'
|
||||||
|
{
|
||||||
|
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('4feb0ae3-7ffb-48dd-891e-c86b2cdeefd4')/mailboxSettings/automaticRepliesSetting",
|
||||||
|
"status": "scheduled",
|
||||||
|
"externalAudience": "none",
|
||||||
|
"internalReplyMessage": "Je suis en congé.",
|
||||||
|
"externalReplyMessage": "",
|
||||||
|
"scheduledStartDateTime": {
|
||||||
|
"dateTime": "2023-07-06T11:00:00.0000000",
|
||||||
|
"timeZone": "UTC"
|
||||||
|
},
|
||||||
|
"scheduledEndDateTime": {
|
||||||
|
"dateTime": "2023-07-21T11:00:00.0000000",
|
||||||
|
"timeZone": "UTC"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
JSON,
|
||||||
|
true,
|
||||||
|
'User is absent with absence scheduled, we are within this period'
|
||||||
|
];
|
||||||
|
|
||||||
|
yield [
|
||||||
|
<<<'JSON'
|
||||||
|
{
|
||||||
|
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('4feb0ae3-7ffb-48dd-891e-c86b2cdeefd4')/mailboxSettings/automaticRepliesSetting",
|
||||||
|
"status": "scheduled",
|
||||||
|
"externalAudience": "none",
|
||||||
|
"internalReplyMessage": "Je suis en congé.",
|
||||||
|
"externalReplyMessage": "",
|
||||||
|
"scheduledStartDateTime": {
|
||||||
|
"dateTime": "2023-07-08T11:00:00.0000000",
|
||||||
|
"timeZone": "UTC"
|
||||||
|
},
|
||||||
|
"scheduledEndDateTime": {
|
||||||
|
"dateTime": "2023-07-21T11:00:00.0000000",
|
||||||
|
"timeZone": "UTC"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
JSON,
|
||||||
|
false,
|
||||||
|
'User is present: absence is scheduled for later'
|
||||||
|
];
|
||||||
|
|
||||||
|
yield [
|
||||||
|
<<<'JSON'
|
||||||
|
{
|
||||||
|
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('4feb0ae3-7ffb-48dd-891e-c86b2cdeefd4')/mailboxSettings/automaticRepliesSetting",
|
||||||
|
"status": "scheduled",
|
||||||
|
"externalAudience": "none",
|
||||||
|
"internalReplyMessage": "Je suis en congé.",
|
||||||
|
"externalReplyMessage": "",
|
||||||
|
"scheduledStartDateTime": {
|
||||||
|
"dateTime": "2023-07-05T11:00:00.0000000",
|
||||||
|
"timeZone": "UTC"
|
||||||
|
},
|
||||||
|
"scheduledEndDateTime": {
|
||||||
|
"dateTime": "2023-07-06T11:00:00.0000000",
|
||||||
|
"timeZone": "UTC"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
JSON,
|
||||||
|
false,
|
||||||
|
'User is present: absence is past'
|
||||||
|
];
|
||||||
|
|
||||||
|
yield [
|
||||||
|
<<<'JSON'
|
||||||
|
{
|
||||||
|
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#users('4feb0ae3-7ffb-48dd-891e-c86b2cdeefd4')/mailboxSettings/automaticRepliesSetting",
|
||||||
|
"status": "alwaysEnabled",
|
||||||
|
"externalAudience": "none",
|
||||||
|
"internalReplyMessage": "Je suis en congé.",
|
||||||
|
"externalReplyMessage": "",
|
||||||
|
"scheduledStartDateTime": {
|
||||||
|
"dateTime": "2023-07-06T12:00:00.0000000",
|
||||||
|
"timeZone": "UTC"
|
||||||
|
},
|
||||||
|
"scheduledEndDateTime": {
|
||||||
|
"dateTime": "2023-07-07T12:00:00.0000000",
|
||||||
|
"timeZone": "UTC"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
JSON,
|
||||||
|
true,
|
||||||
|
"User is absent: absence is always enabled"
|
||||||
|
];
|
||||||
|
}
|
||||||
|
|
||||||
|
}
|
@ -0,0 +1,68 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
declare(strict_types=1);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Chill is a software for social workers
|
||||||
|
*
|
||||||
|
* For the full copyright and license information, please view
|
||||||
|
* the LICENSE file that was distributed with this source code.
|
||||||
|
*/
|
||||||
|
|
||||||
|
namespace Chill\CalendarBundle\Tests\RemoteCalendar\Connector\MSGraph;
|
||||||
|
|
||||||
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MSUserAbsenceReader;
|
||||||
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MSUserAbsenceReaderInterface;
|
||||||
|
use Chill\CalendarBundle\RemoteCalendar\Connector\MSGraph\MSUserAbsenceSync;
|
||||||
|
use Chill\MainBundle\Entity\User;
|
||||||
|
use PHPUnit\Framework\TestCase;
|
||||||
|
use Prophecy\PhpUnit\ProphecyTrait;
|
||||||
|
use Psr\Log\NullLogger;
|
||||||
|
use Symfony\Component\Clock\MockClock;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @internal
|
||||||
|
* @coversNothing
|
||||||
|
*/
|
||||||
|
class MSUserAbsenceSyncTest extends TestCase
|
||||||
|
{
|
||||||
|
use ProphecyTrait;
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @dataProvider provideDataTestSyncUserAbsence
|
||||||
|
*/
|
||||||
|
public function testSyncUserAbsence(User $user, ?bool $absenceFromMicrosoft, bool $expectedAbsence, ?\DateTimeImmutable $expectedAbsenceStart, string $message): void
|
||||||
|
{
|
||||||
|
$userAbsenceReader = $this->prophesize(MSUserAbsenceReaderInterface::class);
|
||||||
|
$userAbsenceReader->isUserAbsent($user)->willReturn($absenceFromMicrosoft);
|
||||||
|
|
||||||
|
$clock = new MockClock(new \DateTimeImmutable('2023-07-01T12:00:00'));
|
||||||
|
|
||||||
|
$syncer = new MSUserAbsenceSync($userAbsenceReader->reveal(), $clock, new NullLogger());
|
||||||
|
|
||||||
|
$syncer->syncUserAbsence($user);
|
||||||
|
|
||||||
|
self::assertEquals($expectedAbsence, $user->isAbsent(), $message);
|
||||||
|
self::assertEquals($expectedAbsenceStart, $user->getAbsenceStart(), $message);
|
||||||
|
}
|
||||||
|
|
||||||
|
public function provideDataTestSyncUserAbsence(): iterable
|
||||||
|
{
|
||||||
|
yield [new User(), false, false, null, "user present remains present"];
|
||||||
|
yield [new User(), true, true, new \DateTimeImmutable('2023-07-01T12:00:00'), "user present becomes absent"];
|
||||||
|
|
||||||
|
$user = new User();
|
||||||
|
$user->setAbsenceStart($abs = new \DateTimeImmutable("2023-07-01T12:00:00"));
|
||||||
|
yield [$user, true, true, $abs, "user absent remains absent"];
|
||||||
|
|
||||||
|
$user = new User();
|
||||||
|
$user->setAbsenceStart($abs = new \DateTimeImmutable("2023-07-01T12:00:00"));
|
||||||
|
yield [$user, false, false, null, "user absent becomes present"];
|
||||||
|
|
||||||
|
yield [new User(), null, false, null, "user not syncable: presence do not change"];
|
||||||
|
|
||||||
|
$user = new User();
|
||||||
|
$user->setAbsenceStart($abs = new \DateTimeImmutable("2023-07-01T12:00:00"));
|
||||||
|
yield [$user, null, true, $abs, "user not syncable: absence do not change"];
|
||||||
|
}
|
||||||
|
}
|
Loading…
x
Reference in New Issue
Block a user