@kinvolk/headlamp-plugin/lib/plugin/Plugins.js

The needed infrastructure for building Headlamp plugins.

import { jsx as _jsx, Fragment as _Fragment } from "react/jsx-runtime";
/*
 * Copyright 2025 The Kubernetes Authors
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
import Button from '@mui/material/Button';
import { useSnackbar } from 'notistack';
import { useEffect } from 'react';
import { useTranslation } from 'react-i18next';
import { useDispatch } from 'react-redux';
import { useHistory } from 'react-router-dom';
import { isElectron } from '../helpers/isElectron';
import { useTypedSelector } from '../redux/reducers/reducers';
import { fetchAndExecutePlugins } from './index';
import { pluginsLoaded, setPluginSettings } from './pluginsSlice';
/**
 * For discovering and executing plugins.
 *
 * Compared to loading plugins in script tags, doing it this way has some benefits:
 *
 * 1) We can more easily catch certain types of errors in execution. With a
 *   script tag we can not catch errors in the running scripts.
 * 2) We can load the scripts into a context other than global/window. This
 *   means that plugins do not pollute the global namespace.
 */
export default function Plugins() {
    const dispatch = useDispatch();
    const { closeSnackbar, enqueueSnackbar } = useSnackbar();
    const history = useHistory();
    const { t } = useTranslation();
    const settingsPlugins = useTypedSelector(state => state.plugins.pluginSettings);
    // only run on first load
    useEffect(() => {
        fetchAndExecutePlugins(settingsPlugins, updatedSettingsPackages => {
            dispatch(setPluginSettings(updatedSettingsPackages));
        }, incompatiblePlugins => {
            const pluginList = Object.values(incompatiblePlugins)
                .map(p => p.name)
                .join(', ');
            const message = t('translation|Warning. Incompatible plugins disabled: ({{ pluginList }})', { pluginList });
            console.warn(message);
            if (isElectron()) {
                enqueueSnackbar(message, {
                    action: (snackbarId) => (_jsx(_Fragment, { children: _jsx(Button, { color: "secondary", size: "small", onClick: () => {
                                history.push('/settings/plugins');
                                closeSnackbar(snackbarId);
                            }, children: t('Settings') }) })),
                });
            }
            else {
                enqueueSnackbar(message);
            }
        })
            .finally(() => {
            dispatch(pluginsLoaded());
            // Warn the app (if we're in app mode).
            window.desktopApi?.send('pluginsLoaded');
        })
            .catch(console.error);
    }, []);
    return null;
}