IUserPreferences #47658

ArtificialOwl · 2024-08-31T02:46:59Z

replace IConfig's preferences-related method
tests

core/Migrations/Version31000Date20240814184402.php

lib/private/UserPreferences.php

lib/public/UserPreferences/ValueType.php

lib/private/UserPreferences.php

lib/public/UserPreferences/IUserPreferences.php

lib/private/AllConfig.php

lib/private/UserPreferences.php

lib/private/AllConfig.php

lib/private/UserPreferences.php

lib/private/AllConfig.php

lib/private/UserPreferences.php

lib/public/UserPreferences/ValueTypeDefinition.php

lib/private/UserPreferences.php

+				$value = $cache[$app][$key];
+				try {
+					$this->decryptSensitiveValue($userId, $app, $key, $value);
+					$value = $this->convertTypedValue($value, $typedAs ?? $this->getValueType($userId, (string)$app, $key, $lazy));


lib/private/UserPreferences.php

+	 * @param string $value preference value
+	 * @param bool $caseInsensitive non-case-sensitive search, only works if $value is a string
+	 *
+	 * @return list<string>


lib/private/UserPreferences.php

+	 * @since 31.0.0
+	 */
+	public function searchUsersByValueString(string $app, string $key, string $value, bool $caseInsensitive = false): array {
+		return $this->searchUsersByTypedValue($app, $key, $value, $caseInsensitive);


lib/private/UserPreferences.php

+	 * @param string $key preference key
+	 * @param array $values list of preference values
+	 *
+	 * @return list<string>


lib/private/UserPreferences.php

+	 * @since 31.0.0
+	 */
+	public function searchUsersByValues(string $app, string $key, array $values): array {
+		return $this->searchUsersByTypedValue($app, $key, $values);


Signed-off-by: Maxence Lange <[email protected]>

artonge · 2024-10-03T14:58:47Z

lib/private/AllConfig.php

@@ -463,31 +365,10 @@ public function getUserValueForUsers($appName, $key, $userIds) {
 	 * @param string $key the key to get the user for
 	 * @param string $value the value to get the user for
 	 * @return list<string> of user IDs
+	 * @deprecated 31.0.0 - use {@see IUserPreferences} directly


Can you specify the replacement method for the deprecated ones?

artonge · 2024-10-03T15:00:56Z

lib/private/UserPreferences.php

If possible, please split that file before it gets out of hand.

artonge · 2024-10-03T15:22:38Z

core/Migrations/Version31000Date20240814184402.php

Ideally, split the type and the flags to two distinct columns.

type with values 1, 2, 3, 4, .... That could also be some flag values, but then drop the MIXED type value
flags with value 1, 2, 4, 8, ... or any combination of them.

artonge · 2024-10-03T15:41:15Z

lib/private/UserPreferences.php

+
+		$qb = $this->connection->getQueryBuilder();
+		$qb->from('preferences');
+		$qb->select('userid', 'appid', 'configkey', 'configvalue', 'type');


For "extra" perf, don't select the userid column and use the $userId var.

come-nc

Stopped at line 1050 of UserPreferences, to be continued…

I dislike the sensitive flag thing, it should be a bool just like lazy so that all types var can be typed to the enum.

come-nc · 2024-10-03T14:47:18Z

lib/private/AllConfig.php

-				$this->userCache[$userId][$appName][$key] = (string)$value;
-				return;
+		/** @var UserPreferences $userPreferences */
+		$userPreferences = \OC::$server->get(IUserPreferences::class);


Suggested change

$userPreferences = \OC::$server->get(IUserPreferences::class);

$userPreferences = \OCP\Server::get(IUserPreferences::class);

come-nc · 2024-10-03T14:49:04Z

lib/private/AllConfig.php

 			return $default;
 		}
+		/** @var UserPreferences $userPreferences */
+		$userPreferences = \OC::$server->get(IUserPreferences::class);


come-nc · 2024-10-03T14:51:29Z

lib/private/AllConfig.php

-		} else {
-			return [];
-		}
+		return \OC::$server->get(IUserPreferences::class)->getKeys($userId, $appName);


Inject it if you use it more than twice :-P

come-nc · 2024-10-03T14:59:40Z

lib/private/UserPreferences.php

+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace OC;


Avoid cluttering OC namespace please

come-nc · 2024-10-03T15:10:14Z

lib/private/UserPreferences.php

+		if ($valueType !== null) {
+			$valueFlag = $valueType->value;
+			$valueFlag &= ~ValueType::SENSITIVE->value;
+			if (ValueType::tryFrom($valueFlag) === null) {
+				throw new InvalidArgumentException('Unknown value type');
+			}
+		}


Does not make sense with an enum

come-nc · 2024-10-03T15:44:20Z

lib/private/UserPreferences.php

+		$rows = $result->fetchAll();
+		foreach ($rows as $row) {
+			$userIds[] = $row['userid'];
+		}
+
+		return $userIds;


Suggested change

$rows = $result->fetchAll();

foreach ($rows as $row) {

$userIds[] = $row['userid'];

}

return $userIds;

while ($row = $result->fetch()) {

yield $row['userid'];

}

come-nc · 2024-10-03T15:45:09Z

lib/private/UserPreferences.php

+		?bool $lazy = false,
+	): string {
+		try {
+			$lazy = ($lazy === null) ? $this->isLazy($userId, $app, $key) : $lazy;


Suggested change

$lazy = ($lazy === null) ? $this->isLazy($userId, $app, $key) : $lazy;

$lazy ??= $this->isLazy($userId, $app, $key);

come-nc · 2024-10-03T15:54:50Z

lib/private/UserPreferences.php

+	/**
+	 * convert bitflag from value type to ValueType
+	 *
+	 * @param int $type
+	 *
+	 * @return ValueType
+	 * @throws IncorrectTypeException
+	 */
+	private function extractValueType(int $type): ValueType {
+		$type &= ~ValueType::SENSITIVE->value;
+
+		try {
+			return ValueType::from($type);
+		} catch (ValueError) {
+			throw new IncorrectTypeException('invalid value type');
+		}
+	}


come-nc · 2024-10-03T16:02:02Z

lib/private/UserPreferences.php

+			}
+
+			/**
+			 * This should only happen during the upgrade process from 28 to 29.


A bit late for that.

come-nc · 2024-10-03T16:02:59Z

lib/private/UserPreferences.php

+			 * We only log a warning and set it to VALUE_MIXED.
+			 */
+			if ($currType === 0) {
+				$this->logger->warning('Value type is set to zero (0) in database. This is fine only during the upgrade process from 28 to 29.', ['app' => $app, 'key' => $key]);


Suggested change

$this->logger->warning('Value type is set to zero (0) in database. This is fine only during the upgrade process from 28 to 29.', ['app' => $app, 'key' => $key]);

$this->logger->warning('Value type is set to zero (0) in database. This is fine only during the upgrade process from 30 to 31.', ['app' => $app, 'key' => $key]);

artonge · 2024-10-03T16:27:38Z

lib/public/UserPreferences/IUserPreferences.php

Maybe let's keep it private for one major version to have the flexibility to change the API down the road?

github-advanced-security bot found potential problems Aug 31, 2024

View reviewed changes

ArtificialOwl force-pushed the enh/noid/user-preferences branch 2 times, most recently from 6d81b97 to a9e2a38 Compare August 31, 2024 22:30

github-advanced-security bot found potential problems Aug 31, 2024

View reviewed changes

lib/private/UserPreferences.php Fixed Show fixed Hide fixed

lib/private/UserPreferences.php Fixed Show fixed Hide fixed

lib/public/UserPreferences/IUserPreferences.php Fixed Show fixed Hide fixed

lib/public/UserPreferences/IUserPreferences.php Fixed Show fixed Hide fixed

ArtificialOwl force-pushed the enh/noid/user-preferences branch from e9ec009 to cda7029 Compare September 1, 2024 19:15

github-advanced-security bot found potential problems Sep 1, 2024

View reviewed changes

lib/private/AllConfig.php Fixed Show fixed Hide fixed

lib/private/AllConfig.php Fixed Show fixed Hide fixed

lib/private/UserPreferences.php Fixed Show fixed Hide fixed

github-advanced-security bot found potential problems Sep 1, 2024

View reviewed changes

lib/private/UserPreferences.php Fixed Show fixed Hide fixed

lib/private/UserPreferences.php Fixed Show fixed Hide fixed

ArtificialOwl force-pushed the enh/noid/user-preferences branch from 1fbb6a9 to 317202a Compare September 1, 2024 22:42

github-advanced-security bot found potential problems Sep 1, 2024

View reviewed changes

lib/private/AllConfig.php Fixed Show fixed Hide fixed

ArtificialOwl force-pushed the enh/noid/user-preferences branch from c78f304 to 979ecee Compare September 2, 2024 01:09

github-advanced-security bot found potential problems Sep 2, 2024

View reviewed changes

lib/private/AllConfig.php Fixed Show fixed Hide fixed

ArtificialOwl force-pushed the enh/noid/user-preferences branch from 979ecee to 41ba78f Compare September 2, 2024 01:19

github-advanced-security bot found potential problems Sep 2, 2024

View reviewed changes

lib/private/AllConfig.php Fixed Show fixed Hide fixed

ArtificialOwl force-pushed the enh/noid/user-preferences branch 2 times, most recently from 8edb1c1 to e510535 Compare September 2, 2024 02:31

github-advanced-security bot found potential problems Sep 2, 2024

View reviewed changes

lib/private/UserPreferences.php Fixed Show fixed Hide fixed

lib/private/UserPreferences.php Fixed Show fixed Hide fixed

ArtificialOwl force-pushed the enh/noid/user-preferences branch from f71bb7d to e24d29a Compare September 2, 2024 03:33

github-advanced-security bot found potential problems Sep 2, 2024

View reviewed changes

lib/private/AllConfig.php Fixed Show fixed Hide fixed

lib/private/AllConfig.php Fixed Show fixed Hide fixed

lib/private/AllConfig.php Fixed Show fixed Hide fixed

ArtificialOwl force-pushed the enh/noid/user-preferences branch 2 times, most recently from 32c209d to b80315b Compare September 2, 2024 14:57

github-advanced-security bot found potential problems Sep 2, 2024

View reviewed changes

lib/private/AllConfig.php Fixed Show fixed Hide fixed

lib/private/AllConfig.php Fixed Show fixed Hide fixed

ArtificialOwl force-pushed the enh/noid/user-preferences branch from b80315b to 0c489af Compare September 2, 2024 16:03

github-advanced-security bot found potential problems Sep 2, 2024

View reviewed changes

lib/private/UserPreferences.php Fixed Show fixed Hide fixed

ArtificialOwl force-pushed the enh/noid/user-preferences branch from 0c489af to 6ae7f9f Compare September 2, 2024 19:50

susnux reviewed Sep 5, 2024

View reviewed changes

lib/public/UserPreferences/ValueTypeDefinition.php Show resolved Hide resolved

ArtificialOwl force-pushed the enh/noid/user-preferences branch from ceb814d to a219133 Compare September 30, 2024 16:25

ArtificialOwl marked this pull request as ready for review September 30, 2024 16:26

ArtificialOwl added the 3. to review Waiting for reviews label Sep 30, 2024

ArtificialOwl added this to the Nextcloud 31 milestone Sep 30, 2024

github-advanced-security bot found potential problems Sep 30, 2024

View reviewed changes

ArtificialOwl force-pushed the enh/noid/user-preferences branch 2 times, most recently from 9010cc6 to cc4a1ff Compare October 3, 2024 13:32

feat(user-prefs): IUserPreferences

da769f0

Signed-off-by: Maxence Lange <[email protected]>

ArtificialOwl force-pushed the enh/noid/user-preferences branch from cc4a1ff to da769f0 Compare October 3, 2024 13:52

artonge reviewed Oct 3, 2024

View reviewed changes

come-nc reviewed Oct 3, 2024

View reviewed changes

artonge reviewed Oct 3, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IUserPreferences #47658

IUserPreferences #47658

ArtificialOwl commented Aug 31, 2024 •

edited

Loading

artonge Oct 3, 2024

artonge Oct 3, 2024

artonge Oct 3, 2024

artonge Oct 3, 2024

come-nc left a comment

come-nc Oct 3, 2024

come-nc Oct 3, 2024

come-nc Oct 3, 2024

come-nc Oct 3, 2024

come-nc Oct 3, 2024

come-nc Oct 3, 2024

come-nc Oct 3, 2024

come-nc Oct 3, 2024

come-nc Oct 3, 2024

come-nc Oct 3, 2024

artonge Oct 3, 2024

	$userPreferences = \OC::$server->get(IUserPreferences::class);
	$userPreferences = \OCP\Server::get(IUserPreferences::class);

	$lazy = ($lazy === null) ? $this->isLazy($userId, $app, $key) : $lazy;
	$lazy ??= $this->isLazy($userId, $app, $key);

	$this->logger->warning('Value type is set to zero (0) in database. This is fine only during the upgrade process from 28 to 29.', ['app' => $app, 'key' => $key]);
	$this->logger->warning('Value type is set to zero (0) in database. This is fine only during the upgrade process from 30 to 31.', ['app' => $app, 'key' => $key]);

IUserPreferences #47658

Are you sure you want to change the base?

IUserPreferences #47658

Conversation

ArtificialOwl commented Aug 31, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

come-nc left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ArtificialOwl commented Aug 31, 2024 •

edited

Loading