Merge pull request #25 from nextcloud/enh/gh-actions

Add php-cs check action

.github/workflows/lint-php-cs.yml

@@ -0,0 +1,59 @@
+# This workflow is provided via the organization template repository
+#
+# https://github.com/nextcloud/.github
+# https://docs.github.com/en/actions/learn-github-actions/sharing-workflows-with-your-organization
+
+name: Lint php-cs
+
+on:
+  push:
+    branches: [ main, test ]
+    paths:
+      - 'lib/**'
+      - 'templates/**'
+      - 'tests/**'
+      - 'vendor/**'
+      - 'vendor-bin/**'
+      - composer.lock
+      - composer.json
+  pull_request:
+    paths:
+      - 'lib/**'
+      - 'templates/**'
+      - 'tests/**'
+      - 'vendor/**'
+      - 'vendor-bin/**'
+      - composer.lock
+      - composer.json
+
+permissions:
+  contents: read
+
+concurrency:
+  group: lint-php-cs-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    name: php-cs
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # v3.5.2
+
+      - name: Set up php
+        uses: shivammathur/setup-php@c5fc0d8281aba02c7fda07d3a70cc5371548067d # v2
+        with:
+          php-version: 8.2
+          coverage: none
+          ini-file: development
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Install dependencies
+        run: composer i
+
+      - name: Lint
+        run: composer run cs:check || ( echo 'Please run `composer run cs:fix` to format your code' && exit 1 )

.github/workflows/phpunit.yml

@@ -56,7 +56,6 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: ${{ matrix.php-versions }}
-          tools: phpunit
           extensions: mbstring, iconv, fileinfo, intl, sqlite, pdo_sqlite, gd, zip
 
       - name: Set up PHPUnit
@@ -71,4 +70,4 @@ jobs:
 
       - name: PHPUnit
         working-directory: apps/${{ env.APP_NAME }}
-        run: phpunit -c tests/phpunit.xml
+        run: composer run test:unit

.gitignore

@@ -6,6 +6,7 @@ js/
 .vscode-upload.json
 .*.sw*
 node_modules
-.phpunit*.cache
+.php*.cache
+/composer.lock
 
 /vendor/

.php-cs-fixer.dist.php

@@ -0,0 +1,17 @@
+<?php
+declare(strict_types=1);
+
+require_once './vendor/autoload.php';
+
+use Nextcloud\CodingStandard\Config;
+
+$config = new Config();
+$config
+	->getFinder()
+	->notPath('build')
+	->notPath('l10n')
+	->notPath('src')
+	->notPath('node_modules')
+	->notPath('vendor')
+	->in(__DIR__);
+return $config;

composer.json

@@ -1,12 +1,29 @@
 {
-    "name": "nextcloud/assistant",
-    "authors": [
-        {
-            "name": "Julien Veyssier",
-            "email": "[email protected]"
-        }
-    ],
-    "require": {
-        "php": "^8.0"
-    }
+	"name": "nextcloud/assistant",
+	"authors": [
+		{
+			"name": "Julien Veyssier",
+			"email": "[email protected]"
+		},
+		{
+			"name": "Sami Finnilä",
+			"email": "[email protected]"
+		}
+	],
+	"require": {
+		"php": "^8.0"
+	},
+	"scripts": {
+		"lint": "find . -name \\*.php -not -path './vendor/*' -print0 | xargs -0 -n1 php -l",
+		"cs:check": "php-cs-fixer fix --dry-run --diff",
+		"cs:fix": "php-cs-fixer fix",
+		"psalm": "psalm.phar",
+		"test:unit": "phpunit --config tests/phpunit.xml"
+	},
+	"require-dev": {
+		"nextcloud/coding-standard": "^1.1",
+		"psalm/phar": "^5.16",
+		"nextcloud/ocp": "dev-master",
+		"phpunit/phpunit": "^9.5"
+	}
 }

lib/AppInfo/Application.php

@@ -3,28 +3,26 @@
 namespace OCA\TPAssistant\AppInfo;
 
 use OCA\TPAssistant\Listener\BeforeTemplateRenderedListener;
+use OCA\TPAssistant\Listener\FreePrompt\FreePromptReferenceListener;
 use OCA\TPAssistant\Listener\TaskFailedListener;
 use OCA\TPAssistant\Listener\TaskSuccessfulListener;
 use OCA\TPAssistant\Listener\Text2Image\Text2ImageReferenceListener;
