Small Plugin Cleanup (#206)

* Clean-up tsconfig a bit Signed-off-by: Luke Tillman <LukeTillman@users.noreply.github.com> * Also use build flag Signed-off-by: Luke Tillman <LukeTillman@users.noreply.github.com> * Remove 'Kind' type parameter from definitions Signed-off-by: Luke Tillman <LukeTillman@users.noreply.github.com> * Add runtime plugin type list, generate registry state from it Signed-off-by: Luke Tillman <LukeTillman@users.noreply.github.com> * Use browser access to get H2 support Signed-off-by: Luke Tillman <LukeTillman@users.noreply.github.com> * Turn on H2 in webpack dev server Signed-off-by: Luke Tillman <LukeTillman@users.noreply.github.com> * Allow turning on H2 via ENV var Signed-off-by: Luke Tillman <LukeTillman@users.noreply.github.com> * Turn off refetch on window focus Signed-off-by: Luke Tillman <LukeTillman@users.noreply.github.com> * Remove Kind/casting from DataSource Signed-off-by: Luke Tillman <LukeTillman@users.noreply.github.com> * Add shared jest config with mapper for project refs Signed-off-by: Luke Tillman <LukeTillman@users.noreply.github.com> * Use an .nvmrc file Signed-off-by: Luke Tillman <LukeTillman@users.noreply.github.com> * Use paths config in test tsconfig Signed-off-by: Luke Tillman <LukeTillman@users.noreply.github.com>
perses · Dec 9, 2021 · 37468fe · 37468fe
1 parent 68c020b
commit 37468fe
Show file tree

Hide file tree

Showing 38 changed files with 224 additions and 173 deletions.
diff --git a/.github/workflows/build.yaml b/.github/workflows/build.yaml
@@ -14,7 +14,7 @@ jobs:
       - name: install nodejs
         uses: actions/setup-node@v2
         with:
-          node-version: '16'
+          node-version-file: "ui/.nvmrc"
       - uses: actions/cache@v2
         with:
           path: ~/.npm

diff --git a/.github/workflows/react.yml b/.github/workflows/react.yml
@@ -9,21 +9,21 @@ jobs:
     name: lint
     runs-on: ubuntu-latest
     steps:
-    - name: checkout
-      uses: actions/checkout@v2
-    - name: install nodejs
-      uses: actions/setup-node@v2
-      with:
-        node-version: '16'
-    - uses: actions/cache@v2
-      with:
-        path: ~/.npm
-        key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
-        restore-keys: |
-          ${{ runner.os }}-node-
-    - name: install deps
-      run: cd ./ui && npm ci
-    - run: cd ./ui && npm run lint
+      - name: checkout
+        uses: actions/checkout@v2
+      - name: install nodejs
+        uses: actions/setup-node@v2
+        with:
+          node-version-file: "ui/.nvmrc"
+      - uses: actions/cache@v2
+        with:
+          path: ~/.npm
+          key: ${{ runner.os }}-node-${{ hashFiles('**/package-lock.json') }}
+          restore-keys: |
+            ${{ runner.os }}-node-
+      - name: install deps
+        run: cd ./ui && npm ci
+      - run: cd ./ui && npm run lint
   test:
     name: "unit test"
     runs-on: ubuntu-latest
@@ -33,7 +33,7 @@ jobs:
       - name: install nodejs
         uses: actions/setup-node@v2
         with:
-          node-version: '16'
+          node-version-file: "ui/.nvmrc"
       - uses: actions/cache@v2
         with:
           path: ~/.npm

diff --git a/dev/data/globaldatasource.json b/dev/data/globaldatasource.json
@@ -12,6 +12,20 @@
       }
     }
   },
+  {
+    "kind": "GlobalDatasource",
+    "metadata": {
+      "name": "PrometheusDemoBrowser"
+    },
+    "spec": {
+      "kind": "Prometheus",
+      "default": false,
+      "http": {
+        "access": "browser",
+        "url": "https://prometheus.demo.do.prometheus.io"
+      }
+    }
+  },
   {
     "kind": "GlobalDatasource",
     "metadata": {

diff --git a/ui/.nvmrc b/ui/.nvmrc
@@ -0,0 +1 @@
+v16.13.1
diff --git a/ui/app/jest.config.ts b/ui/app/jest.config.ts
@@ -0,0 +1,17 @@
+// Copyright 2021 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.
+
+import shared from '../jest.shared';
+
+// Just use shared config as-is for now
+export default shared;
diff --git a/ui/app/package.json b/ui/app/package.json
@@ -49,15 +49,5 @@
     "webpack-cli": "^4.9.1",
     "webpack-dev-server": "^4.6.0",
     "webpack-merge": "^5.8.0"
-  },
-  "jest": {
-    "preset": "ts-jest",
-    "testRegex": "(/__tests__/.*|\\.(test|spec))\\.(ts|tsx|js|jsx)$",
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js",
-      "jsx"
-    ]
   }
 }
