IUserConfig #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);


susnux

Code is fine, but still want to confirm we want this name.

Reason: We use app config and system config and this was config->getUserValue.
So UserConfig might make more sense.

Yet all other places we have words for this refer it as user settings (documentation, occ commands etc), so maybe UserSettings. The only place we have that call it preferences is the DB table.

I am fine with anything regarding this if its agreed :)

lib/public/IConfig.php

ArtificialOwl · 2024-11-18T13:20:52Z

So, it has been renamed to IUserConfig; you happy ? :)

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

lib/private/AllConfig.php

 	 * @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

lib/private/AllConfig.php

 	 * @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

lib/private/Config/UserConfig.php

+		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

lib/private/Config/UserConfig.php

+		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

lib/private/AllConfig.php

+		$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

lib/unstable/Config/Exceptions/IncorrectTypeException.php

+ * 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

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 Outdated 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

artonge approved these changes Nov 14, 2024

View reviewed changes

susnux reviewed Nov 14, 2024

View reviewed changes

come-nc reviewed Nov 18, 2024

View reviewed changes

lib/public/IConfig.php Outdated Show resolved Hide resolved

ArtificialOwl force-pushed the enh/noid/user-preferences branch 2 times, most recently from c9ec4ca to 97ab26e Compare November 18, 2024 13:18

susnux approved these changes Nov 18, 2024

View reviewed changes

ArtificialOwl added 5 commits November 18, 2024 20:11

feat(user-prefs): IUserPreferences

65e24f7

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

fix(user-prefs): adding sensitive and indexed as flags

e73513b

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

feat(user-prefs): iterator instead of array on search

7c04818

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

feat(user-prefs): switching to NCU/

6afc855

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

feat(user-prefs): renaming to IUserConfig

5b4f190

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

ArtificialOwl force-pushed the enh/noid/user-preferences branch from 97ab26e to 5b4f190 Compare November 18, 2024 21:11

skjnldsv added 4. to release Ready to be released and/or waiting for tests to finish and removed 2. developing Work in progress labels Nov 19, 2024

skjnldsv changed the title ~~IUserPreferences~~ IUserConfig Nov 19, 2024

skjnldsv merged commit 899b651 into master Nov 19, 2024
186 checks passed

skjnldsv deleted the enh/noid/user-preferences branch November 19, 2024 08:31

ArtificialOwl mentioned this pull request Nov 19, 2024

fix(userconfig): incrementing version to trigger migration #49376

Merged

nickvergessen reviewed Nov 19, 2024

View reviewed changes

lib/private/AllConfig.php

* @return string

* @deprecated 31.0.0 - use {@see IUserConfig} directly

Copy link

Member

nickvergessen Nov 19, 2024

Choose a reason for hiding this comment

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

same for all methods

nickvergessen reviewed Nov 19, 2024

View reviewed changes

skjnldsv added the pending documentation This pull request needs an associated documentation update label Nov 19, 2024

nickvergessen reviewed Nov 19, 2024

View reviewed changes

skjnldsv reviewed Nov 19, 2024

View reviewed changes

skjnldsv mentioned this pull request Nov 26, 2024

NCU unstable namespace nextcloud/documentation#12329

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

IUserConfig #47658

IUserConfig #47658

ArtificialOwl commented Aug 31, 2024 •

edited

Loading

susnux left a comment •

edited

Loading

ArtificialOwl commented Nov 18, 2024

susnux left a comment

kesselb commented Nov 19, 2024

st3iny commented Nov 19, 2024

nickvergessen Nov 19, 2024

nickvergessen Nov 19, 2024

nickvergessen commented Nov 19, 2024

nickvergessen Nov 19, 2024

nickvergessen Nov 19, 2024

skjnldsv commented Nov 19, 2024 •

edited

Loading

nickvergessen Nov 19, 2024

skjnldsv Nov 19, 2024

come-nc Nov 25, 2024

		* @return string
		* @deprecated 31.0.0 - use {@see IUserConfig} directly

IUserConfig #47658

IUserConfig #47658

Conversation

ArtificialOwl commented Aug 31, 2024 • edited Loading

susnux left a comment • edited Loading

Choose a reason for hiding this comment

ArtificialOwl commented Nov 18, 2024

susnux left a comment

Choose a reason for hiding this comment

kesselb commented Nov 19, 2024

st3iny commented Nov 19, 2024

nickvergessen Nov 19, 2024

Choose a reason for hiding this comment

nickvergessen Nov 19, 2024

Choose a reason for hiding this comment

nickvergessen commented Nov 19, 2024

nickvergessen Nov 19, 2024

Choose a reason for hiding this comment

nickvergessen Nov 19, 2024

Choose a reason for hiding this comment

skjnldsv commented Nov 19, 2024 • edited Loading

nickvergessen Nov 19, 2024

Choose a reason for hiding this comment

skjnldsv Nov 19, 2024

Choose a reason for hiding this comment

come-nc Nov 25, 2024

Choose a reason for hiding this comment

ArtificialOwl commented Aug 31, 2024 •

edited

Loading

susnux left a comment •

edited

Loading

skjnldsv commented Nov 19, 2024 •

edited

Loading