Skip to content

Commit

Permalink
stash
Browse files Browse the repository at this point in the history
  • Loading branch information
@MajorLift
MajorLift committed Apr 23, 2024
1 parent 37137b6 commit 5f59bf9
Show file tree
Hide file tree
Showing 2 changed files with 204 additions and 111 deletions.
187 changes: 138 additions & 49 deletions packages/composable-controller/src/ComposableController.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -151,9 +151,13 @@ describe('ComposableController', () => {

describe('BaseControllerV1', () => {
it('should compose controller state', () => {
type ComposableControllerState = {
BarController: BarControllerState;
BazController: BazControllerState;
};
const composableMessenger = new ControllerMessenger<
never,
ComposableControllerEvents
ComposableControllerEvents<ComposableControllerState>
>().getRestricted({
name: 'ComposableController',
allowedActions: [],
Expand All @@ -171,9 +175,12 @@ describe('ComposableController', () => {
});

it('should notify listeners of nested state change', () => {
type ComposableControllerState = {
BarController: BarControllerState;
};
const controllerMessenger = new ControllerMessenger<
never,
ComposableControllerEvents
ComposableControllerEvents<ComposableControllerState>
>();
const composableMessenger = controllerMessenger.getRestricted({
name: 'ComposableController',
Expand Down Expand Up @@ -203,9 +210,15 @@ describe('ComposableController', () => {

describe('BaseControllerV2', () => {
it('should compose controller state', () => {
type ComposableControllerState = {
FooController: FooControllerState;
QuzController: QuzControllerState;
};
const controllerMessenger = new ControllerMessenger<
never,
FooControllerEvent | QuzControllerEvent
| ComposableControllerEvents<ComposableControllerState>
| FooControllerEvent
| QuzControllerEvent
>();
const fooMessenger = controllerMessenger.getRestricted<
'FooController',
Expand All @@ -224,49 +237,46 @@ describe('ComposableController', () => {
const fooController = new FooController(fooMessenger);
const quzController = new QuzController(quzMessenger);

const composableControllerMessenger = controllerMessenger.getRestricted<
'ComposableController',
never,
(FooControllerEvent | QuzControllerEvent)['type']
>({
const composableControllerMessenger = controllerMessenger.getRestricted({
name: 'ComposableController',
allowedActions: [],
allowedEvents: [
'FooController:stateChange',
'QuzController:stateChange',
],
});
const composableController = new ComposableController({
controllers: [fooController, quzController],
messenger: composableControllerMessenger,
});
const composableController =
new ComposableController<ComposableControllerState>({
controllers: [fooController, quzController],
messenger: composableControllerMessenger,
});
expect(composableController.state).toStrictEqual({
FooController: { foo: 'foo' },
QuzController: { quz: 'quz' },
});
});

it('should notify listeners of nested state change', () => {
type ComposableControllerState = {
FooController: FooControllerState;
};
const controllerMessenger = new ControllerMessenger<
never,
ComposableControllerEvents | FooControllerEvent
| ComposableControllerEvents<ComposableControllerState>
| FooControllerEvent
>();
const fooControllerMessenger = controllerMessenger.getRestricted({
name: 'FooController',
allowedActions: [],
allowedEvents: [],
});
const fooController = new FooController(fooControllerMessenger);
const composableControllerMessenger = controllerMessenger.getRestricted<
'ComposableController',
never,
FooControllerEvent['type']
>({
const composableControllerMessenger = controllerMessenger.getRestricted({
name: 'ComposableController',
allowedActions: [],
allowedEvents: ['FooController:stateChange'],
});
new ComposableController({
new ComposableController<ComposableControllerState>({
controllers: [fooController],
messenger: composableControllerMessenger,
});
Expand All @@ -289,58 +299,61 @@ describe('ComposableController', () => {

describe('Mixed BaseControllerV1 and BaseControllerV2', () => {
it('should compose controller state', () => {
type ComposableControllerState = {
BarController: BarControllerState;
FooController: FooControllerState;
};
const barController = new BarController();
const controllerMessenger = new ControllerMessenger<
never,
FooControllerEvent
| ComposableControllerEvents<ComposableControllerState>
| FooControllerEvent
>();
const fooControllerMessenger = controllerMessenger.getRestricted({
name: 'FooController',
allowedActions: [],
allowedEvents: [],
});
const fooController = new FooController(fooControllerMessenger);
const composableControllerMessenger = controllerMessenger.getRestricted<
'ComposableController',
never,
FooControllerEvent['type']
>({
const composableControllerMessenger = controllerMessenger.getRestricted({
name: 'ComposableController',
allowedActions: [],
allowedEvents: ['FooController:stateChange'],
});
const composableController = new ComposableController({
controllers: [barController, fooController],
messenger: composableControllerMessenger,
});
const composableController =
new ComposableController<ComposableControllerState>({
controllers: [barController, fooController],
messenger: composableControllerMessenger,
});
expect(composableController.state).toStrictEqual({
BarController: { bar: 'bar' },
FooController: { foo: 'foo' },
});
});

it('should notify listeners of BaseControllerV1 state change', () => {
type ComposableControllerState = {
BarController: BarControllerState;
FooController: FooControllerState;
};
const barController = new BarController();
const controllerMessenger = new ControllerMessenger<
never,
ComposableControllerEvents | FooControllerEvent
| ComposableControllerEvents<ComposableControllerState>
| FooControllerEvent
>();
const fooControllerMessenger = controllerMessenger.getRestricted({
name: 'FooController',
allowedActions: [],
allowedEvents: [],
});
const fooController = new FooController(fooControllerMessenger);
const composableControllerMessenger = controllerMessenger.getRestricted<
'ComposableController',
never,
FooControllerEvent['type']
>({
const composableControllerMessenger = controllerMessenger.getRestricted({
name: 'ComposableController',
allowedActions: [],
allowedEvents: ['FooController:stateChange'],
});
new ComposableController({
new ComposableController<ComposableControllerState>({
controllers: [barController, fooController],
messenger: composableControllerMessenger,
});
Expand All @@ -363,27 +376,28 @@ describe('ComposableController', () => {
});

it('should notify listeners of BaseControllerV2 state change', () => {
type ComposableControllerState = {
BarController: BarControllerState;
FooController: FooControllerState;
};
const barController = new BarController();
const controllerMessenger = new ControllerMessenger<
never,
ComposableControllerEvents | FooControllerEvent
| ComposableControllerEvents<ComposableControllerState>
| FooControllerEvent
>();
const fooControllerMessenger = controllerMessenger.getRestricted({
name: 'FooController',
allowedActions: [],
allowedEvents: [],
});
const fooController = new FooController(fooControllerMessenger);
const composableControllerMessenger = controllerMessenger.getRestricted<
'ComposableController',
never,
FooControllerEvent['type']
>({
const composableControllerMessenger = controllerMessenger.getRestricted({
name: 'ComposableController',
allowedActions: [],
allowedEvents: ['FooController:stateChange'],
});
new ComposableController({
new ComposableController<ComposableControllerState>({
controllers: [barController, fooController],
messenger: composableControllerMessenger,
});
Expand Down Expand Up @@ -428,22 +442,22 @@ describe('ComposableController', () => {
});

it('should throw if composing a controller that does not extend from BaseController', () => {
type ComposableControllerState = {
FooController: FooControllerState;
};
const notController = new JsonRpcEngine();
const controllerMessenger = new ControllerMessenger<
never,
FooControllerEvent
| ComposableControllerEvents<ComposableControllerState>
| FooControllerEvent
>();
const fooControllerMessenger = controllerMessenger.getRestricted({
name: 'FooController',
allowedActions: [],
allowedEvents: [],
});
const fooController = new FooController(fooControllerMessenger);
const composableControllerMessenger = controllerMessenger.getRestricted<
'ComposableController',
never,
FooControllerEvent['type']
>({
const composableControllerMessenger = controllerMessenger.getRestricted({
name: 'ComposableController',
allowedActions: [],
allowedEvents: ['FooController:stateChange'],
Expand All @@ -460,4 +474,79 @@ describe('ComposableController', () => {
);
});
});

let barController: BaseControllerV1<never, BarControllerState>;
let fooController: BaseController<
'FooController',
FooControllerState,
FooMessenger
>;
type ComposableControllerState = {
BarController: BarControllerState;
FooController: FooControllerState;
};
let controllerMessenger: ControllerMessenger<
never,
ComposableControllerEvents<ComposableControllerState> | FooControllerEvent
>;
beforeEach(() => {
barController = new BarController();
controllerMessenger = new ControllerMessenger();
const fooControllerMessenger = controllerMessenger.getRestricted({
name: 'FooController',
allowedActions: [],
allowedEvents: [],
});
fooController = new FooController(fooControllerMessenger);
});
describe('messenger and child controllers type validation', () => {
it('should raise a type error if the provided controller messenger does not allow one or more required events', () => {
const composableControllerMessenger = controllerMessenger.getRestricted({
name: 'ComposableController',
allowedActions: [],
allowedEvents: [],
});
new ComposableController<ComposableControllerState>({
controllers: [barController, fooController],
messenger: composableControllerMessenger,
});
});
});

it('should raise a type error if the provided controller messenger allows events that should not be allowed', () => {
const composableControllerMessenger = controllerMessenger.getRestricted({
name: 'ComposableController',
allowedActions: [],
allowedEvents: ['FooController:stateChange', 'BazController:stateChange'],
});
new ComposableController<ComposableControllerState>({
controllers: [barController, fooController],
messenger: composableControllerMessenger,
});
});

it('should raise a type error if the provided controllers array contains a controller that is not included in `ComposableControllerState`', () => {
const composableControllerMessenger = controllerMessenger.getRestricted({
name: 'ComposableController',
allowedActions: [],
allowedEvents: ['FooController:stateChange'],
});
const bazController = new BazController();
new ComposableController<ComposableControllerState>({
controllers: [barController, fooController, bazController],
messenger: composableControllerMessenger,
});
});

it('should raise a type error if the provided controllers array does not contain a controller that is included in `ComposableControllerState`', () => {
const composableControllerMessenger = controllerMessenger.getRestricted({
name: 'ComposableController',
allowedActions: [],
allowedEvents: ['FooController:stateChange'],
});
new ComposableController<ComposableControllerState>({
controllers: [barController],
messenger: composableControllerMessenger,
});
});
});
Loading

0 comments on commit 5f59bf9

Please sign in to comment.