RDKEMW-12279 RALF Support for EntOS - PackageManager integration by SKumarMetro · Pull Request #722 · rdkcentral/entservices-apis

SKumarMetro · 2026-01-29T17:44:12Z

No description provided.

Copilot

Pull request overview

This PR adds support for RALF (Runtime Application Lifecycle Framework) integration with EntOS PackageManager by introducing a new failure reason enum value.

Changes:

Added GENERAL_FAILURE enum value to the FailReason enumeration in IPackageInstaller interface

Copilot · 2026-01-29T17:46:17Z

apis/PackageManager/IAppPackageManager.h


        enum class FailReason : uint8_t {
            NONE,                       // XXX: Not in HLA
+            GENERAL_FAILURE,


The enum value GENERAL_FAILURE is missing the required @text annotation. According to the Enum Naming convention, enum values in interfaces marked with @JSON should include @text annotations to define their JSON RPC representation.

For example, similar patterns can be seen in:

apis/FirmwareUpdate/IFirmwareUpdate.h:30 - VALIDATION_FAILED = 1 /* @text VALIDATION_FAILED */

apis/USBMassStorage/IUSBMassStorage.h:35 - READ_ONLY = 1 /* @text READ_ONLY */

The @text annotation should be added in the format: GENERAL_FAILURE /* @text GENERAL_FAILURE */,

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#enum-naming

into develop

Copilot

Pull request overview

Copilot reviewed 1 out of 1 changed files in this pull request and generated no new comments.

into develop

github-actions · 2026-02-05T23:29:50Z

Documentation Auto-Generated

Documentation has been automatically generated for the changed plugins and committed to this PR branch.

The generated documentation files have been added to the PR for review.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

apis/PackageManager/IAppPackageManager.h

Copilot · 2026-02-05T23:33:57Z

docs/apis/PackageManager.md

 | [download](#download) | Downloads a resource file for an application. |
 | [getConfigForPackage](#getConfigForPackage) | getConfigForPackage |
-| [getLockedInfo](#getLockedInfo) | GetLockedInfo |
 | [getStorageInformation](#getStorageInformation) | GetStorageInformation |


The documentation for the getLockedInfo API has been removed from this file, but the corresponding method GetLockedInfo still exists in the IPackageHandler interface (IAppPackageManager.h lines 322-333). This creates an inconsistency between the header file and the documentation. Either the method should be removed from the header file, or the documentation should be retained. If getLockedInfo is deprecated in favor of getLockInfo, this should be documented clearly.

This reverts commit 0f8399c.

into develop

github-actions · 2026-02-17T01:07:44Z

Documentation Auto-Generated

Documentation has been automatically generated for the changed plugins and committed to this PR branch.

The generated documentation files have been added to the PR for review.

Copilot

Pull request overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 13 comments.

Copilot · 2026-02-17T01:15:55Z

docs/apis/PackageManager.md

+| params.options.priority | bool |  |
+| params.options.retries | integer |  |
+| params.options.rateLimit | integer |  |


The parameter descriptions for the Options struct fields are empty. According to documentation best practices and custom coding guideline 1000003, all parameters should have meaningful descriptions. Add descriptions such as:

priority: "Indicates whether this download should be prioritized"

retries: "Number of retry attempts if download fails"

rateLimit: "Maximum download rate limit in bytes per second"

Refer: https://github.com/rdkcentral/entservices-apis/blob/develop/.github/instructions/api_headers.instructions.md#documentation-tags-guidelines

Copilot · 2026-02-17T01:15:55Z

docs/apis/PackageManager.md

+| result.storageinfo.EXTERNAL | struct |  |
+| result.storageinfo.path | string |  |
+| result.storageinfo.quotaKB | string |  |
+| result.storageinfo.usedKB | string |  |


The StorageInfo structure documentation doesn't match the interface definition in IPackageManager.h. According to the header file (lines 75-86), StorageInfo contains two StorageDetails structs: "apps" and "persistent", each with path, quotaKB, and usedKB fields. The documentation shows "EXTERNAL" as a field which doesn't exist in the interface. The correct structure should be:

result.storageinfo.apps (StorageDetails)

result.storageinfo.apps.path (string)

result.storageinfo.apps.quotaKB (string)

result.storageinfo.apps.usedKB (string)

result.storageinfo.persistent (StorageDetails)

result.storageinfo.persistent.path (string)

result.storageinfo.persistent.quotaKB (string)

result.storageinfo.persistent.usedKB (string)

Suggested change

| result.storageinfo.EXTERNAL | struct | |

| result.storageinfo.path | string | |

| result.storageinfo.quotaKB | string | |

| result.storageinfo.usedKB | string | |

| result.storageinfo.apps | StorageDetails | |

| result.storageinfo.apps.path | string | |

| result.storageinfo.apps.quotaKB | string | |

| result.storageinfo.apps.usedKB | string | |

| result.storageinfo.persistent | StorageDetails | |

| result.storageinfo.persistent.path | string | |

| result.storageinfo.persistent.quotaKB | string | |

| result.storageinfo.persistent.usedKB | string | |

Copilot · 2026-02-17T01:15:55Z

docs/apis/PackageManager.md

+| result.installedIds | IPackageKeyIterator |  |
+| result.installedIds[#].id | string |  |
+| result.installedIds[#].version | string |  |


There's a mismatch between the parameter documentation and the example response. The parameters show "result.installedIds[#].id" and "result.installedIds[#].version", but the example response shows the result as a direct array without the "installedIds" wrapper.

Based on the IPackageManager.h interface (line 178) which returns an IPackageKeyIterator, the JSON-RPC representation typically serializes iterators as arrays. The parameter documentation should either:

Match the example and show "result[#].id" and "result[#].version", or

The example should wrap the array in an "installedIds" field

Consistency between parameter documentation and examples is important for API consumers.

Copilot · 2026-02-17T01:15:55Z

docs/apis/PackageManager.md

+## *uninstall*

-Resume
+Uninstall


The brief description has been changed from "Uninstalls an application" to just "Uninstall". While "Uninstalls an application" was already brief, changing it to just "Uninstall" makes it even less informative. Method descriptions should be complete sentences.

Suggested change

Uninstall

Uninstalls an application package.

Copilot · 2026-02-17T01:15:56Z

docs/apis/PackageManager.md

-| params.version | string |  |
+| params.version | string | Version |
+| params.additionalMetadata | IKeyValueIterator | Additional Metadata |
+| params.additionalMetadata[#].name | string |  |


The KeyValue struct field naming is inconsistent between interfaces. In IAppPackageManager.h (lines 208-213), the KeyValue struct used by IPackageInstaller has "name" and "value" fields. However, in IPackageManager.h (lines 96-99), the KeyValue struct has "key" and "value" fields.

Since this documentation now references IPackageManager.h (line 5), but documents the install method from IPackageInstaller (which uses "name"), there's a naming inconsistency that should be resolved. Ensure the correct struct definition is used based on which interface is actually being implemented.

Suggested change

| params.additionalMetadata[#].name | string | |

| params.additionalMetadata[#].key | string | |

Copilot · 2026-02-17T01:15:57Z

docs/apis/PackageManager.md

+| result.result | LockInfo |  |
+| result.result.reason | string |  |
+| result.result.owner | string |  |


The result structure documentation appears incorrect. It shows "result.result.reason" and "result.result.owner", which suggests a nested "result.result" structure. However, based on the IPackageManager.h interface (line 207), the GetLockInfo method returns a LockInfo struct directly. The documentation should be:

result (object containing LockInfo fields)

result.reason (string)

result.owner (string)

Not "result.result.reason" and "result.result.owner".

Suggested change

| result.result | LockInfo | |

| result.result.reason | string | |

| result.result.owner | string | |

| result.reason | string | |

| result.owner | string | |

Copilot · 2026-02-17T01:15:57Z

docs/apis/PackageManager.md

 ## *cancel*

-Cancels a previously issued asynchronous request.
+Cancel


The brief description has been changed from "Cancels a previously issued asynchronous request" to just "Cancel". This makes the documentation less descriptive and harder to understand. Method descriptions should be complete sentences that clearly explain what the method does, not just restate the method name.

Copilot · 2026-02-17T01:15:57Z

docs/apis/PackageManager.md

+## *install*

-PackageState
+Install


The brief description has been changed from "Downloads and installs an application bundle" to just "Install". This reduces the clarity of the documentation. Method descriptions should be complete sentences that clearly explain what the method does.

Suggested change

Install

Installs the specified package on the device.

Copilot · 2026-02-17T01:15:57Z

docs/apis/PackageManager.md

 # PackageManager Plugin

-**Version: [1.0.0](https://github.com/rdkcentral/entservices-apis/tree/main/apis/PackageManager/IAppPackageManager.h)**
+**Version: [1.0.0](https://github.com/rdkcentral/entservices-apis/tree/main/apis/PackageManager/IPackageManager.h)**


The version link has been changed from IAppPackageManager.h to IPackageManager.h. However, according to the repository's README (apis/PackageManager/README.md), IPackageManager.h is the old interface that will be deleted after transitioning to the new PackageManager, while IAppPackageManager.h contains the new interfaces (IPackageDownloader, IPackageHandler, IPackageInstaller).

The documented APIs in this file appear to be from the new interfaces in IAppPackageManager.h (e.g., download with Options struct, install with additionalMetadata), not from IPackageManager.h. The reference should point to IAppPackageManager.h instead, or the PR title should clarify that this is documenting the old IPackageManager interface.

Copilot · 2026-02-17T01:15:57Z

docs/apis/PackageManager.md

-| params.packageId | string | Package Id |
-| params.version | string |  |
+| params.type | string |  |
+| params.id | string | package id |


The parameter descriptions for "id" and "version" now include descriptions ("package id" and "Version"), which improves clarity. However, there's an inconsistency in capitalization: "package id" is lowercase while "Version" is capitalized. For consistency, either both should be lowercase (e.g., "package id" and "version") or both should follow a consistent capitalization pattern.

Suggested change

| params.id | string | package id |

| params.id | string | Package ID |

into develop

…tservices-apis into topic/RDKEMW-12279

Added GENERAL_FAILURE to IPackageInstaller::FailReason

c99fe06

Copilot AI review requested due to automatic review settings January 29, 2026 17:44

SKumarMetro requested a review from a team as a code owner January 29, 2026 17:44

Copilot started reviewing on behalf of SKumarMetro January 29, 2026 17:44 View session

Copilot AI reviewed Jan 29, 2026

View reviewed changes

Merge branch 'develop' of https://github.com/rdkcentral/entservices-apis

f8ef543

into develop

Copilot AI review requested due to automatic review settings February 3, 2026 19:45

Copilot started reviewing on behalf of SKumarMetro February 3, 2026 19:45 View session

Copilot AI reviewed Feb 3, 2026

View reviewed changes

SKumarMetro added 3 commits February 4, 2026 01:18

Merge branch 'develop' of https://github.com/rdkcentral/entservices-apis

ac7a5b0

into develop

Merge branch 'develop' of https://github.com/rdkcentral/entservices-apis

4e0f9d6

into develop

disable JSONRPC for IPackageHandler

0f8399c

Copilot AI review requested due to automatic review settings February 5, 2026 23:29

Copilot started reviewing on behalf of SKumarMetro February 5, 2026 23:29 View session

Copilot AI reviewed Feb 5, 2026

View reviewed changes

Revert "disable JSONRPC for IPackageHandler"

dd2ebf8

This reverts commit 0f8399c.

SKumarMetro force-pushed the topic/RDKEMW-12279 branch from 3f0233f to dd2ebf8 Compare February 11, 2026 18:50

SKumarMetro added 2 commits February 16, 2026 16:35

Merge branch 'develop' of https://github.com/rdkcentral/entservices-apis

ed31d64

into develop

Merge branch 'develop' into topic/RDKEMW-12279

a9a0ec0

Copilot AI review requested due to automatic review settings February 17, 2026 01:07

Auto-generate documentation from interface changes

a229647

Copilot started reviewing on behalf of SKumarMetro February 17, 2026 01:07 View session

Copilot AI reviewed Feb 17, 2026

View reviewed changes

SKumarMetro added 3 commits February 19, 2026 08:50

Merge branch 'develop' of https://github.com/rdkcentral/entservices-apis

ccb3bcc

into develop

Merge branch 'develop' into topic/RDKEMW-12279

21f1f56

Merge branch 'topic/RDKEMW-12279' of https://github.com/rdkcentral/en…

f2bdd92

…tservices-apis into topic/RDKEMW-12279

-| result.storageinfo.EXTERNAL | struct |  |
-| result.storageinfo.path | string |  |
-| result.storageinfo.quotaKB | string |  |
-| result.storageinfo.usedKB | string |  |
+| result.storageinfo.apps | StorageDetails |  |
+| result.storageinfo.apps.path | string |  |
+| result.storageinfo.apps.quotaKB | string |  |
+| result.storageinfo.apps.usedKB | string |  |
+| result.storageinfo.persistent | StorageDetails |  |
+| result.storageinfo.persistent.path | string |  |
+| result.storageinfo.persistent.quotaKB | string |  |
+| result.storageinfo.persistent.usedKB | string |  |

	\| params.additionalMetadata[#].name \| string \| \|
	\| params.additionalMetadata[#].key \| string \| \|

	\| params.id \| string \| package id \|
	\| params.id \| string \| Package ID \|

Conversation

SKumarMetro commented Jan 29, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Jan 29, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

github-actions bot commented Feb 5, 2026

Documentation Auto-Generated

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Copilot AI Feb 5, 2026

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Feb 17, 2026

Documentation Auto-Generated

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 17, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants