Merge remote-tracking branch 'origin' into add-llm-scenes-app-example

Author: nmarrs

.github/dependabot.yml

@@ -72,43 +72,11 @@ updates:
     open-pull-requests-limit: 3
     reviewers:
       - "grafana/plugins-platform-frontend"
-  
-  - package-ecosystem: "npm"
-    directory: "/panel-flot"
-    schedule:
-      interval: "monthly"
-    open-pull-requests-limit: 3
-    reviewers:
-      - "grafana/plugins-platform-frontend"
 
   - package-ecosystem: "npm"
     directory: "/panel-frame-select"
     schedule:
       interval: "monthly"
     open-pull-requests-limit: 3
     reviewers:
-      - "grafana/plugins-platform-frontend"
-  
-  - package-ecosystem: "npm"
-    directory: "/panel-plotly"
-    schedule:
-      interval: "monthly"
-    open-pull-requests-limit: 3
-    reviewers:
-      - "grafana/plugins-platform-frontend"
-  
-  - package-ecosystem: "npm"
-    directory: "/panel-scatterplot"
-    schedule:
-      interval: "monthly"
-    open-pull-requests-limit: 3
-    reviewers:
-      - "grafana/plugins-platform-frontend"    
-  
-  - package-ecosystem: "npm"
-    directory: "/panel-visx"
-    schedule:
-      interval: "monthly"
-    open-pull-requests-limit: 3
-    reviewers:
-      - "grafana/plugins-platform-frontend"        
+      - "grafana/plugins-platform-frontend"

.github/workflows/integration-tests.yml

@@ -1,8 +1,5 @@
 .vscode
 node_modules
-**/cypress/videos
-**/cypress/report.json
-**/cypress/screenshots/actual/
 .DS_Store
 **/test-results/
 **/playwright-report/

.gitignore

@@ -19,11 +19,7 @@ This repository contains example plugins to showcase different use cases.
 
 | Example                                           | Description                                                                                                                       |
 | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
