feat: use new AppAPI endpoint for ExApp status report#414
Merged
oleksandr-nc merged 1 commit intomainfrom Mar 2, 2026
Merged
Conversation
📝 WalkthroughWalkthroughUpdates the app initialization status endpoint from the deprecated dynamic path Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
nc_py_api/nextcloud.py (1)
426-440:⚠️ Potential issue | 🟠 MajorFix backward-compatibility fallback in
set_init_statusfor older AppAPI versions.Lines 435 and 569 now use only
/ocs/v1.php/apps/app_api/ex-app/status(AppAPI 3.0.0+). Deployments with older AppAPI versions will receive a 404. Add fallback to the deprecated/apps/status/{appId}endpoint onNextcloudExceptionNotFound.Note: The attribute name in the proposed fix should be
self.app_cfg.app_name, notself.app_cfg.name.Suggested fix
def set_init_status(self, progress: int, error: str = "") -> None: """Sets state of the app initialization. :param progress: a number from ``0`` to ``100`` indicating the percentage of application readiness for work. After sending ``100`` AppAPI will enable the application. :param error: if non-empty, signals to AppAPI that the application cannot be initialized successfully. """ - self._session.ocs( - "PUT", - "/ocs/v1.php/apps/app_api/ex-app/status", - json={ - "progress": progress, - "error": error, - }, - ) + payload = { + "progress": progress, + "error": error, + } + try: + self._session.ocs("PUT", "/ocs/v1.php/apps/app_api/ex-app/status", json=payload) + except NextcloudExceptionNotFound: + self._session.ocs( + "PUT", + f"/ocs/v1.php/apps/app_api/apps/status/{self.app_cfg.app_name}", + json=payload, + ) async def set_init_status(self, progress: int, error: str = "") -> None: """Sets state of the app initialization. :param progress: a number from ``0`` to ``100`` indicating the percentage of application readiness for work. After sending ``100`` AppAPI will enable the application. :param error: if non-empty, signals to AppAPI that the application cannot be initialized successfully. """ - await self._session.ocs( - "PUT", - "/ocs/v1.php/apps/app_api/ex-app/status", - json={ - "progress": progress, - "error": error, - }, - ) + payload = { + "progress": progress, + "error": error, + } + try: + await self._session.ocs("PUT", "/ocs/v1.php/apps/app_api/ex-app/status", json=payload) + except NextcloudExceptionNotFound: + await self._session.ocs( + "PUT", + f"/ocs/v1.php/apps/app_api/apps/status/{self.app_cfg.app_name}", + json=payload, + )Also applies to: 560-574
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@nc_py_api/nextcloud.py` around lines 426 - 440, Update set_init_status to catch NextcloudExceptionNotFound when calling the new endpoint and retry the request against the legacy endpoint "/apps/status/{appId}" using self.app_cfg.app_name as the appId; specifically, wrap the existing self._session.ocs(...) call in a try/except for NextcloudExceptionNotFound, and in the except block call self._session.ocs with the deprecated path and the same json payload (progress and error) so older AppAPI versions receive the fallback; apply the same pattern to the other similar call around lines 560-574.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CHANGELOG.md`:
- Around line 18-23: Remove the duplicated release heading "## [0.24.1 -
2026-02-25]" and either delete the repeated section block or merge its entries
into the original 0.24.1 release section so there is only one "## [0.24.1 -
2026-02-25]" heading in CHANGELOG.md; locate occurrences of the heading text to
find both sections and keep/merge content under the first instance, removing the
second.
---
Outside diff comments:
In `@nc_py_api/nextcloud.py`:
- Around line 426-440: Update set_init_status to catch
NextcloudExceptionNotFound when calling the new endpoint and retry the request
against the legacy endpoint "/apps/status/{appId}" using self.app_cfg.app_name
as the appId; specifically, wrap the existing self._session.ocs(...) call in a
try/except for NextcloudExceptionNotFound, and in the except block call
self._session.ocs with the deprecated path and the same json payload (progress
and error) so older AppAPI versions receive the fallback; apply the same pattern
to the other similar call around lines 560-574.
Comment on lines
+18
to
+23
| ## [0.24.1 - 2026-02-25] | ||
|
|
||
| ### Fixed | ||
|
|
||
| - Use FileLock with atomic rename for safe concurrent model downloads #396 | ||
|
|
There was a problem hiding this comment.
Remove duplicated 0.24.1 release section.
Line 18 reintroduces ## [0.24.1 - 2026-02-25], which already exists at Line 5. This duplicates release history and triggers MD024 (no-duplicate-heading).
Suggested fix
-## [0.24.1 - 2026-02-25]
-
-### Fixed
-
-- Use FileLock with atomic rename for safe concurrent model downloads `#396`📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
Suggested change
| ## [0.24.1 - 2026-02-25] | |
| ### Fixed | |
| - Use FileLock with atomic rename for safe concurrent model downloads #396 |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 18-18: Multiple headings with the same content
(MD024, no-duplicate-heading)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CHANGELOG.md` around lines 18 - 23, Remove the duplicated release heading "##
[0.24.1 - 2026-02-25]" and either delete the repeated section block or merge its
entries into the original 0.24.1 release section so there is only one "##
[0.24.1 - 2026-02-25]" heading in CHANGELOG.md; locate occurrences of the
heading text to find both sections and keep/merge content under the first
instance, removing the second.
Signed-off-by: Oleksander Piskun <oleksandr2088@icloud.com>
oleksandr-nc
force-pushed
the
feat/exapp-status-report-endpoint
branch
from
b2b2d44 to
b1b13a5
Compare
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
nc_py_api/nextcloud.py (1)
433-440:⚠️ Potential issue | 🟠 MajorImplement fallback to deprecated endpoint for AppAPI < 3.0.0 compatibility.
The switch to
/ex-app/statusis recent (from AppAPI 3.0.0+, released Aug 2024). While the old endpoint/ocs/v1.php/apps/app_api/apps/status/{appId}is deprecated, it remains functional. To maintain backwards compatibility with older AppAPI installations, catchNextcloudExceptionNotFoundon the new endpoint and retry with the legacy route in both sync and async methods.Backwards-compatible implementation
def set_init_status(self, progress: int, error: str = "") -> None: """Sets state of the app initialization. :param progress: a number from ``0`` to ``100`` indicating the percentage of application readiness for work. After sending ``100`` AppAPI will enable the application. :param error: if non-empty, signals to AppAPI that the application cannot be initialized successfully. """ - self._session.ocs( - "PUT", - "/ocs/v1.php/apps/app_api/ex-app/status", - json={ - "progress": progress, - "error": error, - }, - ) + payload = { + "progress": progress, + "error": error, + } + try: + self._session.ocs("PUT", "/ocs/v1.php/apps/app_api/ex-app/status", json=payload) + except NextcloudExceptionNotFound: + self._session.ocs( + "PUT", + f"/ocs/v1.php/apps/app_api/apps/status/{self._session.cfg.app_name}", + json=payload, + ) async def set_init_status(self, progress: int, error: str = "") -> None: """Sets state of the app initialization. :param progress: a number from ``0`` to ``100`` indicating the percentage of application readiness for work. After sending ``100`` AppAPI will enable the application. :param error: if non-empty, signals to AppAPI that the application cannot be initialized successfully. """ - await self._session.ocs( - "PUT", - "/ocs/v1.php/apps/app_api/ex-app/status", - json={ - "progress": progress, - "error": error, - }, - ) + payload = { + "progress": progress, + "error": error, + } + try: + await self._session.ocs("PUT", "/ocs/v1.php/apps/app_api/ex-app/status", json=payload) + except NextcloudExceptionNotFound: + await self._session.ocs( + "PUT", + f"/ocs/v1.php/apps/app_api/apps/status/{self._session.cfg.app_name}", + json=payload, + )🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@nc_py_api/nextcloud.py` around lines 433 - 440, Wrap the call to self._session.ocs that posts to "/ocs/v1.php/apps/app_api/ex-app/status" in a try/except that catches NextcloudExceptionNotFound and, on that exception, retries the request against the legacy route "/ocs/v1.php/apps/app_api/apps/status/{appId}" (substituting the current app id variable in scope, e.g. app_id or appId). Apply the same pattern to the async counterpart (await self._session.ocs) so both sync and async methods first try the new ex-app/status endpoint and fall back to the deprecated apps/status/{appId} endpoint when NextcloudExceptionNotFound is raised.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Outside diff comments:
In `@nc_py_api/nextcloud.py`:
- Around line 433-440: Wrap the call to self._session.ocs that posts to
"/ocs/v1.php/apps/app_api/ex-app/status" in a try/except that catches
NextcloudExceptionNotFound and, on that exception, retries the request against
the legacy route "/ocs/v1.php/apps/app_api/apps/status/{appId}" (substituting
the current app id variable in scope, e.g. app_id or appId). Apply the same
pattern to the async counterpart (await self._session.ocs) so both sync and
async methods first try the new ex-app/status endpoint and fall back to the
deprecated apps/status/{appId} endpoint when NextcloudExceptionNotFound is
raised.
ℹ️ Review info
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
📒 Files selected for processing (4)
CHANGELOG.mdnc_py_api/_version.pync_py_api/nextcloud.pytests/actual_tests/files_sharing_test.py
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #414 +/- ##
=======================================
Coverage 94.87% 94.87%
=======================================
Files 46 46
Lines 5540 5540
=======================================
Hits 5256 5256
Misses 284 284
🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fix for some flaky situations where ExApp can fail to update it's status during install/update in AppAPI will be only for the new endpoint:
nextcloud/app_api#807
Summary by CodeRabbit
Changed
Chores