Merge pull request #40660 from nextcloud/bugfix/noid/fix-missing-user…

…-status-on-autocomplete-api fix(autocomplete): Fix missing user status on autocomplete endpoint
nextcloud · Oct 4, 2023 · c88b02a · c88b02a
2 parents 4756807 + a7018bc
commit c88b02a
Show file tree

Hide file tree

Showing 6 changed files with 52 additions and 8 deletions.
diff --git a/build/integration/collaboration_features/autocomplete.feature b/build/integration/collaboration_features/autocomplete.feature
@@ -15,12 +15,13 @@ Feature: autocomplete
       | auto | users |
       | autocomplete | users |
       | autocomplete2 | users |
+    And user "autocomplete" has status "dnd"
     When parameter "shareapi_restrict_user_enumeration_full_match" of app "core" is set to "no"
     Then get autocomplete for "auto"
-      | id | source |
-      | auto | users |
-      | autocomplete | users |
-      | autocomplete2 | users |
+      | id            | source | status |
+      | auto          | users  | ""     |
+      | autocomplete  | users  | {"status":"dnd","message":null,"icon":null,"clearAt":null} |
+      | autocomplete2 | users  | ""     |
 
 
   Scenario: getting autocomplete without enumeration

diff --git a/build/integration/config/behat.yml b/build/integration/config/behat.yml
@@ -1,6 +1,10 @@
 default:
   autoload:
     '': "%paths.base%/../features/bootstrap"
+  formatters:
+    pretty:
+      output_styles:
+        comment: [ 'bright-blue' ]
   suites:
     default:
       paths:

diff --git a/build/integration/features/bootstrap/CollaborationContext.php b/build/integration/features/bootstrap/CollaborationContext.php
@@ -73,6 +73,9 @@ private function getAutocompleteWithType(int $type, string $search, TableNode $f
 			if (isset($expected['source'])) {
 				$data['source'] = $suggestion['source'];
 			}
+			if (isset($expected['status'])) {
+				$data['status'] = json_encode($suggestion['status']);
+			}
 			return $data;
 		}, $suggestions, $formData->getHash()));
 	}

diff --git a/core/Controller/AutoCompleteController.php b/core/Controller/AutoCompleteController.php
@@ -123,8 +123,8 @@ protected function prepareResultArray(array $results): array {
 				/** @var ?string $subline */
 				$subline = array_key_exists('subline', $result) ? $result['subline'] : null;
 
-				/** @var ?string $status */
-				$status = array_key_exists('status', $result) && is_string($result['status']) ? $result['status'] : null;
+				/** @var ?array{status: string, message: ?string, icon: ?string, clearAt: ?int} $status */
+				$status = array_key_exists('status', $result) && is_array($result['status']) && !empty($result['status']) ? $result['status'] : null;
 
 				/** @var ?string $shareWithDisplayNameUnique */
 				$shareWithDisplayNameUnique = array_key_exists('shareWithDisplayNameUnique', $result) ? $result['shareWithDisplayNameUnique'] : null;

diff --git a/core/ResponseDefinitions.php b/core/ResponseDefinitions.php
@@ -124,7 +124,12 @@
  *     label: string,
  *     icon: string,
  *     source: string,
- *     status: string,
+ *     status: array{
+ *       status: string,
+ *       message: ?string,
+ *       icon: ?string,
+ *       clearAt: ?int,
+ *     }|string,
  *     subline: string,
  *     shareWithDisplayNameUnique: string,
  * }

diff --git a/core/openapi.json b/core/openapi.json
@@ -45,7 +45,38 @@
                         "type": "string"
                     },
                     "status": {
-                        "type": "string"
+                        "oneOf": [
+                            {
+                                "type": "object",
+                                "required": [
+                                    "status",
+                                    "message",
+                                    "icon",
+                                    "clearAt"
+                                ],
+                                "properties": {
+                                    "status": {
+                                        "type": "string"
+                                    },
+                                    "message": {
+                                        "type": "string",
+                                        "nullable": true
+                                    },
+                                    "icon": {
+                                        "type": "string",
+                                        "nullable": true
+                                    },
+                                    "clearAt": {
+                                        "type": "integer",
+                                        "format": "int64",
+                                        "nullable": true
+                                    }
+                                }
+                            },
+                            {
+                                "type": "string"
+                            }
+                        ]
                     },
                     "subline": {
                         "type": "string"