Skip to content

Dev #171

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

Open
TatevikGr wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Dev #171

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f9ee62d
Refactor: env (#170)
TatevikGr Jul 29, 2026
eb52ad4
Fix the order of route methods
tatevikg1 Jul 31, 2026
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
1 change: 1 addition & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,7 @@ jobs:
export PHPLIST_DATABASE_PASSWORD=${{ env.DB_PASSWORD }}
export PHPLIST_DATABASE_PORT=${{ job.services.mysql.ports['3306'] }}
export PHPLIST_DATABASE_HOST=127.0.0.1
export PHPLIST_DATABASE_PATH=
vendor/bin/phpunit tests/Integration/
continue-on-error: ${{matrix.php-versions == '8.0' }} # [temp-php8]
- name: Running static analysis
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,5 @@
/var/
/vendor/
.phpunit.result.cache
.env
.env.dist
3 changes: 2 additions & 1 deletion composer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@
},
"require": {
"php": "^8.1",
"phplist/core": "dev-main",
"phplist/core": "dev-dev",

@coderabbitai coderabbitai Bot Jul 31, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🩺 Stability & Availability | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

versions="$(
  curl -fsSL https://repo.packagist.org/p2/phplist/core.json |
    jq -r '.packages["phplist/core"][].version'
)"

printf '%s\n' "$versions"
grep -Fxq 'dev-dev' <<<"$versions"

Repository: phpList/rest-api

Length of output: 336

🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

echo "== composer relevant sections =="
python3 - <<'PY'
import json
with open("composer.json") as f:
    data=json.load f
for key in ("require","config","scripts"):
    if key in data:
        print(key)
        print(json.dumps(data[key], indent=2, sort_keys=True))
PY

echo "== lock file phplist/core =="
python3 - <<'PY'
from pathlib import Path
p=Path("composer.lock")
if p.exists():
    text=p.read_text()
    print("composer.lock_exists=true")
    for needle in ("phplist/core","createDotenvConfiguration","source","dist"):
        print(f"{needle}=", text.count(needle))
else:
    print("composer.lock_exists=false")
PY

echo "== lock branch/version strings =="
rg -n '"phplist/name"|"phplist/core"|phplist/core|dev-dev|dev-main|createDotenvConfiguration' composer.lock composer.json || true

Repository: phpList/rest-api

Length of output: 282

🏁 Script executed:

#!/usr/bin/env bash
set -euo pipefail

echo "== composer relevant sections =="
python3 - <<'PY'
import json
from pathlib import Path
data=json.loads(Path("composer.json").read_text())
for key in ("require","config","scripts"):
    if key in data:
        print(key)
        print(json.dumps(data[key], indent=2, sort_keys=True))
PY

echo "== composer.lock presence =="
python3 - <<'PY'
from pathlib import Path
p=Path("composer.lock")
print("composer.lock_exists=", p.exists())
if p.exists():
    text=p.read_text()
    for needle in ("phplist/core","createDotenvConfiguration","source","dist"):
        print(f"{needle}_count=", text.count(needle))
PY

echo "== lock/json branch/version strings =="
rg -n '"phplist/name"|"phplist/core"|phplist/core|dev-dev|dev-main|createDotenvConfiguration' composer.lock composer.json /tmp 2>/dev/null | head -80 || true

Repository: phpList/rest-api

Length of output: 3432

Use a resolvable phplist/core revision.

dev-dev is not published for phplist/core, and there is no VCS repository or lockfile entry to resolve it. Revert to a released version that contains the required script handler, publish dev-dev, or add the correct repository entry.

🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@composer.json` at line 45, Update the phplist/core dependency in
composer.json from the unresolvable dev-dev revision to a resolvable released
version containing the required script handler, or configure the correct VCS
repository and lockfile entry if dev-dev is required.

Source: MCP tools

"friendsofsymfony/rest-bundle": "*",
"symfony/test-pack": "^1.0",
"symfony/process": "^6.4",
Expand Down Expand Up @@ -85,6 +85,7 @@
"PhpList\\Core\\Composer\\ScriptHandler::createGeneralConfiguration",
"PhpList\\Core\\Composer\\ScriptHandler::createBundleConfiguration",
"PhpList\\Core\\Composer\\ScriptHandler::createRoutesConfiguration",
"PhpList\\Core\\Composer\\ScriptHandler::createDotenvConfiguration",
"PhpList\\Core\\Composer\\ScriptHandler::createParametersConfiguration",
"PhpList\\Core\\Composer\\ScriptHandler::clearAllCaches"
],
Expand Down
3 changes: 2 additions & 1 deletion phpunit.xml.dist
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,11 @@
xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/6.2/phpunit.xsd"
backupGlobals="false"
colors="true"
bootstrap="vendor/autoload.php"
bootstrap="tests/bootstrap.php"
>
<php>
<ini name="error_reporting" value="-1"/>
<server name="KERNEL_CLASS" value="PhpList\Core\Core\ApplicationKernel"/>
<server name="APP_ENV" value="test" force="true"/>
</php>
</phpunit>
120 changes: 60 additions & 60 deletions src/Messaging/Controller/TemplateController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -116,6 +116,66 @@ className: Template::class,
);
}

#[Route('', name: 'create', methods: ['POST'])]
#[OA\Post(
path: '/api/v2/templates',
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
'Returns a JSON response of created template.',
summary: 'Create a new template.',
requestBody: new OA\RequestBody(
description: 'Pass session credentials',
required: true,
content: new OA\MediaType(
mediaType: 'multipart/form-data',
schema: new OA\Schema(ref: '#/components/schemas/UpdateTemplateRequest')
)
),
tags: ['templates'],
parameters: [
new OA\Parameter(
name: 'php-auth-pw',
description: 'Session key obtained from login',
in: 'header',
required: true,
schema: new OA\Schema(type: 'string')
),
],
responses: [
new OA\Response(
response: 201,
description: 'Success',
content: new OA\JsonContent(
type: 'array',
items: new OA\Items(ref: '#/components/schemas/Template')
)
),
new OA\Response(
response: 403,
description: 'Failure',
content: new OA\JsonContent(ref: '#/components/schemas/UnauthorizedResponse')
),
new OA\Response(
response: 422,
description: 'Failure',
content: new OA\JsonContent(ref: '#/components/schemas/ValidationErrorResponse')
Comment on lines +125 to +160

@coderabbitai coderabbitai Bot Jul 31, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win

Correct the OpenAPI contract for createTemplates.

Line 130 documents UpdateTemplateRequest, but line 169 validates CreateTemplateRequest.
Lines 147-150 document an array, but line 174 returns one normalized Template.
Document the 409 response because UniqueTemplateTitleValidator throws ConflictHttpException for an existing title.

Proposed fix 
-                schema: new OA\Schema(ref: '`#/components/schemas/UpdateTemplateRequest`')
+                schema: new OA\Schema(ref: '`#/components/schemas/CreateTemplateRequest`')
...
-                content: new OA\JsonContent(
-                    type: 'array',
-                    items: new OA\Items(ref: '`#/components/schemas/Template`')
-                )
+                content: new OA\JsonContent(ref: '`#/components/schemas/Template`')
...
+            new OA\Response(
+                response: 409,
+                description: 'Failure',
+                content: new OA\JsonContent(ref: '`#/components/schemas/AlreadyExistsResponse`')
+            ),
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
requestBody: new OA\RequestBody(
description: 'Pass session credentials',
required: true,
content: new OA\MediaType(
mediaType: 'multipart/form-data',
schema: new OA\Schema(ref: '#/components/schemas/UpdateTemplateRequest')
)
),
tags: ['templates'],
parameters: [
new OA\Parameter(
name: 'php-auth-pw',
description: 'Session key obtained from login',
in: 'header',
required: true,
schema: new OA\Schema(type: 'string')
),
],
responses: [
new OA\Response(
response: 201,
description: 'Success',
content: new OA\JsonContent(
type: 'array',
items: new OA\Items(ref: '#/components/schemas/Template')
)
),
new OA\Response(
response: 403,
description: 'Failure',
content: new OA\JsonContent(ref: '#/components/schemas/UnauthorizedResponse')
),
new OA\Response(
response: 422,
description: 'Failure',
content: new OA\JsonContent(ref: '#/components/schemas/ValidationErrorResponse')
requestBody: new OA\RequestBody(
description: 'Pass session credentials',
required: true,
content: new OA\MediaType(
mediaType: 'multipart/form-data',
schema: new OA\Schema(ref: '`#/components/schemas/CreateTemplateRequest`')
)
),
tags: ['templates'],
parameters: [
new OA\Parameter(
name: 'php-auth-pw',
description: 'Session key obtained from login',
in: 'header',
required: true,
schema: new OA\Schema(type: 'string')
),
],
responses: [
new OA\Response(
response: 201,
description: 'Success',
content: new OA\JsonContent(ref: '`#/components/schemas/Template`')
),
new OA\Response(
response: 403,
description: 'Failure',
content: new OA\JsonContent(ref: '`#/components/schemas/UnauthorizedResponse`')
),
new OA\Response(
response: 409,
description: 'Failure',
content: new OA\JsonContent(ref: '`#/components/schemas/AlreadyExistsResponse`')
),
new OA\Response(
response: 422,
description: 'Failure',
content: new OA\JsonContent(ref: '`#/components/schemas/ValidationErrorResponse`')
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@src/Messaging/Controller/TemplateController.php` around lines 125 - 160,
Update the OpenAPI metadata for createTemplates to reference
CreateTemplateRequest instead of UpdateTemplateRequest, document the successful
response as a single Template object rather than an array, and add a 409
response for conflicts raised by UniqueTemplateTitleValidator.

),
]
)]
public function createTemplates(Request $request): JsonResponse
{
$this->requireAuthentication($request);

/** @var CreateTemplateRequest $createTemplateRequest */
$createTemplateRequest = $this->validator->validate($request, CreateTemplateRequest::class);
$template = $this->templateManager->create($createTemplateRequest->getDto());
$this->entityManager->flush();

return $this->json(
$this->normalizer->normalize($template),
Response::HTTP_CREATED
);
}

#[Route('/defaults', name: 'get_defaults', methods: ['GET'])]
#[OA\Get(
path: '/api/v2/templates/defaults',
Expand Down Expand Up @@ -263,66 +323,6 @@ public function getTemplate(
return $this->json($this->normalizer->normalize($template), Response::HTTP_OK);
}

#[Route('', name: 'create', methods: ['POST'])]
#[OA\Post(
path: '/api/v2/templates',
description: '🚧 **Status: Beta** – This method is under development. Avoid using in production. ' .
'Returns a JSON response of created template.',
summary: 'Create a new template.',
requestBody: new OA\RequestBody(
description: 'Pass session credentials',
required: true,
content: new OA\MediaType(
mediaType: 'multipart/form-data',
schema: new OA\Schema(ref: '#/components/schemas/UpdateTemplateRequest')
)
),
tags: ['templates'],
parameters: [
new OA\Parameter(
name: 'php-auth-pw',
description: 'Session key obtained from login',
in: 'header',
required: true,
schema: new OA\Schema(type: 'string')
),
],
responses: [
new OA\Response(
response: 201,
description: 'Success',
content: new OA\JsonContent(
type: 'array',
items: new OA\Items(ref: '#/components/schemas/Template')
)
),
new OA\Response(
response: 403,
description: 'Failure',
content: new OA\JsonContent(ref: '#/components/schemas/UnauthorizedResponse')
),
new OA\Response(
response: 422,
description: 'Failure',
content: new OA\JsonContent(ref: '#/components/schemas/ValidationErrorResponse')
),
]
)]
public function createTemplates(Request $request): JsonResponse
{
$this->requireAuthentication($request);

/** @var CreateTemplateRequest $createTemplateRequest */
$createTemplateRequest = $this->validator->validate($request, CreateTemplateRequest::class);
$template = $this->templateManager->create($createTemplateRequest->getDto());
$this->entityManager->flush();

return $this->json(
$this->normalizer->normalize($template),
Response::HTTP_CREATED
);
}

#[Route('/{templateId}', name: 'update', methods: ['PUT'])]
#[OA\Put(
path: '/api/v2/templates/{templateId}',
Expand Down
2 changes: 1 addition & 1 deletion tests/Integration/Common/Routing/RoutingTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ class RoutingTest extends WebTestCase
public function testRootUrlHasHtmlContentType()
{
$client = self::createClient();
$client->request('get', '/api/v2');
$client->request('GET', '/api/v2', server: ['HTTP_ACCEPT' => 'text/html']);

$response = $client->getResponse();

Expand Down
4 changes: 1 addition & 3 deletions tests/Integration/Composer/ScriptsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,7 @@ private function getAbsolutePublicDirectoryPath(): string
public static function publicDirectoryFilesDataProvider(): array
{
return [
'production entry point' => ['app.php'],
'development entry point' => ['app_dev.php'],
'testing entry point' => ['app_test.php'],
'entry point' => ['index.php'],
'.htaccess' => ['.htaccess'],
];
}
Expand Down
11 changes: 11 additions & 0 deletions tests/bootstrap.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

declare(strict_types=1);

use Symfony\Component\Dotenv\Dotenv;

require dirname(__DIR__) . '/vendor/autoload.php';

if (method_exists(Dotenv::class, 'bootEnv')) {
(new Dotenv())->bootEnv(dirname(__DIR__) . '/.env');
}
Loading