Skip to content

Commit 44d0b7f

Browse files
dependencies update (#236)
* dependencies update * Update create plugin to latest * Add missing EOL * Remove unnecessary config * package.json changes * Fix test warning --------- Co-authored-by: Zoltán Bedi <zoltan.bedi@gmail.com>
1 parent 41aeca1 commit 44d0b7f

19 files changed

+3493
-3173
lines changed

.config/.cprc.json

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"version": "4.12.0"
3+
}

.config/.eslintrc

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,24 @@
22
* ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
33
*
44
* In order to extend the configuration follow the steps in
5-
* https://grafana.github.io/plugin-tools/docs/advanced-configuration#extending-the-eslint-config
5+
* https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations#extend-the-eslint-config
66
*/
77
{
88
"extends": ["@grafana/eslint-config"],
99
"root": true,
1010
"rules": {
1111
"react/prop-types": "off"
12-
}
12+
},
13+
"overrides": [
14+
{
15+
"plugins": ["deprecation"],
16+
"files": ["src/**/*.{ts,tsx}"],
17+
"rules": {
18+
"deprecation/deprecation": "warn"
19+
},
20+
"parserOptions": {
21+
"project": "./tsconfig.json"
22+
}
23+
}
24+
]
1325
}

.config/Dockerfile

Lines changed: 61 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,13 @@ ARG grafana_image=grafana-enterprise
33

44
FROM grafana/${grafana_image}:${grafana_version}
55

6+
ARG development=false
7+
8+
ARG GO_VERSION=1.21.6
9+
ARG GO_ARCH=amd64
10+
11+
ENV DEV "${development}"
12+
613
# Make it as simple as possible to access the grafana instance for development purposes
714
# Do NOT enable these settings in a public facing / production grafana instance
815
ENV GF_AUTH_ANONYMOUS_ORG_ROLE "Admin"
@@ -11,6 +18,58 @@ ENV GF_AUTH_BASIC_ENABLED "false"
1118
# Set development mode so plugins can be loaded without the need to sign
1219
ENV GF_DEFAULT_APP_MODE "development"
1320

