Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Use "options bag" for BaseControllerV2 constructor #388

Merged
merged 2 commits into from
Mar 15, 2021
Merged

Use "options bag" for BaseControllerV2 constructor #388

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9bc3d11
Use "options bag" for BaseControllerV2 constructor
Gudahtt Mar 12, 2021
8b58823
Merge branch 'develop' into use-options-bag-for-base-controller-v2-co…
Gudahtt Mar 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
139 changes: 72 additions & 67 deletions src/BaseControllerV2.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,36 +33,36 @@ class MockController extends BaseController<'CountController', CountControllerSt
describe('BaseController', () => {
it('should set initial state', () => {
const controllerMessenger = new ControllerMessenger<never, CountControllerEvent>();
const controller = new MockController(
controllerMessenger,
'CountController',
{ count: 0 },
CountControllerStateMetadata,
);
const controller = new MockController({
messenger: controllerMessenger,
name: 'CountController',
state: { count: 0 },
metadata: CountControllerStateMetadata,
});

expect(controller.state).toEqual({ count: 0 });
});

it('should set initial schema', () => {
const controllerMessenger = new ControllerMessenger<never, CountControllerEvent>();
const controller = new MockController(
controllerMessenger,
'CountController',
{ count: 0 },
CountControllerStateMetadata,
);
const controller = new MockController({
messenger: controllerMessenger,
name: 'CountController',
state: { count: 0 },
metadata: CountControllerStateMetadata,
});

expect(controller.metadata).toEqual(CountControllerStateMetadata);
});

it('should not allow mutating state directly', () => {
const controllerMessenger = new ControllerMessenger<never, CountControllerEvent>();
const controller = new MockController(
controllerMessenger,
'CountController',
{ count: 0 },
CountControllerStateMetadata,
);
const controller = new MockController({
messenger: controllerMessenger,
name: 'CountController',
state: { count: 0 },
metadata: CountControllerStateMetadata,
});

expect(() => {
controller.state = { count: 1 };
Expand All @@ -71,12 +71,12 @@ describe('BaseController', () => {

it('should allow updating state by modifying draft', () => {
const controllerMessenger = new ControllerMessenger<never, CountControllerEvent>();
const controller = new MockController(
controllerMessenger,
'CountController',
{ count: 0 },
CountControllerStateMetadata,
);
const controller = new MockController({
messenger: controllerMessenger,
name: 'CountController',
state: { count: 0 },
metadata: CountControllerStateMetadata,
});

controller.update((draft) => {
draft.count += 1;
Expand All @@ -87,12 +87,12 @@ describe('BaseController', () => {

it('should allow updating state by return a value', () => {
const controllerMessenger = new ControllerMessenger<never, CountControllerEvent>();
const controller = new MockController(
controllerMessenger,
'CountController',
{ count: 0 },
CountControllerStateMetadata,
);
const controller = new MockController({
messenger: controllerMessenger,
name: 'CountController',
state: { count: 0 },
metadata: CountControllerStateMetadata,
});

controller.update(() => {
return { count: 1 };
Expand All @@ -103,12 +103,12 @@ describe('BaseController', () => {

it('should throw an error if update callback modifies draft and returns value', () => {
const controllerMessenger = new ControllerMessenger<never, CountControllerEvent>();
const controller = new MockController(
controllerMessenger,
'CountController',
{ count: 0 },
CountControllerStateMetadata,
);
const controller = new MockController({
messenger: controllerMessenger,
name: 'CountController',
state: { count: 0 },
metadata: CountControllerStateMetadata,
});

expect(() => {
controller.update((draft) => {
Expand All @@ -120,12 +120,12 @@ describe('BaseController', () => {

it('should inform subscribers of state changes', () => {
const controllerMessenger = new ControllerMessenger<never, CountControllerEvent>();
const controller = new MockController(
controllerMessenger,
'CountController',
{ count: 0 },
CountControllerStateMetadata,
);
const controller = new MockController({
messenger: controllerMessenger,
name: 'CountController',
state: { count: 0 },
metadata: CountControllerStateMetadata,
});
const listener1 = sinon.stub();
const listener2 = sinon.stub();

Expand All @@ -143,12 +143,12 @@ describe('BaseController', () => {

it('should inform a subscriber of each state change once even after multiple subscriptions', () => {
const controllerMessenger = new ControllerMessenger<never, CountControllerEvent>();
const controller = new MockController(
controllerMessenger,
'CountController',
{ count: 0 },
CountControllerStateMetadata,
);
const controller = new MockController({
messenger: controllerMessenger,
name: 'CountController',
state: { count: 0 },
metadata: CountControllerStateMetadata,
});
const listener1 = sinon.stub();

controllerMessenger.subscribe('CountController:stateChange', listener1);
Expand All @@ -164,12 +164,12 @@ describe('BaseController', () => {

it('should no longer inform a subscriber about state changes after unsubscribing', () => {
const controllerMessenger = new ControllerMessenger<never, CountControllerEvent>();
const controller = new MockController(
controllerMessenger,
'CountController',
{ count: 0 },
CountControllerStateMetadata,
);
const controller = new MockController({
messenger: controllerMessenger,
name: 'CountController',
state: { count: 0 },
metadata: CountControllerStateMetadata,
});
const listener1 = sinon.stub();

controllerMessenger.subscribe('CountController:stateChange', listener1);
Expand All @@ -183,12 +183,12 @@ describe('BaseController', () => {

it('should no longer inform a subscriber about state changes after unsubscribing once, even if they subscribed many times', () => {
const controllerMessenger = new ControllerMessenger<never, CountControllerEvent>();
const controller = new MockController(
controllerMessenger,
'CountController',
{ count: 0 },
CountControllerStateMetadata,
);
const controller = new MockController({
messenger: controllerMessenger,
name: 'CountController',
state: { count: 0 },
metadata: CountControllerStateMetadata,
});
const listener1 = sinon.stub();

controllerMessenger.subscribe('CountController:stateChange', listener1);
Expand All @@ -203,7 +203,12 @@ describe('BaseController', () => {

it('should throw when unsubscribing listener who was never subscribed', () => {
const controllerMessenger = new ControllerMessenger<never, CountControllerEvent>();
new MockController(controllerMessenger, 'CountController', { count: 0 }, CountControllerStateMetadata);
new MockController({
messenger: controllerMessenger,
name: 'CountController',
state: { count: 0 },
metadata: CountControllerStateMetadata,
});
const listener1 = sinon.stub();

expect(() => {
Expand All @@ -213,12 +218,12 @@ describe('BaseController', () => {

it('should no longer update subscribers after being destroyed', () => {
const controllerMessenger = new ControllerMessenger<never, CountControllerEvent>();
const controller = new MockController(
controllerMessenger,
'CountController',
{ count: 0 },
CountControllerStateMetadata,
);
const controller = new MockController({
messenger: controllerMessenger,
name: 'CountController',
state: { count: 0 },
metadata: CountControllerStateMetadata,
});
const listener1 = sinon.stub();
const listener2 = sinon.stub();

Expand Down
29 changes: 18 additions & 11 deletions src/BaseControllerV2.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,18 +110,25 @@ export class BaseController<N extends string, S extends Record<string, unknown>>
/**
* Creates a BaseController instance.
*
* @param messagingSystem - Controller messaging system
* @param state - Initial controller state
* @param metadata - State metadata, describing how to "anonymize" the state,
* and which parts should be persisted.
* @param options
* @param options.messenger - Controller messaging system
* @param options.metadata - State metadata, describing how to "anonymize" the state, and which
* parts should be persisted.
* @param options.name - The name of the controller, used as a namespace for events and actions
* @param options.state - Initial controller state
*/
constructor(
messagingSystem: ControllerMessenger<never, { type: `${N}:stateChange`; payload: [S, Patch[]] }>,
name: N,
state: IsJsonable<S>,
metadata: StateMetadata<S>,
) {
this.messagingSystem = messagingSystem;
constructor({
messenger,
metadata,
name,
state,
}: {
messenger: ControllerMessenger<never, { type: `${N}:stateChange`; payload: [S, Patch[]] }>;
metadata: StateMetadata<S>;
name: N;
state: IsJsonable<S>;
}) {
this.messagingSystem = messenger;
this.name = name;
this.internalState = state;
this.metadata = metadata;
Expand Down