-
-
Notifications
You must be signed in to change notification settings - Fork 255
feat: Add StorageService for offloading large controller data #7192
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
42 commits
Select commit
Hold shift + click to select a range
278eaa9
feat: Add StorageService for offloading large controller data
andrepimenta e844fdd
refactor(storage-service): Move getAllKeys/clear logic to adapters
andrepimenta 19c7d6f
refactor: Adapters now build storage keys (not core)
andrepimenta 5fedbc0
refactor(storage-service): delegate key building and serialization to…
andrepimenta 5af0861
docs(storage-service): update CHANGELOG for initial release
andrepimenta de5388c
docs(storage-service): fix CHANGELOG format
andrepimenta e493d3e
docs(storage-service): update README with current API and precise met…
andrepimenta 81100c2
build: add storage-service to tsconfig.build.json
andrepimenta f5c5aec
Merge branch 'main' into storage-service
andrepimenta 04939f6
docs(storage-service): add JSDoc guidance for large value storage
andrepimenta 3fe4314
Update packages/storage-service/src/StorageService.ts
andrepimenta 84adfd5
Update packages/storage-service/src/StorageService.ts
andrepimenta 7ac8bfc
refactor(storage-service): remove itemRemoved events, keep only itemSet
andrepimenta 24b150e
Merge branch 'storage-service' of https://github.com/MetaMask/core in…
andrepimenta 65efd41
chore(storage-service): add dual MIT+Apache2 license
andrepimenta 60efad1
refactor(storage-service): use unknown instead of generic types
andrepimenta 2222e57
refactor(storage-service): use generate-method-action-types pattern
andrepimenta ce68a05
Update packages/storage-service/package.json
andrepimenta afde837
docs(storage-service): simplify README to focus on usage
andrepimenta ae501a3
Merge branch 'storage-service' of https://github.com/MetaMask/core in…
andrepimenta 81c9cf8
docs(storage-service): simplify CHANGELOG for initial release
andrepimenta 625eee6
fix(storage-service): change event payload order to [key, value]
andrepimenta bda7243
Merge branch 'main' into storage-service
andrepimenta d3a7e4e
Fix prettier
andrepimenta 389e50a
Merge branch 'storage-service' of https://github.com/MetaMask/core in…
andrepimenta 3aeafac
Fix keywords
andrepimenta c46e2e2
Update packages/storage-service/package.json
andrepimenta 1b48670
test(storage-service): add tests for itemSet event
andrepimenta 8050f20
Merge branch 'storage-service' of https://github.com/MetaMask/core in…
andrepimenta 9a65054
refactor(storage-service): use Json type instead of unknown
andrepimenta d6fe459
chore(storage-service): add CODEOWNERS and teams.json entries
andrepimenta 5b4faeb
Update packages/storage-service/src/StorageService.ts
andrepimenta 363533a
Update packages/storage-service/src/InMemoryStorageAdapter.ts
andrepimenta f5ccb18
Update packages/storage-service/src/InMemoryStorageAdapter.ts
andrepimenta b5c5d79
feat(storage-service): add StorageGetResult type for getItem responses
andrepimenta 8557995
Merge branch 'storage-service' of https://github.com/MetaMask/core in…
andrepimenta 7ccd865
Update packages/storage-service/CHANGELOG.md
andrepimenta a139816
fix(storage-service): fix prettier formatting in test
andrepimenta 5598df9
Merge branch 'storage-service' of https://github.com/MetaMask/core in…
andrepimenta bbd8e39
Merge branch 'main' into storage-service
andrepimenta cf634fb
Prettier fix
andrepimenta 6bf384a
Fix return types on StorageServiceGetItemAction
andrepimenta File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| # Changelog | ||
|
|
||
| All notable changes to this project will be documented in this file. | ||
|
|
||
| The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), | ||
| and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | ||
|
|
||
| ## [Unreleased] | ||
|
|
||
| ### Added | ||
|
|
||
| - Initial release of `@metamask/storage-service` ([#7192](https://github.com/MetaMask/core/pull/7192)) | ||
|
|
||
| [Unreleased]: https://github.com/MetaMask/core/ |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| This project is licensed under either of | ||
|
|
||
| * MIT license ([LICENSE.MIT](LICENSE.MIT)) | ||
| * Apache License, Version 2.0 ([LICENSE.APACHE2](LICENSE.APACHE2)) | ||
|
|
||
| at your option. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,201 @@ | ||
| Apache License | ||
| Version 2.0, January 2004 | ||
| http://www.apache.org/licenses/ | ||
|
|
||
| TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION | ||
|
|
||
| 1. Definitions. | ||
|
|
||
| "License" shall mean the terms and conditions for use, reproduction, | ||
| and distribution as defined by Sections 1 through 9 of this document. | ||
|
|
||
| "Licensor" shall mean the copyright owner or entity authorized by | ||
| the copyright owner that is granting the License. | ||
|
|
||
| "Legal Entity" shall mean the union of the acting entity and all | ||
| other entities that control, are controlled by, or are under common | ||
| control with that entity. For the purposes of this definition, | ||
| "control" means (i) the power, direct or indirect, to cause the | ||
| direction or management of such entity, whether by contract or | ||
| otherwise, or (ii) ownership of fifty percent (50%) or more of the | ||
| outstanding shares, or (iii) beneficial ownership of such entity. | ||
|
|
||
| "You" (or "Your") shall mean an individual or Legal Entity | ||
| exercising permissions granted by this License. | ||
|
|
||
| "Source" form shall mean the preferred form for making modifications, | ||
| including but not limited to software source code, documentation | ||
| source, and configuration files. | ||
|
|
||
| "Object" form shall mean any form resulting from mechanical | ||
| transformation or translation of a Source form, including but | ||
| not limited to compiled object code, generated documentation, | ||
| and conversions to other media types. | ||
|
|
||
| "Work" shall mean the work of authorship, whether in Source or | ||
| Object form, made available under the License, as indicated by a | ||
| copyright notice that is included in or attached to the work | ||
| (an example is provided in the Appendix below). | ||
|
|
||
| "Derivative Works" shall mean any work, whether in Source or Object | ||
| form, that is based on (or derived from) the Work and for which the | ||
| editorial revisions, annotations, elaborations, or other modifications | ||
| represent, as a whole, an original work of authorship. For the purposes | ||
| of this License, Derivative Works shall not include works that remain | ||
| separable from, or merely link (or bind by name) to the interfaces of, | ||
| the Work and Derivative Works thereof. | ||
|
|
||
| "Contribution" shall mean any work of authorship, including | ||
| the original version of the Work and any modifications or additions | ||
| to that Work or Derivative Works thereof, that is intentionally | ||
| submitted to Licensor for inclusion in the Work by the copyright owner | ||
| or by an individual or Legal Entity authorized to submit on behalf of | ||
| the copyright owner. For the purposes of this definition, "submitted" | ||
| means any form of electronic, verbal, or written communication sent | ||
| to the Licensor or its representatives, including but not limited to | ||
| communication on electronic mailing lists, source code control systems, | ||
| and issue tracking systems that are managed by, or on behalf of, the | ||
| Licensor for the purpose of discussing and improving the Work, but | ||
| excluding communication that is conspicuously marked or otherwise | ||
| designated in writing by the copyright owner as "Not a Contribution." | ||
|
|
||
| "Contributor" shall mean Licensor and any individual or Legal Entity | ||
| on behalf of whom a Contribution has been received by Licensor and | ||
| subsequently incorporated within the Work. | ||
|
|
||
| 2. Grant of Copyright License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| copyright license to reproduce, prepare Derivative Works of, | ||
| publicly display, publicly perform, sublicense, and distribute the | ||
| Work and such Derivative Works in Source or Object form. | ||
|
|
||
| 3. Grant of Patent License. Subject to the terms and conditions of | ||
| this License, each Contributor hereby grants to You a perpetual, | ||
| worldwide, non-exclusive, no-charge, royalty-free, irrevocable | ||
| (except as stated in this section) patent license to make, have made, | ||
| use, offer to sell, sell, import, and otherwise transfer the Work, | ||
| where such license applies only to those patent claims licensable | ||
| by such Contributor that are necessarily infringed by their | ||
| Contribution(s) alone or by combination of their Contribution(s) | ||
| with the Work to which such Contribution(s) was submitted. If You | ||
| institute patent litigation against any entity (including a | ||
| cross-claim or counterclaim in a lawsuit) alleging that the Work | ||
| or a Contribution incorporated within the Work constitutes direct | ||
| or contributory patent infringement, then any patent licenses | ||
| granted to You under this License for that Work shall terminate | ||
| as of the date such litigation is filed. | ||
|
|
||
| 4. Redistribution. You may reproduce and distribute copies of the | ||
| Work or Derivative Works thereof in any medium, with or without | ||
| modifications, and in Source or Object form, provided that You | ||
| meet the following conditions: | ||
|
|
||
| (a) You must give any other recipients of the Work or | ||
| Derivative Works a copy of this License; and | ||
|
|
||
| (b) You must cause any modified files to carry prominent notices | ||
| stating that You changed the files; and | ||
|
|
||
| (c) You must retain, in the Source form of any Derivative Works | ||
| that You distribute, all copyright, patent, trademark, and | ||
| attribution notices from the Source form of the Work, | ||
| excluding those notices that do not pertain to any part of | ||
| the Derivative Works; and | ||
|
|
||
| (d) If the Work includes a "NOTICE" text file as part of its | ||
| distribution, then any Derivative Works that You distribute must | ||
| include a readable copy of the attribution notices contained | ||
| within such NOTICE file, excluding those notices that do not | ||
| pertain to any part of the Derivative Works, in at least one | ||
| of the following places: within a NOTICE text file distributed | ||
| as part of the Derivative Works; within the Source form or | ||
| documentation, if provided along with the Derivative Works; or, | ||
| within a display generated by the Derivative Works, if and | ||
| wherever such third-party notices normally appear. The contents | ||
| of the NOTICE file are for informational purposes only and | ||
| do not modify the License. You may add Your own attribution | ||
| notices within Derivative Works that You distribute, alongside | ||
| or as an addendum to the NOTICE text from the Work, provided | ||
| that such additional attribution notices cannot be construed | ||
| as modifying the License. | ||
|
|
||
| You may add Your own copyright statement to Your modifications and | ||
| may provide additional or different license terms and conditions | ||
| for use, reproduction, or distribution of Your modifications, or | ||
| for any such Derivative Works as a whole, provided Your use, | ||
| reproduction, and distribution of the Work otherwise complies with | ||
| the conditions stated in this License. | ||
|
|
||
| 5. Submission of Contributions. Unless You explicitly state otherwise, | ||
| any Contribution intentionally submitted for inclusion in the Work | ||
| by You to the Licensor shall be under the terms and conditions of | ||
| this License, without any additional terms or conditions. | ||
| Notwithstanding the above, nothing herein shall supersede or modify | ||
| the terms of any separate license agreement you may have executed | ||
| with Licensor regarding such Contributions. | ||
|
|
||
| 6. Trademarks. This License does not grant permission to use the trade | ||
| names, trademarks, service marks, or product names of the Licensor, | ||
| except as required for reasonable and customary use in describing the | ||
| origin of the Work and reproducing the content of the NOTICE file. | ||
|
|
||
| 7. Disclaimer of Warranty. Unless required by applicable law or | ||
| agreed to in writing, Licensor provides the Work (and each | ||
| Contributor provides its Contributions) on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or | ||
| implied, including, without limitation, any warranties or conditions | ||
| of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A | ||
| PARTICULAR PURPOSE. You are solely responsible for determining the | ||
| appropriateness of using or redistributing the Work and assume any | ||
| risks associated with Your exercise of permissions under this License. | ||
|
|
||
| 8. Limitation of Liability. In no event and under no legal theory, | ||
| whether in tort (including negligence), contract, or otherwise, | ||
| unless required by applicable law (such as deliberate and grossly | ||
| negligent acts) or agreed to in writing, shall any Contributor be | ||
| liable to You for damages, including any direct, indirect, special, | ||
| incidental, or consequential damages of any character arising as a | ||
| result of this License or out of the use or inability to use the | ||
| Work (including but not limited to damages for loss of goodwill, | ||
| work stoppage, computer failure or malfunction, or any and all | ||
| other commercial damages or losses), even if such Contributor | ||
| has been advised of the possibility of such damages. | ||
|
|
||
| 9. Accepting Warranty or Additional Liability. While redistributing | ||
| the Work or Derivative Works thereof, You may choose to offer, | ||
| and charge a fee for, acceptance of support, warranty, indemnity, | ||
| or other liability obligations and/or rights consistent with this | ||
| License. However, in accepting such obligations, You may act only | ||
| on Your own behalf and on Your sole responsibility, not on behalf | ||
| of any other Contributor, and only if You agree to indemnify, | ||
| defend, and hold each Contributor harmless for any liability | ||
| incurred by, or claims asserted against, such Contributor by reason | ||
| of your accepting any such warranty or additional liability. | ||
|
|
||
| END OF TERMS AND CONDITIONS | ||
|
|
||
| APPENDIX: How to apply the Apache License to your work. | ||
|
|
||
| To apply the Apache License to your work, attach the following | ||
| boilerplate notice, with the fields enclosed by brackets "[]" | ||
| replaced with your own identifying information. (Don't include | ||
| the brackets!) The text should be enclosed in the appropriate | ||
| comment syntax for the file format. We also recommend that a | ||
| file or class name and description of purpose be included on the | ||
| same "printed page" as the copyright notice for easier | ||
| identification within third-party archives. | ||
|
|
||
| Copyright 2025 MetaMask | ||
|
|
||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
|
|
||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
|
|
||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2025 MetaMask | ||
|
|
||
| Permission is hereby granted, free of charge, to any person obtaining a copy | ||
| of this software and associated documentation files (the "Software"), to deal | ||
| in the Software without restriction, including without limitation the rights | ||
| to use, copy, modify, merge, publish, distribute, sublicense, and/or sell | ||
| copies of the Software, and to permit persons to whom the Software is | ||
| furnished to do so, subject to the following conditions: | ||
|
|
||
| The above copyright notice and this permission notice shall be included in all | ||
| copies or substantial portions of the Software. | ||
|
|
||
| THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR | ||
| IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, | ||
| FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE | ||
| AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER | ||
| LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, | ||
| OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE | ||
| SOFTWARE. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| # `@metamask/storage-service` | ||
|
|
||
| A platform-agnostic service for storing large, infrequently accessed controller data outside of memory. | ||
|
|
||
| ## When to Use | ||
|
|
||
| ✅ **Use StorageService for:** | ||
|
|
||
| - Large data (> 100 KB) | ||
| - Infrequently accessed data | ||
| - Data that doesn't need to be in Redux state | ||
| - Examples: Snap source code, cached API responses | ||
|
|
||
| ❌ **Don't use for:** | ||
|
|
||
| - Frequently accessed data (use controller state) | ||
| - Small data (< 10 KB - overhead not worth it) | ||
| - Data needed for UI rendering | ||
|
|
||
| ## Installation | ||
|
|
||
| `yarn add @metamask/storage-service` | ||
|
|
||
| or | ||
|
|
||
| `npm install @metamask/storage-service` | ||
|
|
||
| ## Usage | ||
|
|
||
| ### Controller Setup | ||
|
|
||
| ```typescript | ||
| import type { | ||
| StorageServiceSetItemAction, | ||
| StorageServiceGetItemAction, | ||
| } from '@metamask/storage-service'; | ||
|
|
||
| // Grant access to storage actions | ||
| type AllowedActions = | ||
| | StorageServiceSetItemAction | ||
| | StorageServiceGetItemAction; | ||
|
|
||
| class MyController extends BaseController<...> { | ||
| async storeData(id: string, data: string) { | ||
| await this.messenger.call( | ||
| 'StorageService:setItem', | ||
| 'MyController', | ||
| `${id}:data`, | ||
| data, | ||
| ); | ||
| } | ||
|
|
||
| async getData(id: string): Promise<string | undefined> { | ||
| const { result, error } = await this.messenger.call( | ||
| 'StorageService:getItem', | ||
| 'MyController', | ||
| `${id}:data`, | ||
| ); | ||
| if (error) { | ||
| throw error; | ||
| } | ||
| // result is undefined if key doesn't exist | ||
| return result as string | undefined; | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| ### Service Initialization | ||
|
|
||
| The service accepts an optional `StorageAdapter` for platform-specific storage: | ||
|
|
||
| ```typescript | ||
| import { StorageService, type StorageAdapter } from '@metamask/storage-service'; | ||
|
|
||
| // Production: Provide a platform-specific adapter | ||
| const service = new StorageService({ | ||
| messenger: storageServiceMessenger, | ||
| storage: myPlatformAdapter, // FilesystemStorage, IndexedDB, etc. | ||
| }); | ||
|
|
||
| // Testing: Uses in-memory storage by default | ||
| const testService = new StorageService({ | ||
| messenger: testMessenger, | ||
| // No adapter needed - data isolated per test | ||
| }); | ||
| ``` | ||
|
|
||
| ### Events | ||
|
|
||
| Subscribe to storage changes: | ||
|
|
||
| ```typescript | ||
| this.messenger.subscribe( | ||
| 'StorageService:itemSet:MyController', | ||
| (key, value) => { | ||
| console.log(`Data stored: ${key}`); | ||
| }, | ||
| ); | ||
| ``` | ||
|
|
||
| ## StorageAdapter Interface | ||
|
|
||
| Implement this interface to provide platform-specific storage: | ||
|
|
||
| ```typescript | ||
| import type { Json } from '@metamask/utils'; | ||
|
|
||
| // Response type for getItem - distinguishes found, not found, and error | ||
| type StorageGetResult = | ||
| | { result: Json; error?: never } // Data found | ||
| | { result?: never; error: Error } // Error occurred | ||
| | Record<string, never>; // Key doesn't exist (empty object) | ||
|
|
||
| export type StorageAdapter = { | ||
| getItem(namespace: string, key: string): Promise<StorageGetResult>; | ||
| setItem(namespace: string, key: string, value: Json): Promise<void>; | ||
| removeItem(namespace: string, key: string): Promise<void>; | ||
| getAllKeys(namespace: string): Promise<string[]>; | ||
| clear(namespace: string): Promise<void>; | ||
| }; | ||
| ``` | ||
|
|
||
| Adapters are responsible for: | ||
|
|
||
| - Building the full storage key (e.g., `storageService:namespace:key`) | ||
| - Serializing/deserializing JSON data | ||
| - Returning the correct response format for getItem | ||
|
|
||
| ## Contributing | ||
|
|
||
| This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme). |
Oops, something went wrong.
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.