@perses-dev/plugin-system 0.0.0-snapshot-time-range-height-80d08fc

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

@@ -0,0 +1,75 @@
+// Copyright 2022 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: all[name]
+    });
+}
+_export(exports, {
+    PluginRegistryContext: ()=>PluginRegistryContext,
+    usePluginRegistry: ()=>usePluginRegistry,
+    usePlugin: ()=>usePlugin,
+    usePlugins: ()=>usePlugins,
+    useListPluginMetadata: ()=>useListPluginMetadata
+});
+const _react = require("react");
+const _reactQuery = require("@tanstack/react-query");
+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) {
+    var ref;
+    // We never want to ask for a plugin when the kind isn't set yet, so disable those queries automatically
+    options = {
+        ...options,
+        enabled: ((ref = options === null || options === void 0 ? void 0 : options.enabled) !== null && ref !== void 0 ? ref : true) && kind !== ''
+    };
+    const { getPlugin  } = usePluginRegistry();
+    return (0, _reactQuery.useQuery)([
+        'getPlugin',
+        pluginType,
+        kind
+    ], ()=>getPlugin(pluginType, kind), options);
+}
+function usePlugins(pluginType, plugins) {
+    const { getPlugin  } = usePluginRegistry();
+    return (0, _reactQuery.useQueries)({
+        queries: plugins.map((p)=>{
+            return {
+                queryKey: [
+                    'getPlugin',
+                    pluginType,
+                    p.kind
+                ],
+                queryFn: ()=>getPlugin(pluginType, p.kind)
+            };
+        })
+    });
+}
+function useListPluginMetadata(pluginType, options) {
+    const { listPluginMetadata  } = usePluginRegistry();
+    return (0, _reactQuery.useQuery)([
+        'listPluginMetadata',
+        pluginType
+    ], ()=>listPluginMetadata(pluginType), options);
+}

package/dist/cjs/runtime/template-variables.js

@@ -0,0 +1,57 @@
+// Copyright 2022 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: all[name]
+    });
+}
+_export(exports, {
+    DEFAULT_ALL_VALUE: ()=>DEFAULT_ALL_VALUE,
+    TemplateVariableContext: ()=>TemplateVariableContext,
+    useTemplateVariableValues: ()=>useTemplateVariableValues
+});
+const _react = require("react");
+const DEFAULT_ALL_VALUE = '$__all';
+const TemplateVariableContext = (0, _react.createContext)(undefined);
+function useTemplateVariableContext() {
+    const ctx = (0, _react.useContext)(TemplateVariableContext);
+    if (ctx === undefined) {
+        throw new Error('No TemplateVariableContext found. Did you forget a Provider?');
+    }
+    return ctx;
+}
+function useTemplateVariableValues(names) {
+    const { state  } = useTemplateVariableContext();
+    const values = (0, _react.useMemo)(()=>{
+        const values = {};
+        names === null || names === void 0 ? void 0 : names.forEach((name)=>{
+            const s = state[name];
+            if (s) {
+                values[name] = s;
+            }
+        });
+        return values;
+    }, [
+        state,
+        names
+    ]);
+    if (names === undefined) {
+        return state;
+    }
+    return values;
+}

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