-| [panel-flot](examples/panel-flot)                 | Shows how to use the [Flot](http://www.flotcharts.org) plotting library in a panel plugin.                                        |
 | [panel-frame-select](examples/panel-frame-select) | Shows how to update panel options with values from a data query response.                                                         |
-| [panel-plotly](examples/panel-plotly)             | Shows how to use the [Plotly](https://plotly.com/javascript/) graphing library in a panel plugin.                                 |
-| [panel-scatterplot](examples/panel-scatterplot)   | Shows how to use D3 and SVG to create a scatter plot panel.                                                                       |
-| [panel-visx](examples/panel-visx)                 | Shows how to use [visx](https://github.com/airbnb/visx) to create a time series graph.                                            |
 | [panel-basic](examples/panel-basic)               | Shows how to build a panel plugin that uses the time series graph from `@grafana/ui` to read and update the dashboard time range. |
 | [panel-datalinks](examples/panel-datalinks)       | Shows how to build a panel plugin that uses the datalinks functionality of Grafana.                                               |
 
@@ -42,11 +38,9 @@ This repository contains example plugins to showcase different use cases.
 
 ## Integration tests
 
-Some of the examples in this repository contain integration tests that make use of [`@grafana/e2e`](https://npmjs.com/package/@grafana/e2e) package. These tests can be run individually by navigating to the example plugin and running one of the following commands:
+Some of the examples in this repository contain integration tests that make use of [`@grafana/plugin-e2e`](https://npmjs.com/package/@grafana/plugin-e2e) package. These tests can be run individually by navigating to the example plugin and running one of the following commands:
 
-- `npm run e2e` - run integration tests
-- `npm run e2e:open` - open cypress ui and run integration tests
-- `npm run e2e:update` - run integration tests and update any screenshots
+- `npm run e2e` - run Playwright e2e tests
 
 ### Testing against latest versions of Grafana
 
@@ -98,17 +92,17 @@ jobs:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
         with:
-          node-version: "20"
+          node-version: '20'
       - name: Install dependencies
         run: npm install
       - name: Build plugin
         run: npm run build
       - name: Compatibility check
         uses: grafana/plugin-actions/is-compatible@v1
         with:
-          module: "./src/module.ts"
-          comment-pr: "yes"
-          fail-if-incompatible: "no"
+          module: './src/module.ts'
+          comment-pr: 'yes'
+          fail-if-incompatible: 'no'
 ```
 
 This runs a compatibility check for the latest release of Grafana plugins API in your project every time a new push or pull request is open. If it finds an error you will see a message indicating you have an incompatibility.

README.md

@@ -1,3 +1,3 @@
 {
-  "version": "3.5.0"
+  "version": "4.10.4"
 }

examples/app-basic/.config/.cprc.json

@@ -3,6 +3,11 @@ ARG grafana_image=grafana-enterprise
 
 FROM grafana/${grafana_image}:${grafana_version}
 
+ARG development=false
+
+
+ENV DEV "${development}"
+
 # Make it as simple as possible to access the grafana instance for development purposes
 # Do NOT enable these settings in a public facing / production grafana instance
 ENV GF_AUTH_ANONYMOUS_ORG_ROLE "Admin"
@@ -11,6 +16,37 @@ ENV GF_AUTH_BASIC_ENABLED "false"
 # Set development mode so plugins can be loaded without the need to sign
 ENV GF_DEFAULT_APP_MODE "development"
 
-# Inject livereload script into grafana index.html
+
+LABEL maintainer="Grafana Labs <[email protected]>"
+
+ENV GF_PATHS_HOME="/usr/share/grafana"
+WORKDIR $GF_PATHS_HOME
+
 USER root
+
+# Installing supervisor and inotify-tools
+RUN if [ "${development}" = "true" ]; then \
+    if grep -i -q alpine /etc/issue; then \
+        apk add supervisor inotify-tools git; \
+    elif grep -i -q ubuntu /etc/issue; then \
+      DEBIAN_FRONTEND=noninteractive && \
+      apt-get update && \
+      apt-get install -y supervisor inotify-tools git && \
+      rm -rf /var/lib/apt/lists/*; \
+    else \
+      echo 'ERROR: Unsupported base image' && /bin/false; \
+    fi \
+    fi
+
+COPY supervisord/supervisord.conf /etc/supervisor.d/supervisord.ini
+COPY supervisord/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
+
+
+
+# Inject livereload script into grafana index.html
 RUN sed -i 's|</body>|<script src="http://localhost:35729/livereload.js"></script></body>|g' /usr/share/grafana/public/views/index.html
+
+
+COPY entrypoint.sh /entrypoint.sh
+RUN chmod +x /entrypoint.sh
+ENTRYPOINT ["/entrypoint.sh"]

examples/app-basic/.config/Dockerfile

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+if [ "${DEV}" = "false" ]; then
+    echo "Starting test mode"
+    exec /run.sh
+fi
+
+echo "Starting development mode"
+
+if grep -i -q alpine /etc/issue; then
+    exec /usr/bin/supervisord -c /etc/supervisord.conf
+elif grep -i -q ubuntu /etc/issue; then
+    exec /usr/bin/supervisord -c /etc/supervisor/supervisord.conf
+else
+    echo 'ERROR: Unsupported base image'
+    exit 1
+fi
+

examples/app-basic/.config/entrypoint.sh

@@ -6,6 +6,9 @@
  */
 
 import '@testing-library/jest-dom';
+import { TextEncoder, TextDecoder } from 'util';
+                                                                                                          
+Object.assign(global, { TextDecoder, TextEncoder });
 
 // https://jestjs.io/docs/manual-mocks#mocking-methods-which-are-not-implemented-in-jsdom
 Object.defineProperty(global, 'matchMedia', {

examples/app-basic/.config/jest-setup.js

@@ -0,0 +1,15 @@
+[supervisord]
+nodaemon=true
+user=root
+
+[program:grafana]
+user=root
+directory=/var/lib/grafana
+command=/run.sh
+stdout_logfile=/dev/fd/1
+stdout_logfile_maxbytes=0
+redirect_stderr=true
+killasgroup=true
+stopasgroup=true
+autostart=true
+

examples/app-basic/.config/supervisord/supervisord.conf

@@ -12,6 +12,7 @@ import LiveReloadPlugin from 'webpack-livereload-plugin';
 import path from 'path';
 import ReplaceInFileWebpackPlugin from 'replace-in-file-webpack-plugin';
 import { Configuration } from 'webpack';
+import { GrafanaPluginMetaExtractor } from '@grafana/plugin-meta-extractor';
 
 import { getPackageJson, getPluginJson, hasReadme, getEntries, isWSL } from './utils';
 import { SOURCE_DIR, DIST_DIR } from './constants';
@@ -139,6 +140,7 @@ const config = async (env): Promise<Configuration> => {
     },
 
     plugins: [
+      new GrafanaPluginMetaExtractor(),
       new CopyWebpackPlugin({
         patterns: [
           // If src/README.md exists use it; otherwise the root README