14-
# Inject livereload script into grafana index.html
21+
22+
LABEL maintainer="Grafana Labs <hello@grafana.com>"
23+
24+
ENV GF_PATHS_HOME="/usr/share/grafana"
25+
WORKDIR $GF_PATHS_HOME
26+
1527
USER root
16-
RUN sed -i 's/<\/body><\/html>/<script src=\"http:\/\/localhost:35729\/livereload.js\"><\/script><\/body><\/html>/g' /usr/share/grafana/public/views/index.html
28+
29+
# Installing supervisor and inotify-tools
30+
RUN if [ "${development}" = "true" ]; then \
31+
if grep -i -q alpine /etc/issue; then \
32+
apk add supervisor inotify-tools git; \
33+
elif grep -i -q ubuntu /etc/issue; then \
34+
DEBIAN_FRONTEND=noninteractive && \
35+
apt-get update && \
36+
apt-get install -y supervisor inotify-tools git && \
37+
rm -rf /var/lib/apt/lists/*; \
38+
else \
39+
echo 'ERROR: Unsupported base image' && /bin/false; \
40+
fi \
41+
fi
42+
43+
COPY supervisord/supervisord.conf /etc/supervisor.d/supervisord.ini
44+
COPY supervisord/supervisord.conf /etc/supervisor/conf.d/supervisord.conf
45+
46+
47+
# Installing Go
48+
RUN if [ "${development}" = "true" ]; then \
49+
curl -O -L https://golang.org/dl/go${GO_VERSION}.linux-${GO_ARCH}.tar.gz && \
50+
rm -rf /usr/local/go && \
51+
tar -C /usr/local -xzf go${GO_VERSION}.linux-${GO_ARCH}.tar.gz && \
52+
echo "export PATH=$PATH:/usr/local/go/bin:~/go/bin" >> ~/.bashrc && \
53+
rm -f go${GO_VERSION}.linux-${GO_ARCH}.tar.gz; \
54+
fi
55+
56+
# Installing delve for debugging
57+
RUN if [ "${development}" = "true" ]; then \
58+
/usr/local/go/bin/go install github.com/go-delve/delve/cmd/dlv@latest; \
59+
fi
60+
61+
# Installing mage for plugin (re)building
62+
RUN if [ "${development}" = "true" ]; then \
63+
git clone https://github.com/magefile/mage; \
64+
cd mage; \
65+
export PATH=$PATH:/usr/local/go/bin; \
66+
go run bootstrap.go; \
67+
fi
68+
69+
# Inject livereload script into grafana index.html
70+
RUN sed -i 's|</body>|<script src="http://localhost:35729/livereload.js"></script></body>|g' /usr/share/grafana/public/views/index.html
71+
72+
73+
COPY entrypoint.sh /entrypoint.sh
74+
RUN chmod +x /entrypoint.sh
75+
ENTRYPOINT ["/entrypoint.sh"]

.config/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,11 @@ set up the Jest DOM for the testing library and to apply some polyfills. ([link
5656

5757
#### ESM errors with Jest
5858

59-
A common issue found with the current jest config involves importing an npm package which only offers an ESM build. These packages cause jest to error with `SyntaxError: Cannot use import statement outside a module`. To work around this we provide a list of known packages to pass to the `[transformIgnorePatterns](https://jestjs.io/docs/configuration#transformignorepatterns-arraystring)` jest configuration property. If need be this can be extended in the following way:
59+
A common issue with the current jest config involves importing an npm package that only offers an ESM build. These packages cause jest to error with `SyntaxError: Cannot use import statement outside a module`. To work around this, we provide a list of known packages to pass to the `[transformIgnorePatterns](https://jestjs.io/docs/configuration#transformignorepatterns-arraystring)` jest configuration property. If need be, this can be extended in the following way:
6060

6161
```javascript
6262
process.env.TZ = 'UTC';
63-
const { grafanaESModules, nodeModulesToTransform } = require('./jest/utils');
63+
const { grafanaESModules, nodeModulesToTransform } = require('./config/jest/utils');
6464

6565
module.exports = {
6666
// Jest configuration provided by Grafana
@@ -142,7 +142,7 @@ We need to update the `scripts` in the `package.json` to use the extended Webpac
142142

143143
### Configure grafana image to use when running docker
144144

145-
By default `grafana-enterprise` will be used as the docker image for all docker related commands. If you want to override this behaviour simply alter the `docker-compose.yaml` by adding the following build arg `grafana_image`.
145+
By default, `grafana-enterprise` will be used as the docker image for all docker related commands. If you want to override this behavior, simply alter the `docker-compose.yaml` by adding the following build arg `grafana_image`.
146146

147147
**Example:**
148148

@@ -159,6 +159,6 @@ services:
159159
grafana_image: ${GRAFANA_IMAGE:-grafana}
160160
```
161161
162-
In this example we are assigning the environment variable `GRAFANA_IMAGE` to the build arg `grafana_image` with a default value of `grafana`. This will give you the possibility to set the value while running the docker-compose commands which might be convinent in some scenarios.
162+
In this example, we assign the environment variable `GRAFANA_IMAGE` to the build arg `grafana_image` with a default value of `grafana`. This will allow you to set the value while running the docker-compose commands, which might be convenient in some scenarios.
163163

164164
---

.config/entrypoint.sh

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
#!/bin/sh
2+
3+
if [ "${DEV}" = "false" ]; then
4+
echo "Starting test mode"
5+
exec /run.sh
6+
fi
7+
8+
echo "Starting development mode"
9+
10+
if grep -i -q alpine /etc/issue; then
11+
exec /usr/bin/supervisord -c /etc/supervisord.conf
12+
elif grep -i -q ubuntu /etc/issue; then
13+
exec /usr/bin/supervisord -c /etc/supervisor/supervisord.conf
14+
else
15+
echo 'ERROR: Unsupported base image'
16+
exit 1
17+
fi
18+

.config/jest-setup.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,13 @@
22
* ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
33
*
44
* In order to extend the configuration follow the steps in
5-
* https://grafana.github.io/plugin-tools/docs/advanced-configuration#extending-the-jest-config
5+
* https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations#extend-the-jest-config
66
*/
77

88
import '@testing-library/jest-dom';
9+
import { TextEncoder, TextDecoder } from 'util';
10+
11+
Object.assign(global, { TextDecoder, TextEncoder });
912

