@perses-dev/plugin-system 0.51.0-beta.0 → 0.51.0-rc.0

package/dist/runtime/plugin-registry.d.ts

@@ -4,7 +4,7 @@ import { UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
 import { DefaultPluginKinds, PluginImplementation, PluginMetadataWithModule, PluginType } from '../model';
 export interface PluginRegistryContextType {
     getPlugin<T extends PluginType>(kind: T, name: string): Promise<PluginImplementation<T>>;
-    listPluginMetadata(pluginTypes: string[]): Promise<PluginMetadataWithModule[]>;
+    listPluginMetadata(pluginTypes: PluginType[]): Promise<PluginMetadataWithModule[]>;
     defaultPluginKinds?: DefaultPluginKinds;
 }
 export declare const PluginRegistryContext: import("react").Context<PluginRegistryContextType | undefined>;
@@ -28,7 +28,7 @@ type UseListPluginMetadataOptions = Omit<UseQueryOptions<PluginMetadataWithModul
 /**
  * Gets a list of plugin metadata for the specified plugin type and returns it, along with loading/error state.
  */
-export declare function useListPluginMetadata(pluginTypes: string[], options?: UseListPluginMetadataOptions): UseQueryResult<PluginMetadataWithModule[]>;
+export declare function useListPluginMetadata(pluginTypes: PluginType[], options?: UseListPluginMetadataOptions): UseQueryResult<PluginMetadataWithModule[]>;
 export declare function usePluginBuiltinVariableDefinitions(): UseQueryResult<BuiltinVariableDefinition[]>;
 export {};
 //# sourceMappingURL=plugin-registry.d.ts.map

package/dist/runtime/plugin-registry.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"plugin-registry.d.ts","sourceRoot":"","sources":["../../src/runtime/plugin-registry.ts"],"names":[],"mappings":";AAaA,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAwB,eAAe,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAE9F,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE1G,MAAM,WAAW,yBAAyB;IACxC,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;IACzF,kBAAkB,CAAC,WAAW,EAAE,MAAM,EAAE,GAAG,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAAC;IAC/E,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC;AAED,eAAO,MAAM,qBAAqB,gEAAkE,CAAC;AAErG;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,yBAAyB,CAM7D;AAGD,KAAK,gBAAgB,CAAC,CAAC,SAAS,UAAU,IAAI,IAAI,CAChD,eAAe,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,EAAE,MAAM,CAAC,CAAC,EAClH,UAAU,GAAG,SAAS,CACvB,CAAC;AAEF;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,UAAU,EAC5C,UAAU,EAAE,CAAC,GAAG,SAAS,EACzB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAC5B,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAYhD;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAC7C,UAAU,EAAE,CAAC,EACb,OAAO,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,GAC/B,KAAK,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAUhD;AAGD,KAAK,4BAA4B,GAAG,IAAI,CACtC,eAAe,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,wBAAwB,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,EAClG,UAAU,GAAG,SAAS,CACvB,CAAC;AAEF;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,MAAM,EAAE,EACrB,OAAO,CAAC,EAAE,4BAA4B,GACrC,cAAc,CAAC,wBAAwB,EAAE,CAAC,CAO5C;AAED,wBAAgB,mCAAmC,IAAI,cAAc,CAAC,yBAAyB,EAAE,CAAC,CAkBjG"}
+{"version":3,"file":"plugin-registry.d.ts","sourceRoot":"","sources":["../../src/runtime/plugin-registry.ts"],"names":[],"mappings":";AAaA,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAwB,eAAe,EAAE,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAE9F,OAAO,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,wBAAwB,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE1G,MAAM,WAAW,yBAAyB;IACxC,SAAS,CAAC,CAAC,SAAS,UAAU,EAAE,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC;IACzF,kBAAkB,CAAC,WAAW,EAAE,UAAU,EAAE,GAAG,OAAO,CAAC,wBAAwB,EAAE,CAAC,CAAC;IACnF,kBAAkB,CAAC,EAAE,kBAAkB,CAAC;CACzC;AAED,eAAO,MAAM,qBAAqB,gEAAkE,CAAC;AAErG;;;GAGG;AACH,wBAAgB,iBAAiB,IAAI,yBAAyB,CAM7D;AAGD,KAAK,gBAAgB,CAAC,CAAC,SAAS,UAAU,IAAI,IAAI,CAChD,eAAe,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,KAAK,EAAE,oBAAoB,CAAC,CAAC,CAAC,EAAE,CAAC,MAAM,EAAE,UAAU,GAAG,SAAS,EAAE,MAAM,CAAC,CAAC,EAClH,UAAU,GAAG,SAAS,CACvB,CAAC;AAEF;;GAEG;AACH,wBAAgB,SAAS,CAAC,CAAC,SAAS,UAAU,EAC5C,UAAU,EAAE,CAAC,GAAG,SAAS,EACzB,IAAI,EAAE,MAAM,EACZ,OAAO,CAAC,EAAE,gBAAgB,CAAC,CAAC,CAAC,GAC5B,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,EAAE,KAAK,CAAC,CAYhD;AAED;;GAEG;AACH,wBAAgB,UAAU,CAAC,CAAC,SAAS,UAAU,EAC7C,UAAU,EAAE,CAAC,EACb,OAAO,EAAE,KAAK,CAAC;IAAE,IAAI,EAAE,MAAM,CAAA;CAAE,CAAC,GAC/B,KAAK,CAAC,cAAc,CAAC,oBAAoB,CAAC,CAAC,CAAC,CAAC,CAAC,CAoBhD;AAGD,KAAK,4BAA4B,GAAG,IAAI,CACtC,eAAe,CAAC,wBAAwB,EAAE,EAAE,KAAK,EAAE,wBAAwB,EAAE,EAAE,CAAC,MAAM,EAAE,MAAM,EAAE,CAAC,CAAC,EAClG,UAAU,GAAG,SAAS,CACvB,CAAC;AAEF;;GAEG;AACH,wBAAgB,qBAAqB,CACnC,WAAW,EAAE,UAAU,EAAE,EACzB,OAAO,CAAC,EAAE,4BAA4B,GACrC,cAAc,CAAC,wBAAwB,EAAE,CAAC,CAO5C;AAED,wBAAgB,mCAAmC,IAAI,cAAc,CAAC,yBAAyB,EAAE,CAAC,CAkBjG"}

package/dist/runtime/plugin-registry.js

