@perses-dev/plugin-system 0.55.0-beta.3 → 0.55.0-beta.6

package/dist/cjs/runtime/plugin-registry.js

@@ -1,135 +0,0 @@
-// Copyright The Perses 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.
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: Object.getOwnPropertyDescriptor(all, name).get
-    });
-}
-_export(exports, {
-    get PluginRegistryContext () {
-        return PluginRegistryContext;
-    },
-    get useListPluginMetadata () {
-        return useListPluginMetadata;
-    },
-    get usePlugin () {
-        return usePlugin;
-    },
-    get usePluginBuiltinVariableDefinitions () {
-        return usePluginBuiltinVariableDefinitions;
-    },
-    get usePluginRegistry () {
-        return usePluginRegistry;
-    },
-    get usePlugins () {
-        return usePlugins;
-    }
-});
-const _reactquery = require("@tanstack/react-query");
-const _react = require("react");
-const PluginRegistryContext = (0, _react.createContext)(undefined);
-function usePluginRegistry() {
-    const ctx = (0, _react.useContext)(PluginRegistryContext);
-    if (ctx === undefined) {
-        throw new Error('PluginRegistryContext not found. Did you forget a provider?');
-    }
-    return ctx;
-}
-function usePlugin(pluginType, kind, options) {
-    // We never want to ask for a plugin when the kind isn't set yet, so disable those queries automatically
-    options = {
-        ...options,
-        enabled: (options?.enabled ?? true) && pluginType !== undefined && kind !== ''
-    };
-    const { getPlugin } = usePluginRegistry();
-    return (0, _reactquery.useQuery)({
-        queryKey: [
-            'getPlugin',
-            pluginType,
-            kind
-        ],
-        queryFn: ()=>getPlugin({
-                kind: pluginType,
-                name: kind
-            }),
-        ...options
-    });
-}
-function usePlugins(pluginType, plugins) {
-    const { getPlugin } = usePluginRegistry();
-    // useQueries() does not support queries with duplicate keys, therefore we de-duplicate the plugin kinds before running useQueries()
-    // This resolves the following warning in the JS console: "[QueriesObserver]: Duplicate Queries found. This might result in unexpected behavior."
-    // https://github.com/TanStack/query/issues/8224#issuecomment-2523554831
-    // https://github.com/TanStack/query/issues/4187#issuecomment-1256336901
-    const kinds = [
-        ...new Set(plugins.map((p)=>p.kind))
-    ];
-    const result = (0, _reactquery.useQueries)({
-        queries: kinds.map((kind)=>{
-            return {
-                queryKey: [
-                    'getPlugin',
-                    pluginType,
-                    kind
-                ],
-                queryFn: ()=>getPlugin({
-                        kind: pluginType,
-                        name: kind
-                    })
-            };
-        })
-    });
-    // Re-assemble array in original order
-    return plugins.map((p)=>result[kinds.indexOf(p.kind)]);
-}
-function useListPluginMetadata(pluginTypes, options) {
-    const { listPluginMetadata } = usePluginRegistry();
-    return (0, _reactquery.useQuery)({
-        queryKey: [
-            'listPluginMetadata',
-            pluginTypes
-        ],
-        queryFn: ()=>listPluginMetadata(pluginTypes),
-        ...options
-    });
-}
-function usePluginBuiltinVariableDefinitions() {
-    const { getPlugin, listPluginMetadata } = usePluginRegistry();
-    return (0, _reactquery.useQuery)({
-        queryKey: [
-            'usePluginBuiltinVariableDefinitions'
-        ],
-        queryFn: async ()=>{
-            const datasources = await listPluginMetadata([
-                'Datasource'
-            ]);
-            const datasourceNames = new Set(datasources.map((datasource)=>datasource.spec.name));
-            const result = [];
-            for (const name of datasourceNames){
-                const plugin = await getPlugin({
-                    kind: 'Datasource',
-                    name
-                });
-                if (plugin.getBuiltinVariableDefinitions) {
-                    plugin.getBuiltinVariableDefinitions().forEach((definition)=>result.push(definition));
-                }
-            }
-            return result;
-        }
-    });
-}