@@ -0,0 +1,140 @@
+// Copyright 2022 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: all[name]
+    });
+}
+_export(exports, {
+    useTimeSeriesQuery: ()=>useTimeSeriesQuery,
+    useTimeSeriesQueries: ()=>useTimeSeriesQueries
+});
+const _reactQuery = require("@tanstack/react-query");
+const _templateVariables = require("./template-variables");
+const _timeRangeProvider = require("./TimeRangeProvider");
+const _datasources = require("./datasources");
+const _pluginRegistry = require("./plugin-registry");
+/**
+ * Returns a serialized string of the current state of variable values.
+ */ function getVariableValuesKey(v) {
+    return Object.values(v).map((v)=>JSON.stringify(v.value)).join(',');
+}
+function filterVariableStateMap(v, names) {
+    if (!names) {
+        return v;
+    }
+    return Object.fromEntries(Object.entries(v).filter(([name])=>names.includes(name)));
+}
+function getQueryOptions({ plugin , definition , context  }) {
+    const { timeRange , datasourceStore , suggestedStepMs , variableState , refreshKey  } = context;
+    const dependencies = (plugin === null || plugin === void 0 ? void 0 : plugin.dependsOn) ? plugin.dependsOn(definition.spec.plugin.spec, context) : {};
+    const variableDependencies = dependencies === null || dependencies === void 0 ? void 0 : dependencies.variables;
+    // Determine queryKey
+    const filteredVariabledState = filterVariableStateMap(variableState, variableDependencies);
+    const variablesValueKey = getVariableValuesKey(filteredVariabledState);
+    const queryKey = [
+        definition,
+        timeRange,
+        datasourceStore,
+        suggestedStepMs,
+        variablesValueKey,
+        refreshKey
+    ];
+    // Determine queryEnabled
+    let waitToLoad = false;
+    if (variableDependencies) {
+        waitToLoad = variableDependencies.some((v)=>{
+            var ref;
+            return (ref = variableState[v]) === null || ref === void 0 ? void 0 : ref.loading;
+        });
+    }
+    const queryEnabled = plugin !== undefined && !waitToLoad;
+    return {
+        queryKey,
+        queryEnabled
+    };
+}
+const useTimeSeriesQuery = (definition, options)=>{
+    const { data: plugin  } = (0, _pluginRegistry.usePlugin)('TimeSeriesQuery', definition.spec.plugin.kind);
+    const context = useTimeSeriesQueryContext();
+    const { queryEnabled , queryKey  } = getQueryOptions({
+        plugin,
+        definition,
+        context
+    });
+    return (0, _reactQuery.useQuery)({
+        enabled: queryEnabled,
+        queryKey: queryKey,
+        queryFn: ()=>{
+            // 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 === null || options === void 0 ? void 0 : options.suggestedStepMs
+            };
+            return plugin.getTimeSeriesData(definition.spec.plugin.spec, ctx);
+        }
+    });
+};
+function useTimeSeriesQueries(definitions, options) {
+    const { getPlugin  } = (0, _pluginRegistry.usePluginRegistry)();
+    const context = useTimeSeriesQueryContext();
+    const pluginLoaderResponse = (0, _pluginRegistry.usePlugins)('TimeSeriesQuery', definitions.map((d)=>({
+            kind: d.spec.plugin.kind
+        })));
+    return (0, _reactQuery.useQueries)({
+        queries: definitions.map((definition, idx)=>{
+            var ref;
+            const plugin = (ref = pluginLoaderResponse[idx]) === null || ref === void 0 ? void 0 : ref.data;
+            const { queryEnabled , queryKey  } = getQueryOptions({
+                plugin,
+                definition,
+                context
+            });
+            return {
+                enabled: queryEnabled,
+                queryKey: queryKey,
+                queryFn: async ()=>{
+                    // Keep options out of query key so we don't re-run queries because suggested step changes
+                    const ctx = {
+                        ...context,
+                        suggestedStepMs: options === null || options === void 0 ? void 0 : options.suggestedStepMs
+                    };
+                    const plugin = await getPlugin('TimeSeriesQuery', definition.spec.plugin.kind);
+                    const data = await plugin.getTimeSeriesData(definition.spec.plugin.spec, ctx);
+                    return data;
+                }
+            };
+        })
+    });
+}
+function useTimeSeriesQueryContext() {
+    // Build the context object from data available at runtime
+    const { absoluteTimeRange , refreshKey  } = (0, _timeRangeProvider.useTimeRange)();
+    const variableState = (0, _templateVariables.useTemplateVariableValues)();
+    const datasourceStore = (0, _datasources.useDatasourceStore)();
+    return {
+        timeRange: absoluteTimeRange,
+        variableState,
+        datasourceStore,
+        refreshKey
+    };
+}

package/dist/cjs/test/index.js

@@ -0,0 +1,28 @@
+// Copyright 2022 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
+});
+_exportStar(require("./render"), exports);
+function _exportStar(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) Object.defineProperty(to, k, {
+            enumerable: true,
+            get: function() {
+                return from[k];
+            }
+        });
+    });
+    return from;
+}

