IUserConfig by ArtificialOwl · Pull Request #47658 · nextcloud/server

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

replace IConfig's preferences-related method
tests

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


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


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


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


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


susnux

🥳

Signed-off-by: Maxence Lange <maxence@artificial-owl.com>

kesselb · 2024-11-19T10:12:49Z

Please send a follow-up and increase the version to trigger the migration.

st3iny · 2024-11-19T10:50:40Z

Please send a follow-up and increase the version to trigger the migration.

An exception occurred while executing a query: SQLSTATE[42S22]: Column not found: 1054 Unknown column 'type' in 'field list' /home/richard/src/nextcloud/master/lib/private/DB/Exceptions/DbalException.php at 54

nickvergessen · 2024-11-19T16:29:20Z

+ *
 * @throws \OCP\PreConditionNotMetException if a precondition is specified and is not met
 * @throws \UnexpectedValueException when trying to store an unexpected value
+ * @deprecated 31.0.0 - use {@see IUserConfig} directly


https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/api.html#php-unstable-api
Code from the OCP namespace must never mention anything coming from the NCU namespace. It can not require it as an argument, constant or return something from NCU.
So you can not deprecate this and neither the public interface.

nickvergessen · 2024-11-19T16:29:40Z

 * @param mixed $default the default value to be returned if the value isn't set
+ *
 * @return string
+ * @deprecated 31.0.0 - use {@see IUserConfig} directly


same for all methods

nickvergessen · 2024-11-19T16:37:10Z

💥 This PR breaks talks tests.
We set a user config and fetch it in another place of the code, but receive the default value instead:
https://github.com/nextcloud/spreed/actions/runs/11911817197/job/33195693787?pr=13750#step:15:2199

nickvergessen · 2024-11-19T16:58:33Z

+ string $userId,
+ string $app,
+ string $key,
+ string $default = '',


Breaking change, before mixed was documented and no type was casted.
At least null is used by apps and was used even in server's own method (setUserValue)

nickvergessen · 2024-11-19T16:59:03Z

+ string $key,
+ string $default = '',
+ ?bool $lazy = false,
+	): string {


When the default value is "widen" again, the return type also needs to be

skjnldsv · 2024-11-19T17:04:44Z

Please also document this
like https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/config/appconfig.html

nickvergessen · 2024-11-19T17:05:46Z

+ $userPreferences = \OCP\Server::get(IUserConfig::class);
+ if ($preCondition !== null) {
+ try {
+ if ($userPreferences->getValueMixed($userId, $appName, $key) !== (string)$preCondition) {


this is a behaviour change, previously the precondition did not fail, when the value is not set in the database.
Fixed in fix(userconfig): Don't fail the precondition if the value is not set at all #49386

skjnldsv · 2024-11-19T17:08:34Z

+ * SPDX-License-Identifier: AGPL-3.0-or-later
+ */
+
+namespace NCU\Config\Exceptions;


Please create a documentation for this new Namespace and the way it should work (when is it going to become stable, when can devs use it... etc)

https://docs.nextcloud.com/server/latest/developer_manual/digging_deeper/api.html#php-unstable-api

ChristophWurst · 2024-12-13T09:12:39Z

+ // removing this index from Version13000Date20170718121200
+ // $table->addIndex(['appid', 'configkey'], 'preferences_app_key');
+ if ($table->hasIndex('preferences_app_key')) {
+ $table->dropIndex('preferences_app_key');


for my dev instance running mariadb this DROP did not happen, so I now have redundant indexes:
The migration code seems correct, but something seems to prevent the DROP. @ArtificialOwl could you check the upgrade path?

See #49638
The index is dropped... But next repair step run adds it again

github-advanced-securityAI 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 a9e2a38Compare August 31, 2024 22:30

github-advanced-securityAI found potential problems Aug 31, 2024
View reviewed changes

Comment threadlib/private/UserPreferences.php Fixed
Comment threadlib/private/UserPreferences.php Fixed
Comment threadlib/public/UserPreferences/IUserPreferences.php Fixed
Comment threadlib/public/UserPreferences/IUserPreferences.php Fixed

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

github-advanced-securityAI found potential problems Sep 1, 2024
View reviewed changes

Comment threadlib/private/AllConfig.php Fixed
Comment threadlib/private/AllConfig.php Fixed
Comment threadlib/private/UserPreferences.php Fixed

github-advanced-securityAI found potential problems Sep 1, 2024
View reviewed changes

Comment threadlib/private/UserPreferences.php Fixed
Comment threadlib/private/UserPreferences.php Fixed

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

github-advanced-securityAI found potential problems Sep 1, 2024
View reviewed changes

Comment threadlib/private/AllConfig.php Fixed

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