@@ -46,18 +46,27 @@ export const PluginRegistryContext = createContext(undefined);
  * Loads a list of plugins and returns the plugin implementation, along with loading/error state.
  */ export function usePlugins(pluginType, plugins) {
     const { getPlugin } = usePluginRegistry();
-    return useQueries({
-        queries: plugins.map((p)=>{
+    // 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 = useQueries({
+        queries: kinds.map((kind)=>{
             return {
                 queryKey: [
                     'getPlugin',
                     pluginType,
-                    p.kind
+                    kind
                 ],
-                queryFn: ()=>getPlugin(pluginType, p.kind)
+                queryFn: ()=>getPlugin(pluginType, kind)
             };
         })
     });
+    // Re-assemble array in original order
+    return plugins.map((p)=>result[kinds.indexOf(p.kind)]);
 }
 /**
  * Gets a list of plugin metadata for the specified plugin type and returns it, along with loading/error state.

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

@@ -1 +1 @@
-{"version":3,"sources":["../../src/runtime/plugin-registry.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { BuiltinVariableDefinition } from '@perses-dev/core';\nimport { useQueries, useQuery, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';\nimport { createContext, useContext } from 'react';\nimport { DefaultPluginKinds, PluginImplementation, PluginMetadataWithModule, PluginType } from '../model';\n\nexport interface PluginRegistryContextType {\n  getPlugin<T extends PluginType>(kind: T, name: string): Promise<PluginImplementation<T>>;\n  listPluginMetadata(pluginTypes: string[]): Promise<PluginMetadataWithModule[]>;\n  defaultPluginKinds?: DefaultPluginKinds;\n}\n\nexport const PluginRegistryContext = createContext<PluginRegistryContextType | undefined>(undefined);\n\n/**\n * Use the PluginRegistry context directly. This is meant as an escape hatch for custom async flows. You should probably\n * be using `usePlugin` or `useListPluginMetadata` instead.\n */\nexport function usePluginRegistry(): PluginRegistryContextType {\n  const ctx = useContext(PluginRegistryContext);\n  if (ctx === undefined) {\n    throw new Error('PluginRegistryContext not found. Did you forget a provider?');\n  }\n  return ctx;\n}\n\n// Allows consumers to pass useQuery options from react-query when loading a plugin\ntype UsePluginOptions<T extends PluginType> = Omit<\n  UseQueryOptions<PluginImplementation<T>, Error, PluginImplementation<T>, [string, PluginType | undefined, string]>,\n  'queryKey' | 'queryFn'\n>;\n\n/**\n * Loads a plugin and returns the plugin implementation, along with loading/error state.\n */\nexport function usePlugin<T extends PluginType>(\n  pluginType: T | undefined,\n  kind: string,\n  options?: UsePluginOptions<T>\n): UseQueryResult<PluginImplementation<T>, Error> {\n  // We never want to ask for a plugin when the kind isn't set yet, so disable those queries automatically\n  options = {\n    ...options,\n    enabled: (options?.enabled ?? true) && pluginType !== undefined && kind !== '',\n  };\n  const { getPlugin } = usePluginRegistry();\n  return useQuery({\n    queryKey: ['getPlugin', pluginType, kind],\n    queryFn: () => getPlugin(pluginType!, kind),\n    ...options,\n  });\n}\n\n/**\n * Loads a list of plugins and returns the plugin implementation, along with loading/error state.\n */\nexport function usePlugins<T extends PluginType>(\n  pluginType: T,\n  plugins: Array<{ kind: string }>\n): Array<UseQueryResult<PluginImplementation<T>>> {\n  const { getPlugin } = usePluginRegistry();\n  return useQueries({\n    queries: plugins.map((p) => {\n      return {\n        queryKey: ['getPlugin', pluginType, p.kind],\n        queryFn: () => getPlugin(pluginType, p.kind),\n      };\n    }),\n  });\n}\n\n// Allow consumers to pass useQuery options from react-query when listing metadata\ntype UseListPluginMetadataOptions = Omit<\n  UseQueryOptions<PluginMetadataWithModule[], Error, PluginMetadataWithModule[], [string, string[]]>,\n  'queryKey' | 'queryFn'\n>;\n\n/**\n * Gets a list of plugin metadata for the specified plugin type and returns it, along with loading/error state.\n */\nexport function useListPluginMetadata(\n  pluginTypes: string[],\n  options?: UseListPluginMetadataOptions\n): UseQueryResult<PluginMetadataWithModule[]> {\n  const { listPluginMetadata } = usePluginRegistry();\n  return useQuery({\n    queryKey: ['listPluginMetadata', pluginTypes],\n    queryFn: () => listPluginMetadata(pluginTypes),\n    ...options,\n  });\n}\n\nexport function usePluginBuiltinVariableDefinitions(): UseQueryResult<BuiltinVariableDefinition[]> {\n  const { getPlugin, listPluginMetadata } = usePluginRegistry();\n\n  return useQuery({\n    queryKey: ['usePluginBuiltinVariableDefinitions'],\n    queryFn: async () => {\n      const datasources = await listPluginMetadata(['Datasource']);\n      const datasourceNames = new Set(datasources.map((datasource) => datasource.spec.name));\n      const result: BuiltinVariableDefinition[] = [];\n      for (const name of datasourceNames) {\n        const plugin = await getPlugin('Datasource', name);\n        if (plugin.getBuiltinVariableDefinitions) {\n          plugin.getBuiltinVariableDefinitions().forEach((definition) => result.push(definition));\n        }\n      }\n      return result;\n    },\n  });\n}\n"],"names":["useQueries","useQuery","createContext","useContext","PluginRegistryContext","undefined","usePluginRegistry","ctx","Error","usePlugin","pluginType","kind","options","enabled","getPlugin","queryKey","queryFn","usePlugins","plugins","queries","map","p","useListPluginMetadata","pluginTypes","listPluginMetadata","usePluginBuiltinVariableDefinitions","datasources","datasourceNames","Set","datasource","spec","name","result","plugin","getBuiltinVariableDefinitions","forEach","definition","push"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAGjC,SAASA,UAAU,EAAEC,QAAQ,QAAyC,wBAAwB;AAC9F,SAASC,aAAa,EAAEC,UAAU,QAAQ,QAAQ;AASlD,OAAO,MAAMC,wBAAwBF,cAAqDG,WAAW;AAErG;;;CAGC,GACD,OAAO,SAASC;IACd,MAAMC,MAAMJ,WAAWC;IACvB,IAAIG,QAAQF,WAAW;QACrB,MAAM,IAAIG,MAAM;IAClB;IACA,OAAOD;AACT;AAQA;;CAEC,GACD,OAAO,SAASE,UACdC,UAAyB,EACzBC,IAAY,EACZC,OAA6B;IAE7B,wGAAwG;IACxGA,UAAU;QACR,GAAGA,OAAO;QACVC,SAAS,AAACD,CAAAA,SAASC,WAAW,IAAG,KAAMH,eAAeL,aAAaM,SAAS;IAC9E;IACA,MAAM,EAAEG,SAAS,EAAE,GAAGR;IACtB,OAAOL,SAAS;QACdc,UAAU;YAAC;YAAaL;YAAYC;SAAK;QACzCK,SAAS,IAAMF,UAAUJ,YAAaC;QACtC,GAAGC,OAAO;IACZ;AACF;AAEA;;CAEC,GACD,OAAO,SAASK,WACdP,UAAa,EACbQ,OAAgC;IAEhC,MAAM,EAAEJ,SAAS,EAAE,GAAGR;IACtB,OAAON,WAAW;QAChBmB,SAASD,QAAQE,GAAG,CAAC,CAACC;YACpB,OAAO;gBACLN,UAAU;oBAAC;oBAAaL;oBAAYW,EAAEV,IAAI;iBAAC;gBAC3CK,SAAS,IAAMF,UAAUJ,YAAYW,EAAEV,IAAI;YAC7C;QACF;IACF;AACF;AAQA;;CAEC,GACD,OAAO,SAASW,sBACdC,WAAqB,EACrBX,OAAsC;IAEtC,MAAM,EAAEY,kBAAkB,EAAE,GAAGlB;IAC/B,OAAOL,SAAS;QACdc,UAAU;YAAC;YAAsBQ;SAAY;QAC7CP,SAAS,IAAMQ,mBAAmBD;QAClC,GAAGX,OAAO;IACZ;AACF;AAEA,OAAO,SAASa;IACd,MAAM,EAAEX,SAAS,EAAEU,kBAAkB,EAAE,GAAGlB;IAE1C,OAAOL,SAAS;QACdc,UAAU;YAAC;SAAsC;QACjDC,SAAS;YACP,MAAMU,cAAc,MAAMF,mBAAmB;gBAAC;aAAa;YAC3D,MAAMG,kBAAkB,IAAIC,IAAIF,YAAYN,GAAG,CAAC,CAACS,aAAeA,WAAWC,IAAI,CAACC,IAAI;YACpF,MAAMC,SAAsC,EAAE;YAC9C,KAAK,MAAMD,QAAQJ,gBAAiB;gBAClC,MAAMM,SAAS,MAAMnB,UAAU,cAAciB;gBAC7C,IAAIE,OAAOC,6BAA6B,EAAE;oBACxCD,OAAOC,6BAA6B,GAAGC,OAAO,CAAC,CAACC,aAAeJ,OAAOK,IAAI,CAACD;gBAC7E;YACF;YACA,OAAOJ;QACT;IACF;AACF"}
+{"version":3,"sources":["../../src/runtime/plugin-registry.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { BuiltinVariableDefinition } from '@perses-dev/core';\nimport { useQueries, useQuery, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';\nimport { createContext, useContext } from 'react';\nimport { DefaultPluginKinds, PluginImplementation, PluginMetadataWithModule, PluginType } from '../model';\n\nexport interface PluginRegistryContextType {\n  getPlugin<T extends PluginType>(kind: T, name: string): Promise<PluginImplementation<T>>;\n  listPluginMetadata(pluginTypes: PluginType[]): Promise<PluginMetadataWithModule[]>;\n  defaultPluginKinds?: DefaultPluginKinds;\n}\n\nexport const PluginRegistryContext = createContext<PluginRegistryContextType | undefined>(undefined);\n\n/**\n * Use the PluginRegistry context directly. This is meant as an escape hatch for custom async flows. You should probably\n * be using `usePlugin` or `useListPluginMetadata` instead.\n */\nexport function usePluginRegistry(): PluginRegistryContextType {\n  const ctx = useContext(PluginRegistryContext);\n  if (ctx === undefined) {\n    throw new Error('PluginRegistryContext not found. Did you forget a provider?');\n  }\n  return ctx;\n}\n\n// Allows consumers to pass useQuery options from react-query when loading a plugin\ntype UsePluginOptions<T extends PluginType> = Omit<\n  UseQueryOptions<PluginImplementation<T>, Error, PluginImplementation<T>, [string, PluginType | undefined, string]>,\n  'queryKey' | 'queryFn'\n>;\n\n/**\n * Loads a plugin and returns the plugin implementation, along with loading/error state.\n */\nexport function usePlugin<T extends PluginType>(\n  pluginType: T | undefined,\n  kind: string,\n  options?: UsePluginOptions<T>\n): UseQueryResult<PluginImplementation<T>, Error> {\n  // We never want to ask for a plugin when the kind isn't set yet, so disable those queries automatically\n  options = {\n    ...options,\n    enabled: (options?.enabled ?? true) && pluginType !== undefined && kind !== '',\n  };\n  const { getPlugin } = usePluginRegistry();\n  return useQuery({\n    queryKey: ['getPlugin', pluginType, kind],\n    queryFn: () => getPlugin(pluginType!, kind),\n    ...options,\n  });\n}\n\n/**\n * Loads a list of plugins and returns the plugin implementation, along with loading/error state.\n */\nexport function usePlugins<T extends PluginType>(\n  pluginType: T,\n  plugins: Array<{ kind: string }>\n): Array<UseQueryResult<PluginImplementation<T>>> {\n  const { getPlugin } = usePluginRegistry();\n\n  // useQueries() does not support queries with duplicate keys, therefore we de-duplicate the plugin kinds before running useQueries()\n  // This resolves the following warning in the JS console: \"[QueriesObserver]: Duplicate Queries found. This might result in unexpected behavior.\"\n  // https://github.com/TanStack/query/issues/8224#issuecomment-2523554831\n  // https://github.com/TanStack/query/issues/4187#issuecomment-1256336901\n  const kinds = [...new Set(plugins.map((p) => p.kind))];\n\n  const result: Array<UseQueryResult<PluginImplementation<T>>> = useQueries({\n    queries: kinds.map((kind) => {\n      return {\n        queryKey: ['getPlugin', pluginType, kind],\n        queryFn: () => getPlugin(pluginType, kind),\n      };\n    }),\n  });\n\n  // Re-assemble array in original order\n  return plugins.map((p) => result[kinds.indexOf(p.kind)]!);\n}\n\n// Allow consumers to pass useQuery options from react-query when listing metadata\ntype UseListPluginMetadataOptions = Omit<\n  UseQueryOptions<PluginMetadataWithModule[], Error, PluginMetadataWithModule[], [string, string[]]>,\n  'queryKey' | 'queryFn'\n>;\n\n/**\n * Gets a list of plugin metadata for the specified plugin type and returns it, along with loading/error state.\n */\nexport function useListPluginMetadata(\n  pluginTypes: PluginType[],\n  options?: UseListPluginMetadataOptions\n): UseQueryResult<PluginMetadataWithModule[]> {\n  const { listPluginMetadata } = usePluginRegistry();\n  return useQuery({\n    queryKey: ['listPluginMetadata', pluginTypes],\n    queryFn: () => listPluginMetadata(pluginTypes),\n    ...options,\n  });\n}\n\nexport function usePluginBuiltinVariableDefinitions(): UseQueryResult<BuiltinVariableDefinition[]> {\n  const { getPlugin, listPluginMetadata } = usePluginRegistry();\n\n  return useQuery({\n    queryKey: ['usePluginBuiltinVariableDefinitions'],\n    queryFn: async () => {\n      const datasources = await listPluginMetadata(['Datasource']);\n      const datasourceNames = new Set(datasources.map((datasource) => datasource.spec.name));\n      const result: BuiltinVariableDefinition[] = [];\n      for (const name of datasourceNames) {\n        const plugin = await getPlugin('Datasource', name);\n        if (plugin.getBuiltinVariableDefinitions) {\n          plugin.getBuiltinVariableDefinitions().forEach((definition) => result.push(definition));\n        }\n      }\n      return result;\n    },\n  });\n}\n"],"names":["useQueries","useQuery","createContext","useContext","PluginRegistryContext","undefined","usePluginRegistry","ctx","Error","usePlugin","pluginType","kind","options","enabled","getPlugin","queryKey","queryFn","usePlugins","plugins","kinds","Set","map","p","result","queries","indexOf","useListPluginMetadata","pluginTypes","listPluginMetadata","usePluginBuiltinVariableDefinitions","datasources","datasourceNames","datasource","spec","name","plugin","getBuiltinVariableDefinitions","forEach","definition","push"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAGjC,SAASA,UAAU,EAAEC,QAAQ,QAAyC,wBAAwB;AAC9F,SAASC,aAAa,EAAEC,UAAU,QAAQ,QAAQ;AASlD,OAAO,MAAMC,wBAAwBF,cAAqDG,WAAW;AAErG;;;CAGC,GACD,OAAO,SAASC;IACd,MAAMC,MAAMJ,WAAWC;IACvB,IAAIG,QAAQF,WAAW;QACrB,MAAM,IAAIG,MAAM;IAClB;IACA,OAAOD;AACT;AAQA;;CAEC,GACD,OAAO,SAASE,UACdC,UAAyB,EACzBC,IAAY,EACZC,OAA6B;IAE7B,wGAAwG;IACxGA,UAAU;QACR,GAAGA,OAAO;QACVC,SAAS,AAACD,CAAAA,SAASC,WAAW,IAAG,KAAMH,eAAeL,aAAaM,SAAS;IAC9E;IACA,MAAM,EAAEG,SAAS,EAAE,GAAGR;IACtB,OAAOL,SAAS;QACdc,UAAU;YAAC;YAAaL;YAAYC;SAAK;QACzCK,SAAS,IAAMF,UAAUJ,YAAaC;QACtC,GAAGC,OAAO;IACZ;AACF;AAEA;;CAEC,GACD,OAAO,SAASK,WACdP,UAAa,EACbQ,OAAgC;IAEhC,MAAM,EAAEJ,SAAS,EAAE,GAAGR;IAEtB,oIAAoI;IACpI,iJAAiJ;IACjJ,wEAAwE;IACxE,wEAAwE;IACxE,MAAMa,QAAQ;WAAI,IAAIC,IAAIF,QAAQG,GAAG,CAAC,CAACC,IAAMA,EAAEX,IAAI;KAAG;IAEtD,MAAMY,SAAyDvB,WAAW;QACxEwB,SAASL,MAAME,GAAG,CAAC,CAACV;YAClB,OAAO;gBACLI,UAAU;oBAAC;oBAAaL;oBAAYC;iBAAK;gBACzCK,SAAS,IAAMF,UAAUJ,YAAYC;YACvC;QACF;IACF;IAEA,sCAAsC;IACtC,OAAOO,QAAQG,GAAG,CAAC,CAACC,IAAMC,MAAM,CAACJ,MAAMM,OAAO,CAACH,EAAEX,IAAI,EAAE;AACzD;AAQA;;CAEC,GACD,OAAO,SAASe,sBACdC,WAAyB,EACzBf,OAAsC;IAEtC,MAAM,EAAEgB,kBAAkB,EAAE,GAAGtB;IAC/B,OAAOL,SAAS;QACdc,UAAU;YAAC;YAAsBY;SAAY;QAC7CX,SAAS,IAAMY,mBAAmBD;QAClC,GAAGf,OAAO;IACZ;AACF;AAEA,OAAO,SAASiB;IACd,MAAM,EAAEf,SAAS,EAAEc,kBAAkB,EAAE,GAAGtB;IAE1C,OAAOL,SAAS;QACdc,UAAU;YAAC;SAAsC;QACjDC,SAAS;YACP,MAAMc,cAAc,MAAMF,mBAAmB;gBAAC;aAAa;YAC3D,MAAMG,kBAAkB,IAAIX,IAAIU,YAAYT,GAAG,CAAC,CAACW,aAAeA,WAAWC,IAAI,CAACC,IAAI;YACpF,MAAMX,SAAsC,EAAE;YAC9C,KAAK,MAAMW,QAAQH,gBAAiB;gBAClC,MAAMI,SAAS,MAAMrB,UAAU,cAAcoB;gBAC7C,IAAIC,OAAOC,6BAA6B,EAAE;oBACxCD,OAAOC,6BAA6B,GAAGC,OAAO,CAAC,CAACC,aAAef,OAAOgB,IAAI,CAACD;gBAC7E;YACF;YACA,OAAOf;QACT;IACF;AACF"}

package/dist/runtime/time-series-queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"time-series-queries.d.ts","sourceRoot":"","sources":["../../src/runtime/time-series-queries.ts"],"names":[],"mappings":"AAaA,OAAO,EAKL,UAAU,EAEV,oBAAoB,EACpB,cAAc,EACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,yBAAyB,EAAe,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC1F,OAAO,EAAE,mBAAmB,EAA0B,mBAAmB,EAAyB,MAAM,UAAU,CAAC;AAMnH,MAAM,WAAW,yBAAyB;IACxC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC5B;AAED,eAAO,MAAM,qBAAqB,oBAAoB,CAAC;AA8DvD;;GAEG;AACH,eAAO,MAAM,kBAAkB,eACjB,yBAAyB,YAC3B,yBAAyB,iBACpB,qBAAqB,cAAc,CAAC,KAClD,eAAe,cAAc,CAkB/B,CAAC;AAEF;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,yBAAyB,EAAE,EACxC,OAAO,CAAC,EAAE,yBAAyB,EACnC,YAAY,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAC,GACpD,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,CAiCvC;AAkBD;;GAEG;AACH,wBAAgB,0BAA0B,IAAI,mBAAmB,EAAE,CAIlE;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,UAAU,GAAG,mBAAmB,EAAE,CAWnF"}
+{"version":3,"file":"time-series-queries.d.ts","sourceRoot":"","sources":["../../src/runtime/time-series-queries.ts"],"names":[],"mappings":"AAaA,OAAO,EAKL,UAAU,EAEV,oBAAoB,EACpB,cAAc,EACf,MAAM,uBAAuB,CAAC;AAC/B,OAAO,EAAE,yBAAyB,EAAe,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAC1F,OAAO,EAAE,mBAAmB,EAA0B,mBAAmB,EAAyB,MAAM,UAAU,CAAC;AAOnH,MAAM,WAAW,yBAAyB;IACxC,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,IAAI,CAAC,EAAE,mBAAmB,CAAC;CAC5B;AAED,eAAO,MAAM,qBAAqB,oBAAoB,CAAC;AA8CvD;;GAEG;AACH,eAAO,MAAM,kBAAkB,eACjB,yBAAyB,YAC3B,yBAAyB,iBACpB,qBAAqB,cAAc,CAAC,KAClD,eAAe,cAAc,CAkB/B,CAAC;AAEF;;GAEG;AACH,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,yBAAyB,EAAE,EACxC,OAAO,CAAC,EAAE,yBAAyB,EACnC,YAAY,CAAC,EAAE,IAAI,CAAC,oBAAoB,EAAE,UAAU,CAAC,GACpD,KAAK,CAAC,cAAc,CAAC,cAAc,CAAC,CAAC,CAiCvC;AAkBD;;GAEG;AACH,wBAAgB,0BAA0B,IAAI,mBAAmB,EAAE,CAIlE;AAED;;GAEG;AACH,wBAAgB,0BAA0B,CAAC,KAAK,EAAE,UAAU,GAAG,mBAAmB,EAAE,CAWnF"}

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

@@ -15,18 +15,8 @@ import { useAllVariableValues } from './variables';
 import { useTimeRange } from './TimeRangeProvider';
 import { useDatasourceStore } from './datasources';
 import { usePlugin, usePluginRegistry, usePlugins } from './plugin-registry';
+import { filterVariableStateMap, getVariableValuesKey } from './utils';
 export const TIME_SERIES_QUERY_KEY = 'TimeSeriesQuery';
-/**
- * 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, mode, variableState, refreshKey } = context;
     const dependencies = plugin?.dependsOn ? plugin.dependsOn(definition.spec.plugin.spec, context) : {};

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

@@ -1 +1 @@
-{"version":3,"sources":["../../src/runtime/time-series-queries.ts"],"sourcesContent":["// Copyright 2024 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport {\n  useQuery,\n  useQueries,\n  useQueryClient,\n  Query,\n  QueryCache,\n  QueryKey,\n  QueryObserverOptions,\n  UseQueryResult,\n} from '@tanstack/react-query';\nimport { TimeSeriesQueryDefinition, UnknownSpec, TimeSeriesData } from '@perses-dev/core';\nimport { TimeSeriesDataQuery, TimeSeriesQueryContext, TimeSeriesQueryMode, TimeSeriesQueryPlugin } from '../model';\nimport { VariableStateMap, useAllVariableValues } from './variables';\nimport { useTimeRange } from './TimeRangeProvider';\nimport { useDatasourceStore } from './datasources';\nimport { usePlugin, usePluginRegistry, usePlugins } from './plugin-registry';\n\nexport interface UseTimeSeriesQueryOptions {\n  suggestedStepMs?: number;\n  mode?: TimeSeriesQueryMode;\n}\n\nexport const TIME_SERIES_QUERY_KEY = 'TimeSeriesQuery';\n\n/**\n * Returns a serialized string of the current state of variable values.\n */\nfunction getVariableValuesKey(v: VariableStateMap): string {\n  return Object.values(v)\n    .map((v) => JSON.stringify(v.value))\n    .join(',');\n}\n\nfunction filterVariableStateMap(v: VariableStateMap, names?: string[]): VariableStateMap {\n  if (!names) {\n    return v;\n  }\n  return Object.fromEntries(Object.entries(v).filter(([name]) => names.includes(name)));\n}\n\nfunction getQueryOptions({\n  plugin,\n  definition,\n  context,\n}: {\n  plugin?: TimeSeriesQueryPlugin;\n  definition: TimeSeriesQueryDefinition;\n  context: TimeSeriesQueryContext;\n}): {\n  queryKey: QueryKey;\n  queryEnabled: boolean;\n} {\n  const { timeRange, datasourceStore, suggestedStepMs, mode, variableState, refreshKey } = context;\n\n  const dependencies = plugin?.dependsOn ? plugin.dependsOn(definition.spec.plugin.spec, context) : {};\n  const variableDependencies = dependencies?.variables;\n\n  // Determine queryKey\n  const filteredVariabledState = filterVariableStateMap(variableState, variableDependencies);\n  const variablesValueKey = getVariableValuesKey(filteredVariabledState);\n  const queryKey = [\n    definition,\n    timeRange,\n    datasourceStore,\n    suggestedStepMs,\n    mode,\n    variablesValueKey,\n    refreshKey,\n  ] as const;\n\n  // Determine queryEnabled\n  let waitToLoad = false;\n  if (variableDependencies) {\n    waitToLoad = variableDependencies.some((v) => variableState[v]?.loading);\n  }\n\n  const queryEnabled = plugin !== undefined && !waitToLoad;\n\n  return {\n    queryKey,\n    queryEnabled,\n  };\n}\n\n/**\n * Runs a time series query using a plugin and returns the results.\n */\nexport const useTimeSeriesQuery = (\n  definition: TimeSeriesQueryDefinition,\n  options?: UseTimeSeriesQueryOptions,\n  queryOptions?: QueryObserverOptions<TimeSeriesData>\n): UseQueryResult<TimeSeriesData> => {\n  const { data: plugin } = usePlugin(TIME_SERIES_QUERY_KEY, definition.spec.plugin.kind);\n  const context = useTimeSeriesQueryContext();\n\n  const { queryEnabled, queryKey } = getQueryOptions({ plugin, definition, context });\n  return useQuery({\n    enabled: (queryOptions?.enabled ?? true) || queryEnabled,\n    queryKey: queryKey,\n    queryFn: () => {\n      // The 'enabled' option should prevent this from happening, but make TypeScript happy by checking\n      if (plugin === undefined) {\n        throw new Error('Expected plugin to be loaded');\n      }\n      // Keep options out of query key so we don't re-run queries because suggested step changes\n      const ctx: TimeSeriesQueryContext = { ...context, suggestedStepMs: options?.suggestedStepMs };\n      return plugin.getTimeSeriesData(definition.spec.plugin.spec, ctx);\n    },\n  });\n};\n\n/**\n * Runs multiple time series queries using plugins and returns the results.\n */\nexport function useTimeSeriesQueries(\n  definitions: TimeSeriesQueryDefinition[],\n  options?: UseTimeSeriesQueryOptions,\n  queryOptions?: Omit<QueryObserverOptions, 'queryKey'>\n): Array<UseQueryResult<TimeSeriesData>> {\n  const { getPlugin } = usePluginRegistry();\n  const context = {\n    ...useTimeSeriesQueryContext(),\n    // We need mode to be part query key because this drives the type of query done (instant VS range query)\n    mode: options?.mode,\n  };\n\n  const pluginLoaderResponse = usePlugins(\n    TIME_SERIES_QUERY_KEY,\n    definitions.map((d) => ({ kind: d.spec.plugin.kind }))\n  );\n\n  return useQueries({\n    queries: definitions.map((definition, idx) => {\n      const plugin = pluginLoaderResponse[idx]?.data;\n      const { queryEnabled, queryKey } = getQueryOptions({ plugin, definition, context });\n      return {\n        enabled: (queryOptions?.enabled ?? true) && queryEnabled,\n        queryKey: queryKey,\n        queryFn: async (): Promise<TimeSeriesData> => {\n          const ctx: TimeSeriesQueryContext = {\n            ...context,\n            // Keep suggested step changes out of the query key, so we don´t have to run again query when it changes\n            suggestedStepMs: options?.suggestedStepMs,\n          };\n          const plugin = await getPlugin(TIME_SERIES_QUERY_KEY, definition.spec.plugin.kind);\n          const data = await plugin.getTimeSeriesData(definition.spec.plugin.spec, ctx);\n          return data;\n        },\n      };\n    }),\n  });\n}\n\n/**\n * Build the time series query context object from data available at runtime\n */\nfunction useTimeSeriesQueryContext(): TimeSeriesQueryContext {\n  const { absoluteTimeRange, refreshKey } = useTimeRange();\n  const variableState = useAllVariableValues();\n  const datasourceStore = useDatasourceStore();\n\n  return {\n    timeRange: absoluteTimeRange,\n    variableState,\n    datasourceStore,\n    refreshKey,\n  };\n}\n\n/**\n * Get active time series queries for query results summary\n */\nexport function useActiveTimeSeriesQueries(): TimeSeriesDataQuery[] {\n  const queryClient = useQueryClient();\n  const queryCache = queryClient.getQueryCache();\n  return getActiveTimeSeriesQueries(queryCache);\n}\n\n/**\n * Filter all cached queries down to only active time series queries\n */\nexport function getActiveTimeSeriesQueries(cache: QueryCache): TimeSeriesDataQuery[] {\n  const queries: TimeSeriesDataQuery[] = [];\n\n  for (const query of cache.findAll({ type: 'active' })) {\n    const firstPart = query.queryKey?.[0] as UnknownSpec;\n    if (firstPart?.kind && (firstPart.kind as string).startsWith(TIME_SERIES_QUERY_KEY)) {\n      queries.push(query as Query<TimeSeriesData, unknown, TimeSeriesData, QueryKey>);\n    }\n  }\n\n  return queries;\n}\n"],"names":["useQuery","useQueries","useQueryClient","useAllVariableValues","useTimeRange","useDatasourceStore","usePlugin","usePluginRegistry","usePlugins","TIME_SERIES_QUERY_KEY","getVariableValuesKey","v","Object","values","map","JSON","stringify","value","join","filterVariableStateMap","names","fromEntries","entries","filter","name","includes","getQueryOptions","plugin","definition","context","timeRange","datasourceStore","suggestedStepMs","mode","variableState","refreshKey","dependencies","dependsOn","spec","variableDependencies","variables","filteredVariabledState","variablesValueKey","queryKey","waitToLoad","some","loading","queryEnabled","undefined","useTimeSeriesQuery","options","queryOptions","data","kind","useTimeSeriesQueryContext","enabled","queryFn","Error","ctx","getTimeSeriesData","useTimeSeriesQueries","definitions","getPlugin","pluginLoaderResponse","d","queries","idx","absoluteTimeRange","useActiveTimeSeriesQueries","queryClient","queryCache","getQueryCache","getActiveTimeSeriesQueries","cache","query","findAll","type","firstPart","startsWith","push"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,SACEA,QAAQ,EACRC,UAAU,EACVC,cAAc,QAMT,wBAAwB;AAG/B,SAA2BC,oBAAoB,QAAQ,cAAc;AACrE,SAASC,YAAY,QAAQ,sBAAsB;AACnD,SAASC,kBAAkB,QAAQ,gBAAgB;AACnD,SAASC,SAAS,EAAEC,iBAAiB,EAAEC,UAAU,QAAQ,oBAAoB;AAO7E,OAAO,MAAMC,wBAAwB,kBAAkB;AAEvD;;CAEC,GACD,SAASC,qBAAqBC,CAAmB;IAC/C,OAAOC,OAAOC,MAAM,CAACF,GAClBG,GAAG,CAAC,CAACH,IAAMI,KAAKC,SAAS,CAACL,EAAEM,KAAK,GACjCC,IAAI,CAAC;AACV;AAEA,SAASC,uBAAuBR,CAAmB,EAAES,KAAgB;IACnE,IAAI,CAACA,OAAO;QACV,OAAOT;IACT;IACA,OAAOC,OAAOS,WAAW,CAACT,OAAOU,OAAO,CAACX,GAAGY,MAAM,CAAC,CAAC,CAACC,KAAK,GAAKJ,MAAMK,QAAQ,CAACD;AAChF;AAEA,SAASE,gBAAgB,EACvBC,MAAM,EACNC,UAAU,EACVC,OAAO,EAKR;IAIC,MAAM,EAAEC,SAAS,EAAEC,eAAe,EAAEC,eAAe,EAAEC,IAAI,EAAEC,aAAa,EAAEC,UAAU,EAAE,GAAGN;IAEzF,MAAMO,eAAeT,QAAQU,YAAYV,OAAOU,SAAS,CAACT,WAAWU,IAAI,CAACX,MAAM,CAACW,IAAI,EAAET,WAAW,CAAC;IACnG,MAAMU,uBAAuBH,cAAcI;IAE3C,qBAAqB;IACrB,MAAMC,yBAAyBtB,uBAAuBe,eAAeK;IACrE,MAAMG,oBAAoBhC,qBAAqB+B;IAC/C,MAAME,WAAW;QACff;QACAE;QACAC;QACAC;QACAC;QACAS;QACAP;KACD;IAED,yBAAyB;IACzB,IAAIS,aAAa;IACjB,IAAIL,sBAAsB;QACxBK,aAAaL,qBAAqBM,IAAI,CAAC,CAAClC,IAAMuB,aAAa,CAACvB,EAAE,EAAEmC;IAClE;IAEA,MAAMC,eAAepB,WAAWqB,aAAa,CAACJ;IAE9C,OAAO;QACLD;QACAI;IACF;AACF;AAEA;;CAEC,GACD,OAAO,MAAME,qBAAqB,CAChCrB,YACAsB,SACAC;IAEA,MAAM,EAAEC,MAAMzB,MAAM,EAAE,GAAGrB,UAAUG,uBAAuBmB,WAAWU,IAAI,CAACX,MAAM,CAAC0B,IAAI;IACrF,MAAMxB,UAAUyB;IAEhB,MAAM,EAAEP,YAAY,EAAEJ,QAAQ,EAAE,GAAGjB,gBAAgB;QAAEC;QAAQC;QAAYC;IAAQ;IACjF,OAAO7B,SAAS;QACduD,SAAS,AAACJ,CAAAA,cAAcI,WAAW,IAAG,KAAMR;QAC5CJ,UAAUA;QACVa,SAAS;YACP,iGAAiG;YACjG,IAAI7B,WAAWqB,WAAW;gBACxB,MAAM,IAAIS,MAAM;YAClB;YACA,0FAA0F;YAC1F,MAAMC,MAA8B;gBAAE,GAAG7B,OAAO;gBAAEG,iBAAiBkB,SAASlB;YAAgB;YAC5F,OAAOL,OAAOgC,iBAAiB,CAAC/B,WAAWU,IAAI,CAACX,MAAM,CAACW,IAAI,EAAEoB;QAC/D;IACF;AACF,EAAE;AAEF;;CAEC,GACD,OAAO,SAASE,qBACdC,WAAwC,EACxCX,OAAmC,EACnCC,YAAqD;IAErD,MAAM,EAAEW,SAAS,EAAE,GAAGvD;IACtB,MAAMsB,UAAU;QACd,GAAGyB,2BAA2B;QAC9B,wGAAwG;QACxGrB,MAAMiB,SAASjB;IACjB;IAEA,MAAM8B,uBAAuBvD,WAC3BC,uBACAoD,YAAY/C,GAAG,CAAC,CAACkD,IAAO,CAAA;YAAEX,MAAMW,EAAE1B,IAAI,CAACX,MAAM,CAAC0B,IAAI;QAAC,CAAA;IAGrD,OAAOpD,WAAW;QAChBgE,SAASJ,YAAY/C,GAAG,CAAC,CAACc,YAAYsC;YACpC,MAAMvC,SAASoC,oBAAoB,CAACG,IAAI,EAAEd;YAC1C,MAAM,EAAEL,YAAY,EAAEJ,QAAQ,EAAE,GAAGjB,gBAAgB;gBAAEC;gBAAQC;gBAAYC;YAAQ;YACjF,OAAO;gBACL0B,SAAS,AAACJ,CAAAA,cAAcI,WAAW,IAAG,KAAMR;gBAC5CJ,UAAUA;gBACVa,SAAS;oBACP,MAAME,MAA8B;wBAClC,GAAG7B,OAAO;wBACV,wGAAwG;wBACxGG,iBAAiBkB,SAASlB;oBAC5B;oBACA,MAAML,SAAS,MAAMmC,UAAUrD,uBAAuBmB,WAAWU,IAAI,CAACX,MAAM,CAAC0B,IAAI;oBACjF,MAAMD,OAAO,MAAMzB,OAAOgC,iBAAiB,CAAC/B,WAAWU,IAAI,CAACX,MAAM,CAACW,IAAI,EAAEoB;oBACzE,OAAON;gBACT;YACF;QACF;IACF;AACF;AAEA;;CAEC,GACD,SAASE;IACP,MAAM,EAAEa,iBAAiB,EAAEhC,UAAU,EAAE,GAAG/B;IAC1C,MAAM8B,gBAAgB/B;IACtB,MAAM4B,kBAAkB1B;IAExB,OAAO;QACLyB,WAAWqC;QACXjC;QACAH;QACAI;IACF;AACF;AAEA;;CAEC,GACD,OAAO,SAASiC;IACd,MAAMC,cAAcnE;IACpB,MAAMoE,aAAaD,YAAYE,aAAa;IAC5C,OAAOC,2BAA2BF;AACpC;AAEA;;CAEC,GACD,OAAO,SAASE,2BAA2BC,KAAiB;IAC1D,MAAMR,UAAiC,EAAE;IAEzC,KAAK,MAAMS,SAASD,MAAME,OAAO,CAAC;QAAEC,MAAM;IAAS,GAAI;QACrD,MAAMC,YAAYH,MAAM/B,QAAQ,EAAE,CAAC,EAAE;QACrC,IAAIkC,WAAWxB,QAAQ,AAACwB,UAAUxB,IAAI,CAAYyB,UAAU,CAACrE,wBAAwB;YACnFwD,QAAQc,IAAI,CAACL;QACf;IACF;IAEA,OAAOT;AACT"}
+{"version":3,"sources":["../../src/runtime/time-series-queries.ts"],"sourcesContent":["// Copyright 2024 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport {\n  useQuery,\n  useQueries,\n  useQueryClient,\n  Query,\n  QueryCache,\n  QueryKey,\n  QueryObserverOptions,\n  UseQueryResult,\n} from '@tanstack/react-query';\nimport { TimeSeriesQueryDefinition, UnknownSpec, TimeSeriesData } from '@perses-dev/core';\nimport { TimeSeriesDataQuery, TimeSeriesQueryContext, TimeSeriesQueryMode, TimeSeriesQueryPlugin } from '../model';\nimport { useAllVariableValues } from './variables';\nimport { useTimeRange } from './TimeRangeProvider';\nimport { useDatasourceStore } from './datasources';\nimport { usePlugin, usePluginRegistry, usePlugins } from './plugin-registry';\nimport { filterVariableStateMap, getVariableValuesKey } from './utils';\n\nexport interface UseTimeSeriesQueryOptions {\n  suggestedStepMs?: number;\n  mode?: TimeSeriesQueryMode;\n}\n\nexport const TIME_SERIES_QUERY_KEY = 'TimeSeriesQuery';\n\nfunction getQueryOptions({\n  plugin,\n  definition,\n  context,\n}: {\n  plugin?: TimeSeriesQueryPlugin;\n  definition: TimeSeriesQueryDefinition;\n  context: TimeSeriesQueryContext;\n}): {\n  queryKey: QueryKey;\n  queryEnabled: boolean;\n} {\n  const { timeRange, datasourceStore, suggestedStepMs, mode, variableState, refreshKey } = context;\n\n  const dependencies = plugin?.dependsOn ? plugin.dependsOn(definition.spec.plugin.spec, context) : {};\n  const variableDependencies = dependencies?.variables;\n\n  // Determine queryKey\n  const filteredVariabledState = filterVariableStateMap(variableState, variableDependencies);\n  const variablesValueKey = getVariableValuesKey(filteredVariabledState);\n  const queryKey = [\n    definition,\n    timeRange,\n    datasourceStore,\n    suggestedStepMs,\n    mode,\n    variablesValueKey,\n    refreshKey,\n  ] as const;\n\n  // Determine queryEnabled\n  let waitToLoad = false;\n  if (variableDependencies) {\n    waitToLoad = variableDependencies.some((v) => variableState[v]?.loading);\n  }\n\n  const queryEnabled = plugin !== undefined && !waitToLoad;\n\n  return {\n    queryKey,\n    queryEnabled,\n  };\n}\n\n/**\n * Runs a time series query using a plugin and returns the results.\n */\nexport const useTimeSeriesQuery = (\n  definition: TimeSeriesQueryDefinition,\n  options?: UseTimeSeriesQueryOptions,\n  queryOptions?: QueryObserverOptions<TimeSeriesData>\n): UseQueryResult<TimeSeriesData> => {\n  const { data: plugin } = usePlugin(TIME_SERIES_QUERY_KEY, definition.spec.plugin.kind);\n  const context = useTimeSeriesQueryContext();\n\n  const { queryEnabled, queryKey } = getQueryOptions({ plugin, definition, context });\n  return useQuery({\n    enabled: (queryOptions?.enabled ?? true) || queryEnabled,\n    queryKey: queryKey,\n    queryFn: () => {\n      // The 'enabled' option should prevent this from happening, but make TypeScript happy by checking\n      if (plugin === undefined) {\n        throw new Error('Expected plugin to be loaded');\n      }\n      // Keep options out of query key so we don't re-run queries because suggested step changes\n      const ctx: TimeSeriesQueryContext = { ...context, suggestedStepMs: options?.suggestedStepMs };\n      return plugin.getTimeSeriesData(definition.spec.plugin.spec, ctx);\n    },\n  });\n};\n\n/**\n * Runs multiple time series queries using plugins and returns the results.\n */\nexport function useTimeSeriesQueries(\n  definitions: TimeSeriesQueryDefinition[],\n  options?: UseTimeSeriesQueryOptions,\n  queryOptions?: Omit<QueryObserverOptions, 'queryKey'>\n): Array<UseQueryResult<TimeSeriesData>> {\n  const { getPlugin } = usePluginRegistry();\n  const context = {\n    ...useTimeSeriesQueryContext(),\n    // We need mode to be part query key because this drives the type of query done (instant VS range query)\n    mode: options?.mode,\n  };\n\n  const pluginLoaderResponse = usePlugins(\n    TIME_SERIES_QUERY_KEY,\n    definitions.map((d) => ({ kind: d.spec.plugin.kind }))\n  );\n\n  return useQueries({\n    queries: definitions.map((definition, idx) => {\n      const plugin = pluginLoaderResponse[idx]?.data;\n      const { queryEnabled, queryKey } = getQueryOptions({ plugin, definition, context });\n      return {\n        enabled: (queryOptions?.enabled ?? true) && queryEnabled,\n        queryKey: queryKey,\n        queryFn: async (): Promise<TimeSeriesData> => {\n          const ctx: TimeSeriesQueryContext = {\n            ...context,\n            // Keep suggested step changes out of the query key, so we don´t have to run again query when it changes\n            suggestedStepMs: options?.suggestedStepMs,\n          };\n          const plugin = await getPlugin(TIME_SERIES_QUERY_KEY, definition.spec.plugin.kind);\n          const data = await plugin.getTimeSeriesData(definition.spec.plugin.spec, ctx);\n          return data;\n        },\n      };\n    }),\n  });\n}\n\n/**\n * Build the time series query context object from data available at runtime\n */\nfunction useTimeSeriesQueryContext(): TimeSeriesQueryContext {\n  const { absoluteTimeRange, refreshKey } = useTimeRange();\n  const variableState = useAllVariableValues();\n  const datasourceStore = useDatasourceStore();\n\n  return {\n    timeRange: absoluteTimeRange,\n    variableState,\n    datasourceStore,\n    refreshKey,\n  };\n}\n\n/**\n * Get active time series queries for query results summary\n */\nexport function useActiveTimeSeriesQueries(): TimeSeriesDataQuery[] {\n  const queryClient = useQueryClient();\n  const queryCache = queryClient.getQueryCache();\n  return getActiveTimeSeriesQueries(queryCache);\n}\n\n/**\n * Filter all cached queries down to only active time series queries\n */\nexport function getActiveTimeSeriesQueries(cache: QueryCache): TimeSeriesDataQuery[] {\n  const queries: TimeSeriesDataQuery[] = [];\n\n  for (const query of cache.findAll({ type: 'active' })) {\n    const firstPart = query.queryKey?.[0] as UnknownSpec;\n    if (firstPart?.kind && (firstPart.kind as string).startsWith(TIME_SERIES_QUERY_KEY)) {\n      queries.push(query as Query<TimeSeriesData, unknown, TimeSeriesData, QueryKey>);\n    }\n  }\n\n  return queries;\n}\n"],"names":["useQuery","useQueries","useQueryClient","useAllVariableValues","useTimeRange","useDatasourceStore","usePlugin","usePluginRegistry","usePlugins","filterVariableStateMap","getVariableValuesKey","TIME_SERIES_QUERY_KEY","getQueryOptions","plugin","definition","context","timeRange","datasourceStore","suggestedStepMs","mode","variableState","refreshKey","dependencies","dependsOn","spec","variableDependencies","variables","filteredVariabledState","variablesValueKey","queryKey","waitToLoad","some","v","loading","queryEnabled","undefined","useTimeSeriesQuery","options","queryOptions","data","kind","useTimeSeriesQueryContext","enabled","queryFn","Error","ctx","getTimeSeriesData","useTimeSeriesQueries","definitions","getPlugin","pluginLoaderResponse","map","d","queries","idx","absoluteTimeRange","useActiveTimeSeriesQueries","queryClient","queryCache","getQueryCache","getActiveTimeSeriesQueries","cache","query","findAll","type","firstPart","startsWith","push"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,SACEA,QAAQ,EACRC,UAAU,EACVC,cAAc,QAMT,wBAAwB;AAG/B,SAASC,oBAAoB,QAAQ,cAAc;AACnD,SAASC,YAAY,QAAQ,sBAAsB;AACnD,SAASC,kBAAkB,QAAQ,gBAAgB;AACnD,SAASC,SAAS,EAAEC,iBAAiB,EAAEC,UAAU,QAAQ,oBAAoB;AAC7E,SAASC,sBAAsB,EAAEC,oBAAoB,QAAQ,UAAU;AAOvE,OAAO,MAAMC,wBAAwB,kBAAkB;AAEvD,SAASC,gBAAgB,EACvBC,MAAM,EACNC,UAAU,EACVC,OAAO,EAKR;IAIC,MAAM,EAAEC,SAAS,EAAEC,eAAe,EAAEC,eAAe,EAAEC,IAAI,EAAEC,aAAa,EAAEC,UAAU,EAAE,GAAGN;IAEzF,MAAMO,eAAeT,QAAQU,YAAYV,OAAOU,SAAS,CAACT,WAAWU,IAAI,CAACX,MAAM,CAACW,IAAI,EAAET,WAAW,CAAC;IACnG,MAAMU,uBAAuBH,cAAcI;IAE3C,qBAAqB;IACrB,MAAMC,yBAAyBlB,uBAAuBW,eAAeK;IACrE,MAAMG,oBAAoBlB,qBAAqBiB;IAC/C,MAAME,WAAW;QACff;QACAE;QACAC;QACAC;QACAC;QACAS;QACAP;KACD;IAED,yBAAyB;IACzB,IAAIS,aAAa;IACjB,IAAIL,sBAAsB;QACxBK,aAAaL,qBAAqBM,IAAI,CAAC,CAACC,IAAMZ,aAAa,CAACY,EAAE,EAAEC;IAClE;IAEA,MAAMC,eAAerB,WAAWsB,aAAa,CAACL;IAE9C,OAAO;QACLD;QACAK;IACF;AACF;AAEA;;CAEC,GACD,OAAO,MAAME,qBAAqB,CAChCtB,YACAuB,SACAC;IAEA,MAAM,EAAEC,MAAM1B,MAAM,EAAE,GAAGP,UAAUK,uBAAuBG,WAAWU,IAAI,CAACX,MAAM,CAAC2B,IAAI;IACrF,MAAMzB,UAAU0B;IAEhB,MAAM,EAAEP,YAAY,EAAEL,QAAQ,EAAE,GAAGjB,gBAAgB;QAAEC;QAAQC;QAAYC;IAAQ;IACjF,OAAOf,SAAS;QACd0C,SAAS,AAACJ,CAAAA,cAAcI,WAAW,IAAG,KAAMR;QAC5CL,UAAUA;QACVc,SAAS;YACP,iGAAiG;YACjG,IAAI9B,WAAWsB,WAAW;gBACxB,MAAM,IAAIS,MAAM;YAClB;YACA,0FAA0F;YAC1F,MAAMC,MAA8B;gBAAE,GAAG9B,OAAO;gBAAEG,iBAAiBmB,SAASnB;YAAgB;YAC5F,OAAOL,OAAOiC,iBAAiB,CAAChC,WAAWU,IAAI,CAACX,MAAM,CAACW,IAAI,EAAEqB;QAC/D;IACF;AACF,EAAE;AAEF;;CAEC,GACD,OAAO,SAASE,qBACdC,WAAwC,EACxCX,OAAmC,EACnCC,YAAqD;IAErD,MAAM,EAAEW,SAAS,EAAE,GAAG1C;IACtB,MAAMQ,UAAU;QACd,GAAG0B,2BAA2B;QAC9B,wGAAwG;QACxGtB,MAAMkB,SAASlB;IACjB;IAEA,MAAM+B,uBAAuB1C,WAC3BG,uBACAqC,YAAYG,GAAG,CAAC,CAACC,IAAO,CAAA;YAAEZ,MAAMY,EAAE5B,IAAI,CAACX,MAAM,CAAC2B,IAAI;QAAC,CAAA;IAGrD,OAAOvC,WAAW;QAChBoD,SAASL,YAAYG,GAAG,CAAC,CAACrC,YAAYwC;YACpC,MAAMzC,SAASqC,oBAAoB,CAACI,IAAI,EAAEf;YAC1C,MAAM,EAAEL,YAAY,EAAEL,QAAQ,EAAE,GAAGjB,gBAAgB;gBAAEC;gBAAQC;gBAAYC;YAAQ;YACjF,OAAO;gBACL2B,SAAS,AAACJ,CAAAA,cAAcI,WAAW,IAAG,KAAMR;gBAC5CL,UAAUA;gBACVc,SAAS;oBACP,MAAME,MAA8B;wBAClC,GAAG9B,OAAO;wBACV,wGAAwG;wBACxGG,iBAAiBmB,SAASnB;oBAC5B;oBACA,MAAML,SAAS,MAAMoC,UAAUtC,uBAAuBG,WAAWU,IAAI,CAACX,MAAM,CAAC2B,IAAI;oBACjF,MAAMD,OAAO,MAAM1B,OAAOiC,iBAAiB,CAAChC,WAAWU,IAAI,CAACX,MAAM,CAACW,IAAI,EAAEqB;oBACzE,OAAON;gBACT;YACF;QACF;IACF;AACF;AAEA;;CAEC,GACD,SAASE;IACP,MAAM,EAAEc,iBAAiB,EAAElC,UAAU,EAAE,GAAGjB;IAC1C,MAAMgB,gBAAgBjB;IACtB,MAAMc,kBAAkBZ;IAExB,OAAO;QACLW,WAAWuC;QACXnC;QACAH;QACAI;IACF;AACF;AAEA;;CAEC,GACD,OAAO,SAASmC;IACd,MAAMC,cAAcvD;IACpB,MAAMwD,aAAaD,YAAYE,aAAa;IAC5C,OAAOC,2BAA2BF;AACpC;AAEA;;CAEC,GACD,OAAO,SAASE,2BAA2BC,KAAiB;IAC1D,MAAMR,UAAiC,EAAE;IAEzC,KAAK,MAAMS,SAASD,MAAME,OAAO,CAAC;QAAEC,MAAM;IAAS,GAAI;QACrD,MAAMC,YAAYH,MAAMjC,QAAQ,EAAE,CAAC,EAAE;QACrC,IAAIoC,WAAWzB,QAAQ,AAACyB,UAAUzB,IAAI,CAAY0B,UAAU,CAACvD,wBAAwB;YACnF0C,QAAQc,IAAI,CAACL;QACf;IACF;IAEA,OAAOT;AACT"}

package/dist/runtime/trace-queries.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"trace-queries.d.ts","sourceRoot":"","sources":["../../src/runtime/trace-queries.tsx"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9F,OAAO,EAAc,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAInE,MAAM,MAAM,oBAAoB,CAAC,UAAU,GAAG,WAAW,IAAI,eAAe,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AACvG,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,iBAAiB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAM7F;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CA+BrG"}
+{"version":3,"file":"trace-queries.d.ts","sourceRoot":"","sources":["../../src/runtime/trace-queries.tsx"],"names":[],"mappings":"AAcA,OAAO,EAAE,eAAe,EAAE,WAAW,EAAE,iBAAiB,EAAE,SAAS,EAAE,MAAM,kBAAkB,CAAC;AAC9F,OAAO,EAAwB,cAAc,EAAE,MAAM,uBAAuB,CAAC;AAO7E,MAAM,MAAM,oBAAoB,CAAC,UAAU,GAAG,WAAW,IAAI,eAAe,CAAC,YAAY,EAAE,UAAU,CAAC,CAAC;AACvG,eAAO,MAAM,eAAe,eAAe,CAAC;AAE5C,wBAAgB,gBAAgB,CAAC,SAAS,EAAE,iBAAiB,GAAG;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,GAAG,EAAE,MAAM,CAAA;CAAE,CAM7F;AAED;;;;GAIG;AACH,wBAAgB,eAAe,CAAC,WAAW,EAAE,oBAAoB,EAAE,GAAG,KAAK,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC,CA2BrG"}

package/dist/runtime/trace-queries.js

@@ -13,8 +13,10 @@
 import { getUnixTime } from 'date-fns';
 import { useQueries } from '@tanstack/react-query';
 import { useDatasourceStore } from './datasources';
-import { usePluginRegistry } from './plugin-registry';
+import { usePluginRegistry, usePlugins } from './plugin-registry';
 import { useTimeRange } from './TimeRangeProvider';
+import { useAllVariableValues } from './variables';
+import { filterVariableStateMap, getVariableValuesKey } from './utils';
 export const TRACE_QUERY_KEY = 'TraceQuery';
 export function getUnixTimeRange(timeRange) {
     const { start, end } = timeRange;
@@ -29,36 +31,64 @@ export function getUnixTimeRange(timeRange) {
  * Documentation for TraceQL: https://grafana.com/docs/tempo/latest/traceql/
  */ export function useTraceQueries(definitions) {
     const { getPlugin } = usePluginRegistry();
-    const datasourceStore = useDatasourceStore();
-    const { absoluteTimeRange } = useTimeRange();
-    const context = {
-        datasourceStore,
-        absoluteTimeRange
-    };
+    const context = useTraceQueryContext();
+    const pluginLoaderResponse = 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 useQueries({
-        queries: definitions.map((definition)=>{
-            const queryKey = [
+        queries: definitions.map((definition, idx)=>{
+            const plugin = pluginLoaderResponse[idx]?.data;
+            const { queryEnabled, queryKey } = getQueryOptions({
+                context,
                 definition,
-                datasourceStore,
-                absoluteTimeRange
-            ]; // `queryKey` watches and reruns `queryFn` if keys in the array change
+                plugin
+            });
             const traceQueryKind = definition?.spec?.plugin?.kind;
             return {
+                enabled: queryEnabled,
                 queryKey: queryKey,
                 queryFn: async ()=>{
                     const plugin = await getPlugin(TRACE_QUERY_KEY, traceQueryKind);
                     const data = await plugin.getTraceData(definition.spec.plugin.spec, context);
                     return data;
-                },
-                // The data returned by getTraceData() contains circular dependencies (a span has a reference to the parent span, and the parent span has an array of child spans)
-                // Therefore structuralSharing must be turned off, otherwise the query is stuck in the 'fetching' state on re-fetch.
-                // Ref: https://github.com/TanStack/query/issues/6954#issuecomment-1962321426
-                structuralSharing: false
+                }
             };
         })
     });
 }
+function getQueryOptions({ plugin, definition, context }) {
+    const { datasourceStore, variableState, absoluteTimeRange } = context;
+    const dependencies = plugin?.dependsOn ? plugin.dependsOn(definition.spec.plugin.spec, context) : {};
+    const variableDependencies = dependencies?.variables;
+    const filteredVariabledState = filterVariableStateMap(variableState, variableDependencies);
+    const variablesValueKey = getVariableValuesKey(filteredVariabledState);
+    const queryKey = [
+        definition,
+        datasourceStore,
+        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 } = useTimeRange();
+    const variableState = useAllVariableValues();
+    const datasourceStore = useDatasourceStore();
+    return {
+        variableState,
+        datasourceStore,
+        absoluteTimeRange
+    };
+}
 
 //# sourceMappingURL=trace-queries.js.map

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

@@ -1 +1 @@
-{"version":3,"sources":["../../src/runtime/trace-queries.tsx"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { getUnixTime } from 'date-fns';\nimport { QueryDefinition, UnknownSpec, AbsoluteTimeRange, TraceData } from '@perses-dev/core';\nimport { useQueries, UseQueryResult } from '@tanstack/react-query';\nimport { useDatasourceStore } from './datasources';\nimport { usePluginRegistry } from './plugin-registry';\nimport { useTimeRange } from './TimeRangeProvider';\nexport type TraceQueryDefinition<PluginSpec = UnknownSpec> = QueryDefinition<'TraceQuery', PluginSpec>;\nexport const TRACE_QUERY_KEY = 'TraceQuery';\n\nexport function getUnixTimeRange(timeRange: AbsoluteTimeRange): { start: number; end: number } {\n  const { start, end } = timeRange;\n  return {\n    start: Math.ceil(getUnixTime(start)),\n    end: Math.ceil(getUnixTime(end)),\n  };\n}\n\n/**\n * Run a trace query using a TraceQuery plugin and return the results\n * @param definitions: dashboard defintion for a trace query, written in Trace Query Language (TraceQL)\n * Documentation for TraceQL: https://grafana.com/docs/tempo/latest/traceql/\n */\nexport function useTraceQueries(definitions: TraceQueryDefinition[]): Array<UseQueryResult<TraceData>> {\n  const { getPlugin } = usePluginRegistry();\n  const datasourceStore = useDatasourceStore();\n  const { absoluteTimeRange } = useTimeRange();\n\n  const context = {\n    datasourceStore,\n    absoluteTimeRange,\n  };\n\n  // useQueries() handles data fetching from query plugins (e.g. traceQL queries, promQL queries)\n  // https://tanstack.com/query/v4/docs/react/reference/useQuery\n  return useQueries({\n    queries: definitions.map((definition) => {\n      const queryKey = [definition, datasourceStore, absoluteTimeRange] as const; // `queryKey` watches and reruns `queryFn` if keys in the array change\n      const traceQueryKind = definition?.spec?.plugin?.kind;\n      return {\n        queryKey: queryKey,\n        queryFn: async (): Promise<TraceData> => {\n          const plugin = await getPlugin(TRACE_QUERY_KEY, traceQueryKind);\n          const data = await plugin.getTraceData(definition.spec.plugin.spec, context);\n          return data;\n        },\n\n        // The data returned by getTraceData() contains circular dependencies (a span has a reference to the parent span, and the parent span has an array of child spans)\n        // Therefore structuralSharing must be turned off, otherwise the query is stuck in the 'fetching' state on re-fetch.\n        // Ref: https://github.com/TanStack/query/issues/6954#issuecomment-1962321426\n        structuralSharing: false,\n      };\n    }),\n  });\n}\n"],"names":["getUnixTime","useQueries","useDatasourceStore","usePluginRegistry","useTimeRange","TRACE_QUERY_KEY","getUnixTimeRange","timeRange","start","end","Math","ceil","useTraceQueries","definitions","getPlugin","datasourceStore","absoluteTimeRange","context","queries","map","definition","queryKey","traceQueryKind","spec","plugin","kind","queryFn","data","getTraceData","structuralSharing"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,SAASA,WAAW,QAAQ,WAAW;AAEvC,SAASC,UAAU,QAAwB,wBAAwB;AACnE,SAASC,kBAAkB,QAAQ,gBAAgB;AACnD,SAASC,iBAAiB,QAAQ,oBAAoB;AACtD,SAASC,YAAY,QAAQ,sBAAsB;AAEnD,OAAO,MAAMC,kBAAkB,aAAa;AAE5C,OAAO,SAASC,iBAAiBC,SAA4B;IAC3D,MAAM,EAAEC,KAAK,EAAEC,GAAG,EAAE,GAAGF;IACvB,OAAO;QACLC,OAAOE,KAAKC,IAAI,CAACX,YAAYQ;QAC7BC,KAAKC,KAAKC,IAAI,CAACX,YAAYS;IAC7B;AACF;AAEA;;;;CAIC,GACD,OAAO,SAASG,gBAAgBC,WAAmC;IACjE,MAAM,EAAEC,SAAS,EAAE,GAAGX;IACtB,MAAMY,kBAAkBb;IACxB,MAAM,EAAEc,iBAAiB,EAAE,GAAGZ;IAE9B,MAAMa,UAAU;QACdF;QACAC;IACF;IAEA,+FAA+F;IAC/F,8DAA8D;IAC9D,OAAOf,WAAW;QAChBiB,SAASL,YAAYM,GAAG,CAAC,CAACC;YACxB,MAAMC,WAAW;gBAACD;gBAAYL;gBAAiBC;aAAkB,EAAW,sEAAsE;YAClJ,MAAMM,iBAAiBF,YAAYG,MAAMC,QAAQC;YACjD,OAAO;gBACLJ,UAAUA;gBACVK,SAAS;oBACP,MAAMF,SAAS,MAAMV,UAAUT,iBAAiBiB;oBAChD,MAAMK,OAAO,MAAMH,OAAOI,YAAY,CAACR,WAAWG,IAAI,CAACC,MAAM,CAACD,IAAI,EAAEN;oBACpE,OAAOU;gBACT;gBAEA,kKAAkK;gBAClK,oHAAoH;gBACpH,6EAA6E;gBAC7EE,mBAAmB;YACrB;QACF;IACF;AACF"}
+{"version":3,"sources":["../../src/runtime/trace-queries.tsx"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { getUnixTime } from 'date-fns';\nimport { QueryDefinition, UnknownSpec, AbsoluteTimeRange, TraceData } from '@perses-dev/core';\nimport { QueryKey, useQueries, UseQueryResult } from '@tanstack/react-query';\nimport { TraceQueryContext, TraceQueryPlugin } from '../model';\nimport { useDatasourceStore } from './datasources';\nimport { usePluginRegistry, usePlugins } from './plugin-registry';\nimport { useTimeRange } from './TimeRangeProvider';\nimport { useAllVariableValues } from './variables';\nimport { filterVariableStateMap, getVariableValuesKey } from './utils';\nexport type TraceQueryDefinition<PluginSpec = UnknownSpec> = QueryDefinition<'TraceQuery', PluginSpec>;\nexport const TRACE_QUERY_KEY = 'TraceQuery';\n\nexport function getUnixTimeRange(timeRange: AbsoluteTimeRange): { start: number; end: number } {\n  const { start, end } = timeRange;\n  return {\n    start: Math.ceil(getUnixTime(start)),\n    end: Math.ceil(getUnixTime(end)),\n  };\n}\n\n/**\n * Run a trace query using a TraceQuery plugin and return the results\n * @param definitions: dashboard defintion for a trace query, written in Trace Query Language (TraceQL)\n * Documentation for TraceQL: https://grafana.com/docs/tempo/latest/traceql/\n */\nexport function useTraceQueries(definitions: TraceQueryDefinition[]): Array<UseQueryResult<TraceData>> {\n  const { getPlugin } = usePluginRegistry();\n  const context = useTraceQueryContext();\n\n  const pluginLoaderResponse = usePlugins(\n    'TraceQuery',\n    definitions.map((d) => ({ kind: d.spec.plugin.kind }))\n  );\n\n  // useQueries() handles data fetching from query plugins (e.g. traceQL queries, promQL queries)\n  // https://tanstack.com/query/v4/docs/react/reference/useQuery\n  return useQueries({\n    queries: definitions.map((definition, idx) => {\n      const plugin = pluginLoaderResponse[idx]?.data;\n      const { queryEnabled, queryKey } = getQueryOptions({ context, definition, plugin });\n      const traceQueryKind = definition?.spec?.plugin?.kind;\n      return {\n        enabled: queryEnabled,\n        queryKey: queryKey,\n        queryFn: async (): Promise<TraceData> => {\n          const plugin = await getPlugin(TRACE_QUERY_KEY, traceQueryKind);\n          const data = await plugin.getTraceData(definition.spec.plugin.spec, context);\n          return data;\n        },\n      };\n    }),\n  });\n}\n\nfunction getQueryOptions({\n  plugin,\n  definition,\n  context,\n}: {\n  plugin?: TraceQueryPlugin;\n  definition: TraceQueryDefinition;\n  context: TraceQueryContext;\n}): {\n  queryKey: QueryKey;\n  queryEnabled: boolean;\n} {\n  const { datasourceStore, variableState, absoluteTimeRange } = context;\n\n  const dependencies = plugin?.dependsOn ? plugin.dependsOn(definition.spec.plugin.spec, context) : {};\n  const variableDependencies = dependencies?.variables;\n\n  const filteredVariabledState = filterVariableStateMap(variableState, variableDependencies);\n  const variablesValueKey = getVariableValuesKey(filteredVariabledState);\n  const queryKey = [definition, datasourceStore, absoluteTimeRange, variablesValueKey] as const;\n\n  let waitToLoad = false;\n  if (variableDependencies) {\n    waitToLoad = variableDependencies.some((v) => variableState[v]?.loading);\n  }\n\n  const queryEnabled = plugin !== undefined && !waitToLoad;\n  return {\n    queryKey,\n    queryEnabled,\n  };\n}\n\nfunction useTraceQueryContext(): TraceQueryContext {\n  const { absoluteTimeRange } = useTimeRange();\n  const variableState = useAllVariableValues();\n  const datasourceStore = useDatasourceStore();\n\n  return {\n    variableState,\n    datasourceStore,\n    absoluteTimeRange,\n  };\n}\n"],"names":["getUnixTime","useQueries","useDatasourceStore","usePluginRegistry","usePlugins","useTimeRange","useAllVariableValues","filterVariableStateMap","getVariableValuesKey","TRACE_QUERY_KEY","getUnixTimeRange","timeRange","start","end","Math","ceil","useTraceQueries","definitions","getPlugin","context","useTraceQueryContext","pluginLoaderResponse","map","d","kind","spec","plugin","queries","definition","idx","data","queryEnabled","queryKey","getQueryOptions","traceQueryKind","enabled","queryFn","getTraceData","datasourceStore","variableState","absoluteTimeRange","dependencies","dependsOn","variableDependencies","variables","filteredVariabledState","variablesValueKey","waitToLoad","some","v","loading","undefined"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAEjC,SAASA,WAAW,QAAQ,WAAW;AAEvC,SAAmBC,UAAU,QAAwB,wBAAwB;AAE7E,SAASC,kBAAkB,QAAQ,gBAAgB;AACnD,SAASC,iBAAiB,EAAEC,UAAU,QAAQ,oBAAoB;AAClE,SAASC,YAAY,QAAQ,sBAAsB;AACnD,SAASC,oBAAoB,QAAQ,cAAc;AACnD,SAASC,sBAAsB,EAAEC,oBAAoB,QAAQ,UAAU;AAEvE,OAAO,MAAMC,kBAAkB,aAAa;AAE5C,OAAO,SAASC,iBAAiBC,SAA4B;IAC3D,MAAM,EAAEC,KAAK,EAAEC,GAAG,EAAE,GAAGF;IACvB,OAAO;QACLC,OAAOE,KAAKC,IAAI,CAACf,YAAYY;QAC7BC,KAAKC,KAAKC,IAAI,CAACf,YAAYa;IAC7B;AACF;AAEA;;;;CAIC,GACD,OAAO,SAASG,gBAAgBC,WAAmC;IACjE,MAAM,EAAEC,SAAS,EAAE,GAAGf;IACtB,MAAMgB,UAAUC;IAEhB,MAAMC,uBAAuBjB,WAC3B,cACAa,YAAYK,GAAG,CAAC,CAACC,IAAO,CAAA;YAAEC,MAAMD,EAAEE,IAAI,CAACC,MAAM,CAACF,IAAI;QAAC,CAAA;IAGrD,+FAA+F;IAC/F,8DAA8D;IAC9D,OAAOvB,WAAW;QAChB0B,SAASV,YAAYK,GAAG,CAAC,CAACM,YAAYC;YACpC,MAAMH,SAASL,oBAAoB,CAACQ,IAAI,EAAEC;YAC1C,MAAM,EAAEC,YAAY,EAAEC,QAAQ,EAAE,GAAGC,gBAAgB;gBAAEd;gBAASS;gBAAYF;YAAO;YACjF,MAAMQ,iBAAiBN,YAAYH,MAAMC,QAAQF;YACjD,OAAO;gBACLW,SAASJ;gBACTC,UAAUA;gBACVI,SAAS;oBACP,MAAMV,SAAS,MAAMR,UAAUT,iBAAiByB;oBAChD,MAAMJ,OAAO,MAAMJ,OAAOW,YAAY,CAACT,WAAWH,IAAI,CAACC,MAAM,CAACD,IAAI,EAAEN;oBACpE,OAAOW;gBACT;YACF;QACF;IACF;AACF;AAEA,SAASG,gBAAgB,EACvBP,MAAM,EACNE,UAAU,EACVT,OAAO,EAKR;IAIC,MAAM,EAAEmB,eAAe,EAAEC,aAAa,EAAEC,iBAAiB,EAAE,GAAGrB;IAE9D,MAAMsB,eAAef,QAAQgB,YAAYhB,OAAOgB,SAAS,CAACd,WAAWH,IAAI,CAACC,MAAM,CAACD,IAAI,EAAEN,WAAW,CAAC;IACnG,MAAMwB,uBAAuBF,cAAcG;IAE3C,MAAMC,yBAAyBtC,uBAAuBgC,eAAeI;IACrE,MAAMG,oBAAoBtC,qBAAqBqC;IAC/C,MAAMb,WAAW;QAACJ;QAAYU;QAAiBE;QAAmBM;KAAkB;IAEpF,IAAIC,aAAa;IACjB,IAAIJ,sBAAsB;QACxBI,aAAaJ,qBAAqBK,IAAI,CAAC,CAACC,IAAMV,aAAa,CAACU,EAAE,EAAEC;IAClE;IAEA,MAAMnB,eAAeL,WAAWyB,aAAa,CAACJ;IAC9C,OAAO;QACLf;QACAD;IACF;AACF;AAEA,SAASX;IACP,MAAM,EAAEoB,iBAAiB,EAAE,GAAGnC;IAC9B,MAAMkC,gBAAgBjC;IACtB,MAAMgC,kBAAkBpC;IAExB,OAAO;QACLqC;QACAD;QACAE;IACF;AACF"}

package/dist/runtime/utils.d.ts

@@ -0,0 +1,7 @@
+import { VariableStateMap } from './variables';
+export declare function filterVariableStateMap(v: VariableStateMap, names?: string[]): VariableStateMap;
+/**
+ * Returns a serialized string of the current state of variable values.
+ */
+export declare function getVariableValuesKey(v: VariableStateMap): string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/runtime/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../src/runtime/utils.ts"],"names":[],"mappings":"AAaA,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC;AAE/C,wBAAgB,sBAAsB,CAAC,CAAC,EAAE,gBAAgB,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,gBAAgB,CAK9F;AAED;;GAEG;AACH,wBAAgB,oBAAoB,CAAC,CAAC,EAAE,gBAAgB,GAAG,MAAM,CAIhE"}

package/dist/{stories/shared-utils/index.js → runtime/utils.js}

@@ -10,6 +10,16 @@
 // 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.
-export * from './decorators';
+export function filterVariableStateMap(v, names) {
+    if (!names) {
+        return v;
+    }
+    return Object.fromEntries(Object.entries(v).filter(([name])=>names.includes(name)));
+}
+/**
+ * Returns a serialized string of the current state of variable values.
+ */ export function getVariableValuesKey(v) {
+    return Object.values(v).map((v)=>JSON.stringify(v.value)).join(',');
+}
 
-//# sourceMappingURL=index.js.map
+//# sourceMappingURL=utils.js.map

package/dist/runtime/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../../src/runtime/utils.ts"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { VariableStateMap } from './variables';\n\nexport function filterVariableStateMap(v: VariableStateMap, names?: string[]): VariableStateMap {\n  if (!names) {\n    return v;\n  }\n  return Object.fromEntries(Object.entries(v).filter(([name]) => names.includes(name)));\n}\n\n/**\n * Returns a serialized string of the current state of variable values.\n */\nexport function getVariableValuesKey(v: VariableStateMap): string {\n  return Object.values(v)\n    .map((v) => JSON.stringify(v.value))\n    .join(',');\n}\n"],"names":["filterVariableStateMap","v","names","Object","fromEntries","entries","filter","name","includes","getVariableValuesKey","values","map","JSON","stringify","value","join"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAIjC,OAAO,SAASA,uBAAuBC,CAAmB,EAAEC,KAAgB;IAC1E,IAAI,CAACA,OAAO;QACV,OAAOD;IACT;IACA,OAAOE,OAAOC,WAAW,CAACD,OAAOE,OAAO,CAACJ,GAAGK,MAAM,CAAC,CAAC,CAACC,KAAK,GAAKL,MAAMM,QAAQ,CAACD;AAChF;AAEA;;CAEC,GACD,OAAO,SAASE,qBAAqBR,CAAmB;IACtD,OAAOE,OAAOO,MAAM,CAACT,GAClBU,GAAG,CAAC,CAACV,IAAMW,KAAKC,SAAS,CAACZ,EAAEa,KAAK,GACjCC,IAAI,CAAC;AACV"}

package/dist/test-utils/mock-plugin-registry.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../../src/test-utils/mock-plugin-registry.tsx"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { UnknownSpec } from '@perses-dev/core';\nimport { PluginRegistryProps } from '../components';\nimport { PluginModuleResource, Plugin, PluginLoader, PluginImplementation, PluginType } from '../model';\n\nexport type MockPlugin = {\n  [T in PluginType]: {\n    kind: T;\n    spec: { name: string };\n    plugin: PluginImplementation<T>;\n  };\n}[PluginType];\n\n/**\n * Helper for mocking `PluginRegistry` data during tests. Returns props that can be spread on the `PluginRegistry`\n * component so that it will load the mock plugins you provide.\n */\nexport function mockPluginRegistry(...mockPlugins: MockPlugin[]): Omit<PluginRegistryProps, 'children'> {\n  const mockPluginResource: PluginModuleResource = {\n    kind: 'PluginModule',\n    metadata: {\n      name: 'Fake Plugin Module for Tests',\n      version: '0',\n    },\n    spec: {\n      // Add metadata for all mock plugins\n      plugins: mockPlugins.map(({ kind, spec: { name } }) => ({\n        kind,\n        spec: {\n          name,\n          display: {\n            name: getMockPluginName(kind, name),\n          },\n        },\n      })),\n    },\n  };\n\n  const mockPluginModule: Record<string, Plugin<UnknownSpec>> = {};\n  for (const mockPlugin of mockPlugins) {\n    // \"Export\" on the module under the same name as the kind the plugin handles\n    mockPluginModule[mockPlugin.spec.name] = mockPlugin.plugin;\n  }\n\n  const pluginLoader: PluginLoader = {\n    getInstalledPlugins() {\n      return Promise.resolve([mockPluginResource]);\n    },\n    importPluginModule(/* resource */) {\n      return Promise.resolve(mockPluginModule);\n    },\n  };\n\n  return {\n    pluginLoader,\n    defaultPluginKinds: {\n      TimeSeriesQuery: 'PrometheusTimeSeriesQuery',\n    },\n  };\n}\n\n/**\n * The function that's used to generate the display name of mocked plugins in mockPluginRegistry. Can be useful if you\n * need to interact with some UI component that's displaying it.\n */\nexport function getMockPluginName(kind: PluginType, name: string): string {\n  return `${kind} Plugin for ${name}`;\n}\n"],"names":["mockPluginRegistry","mockPlugins","mockPluginResource","kind","metadata","name","version","spec","plugins","map","display","getMockPluginName","mockPluginModule","mockPlugin","plugin","pluginLoader","getInstalledPlugins","Promise","resolve","importPluginModule","defaultPluginKinds","TimeSeriesQuery"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAcjC;;;CAGC,GACD,OAAO,SAASA,mBAAmB,GAAGC,WAAyB;IAC7D,MAAMC,qBAA2C;QAC/CC,MAAM;QACNC,UAAU;YACRC,MAAM;YACNC,SAAS;QACX;QACAC,MAAM;YACJ,oCAAoC;YACpCC,SAASP,YAAYQ,GAAG,CAAC,CAAC,EAAEN,IAAI,EAAEI,MAAM,EAAEF,IAAI,EAAE,EAAE,GAAM,CAAA;oBACtDF;oBACAI,MAAM;wBACJF;wBACAK,SAAS;4BACPL,MAAMM,kBAAkBR,MAAME;wBAChC;oBACF;gBACF,CAAA;QACF;IACF;IAEA,MAAMO,mBAAwD,CAAC;IAC/D,KAAK,MAAMC,cAAcZ,YAAa;QACpC,4EAA4E;QAC5EW,gBAAgB,CAACC,WAAWN,IAAI,CAACF,IAAI,CAAC,GAAGQ,WAAWC,MAAM;IAC5D;IAEA,MAAMC,eAA6B;QACjCC;YACE,OAAOC,QAAQC,OAAO,CAAC;gBAAChB;aAAmB;QAC7C;QACAiB;YACE,OAAOF,QAAQC,OAAO,CAACN;QACzB;IACF;IAEA,OAAO;QACLG;QACAK,oBAAoB;YAClBC,iBAAiB;QACnB;IACF;AACF;AAEA;;;CAGC,GACD,OAAO,SAASV,kBAAkBR,IAAgB,EAAEE,IAAY;IAC9D,OAAO,CAAC,EAAEF,KAAK,YAAY,EAAEE,KAAK,CAAC;AACrC"}
+{"version":3,"sources":["../../src/test-utils/mock-plugin-registry.tsx"],"sourcesContent":["// Copyright 2023 The Perses Authors\n// Licensed under the Apache License, Version 2.0 (the \"License\");\n// you may not use this file except in compliance with the License.\n// You may obtain a copy of the License at\n//\n// http://www.apache.org/licenses/LICENSE-2.0\n//\n// Unless required by applicable law or agreed to in writing, software\n// distributed under the License is distributed on an \"AS IS\" BASIS,\n// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n// See the License for the specific language governing permissions and\n// limitations under the License.\n\nimport { UnknownSpec } from '@perses-dev/core';\nimport { PluginRegistryProps } from '../components';\nimport { PluginModuleResource, Plugin, PluginLoader, PluginImplementation, PluginType } from '../model';\n\nexport type MockPlugin = {\n  [T in PluginType]: {\n    kind: T;\n    spec: { name: string };\n    plugin: PluginImplementation<T>;\n  };\n}[PluginType];\n\n/**\n * Helper for mocking `PluginRegistry` data during tests. Returns props that can be spread on the `PluginRegistry`\n * component so that it will load the mock plugins you provide.\n */\nexport function mockPluginRegistry(...mockPlugins: MockPlugin[]): Omit<PluginRegistryProps, 'children'> {\n  const mockPluginResource: PluginModuleResource = {\n    kind: 'PluginModule',\n    metadata: {\n      name: 'Fake Plugin Module for Tests',\n      version: '0',\n    },\n    spec: {\n      // Add metadata for all mock plugins\n      plugins: mockPlugins.map(({ kind, spec: { name } }) => ({\n        kind,\n        spec: {\n          name,\n          display: {\n            name: getMockPluginName(kind, name),\n          },\n        },\n      })),\n    },\n  };\n\n  const mockPluginModule: Record<string, Plugin<UnknownSpec>> = {};\n  for (const mockPlugin of mockPlugins) {\n    // \"Export\" on the module under the same name as the kind the plugin handles\n    mockPluginModule[mockPlugin.spec.name] = mockPlugin.plugin;\n  }\n\n  const pluginLoader: PluginLoader = {\n    getInstalledPlugins() {\n      return Promise.resolve([mockPluginResource]);\n    },\n    importPluginModule(/* resource */) {\n      return Promise.resolve(mockPluginModule);\n    },\n  };\n\n  return {\n    pluginLoader,\n    defaultPluginKinds: {\n      TimeSeriesQuery: 'PrometheusTimeSeriesQuery',\n    },\n  };\n}\n\n/**\n * The function that's used to generate the display name of mocked plugins in mockPluginRegistry. Can be useful if you\n * need to interact with some UI component that's displaying it.\n */\nexport function getMockPluginName(kind: PluginType, name: string): string {\n  return `${kind} Plugin for ${name}`;\n}\n"],"names":["mockPluginRegistry","mockPlugins","mockPluginResource","kind","metadata","name","version","spec","plugins","map","display","getMockPluginName","mockPluginModule","mockPlugin","plugin","pluginLoader","getInstalledPlugins","Promise","resolve","importPluginModule","defaultPluginKinds","TimeSeriesQuery"],"mappings":"AAAA,oCAAoC;AACpC,kEAAkE;AAClE,mEAAmE;AACnE,0CAA0C;AAC1C,EAAE;AACF,6CAA6C;AAC7C,EAAE;AACF,sEAAsE;AACtE,oEAAoE;AACpE,2EAA2E;AAC3E,sEAAsE;AACtE,iCAAiC;AAcjC;;;CAGC,GACD,OAAO,SAASA,mBAAmB,GAAGC,WAAyB;IAC7D,MAAMC,qBAA2C;QAC/CC,MAAM;QACNC,UAAU;YACRC,MAAM;YACNC,SAAS;QACX;QACAC,MAAM;YACJ,oCAAoC;YACpCC,SAASP,YAAYQ,GAAG,CAAC,CAAC,EAAEN,IAAI,EAAEI,MAAM,EAAEF,IAAI,EAAE,EAAE,GAAM,CAAA;oBACtDF;oBACAI,MAAM;wBACJF;wBACAK,SAAS;4BACPL,MAAMM,kBAAkBR,MAAME;wBAChC;oBACF;gBACF,CAAA;QACF;IACF;IAEA,MAAMO,mBAAwD,CAAC;IAC/D,KAAK,MAAMC,cAAcZ,YAAa;QACpC,4EAA4E;QAC5EW,gBAAgB,CAACC,WAAWN,IAAI,CAACF,IAAI,CAAC,GAAGQ,WAAWC,MAAM;IAC5D;IAEA,MAAMC,eAA6B;QACjCC;YACE,OAAOC,QAAQC,OAAO,CAAC;gBAAChB;aAAmB;QAC7C;QACAiB;YACE,OAAOF,QAAQC,OAAO,CAACN;QACzB;IACF;IAEA,OAAO;QACLG;QACAK,oBAAoB;YAClBC,iBAAiB;QACnB;IACF;AACF;AAEA;;;CAGC,GACD,OAAO,SAASV,kBAAkBR,IAAgB,EAAEE,IAAY;IAC9D,OAAO,GAAGF,KAAK,YAAY,EAAEE,MAAM;AACrC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@perses-dev/plugin-system",
-  "version": "0.51.0-beta.0",
+  "version": "0.51.0-rc.0",
   "description": "The plugin feature in Pereses",
   "license": "Apache-2.0",
   "homepage": "https://github.com/perses/perses/blob/main/README.md",
@@ -29,18 +29,16 @@
   },
   "dependencies": {
     "@module-federation/enhanced": "^0.8.9",
-    "@perses-dev/components": "0.51.0-beta.0",
-    "@perses-dev/core": "0.51.0-beta.0",
-    "date-fns": "^2.30.0",
-    "immer": "^9.0.15",
+    "@perses-dev/components": "0.51.0-rc.0",
+    "@perses-dev/core": "0.51.0-rc.0",
+    "date-fns": "^4.1.0",
+    "date-fns-tz": "^3.2.0",
+    "immer": "^10.1.1",
     "react-hook-form": "^7.46.1",
-    "use-immer": "^0.7.0",
+    "use-immer": "^0.11.0",
     "use-query-params": "^2.1.2",
     "zod": "^3.22.2"
   },
-  "devDependencies": {
-    "@perses-dev/storybook": "0.51.0-beta.0"
-  },
   "peerDependencies": {
     "@mui/material": "^6.1.10",
     "@tanstack/react-query": "^5.64.2",

package/dist/cjs/stories/shared-utils/decorators/WithDataQueries.js

@@ -1,41 +0,0 @@
-// Copyright 2023 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, "WithDataQueries", {
-    enumerable: true,
-    get: function() {
-        return WithDataQueries;
-    }
-});
-const _jsxruntime = require("react/jsx-runtime");
-const _pluginsystem = require("@perses-dev/plugin-system");
-// Type guard because storybook types parameters as `any`
-function isWithDataQueriesParameter(parameter) {
-    return !!parameter && typeof parameter === 'object' && 'props' in parameter;
-}
-const WithDataQueries = (Story, context)=>{
-    const initParameter = context.parameters.withDataQueries;
-    const parameter = isWithDataQueriesParameter(initParameter) ? initParameter : {
-        props: {
-            definitions: []
-        }
-    };
-    const props = parameter?.props;
-    return /*#__PURE__*/ (0, _jsxruntime.jsx)(_pluginsystem.DataQueriesProvider, {
-        ...props,
-        children: /*#__PURE__*/ (0, _jsxruntime.jsx)(Story, {})
-    });
-};

package/dist/cjs/stories/shared-utils/decorators/WithPluginRegistry.js

@@ -1,34 +0,0 @@
-// Copyright 2023 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, "WithPluginRegistry", {
-    enumerable: true,
-    get: function() {
-        return WithPluginRegistry;
-    }
-});
-const _jsxruntime = require("react/jsx-runtime");
-const _pluginsystem = require("@perses-dev/plugin-system");
-const WithPluginRegistry = (Story)=>{
-    return /*#__PURE__*/ (0, _jsxruntime.jsx)(_pluginsystem.PluginRegistry, {
-        pluginLoader: (0, _pluginsystem.remotePluginLoader)(),
-        defaultPluginKinds: {
-            TimeSeriesQuery: 'PrometheusTimeSeriesQuery',
-            TraceQuery: 'TempoTraceQuery'
-        },
-        children: /*#__PURE__*/ (0, _jsxruntime.jsx)(Story, {})
-    });
-};

package/dist/cjs/stories/shared-utils/decorators/WithPluginSystemBuiltinVariables.js

@@ -1,42 +0,0 @@
-// Copyright 2023 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, "WithPluginSystemBuiltinVariables", {
-    enumerable: true,
-    get: function() {
-        return WithPluginSystemBuiltinVariables;
-    }
-});
-const _jsxruntime = require("react/jsx-runtime");
-const _runtime = require("../../../runtime");
-// Type guard because storybook types parameters as `any`
-function isWithBuiltinVariableParameter(parameter) {
-    return !!parameter && Array.isArray(parameter);
-}
-const WithPluginSystemBuiltinVariables = (Story, context)=>{
-    const initParameter = context.parameters.withPluginSystemBuiltinVariables;
-    const defaultValue = {
-        variables: []
-    };
-    const parameter = isWithBuiltinVariableParameter(initParameter) ? initParameter : {
-        props: defaultValue
-    };
-    const props = parameter?.props;
-    return /*#__PURE__*/ (0, _jsxruntime.jsx)(_runtime.BuiltinVariableContext.Provider, {
-        value: props,
-        children: /*#__PURE__*/ (0, _jsxruntime.jsx)(Story, {})
-    });
-};