package/dist/cjs/test/render.js

@@ -0,0 +1,52 @@
+// Copyright 2022 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
+});
+Object.defineProperty(exports, "renderWithContext", {
+    enumerable: true,
+    get: ()=>renderWithContext
+});
+const _jsxRuntime = require("react/jsx-runtime");
+const _react = require("@testing-library/react");
+const _reactQuery = require("@tanstack/react-query");
+const _pluginRegistry = require("../components/PluginRegistry");
+const _testPlugins = require("./test-plugins");
+const testLogger = {
+    log: console.log,
+    warn: console.warn,
+    error: ()=>{
+    // Don't log network errors in tests to the console
+    }
+};
+function renderWithContext(ui, renderOptions, contextOptions) {
+    // Create a new QueryClient for each test to avoid caching issues
+    const queryClient = new _reactQuery.QueryClient({
+        defaultOptions: {
+            queries: {
+                refetchOnWindowFocus: false,
+                retry: false
+            }
+        },
+        logger: testLogger
+    });
+    return (0, _react.render)(/*#__PURE__*/ (0, _jsxRuntime.jsx)(_reactQuery.QueryClientProvider, {
+        client: queryClient,
+        children: /*#__PURE__*/ (0, _jsxRuntime.jsx)(_pluginRegistry.PluginRegistry, {
+            pluginLoader: _testPlugins.testPluginLoader,
+            defaultPluginKinds: contextOptions === null || contextOptions === void 0 ? void 0 : contextOptions.defaultPluginKinds,
+            children: ui
+        })
+    }), renderOptions);
+}

package/dist/cjs/test/setup-tests.js

@@ -0,0 +1,20 @@
+// Copyright 2022 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.
+// Add testing library assertions
+"use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+require("@testing-library/jest-dom/extend-expect");
+// Always mock e-charts during tests since we don't have a proper canvas in jsdom
+jest.mock('echarts/core');

package/dist/cjs/test/test-plugins/bert/index.js

@@ -0,0 +1,77 @@
+// Copyright 2022 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: all[name]
+    });
+}
+_export(exports, {
+    BertPanel1: ()=>BertPanel1,
+    BertPanel2: ()=>BertPanel2
+});
+const _jsxRuntime = require("react/jsx-runtime");
+const BertPanel1 = {
+    PanelComponent: ()=>null,
+    OptionsEditorComponent: function BertPanel1Editor({ value , onChange  }) {
+        return /*#__PURE__*/ (0, _jsxRuntime.jsxs)("div", {
+            children: [
+                /*#__PURE__*/ (0, _jsxRuntime.jsx)("label", {
+                    htmlFor: "editor-input",
+                    children: "BertPanel1 editor"
+                }),
+                /*#__PURE__*/ (0, _jsxRuntime.jsx)("input", {
+                    type: "text",
+                    id: "editor-input",
+                    value: value.option1,
+                    onChange: (e)=>onChange({
+                            ...value,
+                            option1: e.target.value
+                        })
+                })
+            ]
+        });
+    },
+    createInitialOptions: ()=>({
+            option1: ''
+        })
+};
+const BertPanel2 = {
+    PanelComponent: ()=>null,
+    OptionsEditorComponent: function BertPanel2Editor({ value , onChange  }) {
+        return /*#__PURE__*/ (0, _jsxRuntime.jsxs)("div", {
+            children: [
+                /*#__PURE__*/ (0, _jsxRuntime.jsx)("label", {
+                    htmlFor: "editor-input",
+                    children: "BertPanel2 editor"
+                }),
+                /*#__PURE__*/ (0, _jsxRuntime.jsx)("input", {
+                    type: "text",
+                    id: "editor-input",
+                    value: value.option2,
+                    onChange: (e)=>onChange({
+                            ...value,
+                            option2: e.target.value
+                        })
+                })
+            ]
+        });
+    },
+    createInitialOptions: ()=>({
+            option2: ''
+        })
+};

package/dist/cjs/test/test-plugins/ernie/index.js