diff --git a/ui/app/src/context/plugin-registry/create-plugin.tsx b/ui/app/src/context/plugin-registry/create-plugin.tsx
@@ -28,8 +28,8 @@ import {
  * Take a Variable plugin and wrap it so it works with AnyVariableDefinition,
  * doing runtime checking of the definition before delegating to the plugin.
  */
-export function createVariablePlugin<Kind extends string, Options extends JsonObject>(
-  config: PluginConfig<'Variable', Kind, Options>
+export function createVariablePlugin<Options extends JsonObject>(
+  config: PluginConfig<'Variable', Options>
 ): AnyPluginImplementation<'Variable'> {
   // Create runtime validation function
   const useRuntimeValidation = createValidationHook(config);
@@ -53,14 +53,14 @@ export function createVariablePlugin<Kind extends string, Options extends JsonOb
  * Take a Panel plugin and wraps it so it works with AnyPanelDefinition, doing
  * runtime checking of the definition before delegating to the plugin.
  */
-export function createPanelPlugin<Kind extends string, Options extends JsonObject>(
-  config: PluginConfig<'Panel', Kind, Options>
+export function createPanelPlugin<Options extends JsonObject>(
+  config: PluginConfig<'Panel', Options>
 ): AnyPluginImplementation<'Panel'> {
   const useRuntimeValidation = createValidationHook(config);
 
   // Wrap PanelComponent from config with validation (TODO: Can this wrapper
   // become generic for all Plugin components?)
-  function PanelComponent(props: PanelProps<string, JsonObject>) {
+  function PanelComponent(props: PanelProps<JsonObject>) {
     const { definition, ...others } = props;
 
     const { isValid, errorRef } = useRuntimeValidation();
@@ -80,8 +80,8 @@ export function createPanelPlugin<Kind extends string, Options extends JsonObjec
  * Take a GraphQuery plugin and wrap it so it works with AnyChartQueryDefinition,
  * doing runtime validation of the definition before delegating to the plugin.
  */
-export function createGraphQueryPlugin<Kind extends string, Options extends JsonObject>(
-  config: PluginConfig<'GraphQuery', Kind, Options>
+export function createGraphQueryPlugin<Options extends JsonObject>(
+  config: PluginConfig<'GraphQuery', Options>
 ): AnyPluginImplementation<'GraphQuery'> {
   // Create runtime validation function
   const useRuntimeValidation = createValidationHook(config);
@@ -102,23 +102,23 @@ export function createGraphQueryPlugin<Kind extends string, Options extends Json
 }
 
 // A hook for doing runtime validation of a PluginDefinition
-type UseRuntimeValidationHook<Type extends PluginType, Kind extends string, Options extends JsonObject> = () => {
-  isValid: (definition: AnyPluginDefinition<Type>) => definition is PluginDefinition<Type, Kind, Options>;
+type UseRuntimeValidationHook<Type extends PluginType, Options extends JsonObject> = () => {
+  isValid: (definition: AnyPluginDefinition<Type>) => definition is PluginDefinition<Type, Options>;
   errorRef: React.MutableRefObject<InvalidPluginDefinitionError | undefined>;
 };
 
 // Create a hook for doing runtime validation of a plugin definition, given the
 // plugin's config
-function createValidationHook<Type extends PluginType, Kind extends string, Options extends JsonObject>(
-  config: PluginConfig<Type, Kind, Options>
-): UseRuntimeValidationHook<Type, Kind, Options> {
+function createValidationHook<Type extends PluginType, Options extends JsonObject>(
+  config: PluginConfig<Type, Options>
+): UseRuntimeValidationHook<Type, Options> {
   const useRuntimeValidation = () => {
     // Ref for storing any validation errors as a side-effect of calling isValid
     const errorRef = useRef<InvalidPluginDefinitionError | undefined>(undefined);
 
     // Type guard that validates the generic runtime plugin definition data
     // is correct for Kind/Options
-    const isValid = (definition: AnyPluginDefinition<Type>): definition is PluginDefinition<Type, Kind, Options> => {
+    const isValid = (definition: AnyPluginDefinition<Type>): definition is PluginDefinition<Type, Options> => {
       // If they don't give us a validate function in the plugin config, not
       // much we can do so just assume we're OK
       const validateErrors = config.validate?.(definition) ?? [];

diff --git a/ui/app/src/context/plugin-registry/registry-state.ts b/ui/app/src/context/plugin-registry/registry-state.ts
@@ -21,6 +21,7 @@ import {
   PluginType,
   AnyPluginImplementation,
   JsonObject,
+  ALL_PLUGIN_TYPES,
 } from '@perses-ui/core';
 import { BUNDLED_PLUGINS } from './bundled-plugins';
 import { createGraphQueryPlugin, createPanelPlugin, createVariablePlugin } from './create-plugin';
@@ -43,11 +44,10 @@ export function useRegistryState(installedPlugins: PluginResource[]) {
   // Go through all installed plugins and bundled plugins and build an index of
   // those resources by type and kind
   const loadablePlugins = useMemo(() => {
-    const loadableProps: PluginResourcesByTypeAndKind = {
-      Variable: new Map(),
-      Panel: new Map(),
-      GraphQuery: new Map(),
-    };
+    const loadableProps = {} as PluginResourcesByTypeAndKind;
+    for (const pluginType of ALL_PLUGIN_TYPES) {
+      loadableProps[pluginType] = new Map();
+    }
 
     const addToLoadable = (resource: PluginResource) => {
       const supportedKinds = resource.spec.supported_kinds;
@@ -75,15 +75,17 @@ export function useRegistryState(installedPlugins: PluginResource[]) {
     return loadableProps;
   }, [installedPlugins]);
 
-  const [plugins, setPlugins] = useImmer<LoadedPluginsByTypeAndKind>(() => ({
-    Variable: new Map(),
-    Panel: new Map(),
-    GraphQuery: new Map(),
-  }));
+  const [plugins, setPlugins] = useImmer<LoadedPluginsByTypeAndKind>(() => {
+    const loadedPlugins = {} as LoadedPluginsByTypeAndKind;
+    for (const pluginType of ALL_PLUGIN_TYPES) {
+      loadedPlugins[pluginType] = new Map();
+    }
+    return loadedPlugins;
+  });
 
   // Create the register callback to pass to the module's setup function
   const registerPlugin: RegisterPlugin = useCallback(
-    <Kind extends string, Options extends JsonObject>(config: PluginRegistrationConfig<Kind, Options>) => {
+    <Options extends JsonObject>(config: PluginRegistrationConfig<Options>) => {
       switch (config.pluginType) {
         case 'Variable':
           setPlugins((draft) => {

diff --git a/ui/app/src/index.tsx b/ui/app/src/index.tsx
@@ -20,7 +20,7 @@ import App from './App';
 import { createTheme } from './styles/theme';
 import { SnackbarProvider } from './context/SnackbarProvider';
 
-const queryClient = new QueryClient();
+const queryClient = new QueryClient({ defaultOptions: { queries: { refetchOnWindowFocus: false } } });
 
 function renderApp() {
   ReactDOM.render(

diff --git a/ui/app/tsconfig.json b/ui/app/tsconfig.json
@@ -4,9 +4,12 @@
   "compilerOptions": {
     "sourceMap": true,
     "outDir": "./dist",
-    "rootDir": "../",
     "tsBuildInfoFile": "../.build-cache/app.tsbuildinfo",
-    "incremental": true
+    "incremental": true,
+    // Don't need composite since the app is an endpoint project
+    "composite": false,
+    "declaration": false,
+    "declarationMap": false
   },
   "references": [
     {
@@ -21,13 +24,5 @@
       "path": "../prometheus-plugin",
       "prepend": false
     }
-  ],
-  // For webpack builds that use ts-node to compile the configs
-  "ts-node": {
-    "compilerOptions": {
-      "module": "commonjs",
-      "target": "es5",
-      "esModuleInterop": true
-    }
-  }
+  ]
 }
diff --git a/ui/app/webpack.common.ts b/ui/app/webpack.common.ts
@@ -35,6 +35,7 @@ export const commonConfig: Configuration = {
     new ForkTsCheckerWebpackPlugin({
       typescript: {
         configFile: path.resolve(__dirname, './tsconfig.json'),
+        build: true, // Since we use project references...
       },
       eslint: {
         files: '../*/src/**/*.{ts,tsx,js,jsx}',

diff --git a/ui/app/webpack.dev.ts b/ui/app/webpack.dev.ts
@@ -60,6 +60,7 @@ const devConfig: Configuration = {
     port: parseInt(process.env.PORT ?? '3000'),
     open: true,
     https: getHttpsConfig(),
+    http2: process.env.HTTP2 === 'true',
     historyApiFallback: true,
     allowedHosts: 'all',
     proxy: {

diff --git a/ui/core/src/hooks/datasource.ts b/ui/core/src/hooks/datasource.ts
@@ -19,10 +19,10 @@ export function useDataSources(selector: DatasourceSelector): GlobalDatasourceMo
   return usePluginRuntime('useDataSources')(selector);
 }
 
-export function useDataSourceConfig<Kind extends string>(
+export function useDataSourceConfig<T extends DatasourceSpecDefinition>(
   selector: DatasourceSelector,
-  validate: (value: AnyDatasourceSpecDefinition) => value is DatasourceSpecDefinition<Kind>
-): DatasourceSpecDefinition<Kind> {
+  validate: (value: AnyDatasourceSpecDefinition) => value is T
+): T {
   const datasources = useDataSources(selector);
 
   if (datasources.length !== 1 || datasources[0] === undefined) {

diff --git a/ui/core/src/hooks/graph-query.ts b/ui/core/src/hooks/graph-query.ts
@@ -15,6 +15,6 @@ import { usePluginRuntime } from '../context/PluginRuntimeContext';
 import { UseGraphQueryHook } from '../model/graph-query';
 import { JsonObject } from '../model/definitions';
 
-export const useGraphQuery: UseGraphQueryHook<string, JsonObject> = (definition) => {
+export const useGraphQuery: UseGraphQueryHook<JsonObject> = (definition) => {
   return usePluginRuntime('useGraphQuery')(definition);
 };
diff --git a/ui/core/src/model/datasource.ts b/ui/core/src/model/datasource.ts
@@ -13,12 +13,13 @@
 
 import { Metadata, ProjectMetadata } from './resource';
 
-export interface DatasourceSpecDefinition<Kind extends string> {
-  kind: Kind;
+// TODO: Should use Definition<> and JsonObject?
+export interface DatasourceSpecDefinition {
+  kind: string;
   default: boolean;
 }
 
-export type AnyDatasourceSpecDefinition = DatasourceSpecDefinition<string>;
+export type AnyDatasourceSpecDefinition = DatasourceSpecDefinition;
 
 export interface DatasourceModel {
   kind: 'Datasource';

diff --git a/ui/core/src/model/definitions.ts b/ui/core/src/model/definitions.ts
@@ -26,7 +26,7 @@ export type Json = string | number | boolean | null | JsonObject | Json[];
 /**
  * Base type for definitions in JSON config resources.
  */
-export interface Definition<Kind extends string, Options extends JsonObject> extends JsonObject {
-  kind: Kind;
+export interface Definition<Options extends JsonObject> extends JsonObject {
+  kind: string;
   options: Options;
 }
diff --git a/ui/core/src/model/graph-query.ts b/ui/core/src/model/graph-query.ts
@@ -16,18 +16,15 @@ import { Definition, JsonObject } from './definitions';
 import { AnyPluginDefinition, AnyPluginImplementation } from './plugins';
 import { ResourceSelector } from './resource';
 
-export interface GraphQueryDefinition<Kind extends string, Options extends JsonObject>
-  extends Definition<Kind, Options> {
+export interface GraphQueryDefinition<Options extends JsonObject> extends Definition<Options> {
   datasource?: ResourceSelector;
 }
 
-export interface GraphQueryPlugin<Kind extends string, Options extends JsonObject> {
-  useGraphQuery: UseGraphQueryHook<Kind, Options>;
+export interface GraphQueryPlugin<Options extends JsonObject> {
+  useGraphQuery: UseGraphQueryHook<Options>;
 }
 
-export type UseGraphQueryHook<Kind extends string, Options extends JsonObject> = (
-  definition: GraphQueryDefinition<Kind, Options>
-) => {
+export type UseGraphQueryHook<Options extends JsonObject> = (definition: GraphQueryDefinition<Options>) => {
   data?: GraphData;
   loading: boolean;
   error?: Error;

diff --git a/ui/core/src/model/panels.ts b/ui/core/src/model/panels.ts
@@ -14,7 +14,7 @@
 import { Definition, JsonObject } from './definitions';
 import { AnyPluginDefinition, AnyPluginImplementation } from './plugins';
 
-export interface PanelDefinition<Kind extends string, Options extends JsonObject> extends Definition<Kind, Options> {
+export interface PanelDefinition<Options extends JsonObject> extends Definition<Options> {
   display: {
     name: string;
   };
@@ -23,16 +23,14 @@ export interface PanelDefinition<Kind extends string, Options extends JsonObject
 /**
  * Plugin the provides custom visualizations inside of a Panel.
  */
-export interface PanelPlugin<Kind extends string, Options extends JsonObject> {
-  PanelComponent: PanelComponent<Kind, Options>;
+export interface PanelPlugin<Options extends JsonObject> {
+  PanelComponent: PanelComponent<Options>;
 }
 
-export type PanelComponent<Kind extends string, Options extends JsonObject> = React.ComponentType<
-  PanelProps<Kind, Options>
->;
+export type PanelComponent<Options extends JsonObject> = React.ComponentType<PanelProps<Options>>;
 
-export interface PanelProps<Kind extends string, Options extends JsonObject> {
-  definition: PanelDefinition<Kind, Options>;
+export interface PanelProps<Options extends JsonObject> {
+  definition: PanelDefinition<Options>;
 }
 
 export type AnyPanelDefinition = AnyPluginDefinition<'Panel'>;