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

fix(plugins-runtime): remove plugin event listener on close #117

Merged
merged 1 commit into from
Jul 23, 2024
Merged

fix(plugins-runtime): remove plugin event listener on close #117

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 7 additions & 0 deletions libs/plugins-runtime/src/lib/api/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,13 @@ export function createApi(context: PenpotContext, manifest: Manifest): Penpot {
let modal: PluginModalElement | null = null;

const closePlugin = () => {
// remove all event listeners
Object.entries(listeners).forEach(([, map]) => {
map.forEach((id) => {
context.removeListener(id);
});
});

if (modal) {
modals.delete(modal);

Expand Down
11 changes: 10 additions & 1 deletion libs/plugins-runtime/src/lib/api/plugin-api.spec.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,6 +129,15 @@ describe('Plugin api', () => {
expect(mockContext.removeListener).toHaveBeenCalled();
expect((mockContext.removeListener.mock as any).lastCall[0]).toBe(id);
});

it('remove event on close plugin', () => {
const callback = vi.fn();

api.on('pagechange', callback);
api.closePlugin();

expect(mockContext.removeListener).toHaveBeenCalled();
});
});

describe.concurrent('permissions', () => {
Expand Down Expand Up @@ -227,7 +236,7 @@ describe('Plugin api', () => {
expect(modalMock.setTheme).toHaveBeenCalledWith('dark');
});

it('close puglin', () => {
it('close plugin', () => {
const name = 'test';
const url = 'http://fake.com';
const options = { width: 100, height: 100 };
Expand Down
16 changes: 10 additions & 6 deletions libs/plugins-runtime/src/lib/load-plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,14 @@ export function setContextBuilder(builder: ContextBuilder) {

export const ɵloadPlugin = async function (manifest: Manifest) {
try {
const closeAllPlugins = () => {
createdApis.forEach((pluginApi) => {
pluginApi.closePlugin();
});

createdApis = [];
};

const context = contextBuilder && contextBuilder(manifest.pluginId);

if (!context) {
Expand All @@ -35,9 +43,7 @@ export const ɵloadPlugin = async function (manifest: Manifest) {
}

if (createdApis && !multiPlugin) {
createdApis.forEach((pluginApi) => {
pluginApi.closePlugin();
});
closeAllPlugins();
}

const pluginApi = createApi(context, manifest);
Expand Down Expand Up @@ -70,9 +76,7 @@ export const ɵloadPlugin = async function (manifest: Manifest) {
c.evaluate(code);

const listenerId: symbol = context.addListener('finish', () => {
createdApis.forEach((pluginApi) => {
pluginApi.closePlugin();
});
closeAllPlugins();

context?.removeListener(listenerId);
});
Expand Down