feat: deprecate OIDC and Service certificates in the admin

Remove both from the admin menu and mark the entities, controllers,
repositories and supporting classes @deprecated. The entities and their
tables stay, so existing rows survive and remain reachable by URL; every
page of the two now carries a warning saying so.

Author: turegjorup

CHANGELOG.md

@@ -7,6 +7,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+- [#98](https://github.com/itk-dev/devops_itksites/pull/98)
+  Deprecate OIDC and Service certificates
+  - Remove both from the admin menu
+  - Mark the entities, controllers, repositories and supporting classes
+    `@deprecated`
+  - Keep the entities and their tables, so existing rows survive and stay
+    reachable by URL
+  - Warn on every page of the two, since a direct link is now the only way in
 - [#96](https://github.com/itk-dev/devops_itksites/pull/96)
   Show the Service Agreements monthly price as Danish kroner,
   `12.500,50 kr.`, on index and detail

src/Controller/Admin/DashboardController.php

@@ -56,8 +56,9 @@ public function configureMenuItems(): iterable
         yield MenuItem::linkTo(InstallationCrudController::class, 'Installations', 'fas fa-folder');
         yield MenuItem::linkTo(SiteCrudController::class, 'Sites', 'fas fa-bookmark');
         yield MenuItem::linkTo(DomainCrudController::class, 'Domains', 'fas fa-link');
-        yield MenuItem::linkTo(OIDCCrudController::class, 'OIDC', 'fas fa-key');
-        yield MenuItem::linkTo(ServiceCertificateCrudController::class, 'Service certificates', 'fas fa-lock');
+        // OIDC and Service certificates are deprecated. The controllers and
+        // entities are kept so existing rows stay reachable by URL, but the
+        // menu no longer invites new registrations.
         yield MenuItem::linkTo(SecurityContractCrudController::class, 'Service Agreements', 'fas fa-file-contract');
         yield MenuItem::section('Dependencies');
         yield MenuItem::linkTo(PackageCrudController::class, 'Packages', 'fas fa-cube');

src/Controller/Admin/OIDCCrudController.php

@@ -6,6 +6,7 @@
 
 use App\Entity\OIDC;
 use App\Repository\SiteRepository;
+use App\Trait\DeprecatedCrudControllerTrait;
 use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
 use EasyCorp\Bundle\EasyAdminBundle\Field\ChoiceField;
 use EasyCorp\Bundle\EasyAdminBundle\Field\DateField;
@@ -14,8 +15,14 @@
 use EasyCorp\Bundle\EasyAdminBundle\Field\UrlField;
 use Symfony\Component\Translation\TranslatableMessage;
 
+/**
+ * @deprecated Removed from the admin menu. Kept so existing OIDC rows stay
+ *             reachable by URL until the entity itself goes away.
+ */
 class OIDCCrudController extends AbstractFullCrudController
 {
+    use DeprecatedCrudControllerTrait;
+
     public function __construct(
         private readonly SiteRepository $siteRepository)
     {
@@ -26,6 +33,12 @@ public static function getEntityFqcn(): string
         return OIDC::class;
     }
 
+    #[\Override]
+    protected function getDeprecationNotice(): string
+    {
+        return 'OIDC registrations are deprecated and no longer maintained here. This page is only reachable by direct link, so that existing entries stay readable. Do not add new ones.';
+    }
+
     #[\Override]
     public function configureFields(string $pageName): iterable
     {

src/Controller/Admin/ServiceCertificateCrudController.php

@@ -7,6 +7,7 @@
 use App\Entity\ServiceCertificate;
 use App\Form\Type\ServiceCertificate\ServiceType;
 use App\Repository\SiteRepository;
+use App\Trait\DeprecatedCrudControllerTrait;
 use EasyCorp\Bundle\EasyAdminBundle\Config\Crud;
 use EasyCorp\Bundle\EasyAdminBundle\Field\ChoiceField;
 use EasyCorp\Bundle\EasyAdminBundle\Field\CollectionField;
@@ -16,8 +17,14 @@
 use EasyCorp\Bundle\EasyAdminBundle\Field\UrlField;
 use Symfony\Component\Translation\TranslatableMessage;
 
+/**
+ * @deprecated Removed from the admin menu. Kept so existing service certificate
+ *             rows stay reachable by URL until the entity itself goes away.
+ */
 class ServiceCertificateCrudController extends AbstractFullCrudController
 {
+    use DeprecatedCrudControllerTrait;
+
     public function __construct(
         private readonly SiteRepository $siteRepository,
     ) {
@@ -28,6 +35,12 @@ public static function getEntityFqcn(): string
         return ServiceCertificate::class;
     }
 
+    #[\Override]
+    protected function getDeprecationNotice(): string
+    {
+        return 'Service certificates are deprecated and no longer maintained here. This page is only reachable by direct link, so that existing entries stay readable. Do not add new ones.';
+    }
+
     #[\Override]
     public function configureCrud(Crud $crud): Crud
     {

src/Entity/OIDC.php

@@ -11,6 +11,10 @@
 use Symfony\Component\Serializer\Attribute\SerializedName;
 use Symfony\Component\Validator\Constraints as Assert;
 
+/**
+ * @deprecated OIDC registrations are no longer maintained here. The entity is
+ *             kept so the table and its rows survive; do not add new usages.
+ */
 #[ORM\Entity(repositoryClass: OIDCRepository::class)]
 class OIDC extends AbstractBaseEntity
 {

src/Entity/ServiceCertificate.php

@@ -13,6 +13,10 @@
 use Symfony\Component\Serializer\Attribute\Groups;
 use Symfony\Component\Validator\Constraints as Assert;
 
+/**
+ * @deprecated Service certificates are no longer maintained here. The entity is
+ *             kept so the table and its rows survive; do not add new usages.
+ */
 #[ORM\Entity(repositoryClass: ServiceCertificateRepository::class)]
 class ServiceCertificate extends AbstractBaseEntity implements \Stringable
 {

src/Entity/ServiceCertificate/Service.php

@@ -11,6 +11,10 @@
 use Symfony\Component\Serializer\Attribute\Groups;
 use Symfony\Component\Validator\Constraints as Assert;
 
+/**
+ * @deprecated Together with {@see ServiceCertificate}. The entity is
+ *             kept so the table and its rows survive; do not add new usages.
+ */
 #[ORM\Entity(repositoryClass: ServiceRepository::class)]
 #[ORM\Table(name: 'service_certificate_service')]
 class Service extends AbstractBaseEntity implements \Stringable

src/EventListener/OIDCChangedListener.php

@@ -10,6 +10,9 @@
 use Doctrine\ORM\Event\PreFlushEventArgs;
 use Doctrine\ORM\Events;
 
+/**
+ * @deprecated together with {@see OIDC}
+ */
 #[AsEntityListener(event: Events::preFlush, method: 'preFlush', entity: OIDC::class)]
 class OIDCChangedListener
 {

src/Form/Type/ServiceCertificate/ServiceType.php

@@ -13,6 +13,9 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\Translation\TranslatableMessage;
 
+/**
+ * @deprecated together with {@see \App\Entity\ServiceCertificate}
+ */
 class ServiceType extends AbstractType
 {
     public function __construct(private readonly ServiceRepository $serviceRepository)

src/Repository/OIDCRepository.php

@@ -15,6 +15,8 @@
  * @method OIDC|null findOneBy(array $criteria, array $orderBy = null)
  * @method OIDC[]    findAll()
  * @method OIDC[]    findBy(array $criteria, array $orderBy = null, $limit = null, $offset = null)
+ *
+ * @deprecated together with {@see OIDC}
  */
 class OIDCRepository extends ServiceEntityRepository
 {