package/dist/cjs/runtime/profile-queries.js

@@ -1,73 +0,0 @@
-// Copyright The Perses 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.
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: Object.getOwnPropertyDescriptor(all, name).get
-    });
-}
-_export(exports, {
-    get PROFILE_QUERY_KEY () {
-        return PROFILE_QUERY_KEY;
-    },
-    get useProfileQueries () {
-        return useProfileQueries;
-    }
-});
-const _reactquery = require("@tanstack/react-query");
-const _datasources = require("./datasources");
-const _pluginregistry = require("./plugin-registry");
-const _TimeRangeProvider = require("./TimeRangeProvider");
-const PROFILE_QUERY_KEY = 'ProfileQuery';
-function useProfileQueries(definitions) {
-    const { getPlugin } = (0, _pluginregistry.usePluginRegistry)();
-    const datasourceStore = (0, _datasources.useDatasourceStore)();
-    const { absoluteTimeRange } = (0, _TimeRangeProvider.useTimeRange)();
-    const context = {
-        datasourceStore,
-        absoluteTimeRange
-    };
-    // useQueries() handles data fetching from query plugins (e.g. traceQL queries, promQL queries)
-    // https://tanstack.com/query/v4/docs/react/reference/useQuery
-    return (0, _reactquery.useQueries)({
-        queries: definitions.map((definition)=>{
-            const queryKey = [
-                'query',
-                PROFILE_QUERY_KEY,
-                definition,
-                absoluteTimeRange
-            ]; // `queryKey` watches and reruns `queryFn` if keys in the array change
-            const profileQueryKind = definition?.spec?.plugin?.kind;
-            return {
-                queryKey: queryKey,
-                refetchOnMount: false,
-                refetchOnWindowFocus: false,
-                refetchOnReconnect: false,
-                staleTime: Infinity,
-                queryFn: async ({ signal })=>{
-                    const plugin = await getPlugin({
-                        kind: PROFILE_QUERY_KEY,
-                        name: profileQueryKind
-                    });
-                    const data = await plugin.getProfileData(definition.spec.plugin.spec, context, signal);
-                    return data;
-                },
-                structuralSharing: false
-            };
-        })
-    });
-}

package/dist/cjs/runtime/silences-queries.js