1013
// https://jestjs.io/docs/manual-mocks#mocking-methods-which-are-not-implemented-in-jsdom
1114
Object.defineProperty(global, 'matchMedia', {

.config/jest.config.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
33
*
44
* In order to extend the configuration follow the steps in
5-
* https://grafana.github.io/plugin-tools/docs/advanced-configuration#extending-the-jest-config
5+
* https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations#extend-the-jest-config
66
*/
77

88
const path = require('path');
@@ -25,7 +25,7 @@ module.exports = {
2525
'^.+\\.(t|j)sx?$': [
2626
'@swc/jest',
2727
{
28-
sourceMaps: true,
28+
sourceMaps: 'inline',
2929
jsc: {
3030
parser: {
3131
syntax: 'typescript',

.config/jest/utils.js

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,17 +8,20 @@
88
* This utility function is useful in combination with jest `transformIgnorePatterns` config
99
* to transform specific packages (e.g.ES modules) in a projects node_modules folder.
1010
*/
11-
const nodeModulesToTransform = (moduleNames) => `node_modules\/(?!(${moduleNames.join('|')})\/)`;
11+
const nodeModulesToTransform = (moduleNames) => `node_modules\/(?!.*(${moduleNames.join('|')})\/.*)`;
1212

1313
// Array of known nested grafana package dependencies that only bundle an ESM version
1414
const grafanaESModules = [
15+
'.pnpm', // Support using pnpm symlinked packages
16+
'@grafana/schema',
1517
'd3',
1618
'd3-color',
1719
'd3-force',
1820
'd3-interpolate',
1921
'd3-scale-chromatic',
2022
'ol',
2123
'react-colorful',
24+
'rxjs',
2225
'uuid',
2326
];
2427

.config/supervisord/supervisord.conf

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
[supervisord]
2+
nodaemon=true
3+
user=root
4+
5+
[program:grafana]
6+
user=root
7+
directory=/var/lib/grafana
8+
command=bash -c 'while [ ! -f /root/grafana-googlesheets-datasource/dist/gpx_sheets* ]; do sleep 1; done; /run.sh'
9+
stdout_logfile=/dev/fd/1
10+
stdout_logfile_maxbytes=0
11+
redirect_stderr=true
12+
killasgroup=true
13+
stopasgroup=true
14+
autostart=true
15+
16+
[program:delve]
17+
user=root
18+
command=/bin/bash -c 'pid=""; while [ -z "$pid" ]; do pid=$(pgrep -f gpx_sheets); done; /root/go/bin/dlv attach --api-version=2 --headless --continue --accept-multiclient --listen=:2345 $pid'
19+
stdout_logfile=/dev/fd/1
20+
stdout_logfile_maxbytes=0
21+
redirect_stderr=true
22+
killasgroup=false
23+
stopasgroup=false
24+
autostart=true
25+
autorestart=true
26+
27+
[program:build-watcher]
28+
user=root
29+
command=/bin/bash -c 'while inotifywait -e modify,create,delete -r /var/lib/grafana/plugins/grafana-googlesheets-datasource; do echo "Change detected, restarting delve...";supervisorctl restart delve; done'
30+
stdout_logfile=/dev/fd/1
31+
stdout_logfile_maxbytes=0
32+
redirect_stderr=true
33+
killasgroup=true
34+
stopasgroup=true
35+
autostart=true
36+
37+
[program:mage-watcher]
38+
user=root
39+
environment=PATH="/usr/local/go/bin:/root/go/bin:%(ENV_PATH)s"
40+
directory=/root/grafana-googlesheets-datasource
41+
command=/bin/bash -c 'git config --global --add safe.directory /root/grafana-googlesheets-datasource && mage -v watch'
42+
stdout_logfile=/dev/fd/1
43+
stdout_logfile_maxbytes=0
44+
redirect_stderr=true
45+
killasgroup=true
46+
stopasgroup=true
47+
autostart=true

.config/tsconfig.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
* ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
33
*
44
* In order to extend the configuration follow the steps in
5-
* https://grafana.github.io/plugin-tools/docs/advanced-configuration#extending-the-typescript-config
5+
* https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations#extend-the-typescript-config
66
*/
77
{
88
"compilerOptions": {

.config/webpack/utils.ts

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,32 @@
11
import fs from 'fs';
2+
import process from 'process';
3+
import os from 'os';
24
import path from 'path';
3-
import util from 'util';
4-
import glob from 'glob';
5+
import { glob } from 'glob';
56
import { SOURCE_DIR } from './constants';
67

7-
const globAsync = util.promisify(glob);
8+
export function isWSL() {
9+
if (process.platform !== 'linux') {
10+
return false;
11+
}
12+
13+
if (os.release().toLowerCase().includes('microsoft')) {
14+
return true;
15+
}
16+
17+
try {
18+
return fs.readFileSync('/proc/version', 'utf8').toLowerCase().includes('microsoft');
19+
} catch {
20+
return false;
21+
}
22+
}
823

924
export function getPackageJson() {
1025
return require(path.resolve(process.cwd(), 'package.json'));
1126
}
1227

13-
export function getPluginId() {
14-
const { id } = require(path.resolve(process.cwd(), `${SOURCE_DIR}/plugin.json`));
15-
16-
return id;
28+
export function getPluginJson() {
29+
return require(path.resolve(process.cwd(), `${SOURCE_DIR}/plugin.json`));
1730
}
1831

1932
export function hasReadme() {
@@ -23,12 +36,12 @@ export function hasReadme() {
2336
// Support bundling nested plugins by finding all plugin.json files in src directory
2437
// then checking for a sibling module.[jt]sx? file.
2538
export async function getEntries(): Promise<Record<string, string>> {
26-
const pluginsJson = await globAsync('**/src/**/plugin.json', { absolute: true });
39+
const pluginsJson = await glob('**/src/**/plugin.json', { absolute: true });
2740

2841
const plugins = await Promise.all(
2942
pluginsJson.map((pluginJson) => {
3043
const folder = path.dirname(pluginJson);
31-
return globAsync(`${folder}/module.{ts,tsx,js,jsx}`, { absolute: true });
44+
return glob(`${folder}/module.{ts,tsx,js,jsx}`, { absolute: true });
3245
})
3346
);
3447

0 commit comments

Comments
 (0)