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

Add closeHintByUser event #157

Merged
merged 3 commits into from
Feb 26, 2025
Merged

Add closeHintByUser event #157

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
a4c3974
test(onboarding): add tests for closeHint event subscription
vanilla-wave Feb 25, 2025
bdc97e4
feat(onboarding): add closeHintByUser event
vanilla-wave Feb 25, 2025
486a4ee
refactor(onboarding): refactor beforeShowHint event tests
vanilla-wave Feb 25, 2025
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
4 changes: 4 additions & 0 deletions src/controller.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -336,6 +336,10 @@ export class Controller<HintParams, Presets extends string, Steps extends string
step?.hooks?.onCloseHint?.();
}

if (this.hintStore.state.hint) {
this.events.emit('closeHintByUser', {hint: this.hintStore.state.hint});
}

this.hintStore.closeHint();
this.checkReachedHints();
};
Expand Down
284 changes: 254 additions & 30 deletions src/tests/event-hooks.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,50 +221,68 @@ describe('preset hooks', function () {
});
});
describe('event subscriptions', function () {
it('beforeShowHint', async function () {
const controller = new Controller(getOptions());
describe('beforeShowHint', () => {
it('element reached -> trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('beforeShowHint', mock);
const mock = jest.fn();
controller.events.subscribe('beforeShowHint', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});

expect(mock).toHaveBeenCalled();
});

expect(mock).toHaveBeenCalled();
});
it('element reached -> hint shown', async function () {
const controller = new Controller(getOptions());

it('beforeShowHint with cancel -> no hint', async function () {
const controller = new Controller(getOptions());
const mock = jest.fn();
controller.events.subscribe('beforeShowHint', mock);

const mock = jest.fn(() => false);
controller.events.subscribe('beforeShowHint', mock);
await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
expect(controller.hintStore.state.open).toBe(true);
});

expect(controller.hintStore.state.open).toBe(false);
});
it('cancel hint show -> hint still not open', async function () {
const controller = new Controller(getOptions());

it('beforeShowHint with cancel -> call all hooks', async function () {
const controller = new Controller(getOptions());

const mock1 = jest.fn(() => false);
const mock2 = jest.fn();
// return false to cancel hint show
const mock = jest.fn(() => false);
controller.events.subscribe('beforeShowHint', mock);

controller.events.subscribe('beforeShowHint', mock1);
controller.events.subscribe('beforeShowHint', mock2);
await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
expect(controller.hintStore.state.open).toBe(false);
});

expect(mock1).toHaveBeenCalled();
expect(mock2).toHaveBeenCalled();
it('cancel hint show -> call all hooks', async function () {
const controller = new Controller(getOptions());

// return false to cancel hint show
const mock1 = jest.fn(() => false);
const mock2 = jest.fn();

controller.events.subscribe('beforeShowHint', mock1);
controller.events.subscribe('beforeShowHint', mock2);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});

expect(mock1).toHaveBeenCalled();
expect(mock2).toHaveBeenCalled();
});
});

it('showHint', async function () {
Expand All @@ -287,6 +305,212 @@ describe('event subscriptions', function () {
);
});

describe('closeHint event', () => {
it('pass step -> trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHint', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
await controller.passStep('createSprint');

expect(mock).toHaveBeenCalledWith(
{
hint: {
preset: 'createProject',
step: {
slug: 'createSprint',
name: '',
description: '',
},
},
},
controller,
);
});

it('element disappeared -> trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHint', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
controller.stepElementDisappeared('createSprint');

expect(mock).toHaveBeenCalledWith(
{
hint: {
preset: 'createProject',
step: {
slug: 'createSprint',
name: '',
description: '',
},
},
},
controller,
);
});

it('user close hint -> trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHint', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
controller.closeHint('createSprint');

expect(mock).toHaveBeenCalledWith(
{
hint: {
preset: 'createProject',
step: {
slug: 'createSprint',
name: '',
description: '',
},
},
},
controller,
);
});

it('no open hint -> NOT trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHint', mock);

controller.closeHint();

expect(mock).not.toHaveBeenCalled();
});

it('try close other hint -> NOT trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHint', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
controller.closeHint('openBoard');

expect(mock).not.toHaveBeenCalled();
});
});

describe('closeHintByUser event', () => {
it('pass step -> trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHintByUser', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
await controller.passStep('createSprint');

expect(mock).toHaveBeenCalledWith(
{
hint: {
preset: 'createProject',
step: {
slug: 'createSprint',
name: '',
description: '',
},
},
},
controller,
);
});

it('element disappeared -> NOT trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHintByUser', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
controller.stepElementDisappeared('createSprint');

expect(mock).not.toHaveBeenCalled();
});

it('user close hint -> trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHintByUser', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
controller.closeHintByUser('createSprint');

expect(mock).toHaveBeenCalledWith(
{
hint: {
preset: 'createProject',
step: {
slug: 'createSprint',
name: '',
description: '',
},
},
},
controller,
);
});

it('no open hint -> NOT trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHintByUser', mock);

controller.closeHintByUser();

expect(mock).not.toHaveBeenCalled();
});

it('try close other hint -> NOT trigger event', async function () {
const controller = new Controller(getOptions());

const mock = jest.fn();
controller.events.subscribe('closeHintByUser', mock);

await controller.stepElementReached({
stepSlug: 'createSprint',
element: getAnchorElement(),
});
controller.closeHintByUser('openBoard');

expect(mock).not.toHaveBeenCalled();
});
});

it('passStep', async function () {
const controller = new Controller(getOptions());

Expand Down
1 change: 1 addition & 0 deletions src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,6 +183,7 @@ export type EventsMap<
stateChange: {state: Controller<any, any, any>['state']};
hintDataChanged: {state: HintState<HintParams, Presets, Steps>};
closeHint: {hint: Pick<ShowHintParams<HintParams, Presets, Steps>, 'preset' | 'step'>};
closeHintByUser: {hint: Pick<ShowHintParams<HintParams, Presets, Steps>, 'preset' | 'step'>};
init: {};
wizardStateChanged: {wizardState: BaseState['wizardState']};
};
Expand Down