Insert initial admin command

[TatevikGr]

Summary

• Added a console command to create/ensure a default administrator account.

Unit test

Are your changes covered with unit tests, and do they not break anything?

You can run the existing unit tests using this command:

vendor/bin/phpunit tests/

Code style

Have you checked that you code is well-documented and follows the PSR-2 coding
style?

You can check for this using this command:

vendor/bin/phpcs --standard=PSR2 src/ tests/

Other Information

If there's anything else that's important and relevant to your pull
request, mention that information here. This could include benchmarks,
or other information.

If you are updating any of the CHANGELOG files or are asked to update the
CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file.

Thanks for contributing to phpList!

Summary by CodeRabbit

• New Features

  • Added a console command to create/ensure a default administrator account.

• Documentation

  • Added a comprehensive repository Code Review Knowledge Base.
  • Simplified and clarified the pull request template with a minor grammar fix.

• Chores

  • Updated code review configuration with new review options and path-specific guidance.
  • Removed a legacy database initialization migration.

[coderabbitai]

📝 Walkthrough

Walkthrough

Adds repository review configuration and documentation, introduces a Symfony console command to ensure a default admin user, and removes a prior database migration that seeded the initial admin. No runtime behavior beyond initialization mechanisms is changed.

Changes

Cohort / File(s)	Summary
Configuration & Documentation \.coderabbit.yaml, \.github/AGENT.md, \.github/PULL_REQUEST_TEMPLATE.md	New YAML review options and path-specific review guidance added; comprehensive Code Review Knowledge Base document added; PR template simplified and minor grammar fix applied.
Admin Initialization (new command) src/Domain/Identity/Command/ImportDefaultsCommand.php	New Symfony console command ImportDefaultsCommand that ensures a default admin user exists, prompts (or reads env) for password, computes full privilege set, delegates creation to AdministratorManager, and flushes via EntityManager.
Migration Removal src/Migrations/Version20251103SeedInitialAdmin.php	Removed Doctrine migration that previously seeded the initial admin via SQL (PostgreSQL-specific up/down SQL and migration class deleted).

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant Cmd as ImportDefaultsCommand
    participant Repo as AdministratorRepository
    participant Manager as AdministratorManager
    participant EM as EntityManager

    User->>Cmd: run phplist:defaults:import
    Cmd->>Repo: findByLogin("admin")
    alt admin exists
        Cmd-->>User: "Default admin exists"
    else admin missing
        Cmd->>User: prompt hidden password
        User-->>Cmd: provide password
        Cmd->>Cmd: assemble privileges (PrivilegeFlag::cases)
        Cmd->>Manager: createAdministrator(dto)
        Manager->>EM: persist(entity)
        Cmd->>EM: flush()
        Cmd-->>User: "Default admin created"
    end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Pay attention to password input/validation and secret sourcing (env vs prompt).
• Verify privilege enumeration and DTO mapping in ImportDefaultsCommand.
• Check removal of migration for deployment/upgrade implications (DB seeding now manual/command-driven).

Pre-merge checks and finishing touches

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'Insert initial admin command' directly and specifically describes the main change: a new Symfony console command for creating a default admin user.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

✨ Finishing touches

• 📝 Generate docstrings

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch defalut-admin-command

---

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (2)

.github/AGENT.md (1)

10-15: Consider consistent list indentation.

The static analysis tool notes that the nested list uses 4-space indentation instead of the expected 2 spaces. While this doesn't break functionality, consistent indentation helps with markdown readability and tooling compatibility.

If you'd like to align with markdown linting standards, adjust the indentation:

 - **Core responsibilities:**
-    - Application bootstrapping and service configuration
-    - Database ORM (Doctrine) integration
-    - Command-line utilities (Symfony Console)
-    - Async email sending via Symfony Messenger
-    - Logging, configuration, routing, dependency injection
-    - Schema definition and updates
+  - Application bootstrapping and service configuration
+  - Database ORM (Doctrine) integration
+  - Command-line utilities (Symfony Console)
+  - Async email sending via Symfony Messenger
+  - Logging, configuration, routing, dependency injection
+  - Schema definition and updates

src/Domain/Identity/Command/ImportDefaultsCommand.php (1)

36-70: Flush placement is correct, but consider adding transaction handling.

The flush() call at line 70 is properly placed in the application layer (Command), which is acceptable per the coding guidelines. The manager correctly delegates only persist() to the domain layer, leaving orchestration to this handler.

However, the guidelines recommend: "Prefer $em->transactional(...) or explicit try/catch with rollback on failure."

