Fix(text2image): Return providers as indexed array

[marcelklehr]

• Resolves: Undefined array key 0 at /var/www/nextcloud/lib/private/TextToImage/Manager.php#231 text2image_helper#21

Checklist

• Code is properly formatted
• Sign-off message is added to all commits
• Tests (unit, integration, api and/or acceptance) are included
• Screenshots before/after for front-end changes
• Documentation (manuals or wiki) has been updated or is not required
• Backports requested where applicable (ex: critical bugfixes)

[marcelklehr]

/backport to stable28

[come-nc]

Why? Is there code relying on this? If so, please update the OCP return type accordingly in phpdoc to indicate array<int,IProvider> or list<IProvider> depending on what is needed.

[EDIT] Reading the referenced issue, you would need list<IProvider> to be sure that you can use key 0 without issue.

[MB-Finski]

Why? Is there code relying on this? If so, please update the OCP return type accordingly in phpdoc to indicate array<int,IProvider> or list<IProvider> depending on what is needed.

The runOrScheduleTask assumes an indexed array with [0] being defined. This causes issues if a user has not specified the default provider and getPreferredProviders returns the unfiltered results of the getProviders() as it currently does. This seemed like the easiest place to fix this.

[MB-Finski]

@come-nc I hope I got it right. (I'm essentially a php newbie).

EDIT: Nope, made it worse according to psalm.

[marcelklehr]

Can't we just keep IProvider[]?

[come-nc]

Can't we just keep IProvider[]?

You can but then calling code cannot assume that index 0 will be populated as the keys can be anything.

[marcelklehr]

Ah, I kind of assumed string[] to be a list, but it's a array<array-key, string> 🙈

[come-nc]

To fix psalm the property needs to be typed as list as well on https://github.com/nextcloud/server/blob/fix/text-to-image-manager/lib/private/TextToImage/Manager.php#L53

[come-nc]

Ah, I kind of assumed string[] to be a list, but it's a array<array-key, string> 🙈

Yeah, list forces indexes to be contiguous so you cannot unset in the middle without reindexing, it’s restrictive to it’s not the default type.

[nickvergessen]

lib/private/TextToImage/Manager.php:94:10: LessSpecificReturnStatement: The type 'list<mixed>' is more general than the declared return type 'list<OCP\TextToImage\IProvider>' for OC\TextToImage\Manager::getProviders (see https://psalm.dev/129)

Need to adjust the docs on the definition of the member as well

[backportbot-nextcloud]

The backport to stable28 failed. Please do this backport manually.

# Switch to the target branch and update it
git checkout stable28
git pull origin stable28

# Create the new backport branch
git checkout -b fix/foo-stable28

# Cherry pick the change from the commit sha1 of the change against the default branch
# This might cause conflicts. Resolve them.
git cherry-pick abc123

# Push the cherry pick commit to the remote repository and open a pull request
git push origin fix/foo-stable28

Error: Unknown error

More info at https://docs.nextcloud.com/server/latest/developer_manual/getting_started/development_process.html#manual-backport