feat(translation-hub): persist selected translation providers in tran…#1186
feat(translation-hub): persist selected translation providers in tran…#1186zhanxiaoge wants to merge 2 commits intomengxi-ream:mainfrom
Conversation
…slation center dropdown
🦋 Changeset detectedLatest commit: a21c2da The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
dosubot
bot
added
the
size:XL
|
Related Documentation 2 document(s) may need updating based on files changed in this PR: Read Frog - Open Source Immersive Translate API Providers ConfigurationView Suggested Changes@@ -15,6 +15,11 @@
- `temperature`: (Optional, LLM translation providers only) Number controlling randomness/creativity in AI responses. Lower values (e.g., 0) are more deterministic, higher values are more creative. Leave empty to use provider default.
- `providerOptions`: (Optional, LLM translation providers only) Object containing provider-specific advanced options (e.g., for enabling special API features). This is a JSON object passed directly to the provider; see provider documentation for supported keys.
- `connectionOptions`: (Optional) Object containing provider-specific connection settings (e.g., AWS region for Bedrock)
+
+### Translation Hub Configuration
+The translation hub (translation center) configuration is stored in `translate.translationHubConfig` and includes:
+
+- `selectedIds`: Array of provider IDs that are selected/active in the translation hub dropdown. These selections are persisted across sessions, allowing users to maintain their preferred set of translation providers. When a user selects or deselects providers in the translation hub UI, those changes are automatically saved to this array. The default value is an empty array, meaning users need to explicitly select providers on first use, but those selections will persist in subsequent sessions.
Example configuration schema:
```ts
@@ -449,6 +454,11 @@
- The vocabulary insight feature has been fully removed and replaced by Custom AI Action's Dictionary feature
- Converts `translate.page.shortcut` from string[] to portable hotkey string
+**v066 to v067 migration:**
+- Adds `translationHubConfig` to `translate` configuration
+- Adds `selectedIds` field to `translationHubConfig` (default: empty array `[]`)
+- Provider selections in the translation hub are now persisted across sessions
+
---
## Custom AI ActionsConfiguration Schema and MigrationView Suggested Changes@@ -33,7 +33,7 @@
**Note:** The schema version and last modified time are tracked in the configuration's metadata (`meta`), not as fields inside the config object itself. This improves separation of user settings and system metadata, and is reflected in all import/export and sync operations.
-**Current schema version:** The latest `CONFIG_SCHEMA_VERSION` is **66**.
+**Current schema version:** The latest `CONFIG_SCHEMA_VERSION` is **67**.
#### Configuration Initialization Optimization
The `initializeConfig()` function optimizes storage operations by tracking changes during initialization:
@@ -909,6 +909,46 @@
This migration enables users to adjust selection toolbar visibility based on their preferences, making the toolbar less intrusive when needed while maintaining full functionality.
+#### Example: v66 to v67 Migration (Translation Hub Selected Providers)
+The migration from v66 to v67 adds a new `translationHubConfig` object to the `translate` configuration. This configuration persists the user's selected translation providers in the translation center (translation hub) dropdown.
+
+**Key changes:**
+- Adds `translationHubConfig` object to `translate` configuration
+- The object contains a `selectedIds` array that stores the IDs of selected translation providers
+- Default value is an empty array `[]`
+- This enables the translation center panel to remember which providers the user has selected across sessions
+
+The migration script adds this field with an empty array as the default:
+
+```ts
+// migration-scripts/v066-to-v067.ts
+export function migrate(oldConfig: any): any {
+ const translate = oldConfig.translate
+
+ if (!translate) {
+ return oldConfig
+ }
+
+ return {
+ ...oldConfig,
+ translate: {
+ ...translate,
+ translationHubConfig: {
+ selectedIds: [],
+ },
+ },
+ }
+}
+```
+
+**Implementation details:**
+- The `translationHubConfig.selectedIds` array stores provider IDs that correspond to entries in `providersConfig`
+- When the translation hub is opened (e.g., as a Vivaldi panel), previously selected providers are automatically restored
+- Provider selection state is synchronized across all translation hub instances
+- Empty array indicates no providers have been explicitly selected (defaults to showing all enabled providers)
+
+This migration improves the user experience for users who frequently use the translation center, especially when it's set as a browser panel, by preserving their provider selection preferences.
+
#### Example: v65 to v66 Migration (Page Translation Shortcut Format and Vocabulary Insight Removal)
The migration from v65 to v66 performs two changes:
1. Converts the `translate.page.shortcut` field from a string array format to a portable hotkey string format
@@ -1614,6 +1654,28 @@
}
```
+#### v67 Example (Translation Hub Selected Providers)
+```ts
+export const testSeries = {
+ 'complex-config-from-v020': {
+ description: 'Adds translationHubConfig to translate configuration',
+ config: {
+ // ... other config fields
+ translate: {
+ providerId: 'openai-default',
+ mode: 'translationOnly',
+ // ...
+ translationHubConfig: { // New field added in v067
+ selectedIds: [],
+ },
+ // ...
+ },
+ // ...
+ },
+ },
+}
+```
+
#### v66 Example (Page Translation Shortcut Format and Vocabulary Insight Removal)
```ts
export const testSeries = {Note: You must be authenticated to accept/decline updates. How did I do? Any feedback? |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 8014959099
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| translationHubConfig: { | ||
| selectedIds: [], |
There was a problem hiding this comment.
When upgrading an existing v66 profile, this migration hard-codes selectedIds: [], which wipes out the translation hub’s effective selection. Before this change the hub selected every enabled translate provider by default via selectedProviderIdsAtom, so the first open after upgrade now lands on the “No Translation Services Selected” empty state and Translate produces no cards until the user manually rebuilds that list. If the goal is to persist the previous dropdown state, the migration needs to derive the initial selectedIds from the currently enabled translate providers instead of clearing it.
Useful? React with 👍 / 👎.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
1 issue found across 6 files
Prompt for AI agents (unresolved issues)
Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.
<file name="src/utils/config/migration-scripts/v066-to-v067.ts">
<violation number="1" location="src/utils/config/migration-scripts/v066-to-v067.ts:21">
P1: The migration seeds `selectedIds` with an empty array, but the atom's read function now filters enabled providers against this list (`translateEnabledProviders.filter(id => selectedIds.includes(id))`). Since the previous behavior selected all enabled translate providers by default, upgrading users will land on an empty selection with no translation cards. Populate `selectedIds` from the existing enabled translate providers to preserve the pre-upgrade behavior.</violation>
</file>
Since this is your first cubic review, here's how it works:
- cubic automatically reviews your code and comments on bugs and improvements
- Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
- Add one-off context when rerunning by tagging
@cubic-dev-aiwith guidance or docs links (includingllms.txt) - Ask questions if you need clarification on any suggestion
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| translate: { | ||
| ...translate, | ||
| translationHubConfig: { | ||
| selectedIds: [], |
There was a problem hiding this comment.
P1: The migration seeds selectedIds with an empty array, but the atom's read function now filters enabled providers against this list (translateEnabledProviders.filter(id => selectedIds.includes(id))). Since the previous behavior selected all enabled translate providers by default, upgrading users will land on an empty selection with no translation cards. Populate selectedIds from the existing enabled translate providers to preserve the pre-upgrade behavior.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At src/utils/config/migration-scripts/v066-to-v067.ts, line 21:
<comment>The migration seeds `selectedIds` with an empty array, but the atom's read function now filters enabled providers against this list (`translateEnabledProviders.filter(id => selectedIds.includes(id))`). Since the previous behavior selected all enabled translate providers by default, upgrading users will land on an empty selection with no translation cards. Populate `selectedIds` from the existing enabled translate providers to preserve the pre-upgrade behavior.</comment>
<file context>
@@ -0,0 +1,25 @@
+ translate: {
+ ...translate,
+ translationHubConfig: {
+ selectedIds: [],
+ },
+ },
</file context>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: a21c2da213
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| const override = get(selectedProviderIdsOverrideAtom) | ||
| if (override !== null) | ||
| return override |
There was a problem hiding this comment.
Once setSelectedIds runs, selectedProviderIdsOverrideAtom stays non-null for the rest of the page lifetime, so this getter never re-applies filterEnabledProvidersConfig or re-reads the persisted translate.translationHubConfig.selectedIds. In the common Vivaldi-panel workflow where the hub stays mounted, disabling a provider or importing synced config from popup/options leaves the panel on stale ids; selectedProvidersAtom then resolves those ids straight from providersConfig, so a provider disabled elsewhere can still be shown and used until the page reloads.
Useful? React with 👍 / 👎.
| batchQueueConfig: batchQueueConfigSchema, | ||
| translationNodeStyle: translationNodeStyleConfigSchema, | ||
| translationHubConfig: translationHubConfigSchema, |
There was a problem hiding this comment.
Adding a required translationHubConfig here makes every stored v66 config fail configSchema.safeParse until migration has finished. getLocalConfig() does not migrate on read—it falls back to DEFAULT_CONFIG on validation failure (src/utils/config/storage.ts)—and both src/entrypoints/translation-hub/main.tsx and src/entrypoints/popup/main.tsx hydrate from that helper. On upgrade, if the user opens the panel/popup before the background ensureInitializedConfig() completes, those UIs boot with a reset config instead of the stored one.
Useful? React with 👍 / 👎.
github-actions
bot
added
the
contrib-trust:moderate
Contributor trust score14/100 — New contributor This score estimates contributor familiarity with Outcome
Score breakdown
Signals used
Policy
Updated automatically when the PR changes or when a maintainer reruns the workflow. |
github-actions
bot
added
contrib-trust:new
taiiiyang
left a comment
taiiiyang
left a comment
There was a problem hiding this comment.
Right direction, just a few small things to fix up.
- When a user first enters the interface, you need to determine whether the user's selectedIds are empty. If they are empty, you should refill selectedIds using the enabled providers from providersConfig.
- Additionally, when deleting a provider from providerConfigs, you must also remove the corresponding providerId from selectedIds.
| translationHubConfig: { | ||
| selectedIds: [], |
There was a problem hiding this comment.
During migration, you need to read the enable providers from the previous version's providersConfig, then fill in selectedIds to ensure users can see the default selected provider in the new version, avoiding the need to manually re-select after entering the page.
2 participants
…slation center dropdown
Type of Changes
Description
In Vivaldi, you can set the translation center page as a panel tool. I added this function because I hope to retain my previous settings every time I open the panel.
Related Issue
Closes #
How Has This Been Tested?
Screenshots
Checklist
Additional Information
Summary by cubic
Persists selected translation providers in the translation hub dropdown across sessions. Adds
translate.translationHubConfig.selectedIdsand migrates configs to v67.New Features
selectedProviderIdsAtomnow reads/writestranslate.translationHubConfig.selectedIds.selectedIdsare applied.Migration
translationHubConfig.selectedIds: []to existing configs; no action needed.Written for commit a21c2da. Summary will update on new commits.