Consider wrapping the admin creation in a transaction:

         $existing = $this->administratorRepository->findOneBy(['loginName' => $login]);
         if ($existing === null) {
-            // If creating the default admin, require a password. Prefer env var, else prompt for input.
-            $password = $envPassword;
-            if ($password === null) {
-                /** @var QuestionHelper $helper */
-                $helper = $this->getHelper('question');
-                $question = new Question('Enter password for default admin (login "admin"): ');
-                $question->setHidden(true);
-                $question->setHiddenFallback(false);
-                $password = (string) $helper->ask($input, $output, $question);
-                if (trim($password) === '') {
-                    $output->writeln('<error>Password must not be empty.</error>');
-                    return Command::FAILURE;
-                }
-            }
-
-            $dto = new CreateAdministratorDto(
-                loginName: $login,
-                password: $password,
-                email: $email,
-                isSuperUser: true,
-                privileges: $allPrivileges,
-            );
-            $admin = $this->administratorManager->createAdministrator($dto);
-            $this->entityManager->flush();
+            try {
+                // If creating the default admin, require a password. Prefer env var, else prompt for input.
+                $password = $envPassword;
+                if ($password === null) {
+                    /** @var QuestionHelper $helper */
+                    $helper = $this->getHelper('question');
+                    $question = new Question('Enter password for default admin (login "admin"): ');
+                    $question->setHidden(true);
+                    $question->setHiddenFallback(false);
+                    $password = (string) $helper->ask($input, $output, $question);
+                    if (trim($password) === '') {
+                        $output->writeln('<error>Password must not be empty.</error>');
+                        return Command::FAILURE;
+                    }
+                }
+
+                $dto = new CreateAdministratorDto(
+                    loginName: $login,
+                    password: $password,
+                    email: $email,
+                    isSuperUser: true,
+                    privileges: $allPrivileges,
+                );
+                $admin = $this->administratorManager->createAdministrator($dto);
+                $this->entityManager->flush();
+            } catch (\Exception $e) {
+                $output->writeln(sprintf('<error>Failed to create default admin: %s</error>', $e->getMessage()));
+                return Command::FAILURE;
+            }

As per coding guidelines.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5231d0a and 8513761.

📒 Files selected for processing (5)

• .coderabbit.yaml (1 hunks)
• .github/AGENT.md (1 hunks)
• .github/PULL_REQUEST_TEMPLATE.md (2 hunks)
• src/Domain/Identity/Command/ImportDefaultsCommand.php (1 hunks)
• src/Migrations/Version20251103SeedInitialAdmin.php (0 hunks)

💤 Files with no reviewable changes (1)

• src/Migrations/Version20251103SeedInitialAdmin.php

🧰 Additional context used

📓 Path-based instructions (2)

src/Domain/**

⚙️ CodeRabbit configuration file

src/Domain/**: You are reviewing PHP domain-layer code. Enforce strict domain purity:

• ❌ Do not allow infrastructure persistence side effects here.
• Flag ANY usage of Doctrine persistence APIs, especially:
• $entityManager->flush(...), $this->entityManager->flush(...)
• $em->persist(...), $em->remove(...)
• direct transaction control ($em->beginTransaction(), commit(), rollback())
• If found, request moving these calls to application-layer Command handlers or background Jobs.
• Also flag repositories in Domain that invoke flush/transactional logic; Domain repositories should be abstractions without side effects.
• Encourage domain events/outbox or return-values to signal write-intent, leaving orchestration to Commands/Jobs.

Files:

• src/Domain/Identity/Command/ImportDefaultsCommand.php

src/**/Command/**

⚙️ CodeRabbit configuration file

src/**/Command/**: Application layer (Commands/Handlers) is the right place to coordinate persistence.

• ✅ It is acceptable to call $entityManager->flush() here.
• Check that flush is used atomically (once per unit of work) after all domain operations.
• Ensure no domain entity or domain service is calling flush; only the handler orchestrates it.
• Prefer $em->transactional(...) or explicit try/catch with rollback on failure.

Files:

• src/Domain/Identity/Command/ImportDefaultsCommand.php

🧬 Code graph analysis (1)

src/Domain/Identity/Command/ImportDefaultsCommand.php (3)

src/Domain/Identity/Model/Dto/CreateAdministratorDto.php (1)

• CreateAdministratorDto (7-20)

src/Domain/Identity/Service/AdministratorManager.php (2)

• AdministratorManager (13-61)
• createAdministrator (24-37)

src/Domain/Identity/Model/Administrator.php (2)

• isSuperUser (151-154)
• getLoginName (90-93)

🪛 LanguageTool

.github/AGENT.md

[uncategorized] ~37-~37: The official name of this software platform is spelled with a capital “H”.
Context: ...-3.0 | --- ## 📁 Project Structure - .github/ CI/CD and PR templates - bin/ Symfony ...

(GITHUB)

🪛 markdownlint-cli2 (0.18.1)

.github/AGENT.md

10-10: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

---

11-11: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

---

12-12: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

---

13-13: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

---

14-14: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

---

15-15: Unordered list indentation
Expected: 2; Actual: 4

(MD007, ul-indent)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

• GitHub Check: phpList on PHP 8.1 [Build, Test]

🔇 Additional comments (7)

.github/PULL_REQUEST_TEMPLATE.md (2)

1-1: LGTM - Clean template simplification.

Replacing the verbose summary block with the @coderabbitai summary placeholder streamlines the template.

---

14-14: Good catch on the grammar fix.

"your code" reads much better than "you code".

.github/AGENT.md (1)

37-37: Minor capitalization: "GitHub" vs ".github/"

The static analysis tool flagged line 37 where it says ".github/" - it's suggesting "GitHub" with a capital H. However, in this context you're referring to the .github/ directory, not the GitHub platform, so the lowercase is actually correct for the directory path.

.coderabbit.yaml (2)

1-10: Clean configuration setup.

The schema reference, tone setting, and review options are properly configured. Disabling poems and collapsing walkthroughs will keep reviews focused.

---

11-38: Solid architectural guidance via path_instructions.

The three path-specific instruction blocks clearly define boundaries:

• Domain layer: strict purity, no flush/persist
• Command handlers: acceptable flush location with atomic usage
• Message handlers: persistence with idempotency checks

This aligns perfectly with DDD/hexagonal architecture principles and matches the coding guidelines.

src/Domain/Identity/Command/ImportDefaultsCommand.php (2)

28-34: Constructor DI looks good.

Clean dependency injection following Symfony best practices.

---

88-99: Helper method is clean.

The privilege enumeration logic is straightforward and well-documented with the @return annotation.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/Domain/Identity/Command/ImportDefaultsCommand.php (1)

69-70: Consider wrapping flush in transactional block for resilience.

The flush() call here is fine per coding guidelines for application-layer Commands. However, wrapping it in a transactional block would improve error handling and ensure proper rollback on failure.

Apply this pattern for better resilience:

-            $admin = $this->administratorManager->createAdministrator($dto);
-            $this->entityManager->flush();
+            $admin = $this->entityManager->transactional(function () use ($dto) {
+                return $this->administratorManager->createAdministrator($dto);
+            });

As per coding guidelines.

📜 Review details

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 8513761 and ba9d630.

📒 Files selected for processing (1)

• src/Domain/Identity/Command/ImportDefaultsCommand.php (1 hunks)

🧰 Additional context used

📓 Path-based instructions (2)

src/Domain/**

⚙️ CodeRabbit configuration file

src/Domain/**: You are reviewing PHP domain-layer code. Enforce strict domain purity:

• ❌ Do not allow infrastructure persistence side effects here.
• Flag ANY usage of Doctrine persistence APIs, especially:
• $entityManager->flush(...), $this->entityManager->flush(...)
• $em->persist(...), $em->remove(...)
• direct transaction control ($em->beginTransaction(), commit(), rollback())
• If found, request moving these calls to application-layer Command handlers or background Jobs.
• Also flag repositories in Domain that invoke flush/transactional logic; Domain repositories should be abstractions without side effects.
• Encourage domain events/outbox or return-values to signal write-intent, leaving orchestration to Commands/Jobs.

Files:

• src/Domain/Identity/Command/ImportDefaultsCommand.php

src/**/Command/**

⚙️ CodeRabbit configuration file

src/**/Command/**: Application layer (Commands/Handlers) is the right place to coordinate persistence.

• ✅ It is acceptable to call $entityManager->flush() here.
• Check that flush is used atomically (once per unit of work) after all domain operations.
• Ensure no domain entity or domain service is calling flush; only the handler orchestrates it.
• Prefer $em->transactional(...) or explicit try/catch with rollback on failure.

Files:

• src/Domain/Identity/Command/ImportDefaultsCommand.php

🧬 Code graph analysis (1)

src/Domain/Identity/Command/ImportDefaultsCommand.php (3)

src/Domain/Identity/Model/Dto/CreateAdministratorDto.php (1)

• CreateAdministratorDto (7-20)

src/Domain/Identity/Service/AdministratorManager.php (2)

• AdministratorManager (13-61)
• createAdministrator (24-37)

src/Domain/Identity/Model/Administrator.php (2)

• isSuperUser (151-154)
• getLoginName (90-93)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: phpList on PHP 8.1 [Build, Test]
• GitHub Check: phpList on PHP 8.1 [Build, Test]

🔇 Additional comments (4)

src/Domain/Identity/Command/ImportDefaultsCommand.php (4)

1-27: LGTM! Clean setup and imports.

The namespace, imports, and command metadata are well-structured. The constants provide clear defaults for the admin user.

---

28-34: LGTM! Proper dependency injection.

Constructor cleanly injects the necessary services. Using readonly properties is a nice touch.

---

77-83: Nice! Past issue resolved.

The previous review flagged line 81 for using the local $email variable instead of $existing->getEmail(). This has been corrected - the code now properly displays the existing admin's email.

---

88-99: LGTM! Clean privilege enumeration.

The helper correctly iterates over all privilege flags and grants them. The implementation is clear and the PHPDoc is accurate.