import * as React from 'react'; import RepositoryApi from '@joplin/lib/services/plugins/RepositoryApi'; import { createTempDir, mockMobilePlatform, setupDatabaseAndSynchronizer, supportDir, switchClient } from '@joplin/lib/testing/test-utils'; import { act, render, screen } from '@testing-library/react-native'; import '@testing-library/react-native/extend-expect'; import Setting from '@joplin/lib/models/Setting'; import PluginService, { PluginSettings, defaultPluginSetting } from '@joplin/lib/services/plugins/PluginService'; import { useCallback, useState } from 'react'; import pluginServiceSetup from './testUtils/pluginServiceSetup'; import PluginStates from './PluginStates'; import configScreenStyles from '../configScreenStyles'; import { remove, writeFile } from 'fs-extra'; import { join } from 'path'; import shim from '@joplin/lib/shim'; import { resetRepoApi } from './utils/useRepoApi'; import { Store } from 'redux'; import { AppState } from '../../../../utils/types'; import createMockReduxStore from '../../../../utils/testing/createMockReduxStore'; interface WrapperProps { initialPluginSettings: PluginSettings; } let reduxStore: Store = null; const shouldShowBasedOnSettingSearchQuery = ()=>true; const PluginStatesWrapper = (props: WrapperProps) => { const styles = configScreenStyles(Setting.THEME_LIGHT); const [pluginSettings, setPluginSettings] = useState(() => { return props.initialPluginSettings ?? {}; }); const updatePluginStates = useCallback((newStates: PluginSettings) => { setPluginSettings(newStates); }, []); return ( ); }; let repoTempDir: string|null = null; const mockRepositoryApiConstructor = async () => { if (repoTempDir) { await remove(repoTempDir); } repoTempDir = await createTempDir(); RepositoryApi.ofDefaultJoplinRepo = jest.fn((_tempDirPath: string, appType, installMode) => { return new RepositoryApi(`${supportDir}/pluginRepo`, repoTempDir, appType, installMode); }); }; const loadMockPlugin = async (id: string, name: string, version: string, pluginSettings: PluginSettings) => { const service = PluginService.instance(); const pluginSource = ` /* joplin-manifest: ${JSON.stringify({ id, manifest_version: 1, app_min_version: '1.4', name, description: 'Test plugin', platforms: ['mobile', 'desktop'], version, homepage_url: 'https://joplinapp.org', })} */ joplin.plugins.register({ onStart: async function() { }, }); `; const pluginPath = join(await createTempDir(), 'plugin.js'); await writeFile(pluginPath, pluginSource, 'utf-8'); await act(async () => { await service.loadAndRunPlugins([pluginPath], pluginSettings); }); }; describe('PluginStates', () => { beforeEach(async () => { await setupDatabaseAndSynchronizer(0); await switchClient(0); reduxStore = createMockReduxStore(); pluginServiceSetup(reduxStore); resetRepoApi(); await mockMobilePlatform('android'); await mockRepositoryApiConstructor(); }); afterEach(async () => { for (const pluginId of PluginService.instance().pluginIds) { await act(() => PluginService.instance().unloadPlugin(pluginId)); } }); it.each([ 'android', 'ios', ])('should not allow updating a plugin that is not recommended on iOS, but should on Android (on %s)', async (platform) => { await mockMobilePlatform(platform); expect(shim.mobilePlatform()).toBe(platform); await mockRepositoryApiConstructor(); const abcPluginId = 'org.joplinapp.plugins.AbcSheetMusic'; const backlinksPluginId = 'joplin.plugin.ambrt.backlinksToNote'; const defaultPluginSettings: PluginSettings = { [abcPluginId]: defaultPluginSetting(), [backlinksPluginId]: defaultPluginSetting(), }; // Load an outdated recommended plugin await loadMockPlugin(abcPluginId, 'ABC Sheet Music', '0.0.1', defaultPluginSettings); expect(PluginService.instance().plugins[abcPluginId]).toBeTruthy(); // Load a plugin not marked as recommended await loadMockPlugin(backlinksPluginId, 'Backlinks to note', '0.0.1', defaultPluginSettings); expect(PluginService.instance().plugins[backlinksPluginId]).toBeTruthy(); render( , ); expect(await screen.findByText(/^ABC Sheet Music/)).toBeVisible(); expect(await screen.findByText(/^Backlinks to note/)).toBeVisible(); expect(await screen.findByRole('button', { name: 'Update ABC Sheet Music', disabled: false })).toBeVisible(); // Backlinks to note should not be updatable on iOS (it's not _recommended). const backlinksToNoteQuery = { name: 'Update Backlinks to note', disabled: false }; if (platform === 'android') { expect(await screen.findByRole('button', backlinksToNoteQuery)).toBeVisible(); } else { expect(await screen.queryByRole('button', backlinksToNoteQuery)).toBeNull(); } }); it('should show the current plugin version on updatable plugins', async () => { const abcPluginId = 'org.joplinapp.plugins.AbcSheetMusic'; const defaultPluginSettings: PluginSettings = { [abcPluginId]: defaultPluginSetting() }; const outdatedVersion = '0.0.1'; await loadMockPlugin(abcPluginId, 'ABC Sheet Music', outdatedVersion, defaultPluginSettings); expect(PluginService.instance().plugins[abcPluginId]).toBeTruthy(); render( , ); expect(await screen.findByText(/^ABC Sheet Music/)).toBeVisible(); expect(await screen.findByRole('button', { name: 'Update ABC Sheet Music', disabled: false })).toBeVisible(); expect(await screen.findByText(`v${outdatedVersion}`)).toBeVisible(); }); it('should update the list of installed plugins when a plugin is installed and uninstalled', async () => { const pluginSettings: PluginSettings = { }; render( , ); // Initially, no plugins should be visible. expect(screen.queryByText(/^ABC Sheet Music/)).toBeNull(); const testPluginId1 = 'org.joplinapp.plugins.AbcSheetMusic'; const testPluginId2 = 'org.joplinapp.plugins.test.plugin.id'; await act(() => loadMockPlugin(testPluginId1, 'ABC Sheet Music', '1.2.3', pluginSettings)); await act(() => loadMockPlugin(testPluginId2, 'A test plugin', '1.0.0', pluginSettings)); expect(PluginService.instance().plugins[testPluginId1]).toBeTruthy(); // Should update the list of installed plugins even though the plugin settings didn't change. expect(await screen.findByText(/^ABC Sheet Music/)).toBeVisible(); expect(await screen.findByText(/^A test plugin/)).toBeVisible(); // Uninstalling one plugin should keep the other in the list await act(() => PluginService.instance().uninstallPlugin(testPluginId1)); expect(await screen.findByText(/^A test plugin/)).toBeVisible(); expect(screen.queryByText(/^ABC Sheet Music/)).toBeNull(); }); });