feat(mobile app): expose app translations via REST API for mobile clients#39959
Open
divyanshu-patil wants to merge 2 commits intoRocketChat:developfrom
Open
feat(mobile app): expose app translations via REST API for mobile clients#39959divyanshu-patil wants to merge 2 commits intoRocketChat:developfrom
divyanshu-patil wants to merge 2 commits intoRocketChat:developfrom
Conversation
Contributor
|
Looks like this PR is not ready to merge, because of the following issues:
Please fix the issues and try again If you have any trouble, please check the PR guidelines |
|
Contributor
WalkthroughAdded a new REST endpoint Changes
Sequence DiagramsequenceDiagram
actor Client
participant API as API Server
participant Validator as Validator (AJV)
participant Manager as Apps Manager
participant App as Enabled Apps
participant Storage as App Storage
Client->>API: GET /apps.translations?language=pt-BR
API->>Validator: Validate language parameter
Validator-->>API: ✓ Valid
API->>API: Normalize language: "pt-br"
API->>Manager: getManager()
Manager-->>API: Manager instance (or null)
alt Manager exists
API->>Manager: get({ enabled: true })
Manager-->>API: List of enabled apps
loop For each app
API->>Storage: app.getStorageItem().languageContent
Storage-->>API: Language content map
API->>API: Select translations for "pt-br" or fallback to "en"
API->>API: Merge with prefix "app-${appId}.${key}"
end
else Manager unavailable
API-->>Client: 400 Failure response
end
API-->>Client: 200 { language, translations, success: true }
Estimated Code Review Effort🎯 3 (Moderate) | ⏱️ ~25 minutes Suggested Labels
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
10 tasks
coderabbitai
bot
added
the
type: feature
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (1)
apps/meteor/app/api/server/v1/i18n.ts (1)
40-40: Underscore-based locale codes will not be normalized.The split on
'-'handles BCP-47 tags like"en-US"→"en", but locale codes using underscores (e.g.,"pt_BR") will remain as-is and likely fail to match stored translations. If mobile clients might send underscore-based locales, consider normalizing both separators:-const language = (this.queryParams.language ?? 'en').split('-')[0].toLowerCase(); +const language = (this.queryParams.language ?? 'en').split(/[-_]/)[0].toLowerCase();🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@apps/meteor/app/api/server/v1/i18n.ts` at line 40, Normalize incoming locale separators for the language extraction in i18n.ts: instead of only splitting this.queryParams.language on '-' (used to set the language variable), split or normalize both '-' and '_' (e.g., replace '_' with '-' or split on /[-_]/) before taking the primary subtag and lowercasing it so underscore-based codes like "pt_BR" become "pt" and match stored translations.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In `@apps/meteor/app/api/server/v1/i18n.ts`:
- Line 40: Normalize incoming locale separators for the language extraction in
i18n.ts: instead of only splitting this.queryParams.language on '-' (used to set
the language variable), split or normalize both '-' and '_' (e.g., replace '_'
with '-' or split on /[-_]/) before taking the primary subtag and lowercasing it
so underscore-based codes like "pt_BR" become "pt" and match stored
translations.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: e84cb8ef-2747-4c91-9805-d4bbdb7ba104
📒 Files selected for processing (2)
apps/meteor/app/api/server/index.tsapps/meteor/app/api/server/v1/i18n.ts
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)
- GitHub Check: cubic · AI code reviewer
🧰 Additional context used
📓 Path-based instructions (1)
**/*.{ts,tsx,js}
📄 CodeRabbit inference engine (.cursor/rules/playwright.mdc)
**/*.{ts,tsx,js}: Write concise, technical TypeScript/JavaScript with accurate typing in Playwright tests
Avoid code comments in the implementation
Files:
apps/meteor/app/api/server/index.tsapps/meteor/app/api/server/v1/i18n.ts
🧠 Learnings (10)
📓 Common learnings
Learnt from: d-gubert
Repo: RocketChat/Rocket.Chat PR: 37547
File: packages/i18n/src/locales/en.i18n.json:634-634
Timestamp: 2025-11-19T12:32:29.696Z
Learning: Repo: RocketChat/Rocket.Chat
Context: i18n workflow
Learning: In this repository, new translation keys should be added to packages/i18n/src/locales/en.i18n.json only; other locale files are populated via the external translation pipeline and/or fall back to English. Do not request adding the same key to all locale files in future reviews.
Learnt from: smirk-dev
Repo: RocketChat/Rocket.Chat PR: 39625
File: apps/meteor/app/api/server/v1/push.ts:85-97
Timestamp: 2026-03-14T14:58:58.834Z
Learning: In RocketChat/Rocket.Chat, the `push.token` POST/DELETE endpoints in `apps/meteor/app/api/server/v1/push.ts` were already migrated to the chained router API pattern on `develop` prior to PR `#39625`. `cleanTokenResult` (which strips `authToken` and returns `PushTokenResult`) and `isPushTokenPOSTProps`/`isPushTokenDELETEProps` validators already exist on `develop`. PR `#39625` only migrates `push.get` and `push.info` to the chained pattern. Do not flag `cleanTokenResult` or `PushTokenResult` as newly introduced behavior-breaking changes when reviewing this PR.
Learnt from: ahmed-n-abdeltwab
Repo: RocketChat/Rocket.Chat PR: 38974
File: apps/meteor/app/api/server/v1/im.ts:220-221
Timestamp: 2026-02-24T19:09:09.561Z
Learning: In RocketChat/Rocket.Chat OpenAPI migration PRs for apps/meteor/app/api/server/v1 endpoints, maintainers prefer to avoid any logic changes; style-only cleanups (like removing inline comments) may be deferred to follow-ups to keep scope tight.
📚 Learning: 2026-02-24T19:09:09.561Z
Learnt from: ahmed-n-abdeltwab
Repo: RocketChat/Rocket.Chat PR: 38974
File: apps/meteor/app/api/server/v1/im.ts:220-221
Timestamp: 2026-02-24T19:09:09.561Z
Learning: In RocketChat/Rocket.Chat OpenAPI migration PRs for apps/meteor/app/api/server/v1 endpoints, maintainers prefer to avoid any logic changes; style-only cleanups (like removing inline comments) may be deferred to follow-ups to keep scope tight.
Applied to files:
apps/meteor/app/api/server/index.ts
📚 Learning: 2026-03-12T10:26:26.697Z
Learnt from: ahmed-n-abdeltwab
Repo: RocketChat/Rocket.Chat PR: 39340
File: apps/meteor/app/api/server/v1/im.ts:1349-1398
Timestamp: 2026-03-12T10:26:26.697Z
Learning: In `apps/meteor/app/api/server/v1/im.ts` (PR `#39340`), the `DmEndpoints` type intentionally includes temporary stub entries for `/v1/im.kick`, `/v1/dm.kick`, `/v1/im.leave`, and `/v1/dm.leave` (using `DmKickProps` and `DmLeaveProps`) even though no route handlers exist for them yet. These stubs were added to preserve type compatibility after removing the original `DmLeaveProps` and related files. They are planned for cleanup in a follow-up PR. Do not flag these as missing implementations when reviewing this file until the follow-up is merged.
Applied to files:
apps/meteor/app/api/server/index.tsapps/meteor/app/api/server/v1/i18n.ts
📚 Learning: 2026-03-16T21:50:42.118Z
Learnt from: amitb0ra
Repo: RocketChat/Rocket.Chat PR: 39676
File: .changeset/migrate-users-register-openapi.md:3-3
Timestamp: 2026-03-16T21:50:42.118Z
Learning: In RocketChat/Rocket.Chat OpenAPI migration PRs, removing endpoint types and validators from `rocket.chat/rest-typings` (e.g., `UserRegisterParamsPOST`, `/v1/users.register` entry) is the *required* migration pattern per RocketChat/Rocket.Chat-Open-API#150 Rule 7 ("No More rest-typings or Manual Typings"). The endpoint type is re-exposed via a module augmentation `.d.ts` file in the consuming package (e.g., `packages/web-ui-registration/src/users-register.d.ts`). This is NOT a breaking change — the correct changeset bump for `rocket.chat/rest-typings` in this scenario is `minor`, not `major`. Do not flag this as a breaking change during OpenAPI migration reviews.
Applied to files:
apps/meteor/app/api/server/index.tsapps/meteor/app/api/server/v1/i18n.ts
📚 Learning: 2026-02-25T20:10:16.987Z
Learnt from: ahmed-n-abdeltwab
Repo: RocketChat/Rocket.Chat PR: 38913
File: packages/ddp-client/src/legacy/types/SDKLegacy.ts:34-34
Timestamp: 2026-02-25T20:10:16.987Z
Learning: In the RocketChat/Rocket.Chat monorepo, packages/ddp-client and apps/meteor do not use TypeScript project references. Module augmentations in apps/meteor (e.g., declare module 'rocket.chat/rest-typings') are not visible when compiling packages/ddp-client in isolation, which is why legacy SDK methods that depend on OperationResult types for OpenAPI-migrated endpoints must remain commented out.
Applied to files:
apps/meteor/app/api/server/index.ts
📚 Learning: 2026-03-20T13:52:29.575Z
Learnt from: ggazzo
Repo: RocketChat/Rocket.Chat PR: 39553
File: apps/meteor/app/api/server/v1/stats.ts:98-117
Timestamp: 2026-03-20T13:52:29.575Z
Learning: In `apps/meteor/app/api/server/v1/stats.ts`, the `statistics.telemetry` POST endpoint intentionally has no `body` AJV schema in its route options. The proper request body shape (a `params` array of telemetry event objects) has not been formally defined yet, so body validation is deferred to a follow-up. Do not flag the missing body schema for this endpoint during OpenAPI migration reviews.
Applied to files:
apps/meteor/app/api/server/index.tsapps/meteor/app/api/server/v1/i18n.ts
📚 Learning: 2026-02-26T19:25:44.063Z
Learnt from: gabriellsh
Repo: RocketChat/Rocket.Chat PR: 38778
File: packages/ui-voip/src/providers/useMediaSession.ts:192-192
Timestamp: 2026-02-26T19:25:44.063Z
Learning: In the Rocket.Chat repository, do not reference Biome lint rules in code review feedback. Biome is not used even if biome.json exists; only reference Biome rules if there is explicit, project-wide usage documented. For TypeScript files, review lint implications without Biome guidance unless the project enables Biome rules.
Applied to files:
apps/meteor/app/api/server/index.tsapps/meteor/app/api/server/v1/i18n.ts
📚 Learning: 2026-02-26T19:25:44.063Z
Learnt from: gabriellsh
Repo: RocketChat/Rocket.Chat PR: 38778
File: packages/ui-voip/src/providers/useMediaSession.ts:192-192
Timestamp: 2026-02-26T19:25:44.063Z
Learning: In this repository (RocketChat/Rocket.Chat), Biome lint rules are not used even if a biome.json exists. When reviewing TypeScript files (e.g., packages/ui-voip/src/providers/useMediaSession.ts), ensure lint suggestions do not reference Biome-specific rules. Rely on general ESLint/TypeScript lint rules and project conventions instead.
Applied to files:
apps/meteor/app/api/server/index.tsapps/meteor/app/api/server/v1/i18n.ts
📚 Learning: 2026-02-24T19:09:01.522Z
Learnt from: ahmed-n-abdeltwab
Repo: RocketChat/Rocket.Chat PR: 38974
File: apps/meteor/app/api/server/v1/im.ts:220-221
Timestamp: 2026-02-24T19:09:01.522Z
Learning: In Rocket.Chat OpenAPI migration PRs for endpoints under apps/meteor/app/api/server/v1, avoid introducing logic changes. Only perform scope-tight changes that preserve behavior; style-only cleanups (e.g., removing inline comments) may be deferred to follow-ups to keep the migration PR focused.
Applied to files:
apps/meteor/app/api/server/v1/i18n.ts
📚 Learning: 2026-02-23T17:53:06.802Z
Learnt from: ggazzo
Repo: RocketChat/Rocket.Chat PR: 35995
File: apps/meteor/app/api/server/v1/rooms.ts:1107-1112
Timestamp: 2026-02-23T17:53:06.802Z
Learning: During PR reviews that touch endpoint files under apps/meteor/app/api/server/v1, enforce strict scope: if a PR targets a specific endpoint (e.g., rooms.favorite), do not propose changes to unrelated endpoints (e.g., rooms.invite) unless maintainers explicitly request them. Focus feedback on the touched endpoint's behavior, API surface, and related tests; avoid broad cross-endpoint changes in the same PR unless requested.
Applied to files:
apps/meteor/app/api/server/v1/i18n.ts
🔇 Additional comments (4)
apps/meteor/app/api/server/index.ts (1)
47-47: LGTM!The import correctly registers the new i18n route module and is properly placed before the
openApiimport which must remain last.apps/meteor/app/api/server/v1/i18n.ts (3)
43-44: Comment documents a critical non-obvious constraint.The coding guidelines advise avoiding code comments, but this one explains a necessary workaround for a circular initialization crash. Given that the PR objectives also highlight this requirement, keeping the comment is justified for maintainability.
57-82: Solid per-app error isolation.The try/catch around each app's translation extraction ensures that a single app's failure (e.g., malformed storage) doesn't prevent other apps' translations from being returned. The fallback from the requested language to English also aligns with the stated requirements.
84-85: LGTM!The response structure correctly matches the declared 200 schema, including an empty
translationsobject when no apps provide translations for the requested language.
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.
Proposed changes
Adds a new REST endpoint
GET /api/v1/apps.translationsthat aggregates i18n translation strings from all installed and enabled Rocket.Chat Apps.Currently, App translations (e.g. slash command descriptions from Jitsi, Giphy, etc.) are only injected into the web client at runtime via
TAPi18next.addResourceBundle(). The React Native client has no way to access these translations, causing raw internal keys likeapp-3b387ba9-f57c-44c6-9810-8c0256abd64c.command_descriptionto be displayed to users instead of human-readable text.This endpoint solves that by reading
languageContentdirectly from each app's storage item and returning a flat merged map of all translation keys for the requested language, with English as a fallback.Example response:
{ "language": "en", "translations": { "app-3b387ba9-f57c-44c6-9810-8c0256abd64c.command_description": "Generate a Jitsi conference call.", "app-3b387ba9-f57c-44c6-9810-8c0256abd64c.command_params": "username" }, "success": true }Issue(s)
RocketChat/Rocket.Chat.ReactNative#7071
Related PRs
RocketChat/Rocket.Chat.ReactNative#7072
Steps to test or reproduce
?language=frwhen onlyenis available) — should fall back to English stringsFurther comments
await import(...)) to avoid a circular initialization crash at boot time — importing it at module level causesAPI.v1to beundefinedwhen the apps communication chain loadslanguageContentare silently skipped