@@ -1,101 +0,0 @@
-// Copyright The Perses 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.
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: Object.getOwnPropertyDescriptor(all, name).get
-    });
-}
-_export(exports, {
-    get SILENCES_QUERY_KEY () {
-        return SILENCES_QUERY_KEY;
-    },
-    get useSilencesQueries () {
-        return useSilencesQueries;
-    }
-});
-const _reactquery = require("@tanstack/react-query");
-const _datasources = require("./datasources");
-const _pluginregistry = require("./plugin-registry");
-const _utils = require("./utils");
-const _variables = require("./variables");
-const SILENCES_QUERY_KEY = 'SilencesQuery';
-function useSilencesQueries(definitions) {
-    const { getPlugin } = (0, _pluginregistry.usePluginRegistry)();
-    const context = useSilencesQueryContext();
-    const pluginLoaderResponse = (0, _pluginregistry.usePlugins)('SilencesQuery', definitions.map((d)=>({
-            kind: d.spec.plugin.kind
-        })));
-    return (0, _reactquery.useQueries)({
-        queries: definitions.map((definition, idx)=>{
-            const plugin = pluginLoaderResponse[idx]?.data;
-            const { queryEnabled, queryKey } = getQueryOptions({
-                context,
-                definition,
-                plugin
-            });
-            const silencesQueryKind = definition?.spec?.plugin?.kind;
-            return {
-                enabled: queryEnabled,
-                queryKey: queryKey,
-                refetchOnMount: false,
-                refetchOnWindowFocus: false,
-                refetchOnReconnect: false,
-                staleTime: 60_000,
-                queryFn: async ({ signal })=>{
-                    const plugin = await getPlugin({
-                        kind: SILENCES_QUERY_KEY,
-                        name: silencesQueryKind
-                    });
-                    const data = await plugin.getSilencesData(definition.spec.plugin.spec, context, signal);
-                    return data;
-                }
-            };
-        })
-    });
-}
-function getQueryOptions({ plugin, definition, context }) {
-    const { variableState } = context;
-    const dependencies = plugin?.dependsOn ? plugin.dependsOn(definition.spec.plugin.spec, context) : {};
-    const variableDependencies = dependencies?.variables;
-    const filteredVariabledState = (0, _utils.filterVariableStateMap)(variableState, variableDependencies);
-    const variablesValueKey = (0, _utils.getVariableValuesKey)(filteredVariabledState);
-    // Note: no absoluteTimeRange in query key since silences are current state
-    const queryKey = [
-        'query',
-        SILENCES_QUERY_KEY,
-        definition,
-        variablesValueKey
-    ];
-    let waitToLoad = false;
-    if (variableDependencies) {
-        waitToLoad = variableDependencies.some((v)=>variableState[v]?.loading);
-    }
-    const queryEnabled = plugin !== undefined && !waitToLoad;
-    return {
-        queryKey,
-        queryEnabled
-    };
-}
-function useSilencesQueryContext() {
-    const variableState = (0, _variables.useAllVariableValues)();
-    const datasourceStore = (0, _datasources.useDatasourceStore)();
-    return {
-        variableState,
-        datasourceStore
-    };
-}

package/dist/cjs/runtime/time-series-queries.js

