feat(27254): implement new remote-feature-flag-controller #4931
There are no files selected for viewing
This file contains 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 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). | ||||||
|
|
||||||
| ## [0.1.0] | ||||||
|
There was a problem hiding this comment. There are two kinds of sections in each changelog: one for each version that's been released so far, and then an "Unreleased" section for change that haven't shown up in a release yet. For new packages, there aren't any versions released, so all we should have here is an "Unreleased" section:
Suggested change
|
||||||
|
|
||||||
| ### Added | ||||||
|
|
||||||
| - Initial release | ||||||
|
There was a problem hiding this comment. It's best if every changelog entry has a link to the PR that introduced this change. In this case, it's this very PR that introduces the package. So, how about:
Suggested change
|
||||||
|
|
||||||
| [Unreleased]: https://github.com/MetaMask/core/ | ||||||
This file contains 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,20 @@ | ||
| MIT License | ||
|
|
||
| Copyright (c) 2024 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 |
This file contains 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,15 @@ | ||||||
| # `@metamask/example-controllers` | ||||||
|
There was a problem hiding this comment. We should update this to reflect the name of the package:
Suggested change
|
||||||
|
|
||||||
| This package is designed to illustrate best practices for controller packages and controller files, including tests. | ||||||
|
There was a problem hiding this comment. Is there a description you can give this package? Here's the one you gave in
Suggested change
|
||||||
|
|
||||||
| ## Installation | ||||||
|
|
||||||
| `yarn add @metamask/remote-feature-flag-controller` | ||||||
|
|
||||||
| or | ||||||
|
|
||||||
| `npm install @metamask/remote-feature-flag-controller` | ||||||
|
|
||||||
| ## Contributing | ||||||
|
|
||||||
| This package is part of a monorepo. Instructions for contributing can be found in the [monorepo README](https://github.com/MetaMask/core#readme). | ||||||
This file contains 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,26 @@ | ||
| /* | ||
| * For a detailed explanation regarding each configuration property and type check, visit: | ||
| * https://jestjs.io/docs/configuration | ||
| */ | ||
|
|
||
| const merge = require('deepmerge'); | ||
| const path = require('path'); | ||
|
|
||
| const baseConfig = require('../../jest.config.packages'); | ||
|
|
||
| const displayName = path.basename(__dirname); | ||
|
|
||
| module.exports = merge(baseConfig, { | ||
| // The display name when running multiple projects | ||
| displayName, | ||
|
|
||
| // An object that configures minimum threshold enforcement for coverage results | ||
| coverageThreshold: { | ||
| global: { | ||
| branches: 100, | ||
| functions: 100, | ||
| lines: 100, | ||
| statements: 100, | ||
| }, | ||
| }, | ||
| }); |
This file contains 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,70 @@ | ||||||
| { | ||||||
| "name": "@metamask/remote-feature-flag-controller", | ||||||
| "version": "0.0.1", | ||||||
|
There was a problem hiding this comment. New packages start out at 0.0.0. We will assign a new version when we release the package:
Suggested change
|
||||||
| "private": true, | ||||||
| "description": "Controller with caching, fallback, and privacy for managing feature flags via ClientConfigAPI", | ||||||
| "keywords": [ | ||||||
| "MetaMask", | ||||||
| "Ethereum" | ||||||
| ], | ||||||
| "homepage": "https://github.com/MetaMask/core/tree/main/packages/remote-feature-flag-controller#readme", | ||||||
| "bugs": { | ||||||
| "url": "https://github.com/MetaMask/core/issues" | ||||||
| }, | ||||||
| "repository": { | ||||||
| "type": "git", | ||||||
| "url": "https://github.com/MetaMask/core.git" | ||||||
| }, | ||||||
| "license": "MIT", | ||||||
| "sideEffects": false, | ||||||
| "exports": { | ||||||
| ".": { | ||||||
| "import": { | ||||||
| "types": "./dist/index.d.mts", | ||||||
| "default": "./dist/index.mjs" | ||||||
| }, | ||||||
| "require": { | ||||||
| "types": "./dist/index.d.cts", | ||||||
| "default": "./dist/index.cjs" | ||||||
| } | ||||||
| }, | ||||||
| "./package.json": "./package.json" | ||||||
| }, | ||||||
| "main": "./dist/index.cjs", | ||||||
| "types": "./dist/index.d.cts", | ||||||
| "files": [ | ||||||
| "dist/" | ||||||
| ], | ||||||
| "scripts": { | ||||||
| "build": "ts-bridge --project tsconfig.build.json --verbose --clean --no-references", | ||||||
| "build:docs": "typedoc", | ||||||
| "changelog:update": "../../scripts/update-changelog.sh @metamask/remote-feature-flag-controllers", | ||||||
| "changelog:validate": "../../scripts/validate-changelog.sh @metamask/remote-feature-flag-controllers", | ||||||
| "since-latest-release": "../../scripts/since-latest-release.sh", | ||||||
| "test": "NODE_OPTIONS=--experimental-vm-modules jest --reporters=jest-silent-reporter", | ||||||
| "test:clean": "NODE_OPTIONS=--experimental-vm-modules jest --clearCache", | ||||||
| "test:verbose": "NODE_OPTIONS=--experimental-vm-modules jest --verbose", | ||||||
| "test:watch": "NODE_OPTIONS=--experimental-vm-modules jest --watch" | ||||||
| }, | ||||||
| "dependencies": { | ||||||
| "@metamask/base-controller": "^7.0.2", | ||||||
| "@metamask/utils": "^10.0.0", | ||||||
| "cockatiel": "^3.1.2" | ||||||
| }, | ||||||
| "devDependencies": { | ||||||
| "@lavamoat/allow-scripts": "^3.0.4", | ||||||
| "@metamask/auto-changelog": "^3.4.4", | ||||||
| "@metamask/controller-utils": "^11.4.3", | ||||||
| "@types/jest": "^27.4.1", | ||||||
| "deepmerge": "^4.2.2", | ||||||
| "jest": "^27.5.1", | ||||||
| "nock": "^13.3.1", | ||||||
| "ts-jest": "^27.1.4", | ||||||
| "typedoc": "^0.24.8", | ||||||
| "typedoc-plugin-missing-exports": "^2.0.0", | ||||||
| "typescript": "~5.2.2" | ||||||
| }, | ||||||
| "engines": { | ||||||
| "node": "^18.18 || >=20" | ||||||
| } | ||||||
| } | ||||||
This file contains 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,9 @@ | ||
| import type { PublicInterface } from '@metamask/utils'; | ||
|
|
||
| import type { ClientConfigApiService } from './client-config-api-service'; | ||
|
|
||
| /** | ||
| * A service object responsible for fetching feature flags. | ||
| */ | ||
| export type AbstractClientConfigApiService = | ||
| PublicInterface<ClientConfigApiService>; |
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would you mind re-running
yarn update-readme-content? I would expect to seeprofile_sync_controller --> base_controller;but I do not see it here.