-use OCA\TPAssistant\Reference\Text2ImageReferenceProvider;
-use OCA\TPAssistant\Reference\FreePromptReferenceProvider;
-use OCA\TPAssistant\Listener\FreePrompt\FreePromptReferenceListener;
-use OCA\TPAssistant\Listener\FreePrompt\FreePromptResultListener;
-use OCA\TPAssistant\Notification\Notifier;
 use OCA\TPAssistant\Listener\Text2Image\Text2ImageResultListener;
-use OCP\AppFramework\Http\Events\BeforeTemplateRenderedEvent;
-use OCP\Collaboration\Reference\RenderReferenceEvent;
-
+use OCA\TPAssistant\Notification\Notifier;
+use OCA\TPAssistant\Reference\FreePromptReferenceProvider;
+use OCA\TPAssistant\Reference\Text2ImageReferenceProvider;
 use OCP\AppFramework\App;
-use OCP\AppFramework\Bootstrap\IRegistrationContext;
 use OCP\AppFramework\Bootstrap\IBootContext;
+
 use OCP\AppFramework\Bootstrap\IBootstrap;
+use OCP\AppFramework\Bootstrap\IRegistrationContext;
+use OCP\AppFramework\Http\Events\BeforeTemplateRenderedEvent;
+use OCP\Collaboration\Reference\RenderReferenceEvent;
 use OCP\TextProcessing\Events\TaskFailedEvent as TextTaskFailedEvent;
 use OCP\TextProcessing\Events\TaskSuccessfulEvent as TextTaskSuccessfulEvent;
 use OCP\TextToImage\Events\TaskFailedEvent as TextToImageTaskFailedEvent;
 use OCP\TextToImage\Events\TaskSuccessfulEvent as TextToImageTaskSuccessfulEvent;
 
