WIP: SLC 3 (#115)

* docs: move setup guide to wiki

* fix: associate cost to user rather than product

* test: assert unknown uploads

* feature: notification when file is not understood
for #62

* tweak: don't notify for new audits

* wip: split editor UI

* ui: split editor ui

* wip: split classes

* wip: split percentage ui complete

* wip: split percentage ui complete

* test: update qa

* asset: plus minus icons

* feature: splits and profits in product table
closes #105
closes #101

* style: splits list + editor

* bug fix: profit sum

* style: splits list border and margin

* test: assertions for profit/balance

* test: test profit calculations

* ci: wip behat on github actions

---------

Co-authored-by: rjbirkin <[email protected]>

.github/workflows/ci.yml

@@ -155,7 +155,29 @@ jobs:
           path: class/
           standard: phpcs.xml
 
-#  dev-deploy:
+#  behat:
+#    runs-on: ubuntu-latest
+#    needs: [ composer ]
+#    strategy:
+#      matrix:
+#        php: [ 8.2 ]
+#
+#    steps:
+#      - uses: actions/download-artifact@v3
+#        with:
+#          name: build-artifact
+#          path: /tmp/github-actions
+#
+#      - name: Extract build archive
+#        run: tar -xvf /tmp/github-actions/build.tar ./
+#
+#      - name: Behat
+#        uses: php-actions/behat@v1
+#        with:
+#          php_version: ${{ matrix.php }}
+
+
+  #  dev-deploy:
 #    runs-on: ubuntu-latest
 #    needs: [ composer, phpunit, phpstan, phpcs, phpmd ]
 #

README.md

@@ -6,34 +6,3 @@ We make releasing music easier.
 We are DIY artists, label people, software developers and music consumers who are building tools to give indies superpowers in the age of big data.
 
 "Giving indies superpowers in the age of big data."
-
-Dev todo
---------
-
-Notes for Wednesday: the database speedup is immense. From 6 minutes to about 15 seconds.
-But there's still more to do, and ideally it should all be done within 1 second.
-So, here's how:
-
-- [x] When the file is uploaded, just store it in the Upload table.
-- [x] Introduce a new field, Upload.processedUsages
-- [x] In a background script, loop over all uploads that are not processed and extract their usages (then mark as processed)
-- [ ] Introduce another new field, Usage.processed
-- [ ] In another background script, loop over all usages that are unprocessed, finishing the job here.
-- [ ] The usage processor needs to match products and artists - rather than doing this individually in a loop, lookup the unique artist/product first, to cache the IDs (or create new ones), then it's possible to insert UsageOfProduct rows on bulk!
-- [ ] Then optimise further with a profiler. Ideally, a very large import should be completed before the page has chance to reload.
-- [ ] If a spinner is necessary, it should be put onto the three-checkbox page. It's also possible to know how many usages are left to process, so an ACTUAL progress bar is possible.
-
-Setup guide
------------
-
-TODO: From scratch for Linux, Windows and Mac.
-
-Running locally
----------------
-
-TODO.
-
-Writing/running tests
----------------------
-
-TODO.

behat.yml

@@ -14,7 +14,10 @@ default:
         - \SHIFT\Trackshift\BehatContext\AuthContext:
         - \SHIFT\Trackshift\BehatContext\PageContext:
         - \SHIFT\Trackshift\BehatContext\UploadContext:
-        - \SHIFT\Trackshift\BehatContext\AnotherContext:
+        - \SHIFT\Trackshift\BehatContext\ProductContext:
+        - \SHIFT\Trackshift\BehatContext\SplitContext:
+        - \SHIFT\Trackshift\BehatContext\NotificationContext:
+        - \SHIFT\Trackshift\BehatContext\DebugContext:
 
   extensions:
     Behat\MinkExtension:

class/Artist/ArtistRepository.php

@@ -6,7 +6,7 @@
 use SHIFT\Trackshift\Repository\Repository;
 
 readonly class ArtistRepository extends Repository {
-	/** return array<Artist> */
+	/** @return array<Artist> */
 	public function getAll(User $user):array {
 		$artistArray = [];
 

class/Audit/AuditItem.php

@@ -31,7 +31,8 @@ public function getHtml():string {
 			"create" => "Created new $typeName ($descriptionOrId)",
 			"update" => "Updated $typeName ($descriptionOrId)",
 			"delete" => "Deleted $typeName ($descriptionOrId)",
-			default => "Something happened...",
+			"notification" => $descriptionOrId,
+			default => "Unhandled audit type ($this->type)",
 		};
 	}
 

class/Audit/AuditRepository.php

@@ -1,12 +1,22 @@
 <?php
 namespace SHIFT\Trackshift\Audit;
 
+use DateTime;
+use Gt\Database\Query\QueryCollection;
 use Gt\Database\Result\Row;
 use Gt\Ulid\Ulid;
 use SHIFT\Trackshift\Auth\User;
+use SHIFT\Trackshift\Auth\UserRepository;
 use SHIFT\Trackshift\Repository\Repository;
 
 readonly class AuditRepository extends Repository {
+	public function __construct(
+		QueryCollection $db,
+		private UserRepository $userRepository,
+	) {
+		parent::__construct($db);
+	}
+
 	public function create(User $user, string $newId, ?string $description = null):void {
 		$this->db->insert("insertCreation", [
 			"id" => new Ulid("audit"),
@@ -16,6 +26,16 @@ public function create(User $user, string $newId, ?string $description = null):v
 		]);
 	}
 
+	public function notify(User $user, string $description, ?string $idInQuestion = null):void {
+		$this->db->insert("insertNotification", [
+			"id" => new Ulid("audit"),
+			"userId" => $user->id,
+			"description" => $description,
+			"valueId" => $idInQuestion,
+		]);
+	}
+
+
 	public function delete(User $user, string $deletedId, ?string $description = null):void {
 		$this->db->insert("insertDeletion", [
 			"id" => new Ulid("audit"),
@@ -25,7 +45,7 @@ public function delete(User $user, string $deletedId, ?string $description = nul
 		]);
 	}
 
-	/** @return array<AuditItem,NotificationItem> */
+	/** @return array<AuditItem|NotificationItem> */
 	public function getAll(User $user):array {
 		$auditItemArray = [];
 
@@ -39,11 +59,25 @@ public function getAll(User $user):array {
 		return $auditItemArray;
 	}
 
+	public function getLatest(User $user, bool $notificationOnly = false):null|AuditItem|NotificationItem {
+		if($notificationOnly) {
+			$row = $this->db->fetch("getLatestNotification", $user->id);
+		}
+		else {
+			$row = $this->db->fetch("getLatest", $user->id);
+		}
+		return $this->rowToAuditItem($row, $user);
+	}
+
 	private function rowToAuditItem(?Row $row, ?User $user = null):?AuditItem {
 		if(!$row) {
 			return null;
 		}
 
+		if(!$user) {
+			$user = $this->userRepository->getById($row->getString("userId"));
+		}
+
 		return new AuditItem(
 			$row->getString("id"),
 			$user,
@@ -85,6 +119,22 @@ public function update(
 		}
 	}
 
+	public function checkNotifications(User $user):void {
+		$this->userRepository->setNotificationCheckTime($user);
+	}
+
+	public function isNewNotification(User $user):bool {
+		$timeLatestNotification = null;
+		$timeLastChecked = $this->userRepository->getLatestNotificationCheckTime($user);
+
+		if($latestNotification = $this->getLatest($user, true)) {
+			$timeLatestNotification = new DateTime();
+			$timeLatestNotification->setTimestamp((new Ulid(init: $latestNotification->id))->getTimestamp() / 1000);
+		}
+
+		return $timeLatestNotification && $timeLatestNotification > $timeLastChecked;
+	}
+
 	/** @return array<string, string> key = property name, value = "$oldValue -> $newValue" */
 	private function getDiff(object $from, object $to):array {
 		$fromVars = get_object_vars($from);
@@ -102,4 +152,5 @@ private function getDiff(object $from, object $to):array {
 	}
 
 
+
 }

class/Auth/UserRepository.php

@@ -1,7 +1,10 @@
 <?php
 namespace SHIFT\Trackshift\Auth;
 
+use DateTime;
+use DateTimeInterface;
 use Gt\Database\Query\QueryCollection;
+use Gt\Database\Result\Row;
 use Gt\Session\SessionStore;
 use Gt\Ulid\Ulid;
 use SHIFT\Trackshift\Repository\Repository;
@@ -21,6 +24,11 @@ public function getLoggedInUser():?User {
 		return $this->session->getInstance(self::SESSION_USER, User::class);
 	}
 
+	public function getById(string $id):?User {
+		$row = $this->db->fetch("getById", $id);
+		return $this->rowToUser($row);
+	}
+
 	public function createNewUser():User {
 		$user = new User(new Ulid("user"));
 		$this->db->insert("create", $user->id);
@@ -30,4 +38,30 @@ public function createNewUser():User {
 	public function persistUser(User $user):void {
 		$this->session->set(self::SESSION_USER, $user);
 	}
+
+	public function setNotificationCheckTime(User $user, DateTime $when = null):void {
+		if(is_null($when)) {
+			$when = new DateTime();
+		}
+
+		$this->db->update("setNotificationCheckedAt", [
+			"userId" => $user->id,
+			"checkedAt" => $when->getTimestamp(),
+		]);
+	}
+
+	public function getLatestNotificationCheckTime(User $user):?DateTimeInterface {
+		return $this->db->fetchDateTime("getLastNotificationCheckTime", $user->id);
+	}
+
+	private function rowToUser(?Row $row):?User {
+		if(!$row) {
+			return null;
+		}
+
+		return new User($row->getString("id"));
+	}
+
+
+
 }

class/Cost/CostRepository.php

@@ -28,6 +28,7 @@ public function create(Cost $cost, User $user):void {
 		$this->db->insert("create", [
 			"id" => $cost->id,
 			"productId" => $cost->product->id,
+			"userId" => $user->id,
 			"description" => $cost->description,
 			"amount" => $cost->amount->value,
 		]);

class/Product/ProductEarning.php

@@ -12,6 +12,8 @@ public function __construct(
 		public Product $product,
 		public Money $earning,
 		public Money $cost,
+		private Money $outgoing,
+		public Money $profit,
 	) {}
 
 	public function getArtistName():string {
@@ -30,4 +32,13 @@ public function getBalance():?string {
 
 		return null;
 	}
+
+	#[BindGetter]
+	public function getOutgoing():?string {
+		if($this->outgoing->value) {
+			return $this->outgoing;
+		}
+
+		return null;
+	}
 }

class/Product/ProductRepository.php

@@ -25,18 +25,30 @@ public function getProductEarnings(User $user):array {
 			$artist = new Artist($row->getString("artistId"), $row->getString("artistName"));
 			$product = new Product($row->getString("productId"), $row->getString("title"), $artist);
 			$earning = new Money($row->getFloat("totalEarning"));
-			$cost = new Money(0);
+			$cost = new Money();
 			if($costValue = $row->getFloat("totalCost")) {
 				$cost = new Money($costValue);
 			}
 
+			$balance = $earning->withSubtraction($cost);
+
+			$outgoing = new Money();
+			if($outgoingPercentage = $row->getFloat("percentageOutgoing")) {
+				$outgoingValue = ($outgoingPercentage / 100) * $balance->value;
+				$outgoing = new Money(round($outgoingValue, 2));
+			}
+
+			$profit = $balance->withSubtraction($outgoing);
+
 			array_push(
 				$earningList,
 				new ProductEarning(
 					$user,
 					$product,
 					$earning,
 					$cost,
+					$outgoing,
+					$profit,
 				)
 			);
 		}
@@ -54,6 +66,7 @@ public function getById(string $id):Product {
 		);
 	}
 
+	/** @return array<Product> */
 	public function getForArtist(string|Artist $artist):array {
 		$artist = is_string($artist) ? $this->artistRepository->getById($artist) : $artist;
 

class/Repository/Entity.php

@@ -1,5 +1,8 @@
 <?php
 namespace SHIFT\Trackshift\Repository;
 
+/**
+ * @property string $id
+ */
 abstract readonly class Entity {
 }

class/ServiceLoader.php

@@ -12,13 +12,15 @@
 use SHIFT\Trackshift\Content\ContentRepository;
 use SHIFT\Trackshift\Cost\CostRepository;
 use SHIFT\Trackshift\Product\ProductRepository;
+use SHIFT\Trackshift\Split\SplitRepository;
 use SHIFT\Trackshift\Upload\UploadManager;
 
 class ServiceLoader extends DefaultServiceLoader {
 	public function loadAuditRepo():AuditRepository {
 		$database = $this->container->get(Database::class);
 		return new AuditRepository(
 			$database->queryCollection("Audit"),
+			$this->container->get(UserRepository::class),
 		);
 	}
 
@@ -89,4 +91,14 @@ public function loadCostRepository():CostRepository {
 			$this->container->get(AuditRepository::class),
 		);
 	}
+
+	public function loadSplitRepository():SplitRepository {
+		$database = $this->container->get(Database::class);
+
+		return new SplitRepository(
+			$database->queryCollection("Split"),
+			$this->container->get(UserRepository::class),
+			$this->container->get(ProductRepository::class),
+		);
+	}
 }

class/Split/EmptySplitPercentage.php

@@ -0,0 +1,11 @@
+<?php
+namespace SHIFT\Trackshift\Split;
+
+use Gt\DomTemplate\Bind;
+use SHIFT\Trackshift\Repository\Entity;
+
+readonly class EmptySplitPercentage extends Entity {
+	public function __construct(
+		public string $productId,
+	) {}
+}