@@ -1,165 +0,0 @@
-// Copyright The Perses 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.
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: Object.getOwnPropertyDescriptor(all, name).get
-    });
-}
-_export(exports, {
-    get TIME_SERIES_QUERY_KEY () {
-        return TIME_SERIES_QUERY_KEY;
-    },
-    get getActiveTimeSeriesQueries () {
-        return getActiveTimeSeriesQueries;
-    },
-    get useActiveTimeSeriesQueries () {
-        return useActiveTimeSeriesQueries;
-    },
-    get useTimeSeriesQueries () {
-        return useTimeSeriesQueries;
-    },
-    get useTimeSeriesQuery () {
-        return useTimeSeriesQuery;
-    }
-});
-const _reactquery = require("@tanstack/react-query");
-const _datasources = require("./datasources");
-const _pluginregistry = require("./plugin-registry");
-const _TimeRangeProvider = require("./TimeRangeProvider");
-const _utils = require("./utils");
-const _variables = require("./variables");
-const TIME_SERIES_QUERY_KEY = 'TimeSeriesQuery';
-function getQueryOptions({ plugin, definition, context }) {
-    const { timeRange, suggestedStepMs, mode, variableState } = context;
-    const dependencies = plugin?.dependsOn ? plugin.dependsOn(definition.spec.plugin.spec, context) : {};
-    const variableDependencies = dependencies?.variables;
-    // Determine queryKey
-    const filteredVariabledState = (0, _utils.filterVariableStateMap)(variableState, variableDependencies);
-    const variablesValueKey = (0, _utils.getVariableValuesKey)(filteredVariabledState);
-    const queryKey = [
-        'query',
-        TIME_SERIES_QUERY_KEY,
-        definition,
-        timeRange,
-        variablesValueKey,
-        suggestedStepMs,
-        mode
-    ];
-    // Determine queryEnabled
-    let waitToLoad = false;
-    if (variableDependencies) {
-        waitToLoad = variableDependencies.some((v)=>variableState[v]?.loading);
-    }
-    const queryEnabled = plugin !== undefined && !waitToLoad;
-    return {
-        queryKey,
-        queryEnabled
-    };
-}
-const useTimeSeriesQuery = (definition, options, queryOptions)=>{
-    const { data: plugin } = (0, _pluginregistry.usePlugin)(TIME_SERIES_QUERY_KEY, definition.spec.plugin.kind);
-    const context = useTimeSeriesQueryContext();
-    const { queryEnabled, queryKey } = getQueryOptions({
-        plugin,
-        definition,
-        context
-    });
-    return (0, _reactquery.useQuery)({
-        enabled: (queryOptions?.enabled ?? true) || queryEnabled,
-        queryKey: queryKey,
-        queryFn: ({ signal })=>{
-            // The 'enabled' option should prevent this from happening, but make TypeScript happy by checking
-            if (plugin === undefined) {
-                throw new Error('Expected plugin to be loaded');
-            }
-            // Keep options out of query key so we don't re-run queries because suggested step changes
-            const ctx = {
-                ...context,
-                suggestedStepMs: options?.suggestedStepMs
-            };
-            return plugin.getTimeSeriesData(definition.spec.plugin.spec, ctx, signal);
-        }
-    });
-};
-function useTimeSeriesQueries(definitions, options, queryOptions) {
-    const { getPlugin } = (0, _pluginregistry.usePluginRegistry)();
-    const context = {
-        ...useTimeSeriesQueryContext(),
-        mode: options?.mode,
-        suggestedStepMs: options?.suggestedStepMs
-    };
-    const pluginLoaderResponse = (0, _pluginregistry.usePlugins)(TIME_SERIES_QUERY_KEY, definitions.map((d)=>({
-            kind: d.spec.plugin.kind
-        })));
-    return (0, _reactquery.useQueries)({
-        queries: definitions.map((definition, idx)=>{
-            const plugin = pluginLoaderResponse[idx]?.data;
-            const { queryEnabled, queryKey } = getQueryOptions({
-                plugin,
-                definition,
-                context
-            });
-            return {
-                ...queryOptions,
-                enabled: (queryOptions?.enabled ?? true) && queryEnabled,
-                refetchOnMount: false,
-                refetchOnWindowFocus: false,
-                refetchOnReconnect: false,
-                staleTime: Infinity,
-                queryKey: queryKey,
-                queryFn: async ({ signal })=>{
-                    const plugin = await getPlugin({
-                        kind: TIME_SERIES_QUERY_KEY,
-                        name: definition.spec.plugin.kind
-                    });
-                    const data = await plugin.getTimeSeriesData(definition.spec.plugin.spec, context, signal);
-                    return data;
-                }
-            };
-        })
-    });
-}
-/**
- * Build the time series query context object from data available at runtime
- */ function useTimeSeriesQueryContext() {
-    const { absoluteTimeRange } = (0, _TimeRangeProvider.useTimeRange)();
-    const variableState = (0, _variables.useAllVariableValues)();
-    const datasourceStore = (0, _datasources.useDatasourceStore)();
-    return {
-        timeRange: absoluteTimeRange,
-        variableState,
-        datasourceStore
-    };
-}
-function useActiveTimeSeriesQueries() {
-    const queryClient = (0, _reactquery.useQueryClient)();
-    const queryCache = queryClient.getQueryCache();
-    return getActiveTimeSeriesQueries(queryCache);
-}
-function getActiveTimeSeriesQueries(cache) {
-    const queries = [];
-    for (const query of cache.findAll({
-        type: 'active'
-    })){
-        const firstPart = query.queryKey?.[0];
-        if (firstPart?.kind && firstPart.kind.startsWith(TIME_SERIES_QUERY_KEY)) {
-            queries.push(query);
-        }
-    }
-    return queries;
-}

package/dist/cjs/runtime/trace-queries.js

@@ -1,106 +0,0 @@
-// Copyright The Perses 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.
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: Object.getOwnPropertyDescriptor(all, name).get
-    });
-}
-_export(exports, {
-    get TRACE_QUERY_KEY () {
-        return TRACE_QUERY_KEY;
-    },
-    get useTraceQueries () {
-        return useTraceQueries;
-    }
-});
-const _reactquery = require("@tanstack/react-query");
-const _datasources = require("./datasources");
-const _pluginregistry = require("./plugin-registry");
-const _TimeRangeProvider = require("./TimeRangeProvider");
-const _utils = require("./utils");
-const _variables = require("./variables");
-const TRACE_QUERY_KEY = 'TraceQuery';
-function useTraceQueries(definitions) {
-    const { getPlugin } = (0, _pluginregistry.usePluginRegistry)();
-    const context = useTraceQueryContext();
-    const pluginLoaderResponse = (0, _pluginregistry.usePlugins)('TraceQuery', definitions.map((d)=>({
-            kind: d.spec.plugin.kind
-        })));
-    // useQueries() handles data fetching from query plugins (e.g. traceQL queries, promQL queries)
-    // https://tanstack.com/query/v4/docs/react/reference/useQuery
-    return (0, _reactquery.useQueries)({
-        queries: definitions.map((definition, idx)=>{
-            const plugin = pluginLoaderResponse[idx]?.data;
-            const { queryEnabled, queryKey } = getQueryOptions({
-                context,
-                definition,
-                plugin
-            });
-            const traceQueryKind = definition?.spec?.plugin?.kind;
-            return {
-                enabled: queryEnabled,
-                queryKey: queryKey,
-                refetchOnMount: false,
-                refetchOnWindowFocus: false,
-                refetchOnReconnect: false,
-                staleTime: Infinity,
-                queryFn: async ({ signal })=>{
-                    const plugin = await getPlugin({
-                        kind: TRACE_QUERY_KEY,
-                        name: traceQueryKind
-                    });
-                    const data = await plugin.getTraceData(definition.spec.plugin.spec, context, signal);
-                    return data;
-                }
-            };
-        })
-    });
-}
-function getQueryOptions({ plugin, definition, context }) {
-    const { variableState, absoluteTimeRange } = context;
-    const dependencies = plugin?.dependsOn ? plugin.dependsOn(definition.spec.plugin.spec, context) : {};
-    const variableDependencies = dependencies?.variables;
-    const filteredVariabledState = (0, _utils.filterVariableStateMap)(variableState, variableDependencies);
-    const variablesValueKey = (0, _utils.getVariableValuesKey)(filteredVariabledState);
-    const queryKey = [
-        'query',
-        TRACE_QUERY_KEY,
-        definition,
-        absoluteTimeRange,
-        variablesValueKey
-    ];
-    let waitToLoad = false;
-    if (variableDependencies) {
-        waitToLoad = variableDependencies.some((v)=>variableState[v]?.loading);
-    }
-    const queryEnabled = plugin !== undefined && !waitToLoad;
-    return {
-        queryKey,
-        queryEnabled
-    };
-}
-function useTraceQueryContext() {
-    const { absoluteTimeRange } = (0, _TimeRangeProvider.useTimeRange)();
-    const variableState = (0, _variables.useAllVariableValues)();
-    const datasourceStore = (0, _datasources.useDatasourceStore)();
-    return {
-        variableState,
-        datasourceStore,
-        absoluteTimeRange
-    };
-}

package/dist/cjs/runtime/utils.js

@@ -1,39 +0,0 @@
-// Copyright The Perses 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.
-"use strict";
-Object.defineProperty(exports, "__esModule", {
-    value: true
-});
-function _export(target, all) {
-    for(var name in all)Object.defineProperty(target, name, {
-        enumerable: true,
-        get: Object.getOwnPropertyDescriptor(all, name).get
-    });
-}
-_export(exports, {
-    get filterVariableStateMap () {
-        return filterVariableStateMap;
-    },
-    get getVariableValuesKey () {
-        return getVariableValuesKey;
-    }
-});
-function filterVariableStateMap(v, names) {
-    if (!names) {
-        return v;
-    }
-    return Object.fromEntries(Object.entries(v).filter(([name])=>names.includes(name)));
-}
-function getVariableValuesKey(v) {
-    return Object.values(v).map((v)=>JSON.stringify(v.value)).join(',');
-}