-
 class Application extends App implements IBootstrap {
 
 	public const APP_ID = 'assistant';
@@ -62,4 +60,3 @@ public function register(IRegistrationContext $context): void {
 	public function boot(IBootContext $context): void {
 	}
 }
-

lib/Controller/AssistantController.php

@@ -3,6 +3,7 @@
 namespace OCA\TPAssistant\Controller;
 
 use OCA\TPAssistant\AppInfo\Application;
+use OCA\TPAssistant\Service\AssistantService;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http;
 use OCP\AppFramework\Http\Attribute\BruteForceProtection;
@@ -11,9 +12,8 @@
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\Http\TemplateResponse;
 use OCP\AppFramework\Services\IInitialState;
-use OCP\IRequest;
 
-use OCA\TPAssistant\Service\AssistantService;
+use OCP\IRequest;
 
 class AssistantController extends Controller {
 

lib/Controller/ConfigController.php

@@ -2,13 +2,13 @@
 
 namespace OCA\TPAssistant\Controller;
 
+use OCA\TPAssistant\AppInfo\Application;
+use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http\Attribute\NoAdminRequired;
-use OCP\IConfig;
-use OCP\IRequest;
 use OCP\AppFramework\Http\DataResponse;
-use OCP\AppFramework\Controller;
+use OCP\IConfig;
 
-use OCA\TPAssistant\AppInfo\Application;
+use OCP\IRequest;
 use OCP\PreConditionNotMetException;
 
 class ConfigController extends Controller {

lib/Controller/FreePromptController.php

@@ -6,18 +6,16 @@
 namespace OCA\TPAssistant\Controller;
 
 use Exception;
-use OCA\TPAssistant\AppInfo\Application;
 use OCA\TPAssistant\Service\FreePrompt\FreePromptService;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
 use OCP\AppFramework\Http\DataResponse;
-use OCP\AppFramework\Http\TemplateResponse;
+
 use OCP\AppFramework\Services\IInitialState;
 use OCP\IRequest;
 
-use OCP\AppFramework\Http\Attribute\NoAdminRequired;
-use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
-
 class FreePromptController extends Controller {
 	public function __construct(
 		string $appName,

lib/Controller/Text2ImageController.php

@@ -6,23 +6,24 @@
 namespace OCA\TPAssistant\Controller;
 
 use Exception;
-use OCP\Db\Exception as DbException;
 use OCA\TPAssistant\AppInfo\Application;
 use OCA\TPAssistant\Service\Text2Image\Text2ImageHelperService;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http;
+use OCP\AppFramework\Http\Attribute\AnonRateLimit;
 use OCP\AppFramework\Http\Attribute\BruteForceProtection;
+use OCP\AppFramework\Http\Attribute\NoAdminRequired;
+use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
+use OCP\AppFramework\Http\Attribute\PublicPage;
 use OCP\AppFramework\Http\DataDisplayResponse;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\Http\TemplateResponse;
 use OCP\AppFramework\Services\IInitialState;
+
+use OCP\Db\Exception as DbException;
 use OCP\IRequest;
 use OCP\TextToImage\Exception\TaskFailureException;
-use OCP\AppFramework\Http\Attribute\AnonRateLimit;
 
-use OCP\AppFramework\Http\Attribute\NoAdminRequired;
-use OCP\AppFramework\Http\Attribute\NoCSRFRequired;
-use OCP\AppFramework\Http\Attribute\PublicPage;
 class Text2ImageController extends Controller {
 	public function __construct(
 		string $appName,
@@ -141,8 +142,8 @@ public function setVisibilityOfImageFiles(string $imageGenId, array $fileVisStat
 		} catch (Exception $e) {
 			$response = new DataResponse(['error' => $e->getMessage()], $e->getCode());
 			if($e->getCode() === Http::STATUS_BAD_REQUEST | Http::STATUS_UNAUTHORIZED) {
-				// Throttle brute force attempts				
-				$response->throttle(['action' => 'imageGenId']);				
+				// Throttle brute force attempts
+				$response->throttle(['action' => 'imageGenId']);
 			}
 			return $response;
 		}
@@ -152,8 +153,8 @@ public function setVisibilityOfImageFiles(string $imageGenId, array $fileVisStat
 
 	/**
 	 * Notify when image generation is ready
-	 * 
-	 * Does not need bruteforce protection since we respond with success anyways 
+	 *
+	 * Does not need bruteforce protection since we respond with success anyways
 	 * as we don't want to keep the front-end waiting.
 	 * However, we still use rate limiting to prevent timing attacks.
 	 */
@@ -170,11 +171,11 @@ public function notifyWhenReady(string $imageGenId): DataResponse {
 	}
 	/**
 	 * Cancel image generation
-	 * 
+	 *
 	 * Does not need bruteforce protection since we respond with success anyways
 	 * (In theory bruteforce may be possible by a response timing attack but the attacker
 	 * won't gain access to the generation since its deleted during the attack.)
-	 * 
+	 *
 	 * @param string $imageGenId
 	 * @return DataResponse
 	 */
@@ -205,7 +206,7 @@ public function showGenerationPage(?string $imageGenId, ?bool $forceEditMode = f
 			$this->initialStateService->provideInitialState('generation-page-inputs', ['image_gen_id' => $imageGenId, 'force_edit_mode' => $forceEditMode]);
 		} else {
 			$this->initialStateService->provideInitialState('generation-page-inputs', ['image_gen_id' => $imageGenId, 'force_edit_mode' => $forceEditMode]);
-		}		
+		}
 
 		return new TemplateResponse(Application::APP_ID, 'imageGenerationPage');
 	}

lib/Cron/CleanupImageGenerations.php

@@ -6,12 +6,12 @@
 
 namespace OCA\TPAssistant\Cron;
 
+use Exception;
 use OCA\TPAssistant\Db\Text2Image\ImageGenerationMapper;
 use OCA\TPAssistant\Service\Text2Image\CleanUpService;
 use OCP\AppFramework\Utility\ITimeFactory;
 use OCP\BackgroundJob\TimedJob;
 use Psr\Log\LoggerInterface;
-use Exception;
 
 class CleanupImageGenerations extends TimedJob {
 	public function __construct(

lib/Db/FreePrompt/PromptMapper.php

@@ -15,6 +15,7 @@
 use OCP\DB\Exception;
 use OCP\DB\QueryBuilder\IQueryBuilder;
 use OCP\IDBConnection;
+
 /**
  * @implements QBMapper<Prompt>
  */
@@ -182,7 +183,7 @@ public function cleanupUserPrompts(string $userId): void {
 
 		$lastPromptTs = [];
 		/** @var mixed[] $row */
-		while ($row = $req->fetch()) {			
+		while ($row = $req->fetch()) {
 			$lastPromptTs[] = (int)$row['timestamp'];
 		}
 		$req->closeCursor();

lib/Listener/BeforeTemplateRenderedListener.php

@@ -13,8 +13,8 @@
 use OCP\IConfig;
 use OCP\IUser;
 use OCP\IUserSession;
-use OCP\Util;
 use OCP\TextProcessing\IManager as ITextProcessingManager;
+use OCP\Util;
 
 class BeforeTemplateRenderedListener implements IEventListener {
 

lib/Listener/FreePrompt/FreePromptReferenceListener.php

@@ -12,11 +12,11 @@
 use OCP\EventDispatcher\IEventListener;
 use OCP\IConfig;
 use OCP\IGroupManager;
-use OCP\TextProcessing\FreePromptTaskType;
 use OCP\TextProcessing\IManager;
 use OCP\Util;
 
 use Psr\Log\LoggerInterface;
+
 /**
  * @implements IEventListener<RenderReferenceEvent>
  */