@@ -0,0 +1,58 @@
+// Copyright 2022 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
+});
+Object.defineProperty(exports, "ErnieVariable", {
+    enumerable: true,
+    get: ()=>ErnieVariable
+});
+const _jsxRuntime = require("react/jsx-runtime");
+const data = [
+    {
+        label: 'Grover',
+        value: 'Grover'
+    },
+    {
+        label: 'Snuffleupagus',
+        value: 'Snuffleupagus'
+    }
+];
+const ErnieVariable = {
+    getVariableOptions: async ()=>({
+            data
+        }),
+    OptionsEditorComponent: function ErnieVariableEditor({ value , onChange  }) {
+        return /*#__PURE__*/ (0, _jsxRuntime.jsxs)("div", {
+            children: [
+                /*#__PURE__*/ (0, _jsxRuntime.jsx)("label", {
+                    htmlFor: "editor-input",
+                    children: "ErnieVariable editor"
+                }),
+                /*#__PURE__*/ (0, _jsxRuntime.jsx)("input", {
+                    type: "text",
+                    id: "editor-input",
+                    value: value.variableOption,
+                    onChange: (e)=>onChange({
+                            ...value,
+                            variableOption: e.target.value
+                        })
+                })
+            ]
+        });
+    },
+    createInitialOptions: ()=>({
+            variableOption: ''
+        })
+};

package/dist/cjs/test/test-plugins/index.js

@@ -0,0 +1,77 @@
+// Copyright 2022 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
+});
+Object.defineProperty(exports, "testPluginLoader", {
+    enumerable: true,
+    get: ()=>testPluginLoader
+});
+const _model = require("../../model");
+const _pluginJson = /*#__PURE__*/ _interopRequireDefault(require("./bert/plugin.json"));
+const _pluginJson1 = /*#__PURE__*/ _interopRequireDefault(require("./ernie/plugin.json"));
+function _interopRequireDefault(obj) {
+    return obj && obj.__esModule ? obj : {
+        default: obj
+    };
+}
+function _getRequireWildcardCache(nodeInterop) {
+    if (typeof WeakMap !== "function") return null;
+    var cacheBabelInterop = new WeakMap();
+    var cacheNodeInterop = new WeakMap();
+    return (_getRequireWildcardCache = function(nodeInterop) {
+        return nodeInterop ? cacheNodeInterop : cacheBabelInterop;
+    })(nodeInterop);
+}
+function _interopRequireWildcard(obj, nodeInterop) {
+    if (!nodeInterop && obj && obj.__esModule) {
+        return obj;
+    }
+    if (obj === null || typeof obj !== "object" && typeof obj !== "function") {
+        return {
+            default: obj
+        };
+    }
+    var cache = _getRequireWildcardCache(nodeInterop);
+    if (cache && cache.has(obj)) {
+        return cache.get(obj);
+    }
+    var newObj = {};
+    var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor;
+    for(var key in obj){
+        if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) {
+            var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null;
+            if (desc && (desc.get || desc.set)) {
+                Object.defineProperty(newObj, key, desc);
+            } else {
+                newObj[key] = obj[key];
+            }
+        }
+    }
+    newObj.default = obj;
+    if (cache) {
+        cache.set(obj, newObj);
+    }
+    return newObj;
+}
+const testPluginLoader = (0, _model.dynamicImportPluginLoader)([
+    {
+        resource: _pluginJson.default,
+        importPlugin: ()=>Promise.resolve().then(()=>/*#__PURE__*/ _interopRequireWildcard(require("./bert")))
+    },
+    {
+        resource: _pluginJson1.default,
+        importPlugin: ()=>Promise.resolve().then(()=>/*#__PURE__*/ _interopRequireWildcard(require("./ernie")))
+    }
+]);

package/dist/cjs/test-utils/index.js

@@ -0,0 +1,28 @@
+// Copyright 2022 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
+});
+_exportStar(require("./mock-plugin-registry"), exports);
+function _exportStar(from, to) {
+    Object.keys(from).forEach(function(k) {
+        if (k !== "default" && !Object.prototype.hasOwnProperty.call(to, k)) Object.defineProperty(to, k, {
+            enumerable: true,
+            get: function() {
+                return from[k];
+            }
+        });
+    });
+    return from;
+}