`fixed:reports:writer`
`fixed:datasources:reader`
`fixed:datasources:writer`
`fixed:organization:writer`
`fixed:datasources.permissions:reader`
`fixed:datasources.permissions:writer`
`fixed:teams:writer`
`fixed:dashboards:reader`
`fixed:dashboards:writer`
`fixed:dashboards.permissions:reader`
`fixed:dashboards.permissions:writer`
`fixed:dashboards.public:writer`
`fixed:folders:reader`
`fixed:folders:writer`
`fixed:folders.permissions:reader`
`fixed:folders.permissions:writer`
`fixed:alerting:writer`
`fixed:apikeys:reader`
`fixed:apikeys:writer`
`fixed:alerting.provisioning.secrets:reader`
`fixed:alerting.provisioning:writer`
`fixed:datasources.caching:reader`
`fixed:datasources.caching:writer`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:plugins:writer`
`fixed:library.panels:creator`
`fixed:library.panels:reader`
`fixed:library.panels:general.reader`
`fixed:library.panels:writer`
`fixed:library.panels:general.writer`
`fixed:alerting.provisioning.status:writer` | Default [Grafana organization administrator](ref:rbac-basic-roles) assignments. | -| Editor | `basic_editor` | `fixed:datasources:explorer`
`fixed:dashboards:creator`
`fixed:folders:creator`
`fixed:annotations:writer`
`fixed:teams:creator` if the `editors_can_admin` configuration flag is enabled
`fixed:alerting:writer`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:library.panels:creator`
`fixed:library.panels:general.reader`
`fixed:library.panels:general.writer`
`fixed:alerting.provisioning.status:writer` | Default [Editor](ref:rbac-basic-roles) assignments. | -| Viewer | `basic_viewer` | `fixed:datasources.id:reader`
`fixed:organization:reader`
`fixed:annotations:reader`
`fixed:annotations.dashboard:writer`
`fixed:alerting:reader`
`fixed:plugins.app:reader`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:library.panels:general.reader`
`fixed:datasources:explorer` if the `viewers_can_edit` configuration flag is enabled | Default [Viewer](ref:rbac-basic-roles) assignments. | -| No Basic Role | n/a | | Default [No Basic Role](ref:rbac-basic-roles) | +| Basic role | UID | Associated fixed roles | Description | +| ------------- | --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | +| Grafana Admin | `basic_grafana_admin` | `fixed:roles:reader`
`fixed:roles:writer`
`fixed:users:reader`
`fixed:users:writer`
`fixed:org.users:reader`
`fixed:org.users:writer`
`fixed:ldap:reader`
`fixed:ldap:writer`
`fixed:stats:reader`
`fixed:settings:reader`
`fixed:settings:writer`
`fixed:provisioning:writer`
`fixed:organization:reader`
`fixed:organization:maintainer`
`fixed:licensing:reader`
`fixed:licensing:writer`
`fixed:datasources.caching:reader`
`fixed:datasources.caching:writer`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:plugins:maintainer`
`fixed:authentication.config:writer`
`fixed:library.panels:creator`
`fixed:library.panels:reader`
`fixed:library.panels:general.reader`
`fixed:library.panels:writer`
`fixed:library.panels:general.writer`
`fixed:groupsync:writer` | Default [Grafana server administrator](/docs/grafana/
`fixed:reports:writer`
`fixed:datasources:reader`
`fixed:datasources:writer`
`fixed:organization:writer`
`fixed:datasources.permissions:reader`
`fixed:datasources.permissions:writer`
`fixed:teams:writer`
`fixed:dashboards:reader`
`fixed:dashboards:writer`
`fixed:dashboards.permissions:reader`
`fixed:dashboards.permissions:writer`
`fixed:dashboards.public:writer`
`fixed:folders:reader`
`fixed:folders:writer`
`fixed:folders.permissions:reader`
`fixed:folders.permissions:writer`
`fixed:alerting:writer`
`fixed:apikeys:reader`
`fixed:apikeys:writer`
`fixed:alerting.provisioning.secrets:reader`
`fixed:alerting.provisioning:writer`
`fixed:datasources.caching:reader`
`fixed:datasources.caching:writer`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:plugins:writer`
`fixed:library.panels:creator`
`fixed:library.panels:reader`
`fixed:library.panels:general.reader`
`fixed:library.panels:writer`
`fixed:library.panels:general.writer`
`fixed:alerting.provisioning.status:writer`
`fixed:groupsync:writer` | Default [Grafana organization administrator](ref:rbac-basic-roles) assignments. | +| Editor | `basic_editor` | `fixed:datasources:explorer`
`fixed:dashboards:creator`
`fixed:folders:creator`
`fixed:annotations:writer`
`fixed:teams:creator` if the `editors_can_admin` configuration flag is enabled
`fixed:alerting:writer`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:library.panels:creator`
`fixed:library.panels:general.reader`
`fixed:library.panels:general.writer`
`fixed:alerting.provisioning.status:writer` | Default [Editor](ref:rbac-basic-roles) assignments. | +| Viewer | `basic_viewer` | `fixed:datasources.id:reader`
`fixed:organization:reader`
`fixed:annotations:reader`
`fixed:annotations.dashboard:writer`
`fixed:alerting:reader`
`fixed:plugins.app:reader`
`fixed:dashboards.insights:reader`
`fixed:datasources.insights:reader`
`fixed:library.panels:general.reader`
`fixed:datasources:explorer` if the `viewers_can_edit` configuration flag is enabled | Default [Viewer](ref:rbac-basic-roles) assignments. | +| No Basic Role | n/a | | Default [No Basic Role](ref:rbac-basic-roles) | ## Fixed role definitions @@ -115,6 +115,8 @@ To learn how to use the roles API to determine the role UUIDs, refer to [Manage | `fixed:folders.permissions:reader` | `fixed_E06l4cx0JFm47EeLBE4nmv3pnSo` | `folders.permissions:read` | Read all folder permissions. | | `fixed:folders.permissions:writer` | `fixed_3GAgpQ_hWG8o7-lwNb86_VB37eI` | All permissions from `fixed:folders.permissions:reader` and
`folders.permissions:write` | Read and update all folder permissions. | | `fixed:ldap:reader` | `fixed_lMcOPwSkxKY-qCK8NMJc5k6izLE` | `ldap.user:read`
`ldap.status:read` | Read the LDAP configuration and LDAP status information. | +| `fixed:groupsync:reader` | `fixed_tLIbDrE6kw93sKqooF8GVS9BF4E` | `groupsync.mappings:read` | List all group attribute sync mappings. To use this role, enable the `groupAttributeSync` feature toggle. | +| `fixed:groupsync:writer` | `fixed_q7XUYx_efzxxsVmWhQgpiYClwBs` | `groupsync.mappings:read`
`groupsync.mappings:write` | Create, read, update, and delete all group attribute sync mappings. To use this role, enable the `groupAttributeSync` feature toggle. | | `fixed:ldap:writer` | `fixed_p6AvnU4GCQyIh7-hbwI-bk3GYnU` | All permissions from `fixed:ldap:reader` and
`ldap.user:sync`
`ldap.config:reload` | Read and update the LDAP configuration, and read LDAP status information. | | `fixed:library.panels:creator` | `fixed_6eX6ItfegCIY5zLmPqTDW8ZV7KY` | `library.panels:create`
`folders:read` | Create library panel at the root level. | | `fixed:library.panels:general.reader` | `fixed_ct0DghiBWR_2BiQm3EvNPDVmpio` | `library.panels:read` | Read all library panels at the root level. | diff --git a/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md index 9933d75ed6f..4637db17de0 100644 --- a/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md +++ b/docs/sources/alerting/alerting-rules/create-grafana-managed-rule.md @@ -85,6 +85,9 @@ Multiple alert instances can be created as a result of one alert rule (also know {{% admonition type="note" %}} For Grafana Cloud Free Forever, you can create up to 100 free Grafana-managed alert rules with each alert rule having a maximum of 1000 alert instances. + +For all paid tiers (Cloud Pro and Advanced), there is a soft limit of 2000 alert rules and unlimited alert instances. To increase the limit, open a support ticket from the [Cloud portal](https://grafana.com/docs/grafana-cloud/account-management/support/). + {{% /admonition %}} Grafana-managed alert rules can only be edited or deleted by users with Edit permissions for the folder storing the rules. diff --git a/docs/sources/dashboards/create-manage-playlists/index.md b/docs/sources/dashboards/create-manage-playlists/index.md index cae7a433784..20dba1c7cc6 100644 --- a/docs/sources/dashboards/create-manage-playlists/index.md +++ b/docs/sources/dashboards/create-manage-playlists/index.md @@ -24,7 +24,7 @@ A _playlist_ is a list of dashboards that are displayed in a sequence. You might Grafana automatically scales dashboards to any resolution, which makes them perfect for big screens. -You can access the Playlist feature from Grafana's side menu, in the Dashboards submenu. +You can access the **Playlist** feature from Grafana's side menu, in the Dashboards submenu. {{< admonition type="note" >}} You must have at least Editor role permissions to create and manage playlists. @@ -41,12 +41,12 @@ Use the information in this section to access playlists. Start and control the d ### Start a playlist -You can start a playlist in six different view modes. View modes determine how the menus and navigation bar appear on the dashboards as well as how panels are sized. +You can start a playlist in four different view modes. View modes determine how the menus and navigation bar appear on the dashboards as well as how panels are sized. 1. Click **Dashboards** in the main menu. 1. Click **Playlists**. 1. Find the desired playlist and click **Start playlist**. -1. In the dialog box that opens, select one of the [six playlist modes](#playlist-modes) available. +1. In the dialog box that opens, select one of the [four playlist modes](#playlist-modes) available. 1. Disable any dashboard controls that you don't want displayed while the list plays; these controls are enabled and visible by default. Select from: - **Time and refresh** @@ -55,31 +55,28 @@ You can start a playlist in six different view modes. View modes determine how t 1. Click **Start \
- The side menu remains visible.
- The navbar and dashboard controls appear at the top of the screen.
- The side menu remains visible.
- The navbar and dashboard controls appear at the top of the screen.
- Dashboard panels automatically adjust to optimize space on screen.
- The side menu is hidden or removed.
- The navbar and dashboard controls appear at the top of the screen.
- Enabled automatically after one minute of user inactivity.
- Enable it manually using the `d v` sequence shortcut, or by appending the parameter `?inactive` to the dashboard URL.
- Disable it with any mouse movement or keyboard action.
- The side menu is hidden or removed.
- The navbar and dashboard controls appear at the top of the screen.
- Dashboard panels automatically adjust to optimize space on screen.
- |
-| Kiosk mode |
- The side menu is hidden or removed.
- The navbar and dashboard controls appear at the top of the screen.
- You can disable or enable it manually using the `d v` sequence shortcut after the playlist has started.
- The side menu is hidden or removed.
- The navbar and dashboard controls appear at the top of the screen.
- You can disable or enable it manually using the `d v` sequence shortcut after the playlist has started.
- Dashboard panels automatically adjust to optimize space on screen.
- The main menu and navbar remain visible.
- Dashboard controls are hidden.
- Playlist controls are displayed at the top of the screen.
- |
+| Normal mode (with auto fit panels) |
- The main menu and navbar remain visible.
- Dashboard controls are hidden.
- Playlist controls are displayed at the top of the screen.
- Dashboard panels automatically adjust to optimize space on screen.
- The main menu, navbar, and dashboard controls are hidden.
- You can disable the playlist manually by pressing the `Esc` key after the playlist has started. Doing so causes the playlist controls to be displayed at the top of the screen briefly.
- The main menu, navbar, and dashboard controls are hidden.
- You can disable the playlist manually by pressing the `Esc` key after the playlist has started. Doing so causes the playlist controls to be displayed at the top of the screen briefly.
- Dashboard panels automatically adjust to optimize space on screen.
- <
/dashboards/variables/add-template-variables/#add-ad-hoc-filters - pattern: /docs/grafana-cloud/ destination: /docs/grafana-cloud/visualizations/dashboards/variables/add-template-variables/#add-ad-hoc-filters + shared-dashboards: + - pattern: /docs/grafana/ + destination: /docs/grafana/ /dashboards/share-dashboards-panels/shared-dashboards/ + - pattern: /docs/grafana-cloud/ + destination: /docs/grafana-cloud/visualizations/dashboards/share-dashboards-panels/shared-dashboards/ --- # Use dashboards @@ -90,19 +95,18 @@ The dashboard user interface provides a number of features that you can use to c The following image and descriptions highlight all dashboard features. - + -1. **Grafana home** - Click **Home** in the breadcrumb to go to the home page configured in the Grafana instance. 1. **Dashboard folder** - When you click the dashboard folder name, you can search for other dashboards contained in the folder and perform other [folder management tasks](ref:dashboard-folders). 1. **Dashboard title** - You can create your own dashboard titles or have Grafana create them for you using [generative AI features](ref:generative-ai-features). +1. **Kiosk mode** - Click to display the dashboard on a large screen such as a TV or a kiosk. Kiosk mode hides the main menu, navbar, and dashboard controls. Learn more about kiosk mode in our [How to Create Kiosks to Display Dashboards on a TV blog post](https://grafana.com/blog/2019/05/02/grafana-tutorial-how-to-create-kiosks-to-display-dashboards-on-a-tv/). Press `Esc` to leave kiosk mode. 1. **Mark as favorite** - Mark the dashboard as one of your favorites so it's included in your list of **Starred** dashboards in the main menu. -1. **Public label** - When you share a dashboard externally, it's marked with the **Public** label. +1. **Public label** - When you [share a dashboard externally](ref:shared-dashboards), it's marked with the **Public** label. 1. **Dashboard insights** - Click to view analytics about your dashboard including information about users, activity, query counts. Learn more about [dashboard analytics](ref:dashboard-analytics). 1. **Edit** - Click to leave view-only mode and enter edit mode, where you can make changes directly to the dashboard and access dashboard settings, as well as several panel editing functions. 1. **Export** - Access [dashboard exporting](ref:export-dashboards) options. 1. **Share dashboard** - Access several [dashboard sharing](ref:sharing) options. -1. **Kiosk mode** - Click to display the dashboard on a large screen such as a TV or a kiosk. Kiosk mode hides elements such as navigation menus. Learn more about kiosk mode in our [How to Create Kiosks to Display Dashboards on a TV blog post](https://grafana.com/blog/2019/05/02/grafana-tutorial-how-to-create-kiosks-to-display-dashboards-on-a-tv/). Press `Enter` to leave kiosk mode. -1. **Variables** - Use [variables](ref:variables) to create more interactive and dynamic dashboards. +1. **Variables** - Use [variables](ref:variables), including ad hoc filters, to create more interactive and dynamic dashboards. 1. **Dashboard links** - Link to other dashboards, panels, and external websites. Learn more about [dashboard links](ref:dashboard-links). 1. **Current dashboard time range and time picker** - Click to select [relative time range](#relative-time-range) options and set custom [absolute time ranges](#absolute-time-range). - You can change the **Timezone** and **Fiscal year** settings from the time range controls by clicking the **Change time settings** button. diff --git a/docs/sources/developers/angular_deprecation/_index.md b/docs/sources/developers/angular_deprecation/_index.md index 060e3931dfe..7b596b88308 100644 --- a/docs/sources/developers/angular_deprecation/_index.md +++ b/docs/sources/developers/angular_deprecation/_index.md @@ -60,7 +60,7 @@ We encourage you to locate the repository of the corresponding plugin and create ### Links -- [Migrate Angular to React](https://grafana.com/developers/plugin-tools/migration-guides/migrate-angularjs-to-react) +- [Migrate Angular to React](https://grafana.com/developers/plugin-tools/migration-guides/angular-react/) - [Build a panel plugin](https://grafana.com/tutorials/build-a-panel-plugin/) - [Build a data source plugin](https://grafana.com/tutorials/build-a-data-source-plugin/) - [List of current Angular plugins]({{< relref "./angular-plugins/" >}}) diff --git a/docs/sources/developers/http_api/serviceaccount.md b/docs/sources/developers/http_api/serviceaccount.md index 15e424cf151..680c3472647 100644 --- a/docs/sources/developers/http_api/serviceaccount.md +++ b/docs/sources/developers/http_api/serviceaccount.md @@ -445,10 +445,13 @@ Content-Type: application/json Authorization: Basic YWRtaW46YWRtaW4= { - "name": "grafana" + "name": "grafana", + "secondsToLive": 604800 } ``` +Default value for the `secondsToLive` is 0, which means that the service account token will never expire. + **Example Response**: ```http diff --git a/docs/sources/panels-visualizations/visualizations/canvas/index.md b/docs/sources/panels-visualizations/visualizations/canvas/index.md index 5e4cdaab205..4dab56e9f61 100644 --- a/docs/sources/panels-visualizations/visualizations/canvas/index.md +++ b/docs/sources/panels-visualizations/visualizations/canvas/index.md @@ -91,7 +91,23 @@ The text element lets you easily add text to the canvas. The element also suppor ### Icon -The icon element lets you add a supported icon to the canvas. Icons can have their color set based on thresholds / value mappings. +The icon element lets you add a supported icon to the canvas. Icons can have their color set based on thresholds or value mappings. + +#### Add a custom icon + +You can add a custom icon by referencing an SVG file. To add a custom icon, follow these steps: + +1. Under **Icon > SVG Path**, if it's not already selected, select **Fixed** as your file source. +1. Click **Select a value** in the field below. +1. In the dialog box that opens, click the **URL** tab. +1. Enter the URL in the field below the **URL** tab. + + {{< figure src="/media/docs/grafana/panels-visualizations/screenshot-canvas-custom-image-v11.3.png" max-width="300px" alt="Add a custom image URL" >}} + +1. Click **Select**. +1. (Optional) Add a background image to your icon with the **Background (icon)** option by following the steps to [add a custom image](#add-custom-images-to-elements). + +If you don't have an SVG file, you can use a rectangle element instead of an icon and set its background image to an image file type. To add a custom image for another element type, follow the steps to [add a custom image](#add-custom-images-to-elements). ### Server @@ -111,6 +127,25 @@ A button click will only trigger an API call when [inline editing](#inline-editi {{< docs/play title="Canvas Visualization: Buttons" url="https://play.grafana.org/d/c9ea65f5-ed5a-45cf-8fb7-f82af7c3afdf/" >}} +## Add custom images to elements + +You can add custom background images to all elements except **Button** by referencing an image URL. +The image must be hosted at a URL that allows requests from your Grafana instance. + +To upload a custom image, follow these steps: + +1. Under **Background (\ )**, if it's not already selected, select **Fixed** as your image source. + + {{< figure src="/media/docs/grafana/panels-visualizations/screenshot-canvas-custom-image-src-v11.3.png" max-width="300px" alt="Custom image source selection" >}} + +1. Click **Select a value** in the field below. +1. In the dialog box that opens, click the **URL** tab. +1. Enter the URL in the field below the **URL** tab. + + {{< figure src="/media/docs/grafana/panels-visualizations/screenshot-canvas-custom-image-v11.3.png" max-width="300px" alt="Add a custom image URL" >}} + +1. Click **Select**. + ## Connections When building a canvas, you can connect elements together to create more complex visualizations. Connections are created by dragging from the connection anchor of one element to the connection anchor of another element. You can also create connections to the background of the canvas. Connection anchors are displayed when you hover over an element and inline editing is turned on. diff --git a/docs/sources/panels-visualizations/visualizations/node-graph/index.md b/docs/sources/panels-visualizations/visualizations/node-graph/index.md index a57b4304de2..f5860c717c0 100644 --- a/docs/sources/panels-visualizations/visualizations/node-graph/index.md +++ b/docs/sources/panels-visualizations/visualizations/node-graph/index.md @@ -83,6 +83,12 @@ If a node lacks edge connections, it’s displayed on its own outside of the net {{< docs/shared lookup="visualizations/panel-options.md" source="grafana" version=" " >}} +## Node graph options + +Use the following options to refine your node graph visualization. + +- **Zoom mode** - Choose how the node graph should handle zoom and scroll events. + ## Nodes options The **Nodes** options section provides configurations for node behaviors. diff --git a/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md b/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md index 61dee43370e..fab815be73a 100644 --- a/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md +++ b/docs/sources/setup-grafana/configure-grafana/feature-toggles/index.md @@ -28,7 +28,6 @@ Most [generally available](https://grafana.com/docs/release-life-cycle/#general- | `publicDashboardsScene` | Enables public dashboard rendering using scenes | Yes | | `featureHighlights` | Highlight Grafana Enterprise features | | | `correlations` | Correlations page | Yes | -| `autoMigrateXYChartPanel` | Migrate old XYChart panel to new XYChart2 model | Yes | | `cloudWatchCrossAccountQuerying` | Enables cross-account querying in CloudWatch datasources | Yes | | `accessControlOnCall` | Access control primitives for OnCall | Yes | | `nestedFolders` | Enable folder nesting | Yes | @@ -80,6 +79,7 @@ Most [generally available](https://grafana.com/docs/release-life-cycle/#general- | `cloudWatchRoundUpEndTime` | Round up end time for metric queries to the next minute to avoid missing data | Yes | | `cloudwatchMetricInsightsCrossAccount` | Enables cross account observability for Cloudwatch Metric Insights query builder | Yes | | `azureMonitorDisableLogLimit` | Disables the log limit restriction for Azure Monitor when true. The limit is enabled by default. | | +| `preinstallAutoUpdate` | Enables automatic updates for pre-installed plugins | Yes | ## Public preview feature toggles @@ -114,7 +114,9 @@ Most [generally available](https://grafana.com/docs/release-life-cycle/#general- | `ssoSettingsSAML` | Use the new SSO Settings API to configure the SAML connector | | `azureMonitorPrometheusExemplars` | Allows configuration of Azure Monitor as a data source that can provide Prometheus exemplars | | `ssoSettingsLDAP` | Use the new SSO Settings API to configure LDAP | +| `singleTopNav` | Unifies the top search bar and breadcrumb bar into one | | `useSessionStorageForRedirection` | Use session storage for handling the redirection after login | +| `reportingUseRawTimeRange` | Uses the original report or dashboard time range instead of making an absolute transformation | ## Experimental feature toggles @@ -203,7 +205,6 @@ Experimental features might be changed or removed without prior notice. | `newFiltersUI` | Enables new combobox style UI for the Ad hoc filters variable in scenes architecture | | `lokiSendDashboardPanelNames` | Send dashboard and panel names to Loki when querying | | `alertingPrometheusRulesPrimary` | Uses Prometheus rules as the primary source of truth for ruler-enabled data sources | -| `singleTopNav` | Unifies the top search bar and breadcrumb bar into one | | `exploreLogsShardSplitting` | Used in Explore Logs to split queries into multiple queries based on the number of shards | | `exploreLogsAggregatedMetrics` | Used in Explore Logs to query by aggregated metrics | | `exploreLogsLimitedTimeRange` | Used in Explore Logs to limit the time range | @@ -216,7 +217,6 @@ Experimental features might be changed or removed without prior notice. | `timeRangeProvider` | Enables time pickers sync | | `prometheusUsesCombobox` | Use new combobox component for Prometheus query editor | | `userStorageAPI` | Enables the user storage API | -| `preinstallAutoUpdate` | Enables automatic updates for pre-installed plugins | | `dashboardSchemaV2` | Enables the new dashboard schema version 2, implementing changes necessary for dynamic dashboards and dashboards as code. | | `playlistsWatcher` | Enables experimental watcher for playlists | | `enableExtensionsAdminPage` | Enables the extension admin page regardless of development mode | diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md index fe98f938a20..651eed8c172 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/_index.md @@ -159,10 +159,19 @@ Defaults to `false`. auto_login = true ``` -### Avoid automatic OAuth login +### Avoid automatic login -To sign in with a username and password and avoid automatic OAuth login, add the `disableAutoLogin` parameter to your login URL. -For example: `grafana.example.com/login?disableAutoLogin` or `grafana.example.com/login?disableAutoLogin=true` +The `disableAutoLogin=true` URL parameter allows users to bypass the automatic login feature in scenarios where incorrect configuration changes prevent normal login functionality. +This feature is especially helpful when you need to access the login screen to troubleshoot and fix misconfigurations. + +#### How to use + +1. Add `disableAutoLogin=true` as a query parameter to your Grafana URL. + - Example: `grafana.example.net/login?disableAutoLogin=true` or `grafana.example.net/login?disableAutoLogin` +1. This will redirect you to the standard login screen, bypassing the automatic login mechanism. +1. Fix any configuration issues and test your login setup. + +This feature is available for both for OAuth and SAML. Ensure that after fixing the issue, you remove the parameter or revert the configuration to re-enable the automatic login feature, if desired. ### Hide sign-out menu diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md index 532d992b665..dfbea92ba5f 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/azuread/index.md @@ -12,12 +12,12 @@ labels: - cloud - enterprise - oss -menuTitle: Azure AD OAuth2 -title: Configure Azure AD OAuth2 authentication +menuTitle: Azure AD/Entra ID OAuth +title: Configure Azure AD/Entra ID OAuth authentication weight: 800 --- -# Configure Azure AD OAuth2 authentication +# Configure Azure AD/Entra ID OAuth authentication The Azure AD authentication allows you to use a Microsoft Entra ID (formerly known as Azure Active Directory) tenant as an identity provider for Grafana. You can use Entra ID application roles to assign users and groups to Grafana roles from the Azure Portal. @@ -27,7 +27,7 @@ If Users use the same email address in Microsoft Entra ID that they use with oth ## Create the Microsoft Entra ID application -To enable the Azure AD OAuth2, register your application with Entra ID. +To enable the Azure AD/Entra ID OAuth, register your application with Entra ID. 1. Log in to [Azure Portal](https://portal.azure.com), then click **Microsoft Entra ID** in the side menu. @@ -181,7 +181,7 @@ Ensure that you have followed the steps in [Create the Microsoft Entra ID applic Available in Public Preview in Grafana 10.4 behind the `ssoSettingsApi` feature toggle. {{% /admonition %}} -As a Grafana Admin, you can configure your Azure AD OAuth2 client from within Grafana using the Grafana UI. To do this, navigate to the **Administration > Authentication > Azure AD** page and fill in the form. If you have a current configuration in the Grafana configuration file, the form will be pre-populated with those values. Otherwise the form will contain default values. +As a Grafana Admin, you can configure your Azure AD/Entra ID OAuth client from within Grafana using the Grafana UI. To do this, navigate to the **Administration > Authentication > Azure AD** page and fill in the form. If you have a current configuration in the Grafana configuration file, the form will be pre-populated with those values. Otherwise the form will contain default values. After you have filled in the form, click **Save** to save the configuration. If the save was successful, Grafana will apply the new configurations. diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md index 177e24dbebd..adde6ae745b 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/generic-oauth/index.md @@ -1,7 +1,7 @@ --- aliases: - ../../../auth/generic-oauth/ -description: Configure generic OAuth2 authentication +description: Configure Generic OAuth authentication keywords: - grafana - configuration @@ -12,12 +12,12 @@ labels: - cloud - enterprise - oss -menuTitle: Generic OAuth2 -title: Configure generic OAuth2 authentication +menuTitle: Generic OAuth +title: Configure Generic OAuth authentication weight: 700 --- -# Configure generic OAuth2 authentication +# Configure Generic OAuth authentication {{< docs/shared lookup="auth/intro.md" source="grafana" version=" " >}} @@ -31,9 +31,9 @@ Grafana provides OAuth2 integrations for the following auth providers: - [Keycloak OAuth]({{< relref "../keycloak" >}}) - [Okta OAuth]({{< relref "../okta" >}}) -If your OAuth2 provider is not listed, you can use generic OAuth2 authentication. +If your OAuth2 provider is not listed, you can use Generic OAuth authentication. -This topic describes how to configure generic OAuth2 authentication using different methods and includes [examples of setting up generic OAuth2]({{< relref "#examples-of-setting-up-generic-oauth2" >}}) with specific OAuth2 providers. +This topic describes how to configure Generic OAuth authentication using different methods and includes [examples of setting up Generic OAuth]({{< relref "#examples-of-setting-up-generic-oauth2" >}}) with specific OAuth2 providers. ## Before you begin @@ -53,7 +53,7 @@ If Users use the same email address in Azure AD that they use with other authent Available in Public Preview in Grafana 10.4 behind the `ssoSettingsApi` feature toggle. {{% /admonition %}} -As a Grafana Admin, you can configure Generic OAuth2 client from within Grafana using the Generic OAuth UI. To do this, navigate to **Administration > Authentication > Generic OAuth** page and fill in the form. If you have a current configuration in the Grafana configuration file then the form will be pre-populated with those values otherwise the form will contain default values. +As a Grafana Admin, you can configure Generic OAuth client from within Grafana using the Generic OAuth UI. To do this, navigate to **Administration > Authentication > Generic OAuth** page and fill in the form. If you have a current configuration in the Grafana configuration file then the form will be pre-populated with those values otherwise the form will contain default values. After you have filled in the form, click **Save** to save the configuration. If the save was successful, Grafana will apply the new configurations. @@ -98,7 +98,7 @@ Ensure that you have access to the [Grafana configuration file]({{< relref "../. ### Steps -To integrate your OAuth2 provider with Grafana using our generic OAuth2 authentication, follow these steps: +To integrate your OAuth2 provider with Grafana using our Generic OAuth authentication, follow these steps: 1. Create an OAuth2 application in your chosen OAuth2 provider. 1. Set the callback URL for your OAuth2 app to `http:// : /login/generic_oauth`. @@ -114,9 +114,9 @@ To integrate your OAuth2 provider with Grafana using our generic OAuth2 authenti | `client_id`, `client_secret` | These values must match the client ID and client secret from your OAuth2 app. | | `auth_url` | The authorization endpoint of your OAuth2 provider. | | `api_url` | The user information endpoint of your OAuth2 provider. Information returned by this endpoint must be compatible with [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo). | - | `enabled` | Enables generic OAuth2 authentication. Set this value to `true`. | + | `enabled` | Enables Generic OAuth authentication. Set this value to `true`. | - Review the list of other generic OAuth2 [configuration options]({{< relref "#configuration-options" >}}) and complete them, as necessary. + Review the list of other Generic OAuth [configuration options]({{< relref "#configuration-options" >}}) and complete them, as necessary. 1. Optional: [Configure a refresh token]({{< relref "#configure-a-refresh-token" >}}): @@ -130,7 +130,7 @@ To integrate your OAuth2 provider with Grafana using our generic OAuth2 authenti 1. Optional: [Configure team synchronization]({{< relref "#configure-team-synchronization" >}}). 1. Restart Grafana. - You should now see a generic OAuth2 login button on the login page and be able to log in or sign up with your OAuth2 provider. + You should now see a Generic OAuth login button on the login page and be able to log in or sign up with your OAuth2 provider. ### Configure login @@ -185,7 +185,7 @@ When a user logs in using an OAuth2 provider, Grafana verifies that the access t Grafana uses a refresh token to obtain a new access token without requiring the user to log in again. If a refresh token doesn't exist, Grafana logs the user out of the system after the access token has expired. -To configure generic OAuth2 to use a refresh token, set `use_refresh_token` configuration option to `true` and perform one or both of the following steps, if required: +To configure Generic OAuth to use a refresh token, set `use_refresh_token` configuration option to `true` and perform one or both of the following steps, if required: 1. Extend the `scopes` field of `[auth.generic_oauth]` section in Grafana configuration file with additional scopes. 1. Enable the refresh token on the provider. @@ -335,7 +335,7 @@ org_mapping = org_foo:org_foo:Viewer org_bar:org_bar:Editor *:org_baz:Editor By using Team Sync, you can link your OAuth2 groups to teams within Grafana. This will automatically assign users to the appropriate teams. Teams for each user are synchronized when the user logs in. -Generic OAuth2 groups can be referenced by group ID, such as `8bab1c86-8fba-33e5-2089-1d1c80ec267d` or `myteam`. +Generic OAuth groups can be referenced by group ID, such as `8bab1c86-8fba-33e5-2089-1d1c80ec267d` or `myteam`. For information on configuring OAuth2 groups with Grafana using the `groups_attribute_path` configuration option, refer to [configuration options]({{< relref "#configuration-options" >}}). To learn more about Team Sync, refer to [Configure team sync]({{< relref "../../configure-team-sync" >}}). @@ -367,55 +367,60 @@ Payload: ## Configuration options -The following table outlines the various generic OAuth2 configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. +The following table outlines the various Generic OAuth configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables]({{< relref "../../../configure-grafana#override-configuration-with-environment-variables" >}}). -| Setting | Required | Description | Default | -| ---------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | -| `enabled` | No | Enables generic OAuth2 authentication. | `false` | -| `name` | No | Name that refers to the generic OAuth2 authentication from the Grafana user interface. | `OAuth` | -| `icon` | No | Icon used for the generic OAuth2 authentication in the Grafana user interface. | `signin` | -| `client_id` | Yes | Client ID provided by your OAuth2 app. | | -| `client_secret` | Yes | Client secret provided by your OAuth2 app. | | -| `auth_url` | Yes | Authorization endpoint of your OAuth2 provider. | | -| `token_url` | Yes | Endpoint used to obtain the OAuth2 access token. | | -| `api_url` | Yes | Endpoint used to obtain user information compatible with [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo). | | -| `auth_style` | No | Name of the [OAuth2 AuthStyle](https://pkg.go.dev/golang.org/x/oauth2#AuthStyle) to be used when ID token is requested from OAuth2 provider. It determines how `client_id` and `client_secret` are sent to Oauth2 provider. Available values are `AutoDetect`, `InParams` and `InHeader`. | `AutoDetect` | -| `scopes` | No | List of comma- or space-separated OAuth2 scopes. | `user:email` | -| `empty_scopes` | No | Set to `true` to use an empty scope during authentication. | `false` | -| `allow_sign_up` | No | Controls Grafana user creation through the generic OAuth2 login. Only existing Grafana users can log in with Generic OAuth if set to `false`. | `true` | -| `auto_login` | No | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | -| `id_token_attribute_name` | No | The name of the key used to extract the ID token from the returned OAuth2 token. | `id_token` | -| `login_attribute_path` | No | [JMESPath](http://jmespath.org/examples.html) expression to use for user login lookup from the user ID token. For more information on how user login is retrieved, refer to [Configure login]({{< relref "#configure-login" >}}). | | -| `name_attribute_path` | No | [JMESPath](http://jmespath.org/examples.html) expression to use for user name lookup from the user ID token. This name will be used as the user's display name. For more information on how user display name is retrieved, refer to [Configure display name]({{< relref "#configure-display-name" >}}). | | -| `email_attribute_path` | No | [JMESPath](http://jmespath.org/examples.html) expression to use for user email lookup from the user information. For more information on how user email is retrieved, refer to [Configure email address]({{< relref "#configure-email-address" >}}). | | -| `email_attribute_name` | No | Name of the key to use for user email lookup within the `attributes` map of OAuth2 ID token. For more information on how user email is retrieved, refer to [Configure email address]({{< relref "#configure-email-address" >}}). | `email:primary` | -| `role_attribute_path` | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no role is found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | | -| `role_attribute_strict` | No | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | -| `org_attribute_path` | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana org to role lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no value is returned, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation will be mapped to org roles based on `org_mapping`. For more information on org to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | -| `org_mapping` | No | List of comma- or space-separated ` : : ` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | -| `allow_assign_grafana_admin` | No | Set to `true` to enable automatic sync of the Grafana server administrator role. If this option is set to `true` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user the server administrator privileges and organization administrator role. If this option is set to `false` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user only organization administrator role. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | -| `skip_org_role_sync` | No | Set to `true` to stop automatically syncing user roles. This will allow you to set organization roles for your users from within Grafana manually. | `false` | -| `groups_attribute_path` | No | [JMESPath](http://jmespath.org/examples.html) expression to use for user group lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no groups are found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a string array of groups. | | -| `allowed_groups` | No | List of comma- or space-separated groups. The user should be a member of at least one group to log in. If you configure `allowed_groups`, you must also configure `groups_attribute_path`. | | -| `allowed_organizations` | No | List of comma- or space-separated organizations. The user should be a member of at least one organization to log in. | | -| `allowed_domains` | No | List of comma- or space-separated domains. The user should belong to at least one domain to log in. | | -| `team_ids` | No | String list of team IDs. If set, the user must be a member of one of the given teams to log in. If you configure `team_ids`, you must also configure `teams_url` and `team_ids_attribute_path`. | | -| `team_ids_attribute_path` | No | The [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana team ID lookup within the results returned by the `teams_url` endpoint. | | -| `teams_url` | No | The URL used to query for team IDs. If not set, the default value is `/teams`. If you configure `teams_url`, you must also configure `team_ids_attribute_path`. | | -| `tls_skip_verify_insecure` | No | If set to `true`, the client accepts any certificate presented by the server and any host name in that certificate. _You should only use this for testing_, because this mode leaves SSL/TLS susceptible to man-in-the-middle attacks. | `false` | -| `tls_client_cert` | No | The path to the certificate. | | -| `tls_client_key` | No | The path to the key. | | -| `tls_client_ca` | No | The path to the trusted certificate authority list. | | -| `use_pkce` | No | Set to `true` to use [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636). Grafana uses the SHA256 based `S256` challenge method and a 128 bytes (base64url encoded) code verifier. | `false` | -| `use_refresh_token` | No | Set to `true` to use refresh token and check access token expiration. | `false` | +{{< admonition type="note" >}} +If the configuration option requires a JMESPath expression that includes a colon, enclose the entire expression in quotes to prevent parsing errors. For example `role_attribute_path: "role:view"` +{{< /admonition >}} -## Examples of setting up generic OAuth2 +| Setting | Required | Supported on Cloud | Description | Default | +| ---------------------------- | -------- | ------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- | +| `enabled` | No | Yes | Enables Generic OAuth authentication. | `false` | +| `name` | No | Yes | Name that refers to the Generic OAuth authentication from the Grafana user interface. | `OAuth` | +| `icon` | No | Yes | Icon used for the Generic OAuth authentication in the Grafana user interface. | `signin` | +| `client_id` | Yes | Yes | Client ID provided by your OAuth2 app. | | +| `client_secret` | Yes | Yes | Client secret provided by your OAuth2 app. | | +| `auth_url` | Yes | Yes | Authorization endpoint of your OAuth2 provider. | | +| `token_url` | Yes | Yes | Endpoint used to obtain the OAuth2 access token. | | +| `api_url` | Yes | Yes | Endpoint used to obtain user information compatible with [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo). | | +| `auth_style` | No | Yes | Name of the [OAuth2 AuthStyle](https://pkg.go.dev/golang.org/x/oauth2#AuthStyle) to be used when ID token is requested from OAuth2 provider. It determines how `client_id` and `client_secret` are sent to Oauth2 provider. Available values are `AutoDetect`, `InParams` and `InHeader`. | `AutoDetect` | +| `scopes` | No | Yes | List of comma- or space-separated OAuth2 scopes. | `user:email` | +| `empty_scopes` | No | Yes | Set to `true` to use an empty scope during authentication. | `false` | +| `allow_sign_up` | No | Yes | Controls Grafana user creation through the Generic OAuth login. Only existing Grafana users can log in with Generic OAuth if set to `false`. | `true` | +| `auto_login` | No | Yes | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | +| `id_token_attribute_name` | No | Yes | The name of the key used to extract the ID token from the returned OAuth2 token. | `id_token` | +| `login_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for user login lookup from the user ID token. For more information on how user login is retrieved, refer to [Configure login]({{< relref "#configure-login" >}}). | | +| `name_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for user name lookup from the user ID token. This name will be used as the user's display name. For more information on how user display name is retrieved, refer to [Configure display name]({{< relref "#configure-display-name" >}}). | | +| `email_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for user email lookup from the user information. For more information on how user email is retrieved, refer to [Configure email address]({{< relref "#configure-email-address" >}}). | | +| `email_attribute_name` | No | Yes | Name of the key to use for user email lookup within the `attributes` map of OAuth2 ID token. For more information on how user email is retrieved, refer to [Configure email address]({{< relref "#configure-email-address" >}}). | `email:primary` | +| `role_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no role is found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | | +| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | +| `skip_org_role_sync` | No | Yes | Set to `true` to stop automatically syncing user roles. This will allow you to set organization roles for your users from within Grafana manually. | `false` | +| `org_attribute_path` | No | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana org to role lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no value is returned, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation will be mapped to org roles based on `org_mapping`. For more information on org to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | +| `org_mapping` | No | No | List of comma- or space-separated ` : : ` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | +| `allow_assign_grafana_admin` | No | No | Set to `true` to enable automatic sync of the Grafana server administrator role. If this option is set to `true` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user the server administrator privileges and organization administrator role. If this option is set to `false` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user only organization administrator role. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | +| `groups_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for user group lookup. Grafana will first evaluate the expression using the OAuth2 ID token. If no groups are found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a string array of groups. | | +| `allowed_groups` | No | Yes | List of comma- or space-separated groups. The user should be a member of at least one group to log in. If you configure `allowed_groups`, you must also configure `groups_attribute_path`. | | +| `allowed_organizations` | No | Yes | List of comma- or space-separated organizations. The user should be a member of at least one organization to log in. | | +| `allowed_domains` | No | Yes | List of comma- or space-separated domains. The user should belong to at least one domain to log in. | | +| `team_ids` | No | Yes | String list of team IDs. If set, the user must be a member of one of the given teams to log in. If you configure `team_ids`, you must also configure `teams_url` and `team_ids_attribute_path`. | | +| `team_ids_attribute_path` | No | Yes | The [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana team ID lookup within the results returned by the `teams_url` endpoint. | | +| `teams_url` | No | Yes | The URL used to query for team IDs. If not set, the default value is `/teams`. If you configure `teams_url`, you must also configure `team_ids_attribute_path`. | | +| `tls_skip_verify_insecure` | No | No | If set to `true`, the client accepts any certificate presented by the server and any host name in that certificate. _You should only use this for testing_, because this mode leaves SSL/TLS susceptible to man-in-the-middle attacks. | `false` | +| `tls_client_cert` | No | No | The path to the certificate. | | +| `tls_client_key` | No | No | The path to the key. | | +| `tls_client_ca` | No | No | The path to the trusted certificate authority list. | | +| `use_pkce` | No | Yes | Set to `true` to use [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636). Grafana uses the SHA256 based `S256` challenge method and a 128 bytes (base64url encoded) code verifier. | `false` | +| `use_refresh_token` | No | Yes | Set to `true` to use refresh token and check access token expiration. | `false` | +| `signout_redirect_url` | No | Yes | URL to redirect to after the user logs out. | | -This section includes examples of setting up generic OAuth2 integration. +## Examples of setting up Generic OAuth + +This section includes examples of setting up Generic OAuth integration. ### Set up OAuth2 with Descope -To set up generic OAuth2 authentication with Descope, follow these steps: +To set up Generic OAuth authentication with Descope, follow these steps: 1. Create a Descope Project [here](https://app.descope.com/gettingStarted), and go through the Getting Started Wizard to configure your authentication. You can skip step if you already have Descope project set up. @@ -449,7 +454,7 @@ To set up generic OAuth2 authentication with Descope, follow these steps: ### Set up OAuth2 with Auth0 -To set up generic OAuth2 authentication with Auth0, follow these steps: +To set up Generic OAuth authentication with Auth0, follow these steps: 1. Create an Auth0 application using the following parameters: @@ -482,7 +487,7 @@ To set up generic OAuth2 authentication with Auth0, follow these steps: ### Set up OAuth2 with Bitbucket -To set up generic OAuth2 authentication with Bitbucket, follow these steps: +To set up Generic OAuth authentication with Bitbucket, follow these steps: 1. Navigate to **Settings > Workspace setting > OAuth consumers** in BitBucket. @@ -517,7 +522,7 @@ By default, a refresh token is included in the response for the **Authorization ### Set up OAuth2 with OneLogin -To set up generic OAuth2 authentication with OneLogin, follow these steps: +To set up Generic OAuth authentication with OneLogin, follow these steps: 1. Create a new Custom Connector in OneLogin with the following settings: @@ -553,7 +558,7 @@ To set up generic OAuth2 authentication with OneLogin, follow these steps: ### Set up OAuth2 with Dex -To set up generic OAuth2 authentication with [Dex IdP](https://dexidp.io/), follow these +To set up Generic OAuth authentication with [Dex IdP](https://dexidp.io/), follow these steps: 1. Add Grafana as a client in the Dex config YAML file: diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md index 4c820d9bbe1..600cc9f26e4 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/github/index.md @@ -1,7 +1,7 @@ --- aliases: - ../../../auth/github/ -description: Configure GitHub OAuth2 authentication +description: Configure GitHub OAuth authentication keywords: - grafana - configuration @@ -12,16 +12,16 @@ labels: - cloud - enterprise - oss -menuTitle: GitHub OAuth2 -title: Configure GitHub OAuth2 authentication +menuTitle: GitHub OAuth +title: Configure GitHub OAuth authentication weight: 900 --- -# Configure GitHub OAuth2 authentication +# Configure GitHub OAuth authentication {{< docs/shared lookup="auth/intro.md" source="grafana" version=" " >}} -This topic describes how to configure GitHub OAuth2 authentication. +This topic describes how to configure GitHub OAuth authentication. {{% admonition type="note" %}} If Users use the same email address in GitHub that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information. @@ -31,13 +31,23 @@ If Users use the same email address in GitHub that they use with other authentic Ensure you know how to create a GitHub OAuth app. Consult GitHub's documentation on [creating an OAuth app](https://docs.github.com/en/apps/oauth-apps/building-oauth-apps/creating-an-oauth-app) for more information. +### Create a GitHub OAuth App + +1. Log in to your GitHub account. + In **Profile > Settings > Developer settings**, select **OAuth Apps**. +1. Click **New OAuth App**. +1. Fill out the fields, using your Grafana homepage URL when appropriate. + In the **Authorization callback URL** field, enter the following: `https:// /login/github` . +1. Note your client ID. +1. Generate, then note, your client secret. + ## Configure GitHub authentication client using the Grafana UI {{% admonition type="note" %}} Available in Public Preview in Grafana 10.4 behind the `ssoSettingsApi` feature toggle. {{% /admonition %}} -As a Grafana Admin, you can configure GitHub OAuth2 client from within Grafana using the GitHub UI. To do this, navigate to **Administration > Authentication > GitHub** page and fill in the form. If you have a current configuration in the Grafana configuration file, the form will be pre-populated with those values. Otherwise the form will contain default values. +As a Grafana Admin, you can configure GitHub OAuth client from within Grafana using the GitHub UI. To do this, navigate to **Administration > Authentication > GitHub** page and fill in the form. If you have a current configuration in the Grafana configuration file, the form will be pre-populated with those values. Otherwise the form will contain default values. After you have filled in the form, click **Save** . If the save was successful, Grafana will apply the new configurations. @@ -156,7 +166,18 @@ All other users are granted the `Viewer` role. role_attribute_path = contains(groups[*], '@my-github-organization/my-github-team') && 'Editor' || 'Viewer' ``` -#### Map server administrator role +##### Map roles using multiple GitHub teams + +In this example, the users from GitHub teams `admins` and `devops` have been granted the `Admin` role, +the users from GitHub teams `engineers` and `managers` have been granted the `Editor` role, +the users from GitHub team `qa` have been granted the `Viewer` role and +all other users are granted the `None` role. + +```bash +role_attribute_path = contains(groups[*], '@my-github-organization/admins') && 'Admin' || contains(groups[*], '@my-github-organization/devops') && 'Admin' || contains(groups[*], '@my-github-organization/engineers') && 'Editor' || contains(groups[*], '@my-github-organization/managers') && 'Editor' || contains(groups[*], '@my-github-organization/qa') && 'Viewer' || 'None' +``` + +##### Map server administrator role In this example, the user with login `octocat` has been granted the `Admin` organization role as well as the Grafana server admin role. All other users are granted the `Viewer` role. @@ -215,30 +236,35 @@ To learn more about Team Sync, refer to [Configure team sync]({{< relref "../../ ## Configuration options -The table below describes all GitHub OAuth configuration options. Like any other Grafana configuration, you can apply these options as environment variables. +The table below describes all GitHub OAuth configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables]({{< relref "../../../configure-grafana#override-configuration-with-environment-variables" >}}). -| Setting | Required | Description | Default | -| ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | -| `enabled` | No | Whether GitHub OAuth authentication is allowed. | `false` | -| `name` | No | Name used to refer to the GitHub authentication in the Grafana user interface. | `GitHub` | -| `icon` | No | Icon used for GitHub authentication in the Grafana user interface. | `github` | -| `client_id` | Yes | Client ID provided by your GitHub OAuth app. | | -| `client_secret` | Yes | Client secret provided by your GitHub OAuth app. | | -| `auth_url` | Yes | Authorization endpoint of your GitHub OAuth provider. | `https://github.com/login/oauth/authorize` | -| `token_url` | Yes | Endpoint used to obtain GitHub OAuth access token. | `https://github.com/login/oauth/access_token` | -| `api_url` | Yes | Endpoint used to obtain GitHub user information compatible with [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo). | `https://api.github.com/user` | -| `scopes` | No | List of comma- or space-separated GitHub OAuth scopes. | `user:email,read:org` | -| `allow_sign_up` | No | Whether to allow new Grafana user creation through GitHub login. If set to `false`, then only existing Grafana users can log in with GitHub OAuth. | `true` | -| `auto_login` | No | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | -| `role_attribute_path` | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the user information obtained from the UserInfo endpoint. If no role is found, Grafana creates a JSON data with `groups` key that maps to GitHub teams obtained from GitHub's [`/api/user/teams`](https://docs.github.com/en/rest/teams/teams#list-teams-for-the-authenticated-user) endpoint, and evaluates the expression using this data. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping](#org-roles-mapping-example). | | -| `role_attribute_strict` | No | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Configure role mapping](#org-roles-mapping-example). | `false` | -| `org_mapping` | No | List of comma- or space-separated ` : : ` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | -| `allow_assign_grafana_admin` | No | Set to `true` to enable automatic sync of the Grafana server administrator role. If this option is set to `true` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user the server administrator privileges and organization administrator role. If this option is set to `false` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user only organization administrator role. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | -| `skip_org_role_sync` | No | Set to `true` to stop automatically syncing user roles. | `false` | -| `allowed_organizations` | No | List of comma- or space-separated organizations. User must be a member of at least one organization to log in. | | -| `allowed_domains` | No | List of comma- or space-separated domains. User must belong to at least one domain to log in. | | -| `team_ids` | No | Integer list of team IDs. If set, user has to be a member of one of the given teams to log in. | | -| `tls_skip_verify_insecure` | No | If set to `true`, the client accepts any certificate presented by the server and any host name in that certificate. _You should only use this for testing_, because this mode leaves SSL/TLS susceptible to man-in-the-middle attacks. | `false` | -| `tls_client_cert` | No | The path to the certificate. | | -| `tls_client_key` | No | The path to the key. | | -| `tls_client_ca` | No | The path to the trusted certificate authority list. | | +{{< admonition type="note" >}} +If the configuration option requires a JMESPath expression that includes a colon, enclose the entire expression in quotes to prevent parsing errors. For example `role_attribute_path: "role:view"` +{{< /admonition >}} + +| Setting | Required | Supported on Cloud | Description | Default | +| ---------------------------- | -------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------- | +| `enabled` | No | Yes | Whether GitHub OAuth authentication is allowed. | `false` | +| `name` | No | Yes | Name used to refer to the GitHub authentication in the Grafana user interface. | `GitHub` | +| `icon` | No | Yes | Icon used for GitHub authentication in the Grafana user interface. | `github` | +| `client_id` | Yes | Yes | Client ID provided by your GitHub OAuth app. | | +| `client_secret` | Yes | Yes | Client secret provided by your GitHub OAuth app. | | +| `auth_url` | Yes | Yes | Authorization endpoint of your GitHub OAuth provider. | `https://github.com/login/oauth/authorize` | +| `token_url` | Yes | Yes | Endpoint used to obtain GitHub OAuth access token. | `https://github.com/login/oauth/access_token` | +| `api_url` | Yes | Yes | Endpoint used to obtain GitHub user information compatible with [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo). | `https://api.github.com/user` | +| `scopes` | No | Yes | List of comma- or space-separated GitHub OAuth scopes. | `user:email,read:org` | +| `allow_sign_up` | No | Yes | Whether to allow new Grafana user creation through GitHub login. If set to `false`, then only existing Grafana users can log in with GitHub OAuth. | `true` | +| `auto_login` | No | Yes | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | +| `role_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the user information obtained from the UserInfo endpoint. If no role is found, Grafana creates a JSON data with `groups` key that maps to GitHub teams obtained from GitHub's [`/api/user/teams`](https://docs.github.com/en/rest/teams/teams#list-teams-for-the-authenticated-user) endpoint, and evaluates the expression using this data. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping](#org-roles-mapping-example). | | +| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Configure role mapping](#org-roles-mapping-example). | `false` | +| `org_mapping` | No | No | List of comma- or space-separated ` : : ` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | +| `skip_org_role_sync` | No | Yes | Set to `true` to stop automatically syncing user roles. | `false` | +| `allow_assign_grafana_admin` | No | No | Set to `true` to enable automatic sync of the Grafana server administrator role. If this option is set to `true` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user the server administrator privileges and organization administrator role. If this option is set to `false` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user only organization administrator role. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | +| `allowed_organizations` | No | Yes | List of comma- or space-separated organizations. User must be a member of at least one organization to log in. | | +| `allowed_domains` | No | Yes | List of comma- or space-separated domains. User must belong to at least one domain to log in. | | +| `team_ids` | No | Yes | Integer list of team IDs. If set, user has to be a member of one of the given teams to log in. | | +| `tls_skip_verify_insecure` | No | No | If set to `true`, the client accepts any certificate presented by the server and any host name in that certificate. _You should only use this for testing_, because this mode leaves SSL/TLS susceptible to man-in-the-middle attacks. | `false` | +| `tls_client_cert` | No | No | The path to the certificate. | | +| `tls_client_key` | No | No | The path to the key. | | +| `tls_client_ca` | No | No | The path to the trusted certificate authority list. | | +| `signout_redirect_url` | No | Yes | URL to redirect to after the user logs out. | | diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md index be61bbb796c..075047b7c49 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/gitlab/index.md @@ -1,7 +1,7 @@ --- aliases: - ../../../auth/gitlab/ -description: Grafana OAuthentication Guide +description: Grafana GitLab OAuth Guide keywords: - grafana - configuration @@ -12,16 +12,16 @@ labels: - cloud - enterprise - oss -menuTitle: GitLab OAuth2 -title: Configure GitLab OAuth2 authentication +menuTitle: GitLab OAuth +title: Configure GitLab OAuth authentication weight: 1000 --- -# Configure GitLab OAuth2 authentication +# Configure GitLab OAuth authentication {{< docs/shared lookup="auth/intro.md" source="grafana" version=" " >}} -This topic describes how to configure GitLab OAuth2 authentication. +This topic describes how to configure GitLab OAuth authentication. {{% admonition type="note" %}} If Users use the same email address in GitLab that they use with other authentication providers (such as Grafana.com), you need to do additional configuration to ensure that the users are matched correctly. Please refer to the [Using the same email address to login with different identity providers]({{< relref "../../configure-authentication#using-the-same-email-address-to-login-with-different-identity-providers" >}}) documentation for more information. @@ -31,13 +31,23 @@ If Users use the same email address in GitLab that they use with other authentic Ensure you know how to create a GitLab OAuth application. Consult GitLab's documentation on [creating a GitLab OAuth application](https://docs.gitlab.com/ee/integration/oauth_provider.html) for more information. +### Create a GitLab OAuth Application + +1. Log in to your GitLab account and go to **Profile > Preferences > Applications**. +1. Click **Add new application**. +1. Fill out the fields. + - In the **Redirect URI** field, enter the following: `https:// /login/gitlab` and check `openid`, `email`, `profile` in the **Scopes** list. + - Leave the **Confidential** checkbox checked. +1. Click **Save application**. +1. Note your **Application ID** (this is the `Client Id`) and **Secret** (this is the `Client Secret`). + ## Configure GitLab authentication client using the Grafana UI {{% admonition type="note" %}} Available in Public Preview in Grafana 10.4 behind the `ssoSettingsApi` feature toggle. {{% /admonition %}} -As a Grafana Admin, you can configure GitLab OAuth2 client from within Grafana using the GitLab UI. To do this, navigate to **Administration > Authentication > GitLab** page and fill in the form. If you have a current configuration in the Grafana configuration file then the form will be pre-populated with those values otherwise the form will contain default values. +As a Grafana Admin, you can configure GitLab OAuth client from within Grafana using the GitLab UI. To do this, navigate to **Administration > Authentication > GitLab** page and fill in the form. If you have a current configuration in the Grafana configuration file then the form will be pre-populated with those values otherwise the form will contain default values. After you have filled in the form, click **Save** to save the configuration. If the save was successful, Grafana will apply the new configurations. @@ -97,10 +107,10 @@ To configure GitLab authentication with Grafana, follow these steps: 1. Refer to the following table to update field values located in the `[auth.gitlab]` section of the Grafana configuration file: - | Field | Description | - | ---------------------------- | -------------------------------------------------------------------------------------------- | - | `client_id`, `client_secret` | These values must match the client ID and client secret from your GitLab OAuth2 application. | - | `enabled` | Enables GitLab authentication. Set this value to `true`. | + | Field | Description | + | ---------------------------- | --------------------------------------------------------------------------------------------- | + | `client_id`, `client_secret` | These values must match the `Application ID` and `Secret` from your GitLab OAuth application. | + | `enabled` | Enables GitLab authentication. Set this value to `true`. | Review the list of other GitLab [configuration options]({{< relref "#configuration-options" >}}) and complete them, as necessary. @@ -234,7 +244,9 @@ use_refresh_token = true ## Configure team synchronization -> **Note:** Available in [Grafana Enterprise]({{< relref "../../../../introduction/grafana-enterprise" >}}) and [Grafana Cloud](/docs/grafana-cloud/). +{{% admonition type="note" %}} +Available in [Grafana Enterprise]({{< relref "../../../../introduction/grafana-enterprise" >}}) and [Grafana Cloud](/docs/grafana-cloud/). +{{% /admonition %}} By using Team Sync, you can map GitLab groups to teams within Grafana. This will automatically assign users to the appropriate teams. Teams for each user are synchronized when the user logs in. @@ -247,31 +259,36 @@ To learn more about Team Sync, refer to [Configure team sync]({{< relref "../../ ## Configuration options -The table below describes all GitLab OAuth configuration options. Like any other Grafana configuration, you can apply these options as environment variables. +The table below describes all GitLab OAuth configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables]({{< relref "../../../configure-grafana#override-configuration-with-environment-variables" >}}). -| Setting | Required | Description | Default | -| ---------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | -| `enabled` | Yes | Whether GitLab OAuth authentication is allowed. | `false` | -| `client_id` | Yes | Client ID provided by your GitLab OAuth app. | | -| `client_secret` | Yes | Client secret provided by your GitLab OAuth app. | | -| `auth_url` | Yes | Authorization endpoint of your GitLab OAuth provider. If you use your own instance of GitLab instead of gitlab.com, adjust `auth_url` by replacing the `gitlab.com` hostname with your own. | `https://gitlab.com/oauth/authorize` | -| `token_url` | Yes | Endpoint used to obtain GitLab OAuth access token. If you use your own instance of GitLab instead of gitlab.com, adjust `token_url` by replacing the `gitlab.com` hostname with your own. | `https://gitlab.com/oauth/token` | -| `api_url` | No | Grafana uses ` /user` endpoint to obtain GitLab user information compatible with [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo). | `https://gitlab.com/api/v4` | -| `name` | No | Name used to refer to the GitLab authentication in the Grafana user interface. | `GitLab` | -| `icon` | No | Icon used for GitLab authentication in the Grafana user interface. | `gitlab` | -| `scopes` | No | List of comma or space-separated GitLab OAuth scopes. | `openid email profile` | -| `allow_sign_up` | No | Whether to allow new Grafana user creation through GitLab login. If set to `false`, then only existing Grafana users can log in with GitLab OAuth. | `true` | -| `auto_login` | No | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | -| `role_attribute_path` | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the GitLab OAuth token. If no role is found, Grafana creates a JSON data with `groups` key that maps to groups obtained from GitLab's `/oauth/userinfo` endpoint, and evaluates the expression using this data. Finally, if a valid role is still not found, the expression is evaluated against the user information retrieved from `api_url/users` endpoint and groups retrieved from `api_url/groups` endpoint. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | | -| `role_attribute_strict` | No | Set to `true` to deny user login if the Grafana role cannot be extracted using `role_attribute_path`. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | -| `org_mapping` | No | List of comma- or space-separated ` : : ` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | -| `allow_assign_grafana_admin` | No | Set to `true` to enable automatic sync of the Grafana server administrator role. If this option is set to `true` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user the server administrator privileges and organization administrator role. If this option is set to `false` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user only organization administrator role. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | -| `skip_org_role_sync` | No | Set to `true` to stop automatically syncing user roles. | `false` | -| `allowed_domains` | No | List of comma or space-separated domains. User must belong to at least one domain to log in. | | -| `allowed_groups` | No | List of comma or space-separated groups. The user should be a member of at least one group to log in. | | -| `tls_skip_verify_insecure` | No | If set to `true`, the client accepts any certificate presented by the server and any host name in that certificate. _You should only use this for testing_, because this mode leaves SSL/TLS susceptible to man-in-the-middle attacks. | `false` | -| `tls_client_cert` | No | The path to the certificate. | | -| `tls_client_key` | No | The path to the key. | | -| `tls_client_ca` | No | The path to the trusted certificate authority list. | | -| `use_pkce` | No | Set to `true` to use [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636). Grafana uses the SHA256 based `S256` challenge method and a 128 bytes (base64url encoded) code verifier. | `true` | -| `use_refresh_token` | No | Set to `true` to use refresh token and check access token expiration. The `accessTokenExpirationCheck` feature toggle should also be enabled to use refresh token. | `true` | +{{< admonition type="note" >}} +If the configuration option requires a JMESPath expression that includes a colon, enclose the entire expression in quotes to prevent parsing errors. For example `role_attribute_path: "role:view"` +{{< /admonition >}} + +| Setting | Required | Supported on Cloud | Description | Default | +| ---------------------------- | -------- | ------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ | +| `enabled` | Yes | Yes | Whether GitLab OAuth authentication is allowed. | `false` | +| `client_id` | Yes | Yes | Client ID provided by your GitLab OAuth app. | | +| `client_secret` | Yes | Yes | Client secret provided by your GitLab OAuth app. | | +| `auth_url` | Yes | Yes | Authorization endpoint of your GitLab OAuth provider. If you use your own instance of GitLab instead of gitlab.com, adjust `auth_url` by replacing the `gitlab.com` hostname with your own. | `https://gitlab.com/oauth/authorize` | +| `token_url` | Yes | Yes | Endpoint used to obtain GitLab OAuth access token. If you use your own instance of GitLab instead of gitlab.com, adjust `token_url` by replacing the `gitlab.com` hostname with your own. | `https://gitlab.com/oauth/token` | +| `api_url` | No | Yes | Grafana uses ` /user` endpoint to obtain GitLab user information compatible with [OpenID UserInfo](https://connect2id.com/products/server/docs/api/userinfo). | `https://gitlab.com/api/v4` | +| `name` | No | Yes | Name used to refer to the GitLab authentication in the Grafana user interface. | `GitLab` | +| `icon` | No | Yes | Icon used for GitLab authentication in the Grafana user interface. | `gitlab` | +| `scopes` | No | Yes | List of comma or space-separated GitLab OAuth scopes. | `openid email profile` | +| `allow_sign_up` | No | Yes | Whether to allow new Grafana user creation through GitLab login. If set to `false`, then only existing Grafana users can log in with GitLab OAuth. | `true` | +| `auto_login` | No | Yes | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | +| `role_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the GitLab OAuth token. If no role is found, Grafana creates a JSON data with `groups` key that maps to groups obtained from GitLab's `/oauth/userinfo` endpoint, and evaluates the expression using this data. Finally, if a valid role is still not found, the expression is evaluated against the user information retrieved from `api_url/users` endpoint and groups retrieved from `api_url/groups` endpoint. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | | +| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana role cannot be extracted using `role_attribute_path`. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | +| `org_mapping` | No | No | List of comma- or space-separated ` : : ` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | +| `skip_org_role_sync` | No | Yes | Set to `true` to stop automatically syncing user roles. | `false` | +| `allow_assign_grafana_admin` | No | No | Set to `true` to enable automatic sync of the Grafana server administrator role. If this option is set to `true` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user the server administrator privileges and organization administrator role. If this option is set to `false` and the result of evaluating `role_attribute_path` for a user is `GrafanaAdmin`, Grafana grants the user only organization administrator role. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | +| `allowed_domains` | No | Yes | List of comma or space-separated domains. User must belong to at least one domain to log in. | | +| `allowed_groups` | No | Yes | List of comma or space-separated groups. The user should be a member of at least one group to log in. | | +| `tls_skip_verify_insecure` | No | No | If set to `true`, the client accepts any certificate presented by the server and any host name in that certificate. _You should only use this for testing_, because this mode leaves SSL/TLS susceptible to man-in-the-middle attacks. | `false` | +| `tls_client_cert` | No | No | The path to the certificate. | | +| `tls_client_key` | No | No | The path to the key. | | +| `tls_client_ca` | No | No | The path to the trusted certificate authority list. | | +| `use_pkce` | No | Yes | Set to `true` to use [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636). Grafana uses the SHA256 based `S256` challenge method and a 128 bytes (base64url encoded) code verifier. | `true` | +| `use_refresh_token` | No | Yes | Set to `true` to use refresh token and check access token expiration. The `accessTokenExpirationCheck` feature toggle should also be enabled to use refresh token. | `true` | +| `signout_redirect_url` | No | Yes | URL to redirect to after the user logs out. | | diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md index f80bd7a9703..fed9af7ebd9 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/google/index.md @@ -1,7 +1,7 @@ --- aliases: - ../../../auth/google/ -description: Grafana OAuthentication Guide +description: Grafana Google OAuth Guide labels: products: - cloud diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/keycloak/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/keycloak/index.md index ebf55c834dc..0759f30428c 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/keycloak/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/keycloak/index.md @@ -1,7 +1,7 @@ --- aliases: - ../../../auth/keycloak/ -description: Keycloak Grafana OAuthentication Guide +description: Grafana Keycloak Guide keywords: - grafana - keycloak diff --git a/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md b/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md index dba1580f535..acf3e070cdd 100644 --- a/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md +++ b/docs/sources/setup-grafana/configure-security/configure-authentication/okta/index.md @@ -260,27 +260,32 @@ To learn more about Team Sync, refer to [Configure Team Sync]({{< relref "../../ ## Configuration options -The following table outlines the various Okta OIDC configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. +The following table outlines the various Okta OIDC configuration options. You can apply these options as environment variables, similar to any other configuration within Grafana. For more information, refer to [Override configuration with environment variables]({{< relref "../../../configure-grafana#override-configuration-with-environment-variables" >}}). -| Setting | Required | Description | Default | -| ----------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- | -| `enabled` | No | Enables Okta OIDC authentication. | `false` | -| `name` | No | Name that refers to the Okta OIDC authentication from the Grafana user interface. | `Okta` | -| `icon` | No | Icon used for the Okta OIDC authentication in the Grafana user interface. | `okta` | -| `client_id` | Yes | Client ID provided by your Okta OIDC app. | | -| `client_secret` | Yes | Client secret provided by your Okta OIDC app. | | -| `auth_url` | Yes | Authorization endpoint of your Okta OIDC provider. | | -| `token_url` | Yes | Endpoint used to obtain the Okta OIDC access token. | | -| `api_url` | Yes | Endpoint used to obtain user information. | | -| `scopes` | No | List of comma- or space-separated Okta OIDC scopes. | `openid profile email groups` | -| `allow_sign_up` | No | Controls Grafana user creation through the Okta OIDC login. Only existing Grafana users can log in with Okta OIDC if set to `false`. | `true` | -| `auto_login` | No | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | -| `role_attribute_path` | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the Okta OIDC ID token. If no role is found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | | -| `role_attribute_strict` | No | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | -| `org_attribute_path` | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana org to role lookup. The result of the evaluation will be mapped to org roles based on `org_mapping`. For more information on org to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | -| `org_mapping` | No | List of comma- or space-separated ` : : ` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | -| `skip_org_role_sync` | No | Set to `true` to stop automatically syncing user roles. This will allow you to set organization roles for your users from within Grafana manually. | `false` | -| `allowed_groups` | No | List of comma- or space-separated groups. The user should be a member of at least one group to log in. | | -| `allowed_domains` | No | List of comma- or space-separated domains. The user should belong to at least one domain to log in. | | -| `use_pkce` | No | Set to `true` to use [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636). Grafana uses the SHA256 based `S256` challenge method and a 128 bytes (base64url encoded) code verifier. | `true` | -| `use_refresh_token` | No | Set to `true` to use refresh token and check access token expiration. | `false` | +{{< admonition type="note" >}} +If the configuration option requires a JMESPath expression that includes a colon, enclose the entire expression in quotes to prevent parsing errors. For example `role_attribute_path: "role:view"` +{{< /admonition >}} + +| Setting | Required | Supported on Cloud | Description | Default | +| ----------------------- | -------- | ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------- | +| `enabled` | No | Yes | Enables Okta OIDC authentication. | `false` | +| `name` | No | Yes | Name that refers to the Okta OIDC authentication from the Grafana user interface. | `Okta` | +| `icon` | No | Yes | Icon used for the Okta OIDC authentication in the Grafana user interface. | `okta` | +| `client_id` | Yes | Yes | Client ID provided by your Okta OIDC app. | | +| `client_secret` | Yes | Yes | Client secret provided by your Okta OIDC app. | | +| `auth_url` | Yes | Yes | Authorization endpoint of your Okta OIDC provider. | | +| `token_url` | Yes | Yes | Endpoint used to obtain the Okta OIDC access token. | | +| `api_url` | Yes | Yes | Endpoint used to obtain user information. | | +| `scopes` | No | Yes | List of comma- or space-separated Okta OIDC scopes. | `openid profile email groups` | +| `allow_sign_up` | No | Yes | Controls Grafana user creation through the Okta OIDC login. Only existing Grafana users can log in with Okta OIDC if set to `false`. | `true` | +| `auto_login` | No | Yes | Set to `true` to enable users to bypass the login screen and automatically log in. This setting is ignored if you configure multiple auth providers to use auto-login. | `false` | +| `role_attribute_path` | No | Yes | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana role lookup. Grafana will first evaluate the expression using the Okta OIDC ID token. If no role is found, the expression will be evaluated using the user information obtained from the UserInfo endpoint. The result of the evaluation should be a valid Grafana role (`None`, `Viewer`, `Editor`, `Admin` or `GrafanaAdmin`). For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | | +| `role_attribute_strict` | No | Yes | Set to `true` to deny user login if the Grafana org role cannot be extracted using `role_attribute_path` or `org_mapping`. For more information on user role mapping, refer to [Configure role mapping]({{< relref "#configure-role-mapping" >}}). | `false` | +| `org_attribute_path` | No | No | [JMESPath](http://jmespath.org/examples.html) expression to use for Grafana org to role lookup. The result of the evaluation will be mapped to org roles based on `org_mapping`. For more information on org to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | +| `org_mapping` | No | No | List of comma- or space-separated ` : : ` mappings. Value can be `*` meaning "All users". Role is optional and can have the following values: `None`, `Viewer`, `Editor` or `Admin`. For more information on external organization to role mapping, refer to [Org roles mapping example](#org-roles-mapping-example). | | +| `skip_org_role_sync` | No | Yes | Set to `true` to stop automatically syncing user roles. This will allow you to set organization roles for your users from within Grafana manually. | `false` | +| `allowed_groups` | No | Yes | List of comma- or space-separated groups. The user should be a member of at least one group to log in. | | +| `allowed_domains` | No | Yes | List of comma- or space-separated domains. The user should belong to at least one domain to log in. | | +| `use_pkce` | No | Yes | Set to `true` to use [Proof Key for Code Exchange (PKCE)](https://datatracker.ietf.org/doc/html/rfc7636). Grafana uses the SHA256 based `S256` challenge method and a 128 bytes (base64url encoded) code verifier. | `true` | +| `use_refresh_token` | No | Yes | Set to `true` to use refresh token and check access token expiration. | `false` | +| `signout_redirect_url` | No | Yes | URL to redirect to after the user logs out. | | diff --git a/emails/templates/passwordless_verify_existing_user.mjml b/emails/templates/passwordless_verify_existing_user.mjml new file mode 100644 index 00000000000..1c583bc03ad --- /dev/null +++ b/emails/templates/passwordless_verify_existing_user.mjml @@ -0,0 +1,51 @@ + + + diff --git a/emails/templates/passwordless_verify_existing_user.txt b/emails/templates/passwordless_verify_existing_user.txt new file mode 100644 index 00000000000..ccc8f1f3d1d --- /dev/null +++ b/emails/templates/passwordless_verify_existing_user.txt @@ -0,0 +1,10 @@ +[[HiddenSubject .Subject "Verify your email"]] + +Hi, + +Copy and paste the email verification code: +[[.ConfirmationCode]] +into the login form to verify your email address. This confirmation code will expire in {{ .Expire }} minutes. +Alternatively, you can use the button below to verify your email address. + +[[.AppUrl]]login/?code=[[.Code]]&confirmationCode=[[.ConfirmationCode]] diff --git a/emails/templates/passwordless_verify_new_user.mjml b/emails/templates/passwordless_verify_new_user.mjml new file mode 100644 index 00000000000..d08457ea7e5 --- /dev/null +++ b/emails/templates/passwordless_verify_new_user.mjml @@ -0,0 +1,53 @@ ++ + + + + +{{ Subject .Subject .TemplateData "Verify your email" }} ++ + ++ ++ + ++ ++ ++ +Please verify your email
++ Copy and paste the confirmation code into the login form to verify your email address. This confirmation code + will expire in {{ .Expire }} minutes. + ++ ++ +{{ .ConfirmationCode }} ++ ++ +Alternatively, you can use the button below to verify your email address. ++ Verify your email + +You can also copy and paste this link into your browser directly: ++ {{ .AppUrl }}login?code={{ .Code }}&confirmationCode={{ .ConfirmationCode }} + ++ ++ + + diff --git a/emails/templates/passwordless_verify_new_user.txt b/emails/templates/passwordless_verify_new_user.txt new file mode 100644 index 00000000000..938d1dab934 --- /dev/null +++ b/emails/templates/passwordless_verify_new_user.txt @@ -0,0 +1,10 @@ +[[HiddenSubject .Subject "Welcome to Grafana, please complete your signup!"]] + +Hi, + +Copy and paste the email verification code: +[[.ConfirmationCode]] +into the sign up form to verify your email address. This confirmation code will expire in {{ .Expire }} minutes. +Alternatively, you can use the button below to verify your email address. + +[[.AppUrl]]login/?code=[[.Code]]&confirmationCode=[[.ConfirmationCode]] diff --git a/go.mod b/go.mod index 7b8fc74c59d..df73af80bc0 100644 --- a/go.mod +++ b/go.mod @@ -61,7 +61,7 @@ require ( github.com/go-stack/stack v1.8.1 // @grafana/grafana-backend-group github.com/gobwas/glob v0.2.3 // @grafana/grafana-backend-group github.com/gogo/protobuf v1.3.2 // @grafana/alerting-backend - github.com/golang-jwt/jwt/v4 v4.5.0 // @grafana/grafana-backend-group + github.com/golang-jwt/jwt/v4 v4.5.1 // @grafana/grafana-backend-group github.com/golang-migrate/migrate/v4 v4.7.0 // @grafana/grafana-backend-group github.com/golang/mock v1.6.0 // @grafana/alerting-backend github.com/golang/protobuf v1.5.4 // @grafana/grafana-backend-group diff --git a/go.sum b/go.sum index 31f3022ffb8..e87e90b4184 100644 --- a/go.sum +++ b/go.sum @@ -2060,8 +2060,9 @@ github.com/golang-jwt/jwt v3.2.1+incompatible/go.mod h1:8pz2t5EyA70fFQQSrl6XZXzq github.com/golang-jwt/jwt/v4 v4.0.0/go.mod h1:/xlHOz8bRuivTWchD4jCa+NbatV+wEUSzwAxVc6locg= github.com/golang-jwt/jwt/v4 v4.2.0/go.mod h1:/xlHOz8bRuivTWchD4jCa+NbatV+wEUSzwAxVc6locg= github.com/golang-jwt/jwt/v4 v4.4.2/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0= -github.com/golang-jwt/jwt/v4 v4.5.0 h1:7cYmW1XlMY7h7ii7UhUyChSgS5wUJEnm9uZVTGqOWzg= github.com/golang-jwt/jwt/v4 v4.5.0/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0= +github.com/golang-jwt/jwt/v4 v4.5.1 h1:JdqV9zKUdtaa9gdPlywC3aeoEsR681PlKC+4F5gQgeo= +github.com/golang-jwt/jwt/v4 v4.5.1/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0= github.com/golang-jwt/jwt/v5 v5.0.0/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk= github.com/golang-jwt/jwt/v5 v5.2.1 h1:OuVbFODueb089Lh128TAcimifWaLhJwVflnrgM17wHk= github.com/golang-jwt/jwt/v5 v5.2.1/go.mod h1:pqrtFR0X4osieyHYxtmOUWsAWrfe1Q5UVIyoH402zdk= diff --git a/package.json b/package.json index 5a422a6f0be..e7cf16bafa2 100644 --- a/package.json +++ b/package.json @@ -208,7 +208,7 @@ "knip": "^5.10.0", "lerna": "8.1.8", "mini-css-extract-plugin": "2.9.2", - "msw": "2.4.13", + "msw": "2.6.4", "mutationobserver-shim": "0.3.7", "ngtemplate-loader": "2.1.0", "node-notifier": "10.0.1", @@ -225,7 +225,7 @@ "redux-mock-store": "1.5.5", "rimraf": "6.0.1", "rudder-sdk-js": "2.48.26", - "sass": "1.79.5", + "sass": "1.80.7", "sass-loader": "16.0.3", "smtp-tester": "^2.1.0", "style-loader": "4.0.0", @@ -253,7 +253,7 @@ "@emotion/css": "11.13.4", "@emotion/react": "11.13.3", "@fingerprintjs/fingerprintjs": "^3.4.2", - "@floating-ui/react": "0.26.27", + "@floating-ui/react": "0.26.28", "@formatjs/intl-durationformat": "^0.6.0", "@glideapps/glide-data-grid": "^6.0.0", "@grafana/aws-sdk": "0.5.0", @@ -272,8 +272,8 @@ "@grafana/prometheus": "workspace:*", "@grafana/runtime": "workspace:*", "@grafana/saga-icons": "workspace:*", - "@grafana/scenes": "5.23.1", - "@grafana/scenes-react": "5.23.1", + "@grafana/scenes": "5.25.0", + "@grafana/scenes-react": "5.25.0", "@grafana/schema": "workspace:*", "@grafana/sql": "workspace:*", "@grafana/ui": "workspace:*", @@ -361,7 +361,7 @@ "prismjs": "1.29.0", "rc-slider": "11.1.7", "rc-time-picker": "3.7.3", - "rc-tree": "5.9.0", + "rc-tree": "5.10.1", "re-resizable": "6.10.1", "react": "18.2.0", "react-diff-viewer-continued": "^3.4.0", diff --git a/packages/grafana-data/src/types/config.ts b/packages/grafana-data/src/types/config.ts index ceda30f6674..50b9461ba19 100644 --- a/packages/grafana-data/src/types/config.ts +++ b/packages/grafana-data/src/types/config.ts @@ -278,5 +278,6 @@ export interface AuthSettings { GenericOAuthSkipOrgRoleSync?: boolean; disableLogin?: boolean; + passwordlessEnabled?: boolean; basicAuthStrongPasswordPolicy?: boolean; } diff --git a/packages/grafana-data/src/types/featureToggles.gen.ts b/packages/grafana-data/src/types/featureToggles.gen.ts index d3dbd6c2c7f..3d27b8456cf 100644 --- a/packages/grafana-data/src/types/featureToggles.gen.ts +++ b/packages/grafana-data/src/types/featureToggles.gen.ts @@ -35,7 +35,6 @@ export interface FeatureToggles { autoMigratePiechartPanel?: boolean; autoMigrateWorldmapPanel?: boolean; autoMigrateStatPanel?: boolean; - autoMigrateXYChartPanel?: boolean; disableAngular?: boolean; canvasPanelNesting?: boolean; vizActions?: boolean; @@ -232,9 +231,11 @@ export interface FeatureToggles { preinstallAutoUpdate?: boolean; dashboardSchemaV2?: boolean; playlistsWatcher?: boolean; + passwordlessMagicLinkAuthentication?: boolean; exploreMetricsRelatedLogs?: boolean; enableExtensionsAdminPage?: boolean; zipkinBackendMigration?: boolean; enableSCIM?: boolean; crashDetection?: boolean; + reportingUseRawTimeRange?: boolean; } diff --git a/packages/grafana-e2e-selectors/src/selectors/pages.ts b/packages/grafana-e2e-selectors/src/selectors/pages.ts index 3d84faa1538..92f73b85303 100644 --- a/packages/grafana-e2e-selectors/src/selectors/pages.ts +++ b/packages/grafana-e2e-selectors/src/selectors/pages.ts @@ -39,6 +39,19 @@ export const versionedPages = { '10.2.3': 'data-testid Skip change password button', }, }, + PasswordlessLogin: { + url: { + [MIN_GRAFANA_VERSION]: '/login/passwordless/authenticate', + }, + email: { + '10.2.3': 'data-testid Email input field', + [MIN_GRAFANA_VERSION]: 'Email input field', + }, + submit: { + '10.2.3': 'data-testid PasswordlessLogin button', + [MIN_GRAFANA_VERSION]: 'PasswordlessLogin button', + }, + }, Home: { url: { [MIN_GRAFANA_VERSION]: '/', diff --git a/packages/grafana-prometheus/package.json b/packages/grafana-prometheus/package.json index b305c672b5d..6d241e46306 100644 --- a/packages/grafana-prometheus/package.json +++ b/packages/grafana-prometheus/package.json @@ -37,10 +37,10 @@ }, "dependencies": { "@emotion/css": "11.13.4", - "@floating-ui/react": "0.26.27", + "@floating-ui/react": "0.26.28", "@grafana/data": "11.4.0-pre", "@grafana/experimental": "2.1.2", - "@grafana/faro-web-sdk": "1.11.0", + "@grafana/faro-web-sdk": "1.12.0", "@grafana/runtime": "11.4.0-pre", "@grafana/schema": "11.4.0-pre", "@grafana/ui": "11.4.0-pre", @@ -130,7 +130,7 @@ "rollup-plugin-dts": "^6.1.1", "rollup-plugin-esbuild": "6.1.1", "rollup-plugin-node-externals": "^7.1.3", - "sass": "1.79.5", + "sass": "1.80.7", "sass-loader": "16.0.3", "style-loader": "4.0.0", "testing-library-selector": "0.3.1", diff --git a/packages/grafana-prometheus/src/querybuilder/components/MetricSelect.tsx b/packages/grafana-prometheus/src/querybuilder/components/MetricSelect.tsx index 4aa698fa7cb..e983eb23be9 100644 --- a/packages/grafana-prometheus/src/querybuilder/components/MetricSelect.tsx +++ b/packages/grafana-prometheus/src/querybuilder/components/MetricSelect.tsx @@ -17,11 +17,11 @@ import { Icon, InlineField, InlineFieldRow, + ScrollContainer, SelectMenuOptions, useStyles2, useTheme2, } from '@grafana/ui'; -import { ScrollContainer } from '@grafana/ui/src/unstable'; import { PrometheusDatasource } from '../../datasource'; import { truncateResult } from '../../language_utils'; diff --git a/packages/grafana-runtime/src/services/SidecarContext_EXPERIMENTAL.ts b/packages/grafana-runtime/src/services/SidecarContext_EXPERIMENTAL.ts index 1597fb25b39..dd689499573 100644 --- a/packages/grafana-runtime/src/services/SidecarContext_EXPERIMENTAL.ts +++ b/packages/grafana-runtime/src/services/SidecarContext_EXPERIMENTAL.ts @@ -21,17 +21,20 @@ export function useSidecar_EXPERIMENTAL() { throw new Error('No SidecarContext found'); } - const activePluginId = useObservable(service.activePluginIdObservable, service.activePluginId); const initialContext = useObservable(service.initialContextObservable, service.initialContext); + const activePluginId = useObservable(service.activePluginIdObservable, service.activePluginId); + const locationService = service.getLocationService(); return { activePluginId, initialContext, + locationService, // TODO: currently this allows anybody to open any app, in the future we should probably scope this to the // current app but that means we will need to incorporate this better into the plugin platform APIs which // we will do once the functionality is reasonably stable - openApp: (pluginId: string) => service.openApp(pluginId), - closeApp: (pluginId: string) => service.closeApp(pluginId), + openApp: (pluginId: string, context?: unknown) => service.openApp(pluginId, context), + openAppV2: (pluginId: string, path?: string) => service.openAppV2(pluginId, path), + closeApp: () => service.closeApp(), isAppOpened: (pluginId: string) => service.isAppOpened(pluginId), }; } diff --git a/packages/grafana-runtime/src/services/SidecarService_EXPERIMENTAL.test.ts b/packages/grafana-runtime/src/services/SidecarService_EXPERIMENTAL.test.ts index a58d5483fd3..afa9f3aaf18 100644 --- a/packages/grafana-runtime/src/services/SidecarService_EXPERIMENTAL.test.ts +++ b/packages/grafana-runtime/src/services/SidecarService_EXPERIMENTAL.test.ts @@ -11,37 +11,51 @@ describe('SidecarService_EXPERIMENTAL', () => { }); it('has the correct state after opening and closing an app', () => { - const sidecarService = new SidecarService_EXPERIMENTAL({}); + const sidecarService = new SidecarService_EXPERIMENTAL(); sidecarService.openApp('pluginId', { filter: 'test' }); expect(sidecarService.activePluginId).toBe('pluginId'); expect(sidecarService.initialContext).toMatchObject({ filter: 'test' }); + expect(sidecarService.getLocationService().getLocation().pathname).toBe('/a/pluginId'); - sidecarService.closeApp('pluginId'); + sidecarService.closeApp(); expect(sidecarService.activePluginId).toBe(undefined); expect(sidecarService.initialContext).toBe(undefined); + expect(sidecarService.getLocationService().getLocation().pathname).toBe('/'); + }); + + it('has the correct state after opening and closing an app v2', () => { + const sidecarService = new SidecarService_EXPERIMENTAL(); + sidecarService.openAppV2('pluginId', '/test'); + + expect(sidecarService.activePluginId).toBe('pluginId'); + expect(sidecarService.getLocationService().getLocation().pathname).toBe('/a/pluginId/test'); + + sidecarService.closeApp(); + expect(sidecarService.activePluginId).toBe(undefined); + expect(sidecarService.initialContext).toBe(undefined); + expect(sidecarService.getLocationService().getLocation().pathname).toBe('/'); }); it('reports correct opened state', () => { - const sidecarService = new SidecarService_EXPERIMENTAL({}); + const sidecarService = new SidecarService_EXPERIMENTAL(); expect(sidecarService.isAppOpened('pluginId')).toBe(false); sidecarService.openApp('pluginId'); - expect(sidecarService.isAppOpened('pluginId')).toBe(true); - sidecarService.closeApp('pluginId'); - + sidecarService.closeApp(); expect(sidecarService.isAppOpened('pluginId')).toBe(false); }); - it('does not close app that is not opened', () => { - const sidecarService = new SidecarService_EXPERIMENTAL({}); - sidecarService.openApp('pluginId'); - - sidecarService.closeApp('foobar'); + it('reports correct opened state v2', () => { + const sidecarService = new SidecarService_EXPERIMENTAL(); + expect(sidecarService.isAppOpened('pluginId')).toBe(false); + sidecarService.openAppV2('pluginId'); expect(sidecarService.isAppOpened('pluginId')).toBe(true); - expect(sidecarService.activePluginId).toBe('pluginId'); + + sidecarService.closeApp(); + expect(sidecarService.isAppOpened('pluginId')).toBe(false); }); }); diff --git a/packages/grafana-runtime/src/services/SidecarService_EXPERIMENTAL.ts b/packages/grafana-runtime/src/services/SidecarService_EXPERIMENTAL.ts index 67e8dd776f7..c91d2dc9181 100644 --- a/packages/grafana-runtime/src/services/SidecarService_EXPERIMENTAL.ts +++ b/packages/grafana-runtime/src/services/SidecarService_EXPERIMENTAL.ts @@ -1,16 +1,14 @@ -import { BehaviorSubject } from 'rxjs'; +import * as H from 'history'; +import { pick } from 'lodash'; +import { BehaviorSubject, map, Observable } from 'rxjs'; import { config } from '../config'; -import { locationService } from './LocationService'; - -interface Options { - localStorageKey?: string; -} +import { HistoryWrapper, LocationService, locationService } from './LocationService'; /** * This is a service that handles state and operation of a sidecar feature (sideview to render a second app in grafana). - * At this moment this is highly experimental and if used should be understand to break easily with newer versions. + * At this moment this is highly experimental and if used should be understood to break easily with newer versions. * None of this functionality works without a feature toggle `appSidecar` being enabled. * * Right now this being in a single service is more of a practical tradeoff for easier isolation in the future these @@ -19,18 +17,16 @@ interface Options { * @experimental */ export class SidecarService_EXPERIMENTAL { - private _activePluginId: BehaviorSubject+ + + + + +{{ Subject .Subject .TemplateData "Welcome to Grafana, please complete your sign up!" }} ++ + ++ ++ + ++ ++ ++ +Please complete your signup
++ Copy and paste the confirmation code into the sign up form to verify your email address. This confirmation + code will expire in {{ .Expire }} minutes. + ++ ++ +{{ .ConfirmationCode }} ++ ++ +Alternatively, you can use the button below to complete your sign up. ++ Complete Sign Up + +You can also copy and paste this link into your browser directly: ++ {{ .AppUrl }}login?code={{ .Code }}&confirmationCode={{ .ConfirmationCode }}&signup=true + ++ ++ ; private _initialContext: BehaviorSubject ; - private localStorageKey: string | undefined; + private memoryLocationService: LocationService; + private history: LocationStorageHistory; - constructor(options: Options) { - this.localStorageKey = options.localStorageKey; - let initialId = undefined; - if (this.localStorageKey) { - initialId = localStorage.getItem(this.localStorageKey) || undefined; - } - this._activePluginId = new BehaviorSubject (initialId); + constructor() { this._initialContext = new BehaviorSubject (undefined); + // We need a local ref for this so we can tap into the location changes and drive rerendering of components based + // on it without having a parent Router. + this.history = createLocationStorageHistory({ storageKey: 'grafana.sidecar.history' }); + this.memoryLocationService = new HistoryWrapper(this.history); } private assertFeatureEnabled() { @@ -50,7 +46,11 @@ export class SidecarService_EXPERIMENTAL { * @experimental */ get activePluginIdObservable() { - return this._activePluginId.asObservable(); + return this.history.getLocationObservable().pipe( + map((val) => { + return getPluginIdFromUrl(val?.pathname || ''); + }) + ); } /** @@ -74,39 +74,48 @@ export class SidecarService_EXPERIMENTAL { * @experimental */ get activePluginId() { - return this._activePluginId.getValue(); + return getPluginIdFromUrl(this.memoryLocationService.getLocation().pathname); + } + + getLocationService() { + return this.memoryLocationService; } /** * Opens an app in a sidecar. You can also pass some context object that will be then available to the app. + * @deprecated * @experimental */ openApp(pluginId: string, context?: unknown) { if (!this.assertFeatureEnabled()) { return; } - if (this.localStorageKey) { - localStorage.setItem(this.localStorageKey, pluginId); + this._initialContext.next(context); + this.memoryLocationService.push({ pathname: `/a/${pluginId}` }); + } + + /** + * Opens an app in a sidecar. You can also relative path inside the app to open. + * @experimental + */ + openAppV2(pluginId: string, path?: string) { + if (!this.assertFeatureEnabled()) { + return; } - this._activePluginId.next(pluginId); - this._initialContext.next(context); + this.memoryLocationService.push({ pathname: `/a/${pluginId}${path || ''}` }); } /** * @experimental */ - closeApp(pluginId: string) { + closeApp() { if (!this.assertFeatureEnabled()) { return; } - if (this._activePluginId.getValue() === pluginId) { - if (this.localStorageKey) { - localStorage.removeItem(this.localStorageKey); - } - this._activePluginId.next(undefined); - this._initialContext.next(undefined); - } + + this._initialContext.next(undefined); + this.memoryLocationService.replace({ pathname: '/' }); } /** @@ -130,23 +139,23 @@ export class SidecarService_EXPERIMENTAL { return false; } - return !!( - this._activePluginId.getValue() && - (this._activePluginId.getValue() === pluginId || getMainAppPluginId() === pluginId) - ); + return !!(this.activePluginId && (this.activePluginId === pluginId || getMainAppPluginId() === pluginId)); } } -export const sidecarServiceSingleton_EXPERIMENTAL = new SidecarService_EXPERIMENTAL({ - localStorageKey: 'grafana.sidecar.activePluginId', -}); +const pluginIdUrlRegex = /a\/([^\/]+)/; +function getPluginIdFromUrl(url: string) { + return url.match(pluginIdUrlRegex)?.[1]; +} // The app plugin that is "open" in the main Grafana view function getMainAppPluginId() { + // TODO: not great but we have to get a handle on the other locationService used for the main view and easiest way + // right now is through this global singleton const { pathname } = locationService.getLocation(); // A naive way to sort of simulate core features being an app and having an appID - let mainApp = pathname.match(/\/a\/([^/]+)/)?.[1]; + let mainApp = getPluginIdFromUrl(pathname); if (!mainApp && pathname.match(/\/explore/)) { mainApp = 'explore'; } @@ -157,3 +166,88 @@ function getMainAppPluginId() { return mainApp || 'unknown'; } + +type LocalStorageHistoryOptions = { + storageKey: string; +}; + +interface LocationStorageHistory extends H.MemoryHistory { + getLocationObservable(): Observable ; +} + +/** + * Simple wrapper over the memory history that persists the location in the localStorage. + * + * @param options + */ +function createLocationStorageHistory(options: LocalStorageHistoryOptions): LocationStorageHistory { + const storedLocation = localStorage.getItem(options.storageKey); + const initialEntry = storedLocation ? JSON.parse(storedLocation) : '/'; + const locationSubject = new BehaviorSubject (initialEntry); + const memoryHistory = H.createMemoryHistory({ initialEntries: [initialEntry] }); + + let currentLocation = memoryHistory.location; + + function maybeUpdateLocation() { + if (memoryHistory.location !== currentLocation) { + localStorage.setItem( + options.storageKey, + JSON.stringify(pick(memoryHistory.location, 'pathname', 'search', 'hash')) + ); + currentLocation = memoryHistory.location; + locationSubject.next(memoryHistory.location); + } + } + + // This creates a sort of proxy over the memory location just to add the localStorage persistence and the location + // observer. We could achieve the same effect by a listener but that would create a memory leak as there would be no + // reasonable way to unsubcribe the listener later on. + // Another issue is that react router for some reason does not care about proper `this` binding and just calls these + // as normal functions. So if this were to be a class we would still need to bind each of these methods to the + // instance so at that moment this just seems easier. + return { + ...memoryHistory, + // Getter aren't destructured as getter but as values, so they have to be still here even though we are not + // modifying them. + get index() { + return memoryHistory.index; + }, + get entries() { + return memoryHistory.entries; + }, + get length() { + return memoryHistory.length; + }, + get action() { + return memoryHistory.action; + }, + get location() { + return memoryHistory.location; + }, + push(location: H.Path | H.LocationDescriptor , state?: H.LocationState) { + memoryHistory.push(location, state); + maybeUpdateLocation(); + }, + replace(location: H.Path | H.LocationDescriptor , state?: H.LocationState) { + memoryHistory.replace(location, state); + maybeUpdateLocation(); + }, + go(n: number) { + memoryHistory.go(n); + maybeUpdateLocation(); + }, + goBack() { + memoryHistory.goBack(); + maybeUpdateLocation(); + }, + goForward() { + memoryHistory.goForward(); + maybeUpdateLocation(); + }, + getLocationObservable() { + return locationSubject.asObservable(); + }, + }; +} + +export const sidecarServiceSingleton_EXPERIMENTAL = new SidecarService_EXPERIMENTAL(); diff --git a/packages/grafana-schema/src/raw/composable/nodegraph/panelcfg/x/NodeGraphPanelCfg_types.gen.ts b/packages/grafana-schema/src/raw/composable/nodegraph/panelcfg/x/NodeGraphPanelCfg_types.gen.ts index 357969cb116..7e1b4a63d64 100644 --- a/packages/grafana-schema/src/raw/composable/nodegraph/panelcfg/x/NodeGraphPanelCfg_types.gen.ts +++ b/packages/grafana-schema/src/raw/composable/nodegraph/panelcfg/x/NodeGraphPanelCfg_types.gen.ts @@ -21,6 +21,11 @@ export interface ArcOption { field?: string; } +export enum ZoomMode { + Cooperative = 'cooperative', + Greedy = 'greedy', +} + export interface Options { edges?: { /** @@ -46,4 +51,8 @@ export interface Options { */ arcs?: Array ; }; + /** + * How to handle zoom/scroll events in the node graph + */ + zoomMode?: ZoomMode; } diff --git a/packages/grafana-schema/src/raw/composable/xychart/panelcfg/x/XYChartPanelCfg_types.gen.ts b/packages/grafana-schema/src/raw/composable/xychart/panelcfg/x/XYChartPanelCfg_types.gen.ts index 8e98dfaa449..5e5267a9be4 100644 --- a/packages/grafana-schema/src/raw/composable/xychart/panelcfg/x/XYChartPanelCfg_types.gen.ts +++ b/packages/grafana-schema/src/raw/composable/xychart/panelcfg/x/XYChartPanelCfg_types.gen.ts @@ -12,66 +12,85 @@ import * as common from '@grafana/schema'; export const pluginVersion = "11.4.0-pre"; -/** - * Auto is "table" in the UI - */ +export enum PointShape { + Circle = 'circle', + Square = 'square', +} + export enum SeriesMapping { Auto = 'auto', Manual = 'manual', } -export enum ScatterShow { +export enum XYShowMode { Lines = 'lines', Points = 'points', PointsAndLines = 'points+lines', } /** - * Configuration for the Table/Auto mode + * NOTE: (copied from dashboard_kind.cue, since not exported) + * Matcher is a predicate configuration. Based on the config a set of field(s) or values is filtered in order to apply override / transformation. + * It comes with in id ( to resolve implementation from registry) and a configuration that’s specific to a particular matcher type. */ -export interface XYDimensionConfig { - exclude?: Array ; - frame: number; - x?: string; +export interface MatcherConfig { + /** + * The matcher id. This is used to find the matcher implementation from registry. + */ + id: string; + /** + * The matcher options. This is specific to the matcher implementation. + */ + options?: unknown; } -export const defaultXYDimensionConfig: Partial = { - exclude: [], +export const defaultMatcherConfig: Partial = { + id: '', }; export interface FieldConfig extends common.HideableFieldConfig, common.AxisConfig { - label?: common.VisibilityMode; - labelValue?: common.TextDimensionConfig; - lineColor?: common.ColorDimensionConfig; + fillOpacity?: number; lineStyle?: common.LineStyle; lineWidth?: number; - pointColor?: common.ColorDimensionConfig; - pointSize?: common.ScaleDimensionConfig; - show?: ScatterShow; + pointShape?: PointShape; + pointSize?: { + fixed?: number; + min?: number; + max?: number; + }; + pointStrokeWidth?: number; + show?: XYShowMode; } export const defaultFieldConfig: Partial = { - label: common.VisibilityMode.Auto, - show: ScatterShow.Points, + fillOpacity: 50, + show: XYShowMode.Points, }; -export interface ScatterSeriesConfig extends FieldConfig { - frame?: number; - name?: string; - x?: string; - y?: string; +export interface XYSeriesConfig { + color?: { + matcher: MatcherConfig; + }; + frame?: { + matcher: MatcherConfig; + }; + name?: { + fixed?: string; + }; + size?: { + matcher: MatcherConfig; + }; + x?: { + matcher: MatcherConfig; + }; + y?: { + matcher: MatcherConfig; + }; } export interface Options extends common.OptionsWithLegend, common.OptionsWithTooltip { - /** - * Table Mode (auto) - */ - dims: XYDimensionConfig; - /** - * Manual Mode - */ - series: Array ; - seriesMapping?: SeriesMapping; + mapping: SeriesMapping; + series: Array ; } export const defaultOptions: Partial = { diff --git a/packages/grafana-sql/src/components/QueryEditor.tsx b/packages/grafana-sql/src/components/QueryEditor.tsx index 3adffb79efb..487c4f2c1c9 100644 --- a/packages/grafana-sql/src/components/QueryEditor.tsx +++ b/packages/grafana-sql/src/components/QueryEditor.tsx @@ -14,11 +14,11 @@ import { QueryHeader, QueryHeaderProps } from './QueryHeader'; import { RawEditor } from './query-editor-raw/RawEditor'; import { VisualEditor } from './visual-query-builder/VisualEditor'; -interface SqlQueryEditorProps extends QueryEditorProps }> + + + ); +} + +const getStyles = (theme: GrafanaTheme2) => { + return { + container: css({ + marginBottom: 'unset', + marginLeft: theme.spacing(1), + }), + }; +}; diff --git a/packages/grafana-sql/src/datasource/SqlDatasource.ts b/packages/grafana-sql/src/datasource/SqlDatasource.ts index ce5d3bc7ea2..121d30a4731 100644 --- a/packages/grafana-sql/src/datasource/SqlDatasource.ts +++ b/packages/grafana-sql/src/datasource/SqlDatasource.ts @@ -30,7 +30,7 @@ import { } from '@grafana/runtime'; import { ResponseParser } from '../ResponseParser'; -import { SqlQueryEditor } from '../components/QueryEditor'; +import { SqlQueryEditorLazy } from '../components/QueryEditorLazy'; import { MACRO_NAMES } from '../constants'; import { DB, SQLQuery, SQLOptions, SqlQueryModel, QueryFormat } from '../types'; import migrateAnnotation from '../utils/migration'; @@ -63,7 +63,7 @@ export abstract class SqlDatasource extends DataSourceWithBackend ); + +const input = screen.getByRole('combobox'); +await userEvent.click(input); + +const item = await screen.findByRole('option', { name: 'Option 1' }); +await userEvent.click(item); +expect(screen.getByDisplayValue('Option 1')).toBeInTheDocument(); +``` + +#### Selecting option by typing + +```js +render( ); + +const input = screen.getByRole('combobox'); +await userEvent.type(input, 'Option 3'); +await userEvent.keyboard('{ArrowDown}{Enter}'); + +expect(screen.getByDisplayValue('Option 3')).toBeInTheDocument(); +``` + +## Props + + diff --git a/packages/grafana-ui/src/components/Combobox/Combobox.story.tsx b/packages/grafana-ui/src/components/Combobox/Combobox.story.tsx index 967b7537b8d..1b63c36bec1 100644 --- a/packages/grafana-ui/src/components/Combobox/Combobox.story.tsx +++ b/packages/grafana-ui/src/components/Combobox/Combobox.story.tsx @@ -11,12 +11,18 @@ import { Field } from '../Forms/Field'; import { AsyncSelect, Select } from '../Select/Select'; import { Combobox, ComboboxOption } from './Combobox'; +import mdx from './Combobox.mdx'; type PropsAndCustomArgs = ComponentProps & { numberOfOptions: number }; const meta: Meta = { title: 'Forms/Combobox', component: Combobox, + parameters: { + docs: { + page: mdx, + }, + }, args: { loading: undefined, invalid: undefined, diff --git a/packages/grafana-ui/src/components/Combobox/Combobox.test.tsx b/packages/grafana-ui/src/components/Combobox/Combobox.test.tsx index 1c3ac5766da..d45c2cc2402 100644 --- a/packages/grafana-ui/src/components/Combobox/Combobox.test.tsx +++ b/packages/grafana-ui/src/components/Combobox/Combobox.test.tsx @@ -166,7 +166,7 @@ describe('Combobox', () => { expect(onChangeHandler).toHaveBeenCalledWith(expect.objectContaining({ value: 'custom value' })); }); - it('should proivde custom string when all options are numbers', async () => { + it('should provide custom string when all options are numbers', async () => { const options = [ { label: '1', value: 1 }, { label: '2', value: 2 }, @@ -333,7 +333,7 @@ describe('Combobox', () => { jest.advanceTimersByTime(500); // Custom value while typing }); - const customItem = screen.queryByRole('option', { name: 'fir Create custom value' }); + const customItem = screen.queryByRole('option', { name: 'Custom value: fir' }); expect(customItem).toBeInTheDocument(); }); diff --git a/packages/grafana-ui/src/components/Combobox/Combobox.tsx b/packages/grafana-ui/src/components/Combobox/Combobox.tsx index eb8112ba6be..148c9e61cd3 100644 --- a/packages/grafana-ui/src/components/Combobox/Combobox.tsx +++ b/packages/grafana-ui/src/components/Combobox/Combobox.tsx @@ -5,6 +5,7 @@ import { debounce } from 'lodash'; import { ReactNode, useCallback, useId, useMemo, useState } from 'react'; import { useStyles2 } from '../../themes'; +import { logOptions } from '../../utils'; import { t, Trans } from '../../utils/i18n'; import { Icon } from '../Icon/Icon'; import { AutoSizeInput } from '../Input/AutoSizeInput'; @@ -13,8 +14,8 @@ import { Box } from '../Layout/Box/Box'; import { Stack } from '../Layout/Stack/Stack'; import { ScrollContainer } from '../ScrollContainer/ScrollContainer'; -import { getComboboxStyles } from './getComboboxStyles'; -import { useComboboxFloat, OPTION_HEIGHT } from './useComboboxFloat'; +import { getComboboxStyles, MENU_OPTION_HEIGHT } from './getComboboxStyles'; +import { useComboboxFloat } from './useComboboxFloat'; import { StaleResultError, useLatestAsyncCall } from './useLatestAsyncCall'; export type ComboboxOption = { @@ -27,7 +28,13 @@ export type ComboboxOption = { // then the onChange handler emits ComboboxOption with the label as non-undefined. interface ComboboxBaseProps extends Omit | null) => void; @@ -42,10 +49,18 @@ interface ComboboxBaseProps width?: number | 'auto'; } +const RECOMMENDED_ITEMS_AMOUNT = 100_000; + type AutoSizeConditionals = | { width: 'auto'; + /** + * Needs to be set when width is 'auto' to prevent the input from shrinking too much + */ minWidth: number; + /** + * Recommended to set when width is 'auto' to prevent the input from growing too much. + */ maxWidth?: number; } | { @@ -57,6 +72,9 @@ type AutoSizeConditionals = type ComboboxProps = ComboboxBaseProps & AutoSizeConditionals; function itemToString (item: ComboboxOption | null) { + if (item?.label?.includes('Custom value: ')) { + return item?.value.toString(); + } return item?.label ?? item?.value.toString() ?? ''; } @@ -108,15 +126,20 @@ export const Combobox = (props: ComboboxProps ) => const setItems = useCallback( (items: Array (props: ComboboxProps ) => baseSetItems(itemsToSet); }, - [createCustomValue] + [createCustomValue, id, ariaLabelledBy] ); const selectedItemIndex = useMemo(() => { @@ -162,7 +185,7 @@ export const Combobox = (props: ComboboxProps ) => const virtualizerOptions = { count: items.length, getScrollElement: () => scrollRef.current, - estimateSize: () => OPTION_HEIGHT, + estimateSize: () => MENU_OPTION_HEIGHT, overscan: 4, }; @@ -195,8 +218,6 @@ export const Combobox = (props: ComboboxProps ) => getMenuProps, getItemProps, - openMenu, - closeMenu, selectItem, } = useCombobox({ menuId, @@ -307,10 +328,6 @@ export const Combobox = (props: ComboboxProps ) => const { inputRef, floatingRef, floatStyles, scrollRef } = useComboboxFloat(items, rowVirtualizer.range, isOpen); - const handleSuffixClick = useCallback(() => { - isOpen ? closeMenu() : openMenu(); - }, [isOpen, openMenu, closeMenu]); - const InputComponent = width === 'auto' ? AutoSizeInput : Input; const suffixIcon = asyncLoading @@ -326,6 +343,7 @@ export const Combobox = (props: ComboboxProps ) => {!!value && value === selectedItem?.value && isClearable && ( @@ -346,11 +364,7 @@ export const Combobox = (props: ComboboxProps ) => /> )} - {/* When you click the input, it should just focus the text box. However, clicks on input suffix arent - translated to the input, so it blocks the input from being focused. So we need an additional event - handler here to open/close the menu. It should not have button role because we intentionally don't - want it in the a11y tree. */} - + } {...restProps} diff --git a/packages/grafana-ui/src/components/Combobox/getComboboxStyles.ts b/packages/grafana-ui/src/components/Combobox/getComboboxStyles.ts index c6926de6537..9b3ff494f7a 100644 --- a/packages/grafana-ui/src/components/Combobox/getComboboxStyles.ts +++ b/packages/grafana-ui/src/components/Combobox/getComboboxStyles.ts @@ -6,7 +6,12 @@ import { GrafanaTheme2 } from '@grafana/data'; // This should be in sync with the body font size in the theme. export const MENU_ITEM_FONT_SIZE = 14; export const MENU_ITEM_FONT_WEIGHT = 500; -export const MENU_ITEM_PADDING_X = 8; +export const MENU_ITEM_PADDING = 8; +export const MENU_ITEM_LINE_HEIGHT = 1.5; + +// Used with Downshift to get the height of each item +export const MENU_OPTION_HEIGHT = MENU_ITEM_PADDING * 2 + MENU_ITEM_FONT_SIZE * MENU_ITEM_LINE_HEIGHT; +export const POPOVER_MAX_HEIGHT = MENU_OPTION_HEIGHT * 8.5; export const getComboboxStyles = (theme: GrafanaTheme2) => { return { @@ -27,7 +32,7 @@ export const getComboboxStyles = (theme: GrafanaTheme2) => { }), option: css({ label: 'grafana-select-option', - padding: MENU_ITEM_PADDING_X, + padding: MENU_ITEM_PADDING, position: 'absolute', display: 'flex', alignItems: 'center', @@ -65,7 +70,7 @@ export const getComboboxStyles = (theme: GrafanaTheme2) => { fontWeight: 'normal', fontSize: theme.typography.bodySmall.fontSize, color: theme.colors.text.secondary, - lineHeight: theme.typography.body.lineHeight, + lineHeight: MENU_ITEM_LINE_HEIGHT, textOverflow: 'ellipsis', overflow: 'hidden', }), @@ -84,7 +89,7 @@ export const getComboboxStyles = (theme: GrafanaTheme2) => { borderRadius: theme.shape.radius.default, content: '" "', display: 'block', - height: '100%', + height: MENU_OPTION_HEIGHT, position: 'absolute', width: theme.spacing(0.5), left: 0, @@ -94,6 +99,7 @@ export const getComboboxStyles = (theme: GrafanaTheme2) => { clear: css({ label: 'grafana-select-clear', cursor: 'pointer', + pointerEvents: 'auto', '&:hover': { color: theme.colors.text.primary, }, @@ -102,5 +108,11 @@ export const getComboboxStyles = (theme: GrafanaTheme2) => { label: 'grafana-select-warning-icon', color: theme.colors.text.secondary, }), + input: css({ + label: 'grafana-select-input', + '> div > div:last-child': { + pointerEvents: 'none', + }, + }), }; }; diff --git a/packages/grafana-ui/src/components/Combobox/useComboboxFloat.ts b/packages/grafana-ui/src/components/Combobox/useComboboxFloat.ts index e2f7e3ac851..3a72680203f 100644 --- a/packages/grafana-ui/src/components/Combobox/useComboboxFloat.ts +++ b/packages/grafana-ui/src/components/Combobox/useComboboxFloat.ts @@ -4,15 +4,17 @@ import { useMemo, useRef, useState } from 'react'; import { measureText } from '../../utils'; import { ComboboxOption } from './Combobox'; -import { MENU_ITEM_FONT_SIZE, MENU_ITEM_FONT_WEIGHT, MENU_ITEM_PADDING_X } from './getComboboxStyles'; +import { + MENU_ITEM_FONT_SIZE, + MENU_ITEM_FONT_WEIGHT, + MENU_ITEM_PADDING, + MENU_OPTION_HEIGHT, + POPOVER_MAX_HEIGHT, +} from './getComboboxStyles'; // Only consider the first n items when calculating the width of the popover. const WIDTH_CALCULATION_LIMIT_ITEMS = 100_000; -// Used with Downshift to get the height of each item -export const OPTION_HEIGHT = 45; -const POPOVER_MAX_HEIGHT = OPTION_HEIGHT * 8.5; - // Clearance around the popover to prevent it from being too close to the edge of the viewport const POPOVER_PADDING = 16; @@ -41,7 +43,7 @@ export const useComboboxFloat = ( const preferredMaxHeight = availableHeight - POPOVER_PADDING; const width = Math.max(preferredMaxWidth, 0); - const height = Math.min(Math.max(preferredMaxHeight, OPTION_HEIGHT * 6), POPOVER_MAX_HEIGHT); + const height = Math.min(Math.max(preferredMaxHeight, MENU_OPTION_HEIGHT * 6), POPOVER_MAX_HEIGHT); setPopoverMaxSize({ width, height }); }, @@ -68,7 +70,7 @@ export const useComboboxFloat = ( const size = measureText(longestItem, MENU_ITEM_FONT_SIZE, MENU_ITEM_FONT_WEIGHT).width; - return size + MENU_ITEM_PADDING_X * 2 + scrollbarWidth; + return size + MENU_ITEM_PADDING * 2 + scrollbarWidth; }, [items, scrollbarWidth]); const floatStyles = { diff --git a/packages/grafana-ui/src/components/CustomScrollbar/CustomScrollbar.tsx b/packages/grafana-ui/src/components/CustomScrollbar/CustomScrollbar.tsx index ac775afbe97..541eb9c8db8 100644 --- a/packages/grafana-ui/src/components/CustomScrollbar/CustomScrollbar.tsx +++ b/packages/grafana-ui/src/components/CustomScrollbar/CustomScrollbar.tsx @@ -32,6 +32,7 @@ interface Props { /** * Wraps component into component from `react-custom-scrollbars` + * @deprecated Use `ScrollContainer` from `@grafana/ui` instead. It uses native scrollbars and has a simpler API. */ export const CustomScrollbar = ({ autoHide = false, diff --git a/packages/grafana-ui/src/components/DateTimePickers/TimeRangePicker/CalendarBody.tsx b/packages/grafana-ui/src/components/DateTimePickers/TimeRangePicker/CalendarBody.tsx index a70611dd109..e5e835dd188 100644 --- a/packages/grafana-ui/src/components/DateTimePickers/TimeRangePicker/CalendarBody.tsx +++ b/packages/grafana-ui/src/components/DateTimePickers/TimeRangePicker/CalendarBody.tsx @@ -1,7 +1,6 @@ import { css } from '@emotion/css'; import { useCallback } from 'react'; -import Calendar from 'react-calendar'; -import { CalendarType } from 'react-calendar/dist/cjs/shared/types'; +import Calendar, { CalendarType } from 'react-calendar'; import { GrafanaTheme2, dateTimeParse, DateTime, TimeZone } from '@grafana/data'; diff --git a/packages/grafana-ui/src/components/Input/AutoSizeInput.test.tsx b/packages/grafana-ui/src/components/Input/AutoSizeInput.test.tsx index f3372a6045d..148f35c6af3 100644 --- a/packages/grafana-ui/src/components/Input/AutoSizeInput.test.tsx +++ b/packages/grafana-ui/src/components/Input/AutoSizeInput.test.tsx @@ -58,6 +58,23 @@ describe('AutoSizeInput', () => { expect(getComputedStyle(inputWrapper).width).toBe('304px'); }); + it('should use placeholder for width if input is empty', () => { + render( ); + + const inputWrapper: HTMLDivElement = screen.getByTestId('input-wrapper'); + expect(getComputedStyle(inputWrapper).width).toBe('304px'); + }); + + it('should use value for width even with a placeholder', () => { + render( ); + + const input: HTMLInputElement = screen.getByTestId('autosize-input'); + const inputWrapper: HTMLDivElement = screen.getByTestId('input-wrapper'); + + fireEvent.change(input, { target: { value: 'very very long value' } }); + expect(getComputedStyle(inputWrapper).width).toBe('304px'); + }); + it('should call onBlur if set when blurring', () => { const onBlur = jest.fn(); const onCommitChange = jest.fn(); diff --git a/packages/grafana-ui/src/components/Input/AutoSizeInput.tsx b/packages/grafana-ui/src/components/Input/AutoSizeInput.tsx index 7d8eccee748..b6899a4caa3 100644 --- a/packages/grafana-ui/src/components/Input/AutoSizeInput.tsx +++ b/packages/grafana-ui/src/components/Input/AutoSizeInput.tsx @@ -24,6 +24,7 @@ export const AutoSizeInput = React.forwardRef // Your amazing scrolling content ; + ``` + + - After: + + ```tsx + const [scrollTop, setScrollTop] = useState(0); + const scrollRef = useRef(null); + + useEffect(() => { + scrollRef.current?.scrollTo(0, scrollTop); + }, [scrollTop]); + + return // Your amazing scrolling content ; + ``` + +### Props that have been removed and are no longer supported + +- `autoHide`, `autoHideTimeout` and `hideTracksWhenNotNeeded`. + - These props no longer make sense when using native scrollbars, since some operating systems (Windows for example) don't have overlay scrollbars. +- `className` + - Like our other design system components, the intention is that you'll never need to write custom CSS for this component. We extend all the base `Box` props, so everything _should_ be available as a prop. +- `updateAfterMountMs` + - This wasn't very react-y, and could cause inconsistent behaviour. + +diff --git a/packages/grafana-ui/src/components/ScrollContainer/ScrollContainer.story.tsx b/packages/grafana-ui/src/components/ScrollContainer/ScrollContainer.story.tsx new file mode 100644 index 00000000000..a633b347cf0 --- /dev/null +++ b/packages/grafana-ui/src/components/ScrollContainer/ScrollContainer.story.tsx @@ -0,0 +1,93 @@ +import { action } from '@storybook/addon-actions'; +import { Meta, StoryFn } from '@storybook/react'; + +import { ScrollContainer } from './ScrollContainer'; +import mdx from './ScrollContainer.mdx'; + +const meta: Meta = { + title: 'General/Layout/ScrollContainer', + component: ScrollContainer, + parameters: { + controls: { + exclude: ['onScroll'], + }, + docs: { + page: mdx, + }, + }, + argTypes: {}, + args: { + onScroll: action('onScroll'), + height: 50, + overflowX: 'auto', + overflowY: 'auto', + scrollbarWidth: 'thin', + showScrollIndicators: true, + width: 50, + }, +}; + +export const Basic: StoryFn = (args) => { + return ( + + + ); +}; + +export default meta; diff --git a/packages/grafana-ui/src/components/ScrollContainer/ScrollContainer.tsx b/packages/grafana-ui/src/components/ScrollContainer/ScrollContainer.tsx index 90d3514f545..42f2ae08683 100644 --- a/packages/grafana-ui/src/components/ScrollContainer/ScrollContainer.tsx +++ b/packages/grafana-ui/src/components/ScrollContainer/ScrollContainer.tsx @@ -9,7 +9,7 @@ import { Box, BoxProps } from '../Layout/Box/Box'; import { ScrollIndicators } from './ScrollIndicators'; -interface Props extends Omit+ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore + magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo + consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla + pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est + laborum. +
++ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore + magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo + consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla + pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est + laborum. +
++ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore + magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo + consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla + pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est + laborum. +
++ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore + magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo + consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla + pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est + laborum. +
++ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore + magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo + consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla + pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est + laborum. +
++ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore + magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo + consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla + pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est + laborum. +
++ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore + magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo + consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla + pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est + laborum. +
++ Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore + magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo + consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla + pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est + laborum. +
+; overflowX?: Property.OverflowX; diff --git a/packages/grafana-ui/src/components/Splitter/useSplitter.ts b/packages/grafana-ui/src/components/Splitter/useSplitter.ts index 325087bf683..dfb293ebbf7 100644 --- a/packages/grafana-ui/src/components/Splitter/useSplitter.ts +++ b/packages/grafana-ui/src/components/Splitter/useSplitter.ts @@ -6,6 +6,7 @@ import * as React from 'react'; import { GrafanaTheme2 } from '@grafana/data'; import { useStyles2 } from '../../themes'; +import { ComponentSize } from '../../types'; import { DragHandlePosition, getDragStyles } from '../DragHandle/DragHandle'; export interface UseSplitterOptions { @@ -21,6 +22,10 @@ export interface UseSplitterOptions { */ onSizeChanged?: (flexSize: number, pixelSize: number) => void; onResizing?: (flexSize: number, pixelSize: number) => void; + + // Size of the region left of the handle indicator that is responsive to dragging. At the same time acts as a margin + // pushing the left pane content left. + handleSize?: ComponentSize; } const PIXELS_PER_MS = 0.3 as const; @@ -45,7 +50,7 @@ const propsForDirection = { export function useSplitter(options: UseSplitterOptions) { const { direction, initialSize = 0.5, dragPosition = 'middle', onResizing, onSizeChanged } = options; - const handleSize = 16; + const handleSize = getPixelSize(options.handleSize); const splitterRef = useRef (null); const firstPaneRef = useRef (null); const secondPaneRef = useRef (null); @@ -413,3 +418,12 @@ function getStyles(theme: GrafanaTheme2, direction: UseSplitterOptions['directio panel: css({ display: 'flex', position: 'relative', flexBasis: 0 }), }; } + +function getPixelSize(size: ComponentSize = 'md') { + return { + xs: 4, + sm: 8, + md: 16, + lg: 32, + }[size]; +} diff --git a/packages/grafana-ui/src/components/index.ts b/packages/grafana-ui/src/components/index.ts index 5edf0b5e60d..a88b49db681 100644 --- a/packages/grafana-ui/src/components/index.ts +++ b/packages/grafana-ui/src/components/index.ts @@ -217,6 +217,7 @@ export { Box } from './Layout/Box/Box'; export { Stack } from './Layout/Stack/Stack'; export { Grid } from './Layout/Grid/Grid'; export { Space } from './Layout/Space'; +export { ScrollContainer } from './ScrollContainer/ScrollContainer'; export { Label } from './Forms/Label'; export { Field, type FieldProps } from './Forms/Field'; diff --git a/packages/grafana-ui/src/unstable.ts b/packages/grafana-ui/src/unstable.ts index 4ff84f73255..02938ddf2d2 100644 --- a/packages/grafana-ui/src/unstable.ts +++ b/packages/grafana-ui/src/unstable.ts @@ -10,4 +10,3 @@ */ export * from './utils/skeleton'; -export * from './components/ScrollContainer/ScrollContainer'; diff --git a/packages/grafana-ui/src/utils/index.ts b/packages/grafana-ui/src/utils/index.ts index be52f2352c0..20d5a6c3cff 100644 --- a/packages/grafana-ui/src/utils/index.ts +++ b/packages/grafana-ui/src/utils/index.ts @@ -18,5 +18,6 @@ export { createLogger } from './logger'; export { attachDebugger } from './debug'; export * from './nodeGraph'; export { fuzzyMatch } from './fuzzy'; +export { logOptions } from './logOptions'; export { ReactUtils }; diff --git a/packages/grafana-ui/src/utils/logOptions.test.ts b/packages/grafana-ui/src/utils/logOptions.test.ts new file mode 100644 index 00000000000..06e2ff8acc4 --- /dev/null +++ b/packages/grafana-ui/src/utils/logOptions.test.ts @@ -0,0 +1,30 @@ +import { logOptions } from './logOptions'; + +const RECOMMENDED_AMOUNT = 10; + +describe('logOptions', () => { + beforeEach(() => { + jest.clearAllMocks(); + }); + + it('should not log anything if amount is less than or equal to recommendedAmount', () => { + console.warn = jest.fn(); + + logOptions(5, RECOMMENDED_AMOUNT, 'test-id', 'test-aria'); + + expect(console.warn).not.toHaveBeenCalled(); + }); + + it('should log a warning if amount exceeds recommendedAmount', () => { + console.warn = jest.fn(); + + logOptions(15, RECOMMENDED_AMOUNT, 'test-id', 'test-aria'); + + expect(console.warn).toHaveBeenCalledWith('[Combobox] Items exceed the recommended amount 10.', { + itemsCount: '15', + recommendedAmount: '10', + 'aria-labelledby': 'test-aria', + id: 'test-id', + }); + }); +}); diff --git a/packages/grafana-ui/src/utils/logOptions.ts b/packages/grafana-ui/src/utils/logOptions.ts new file mode 100644 index 00000000000..b1a749c22a3 --- /dev/null +++ b/packages/grafana-ui/src/utils/logOptions.ts @@ -0,0 +1,23 @@ +/** + * This function logs a warning if the amount of items exceeds the recommended amount. + * + * @param amount + * @param id + * @param ariaLabelledBy + */ +export function logOptions( + amount: number, + recommendedAmount: number, + id: string | undefined, + ariaLabelledBy: string | undefined +): void { + if (amount > recommendedAmount) { + const msg = `[Combobox] Items exceed the recommended amount ${recommendedAmount}.`; + console.warn(msg, { + itemsCount: '' + amount, + recommendedAmount: '' + recommendedAmount, + 'aria-labelledby': ariaLabelledBy ?? '', + id: id ?? '', + }); + } +} diff --git a/pkg/aggregator/go.mod b/pkg/aggregator/go.mod index 3790453ad59..165efc59d59 100644 --- a/pkg/aggregator/go.mod +++ b/pkg/aggregator/go.mod @@ -50,6 +50,7 @@ require ( github.com/go-openapi/swag v0.23.0 // indirect github.com/goccy/go-json v0.10.3 // indirect github.com/gogo/protobuf v1.3.2 // indirect + github.com/golang-jwt/jwt/v4 v4.5.1 // indirect github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect github.com/golang/protobuf v1.5.4 // indirect github.com/google/btree v1.1.2 // indirect diff --git a/pkg/aggregator/go.sum b/pkg/aggregator/go.sum index 4ec4a96f9dc..5ea9ca39909 100644 --- a/pkg/aggregator/go.sum +++ b/pkg/aggregator/go.sum @@ -93,8 +93,8 @@ github.com/goccy/go-json v0.10.3/go.mod h1:oq7eo15ShAhp70Anwd5lgX2pLfOS3QCiwU/PU github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q= -github.com/golang-jwt/jwt/v4 v4.5.0 h1:7cYmW1XlMY7h7ii7UhUyChSgS5wUJEnm9uZVTGqOWzg= -github.com/golang-jwt/jwt/v4 v4.5.0/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0= +github.com/golang-jwt/jwt/v4 v4.5.1 h1:JdqV9zKUdtaa9gdPlywC3aeoEsR681PlKC+4F5gQgeo= +github.com/golang-jwt/jwt/v4 v4.5.1/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da h1:oI5xCqsCo564l8iNU+DwB5epxmsaqB+rhGL0m5jtYqE= github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da/go.mod h1:cIg4eruTrX1D+g88fzRXU5OdNfaM+9IcxsU14FzY7Hc= diff --git a/pkg/api/api.go b/pkg/api/api.go index 968aae01a84..adf60b406d7 100644 --- a/pkg/api/api.go +++ b/pkg/api/api.go @@ -78,6 +78,7 @@ func (hs *HTTPServer) registerRoutes() { r.Get("/logout", hs.Logout) r.Post("/login", requestmeta.SetOwner(requestmeta.TeamAuth), quota(string(auth.QuotaTargetSrv)), routing.Wrap(hs.LoginPost)) r.Get("/login/:name", quota(string(auth.QuotaTargetSrv)), hs.OAuthLogin) + r.Get("/login", hs.LoginView) r.Get("/invite/:code", hs.Index) @@ -207,6 +208,11 @@ func (hs *HTTPServer) registerRoutes() { r.Post("/api/user/email/start-verify", reqSignedInNoAnonymous, routing.Wrap(hs.StartEmailVerificaton)) } + if hs.Cfg.PasswordlessMagicLinkAuth.Enabled && hs.Features.IsEnabledGlobally(featuremgmt.FlagPasswordlessMagicLinkAuthentication) { + r.Post("/api/login/passwordless/start", requestmeta.SetOwner(requestmeta.TeamAuth), quota(string(auth.QuotaTargetSrv)), hs.StartPasswordless) + r.Post("/api/login/passwordless/authenticate", requestmeta.SetOwner(requestmeta.TeamAuth), quota(string(auth.QuotaTargetSrv)), routing.Wrap(hs.LoginPasswordless)) + } + // invited r.Get("/api/user/invite/:code", routing.Wrap(hs.GetInviteInfoByCode)) r.Post("/api/user/invite/complete", routing.Wrap(hs.CompleteInvite)) diff --git a/pkg/api/dtos/frontend_settings.go b/pkg/api/dtos/frontend_settings.go index 0799c4814fe..37a71629fde 100644 --- a/pkg/api/dtos/frontend_settings.go +++ b/pkg/api/dtos/frontend_settings.go @@ -33,6 +33,7 @@ type FrontendSettingsAuthDTO struct { DisableLogin bool `json:"disableLogin"` BasicAuthStrongPasswordPolicy bool `json:"basicAuthStrongPasswordPolicy"` + PasswordlessEnabled bool `json:"passwordlessEnabled"` } type FrontendSettingsBuildInfoDTO struct { @@ -253,6 +254,7 @@ type FrontendSettingsDTO struct { TokenExpirationDayLimit int `json:"tokenExpirationDayLimit"` SharedWithMeFolderUID string `json:"sharedWithMeFolderUID"` RootFolderUID string `json:"rootFolderUID"` + PasswordlessEnabled string `json:"passwordlessEnabled"` GeomapDefaultBaseLayerConfig *map[string]any `json:"geomapDefaultBaseLayerConfig,omitempty"` GeomapDisableCustomBaseLayer bool `json:"geomapDisableCustomBaseLayer"` diff --git a/pkg/api/frontendsettings.go b/pkg/api/frontendsettings.go index 3441ec56f0e..002bbbfd54c 100644 --- a/pkg/api/frontendsettings.go +++ b/pkg/api/frontendsettings.go @@ -360,6 +360,7 @@ func (hs *HTTPServer) getFrontendSettings(c *contextmodel.ReqContext) (*dtos.Fro OktaSkipOrgRoleSync: parseSkipOrgRoleSyncEnabled(oauthProviders[social.OktaProviderName]), DisableLogin: hs.Cfg.DisableLogin, BasicAuthStrongPasswordPolicy: hs.Cfg.BasicAuthStrongPasswordPolicy, + PasswordlessEnabled: hs.Cfg.PasswordlessMagicLinkAuth.Enabled && hs.Features.IsEnabled(c.Req.Context(), featuremgmt.FlagPasswordlessMagicLinkAuthentication), } if hs.pluginsCDNService != nil && hs.pluginsCDNService.IsEnabled() { diff --git a/pkg/api/login.go b/pkg/api/login.go index 338ccf5a24e..0361b133872 100644 --- a/pkg/api/login.go +++ b/pkg/api/login.go @@ -241,6 +241,26 @@ func (hs *HTTPServer) LoginPost(c *contextmodel.ReqContext) response.Response { return authn.HandleLoginResponse(c.Req, c.Resp, hs.Cfg, identity, hs.ValidateRedirectTo, hs.Features) } +func (hs *HTTPServer) LoginPasswordless(c *contextmodel.ReqContext) response.Response { + identity, err := hs.authnService.Login(c.Req.Context(), authn.ClientPasswordless, &authn.Request{HTTPRequest: c.Req}) + if err != nil { + tokenErr := &auth.CreateTokenErr{} + if errors.As(err, &tokenErr) { + return response.Error(tokenErr.StatusCode, tokenErr.ExternalErr, tokenErr.InternalErr) + } + return response.Err(err) + } + return authn.HandleLoginResponse(c.Req, c.Resp, hs.Cfg, identity, hs.ValidateRedirectTo, hs.Features) +} + +func (hs *HTTPServer) StartPasswordless(c *contextmodel.ReqContext) { + redirect, err := hs.authnService.RedirectURL(c.Req.Context(), authn.ClientPasswordless, &authn.Request{HTTPRequest: c.Req}) + if err != nil { + c.Redirect(hs.redirectURLWithErrorCookie(c, err)) + } + c.JSON(http.StatusOK, redirect) +} + func (hs *HTTPServer) loginUserWithUser(user *user.User, c *contextmodel.ReqContext) error { if user == nil { return errors.New("could not login user") diff --git a/pkg/apiserver/go.mod b/pkg/apiserver/go.mod index 342c8bc9fbb..97124b9b818 100644 --- a/pkg/apiserver/go.mod +++ b/pkg/apiserver/go.mod @@ -36,6 +36,7 @@ require ( github.com/go-openapi/jsonreference v0.21.0 // indirect github.com/go-openapi/swag v0.23.0 // indirect github.com/gogo/protobuf v1.3.2 // indirect + github.com/golang-jwt/jwt/v4 v4.5.1 // indirect github.com/golang/protobuf v1.5.4 // indirect github.com/google/btree v1.1.2 // indirect github.com/google/gnostic-models v0.6.8 // indirect diff --git a/pkg/apiserver/go.sum b/pkg/apiserver/go.sum index d5575dd60ef..afd78bfe636 100644 --- a/pkg/apiserver/go.sum +++ b/pkg/apiserver/go.sum @@ -52,8 +52,8 @@ github.com/go-task/slim-sprig/v3 v3.0.0/go.mod h1:W848ghGpv3Qj3dhTPRyJypKRiqCdHZ github.com/godbus/dbus/v5 v5.0.4/go.mod h1:xhWf0FNVPg57R7Z0UbKHbJfkEywrmjJnf7w5xrFpKfA= github.com/gogo/protobuf v1.3.2 h1:Ov1cvc58UF3b5XjBnZv7+opcTcQFZebYjWzi34vdm4Q= github.com/gogo/protobuf v1.3.2/go.mod h1:P1XiOD3dCwIKUDQYPy72D8LYyHL2YPYrpS2s69NZV8Q= -github.com/golang-jwt/jwt/v4 v4.5.0 h1:7cYmW1XlMY7h7ii7UhUyChSgS5wUJEnm9uZVTGqOWzg= -github.com/golang-jwt/jwt/v4 v4.5.0/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0= +github.com/golang-jwt/jwt/v4 v4.5.1 h1:JdqV9zKUdtaa9gdPlywC3aeoEsR681PlKC+4F5gQgeo= +github.com/golang-jwt/jwt/v4 v4.5.1/go.mod h1:m21LjoU+eqJr34lmDMbreY2eSTRJ1cv77w39/MY0Ch0= github.com/golang/glog v0.0.0-20160126235308-23def4e6c14b/go.mod h1:SBH7ygxi8pfUlaOkMMuAQtPIUF8ecWP5IEl/CR7VP2Q= github.com/golang/mock v1.1.1/go.mod h1:oTYuIxOrZwtPieC+H1uAHpcLFnEyAGVDL/k47Jfbm0A= github.com/golang/protobuf v1.2.0/go.mod h1:6lQm79b+lXiMfvg/cZm0SGofjICqVBUtrP5yJMmIC1U= diff --git a/pkg/plugins/backendplugin/coreplugin/registry.go b/pkg/plugins/backendplugin/coreplugin/registry.go index 43b0d78fc72..e346c7893af 100644 --- a/pkg/plugins/backendplugin/coreplugin/registry.go +++ b/pkg/plugins/backendplugin/coreplugin/registry.go @@ -186,8 +186,9 @@ func (l *logWrapper) Level() sdklog.Level { } func (l *logWrapper) With(args ...any) sdklog.Logger { - l.logger = l.logger.New(args...) - return l + return &logWrapper{ + logger: l.logger.New(args...), + } } func (l *logWrapper) FromContext(ctx context.Context) sdklog.Logger { diff --git a/pkg/plugins/backendplugin/coreplugin/registry_test.go b/pkg/plugins/backendplugin/coreplugin/registry_test.go index 1ca04daf3c7..2bb6bed4042 100644 --- a/pkg/plugins/backendplugin/coreplugin/registry_test.go +++ b/pkg/plugins/backendplugin/coreplugin/registry_test.go @@ -5,6 +5,7 @@ import ( "github.com/grafana/grafana-plugin-sdk-go/backend/httpclient" "github.com/grafana/grafana/pkg/infra/tracing" + "github.com/grafana/grafana/pkg/plugins/log" "github.com/grafana/grafana/pkg/services/featuremgmt" "github.com/grafana/grafana/pkg/setting" "github.com/stretchr/testify/require" @@ -62,3 +63,14 @@ func TestNewPlugin(t *testing.T) { }) } } + +func TestLogger(t *testing.T) { + t.Run("logger.With should create a new logger", func(t *testing.T) { + wrapper := &logWrapper{ + logger: log.New("test"), + } + newLogger := wrapper.With("key", "value") + + require.NotSame(t, newLogger.(*logWrapper).logger, wrapper.logger, "`With` should not return the same instance") + }) +} diff --git a/pkg/services/accesscontrol/dualwrite/collectors.go b/pkg/services/accesscontrol/dualwrite/collectors.go index 3607675f25c..a48219bab0a 100644 --- a/pkg/services/accesscontrol/dualwrite/collectors.go +++ b/pkg/services/accesscontrol/dualwrite/collectors.go @@ -17,7 +17,7 @@ func teamMembershipCollector(store db.DB) legacyTupleCollector { FROM team_member tm INNER JOIN team t ON tm.team_id = t.id INNER JOIN ` + store.GetDialect().Quote("user") + ` u ON tm.user_id = u.id - WHERE org_id = ? + WHERE t.org_id = ? ` type membership struct { @@ -109,7 +109,7 @@ func folderTreeCollector(store db.DB) legacyTupleCollector { } } -// managedPermissionsCollector collects managed permissions into provided tuple map. +// managedPermissionsCollector collects managed permissions. // It will only store actions that are supported by our schema. Managed permissions can // be directly mapped to user/team/role without having to write an intermediate role. func managedPermissionsCollector(store db.DB, kind string) legacyTupleCollector { @@ -195,6 +195,99 @@ func tupleStringWithoutCondition(tuple *openfgav1.TupleKey) string { return s } +// basicRolePermissionsCollector collects permissions for basic roles +func basicRolePermissionsCollector(store db.DB) legacyTupleCollector { + return func(ctx context.Context, _ int64) (map[string]map[string]*openfgav1.TupleKey, error) { + const query = ` + SELECT r.uid as role_uid, p.action, p.kind, p.identifier + FROM permission p + INNER JOIN role r ON p.role_id = r.id + LEFT JOIN builtin_role br ON r.id = br.role_id + WHERE r.name LIKE 'basic:%' + ` + type Permission struct { + Action string `xorm:"action"` + Kind string + Identifier string + RoleUID string `xorm:"role_uid"` + } + + var permissions []Permission + err := store.WithDbSession(ctx, func(sess *db.Session) error { + return sess.SQL(query).Find(&permissions) + }) + if err != nil { + return nil, err + } + + tuples := make(map[string]map[string]*openfgav1.TupleKey) + + for _, p := range permissions { + subject := zanzana.NewTupleEntry(zanzana.TypeRole, p.RoleUID, "assignee") + + tuple, ok := zanzana.TranslateToResourceTuple(subject, p.Action, p.Kind, p.Identifier) + if !ok { + continue + } + + if tuples[tuple.Object] == nil { + tuples[tuple.Object] = make(map[string]*openfgav1.TupleKey) + } + + tuples[tuple.Object][tuple.String()] = tuple + } + + return tuples, nil + } +} + +// basicRoleBindingsCollects collects role bindings for basic roles +func basicRoleBindingsCollector(store db.DB) legacyTupleCollector { + return func(ctx context.Context, orgID int64) (map[string]map[string]*openfgav1.TupleKey, error) { + query := ` + SELECT ou.org_id, u.uid as user_uid, ou.role as org_role + FROM org_user ou + LEFT JOIN ` + store.GetDialect().Quote("user") + ` u ON u.id = ou.user_id + WHERE ou.org_id = ? + AND NOT u.is_service_account + ` + // FIXME: handle service admin role + type Binding struct { + UserUID string `xorm:"user_uid"` + OrgRole string `xorm:"org_role"` + } + + var bindings []Binding + err := store.WithDbSession(ctx, func(sess *db.Session) error { + return sess.SQL(query, orgID).Find(&bindings) + }) + + if err != nil { + return nil, err + } + + tuples := make(map[string]map[string]*openfgav1.TupleKey) + + for _, b := range bindings { + subject := zanzana.NewTupleEntry(zanzana.TypeUser, b.UserUID, "") + + tuple := &openfgav1.TupleKey{ + User: subject, + Relation: zanzana.RelationAssignee, + Object: zanzana.NewTupleEntry(zanzana.TypeRole, zanzana.TranslateBasicRole(b.OrgRole), ""), + } + + if tuples[tuple.Object] == nil { + tuples[tuple.Object] = make(map[string]*openfgav1.TupleKey) + } + + tuples[tuple.Object][tuple.String()] = tuple + } + + return tuples, nil + } +} + func zanzanaCollector(relations []string) zanzanaTupleCollector { return func(ctx context.Context, client zanzana.Client, object string, namespace string) (map[string]*openfgav1.TupleKey, error) { // list will use continuation token to collect all tuples for object and relation diff --git a/pkg/services/accesscontrol/dualwrite/reconciler.go b/pkg/services/accesscontrol/dualwrite/reconciler.go index d0e4594933f..82364c8c259 100644 --- a/pkg/services/accesscontrol/dualwrite/reconciler.go +++ b/pkg/services/accesscontrol/dualwrite/reconciler.go @@ -64,6 +64,18 @@ func NewZanzanaReconciler(cfg *setting.Cfg, client zanzana.Client, store db.DB, zanzanaCollector(zanzana.ResourceRelations), client, ), + newResourceReconciler( + "basic role permissions", + basicRolePermissionsCollector(store), + zanzanaCollector(zanzana.FolderRelations), + client, + ), + newResourceReconciler( + "basic role bindings", + basicRoleBindingsCollector(store), + zanzanaCollector([]string{zanzana.RelationAssignee}), + client, + ), }, } } diff --git a/pkg/services/authn/authn.go b/pkg/services/authn/authn.go index a689fdfa0f7..5dcb9d45f5f 100644 --- a/pkg/services/authn/authn.go +++ b/pkg/services/authn/authn.go @@ -19,16 +19,17 @@ import ( ) const ( - ClientAPIKey = "auth.client.api-key" // #nosec G101 - ClientAnonymous = "auth.client.anonymous" - ClientBasic = "auth.client.basic" - ClientJWT = "auth.client.jwt" - ClientExtendedJWT = "auth.client.extended-jwt" - ClientRender = "auth.client.render" - ClientSession = "auth.client.session" - ClientForm = "auth.client.form" - ClientProxy = "auth.client.proxy" - ClientSAML = "auth.client.saml" + ClientAPIKey = "auth.client.api-key" // #nosec G101 + ClientAnonymous = "auth.client.anonymous" + ClientBasic = "auth.client.basic" + ClientJWT = "auth.client.jwt" + ClientExtendedJWT = "auth.client.extended-jwt" + ClientRender = "auth.client.render" + ClientSession = "auth.client.session" + ClientForm = "auth.client.form" + ClientProxy = "auth.client.proxy" + ClientSAML = "auth.client.saml" + ClientPasswordless = "auth.client.passwordless" ) const ( diff --git a/pkg/services/authn/authnimpl/registration.go b/pkg/services/authn/authnimpl/registration.go index 562f638565c..ea47102809c 100644 --- a/pkg/services/authn/authnimpl/registration.go +++ b/pkg/services/authn/authnimpl/registration.go @@ -17,10 +17,12 @@ import ( "github.com/grafana/grafana/pkg/services/ldap/service" "github.com/grafana/grafana/pkg/services/login" "github.com/grafana/grafana/pkg/services/loginattempt" + "github.com/grafana/grafana/pkg/services/notifications" "github.com/grafana/grafana/pkg/services/oauthtoken" "github.com/grafana/grafana/pkg/services/org" "github.com/grafana/grafana/pkg/services/quota" "github.com/grafana/grafana/pkg/services/rendering" + tempuser "github.com/grafana/grafana/pkg/services/temp_user" "github.com/grafana/grafana/pkg/services/user" "github.com/grafana/grafana/pkg/setting" ) @@ -38,7 +40,7 @@ func ProvideRegistration( features *featuremgmt.FeatureManager, oauthTokenService oauthtoken.OAuthTokenService, socialService social.Service, cache *remotecache.RemoteCache, ldapService service.LDAP, settingsProviderService setting.Provider, - tracer tracing.Tracer, + tracer tracing.Tracer, tempUserService tempuser.Service, notificationService notifications.Service, ) Registration { logger := log.New("authn.registration") @@ -78,6 +80,11 @@ func ProvideRegistration( } } + if cfg.PasswordlessMagicLinkAuth.Enabled && features.IsEnabledGlobally(featuremgmt.FlagPasswordlessMagicLinkAuthentication) { + passwordless := clients.ProvidePasswordless(cfg, loginAttempts, userService, tempUserService, notificationService, cache) + authnSvc.RegisterClient(passwordless) + } + if cfg.AuthProxy.Enabled && len(proxyClients) > 0 { proxy, err := clients.ProvideProxy(cfg, cache, proxyClients...) if err != nil { diff --git a/pkg/services/authn/clients/passwordless.go b/pkg/services/authn/clients/passwordless.go new file mode 100644 index 00000000000..701d7818789 --- /dev/null +++ b/pkg/services/authn/clients/passwordless.go @@ -0,0 +1,335 @@ +package clients + +import ( + "context" + "crypto/subtle" + "encoding/json" + "errors" + "fmt" + "strconv" + "time" + + "github.com/grafana/authlib/claims" + "github.com/grafana/grafana/pkg/apimachinery/errutil" + "github.com/grafana/grafana/pkg/infra/log" + "github.com/grafana/grafana/pkg/infra/remotecache" + "github.com/grafana/grafana/pkg/services/authn" + "github.com/grafana/grafana/pkg/services/login" + "github.com/grafana/grafana/pkg/services/loginattempt" + "github.com/grafana/grafana/pkg/services/notifications" + tempuser "github.com/grafana/grafana/pkg/services/temp_user" + "github.com/grafana/grafana/pkg/services/user" + "github.com/grafana/grafana/pkg/setting" + "github.com/grafana/grafana/pkg/util" + "github.com/grafana/grafana/pkg/web" +) + +var ( + errPasswordlessClientInvalidConfirmationCode = errutil.Unauthorized("passwordless.invalid.confirmation-code", errutil.WithPublicMessage("Invalid confirmation code")) + errPasswordlessClientTooManyLoginAttempts = errutil.Unauthorized("passwordless.invalid.login-attempt", errutil.WithPublicMessage("Login temporarily blocked")) + errPasswordlessClientInvalidEmail = errutil.Unauthorized("passwordless.invalid.email", errutil.WithPublicMessage("Invalid email")) + errPasswordlessClientCodeAlreadySent = errutil.Unauthorized("passwordless.invalid.code", errutil.WithPublicMessage("Code already sent to email")) + + errPasswordlessClientInternal = errutil.Internal("passwordless.failed", errutil.WithPublicMessage("An internal error occurred in the Passwordless client")) + + errPasswordlessClientMissingCode = errutil.BadRequest("passwordless.missing.code", errutil.WithPublicMessage("Missing code")) +) + +const passwordlessKeyPrefix = "passwordless-%s" + +var _ authn.RedirectClient = new(Passwordless) + +func ProvidePasswordless(cfg *setting.Cfg, loginAttempts loginattempt.Service, userService user.Service, tempUserService tempuser.Service, notificationService notifications.Service, cache remotecache.CacheStorage) *Passwordless { + return &Passwordless{cfg, loginAttempts, userService, tempUserService, notificationService, cache, log.New("authn.passwordless")} +} + +type PasswordlessCacheCodeEntry struct { + Email string `json:"email"` + ConfirmationCode string `json:"confirmation_code"` + SentDate string `json:"sent_date"` +} + +type PasswordlessCacheEmailEntry struct { + Code string `json:"code"` + SentDate string `json:"sent_date"` +} + +type Passwordless struct { + cfg *setting.Cfg + loginAttempts loginattempt.Service + userService user.Service + tempUserService tempuser.Service + notificationService notifications.Service + cache remotecache.CacheStorage + log log.Logger +} + +type EmailForm struct { + Email string `json:"email" binding:"required,email"` +} + +type PasswordlessForm struct { + Code string `json:"code" binding:"required"` + ConfirmationCode string `json:"confirmationCode" binding:"required"` + Name string `json:"name"` + Username string `json:"username"` +} + +// Authenticate implements authn.Client. +func (c *Passwordless) Authenticate(ctx context.Context, r *authn.Request) (*authn.Identity, error) { + var form PasswordlessForm + if err := web.Bind(r.HTTPRequest, &form); err != nil { + return nil, err + } + + return c.authenticatePasswordless(ctx, r, form) +} + +func (c *Passwordless) generateCodes() (string, string, error) { + alphabet := []byte("BCDFGHJKLMNPQRSTVWXZ") + confirmationCode, err := util.GetRandomString(8, alphabet...) + if err != nil { + return "", "", err + } + code, err := util.GetRandomString(32) + if err != nil { + return "", "", err + } + return confirmationCode, code, err +} + +// RedirectURL implements authn.RedirectClient. +func (c *Passwordless) RedirectURL(ctx context.Context, r *authn.Request) (*authn.Redirect, error) { + var form EmailForm + if err := web.Bind(r.HTTPRequest, &form); err != nil { + return nil, err + } + + // TODO: add IP address validation + ok, err := c.loginAttempts.Validate(ctx, form.Email) + if err != nil { + return nil, err + } + + if !ok { + return nil, errPasswordlessClientTooManyLoginAttempts.Errorf("too many consecutive incorrect login attempts for user - login for user temporarily blocked") + } + + err = c.loginAttempts.Add(ctx, form.Email, web.RemoteAddr(r.HTTPRequest)) + if err != nil { + return nil, err + } + + code, err := c.startPasswordless(ctx, form.Email) + if err != nil { + return nil, err + } + + return &authn.Redirect{ + URL: c.cfg.AppSubURL + "/login?code=" + code, + Extra: map[string]string{"code": code}, + }, nil +} + +func (c *Passwordless) IsEnabled() bool { + return true +} + +func (c *Passwordless) Name() string { + return authn.ClientPasswordless +} + +func (c *Passwordless) startPasswordless(ctx context.Context, email string) (string, error) { + // 1. check if is existing user with email or user invite with email + var existingUser *user.User + var tempUsers []*tempuser.TempUserDTO + var err error + + if !util.IsEmail(email) { + return "", errPasswordlessClientInvalidEmail.Errorf("invalid email %s", email) + } + + cacheKey := fmt.Sprintf(passwordlessKeyPrefix, email) + _, err = c.cache.Get(ctx, cacheKey) + if err != nil && !errors.Is(err, remotecache.ErrCacheItemNotFound) { + return "", errPasswordlessClientInternal.Errorf("cache error: %s", err) + } + + // if code already sent to email, return error + if err == nil { + return "", errPasswordlessClientCodeAlreadySent.Errorf("passwordless code already sent to email %s", email) + } + + existingUser, err = c.userService.GetByEmail(ctx, &user.GetUserByEmailQuery{Email: email}) + if err != nil && !errors.Is(err, user.ErrUserNotFound) { + return "", errPasswordlessClientInternal.Errorf("error retreiving user by email: %w - email: %s", err, email) + } + + if existingUser == nil { + tempUsers, err = c.tempUserService.GetTempUsersQuery(ctx, &tempuser.GetTempUsersQuery{Email: email, Status: tempuser.TmpUserInvitePending}) + + if err != nil && !errors.Is(err, tempuser.ErrTempUserNotFound) { + return "", err + } + if tempUsers == nil { + return "", errPasswordlessClientInvalidEmail.Errorf("no user or invite found with email %s", email) + } + } + + // 2. if existing user or temp user found, send email with passwordless link + confirmationCode, code, err := c.generateCodes() + if err != nil { + return "", err + } + + emailCmd := notifications.SendEmailCommand{ + To: []string{email}, + Data: map[string]any{ + "Email": email, + "ConfirmationCode": confirmationCode, + "Code": code, + "Expire": c.cfg.PasswordlessMagicLinkAuth.CodeExpiration.Minutes(), + }, + } + + if existingUser != nil { + emailCmd.Template = "passwordless_verify_existing_user" + } else { + emailCmd.Template = "passwordless_verify_new_user" + } + + err = c.notificationService.SendEmailCommandHandler(ctx, &emailCmd) + if err != nil { + return "", err + } + + sentDate := time.Now().Format(time.RFC3339) + + value := &PasswordlessCacheCodeEntry{ + Email: email, + ConfirmationCode: confirmationCode, + SentDate: sentDate, + } + valueBytes, err := json.Marshal(value) + if err != nil { + return "", err + } + + cacheKey = fmt.Sprintf(passwordlessKeyPrefix, code) + err = c.cache.Set(ctx, cacheKey, valueBytes, c.cfg.PasswordlessMagicLinkAuth.CodeExpiration) + if err != nil { + return "", errPasswordlessClientInternal.Errorf("cache error: %s", err) + } + + // second cache entry to lookup code by email + emailValue := &PasswordlessCacheEmailEntry{ + Code: code, + SentDate: sentDate, + } + valueBytes, err = json.Marshal(emailValue) + if err != nil { + return "", err + } + + cacheKey = fmt.Sprintf(passwordlessKeyPrefix, email) + err = c.cache.Set(ctx, cacheKey, valueBytes, c.cfg.PasswordlessMagicLinkAuth.CodeExpiration) + if err != nil { + return "", errPasswordlessClientInternal.Errorf("cache error: %s", err) + } + + return code, nil +} + +func (c *Passwordless) authenticatePasswordless(ctx context.Context, r *authn.Request, form PasswordlessForm) (*authn.Identity, error) { + code := form.Code + confirmationCode := form.ConfirmationCode + + if len(code) == 0 || len(confirmationCode) == 0 { + return nil, errPasswordlessClientMissingCode.Errorf("no code provided") + } + + cacheKey := fmt.Sprintf(passwordlessKeyPrefix, code) + jsonData, err := c.cache.Get(ctx, cacheKey) + if err != nil { + return nil, errPasswordlessClientInternal.Errorf("cache error: %s", err) + } + + var codeEntry PasswordlessCacheCodeEntry + err = json.Unmarshal(jsonData, &codeEntry) + if err != nil { + return nil, errPasswordlessClientInternal.Errorf("failed to parse entry from passwordless cache: %w - entry: %s", err, string(jsonData)) + } + + if subtle.ConstantTimeCompare([]byte(codeEntry.ConfirmationCode), []byte(confirmationCode)) != 1 { + return nil, errPasswordlessClientInvalidConfirmationCode + } + + ok, err := c.loginAttempts.Validate(ctx, codeEntry.Email) + if err != nil { + return nil, err + } + if !ok { + return nil, errPasswordlessClientTooManyLoginAttempts.Errorf("too many consecutive incorrect login attempts for user - login for user temporarily blocked") + } + + if err := c.loginAttempts.Reset(ctx, codeEntry.Email); err != nil { + c.log.Warn("could not reset login attempts", "err", err, "username", codeEntry.Email) + } + + usr, err := c.userService.GetByEmail(ctx, &user.GetUserByEmailQuery{Email: codeEntry.Email}) + if err != nil && !errors.Is(err, user.ErrUserNotFound) { + return nil, errPasswordlessClientInternal.Errorf("error retreiving user by email: %w - email: %s", err, codeEntry.Email) + } + + if usr == nil { + tempUsers, err := c.tempUserService.GetTempUsersQuery(ctx, &tempuser.GetTempUsersQuery{Email: codeEntry.Email, Status: tempuser.TmpUserInvitePending}) + if err != nil { + return nil, err + } + if tempUsers == nil { + return nil, errPasswordlessClientInvalidEmail.Errorf("no user or invite found with email %s", codeEntry.Email) + } + + createUserCmd := user.CreateUserCommand{ + Email: codeEntry.Email, + Login: form.Username, + Name: form.Name, + } + + // TODO: use user sync hook to create user + usr, err = c.userService.Create(ctx, &createUserCmd) + if err != nil { + return nil, err + } + + for _, tempUser := range tempUsers { + if err := c.tempUserService.UpdateTempUserStatus(ctx, &tempuser.UpdateTempUserStatusCommand{Code: tempUser.Code, Status: tempuser.TmpUserCompleted}); err != nil { + return nil, err + } + } + } + + // delete cache entry with code as key + err = c.cache.Delete(ctx, cacheKey) + if err != nil { + return nil, errPasswordlessClientInternal.Errorf("failed to delete entry from passwordless cache: %w - key: %s", err, cacheKey) + } + + // delete cache entry with email as key + cacheKey = fmt.Sprintf(passwordlessKeyPrefix, codeEntry.Email) + err = c.cache.Delete(ctx, cacheKey) + if err != nil { + return nil, errPasswordlessClientInternal.Errorf("failed to delete entry from passwordless cache: %w - key: %s", err, cacheKey) + } + + // user was found so set auth module in req metadata + r.SetMeta(authn.MetaKeyAuthModule, login.PasswordlessAuthModule) + + return &authn.Identity{ + ID: strconv.FormatInt(usr.ID, 10), + Type: claims.TypeUser, + OrgID: r.OrgID, + ClientParams: authn.ClientParams{FetchSyncedUser: true, SyncPermissions: true}, + AuthenticatedBy: login.PasswordlessAuthModule, + }, nil +} diff --git a/pkg/services/authn/clients/passwordless_test.go b/pkg/services/authn/clients/passwordless_test.go new file mode 100644 index 00000000000..0944d1b8a7b --- /dev/null +++ b/pkg/services/authn/clients/passwordless_test.go @@ -0,0 +1,160 @@ +package clients + +import ( + "context" + "testing" + + "github.com/stretchr/testify/assert" + + "github.com/grafana/authlib/claims" + "github.com/grafana/grafana/pkg/infra/remotecache" + "github.com/grafana/grafana/pkg/services/authn" + "github.com/grafana/grafana/pkg/services/login" + "github.com/grafana/grafana/pkg/services/loginattempt/loginattempttest" + "github.com/grafana/grafana/pkg/services/notifications" + tempuser "github.com/grafana/grafana/pkg/services/temp_user" + "github.com/grafana/grafana/pkg/services/temp_user/tempusertest" + "github.com/grafana/grafana/pkg/services/user" + "github.com/grafana/grafana/pkg/services/user/usertest" + "github.com/grafana/grafana/pkg/setting" + "github.com/grafana/grafana/pkg/util" +) + +func TestPasswordless_StartPasswordless(t *testing.T) { + type testCase struct { + desc string + email string + findUser bool + findTempUser bool + blockLogin bool + expectedErr error + } + + tests := []testCase{ + { + desc: "should succeed if user is found", + email: "user@domain.com", + findUser: true, + blockLogin: false, + }, + { + desc: "should succeed if temp user is found", + email: "user@domain.com", + findUser: false, + findTempUser: true, + blockLogin: false, + }, + { + desc: "should fail if user or temp user is not found", + email: "user@domain.com", + findUser: false, + findTempUser: false, + blockLogin: false, + expectedErr: errPasswordlessClientInvalidEmail.Errorf("no user or invite found with email user@domain.com"), + }, + } + + for _, tt := range tests { + t.Run(tt.desc, func(t *testing.T) { + hashed, _ := util.EncodePassword("password", "salt") + userService := &usertest.FakeUserService{ + ExpectedUser: &user.User{ID: 1, Email: "user@domain.com", Login: "user", Password: user.Password(hashed), Salt: "salt"}, + } + las := &loginattempttest.FakeLoginAttemptService{ExpectedValid: !tt.blockLogin} + tus := &tempusertest.FakeTempUserService{} + tus.GetTempUsersQueryFN = func(ctx context.Context, query *tempuser.GetTempUsersQuery) ([]*tempuser.TempUserDTO, error) { + return []*tempuser.TempUserDTO{{ + ID: 1, + Email: "user@domain.com", + Status: tempuser.TmpUserInvitePending, + EmailSent: true, + }}, nil + } + ns := notifications.MockNotificationService() + cache := remotecache.NewFakeCacheStorage() + + if !tt.findUser { + userService.ExpectedUser = nil + userService.ExpectedError = user.ErrUserNotFound + } + + if !tt.findTempUser { + tus.GetTempUsersQueryFN = func(ctx context.Context, query *tempuser.GetTempUsersQuery) ([]*tempuser.TempUserDTO, error) { + return nil, tempuser.ErrTempUserNotFound + } + } + + c := ProvidePasswordless(setting.NewCfg(), las, userService, tus, ns, cache) + _, err := c.startPasswordless(context.Background(), tt.email) + assert.ErrorIs(t, err, tt.expectedErr) + }) + } +} + +func TestPasswordless_AuthenticatePasswordless(t *testing.T) { + type testCase struct { + desc string + email string + findUser bool + blockLogin bool + expectedErr error + expectedIdentity *authn.Identity + } + + tests := []testCase{ + { + desc: "should successfully authenticate user with correct passwordless magic link", + email: "user@domain.com", + findUser: true, + blockLogin: false, + expectedIdentity: &authn.Identity{ + ID: "1", + Type: claims.TypeUser, + OrgID: 1, + AuthenticatedBy: login.PasswordlessAuthModule, + ClientParams: authn.ClientParams{FetchSyncedUser: true, SyncPermissions: true}, + }, + }, + { + desc: "should fail if login is blocked", + email: "user@domain.com", + findUser: true, + blockLogin: true, + expectedErr: errPasswordlessClientTooManyLoginAttempts.Errorf("too many consecutive incorrect login attempts for user - login for user temporarily blocked"), + }, + } + + for _, tt := range tests { + t.Run(tt.desc, func(t *testing.T) { + hashed, _ := util.EncodePassword("password", "salt") + userService := &usertest.FakeUserService{ + ExpectedUser: &user.User{ID: 1, Email: "user@domain.com", Login: "user", Password: user.Password(hashed), Salt: "salt"}, + } + las := &loginattempttest.FakeLoginAttemptService{ExpectedValid: !tt.blockLogin} + tus := &tempusertest.FakeTempUserService{} + ns := notifications.MockNotificationService() + cache := remotecache.NewFakeCacheStorage() + + if !tt.findUser { + userService.ExpectedUser = nil + userService.ExpectedError = user.ErrUserNotFound + } + + c := ProvidePasswordless(setting.NewCfg(), las, userService, tus, ns, cache) + code, err := c.startPasswordless(context.Background(), tt.email) + if err != nil { + t.Fatalf("failed to start passwordless: %v", err) + } + + form := &PasswordlessForm{ + Code: code, + ConfirmationCode: ns.Email.Data["ConfirmationCode"].(string), + Name: "user", + Username: "username", + } + identity, err := c.authenticatePasswordless(context.Background(), &authn.Request{OrgID: 1}, *form) + assert.ErrorIs(t, err, tt.expectedErr) + assert.EqualValues(t, tt.expectedIdentity, identity) + }) + } +} diff --git a/pkg/services/authz/zanzana/server/server.go b/pkg/services/authz/zanzana/server/server.go index 039af673649..27f12cf6aad 100644 --- a/pkg/services/authz/zanzana/server/server.go +++ b/pkg/services/authz/zanzana/server/server.go @@ -1,7 +1,6 @@ package server import ( - "errors" "sync" authzv1 "github.com/grafana/authlib/authz/proto/v1" @@ -25,19 +24,16 @@ var _ authzextv1.AuthzExtentionServiceServer = (*Server)(nil) var tracer = otel.Tracer("github.com/grafana/grafana/pkg/services/authz/zanzana/server") -var errStoreNotFound = errors.New("store not found") -var errAuthorizationModelNotInitialized = errors.New("authorization model not initialized") - type Server struct { authzv1.UnimplementedAuthzServiceServer authzextv1.UnimplementedAuthzExtentionServiceServer openfga openfgav1.OpenFGAServiceServer - logger log.Logger - modules []transformer.ModuleFile - storeMap map[string]storeInfo - storeLock *sync.Mutex + logger log.Logger + modules []transformer.ModuleFile + stores map[string]storeInfo + storesMU *sync.Mutex } type storeInfo struct { @@ -65,9 +61,9 @@ func NewAuthzServer(cfg *setting.Cfg, openfga openfgav1.OpenFGAServiceServer) (* func NewAuthz(openfga openfgav1.OpenFGAServiceServer, opts ...ServerOption) (*Server, error) { s := &Server{ - openfga: openfga, - storeLock: &sync.Mutex{}, - storeMap: make(map[string]storeInfo), + openfga: openfga, + storesMU: &sync.Mutex{}, + stores: make(map[string]storeInfo), } for _, o := range opts { diff --git a/pkg/services/authz/zanzana/server/server_check.go b/pkg/services/authz/zanzana/server/server_check.go index 5da418c4129..3bb77aaf182 100644 --- a/pkg/services/authz/zanzana/server/server_check.go +++ b/pkg/services/authz/zanzana/server/server_check.go @@ -21,7 +21,7 @@ func (s *Server) Check(ctx context.Context, r *authzv1.CheckRequest) (*authzv1.C } func (s *Server) checkTyped(ctx context.Context, r *authzv1.CheckRequest, info common.TypeInfo) (*authzv1.CheckResponse, error) { - storeInf, err := s.getNamespaceStore(ctx, r.Namespace) + storeInf, err := s.getStoreInfo(ctx, r.Namespace) if err != nil { return nil, err } @@ -64,7 +64,7 @@ func (s *Server) checkTyped(ctx context.Context, r *authzv1.CheckRequest, info c } func (s *Server) checkGeneric(ctx context.Context, r *authzv1.CheckRequest) (*authzv1.CheckResponse, error) { - storeInf, err := s.getNamespaceStore(ctx, r.Namespace) + storeInf, err := s.getStoreInfo(ctx, r.Namespace) if err != nil { return nil, err } diff --git a/pkg/services/authz/zanzana/server/server_list.go b/pkg/services/authz/zanzana/server/server_list.go index c2ea35e4020..a874ac5feee 100644 --- a/pkg/services/authz/zanzana/server/server_list.go +++ b/pkg/services/authz/zanzana/server/server_list.go @@ -24,7 +24,7 @@ func (s *Server) List(ctx context.Context, r *authzextv1.ListRequest) (*authzext } func (s *Server) listTyped(ctx context.Context, r *authzextv1.ListRequest, info common.TypeInfo) (*authzextv1.ListResponse, error) { - storeInf, err := s.getNamespaceStore(ctx, r.Namespace) + storeInf, err := s.getStoreInfo(ctx, r.Namespace) if err != nil { return nil, err } @@ -67,7 +67,7 @@ func (s *Server) listTyped(ctx context.Context, r *authzextv1.ListRequest, info } func (s *Server) listGeneric(ctx context.Context, r *authzextv1.ListRequest) (*authzextv1.ListResponse, error) { - storeInf, err := s.getNamespaceStore(ctx, r.Namespace) + storeInf, err := s.getStoreInfo(ctx, r.Namespace) if err != nil { return nil, err } diff --git a/pkg/services/authz/zanzana/server/server_list_test.go b/pkg/services/authz/zanzana/server/server_list_test.go index 520616b5736..cc7ef17126c 100644 --- a/pkg/services/authz/zanzana/server/server_list_test.go +++ b/pkg/services/authz/zanzana/server/server_list_test.go @@ -52,8 +52,16 @@ func testList(t *testing.T, server *Server) { require.NoError(t, err) assert.Len(t, res.GetItems(), 0) assert.Len(t, res.GetFolders(), 2) - assert.Equal(t, res.GetFolders()[0], "1") - assert.Equal(t, res.GetFolders()[1], "3") + + first := res.GetFolders()[0] + second := res.GetFolders()[1] + + if first == "3" { + first, second = second, first + } + + assert.Equal(t, first, "1") + assert.Equal(t, second, "3") }) t.Run("user:5 should be get list all dashboards.grafana.app/dashboards in folder 1 with set relation", func(t *testing.T) { diff --git a/pkg/services/authz/zanzana/server/server_read.go b/pkg/services/authz/zanzana/server/server_read.go index 4c0d238d401..eafecdf5f76 100644 --- a/pkg/services/authz/zanzana/server/server_read.go +++ b/pkg/services/authz/zanzana/server/server_read.go @@ -13,7 +13,7 @@ func (s *Server) Read(ctx context.Context, req *authzextv1.ReadRequest) (*authze ctx, span := tracer.Start(ctx, "authzServer.Read") defer span.End() - storeInf, err := s.getNamespaceStore(ctx, req.Namespace) + storeInf, err := s.getStoreInfo(ctx, req.Namespace) if err != nil { return nil, err } diff --git a/pkg/services/authz/zanzana/server/server_store.go b/pkg/services/authz/zanzana/server/server_store.go index 3e760c377da..8af1ca98ef9 100644 --- a/pkg/services/authz/zanzana/server/server_store.go +++ b/pkg/services/authz/zanzana/server/server_store.go @@ -2,7 +2,6 @@ package server import ( "context" - "errors" "fmt" openfgav1 "github.com/openfga/api/proto/openfga/v1" @@ -12,66 +11,35 @@ import ( "github.com/grafana/grafana/pkg/services/authz/zanzana/schema" ) -func (s *Server) getOrCreateStore(ctx context.Context, namespace string) (*openfgav1.Store, error) { - store, err := s.getStore(ctx, namespace) - - if errors.Is(err, errStoreNotFound) { - var res *openfgav1.CreateStoreResponse - res, err = s.openfga.CreateStore(ctx, &openfgav1.CreateStoreRequest{Name: namespace}) - if res != nil { - store = &openfgav1.Store{ - Id: res.GetId(), - Name: res.GetName(), - CreatedAt: res.GetCreatedAt(), - } - s.storeMap[res.GetName()] = storeInfo{ - Id: res.GetId(), - } - } +func (s *Server) getStoreInfo(ctx context.Context, namespace string) (*storeInfo, error) { + s.storesMU.Lock() + defer s.storesMU.Unlock() + info, ok := s.stores[namespace] + if ok { + return &info, nil } - return store, err -} - -func (s *Server) getStoreInfo(namespace string) (*storeInfo, error) { - info, ok := s.storeMap[namespace] - if !ok { - return nil, errStoreNotFound + store, err := s.getOrCreateStore(ctx, namespace) + if err != nil { + return nil, err } + modelID, err := s.loadModel(ctx, store.GetId(), schema.SchemaModules) + if err != nil { + return nil, err + } + + info = storeInfo{ + Id: store.GetId(), + AuthorizationModelId: modelID, + } + + s.stores[namespace] = info + return &info, nil } -func (s *Server) getStore(ctx context.Context, namespace string) (*openfgav1.Store, error) { - if len(s.storeMap) == 0 { - err := s.initStores(ctx) - if err != nil { - return nil, err - } - } - - storeInf, err := s.getStoreInfo(namespace) - if err != nil { - return nil, err - } - - res, err := s.openfga.GetStore(ctx, &openfgav1.GetStoreRequest{ - StoreId: storeInf.Id, - }) - if err != nil { - return nil, err - } - - store := &openfgav1.Store{ - Id: res.GetId(), - Name: res.GetName(), - CreatedAt: res.GetCreatedAt(), - } - - return store, nil -} - -func (s *Server) initStores(ctx context.Context) error { +func (s *Server) getOrCreateStore(ctx context.Context, namespace string) (*openfgav1.Store, error) { var continuationToken string for { @@ -81,13 +49,12 @@ func (s *Server) initStores(ctx context.Context) error { }) if err != nil { - return fmt.Errorf("failed to load zanzana stores: %w", err) + return nil, fmt.Errorf("failed to load zanzana stores: %w", err) } - for _, store := range res.GetStores() { - name := store.GetName() - s.storeMap[name] = storeInfo{ - Id: store.GetId(), + for _, s := range res.GetStores() { + if s.GetName() == namespace { + return s, nil } } @@ -99,10 +66,18 @@ func (s *Server) initStores(ctx context.Context) error { continuationToken = res.GetContinuationToken() } - return nil + res, err := s.openfga.CreateStore(ctx, &openfgav1.CreateStoreRequest{Name: namespace}) + if err != nil { + return nil, err + } + + return &openfgav1.Store{ + Id: res.GetId(), + Name: res.GetName(), + }, nil } -func (s *Server) loadModel(ctx context.Context, namespace string, modules []transformer.ModuleFile) (string, error) { +func (s *Server) loadModel(ctx context.Context, storeID string, modules []transformer.ModuleFile) (string, error) { var continuationToken string model, err := schema.TransformModulesToModel(modules) @@ -110,41 +85,27 @@ func (s *Server) loadModel(ctx context.Context, namespace string, modules []tran return "", err } - store, err := s.getStore(ctx, namespace) + // ReadAuthorizationModels returns authorization models for a store sorted in descending order of creation. + // So with a pageSize of 1 we will get the latest model. + res, err := s.openfga.ReadAuthorizationModels(ctx, &openfgav1.ReadAuthorizationModelsRequest{ + StoreId: storeID, + PageSize: &wrapperspb.Int32Value{Value: 1}, + ContinuationToken: continuationToken, + }) + if err != nil { - return "", err + return "", fmt.Errorf("failed to load authorization model: %w", err) } - for { - // ReadAuthorizationModels returns authorization models for a store sorted in descending order of creation. - // So with a pageSize of 1 we will get the latest model. - res, err := s.openfga.ReadAuthorizationModels(ctx, &openfgav1.ReadAuthorizationModelsRequest{ - StoreId: store.GetId(), - PageSize: &wrapperspb.Int32Value{Value: 20}, - ContinuationToken: continuationToken, - }) - - if err != nil { - return "", fmt.Errorf("failed to load authorization model: %w", err) + for _, m := range res.GetAuthorizationModels() { + // If provided dsl is equal to a stored dsl we use that as the authorization id + if schema.EqualModels(m, model) { + return m.GetId(), nil } - - for _, m := range res.GetAuthorizationModels() { - // If provided dsl is equal to a stored dsl we use that as the authorization id - if schema.EqualModels(m, model) { - return m.GetId(), nil - } - } - - // If we have not found any matching authorization model we break the loop and create a new one - if res.GetContinuationToken() == "" { - break - } - - continuationToken = res.GetContinuationToken() } writeRes, err := s.openfga.WriteAuthorizationModel(ctx, &openfgav1.WriteAuthorizationModelRequest{ - StoreId: store.GetId(), + StoreId: storeID, TypeDefinitions: model.GetTypeDefinitions(), SchemaVersion: model.GetSchemaVersion(), Conditions: model.GetConditions(), @@ -156,44 +117,3 @@ func (s *Server) loadModel(ctx context.Context, namespace string, modules []tran return writeRes.GetAuthorizationModelId(), nil } - -func (s *Server) getNamespaceStore(ctx context.Context, namespace string) (*storeInfo, error) { - var storeInf *storeInfo - var err error - - s.storeLock.Lock() - defer s.storeLock.Unlock() - - storeInf, err = s.getStoreInfo(namespace) - if errors.Is(err, errStoreNotFound) || storeInf.AuthorizationModelId == "" { - storeInf, err = s.initNamespaceStore(ctx, namespace) - } - if err != nil { - return nil, err - } - - return storeInf, nil -} - -func (s *Server) initNamespaceStore(ctx context.Context, namespace string) (*storeInfo, error) { - store, err := s.getOrCreateStore(ctx, namespace) - if err != nil { - return nil, err - } - - modules := schema.SchemaModules - modelID, err := s.loadModel(ctx, namespace, modules) - if err != nil { - return nil, err - } - - if info, ok := s.storeMap[store.GetName()]; ok { - s.storeMap[store.GetName()] = storeInfo{ - Id: info.Id, - AuthorizationModelId: modelID, - } - } - - updatedInfo := s.storeMap[store.GetName()] - return &updatedInfo, nil -} diff --git a/pkg/services/authz/zanzana/server/server_test.go b/pkg/services/authz/zanzana/server/server_test.go index 4800f38541e..9e04ceb117b 100644 --- a/pkg/services/authz/zanzana/server/server_test.go +++ b/pkg/services/authz/zanzana/server/server_test.go @@ -62,7 +62,7 @@ func setup(t *testing.T, testDB db.DB, cfg *setting.Cfg) *Server { require.NoError(t, err) namespace := "default" - storeInf, err := srv.initNamespaceStore(context.Background(), namespace) + storeInf, err := srv.getStoreInfo(context.Background(), namespace) require.NoError(t, err) // seed tuples diff --git a/pkg/services/authz/zanzana/server/server_write.go b/pkg/services/authz/zanzana/server/server_write.go index 38c36fdebf6..a8c76c0ebe3 100644 --- a/pkg/services/authz/zanzana/server/server_write.go +++ b/pkg/services/authz/zanzana/server/server_write.go @@ -13,13 +13,10 @@ func (s *Server) Write(ctx context.Context, req *authzextv1.WriteRequest) (*auth ctx, span := tracer.Start(ctx, "authzServer.Write") defer span.End() - storeInf, err := s.getNamespaceStore(ctx, req.Namespace) + storeInf, err := s.getStoreInfo(ctx, req.Namespace) if err != nil { return nil, err } - if storeInf.AuthorizationModelId == "" { - return nil, errAuthorizationModelNotInitialized - } writeTuples := make([]*openfgav1.TupleKey, 0) for _, t := range req.GetWrites().GetTupleKeys() { diff --git a/pkg/services/authz/zanzana/translations.go b/pkg/services/authz/zanzana/translations.go index 150f9e25bc1..8432614c7db 100644 --- a/pkg/services/authz/zanzana/translations.go +++ b/pkg/services/authz/zanzana/translations.go @@ -5,6 +5,22 @@ import ( folderalpha1 "github.com/grafana/grafana/pkg/apis/folder/v0alpha1" ) +const ( + roleGrafanaAdmin = "Grafana Admin" + roleAdmin = "Admin" + roleEditor = "Editor" + roleViewer = "Viewer" + roleNone = "None" +) + +var basicRolesTranslations = map[string]string{ + roleGrafanaAdmin: "basic_grafana_admin", + roleAdmin: "basic_admin", + roleEditor: "basic_editor", + roleViewer: "basic_viewer", + roleNone: "basic_none", +} + type resourceTranslation struct { typ string group string diff --git a/pkg/services/authz/zanzana/zanzana.go b/pkg/services/authz/zanzana/zanzana.go index ac951b79ba4..2001d248780 100644 --- a/pkg/services/authz/zanzana/zanzana.go +++ b/pkg/services/authz/zanzana/zanzana.go @@ -73,19 +73,6 @@ const ( KindFolders string = "folders" ) -const ( - RoleGrafanaAdmin = "Grafana Admin" - RoleAdmin = "Admin" - RoleEditor = "Editor" - RoleViewer = "Viewer" - RoleNone = "None" - - BasicRolePrefix = "basic:" - BasicRoleUIDPrefix = "basic_" - - GlobalOrgID = 0 -) - var ( ToAuthzExtTupleKey = common.ToAuthzExtTupleKey ToAuthzExtTupleKeys = common.ToAuthzExtTupleKeys @@ -98,11 +85,11 @@ var ( ToOpenFGATupleKeyWithoutCondition = common.ToOpenFGATupleKeyWithoutCondition ) -// NewTupleEntry constructs new openfga entry type:id[#relation]. -// Relation allows to specify group of users (subjects) related to type:id +// NewTupleEntry constructs new openfga entry type:name[#relation]. +// Relation allows to specify group of users (subjects) related to type:name // (for example, team:devs#member refers to users which are members of team devs) -func NewTupleEntry(objectType, id, relation string) string { - obj := fmt.Sprintf("%s:%s", objectType, id) +func NewTupleEntry(objectType, name, relation string) string { + obj := fmt.Sprintf("%s:%s", objectType, name) if relation != "" { obj = fmt.Sprintf("%s#%s", obj, relation) } @@ -121,6 +108,10 @@ func TranslateToResourceTuple(subject string, action, kind, name string) (*openf return nil, false } + if name == "*" { + return common.NewNamespaceResourceTuple(subject, m.relation, translation.group, translation.resource), true + } + if translation.typ == TypeResource { return common.NewResourceTuple(subject, m.relation, translation.group, translation.resource, name), true } @@ -174,3 +165,7 @@ func TranslateToCheckRequest(namespace, action, kind, folder, name string) (*aut return req, true } + +func TranslateBasicRole(name string) string { + return basicRolesTranslations[name] +} diff --git a/pkg/services/featuremgmt/codeowners.go b/pkg/services/featuremgmt/codeowners.go index 84372c99ffb..85bb0739e32 100644 --- a/pkg/services/featuremgmt/codeowners.go +++ b/pkg/services/featuremgmt/codeowners.go @@ -7,7 +7,6 @@ type codeowner string const ( grafanaAppPlatformSquad codeowner = "@grafana/grafana-app-platform-squad" grafanaDashboardsSquad codeowner = "@grafana/dashboards-squad" - grafanaExploreSquad codeowner = "@grafana/explore-squad" grafanaDatavizSquad codeowner = "@grafana/dataviz-squad" grafanaFrontendPlatformSquad codeowner = "@grafana/grafana-frontend-platform" grafanaBackendGroup codeowner = "@grafana/grafana-backend-group" diff --git a/pkg/services/featuremgmt/registry.go b/pkg/services/featuremgmt/registry.go index 687326cefb8..235197f6e30 100644 --- a/pkg/services/featuremgmt/registry.go +++ b/pkg/services/featuremgmt/registry.go @@ -96,7 +96,7 @@ var ( Name: "correlations", Description: "Correlations page", Stage: FeatureStageGeneralAvailability, - Owner: grafanaExploreSquad, + Owner: grafanaDatavizSquad, Expression: "true", // enabled by default AllowSelfServe: true, }, @@ -142,14 +142,6 @@ var ( FrontendOnly: true, Owner: grafanaDatavizSquad, }, - { - Name: "autoMigrateXYChartPanel", - Description: "Migrate old XYChart panel to new XYChart2 model", - Stage: FeatureStageGeneralAvailability, - FrontendOnly: true, - Expression: "true", // enabled by default - Owner: grafanaDatavizSquad, - }, { Name: "disableAngular", Description: "Dynamic flag to disable angular at runtime. The preferred method is to set `angular_support_enabled` to `false` in the [security] settings, which allows you to change the state at runtime.", @@ -1232,7 +1224,7 @@ var ( Name: "queryLibrary", Description: "Enables Query Library feature in Explore", Stage: FeatureStageExperimental, - Owner: grafanaExploreSquad, + Owner: grafanaFrontendPlatformSquad, FrontendOnly: false, AllowSelfServe: false, }, @@ -1456,7 +1448,7 @@ var ( { Name: "singleTopNav", Description: "Unifies the top search bar and breadcrumb bar into one", - Stage: FeatureStageExperimental, + Stage: FeatureStagePublicPreview, FrontendOnly: true, Owner: grafanaFrontendPlatformSquad, }, @@ -1500,7 +1492,7 @@ var ( Name: "appSidecar", Description: "Enable the app sidecar feature that allows rendering 2 apps at the same time", Stage: FeatureStageExperimental, - Owner: grafanaExploreSquad, + Owner: grafanaFrontendPlatformSquad, }, { Name: "groupAttributeSync", @@ -1584,8 +1576,9 @@ var ( { Name: "preinstallAutoUpdate", Description: "Enables automatic updates for pre-installed plugins", - Stage: FeatureStageExperimental, + Stage: FeatureStageGeneralAvailability, Owner: grafanaPluginsPlatformSquad, + Expression: "true", // enabled by default }, { Name: "dashboardSchemaV2", @@ -1601,6 +1594,15 @@ var ( Owner: grafanaAppPlatformSquad, RequiresRestart: true, }, + { + Name: "passwordlessMagicLinkAuthentication", + Description: "Enable passwordless login via magic link authentication", + Stage: FeatureStageExperimental, + Owner: identityAccessTeam, + HideFromDocs: true, + HideFromAdminPage: true, + AllowSelfServe: false, + }, { Name: "exploreMetricsRelatedLogs", Description: "Display Related Logs in Explore Metrics", @@ -1635,6 +1637,13 @@ var ( Owner: grafanaObservabilityTracesAndProfilingSquad, FrontendOnly: true, }, + { + Name: "reportingUseRawTimeRange", + Description: "Uses the original report or dashboard time range instead of making an absolute transformation", + Stage: FeatureStagePublicPreview, + Owner: grafanaSharingSquad, + Expression: "false", // disabled by default + }, } ) diff --git a/pkg/services/featuremgmt/toggles_gen.csv b/pkg/services/featuremgmt/toggles_gen.csv index cac9fde8832..16125721adb 100644 --- a/pkg/services/featuremgmt/toggles_gen.csv +++ b/pkg/services/featuremgmt/toggles_gen.csv @@ -9,14 +9,13 @@ publicDashboardsScene,GA,@grafana/sharing-squad,false,false,true lokiExperimentalStreaming,experimental,@grafana/observability-logs,false,false,false featureHighlights,GA,@grafana/grafana-as-code,false,false,false storage,experimental,@grafana/search-and-storage,false,false,false -correlations,GA,@grafana/explore-squad,false,false,false +correlations,GA,@grafana/dataviz-squad,false,false,false autoMigrateOldPanels,preview,@grafana/dataviz-squad,false,false,true autoMigrateGraphPanel,preview,@grafana/dataviz-squad,false,false,true autoMigrateTablePanel,preview,@grafana/dataviz-squad,false,false,true autoMigratePiechartPanel,preview,@grafana/dataviz-squad,false,false,true autoMigrateWorldmapPanel,preview,@grafana/dataviz-squad,false,false,true autoMigrateStatPanel,preview,@grafana/dataviz-squad,false,false,true -autoMigrateXYChartPanel,GA,@grafana/dataviz-squad,false,false,true disableAngular,preview,@grafana/dataviz-squad,false,false,true canvasPanelNesting,experimental,@grafana/dataviz-squad,false,false,true vizActions,experimental,@grafana/dataviz-squad,false,false,true @@ -161,7 +160,7 @@ cloudWatchNewLabelParsing,GA,@grafana/aws-datasources,false,false,false accessActionSets,GA,@grafana/identity-access-team,false,false,false disableNumericMetricsSortingInExpressions,experimental,@grafana/observability-metrics,false,true,false grafanaManagedRecordingRules,experimental,@grafana/alerting-squad,false,false,false -queryLibrary,experimental,@grafana/explore-squad,false,false,false +queryLibrary,experimental,@grafana/grafana-frontend-platform,false,false,false logsExploreTableDefaultVisualization,experimental,@grafana/observability-logs,false,false,true newDashboardSharingComponent,GA,@grafana/sharing-squad,false,false,true alertingListViewV2,experimental,@grafana/alerting-squad,false,false,true @@ -191,13 +190,13 @@ dataplaneAggregator,experimental,@grafana/grafana-app-platform-squad,false,true, newFiltersUI,experimental,@grafana/dashboards-squad,false,false,false lokiSendDashboardPanelNames,experimental,@grafana/observability-logs,false,false,false alertingPrometheusRulesPrimary,experimental,@grafana/alerting-squad,false,false,true -singleTopNav,experimental,@grafana/grafana-frontend-platform,false,false,true +singleTopNav,preview,@grafana/grafana-frontend-platform,false,false,true exploreLogsShardSplitting,experimental,@grafana/observability-logs,false,false,true exploreLogsAggregatedMetrics,experimental,@grafana/observability-logs,false,false,true exploreLogsLimitedTimeRange,experimental,@grafana/observability-logs,false,false,true homeSetupGuide,experimental,@grafana/growth-and-onboarding,false,false,true appPlatformGrpcClientAuth,experimental,@grafana/identity-access-team,false,false,false -appSidecar,experimental,@grafana/explore-squad,false,false,false +appSidecar,experimental,@grafana/grafana-frontend-platform,false,false,false groupAttributeSync,privatePreview,@grafana/identity-access-team,false,false,false alertingQueryAndExpressionsStepMode,experimental,@grafana/alerting-squad,false,false,true improvedExternalSessionHandling,experimental,@grafana/identity-access-team,false,false,false @@ -210,11 +209,13 @@ timeRangeProvider,experimental,@grafana/grafana-frontend-platform,false,false,fa prometheusUsesCombobox,experimental,@grafana/observability-metrics,false,false,false userStorageAPI,experimental,@grafana/plugins-platform-backend,false,false,false azureMonitorDisableLogLimit,GA,@grafana/partner-datasources,false,false,false -preinstallAutoUpdate,experimental,@grafana/plugins-platform-backend,false,false,false +preinstallAutoUpdate,GA,@grafana/plugins-platform-backend,false,false,false dashboardSchemaV2,experimental,@grafana/dashboards-squad,false,false,true playlistsWatcher,experimental,@grafana/grafana-app-platform-squad,false,true,false +passwordlessMagicLinkAuthentication,experimental,@grafana/identity-access-team,false,false,false exploreMetricsRelatedLogs,experimental,@grafana/observability-metrics,false,false,true enableExtensionsAdminPage,experimental,@grafana/plugins-platform-backend,false,true,false zipkinBackendMigration,experimental,@grafana/oss-big-tent,false,false,false enableSCIM,experimental,@grafana/identity-access-team,false,false,false crashDetection,experimental,@grafana/observability-traces-and-profiling,false,false,true +reportingUseRawTimeRange,preview,@grafana/sharing-squad,false,false,false diff --git a/pkg/services/featuremgmt/toggles_gen.go b/pkg/services/featuremgmt/toggles_gen.go index 1656aa935c3..37231dcc9d4 100644 --- a/pkg/services/featuremgmt/toggles_gen.go +++ b/pkg/services/featuremgmt/toggles_gen.go @@ -75,10 +75,6 @@ const ( // Migrate old stat panel to supported stat panel - broken out from autoMigrateOldPanels to enable granular tracking FlagAutoMigrateStatPanel = "autoMigrateStatPanel" - // FlagAutoMigrateXYChartPanel - // Migrate old XYChart panel to new XYChart2 model - FlagAutoMigrateXYChartPanel = "autoMigrateXYChartPanel" - // FlagDisableAngular // Dynamic flag to disable angular at runtime. The preferred method is to set `angular_support_enabled` to `false` in the [security] settings, which allows you to change the state at runtime. FlagDisableAngular = "disableAngular" @@ -863,6 +859,10 @@ const ( // Enables experimental watcher for playlists FlagPlaylistsWatcher = "playlistsWatcher" + // FlagPasswordlessMagicLinkAuthentication + // Enable passwordless login via magic link authentication + FlagPasswordlessMagicLinkAuthentication = "passwordlessMagicLinkAuthentication" + // FlagExploreMetricsRelatedLogs // Display Related Logs in Explore Metrics FlagExploreMetricsRelatedLogs = "exploreMetricsRelatedLogs" @@ -882,4 +882,8 @@ const ( // FlagCrashDetection // Enables browser crash detection reporting to Faro. FlagCrashDetection = "crashDetection" + + // FlagReportingUseRawTimeRange + // Uses the original report or dashboard time range instead of making an absolute transformation + FlagReportingUseRawTimeRange = "reportingUseRawTimeRange" ) diff --git a/pkg/services/featuremgmt/toggles_gen.json b/pkg/services/featuremgmt/toggles_gen.json index 34c1e5e5f78..9f844717dbd 100644 --- a/pkg/services/featuremgmt/toggles_gen.json +++ b/pkg/services/featuremgmt/toggles_gen.json @@ -415,13 +415,16 @@ { "metadata": { "name": "appSidecar", - "resourceVersion": "1722872007883", - "creationTimestamp": "2024-09-09T12:45:05Z" + "resourceVersion": "1731608393499", + "creationTimestamp": "2024-09-09T12:45:05Z", + "annotations": { + "grafana.app/updatedTimestamp": "2024-11-14 18:19:53.499798 +0000 UTC" + } }, "spec": { "description": "Enable the app sidecar feature that allows rendering 2 apps at the same time", "stage": "experimental", - "codeowner": "@grafana/explore-squad" + "codeowner": "@grafana/grafana-frontend-platform" } }, { @@ -535,6 +538,7 @@ "name": "autoMigrateXYChartPanel", "resourceVersion": "1722537244598", "creationTimestamp": "2024-03-22T15:44:37Z", + "deletionTimestamp": "2024-11-14T01:17:06Z", "annotations": { "grafana.app/updatedTimestamp": "2024-08-01 18:34:04.598082 +0000 UTC" } @@ -841,16 +845,16 @@ { "metadata": { "name": "correlations", - "resourceVersion": "1720021873452", + "resourceVersion": "1731608393499", "creationTimestamp": "2022-09-16T13:14:27Z", "annotations": { - "grafana.app/updatedTimestamp": "2024-07-03 15:51:13.452477 +0000 UTC" + "grafana.app/updatedTimestamp": "2024-11-14 18:19:53.499798 +0000 UTC" } }, "spec": { "description": "Correlations page", "stage": "GA", - "codeowner": "@grafana/explore-squad", + "codeowner": "@grafana/dataviz-squad", "allowSelfServe": true, "expression": "true" } @@ -2462,6 +2466,20 @@ "hideFromDocs": true } }, + { + "metadata": { + "name": "passwordlessMagicLinkAuthentication", + "resourceVersion": "1730232874003", + "creationTimestamp": "2024-10-29T20:14:34Z" + }, + "spec": { + "description": "Enable passwordless login via magic link authentication", + "stage": "experimental", + "codeowner": "@grafana/identity-access-team", + "hideFromAdminPage": true, + "hideFromDocs": true + } + }, { "metadata": { "name": "pdfTables", @@ -2602,13 +2620,17 @@ { "metadata": { "name": "preinstallAutoUpdate", - "resourceVersion": "1730904343525", - "creationTimestamp": "2024-11-06T14:45:43Z" + "resourceVersion": "1731581146864", + "creationTimestamp": "2024-11-06T14:45:43Z", + "annotations": { + "grafana.app/updatedTimestamp": "2024-11-14 10:45:46.864585 +0000 UTC" + } }, "spec": { "description": "Enables automatic updates for pre-installed plugins", - "stage": "experimental", - "codeowner": "@grafana/plugins-platform-backend" + "stage": "GA", + "codeowner": "@grafana/plugins-platform-backend", + "expression": "true" } }, { @@ -2828,14 +2850,17 @@ { "metadata": { "name": "queryLibrary", - "resourceVersion": "1718727528075", + "resourceVersion": "1731609408207", "creationTimestamp": "2022-10-07T18:31:45Z", - "deletionTimestamp": "2023-03-20T16:00:14Z" + "deletionTimestamp": "2023-03-20T16:00:14Z", + "annotations": { + "grafana.app/updatedTimestamp": "2024-11-14 18:36:48.207329 +0000 UTC" + } }, "spec": { "description": "Enables Query Library feature in Explore", "stage": "experimental", - "codeowner": "@grafana/explore-squad" + "codeowner": "@grafana/grafana-frontend-platform" } }, { @@ -2992,6 +3017,22 @@ "requiresRestart": true } }, + { + "metadata": { + "name": "reportingUseRawTimeRange", + "resourceVersion": "1731604692461", + "creationTimestamp": "2024-11-13T15:48:28Z", + "annotations": { + "grafana.app/updatedTimestamp": "2024-11-14 17:18:12.461446 +0000 UTC" + } + }, + "spec": { + "description": "Uses the original report or dashboard time range instead of making an absolute transformation", + "stage": "preview", + "codeowner": "@grafana/sharing-squad", + "expression": "false" + } + }, { "metadata": { "name": "rolePickerDrawer", @@ -3047,12 +3088,15 @@ { "metadata": { "name": "singleTopNav", - "resourceVersion": "1724861961030", - "creationTimestamp": "2024-08-29T08:48:32Z" + "resourceVersion": "1731664029942", + "creationTimestamp": "2024-08-29T08:48:32Z", + "annotations": { + "grafana.app/updatedTimestamp": "2024-11-15 09:47:09.942158 +0000 UTC" + } }, "spec": { "description": "Unifies the top search bar and breadcrumb bar into one", - "stage": "experimental", + "stage": "preview", "codeowner": "@grafana/grafana-frontend-platform", "frontend": true } @@ -3483,4 +3527,4 @@ } } ] -} +} \ No newline at end of file diff --git a/pkg/services/login/authinfo.go b/pkg/services/login/authinfo.go index 103372c942d..b13bf360eb5 100644 --- a/pkg/services/login/authinfo.go +++ b/pkg/services/login/authinfo.go @@ -25,14 +25,15 @@ type Store interface { const ( // modules - PasswordAuthModule = "password" - APIKeyAuthModule = "apikey" - SAMLAuthModule = "auth.saml" - LDAPAuthModule = "ldap" - AuthProxyAuthModule = "authproxy" - JWTModule = "jwt" - ExtendedJWTModule = "extendedjwt" - RenderModule = "render" + PasswordAuthModule = "password" + PasswordlessAuthModule = "passwordless" + APIKeyAuthModule = "apikey" + SAMLAuthModule = "auth.saml" + LDAPAuthModule = "ldap" + AuthProxyAuthModule = "authproxy" + JWTModule = "jwt" + ExtendedJWTModule = "extendedjwt" + RenderModule = "render" // OAuth provider modules AzureADAuthModule = "oauth_azuread" GoogleAuthModule = "oauth_google" diff --git a/pkg/services/navtree/navtreeimpl/navtree.go b/pkg/services/navtree/navtreeimpl/navtree.go index 2d64d9c6ade..448893bffd0 100644 --- a/pkg/services/navtree/navtreeimpl/navtree.go +++ b/pkg/services/navtree/navtreeimpl/navtree.go @@ -452,6 +452,8 @@ func (s *ServiceImpl) buildAlertNavLinks(c *contextmodel.ReqContext) *navtree.Na if hasAccess(ac.EvalAny( ac.EvalPermission(ac.ActionAlertingNotificationsRead), ac.EvalPermission(ac.ActionAlertingNotificationsExternalRead), + ac.EvalPermission(ac.ActionAlertingNotificationsTimeIntervalsRead), + ac.EvalPermission(ac.ActionAlertingNotificationsTimeIntervalsWrite), )) { alertChildNavs = append(alertChildNavs, &navtree.NavLink{Text: "Notification policies", SubTitle: "Determine how alerts are routed to contact points", Id: "am-routes", Url: s.cfg.AppSubURL + "/alerting/routes", Icon: "sitemap"}) } diff --git a/pkg/services/ngalert/api/api_ruler_test.go b/pkg/services/ngalert/api/api_ruler_test.go index 7994712bbb7..6a346c29102 100644 --- a/pkg/services/ngalert/api/api_ruler_test.go +++ b/pkg/services/ngalert/api/api_ruler_test.go @@ -337,6 +337,7 @@ func TestRouteGetRuleByUID(t *testing.T) { createdRules := gen.With( gen.WithUniqueGroupIndex(), gen.WithUniqueID(), gen.WithEditorSettingsSimplifiedQueryAndExpressionsSection(true), + gen.WithEditorSettingsSimplifiedNotificationsSection(true), ).GenerateManyRef(3) require.Len(t, createdRules, 3) ruleStore.PutRule(context.Background(), createdRules...) @@ -356,6 +357,7 @@ func TestRouteGetRuleByUID(t *testing.T) { require.Equal(t, expectedRule.RuleGroup, result.GrafanaManagedAlert.RuleGroup) require.Equal(t, expectedRule.Title, result.GrafanaManagedAlert.Title) require.True(t, result.GrafanaManagedAlert.Metadata.EditorSettings.SimplifiedQueryAndExpressionsSection) + require.True(t, result.GrafanaManagedAlert.Metadata.EditorSettings.SimplifiedNotificationsSection) }) t.Run("error when fetching rule with non-existent UID", func(t *testing.T) { diff --git a/pkg/services/ngalert/api/api_ruler_validation.go b/pkg/services/ngalert/api/api_ruler_validation.go index ae5bd72b840..1ed855378fd 100644 --- a/pkg/services/ngalert/api/api_ruler_validation.go +++ b/pkg/services/ngalert/api/api_ruler_validation.go @@ -147,6 +147,7 @@ func validateAlertingRuleFields(in *apimodels.PostableExtendedRuleNode, newRule if in.GrafanaManagedAlert.Metadata != nil { newRule.Metadata.EditorSettings = ngmodels.EditorSettings{ SimplifiedQueryAndExpressionsSection: in.GrafanaManagedAlert.Metadata.EditorSettings.SimplifiedQueryAndExpressionsSection, + SimplifiedNotificationsSection: in.GrafanaManagedAlert.Metadata.EditorSettings.SimplifiedNotificationsSection, } } diff --git a/pkg/services/ngalert/api/api_ruler_validation_test.go b/pkg/services/ngalert/api/api_ruler_validation_test.go index 4d70960da5c..b56705f625f 100644 --- a/pkg/services/ngalert/api/api_ruler_validation_test.go +++ b/pkg/services/ngalert/api/api_ruler_validation_test.go @@ -301,6 +301,36 @@ func TestValidateRuleGroupFailures(t *testing.T) { require.Contains(t, err.Error(), apiModel.Rules[0].GrafanaManagedAlert.UID) }, }, + { + name: "fail with 4xx if rule contains only panelID", + group: func() *apimodels.PostableRuleGroupConfig { + r1 := validRule() + panelId := int64(42) + r1.Annotations = map[string]string{ + models.PanelIDAnnotation: strconv.FormatInt(panelId, 10), + } + g := validGroup(cfg, r1) + return &g + }, + assert: func(t *testing.T, apiModel *apimodels.PostableRuleGroupConfig, err error) { + require.ErrorIs(t, err, models.ErrAlertRuleFailedValidation) + }, + }, + { + name: "fail with 4xx if rule contains only dashboardUID", + group: func() *apimodels.PostableRuleGroupConfig { + r1 := validRule() + dashboardUid := "oinwerfgiuac" + r1.Annotations = map[string]string{ + models.DashboardUIDAnnotation: dashboardUid, + } + g := validGroup(cfg, r1) + return &g + }, + assert: func(t *testing.T, apiModel *apimodels.PostableRuleGroupConfig, err error) { + require.ErrorIs(t, err, models.ErrAlertRuleFailedValidation) + }, + }, } for _, testCase := range testCases { @@ -1046,6 +1076,36 @@ func TestValidateRuleNodeNotificationSettings(t *testing.T) { } } +func TestValidateRuleNodeEditorSettings(t *testing.T) { + cfg := config(t) + limits := makeLimits(cfg) + + editorSettings := models.EditorSettings{ + SimplifiedQueryAndExpressionsSection: true, + SimplifiedNotificationsSection: true, + } + + testCases := []struct { + name string + editorSettings models.EditorSettings + }{ + { + name: "valid editor settings", + editorSettings: editorSettings, + }, + } + + for _, tt := range testCases { + t.Run(tt.name, func(t *testing.T) { + r := validRule() + r.GrafanaManagedAlert.Metadata = AlertRuleMetadataFromModelMetadata(models.AlertRuleMetadata{EditorSettings: tt.editorSettings}) + newRule, err := validateRuleNode(&r, util.GenerateShortUID(), cfg.BaseInterval*time.Duration(rand.Int63n(10)+1), rand.Int63(), randFolder().UID, limits) + require.NoError(t, err) + require.Equal(t, tt.editorSettings, newRule.Metadata.EditorSettings) + }) + } +} + func TestValidateRuleNodeReservedLabels(t *testing.T) { cfg := config(t) limits := makeLimits(cfg) diff --git a/pkg/services/ngalert/api/compat.go b/pkg/services/ngalert/api/compat.go index 30266fc504b..ba78f5f613d 100644 --- a/pkg/services/ngalert/api/compat.go +++ b/pkg/services/ngalert/api/compat.go @@ -425,6 +425,7 @@ func MuteTimingIntervalToMuteTimeIntervalHclExport(m definitions.MuteTimeInterva func AlertRuleEditorSettingsFromModelEditorSettings(es models.EditorSettings) *definitions.AlertRuleEditorSettings { return &definitions.AlertRuleEditorSettings{ SimplifiedQueryAndExpressionsSection: es.SimplifiedQueryAndExpressionsSection, + SimplifiedNotificationsSection: es.SimplifiedNotificationsSection, } } diff --git a/pkg/services/ngalert/api/compat_test.go b/pkg/services/ngalert/api/compat_test.go index bd06d64d393..e2dd108c815 100644 --- a/pkg/services/ngalert/api/compat_test.go +++ b/pkg/services/ngalert/api/compat_test.go @@ -6,6 +6,7 @@ import ( "github.com/stretchr/testify/require" "github.com/grafana/grafana/pkg/services/ngalert/api/tooling/definitions" + "github.com/grafana/grafana/pkg/services/ngalert/models" ) func TestToModel(t *testing.T) { @@ -67,3 +68,19 @@ func TestToModel(t *testing.T) { require.Nil(t, rule.NotificationSettings) }) } + +func TestAlertRuleMetadataFromModelMetadata(t *testing.T) { + t.Run("should convert model metadata to api metadata", func(t *testing.T) { + modelMetadata := models.AlertRuleMetadata{ + EditorSettings: models.EditorSettings{ + SimplifiedQueryAndExpressionsSection: true, + SimplifiedNotificationsSection: true, + }, + } + + apiMetadata := AlertRuleMetadataFromModelMetadata(modelMetadata) + + require.True(t, apiMetadata.EditorSettings.SimplifiedQueryAndExpressionsSection) + require.True(t, apiMetadata.EditorSettings.SimplifiedNotificationsSection) + }) +} diff --git a/pkg/services/ngalert/api/tooling/definitions/cortex-ruler.go b/pkg/services/ngalert/api/tooling/definitions/cortex-ruler.go index bca1323a41b..a6383efa0b6 100644 --- a/pkg/services/ngalert/api/tooling/definitions/cortex-ruler.go +++ b/pkg/services/ngalert/api/tooling/definitions/cortex-ruler.go @@ -460,6 +460,7 @@ type AlertRuleMetadata struct { // swagger:model type AlertRuleEditorSettings struct { SimplifiedQueryAndExpressionsSection bool `json:"simplified_query_and_expressions_section" yaml:"simplified_query_and_expressions_section"` + SimplifiedNotificationsSection bool `json:"simplified_notifications_section" yaml:"simplified_notifications_section"` } // swagger:model diff --git a/pkg/services/ngalert/models/alert_rule.go b/pkg/services/ngalert/models/alert_rule.go index 32ca13a33d4..ef8d15827df 100644 --- a/pkg/services/ngalert/models/alert_rule.go +++ b/pkg/services/ngalert/models/alert_rule.go @@ -278,6 +278,7 @@ type AlertRuleMetadata struct { type EditorSettings struct { SimplifiedQueryAndExpressionsSection bool `json:"simplified_query_and_expressions_section"` + SimplifiedNotificationsSection bool `json:"simplified_notifications_section"` } // Namespaced describes a class of resources that are stored in a specific namespace. @@ -435,13 +436,13 @@ func (alertRule *AlertRule) SetDashboardAndPanelFromAnnotations() error { dashUID := alertRule.Annotations[DashboardUIDAnnotation] panelID := alertRule.Annotations[PanelIDAnnotation] if dashUID != "" && panelID == "" || dashUID == "" && panelID != "" { - return fmt.Errorf("both annotations %s and %s must be specified", + return fmt.Errorf("%w: both annotations %s and %s must be specified", ErrAlertRuleFailedValidation, DashboardUIDAnnotation, PanelIDAnnotation) } if dashUID != "" { panelIDValue, err := strconv.ParseInt(panelID, 10, 64) if err != nil { - return fmt.Errorf("annotation %s must be a valid integer Panel ID", + return fmt.Errorf("%w: annotation %s must be a valid integer Panel ID", ErrAlertRuleFailedValidation, PanelIDAnnotation) } alertRule.DashboardUID = &dashUID diff --git a/pkg/services/ngalert/models/alert_rule_test.go b/pkg/services/ngalert/models/alert_rule_test.go index 619d50d90df..bb7bfdadf33 100644 --- a/pkg/services/ngalert/models/alert_rule_test.go +++ b/pkg/services/ngalert/models/alert_rule_test.go @@ -137,6 +137,7 @@ func TestSetDashboardAndPanelFromAnnotations(t *testing.T) { name string annotations map[string]string expectedError error + expectedErrContains string expectedDashboardUID string expectedPanelID int64 }{ @@ -148,41 +149,42 @@ func TestSetDashboardAndPanelFromAnnotations(t *testing.T) { expectedPanelID: -1, }, { - name: "dashboardUID is not present", - annotations: map[string]string{PanelIDAnnotation: "1234567890"}, - expectedError: fmt.Errorf("both annotations %s and %s must be specified", - DashboardUIDAnnotation, PanelIDAnnotation), + name: "dashboardUID is not present", + annotations: map[string]string{PanelIDAnnotation: "1234567890"}, + expectedError: ErrAlertRuleFailedValidation, + expectedErrContains: fmt.Sprintf("%s and %s", DashboardUIDAnnotation, PanelIDAnnotation), expectedDashboardUID: "", expectedPanelID: -1, }, { - name: "dashboardUID is present but empty", - annotations: map[string]string{DashboardUIDAnnotation: "", PanelIDAnnotation: "1234567890"}, - expectedError: fmt.Errorf("both annotations %s and %s must be specified", - DashboardUIDAnnotation, PanelIDAnnotation), + name: "dashboardUID is present but empty", + annotations: map[string]string{DashboardUIDAnnotation: "", PanelIDAnnotation: "1234567890"}, + expectedError: ErrAlertRuleFailedValidation, + expectedErrContains: fmt.Sprintf("%s and %s", DashboardUIDAnnotation, PanelIDAnnotation), expectedDashboardUID: "", expectedPanelID: -1, }, { - name: "panelID is not present", - annotations: map[string]string{DashboardUIDAnnotation: "cKy7f6Hk"}, - expectedError: fmt.Errorf("both annotations %s and %s must be specified", - DashboardUIDAnnotation, PanelIDAnnotation), + name: "panelID is not present", + annotations: map[string]string{DashboardUIDAnnotation: "cKy7f6Hk"}, + expectedError: ErrAlertRuleFailedValidation, + expectedErrContains: fmt.Sprintf("%s and %s", DashboardUIDAnnotation, PanelIDAnnotation), expectedDashboardUID: "", expectedPanelID: -1, }, { - name: "panelID is present but empty", - annotations: map[string]string{DashboardUIDAnnotation: "cKy7f6Hk", PanelIDAnnotation: ""}, - expectedError: fmt.Errorf("both annotations %s and %s must be specified", - DashboardUIDAnnotation, PanelIDAnnotation), + name: "panelID is present but empty", + annotations: map[string]string{DashboardUIDAnnotation: "cKy7f6Hk", PanelIDAnnotation: ""}, + expectedError: ErrAlertRuleFailedValidation, + expectedErrContains: fmt.Sprintf("%s and %s", DashboardUIDAnnotation, PanelIDAnnotation), expectedDashboardUID: "", expectedPanelID: -1, }, { name: "dashboardUID and panelID are present but panelID is not a correct int64", annotations: map[string]string{DashboardUIDAnnotation: "cKy7f6Hk", PanelIDAnnotation: "fgh"}, - expectedError: fmt.Errorf("annotation %s must be a valid integer Panel ID", PanelIDAnnotation), + expectedError: ErrAlertRuleFailedValidation, + expectedErrContains: PanelIDAnnotation, expectedDashboardUID: "", expectedPanelID: -1, }, @@ -203,7 +205,10 @@ func TestSetDashboardAndPanelFromAnnotations(t *testing.T) { ).Generate() err := rule.SetDashboardAndPanelFromAnnotations() - require.Equal(t, tc.expectedError, err) + require.ErrorIs(t, err, tc.expectedError) + if tc.expectedErrContains != "" { + require.ErrorContains(t, err, tc.expectedErrContains) + } require.Equal(t, tc.expectedDashboardUID, rule.GetDashboardUID()) require.Equal(t, tc.expectedPanelID, rule.GetPanelID()) }) diff --git a/pkg/services/ngalert/models/testing.go b/pkg/services/ngalert/models/testing.go index b8b2b5ceed2..53279b09cbb 100644 --- a/pkg/services/ngalert/models/testing.go +++ b/pkg/services/ngalert/models/testing.go @@ -197,9 +197,15 @@ func (a *AlertRuleMutators) WithUniqueID() AlertRuleMutator { } } -func (a *AlertRuleMutators) WithEditorSettingsSimplifiedQueryAndExpressionsSection(mode bool) AlertRuleMutator { +func (a *AlertRuleMutators) WithEditorSettingsSimplifiedQueryAndExpressionsSection(enabled bool) AlertRuleMutator { return func(rule *AlertRule) { - rule.Metadata.EditorSettings.SimplifiedQueryAndExpressionsSection = mode + rule.Metadata.EditorSettings.SimplifiedQueryAndExpressionsSection = enabled + } +} + +func (a *AlertRuleMutators) WithEditorSettingsSimplifiedNotificationsSection(enabled bool) AlertRuleMutator { + return func(rule *AlertRule) { + rule.Metadata.EditorSettings.SimplifiedNotificationsSection = enabled } } diff --git a/pkg/services/ngalert/provisioning/alert_rules_test.go b/pkg/services/ngalert/provisioning/alert_rules_test.go index 98693e427d5..ce0651f4eaf 100644 --- a/pkg/services/ngalert/provisioning/alert_rules_test.go +++ b/pkg/services/ngalert/provisioning/alert_rules_test.go @@ -867,6 +867,37 @@ func TestCreateAlertRule(t *testing.T) { require.NoError(t, err) }) }) + t.Run("when dashboard is specified", func(t *testing.T) { + t.Run("return no error when both specified", func(t *testing.T) { + rule := dummyRule("test#4", orgID) + dashboardUid := "oinwerfgiuac" + panelId := int64(42) + rule.Annotations = map[string]string{ + models.DashboardUIDAnnotation: dashboardUid, + models.PanelIDAnnotation: strconv.FormatInt(panelId, 10), + } + rule, err := ruleService.CreateAlertRule(context.Background(), u, rule, models.ProvenanceNone) + require.NoError(t, err) + }) + t.Run("return 4xx error when missing dashboard uid", func(t *testing.T) { + rule := dummyRule("test#3", orgID) + panelId := int64(42) + rule.Annotations = map[string]string{ + models.PanelIDAnnotation: strconv.FormatInt(panelId, 10), + } + rule, err := ruleService.CreateAlertRule(context.Background(), u, rule, models.ProvenanceNone) + require.ErrorIs(t, err, models.ErrAlertRuleFailedValidation) + }) + t.Run("return 4xx error when missing panel id", func(t *testing.T) { + rule := dummyRule("test#3", orgID) + dashboardUid := "oinwerfgiuac" + rule.Annotations = map[string]string{ + models.DashboardUIDAnnotation: dashboardUid, + } + rule, err := ruleService.CreateAlertRule(context.Background(), u, rule, models.ProvenanceNone) + require.ErrorIs(t, err, models.ErrAlertRuleFailedValidation) + }) + }) } func TestUpdateAlertRule(t *testing.T) { diff --git a/pkg/services/ngalert/schedule/registry_test.go b/pkg/services/ngalert/schedule/registry_test.go index 8c770dfb640..a28ec6265aa 100644 --- a/pkg/services/ngalert/schedule/registry_test.go +++ b/pkg/services/ngalert/schedule/registry_test.go @@ -207,6 +207,7 @@ func TestRuleWithFolderFingerprint(t *testing.T) { Metadata: models.AlertRuleMetadata{ EditorSettings: models.EditorSettings{ SimplifiedQueryAndExpressionsSection: false, + SimplifiedNotificationsSection: false, }, }, } diff --git a/pkg/services/temp_user/tempusertest/fake.go b/pkg/services/temp_user/tempusertest/fake.go index 0bd9b803a88..8376b691e83 100644 --- a/pkg/services/temp_user/tempusertest/fake.go +++ b/pkg/services/temp_user/tempusertest/fake.go @@ -11,6 +11,7 @@ var _ tempuser.Service = (*FakeTempUserService)(nil) type FakeTempUserService struct { tempuser.Service GetTempUserByCodeFN func(ctx context.Context, query *tempuser.GetTempUserByCodeQuery) (*tempuser.TempUserDTO, error) + GetTempUsersQueryFN func(ctx context.Context, query *tempuser.GetTempUsersQuery) ([]*tempuser.TempUserDTO, error) UpdateTempUserStatusFN func(ctx context.Context, cmd *tempuser.UpdateTempUserStatusCommand) error CreateTempUserFN func(ctx context.Context, cmd *tempuser.CreateTempUserCommand) (*tempuser.TempUser, error) ExpirePreviousVerificationsFN func(ctx context.Context, cmd *tempuser.ExpirePreviousVerificationsCommand) error @@ -24,6 +25,13 @@ func (f *FakeTempUserService) GetTempUserByCode(ctx context.Context, query *temp return nil, nil } +func (f *FakeTempUserService) GetTempUsersQuery(ctx context.Context, query *tempuser.GetTempUsersQuery) ([]*tempuser.TempUserDTO, error) { + if f.GetTempUsersQueryFN != nil { + return f.GetTempUsersQueryFN(ctx, query) + } + return nil, nil +} + func (f *FakeTempUserService) UpdateTempUserStatus(ctx context.Context, cmd *tempuser.UpdateTempUserStatusCommand) error { if f.UpdateTempUserStatusFN != nil { return f.UpdateTempUserStatusFN(ctx, cmd) diff --git a/pkg/setting/setting.go b/pkg/setting/setting.go index e0a54e7ab6f..9715d99a427 100644 --- a/pkg/setting/setting.go +++ b/pkg/setting/setting.go @@ -271,6 +271,8 @@ type Cfg struct { JWTAuth AuthJWTSettings ExtJWTAuth ExtJWTSettings + PasswordlessMagicLinkAuth AuthPasswordlessMagicLinkSettings + // SSO Settings Auth SSOSettingsReloadInterval time.Duration SSOSettingsConfigurableProviders map[string]bool @@ -1248,6 +1250,7 @@ func (cfg *Cfg) parseINIFile(iniFile *ini.File) error { cfg.readAuthExtJWTSettings() cfg.readAuthProxySettings() cfg.readSessionConfig() + cfg.readPasswordlessMagicLinkSettings() if err := cfg.readSmtpSettings(); err != nil { return err } diff --git a/pkg/setting/setting_passwordless_magic_link.go b/pkg/setting/setting_passwordless_magic_link.go new file mode 100644 index 00000000000..0f0d6b65d34 --- /dev/null +++ b/pkg/setting/setting_passwordless_magic_link.go @@ -0,0 +1,17 @@ +package setting + +import "time" + +type AuthPasswordlessMagicLinkSettings struct { + // Passwordless Auth via Magic Link + Enabled bool + CodeExpiration time.Duration +} + +func (cfg *Cfg) readPasswordlessMagicLinkSettings() { + authPasswordless := cfg.SectionWithEnvOverrides("auth.passwordless") + PasswordlessMagicLinkSettings := AuthPasswordlessMagicLinkSettings{} + PasswordlessMagicLinkSettings.Enabled = authPasswordless.Key("enabled").MustBool(false) + PasswordlessMagicLinkSettings.CodeExpiration = authPasswordless.Key("code_expiration").MustDuration(time.Minute * 20) + cfg.PasswordlessMagicLinkAuth = PasswordlessMagicLinkSettings +} diff --git a/pkg/setting/setting_plugins.go b/pkg/setting/setting_plugins.go index 904dadcb20e..d3ba8384a40 100644 --- a/pkg/setting/setting_plugins.go +++ b/pkg/setting/setting_plugins.go @@ -26,6 +26,13 @@ func extractPluginSettings(sections []*ini.Section) PluginSettings { return psMap } +var ( + defaultPreinstallPlugins = map[string]InstallPlugin{ + // Default preinstalled plugins + "grafana-lokiexplore-app": {"grafana-lokiexplore-app", ""}, + } +) + func (cfg *Cfg) readPluginSettings(iniFile *ini.File) error { pluginsSection := iniFile.Section("plugins") @@ -42,15 +49,27 @@ func (cfg *Cfg) readPluginSettings(iniFile *ini.File) error { disablePreinstall := pluginsSection.Key("preinstall_disabled").MustBool(false) if !disablePreinstall { rawInstallPlugins := util.SplitString(pluginsSection.Key("preinstall").MustString("")) - cfg.PreinstallPlugins = make([]InstallPlugin, len(rawInstallPlugins)) - for i, plugin := range rawInstallPlugins { + preinstallPlugins := make(map[string]InstallPlugin) + // Add the default preinstalled plugins + for _, plugin := range defaultPreinstallPlugins { + preinstallPlugins[plugin.ID] = plugin + } + // Add the plugins defined in the configuration + for _, plugin := range rawInstallPlugins { parts := strings.Split(plugin, "@") id := parts[0] v := "" if len(parts) == 2 { v = parts[1] } - cfg.PreinstallPlugins[i] = InstallPlugin{id, v} + preinstallPlugins[id] = InstallPlugin{id, v} + } + // Remove from the list the plugins that have been disabled + for _, disabledPlugin := range cfg.DisablePlugins { + delete(preinstallPlugins, disabledPlugin) + } + for _, plugin := range preinstallPlugins { + cfg.PreinstallPlugins = append(cfg.PreinstallPlugins, plugin) } cfg.PreinstallPluginsAsync = pluginsSection.Key("preinstall_async").MustBool(true) } diff --git a/pkg/setting/setting_plugins_test.go b/pkg/setting/setting_plugins_test.go index 6ca5e0cc692..de1e45d9f42 100644 --- a/pkg/setting/setting_plugins_test.go +++ b/pkg/setting/setting_plugins_test.go @@ -4,6 +4,7 @@ import ( "strings" "testing" + "github.com/stretchr/testify/assert" "github.com/stretchr/testify/require" ) @@ -95,4 +96,89 @@ func Test_readPluginSettings(t *testing.T) { }) } }) + + t.Run("when plugins.preinstall is defined", func(t *testing.T) { + defaultPreinstallPluginsList := make([]InstallPlugin, 0, len(defaultPreinstallPlugins)) + defaultPreinstallPluginsIDs := []string{} + for _, p := range defaultPreinstallPlugins { + defaultPreinstallPluginsList = append(defaultPreinstallPluginsList, p) + defaultPreinstallPluginsIDs = append(defaultPreinstallPluginsIDs, p.ID) + } + tests := []struct { + name string + rawInput string + disablePreinstall bool + expected []InstallPlugin + disableAsync bool + disablePlugins string + }{ + { + name: "should add the default preinstalled plugin", + rawInput: "", + expected: defaultPreinstallPluginsList, + }, + { + name: "should add the default preinstalled plugin and the one defined", + rawInput: "plugin1", + expected: append(defaultPreinstallPluginsList, InstallPlugin{"plugin1", ""}), + }, + { + name: "should add the default preinstalled plugin and the one defined with version", + rawInput: "plugin1@1.0.0", + expected: append(defaultPreinstallPluginsList, InstallPlugin{"plugin1", "1.0.0"}), + }, + { + name: "it should remove the disabled plugin", + rawInput: "plugin1", + disablePlugins: "plugin1", + expected: defaultPreinstallPluginsList, + }, + { + name: "it should remove default plugins", + rawInput: "", + disablePlugins: strings.Join(defaultPreinstallPluginsIDs, ","), + expected: nil, + }, + { + name: "should ignore input when preinstall is disabled", + rawInput: "plugin1", + disablePreinstall: true, + expected: nil, + }, + { + name: "should mark preinstall as sync", + rawInput: "plugin1", + disableAsync: true, + expected: append(defaultPreinstallPluginsList, InstallPlugin{"plugin1", ""}), + }, + } + for _, tc := range tests { + t.Run(tc.name, func(t *testing.T) { + cfg := NewCfg() + sec, err := cfg.Raw.NewSection("plugins") + require.NoError(t, err) + _, err = sec.NewKey("preinstall", tc.rawInput) + require.NoError(t, err) + if tc.disablePreinstall { + _, err = sec.NewKey("preinstall_disabled", "true") + require.NoError(t, err) + } + if tc.disableAsync { + _, err = sec.NewKey("preinstall_async", "false") + require.NoError(t, err) + } + if tc.disablePlugins != "" { + _, err = sec.NewKey("disable_plugins", tc.disablePlugins) + require.NoError(t, err) + } + + err = cfg.readPluginSettings(cfg.Raw) + require.NoError(t, err) + assert.ElementsMatch(t, cfg.PreinstallPlugins, tc.expected) + if tc.disableAsync { + require.Equal(t, cfg.PreinstallPluginsAsync, false) + } + }) + } + }) } diff --git a/pkg/storage/unified/resource/index.go b/pkg/storage/unified/resource/index.go index 3cc20ddfd0d..0ec0ab393ad 100644 --- a/pkg/storage/unified/resource/index.go +++ b/pkg/storage/unified/resource/index.go @@ -195,24 +195,24 @@ func (i *Index) InitForTenant(ctx context.Context, namespace string) (int, error resourceTypes := fetchResourceTypes() totalObjectsFetched := 0 for _, rt := range resourceTypes { - logger.Debug("indexing resource", "kind", rt.Key.Resource, "list_limit", i.opts.ListLimit, "batch_size", i.opts.BatchSize, "workers", i.opts.Workers, "namespace", namespace) - r := &ListRequest{Options: rt, Limit: int64(i.opts.ListLimit)} + logger.Debug("indexing resource", "kind", rt.Kind, "list_limit", i.opts.ListLimit, "batch_size", i.opts.BatchSize, "workers", i.opts.Workers, "namespace", namespace) + r := &ListRequest{Options: rt.ListOptions, Limit: int64(i.opts.ListLimit)} r.Options.Key.Namespace = namespace // scope the list to a tenant or this will take forever when US has 1M+ resources // Paginate through the list of resources and index each page for { - logger.Debug("fetching resource list", "kind", rt.Key.Resource, "namespace", namespace) + logger.Debug("fetching resource list", "kind", rt.Kind, "namespace", namespace) list, err := i.s.List(ctx, r) if err != nil { return totalObjectsFetched, err } // Record the number of objects indexed for the kind - IndexServerMetrics.IndexedKinds.WithLabelValues(rt.Key.Resource).Add(float64(len(list.Items))) + IndexServerMetrics.IndexedKinds.WithLabelValues(rt.Kind).Add(float64(len(list.Items))) totalObjectsFetched += len(list.Items) - logger.Debug("indexing batch", "kind", rt.Key.Resource, "count", len(list.Items), "namespace", namespace) + logger.Debug("indexing batch", "kind", rt.Kind, "count", len(list.Items), "namespace", namespace) //add changes to batches for shards with changes in the List err = i.writeBatch(ctx, list) if err != nil { @@ -309,6 +309,9 @@ func (i *Index) Delete(ctx context.Context, uid string, key *ResourceKey) error if err != nil { return err } + + IndexServerMetrics.IndexedKinds.WithLabelValues(key.Resource).Dec() + return nil } @@ -474,29 +477,43 @@ func createInMemoryIndex() (bleve.Index, string, error) { return index, "", err } +type IndexerListOptions struct { + *ListOptions + Kind string +} + // TODO - fetch from api -func fetchResourceTypes() []*ListOptions { - items := []*ListOptions{} - items = append(items, - &ListOptions{ - Key: &ResourceKey{ - Group: "playlist.grafana.app", - Resource: "playlists", +// Folders need to be indexed first as dashboards depend on them to be indexed already. +func fetchResourceTypes() []*IndexerListOptions { + return []*IndexerListOptions{ + { + ListOptions: &ListOptions{ + Key: &ResourceKey{ + Group: "folder.grafana.app", + Resource: "folders", + }, }, + Kind: "Folder", }, - &ListOptions{ - Key: &ResourceKey{ - Group: "folder.grafana.app", - Resource: "folders", + { + ListOptions: &ListOptions{ + Key: &ResourceKey{ + Group: "playlist.grafana.app", + Resource: "playlists", + }, }, + Kind: "Playlist", }, - &ListOptions{ - Key: &ResourceKey{ - Group: "dashboard.grafana.app", - Resource: "dashboards", + { + ListOptions: &ListOptions{ + Key: &ResourceKey{ + Group: "dashboard.grafana.app", + Resource: "dashboards", + }, }, - }) - return items + Kind: "Dashboard", + }, + } } func getSortFields(request *SearchRequest) []string { diff --git a/pkg/storage/unified/resource/index_metrics.go b/pkg/storage/unified/resource/index_metrics.go index 7c01d721fb2..25351ab2198 100644 --- a/pkg/storage/unified/resource/index_metrics.go +++ b/pkg/storage/unified/resource/index_metrics.go @@ -23,7 +23,7 @@ type IndexMetrics struct { IndexLatency *prometheus.HistogramVec IndexSize prometheus.Gauge IndexedDocs prometheus.Gauge - IndexedKinds *prometheus.CounterVec + IndexedKinds *prometheus.GaugeVec IndexCreationTime *prometheus.HistogramVec } @@ -53,7 +53,7 @@ func NewIndexMetrics(indexDir string, indexServer *IndexServer) *IndexMetrics { Name: "indexed_docs", Help: "Number of indexed documents by resource", }), - IndexedKinds: prometheus.NewCounterVec(prometheus.CounterOpts{ + IndexedKinds: prometheus.NewGaugeVec(prometheus.GaugeOpts{ Namespace: "index_server", Name: "indexed_kinds", Help: "Number of indexed documents by kind", diff --git a/pkg/storage/unified/resource/index_server.go b/pkg/storage/unified/resource/index_server.go index 1c53b67a374..a71ed0efd55 100644 --- a/pkg/storage/unified/resource/index_server.go +++ b/pkg/storage/unified/resource/index_server.go @@ -76,7 +76,7 @@ func (is *IndexServer) Watch(ctx context.Context) error { rtList := fetchResourceTypes() for _, rt := range rtList { wr := &WatchRequest{ - Options: rt, + Options: rt.ListOptions, } go func() { @@ -229,7 +229,7 @@ func getData(wr *WatchEvent_Resource) (*Data, error) { key := &ResourceKey{ Group: r.Group, - Resource: r.Kind, + Resource: r.Kind, // We use Kind as resource key since watch events don't have a resource name on them Namespace: r.Namespace, Name: r.Name, } diff --git a/pkg/tests/api/alerting/api_alertmanager_test.go b/pkg/tests/api/alerting/api_alertmanager_test.go index e5d7b5fb01f..67f6bb696eb 100644 --- a/pkg/tests/api/alerting/api_alertmanager_test.go +++ b/pkg/tests/api/alerting/api_alertmanager_test.go @@ -793,7 +793,8 @@ func TestIntegrationDeleteFolderWithRules(t *testing.T) { "exec_err_state": "Alerting", "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } @@ -1276,7 +1277,8 @@ func TestIntegrationAlertRuleCRUD(t *testing.T) { "exec_err_state":"Alerting", "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } @@ -1317,7 +1319,8 @@ func TestIntegrationAlertRuleCRUD(t *testing.T) { "exec_err_state":"Alerting", "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } @@ -1630,7 +1633,8 @@ func TestIntegrationAlertRuleCRUD(t *testing.T) { "exec_err_state":"Alerting", "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } @@ -1744,7 +1748,8 @@ func TestIntegrationAlertRuleCRUD(t *testing.T) { "exec_err_state":"Alerting", "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } @@ -1837,7 +1842,8 @@ func TestIntegrationAlertRuleCRUD(t *testing.T) { "exec_err_state":"Alerting", "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } @@ -2369,7 +2375,8 @@ func TestIntegrationQuota(t *testing.T) { "exec_err_state":"Alerting", "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } diff --git a/pkg/tests/api/alerting/api_prometheus_test.go b/pkg/tests/api/alerting/api_prometheus_test.go index 2e81b4c6c52..bfae05b1538 100644 --- a/pkg/tests/api/alerting/api_prometheus_test.go +++ b/pkg/tests/api/alerting/api_prometheus_test.go @@ -215,7 +215,10 @@ func TestIntegrationPrometheusRules(t *testing.T) { assert.Equal(t, 400, resp.StatusCode) var res map[string]any require.NoError(t, json.Unmarshal(b, &res)) - require.Equal(t, "invalid rule specification at index [0]: both annotations __dashboardUid__ and __panelId__ must be specified", res["message"]) + require.Contains(t, res["message"], "[0]") // Index of the invalid rule. + require.Contains(t, res["message"], ngmodels.ErrAlertRuleFailedValidation.Error()) + require.Contains(t, res["message"], ngmodels.DashboardUIDAnnotation) + require.Contains(t, res["message"], ngmodels.PanelIDAnnotation) } // Now, let's see how this looks like. diff --git a/pkg/tests/api/alerting/api_ruler_test.go b/pkg/tests/api/alerting/api_ruler_test.go index f96d6facd43..b54f70dec15 100644 --- a/pkg/tests/api/alerting/api_ruler_test.go +++ b/pkg/tests/api/alerting/api_ruler_test.go @@ -919,6 +919,46 @@ func TestIntegrationAlertRuleEditorSettings(t *testing.T) { require.False(t, updatedRuleGroup.Rules[0].GrafanaManagedAlert.Metadata.EditorSettings.SimplifiedQueryAndExpressionsSection) }) + t.Run("set simplified notifications editor in editor settings", func(t *testing.T) { + metadata := &apimodels.AlertRuleMetadata{ + EditorSettings: apimodels.AlertRuleEditorSettings{ + SimplifiedQueryAndExpressionsSection: false, + }, + } + createdRuleGroup := createAlertInGrafana(metadata) + + rulesWithUID := convertGettableRuleGroupToPostable(createdRuleGroup) + rulesWithUID.Rules[0].GrafanaManagedAlert.Metadata.EditorSettings.SimplifiedNotificationsSection = true + + _, status, _ := apiClient.PostRulesGroupWithStatus(t, folderName, &rulesWithUID) + assert.Equal(t, http.StatusAccepted, status) + + updatedRuleGroup := apiClient.GetRulesGroup(t, folderName, groupName).GettableRuleGroupConfig + require.Len(t, updatedRuleGroup.Rules, 1) + require.True(t, updatedRuleGroup.Rules[0].GrafanaManagedAlert.Metadata.EditorSettings.SimplifiedNotificationsSection) + }) + + t.Run("disable simplified notifications editor in editor settings", func(t *testing.T) { + metadata := &apimodels.AlertRuleMetadata{ + EditorSettings: apimodels.AlertRuleEditorSettings{ + SimplifiedNotificationsSection: true, + }, + } + createdRuleGroup := createAlertInGrafana(metadata) + + rulesWithUID := convertGettableRuleGroupToPostable(createdRuleGroup) + + // disabling the editor + rulesWithUID.Rules[0].GrafanaManagedAlert.Metadata.EditorSettings.SimplifiedNotificationsSection = false + + _, status, _ := apiClient.PostRulesGroupWithStatus(t, folderName, &rulesWithUID) + assert.Equal(t, http.StatusAccepted, status) + + updatedRuleGroup := apiClient.GetRulesGroup(t, folderName, groupName).GettableRuleGroupConfig + require.Len(t, updatedRuleGroup.Rules, 1) + require.False(t, updatedRuleGroup.Rules[0].GrafanaManagedAlert.Metadata.EditorSettings.SimplifiedNotificationsSection) + }) + t.Run("post alert without metadata", func(t *testing.T) { createAlertInGrafana(nil) @@ -1154,7 +1194,8 @@ func TestIntegrationRulerRulesFilterByDashboard(t *testing.T) { "exec_err_state": "Alerting", "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } @@ -1192,7 +1233,8 @@ func TestIntegrationRulerRulesFilterByDashboard(t *testing.T) { "exec_err_state": "Alerting", "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } @@ -1242,7 +1284,8 @@ func TestIntegrationRulerRulesFilterByDashboard(t *testing.T) { "exec_err_state": "Alerting", "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } diff --git a/pkg/tests/api/alerting/test-data/rulegroup-1-get.json b/pkg/tests/api/alerting/test-data/rulegroup-1-get.json index ab1231f3bd8..cb2b3df8345 100644 --- a/pkg/tests/api/alerting/test-data/rulegroup-1-get.json +++ b/pkg/tests/api/alerting/test-data/rulegroup-1-get.json @@ -44,7 +44,8 @@ "is_paused": false, "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } @@ -91,7 +92,8 @@ "is_paused": false, "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } diff --git a/pkg/tests/api/alerting/test-data/rulegroup-2-get.json b/pkg/tests/api/alerting/test-data/rulegroup-2-get.json index 397066bf202..572454ad1e7 100644 --- a/pkg/tests/api/alerting/test-data/rulegroup-2-get.json +++ b/pkg/tests/api/alerting/test-data/rulegroup-2-get.json @@ -44,7 +44,8 @@ "is_paused": false, "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } diff --git a/pkg/tests/api/alerting/test-data/rulegroup-3-get.json b/pkg/tests/api/alerting/test-data/rulegroup-3-get.json index 2956c506930..5e454967b5d 100644 --- a/pkg/tests/api/alerting/test-data/rulegroup-3-get.json +++ b/pkg/tests/api/alerting/test-data/rulegroup-3-get.json @@ -44,7 +44,8 @@ "is_paused": false, "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } @@ -91,7 +92,8 @@ "is_paused": false, "metadata": { "editor_settings": { - "simplified_query_and_expressions_section": false + "simplified_query_and_expressions_section": false, + "simplified_notifications_section": false } } } diff --git a/pkg/tests/api/plugins/data/expectedListResp.json b/pkg/tests/api/plugins/data/expectedListResp.json index dcbe8301979..4872d95f3c0 100644 --- a/pkg/tests/api/plugins/data/expectedListResp.json +++ b/pkg/tests/api/plugins/data/expectedListResp.json @@ -2089,7 +2089,7 @@ "hasUpdate": false, "defaultNavUrl": "/plugins/xychart/", "category": "", - "state": "beta", + "state": "", "signature": "internal", "signatureType": "", "signatureOrg": "", diff --git a/pkg/tsdb/loki/healthcheck.go b/pkg/tsdb/loki/healthcheck.go index 1bcd17e6be2..ad6dd904683 100644 --- a/pkg/tsdb/loki/healthcheck.go +++ b/pkg/tsdb/loki/healthcheck.go @@ -20,7 +20,7 @@ const ( func (s *Service) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) { - logger := s.logger.With("endpoint", "CheckHealth") + logger := s.logger.With("endpoint", "checkHealth") ds, err := s.im.Get(ctx, req.PluginContext) // check that the datasource exists if err != nil { diff --git a/pkg/tsdb/tempo/testData/trace.json b/pkg/tsdb/tempo/testData/trace.json index a0533a5cfd2..81c6f06c46f 100644 --- a/pkg/tsdb/tempo/testData/trace.json +++ b/pkg/tsdb/tempo/testData/trace.json @@ -1342,6 +1342,42 @@ "value": { "string_value": "net/http" } + }, + { + "key": "arrayAttribute", + "value": { + "array_value": { + "values": [ + { + "string_value": "value1" + }, + { + "string_value": "value2" + } + ] + } + } + }, + { + "key": "kvlistAttribute", + "value": { + "kvlist_value": { + "values": [ + { + "key": "key1", + "value": { + "string_value": "value1" + } + }, + { + "key": "key2", + "value": { + "string_value": "value2" + } + } + ] + } + } } ], "status": {} diff --git a/pkg/tsdb/tempo/trace_transform.go b/pkg/tsdb/tempo/trace_transform.go index 13b5e79fae7..047db53adf0 100644 --- a/pkg/tsdb/tempo/trace_transform.go +++ b/pkg/tsdb/tempo/trace_transform.go @@ -194,33 +194,79 @@ func resourceToProcess(resource *v1.Resource) (string, []*KeyValue) { if attribute.Key(attr.Key) == semconv.ServiceNameKey { serviceName = attr.GetValue().GetStringValue() } - tags = append(tags, &KeyValue{Key: attr.Key, Value: getAttributeVal(attr.Value)}) + val, err := getAttributeVal(attr.Value) + if err != nil { + logger.Debug("error transforming resource to process", "err", err) + } + tags = append(tags, &KeyValue{Key: attr.Key, Value: val}) } return serviceName, tags } -func getAttributeVal(attr *commonv11.AnyValue) any { +func getAttributeVal(attr *commonv11.AnyValue) (any, error) { switch attr.GetValue().(type) { case *commonv11.AnyValue_StringValue: - return attr.GetStringValue() + return attr.GetStringValue(), nil case *commonv11.AnyValue_IntValue: - return attr.GetIntValue() + return attr.GetIntValue(), nil case *commonv11.AnyValue_BoolValue: - return attr.GetBoolValue() + return attr.GetBoolValue(), nil case *commonv11.AnyValue_DoubleValue: - return attr.GetDoubleValue() - case *commonv11.AnyValue_KvlistValue, *commonv11.AnyValue_ArrayValue: - return attr.GetStringValue() + return attr.GetDoubleValue(), nil + case *commonv11.AnyValue_KvlistValue: + return kvListAsString(attr.GetKvlistValue()) + case *commonv11.AnyValue_ArrayValue: + return arrayAsString(attr.GetArrayValue()) default: - return nil + return attr.GetStringValue(), nil } } +func arrayAsString(list *commonv11.ArrayValue) (string, error) { + vals := make([]any, len(list.GetValues())) + + for i, val := range list.GetValues() { + v, err := getAttributeVal(val) + if err != nil { + return "", fmt.Errorf("failed to get attribute value: %w", err) + } + vals[i] = v + } + + res, err := json.Marshal(vals) + if err != nil { + return "", fmt.Errorf("failed to marshal array: %w", err) + } + return string(res), nil +} + +func kvListAsString(list *commonv11.KeyValueList) (string, error) { + vals := make(map[string]any, len(list.GetValues())) + + for _, val := range list.GetValues() { + v, err := getAttributeVal(val.GetValue()) + if err != nil { + return "", fmt.Errorf("failed to get attribute value: %w", err) + } + vals[val.GetKey()] = v + } + + res, err := json.Marshal(vals) + if err != nil { + return "", fmt.Errorf("failed to marshal kvlist: %w", err) + } + return string(res), nil +} + func getSpanTags(span *tracev11.Span) []*KeyValue { tags := make([]*KeyValue, len(span.Attributes)) for i, attr := range span.Attributes { - tags[i] = &KeyValue{Key: attr.Key, Value: getAttributeVal(attr.Value)} + val, err := getAttributeVal(attr.Value) + if err != nil { + logger.Debug("error transforming span tags", "err", err) + } + tags[i] = &KeyValue{Key: attr.Key, Value: val} } return tags } @@ -255,7 +301,11 @@ func spanEventsToLogs(events []*tracev11.Span_Event) []*TraceLog { event := events[i] fields := make([]*KeyValue, 0, len(event.Attributes)+1) for _, attr := range event.Attributes { - fields = append(fields, &KeyValue{Key: attr.Key, Value: getAttributeVal(attr.Value)}) + val, err := getAttributeVal(attr.Value) + if err != nil { + logger.Debug("error transforming span events to logs", "err", err) + } + fields = append(fields, &KeyValue{Key: attr.Key, Value: val}) } logs = append(logs, &TraceLog{ Timestamp: float64(event.TimeUnixNano) / 1_000_000, @@ -285,7 +335,11 @@ func spanLinksToReferences(links []*tracev11.Span_Link) []*TraceReference { tags := make([]*KeyValue, 0, len(link.Attributes)) for _, attr := range link.Attributes { - tags = append(tags, &KeyValue{Key: attr.Key, Value: getAttributeVal(attr.Value)}) + val, err := getAttributeVal(attr.Value) + if err != nil { + logger.Debug("error transforming span links to references", "err", err) + } + tags = append(tags, &KeyValue{Key: attr.Key, Value: val}) } references = append(references, &TraceReference{ diff --git a/pkg/tsdb/tempo/trace_transform_test.go b/pkg/tsdb/tempo/trace_transform_test.go index 8fd69f64ca8..64cee9584a8 100644 --- a/pkg/tsdb/tempo/trace_transform_test.go +++ b/pkg/tsdb/tempo/trace_transform_test.go @@ -45,7 +45,7 @@ func TestTraceToFrame(t *testing.T) { require.Equal(t, 1616072924070.497, root["startTime"]) require.Equal(t, 8.421, root["duration"]) require.Equal(t, json.RawMessage("null"), root["logs"]) - require.Equal(t, json.RawMessage("[{\"value\":\"const\",\"key\":\"sampler.type\"},{\"value\":true,\"key\":\"sampler.param\"},{\"value\":200,\"key\":\"http.status_code\"},{\"value\":\"GET\",\"key\":\"http.method\"},{\"value\":\"/loki/api/v1/query_range?direction=BACKWARD\\u0026limit=1000\\u0026query=%7Bcompose_project%3D%22devenv%22%7D%20%7C%3D%22trace_id%22\\u0026start=1616070921000000000\\u0026end=1616072722000000000\\u0026step=2\",\"key\":\"http.url\"},{\"value\":\"net/http\",\"key\":\"component\"}]"), root["tags"]) + require.Equal(t, json.RawMessage("[{\"value\":\"const\",\"key\":\"sampler.type\"},{\"value\":true,\"key\":\"sampler.param\"},{\"value\":200,\"key\":\"http.status_code\"},{\"value\":\"GET\",\"key\":\"http.method\"},{\"value\":\"/loki/api/v1/query_range?direction=BACKWARD\\u0026limit=1000\\u0026query=%7Bcompose_project%3D%22devenv%22%7D%20%7C%3D%22trace_id%22\\u0026start=1616070921000000000\\u0026end=1616072722000000000\\u0026step=2\",\"key\":\"http.url\"},{\"value\":\"net/http\",\"key\":\"component\"},{\"value\":\"[\\\"value1\\\",\\\"value2\\\"]\",\"key\":\"arrayAttribute\"},{\"value\":\"{\\\"key1\\\":\\\"value1\\\",\\\"key2\\\":\\\"value2\\\"}\",\"key\":\"kvlistAttribute\"}]"), root["tags"]) span := bFrame.FindRowWithValue("spanID", "7198307df9748606") diff --git a/public/api-enterprise-spec.json b/public/api-enterprise-spec.json index 03cfc610ab7..957d01fcb14 100644 --- a/public/api-enterprise-spec.json +++ b/public/api-enterprise-spec.json @@ -7004,6 +7004,9 @@ "branding": { "$ref": "#/definitions/ReportBrandingOptions" }, + "embeddedImageTheme": { + "type": "string" + }, "id": { "type": "integer", "format": "int64" @@ -7012,6 +7015,9 @@ "type": "integer", "format": "int64" }, + "pdfTheme": { + "type": "string" + }, "userId": { "type": "integer", "format": "int64" diff --git a/public/api-merged.json b/public/api-merged.json index 5846dc3b5ca..f54a90d84d6 100644 --- a/public/api-merged.json +++ b/public/api-merged.json @@ -19666,6 +19666,9 @@ "branding": { "$ref": "#/definitions/ReportBrandingOptions" }, + "embeddedImageTheme": { + "type": "string" + }, "id": { "type": "integer", "format": "int64" @@ -19674,6 +19677,9 @@ "type": "integer", "format": "int64" }, + "pdfTheme": { + "type": "string" + }, "userId": { "type": "integer", "format": "int64" diff --git a/public/app/core/components/AppChrome/MegaMenu/MegaMenu.tsx b/public/app/core/components/AppChrome/MegaMenu/MegaMenu.tsx index 38b61edad70..d9bd69a7002 100644 --- a/public/app/core/components/AppChrome/MegaMenu/MegaMenu.tsx +++ b/public/app/core/components/AppChrome/MegaMenu/MegaMenu.tsx @@ -6,8 +6,7 @@ import { useLocation } from 'react-router-dom-v5-compat'; import { GrafanaTheme2, NavModelItem } from '@grafana/data'; import { selectors } from '@grafana/e2e-selectors'; import { config, reportInteraction } from '@grafana/runtime'; -import { Icon, IconButton, useStyles2, Stack } from '@grafana/ui'; -import { ScrollContainer } from '@grafana/ui/src/unstable'; +import { Icon, IconButton, ScrollContainer, useStyles2, Stack } from '@grafana/ui'; import { useGrafana } from 'app/core/context/GrafanaContext'; import { t } from 'app/core/internationalization'; import { setBookmark } from 'app/core/reducers/navBarTree'; diff --git a/public/app/core/components/ForgottenPassword/ChangePasswordPage.test.tsx b/public/app/core/components/ForgottenPassword/ChangePasswordPage.test.tsx index 0cd67650137..401843d80c3 100644 --- a/public/app/core/components/ForgottenPassword/ChangePasswordPage.test.tsx +++ b/public/app/core/components/ForgottenPassword/ChangePasswordPage.test.tsx @@ -10,6 +10,9 @@ jest.mock('@grafana/runtime', () => ({ getBackendSrv: () => ({ post: postMock, }), + locationService: { + getSearch: () => new URLSearchParams(), + }, config: { ...jest.requireActual('@grafana/runtime').config, loginError: false, diff --git a/public/app/core/components/Login/LoginCtrl.tsx b/public/app/core/components/Login/LoginCtrl.tsx index 1a8a1abfd5b..7487452b774 100644 --- a/public/app/core/components/Login/LoginCtrl.tsx +++ b/public/app/core/components/Login/LoginCtrl.tsx @@ -1,21 +1,37 @@ import { PureComponent } from 'react'; -import { FetchError, getBackendSrv, isFetchError } from '@grafana/runtime'; +import { FetchError, getBackendSrv, isFetchError, locationService } from '@grafana/runtime'; import config from 'app/core/config'; import { t } from 'app/core/internationalization'; -import { LoginDTO } from './types'; +import { LoginDTO, AuthNRedirectDTO } from './types'; const isOauthEnabled = () => { return !!config.oauth && Object.keys(config.oauth).length > 0; }; +const showPasswordlessConfirmation = () => { + const queryValues = locationService.getSearch(); + return !!queryValues.get('code'); +}; + export interface FormModel { user: string; password: string; email: string; } +export interface PasswordlessFormModel { + email: string; +} + +export interface PasswordlessConfirmationFormModel { + code: string; + confirmationCode: string; + username?: string; + name?: string; +} + interface Props { resetCode?: string; @@ -25,6 +41,9 @@ interface Props { isChangingPassword: boolean; skipPasswordChange: Function; login: (data: FormModel) => void; + passwordlessStart: (data: PasswordlessFormModel) => void; + passwordlessConfirm: (data: PasswordlessConfirmationFormModel) => void; + showPasswordlessConfirmation: boolean; disableLoginForm: boolean; disableUserSignUp: boolean; isOauthEnabled: boolean; @@ -111,6 +130,49 @@ export class LoginCtrl extends PureComponent ('/api/login/passwordless/start', formModel, { showErrorAlert: false }) + .then((result) => { + window.location.assign(result.URL); + return; + }) + .catch((err) => { + const fetchErrorMessage = isFetchError(err) ? getErrorMessage(err) : undefined; + this.setState({ + isLoggingIn: false, + loginErrorMessage: fetchErrorMessage || t('login.error.unknown', 'Unknown error occurred'), + }); + }); + }; + + passwordlessConfirm = (formModel: PasswordlessConfirmationFormModel) => { + this.setState({ + loginErrorMessage: undefined, + isLoggingIn: true, + }); + + getBackendSrv() + .post ('/api/login/passwordless/authenticate', formModel, { showErrorAlert: false }) + .then((result) => { + this.result = result; + this.toGrafana(); + return; + }) + .catch((err) => { + const fetchErrorMessage = isFetchError(err) ? getErrorMessage(err) : undefined; + this.setState({ + isLoggingIn: false, + loginErrorMessage: fetchErrorMessage || t('login.error.unknown', 'Unknown error occurred'), + }); + }); + }; + changeView = (showDefaultPasswordWarning: boolean) => { this.setState({ isChangingPassword: true, @@ -138,7 +200,7 @@ export class LoginCtrl extends PureComponent - {!isChangingPassword && ( + {!isChangingPassword && !showPasswordlessConfirmation && ( {loginErrorMessage && ( )} - {isChangingPassword && ( + {config.auth.passwordlessEnabled && showPasswordlessConfirmation && ( +@@ -44,7 +49,7 @@ const LoginPage = () => { )} - {!disableLoginForm && ( + {!disableLoginForm && !config.auth.passwordlessEnabled && ({!config.auth.disableLogin && ( @@ -59,12 +64,24 @@ const LoginPage = () => { + )} {!disableUserSignUp && } + + )} + + {isChangingPassword && !config.auth.passwordlessEnabled && (+ void; + isLoggingIn: boolean; +} + +export const PasswordlessConfirmation = ({ onSubmit, isLoggingIn }: Props) => { + const styles = useStyles2(getStyles); + const confirmationCodeId = useId(); + const codeId = useId(); + const usernameId = useId(); + const nameId = useId(); + const [signup, setSignup] = useState(false); + + const { + handleSubmit, + register, + setValue, + formState: { errors }, + } = useForm ({ mode: 'onChange' }); + + useEffect(() => { + Branding.LoginTitle = "We've sent you an email!"; + Branding.GetLoginSubTitle = () => + "Check your inbox and click the confirmation link or use the confirmation code we've sent."; + + const queryValues = locationService.getSearch(); + + setValue('code', queryValues.get('code') || ''); + if (queryValues.get('confirmationCode')) { + setValue('confirmationCode', queryValues.get('confirmationCode') || ''); + if (!queryValues.get('signup')) { + handleSubmit(onSubmit)(); + } + } + if (queryValues.get('signup')) { + setSignup(true); + } + if (queryValues.get('username')) { + setValue('username', queryValues.get('username') || ''); + } + if (queryValues.get('name')) { + setValue('name', queryValues.get('name') || ''); + } + }, [setValue, handleSubmit, onSubmit, setSignup]); + + return ( + + ++ ); +}; + +export const getStyles = (theme: GrafanaTheme2) => { + return { + wrapper: css({ + width: '100%', + paddingBottom: theme.spacing(2), + }), + + submitButton: css({ + justifyContent: 'center', + width: '100%', + }), + + skipButton: css({ + alignSelf: 'flex-start', + }), + }; +}; diff --git a/public/app/core/components/Login/PasswordlessLoginForm.tsx b/public/app/core/components/Login/PasswordlessLoginForm.tsx new file mode 100644 index 00000000000..f1737510f12 --- /dev/null +++ b/public/app/core/components/Login/PasswordlessLoginForm.tsx @@ -0,0 +1,70 @@ +import { css } from '@emotion/css'; +import { useId } from 'react'; +import { useForm } from 'react-hook-form'; + +import { GrafanaTheme2 } from '@grafana/data'; +import { selectors } from '@grafana/e2e-selectors'; +import { Button, Input, Field, useStyles2 } from '@grafana/ui'; +import { t } from 'app/core/internationalization'; + +import { PasswordlessFormModel } from './LoginCtrl'; + +interface Props { + onSubmit: (data: PasswordlessFormModel) => void; + isLoggingIn: boolean; +} + +export const PasswordlessLoginForm = ({ onSubmit, isLoggingIn }: Props) => { + const styles = useStyles2(getStyles); + const emailId = useId(); + const { + handleSubmit, + register, + formState: { errors }, + } = useForm({ mode: 'onChange' }); + + return ( + + ++ ); +}; + +export const getStyles = (theme: GrafanaTheme2) => { + return { + wrapper: css({ + width: '100%', + paddingBottom: theme.spacing(2), + }), + + submitButton: css({ + justifyContent: 'center', + width: '100%', + }), + + skipButton: css({ + alignSelf: 'flex-start', + }), + }; +}; diff --git a/public/app/core/components/Login/types.ts b/public/app/core/components/Login/types.ts index 4ca72bb46ae..4fa504f1201 100644 --- a/public/app/core/components/Login/types.ts +++ b/public/app/core/components/Login/types.ts @@ -2,3 +2,7 @@ export interface LoginDTO { message: string; redirectUrl: string; } + +export interface AuthNRedirectDTO { + URL: string; +} diff --git a/public/app/core/components/RolePicker/RolePickerMenu.tsx b/public/app/core/components/RolePicker/RolePickerMenu.tsx index 193a5062a8f..9ee528c1e9b 100644 --- a/public/app/core/components/RolePicker/RolePickerMenu.tsx +++ b/public/app/core/components/RolePicker/RolePickerMenu.tsx @@ -1,9 +1,8 @@ import { css, cx } from '@emotion/css'; import { useEffect, useRef, useState } from 'react'; -import { Button, Stack, TextLink, useStyles2, useTheme2 } from '@grafana/ui'; +import { Button, ScrollContainer, Stack, TextLink, useStyles2, useTheme2 } from '@grafana/ui'; import { getSelectStyles } from '@grafana/ui/src/components/Select/getSelectStyles'; -import { ScrollContainer } from '@grafana/ui/src/unstable'; import { OrgRole, Role } from 'app/types'; import { BuiltinRoleSelector } from './BuiltinRoleSelector'; diff --git a/public/app/core/components/RolePicker/RolePickerSubMenu.tsx b/public/app/core/components/RolePicker/RolePickerSubMenu.tsx index 68bc285c281..647ba41b301 100644 --- a/public/app/core/components/RolePicker/RolePickerSubMenu.tsx +++ b/public/app/core/components/RolePicker/RolePickerSubMenu.tsx @@ -1,8 +1,7 @@ import { cx } from '@emotion/css'; -import { Button, Stack, useStyles2, useTheme2 } from '@grafana/ui'; +import { Button, ScrollContainer, Stack, useStyles2, useTheme2 } from '@grafana/ui'; import { getSelectStyles } from '@grafana/ui/src/components/Select/getSelectStyles'; -import { ScrollContainer } from '@grafana/ui/src/unstable'; import { Role } from 'app/types'; import { RoleMenuOption } from './RoleMenuOption'; diff --git a/public/app/core/services/echo/backends/grafana-javascript-agent/GrafanaJavascriptAgentBackend.test.ts b/public/app/core/services/echo/backends/grafana-javascript-agent/GrafanaJavascriptAgentBackend.test.ts index 59b0a130f4c..ca7d940b2fc 100644 --- a/public/app/core/services/echo/backends/grafana-javascript-agent/GrafanaJavascriptAgentBackend.test.ts +++ b/public/app/core/services/echo/backends/grafana-javascript-agent/GrafanaJavascriptAgentBackend.test.ts @@ -92,7 +92,7 @@ describe('GrafanaJavascriptAgentEchoBackend', () => { expect(initializeFaroMock.mock.calls[0][0].transports?.length).toEqual(2); expect(initializeFaroMock.mock.calls[0][0].transports?.[0]).toBeInstanceOf(EchoSrvTransport); expect(initializeFaroMock.mock.calls[0][0].transports?.[0].getIgnoreUrls()).toEqual([ - new RegExp('/*/log-grafana-javascript-agent/'), + /.*\/log-grafana-javascript-agent.*/, /.*.google-analytics.com*.*/, /.*.googletagmanager.com*.*/, /frontend-metrics/, diff --git a/public/app/core/services/echo/backends/grafana-javascript-agent/GrafanaJavascriptAgentBackend.ts b/public/app/core/services/echo/backends/grafana-javascript-agent/GrafanaJavascriptAgentBackend.ts index f9659d6a168..4ea54e38053 100644 --- a/public/app/core/services/echo/backends/grafana-javascript-agent/GrafanaJavascriptAgentBackend.ts +++ b/public/app/core/services/echo/backends/grafana-javascript-agent/GrafanaJavascriptAgentBackend.ts @@ -1,4 +1,4 @@ -import { BuildInfo } from '@grafana/data'; +import { BuildInfo, escapeRegex } from '@grafana/data'; import { BaseTransport, defaultInternalLoggerLevel } from '@grafana/faro-core'; import { initializeFaro, @@ -53,7 +53,12 @@ export class GrafanaJavascriptAgentBackend constructor(public options: GrafanaJavascriptAgentBackendOptions) { // configure instrumentations. const instrumentations: Instrumentation[] = []; - const ignoreUrls = [new RegExp(`/*${options.customEndpoint}/`), ...TRACKING_URLS, ...options.ignoreUrls]; + + const ignoreUrls = [ + new RegExp(`.*${escapeRegex(options.customEndpoint)}.*`), + ...TRACKING_URLS, + ...options.ignoreUrls, + ]; const transports: BaseTransport[] = [new EchoSrvTransport({ ignoreUrls })]; diff --git a/public/app/features/alerting/routes.tsx b/public/app/features/alerting/routes.tsx index ef88f26d6c6..bb7bbe9c995 100644 --- a/public/app/features/alerting/routes.tsx +++ b/public/app/features/alerting/routes.tsx @@ -4,6 +4,10 @@ import { GrafanaRouteComponent, RouteDescriptor } from 'app/core/navigation/type import { AccessControlAction } from 'app/types'; import { PERMISSIONS_CONTACT_POINTS } from './unified/components/contact-points/permissions'; +import { + PERMISSIONS_TIME_INTERVALS_MODIFY, + PERMISSIONS_TIME_INTERVALS_READ, +} from './unified/components/mute-timings/permissions'; import { PERMISSIONS_TEMPLATES } from './unified/components/templates/permissions'; import { evaluateAccess } from './unified/utils/access-control'; @@ -33,6 +37,8 @@ export function getAlertingRoutes(cfg = config): RouteDescriptor[] { roles: evaluateAccess([ AccessControlAction.AlertingNotificationsRead, AccessControlAction.AlertingNotificationsExternalRead, + ...PERMISSIONS_TIME_INTERVALS_READ, + ...PERMISSIONS_TIME_INTERVALS_MODIFY, ]), component: importAlertingComponent( () => import(/* webpackChunkName: "AlertAmRoutes" */ 'app/features/alerting/unified/NotificationPolicies') @@ -43,6 +49,7 @@ export function getAlertingRoutes(cfg = config): RouteDescriptor[] { roles: evaluateAccess([ AccessControlAction.AlertingNotificationsWrite, AccessControlAction.AlertingNotificationsExternalWrite, + ...PERMISSIONS_TIME_INTERVALS_MODIFY, ]), component: importAlertingComponent( () => @@ -56,6 +63,8 @@ export function getAlertingRoutes(cfg = config): RouteDescriptor[] { roles: evaluateAccess([ AccessControlAction.AlertingNotificationsWrite, AccessControlAction.AlertingNotificationsExternalWrite, + ...PERMISSIONS_TIME_INTERVALS_READ, + ...PERMISSIONS_TIME_INTERVALS_MODIFY, ]), component: importAlertingComponent( () => diff --git a/public/app/features/alerting/unified/Analytics.ts b/public/app/features/alerting/unified/Analytics.ts index 09a3da9f551..87044454af4 100644 --- a/public/app/features/alerting/unified/Analytics.ts +++ b/public/app/features/alerting/unified/Analytics.ts @@ -29,9 +29,11 @@ export const LogMessages = { loadedCentralAlertStateHistory: 'loaded central alert state history', }; -const { logInfo, logError, logMeasurement } = createMonitoringLogger('features.alerting', { module: 'Alerting' }); +const { logInfo, logError, logMeasurement, logWarning } = createMonitoringLogger('features.alerting', { + module: 'Alerting', +}); -export { logError, logInfo, logMeasurement }; +export { logError, logInfo, logMeasurement, logWarning }; // eslint-disable-next-line @typescript-eslint/no-explicit-any export function withPerformanceLoggingPromise >( diff --git a/public/app/features/alerting/unified/NotificationPolicies.tsx b/public/app/features/alerting/unified/NotificationPolicies.tsx index beb1b908abe..2d9dbcd2ac6 100644 --- a/public/app/features/alerting/unified/NotificationPolicies.tsx +++ b/public/app/features/alerting/unified/NotificationPolicies.tsx @@ -242,54 +242,51 @@ const AmRoutes = () => { {isFetching && ); diff --git a/public/app/features/alerting/unified/PanelAlertTabContent.tsx b/public/app/features/alerting/unified/PanelAlertTabContent.tsx index 41d38cd6014..412f82e3db4 100644 --- a/public/app/features/alerting/unified/PanelAlertTabContent.tsx +++ b/public/app/features/alerting/unified/PanelAlertTabContent.tsx @@ -2,8 +2,7 @@ import { css } from '@emotion/css'; import { GrafanaTheme2 } from '@grafana/data'; import { selectors } from '@grafana/e2e-selectors'; -import { Alert, LoadingPlaceholder, useStyles2 } from '@grafana/ui'; -import { ScrollContainer } from '@grafana/ui/src/unstable'; +import { Alert, LoadingPlaceholder, ScrollContainer, useStyles2 } from '@grafana/ui'; import { contextSrv } from 'app/core/services/context_srv'; import { DashboardModel, PanelModel } from 'app/features/dashboard/state'; diff --git a/public/app/features/alerting/unified/components/alert-groups/AlertGroup.tsx b/public/app/features/alerting/unified/components/alert-groups/AlertGroup.tsx index 7c5169f930b..17fc1ca5a01 100644 --- a/public/app/features/alerting/unified/components/alert-groups/AlertGroup.tsx +++ b/public/app/features/alerting/unified/components/alert-groups/AlertGroup.tsx @@ -3,9 +3,9 @@ import { useState } from 'react'; import { GrafanaTheme2 } from '@grafana/data'; import { useStyles2, Stack, TextLink } from '@grafana/ui'; -import { AlertmanagerGroup, AlertState } from 'app/plugins/datasource/alertmanager/types'; +import { AlertmanagerGroup } from 'app/plugins/datasource/alertmanager/types'; -import { createContactPointLink } from '../../utils/misc'; +import { createContactPointSearchLink } from '../../utils/misc'; import { AlertLabels } from '../AlertLabels'; import { CollapseToggle } from '../CollapseToggle'; import { MetaText } from '../MetaText'; @@ -44,7 +44,7 @@ export const AlertGroup = ({ alertManagerSourceName, group }: Props) => {} - {haveError && ( - - {resultError.message || 'Unknown error.'} - - )} - {haveData && ( + {policyTreeTabActive && ( <> - {policyTreeTabActive && ( - <> -- {rootRoute && ( - - {addModal} - {editModal} - {deleteModal} - {alertInstancesModal} - + {haveError && ( +- )} - {rootRoute && ( - - )} - + {resultError.message || 'Unknown error.'} + )} - {muteTimingsTabActive && ( -+ {haveData && ( + + {rootRoute && ( + )} + {addModal} + {editModal} + {deleteModal} + {alertInstancesModal} )} + {muteTimingsTabActive && ( ++ )} + {rootRoute && ( + + )} + + )} Delivered to{' '} ({ flexWrap: 'wrap', alignItems: 'center', justifyContent: 'space-between', - padding: `${theme.spacing(1)} ${theme.spacing(1)} ${theme.spacing(1)} 0`, + padding: theme.spacing(1), backgroundColor: theme.colors.background.secondary, width: '100%', }), @@ -86,14 +86,4 @@ const getStyles = (theme: GrafanaTheme2) => ({ flexDirection: 'row', alignItems: 'center', }), - summary: css({}), - [AlertState.Active]: css({ - color: theme.colors.error.main, - }), - [AlertState.Suppressed]: css({ - color: theme.colors.primary.main, - }), - [AlertState.Unprocessed]: css({ - color: theme.colors.secondary.main, - }), }); diff --git a/public/app/features/alerting/unified/components/contact-points/ContactPoint.tsx b/public/app/features/alerting/unified/components/contact-points/ContactPoint.tsx index 2c249b30171..c3a9c10aae2 100644 --- a/public/app/features/alerting/unified/components/contact-points/ContactPoint.tsx +++ b/public/app/features/alerting/unified/components/contact-points/ContactPoint.tsx @@ -47,13 +47,7 @@ export const ContactPoint = ({ contactPoint }: ContactPointProps) => { }) } /> - {receivers.length === 0 && ( - -- )} + {showFullMetadata ? (- -No integrations configured -{receivers.map((receiver, index) => { @@ -176,6 +170,11 @@ export const ContactPointReceiverSummary = ({ receivers, limit }: ContactPointRe return (); diff --git a/public/app/plugins/panel/nodeGraph/module.tsx b/public/app/plugins/panel/nodeGraph/module.tsx index 3a3c0399a34..8aa1151d834 100644 --- a/public/app/plugins/panel/nodeGraph/module.tsx +++ b/public/app/plugins/panel/nodeGraph/module.tsx @@ -10,6 +10,17 @@ export const plugin = new PanelPlugin+ {integrationsShown.length === 0 && ( + {!isLastItem && '⋅'} diff --git a/public/app/features/alerting/unified/components/contact-points/ContactPoints.tsx b/public/app/features/alerting/unified/components/contact-points/ContactPoints.tsx index 6366c421d9a..c33609b367f 100644 --- a/public/app/features/alerting/unified/components/contact-points/ContactPoints.tsx +++ b/public/app/features/alerting/unified/components/contact-points/ContactPoints.tsx @@ -243,6 +243,11 @@ const ContactPointsList = ({ contactPoints, search, pageSize = DEFAULT_PAGE_SIZE const searchResults = useContactPointsSearch(contactPoints, search); const { page, pageItems, numberOfPages, onPageChange } = usePagination(searchResults, 1, pageSize); + if (pageItems.length === 0) { + const emptyMessage = t('alerting.contact-points.no-contact-points-found', 'No contact points found'); + return+ + )} {integrationsShown.map(([type, receivers], index) => { const iconName = INTEGRATION_ICONS[type]; const receiverName = receiverTypeNames[type] ?? upperFirst(type); @@ -198,7 +197,7 @@ export const ContactPointReceiverSummary = ({ receivers, limit }: ContactPointRe {iconName &&No integrations configured +} {receiverName} - {receivers.length > 1 && receivers.length} + {receivers.length > 1 && ` (${receivers.length})`} ; + } + return ( <> {pageItems.map((contactPoint, index) => { diff --git a/public/app/features/alerting/unified/components/contact-points/permissions.ts b/public/app/features/alerting/unified/components/contact-points/permissions.ts index 30af528e6dc..48ba46a10c5 100644 --- a/public/app/features/alerting/unified/components/contact-points/permissions.ts +++ b/public/app/features/alerting/unified/components/contact-points/permissions.ts @@ -5,7 +5,7 @@ import { AccessControlAction } from 'app/types'; * * Any permission in this list will be checked for client side access to view Contact Points functionality. */ -const PERMISSIONS_CONTACT_POINTS_READ = [AccessControlAction.AlertingReceiversRead]; +export const PERMISSIONS_CONTACT_POINTS_READ = [AccessControlAction.AlertingReceiversRead]; /** * List of granular permissions that allow modifying contact points diff --git a/public/app/features/alerting/unified/components/contact-points/utils.ts b/public/app/features/alerting/unified/components/contact-points/utils.ts index 5f6deb9c0b0..c02bfabfb1a 100644 --- a/public/app/features/alerting/unified/components/contact-points/utils.ts +++ b/public/app/features/alerting/unified/components/contact-points/utils.ts @@ -129,7 +129,7 @@ export function enhanceContactPointsWithMetadata({ const receivers = extractReceivers(contactPoint); const statusForReceiver = status.find((status) => status.name === contactPoint.name); - const id = 'id' in contactPoint && contactPoint.id ? contactPoint.id : contactPoint.name; + const id = getContactPointIdentifier(contactPoint); return { ...contactPoint, @@ -157,6 +157,10 @@ export function enhanceContactPointsWithMetadata({ return enhanced.sort((a, b) => a.name.localeCompare(b.name)); } +function getContactPointIdentifier(contactPoint: Receiver): string { + return 'id' in contactPoint && contactPoint.id ? contactPoint.id : contactPoint.name; +} + export function isAutoGeneratedPolicy(route: Route) { const simplifiedRoutingToggleEnabled = config.featureToggles.alertingSimplifiedRouting ?? false; if (!simplifiedRoutingToggleEnabled) { diff --git a/public/app/features/alerting/unified/components/mute-timings/permissions.ts b/public/app/features/alerting/unified/components/mute-timings/permissions.ts new file mode 100644 index 00000000000..dc895c100c8 --- /dev/null +++ b/public/app/features/alerting/unified/components/mute-timings/permissions.ts @@ -0,0 +1,11 @@ +import { AccessControlAction } from 'app/types'; + +/** + * List of granular permissions that allow viewing contact points + */ +export const PERMISSIONS_TIME_INTERVALS_READ = [AccessControlAction.AlertingTimeIntervalsRead]; + +/** + * List of granular permissions that allow modifying time intervals + */ +export const PERMISSIONS_TIME_INTERVALS_MODIFY = [AccessControlAction.AlertingTimeIntervalsWrite]; diff --git a/public/app/features/alerting/unified/components/notification-policies/Policy.test.tsx b/public/app/features/alerting/unified/components/notification-policies/Policy.test.tsx index 2985c7e20a6..19afef0f8e0 100644 --- a/public/app/features/alerting/unified/components/notification-policies/Policy.test.tsx +++ b/public/app/features/alerting/unified/components/notification-policies/Policy.test.tsx @@ -15,7 +15,7 @@ import { import { ReceiversState } from 'app/types/alerting'; import { useAlertmanagerAbilities } from '../../hooks/useAbilities'; -import { mockAlertGroup, mockAlertmanagerAlert, mockReceiversState } from '../../mocks'; +import { mockReceiversState } from '../../mocks'; import { AlertmanagerProvider } from '../../state/AlertmanagerContext'; import { GRAFANA_RULES_SOURCE_NAME } from '../../utils/datasource'; @@ -57,7 +57,8 @@ describe('Policy', () => { renderPolicy( { renderPolicy( { renderPolicy( { renderPolicy( { renderPolicy( { routes: [{ id: '1', object_matchers: [['foo', eq, 'bar']] }], }; - const matchingGroups: AlertmanagerGroup[] = [ - mockAlertGroup({ - labels: {}, - alerts: [mockAlertmanagerAlert({ labels: { foo: 'bar' } }), mockAlertmanagerAlert({ labels: { foo: 'bar' } })], - }), - mockAlertGroup({ - labels: {}, - alerts: [mockAlertmanagerAlert({ labels: { bar: 'baz' } })], - }), - ]; - renderPolicy( { renderPolicy( void; @@ -79,6 +77,7 @@ interface PolicyComponentProps { formatter?: MatcherFormatter ) => void; isAutoGenerated?: boolean; + isDefaultPolicy?: boolean; } const Policy = (props: PolicyComponentProps) => { @@ -87,10 +86,8 @@ const Policy = (props: PolicyComponentProps) => { contactPointsState, readOnly = false, provisioned = false, - alertGroups = [], alertManagerSourceName, currentRoute, - routeTree, inheritedProperties, routesMatchingFilters = { filtersApplied: false, @@ -102,12 +99,11 @@ const Policy = (props: PolicyComponentProps) => { onDeletePolicy, onShowAlertInstances, isAutoGenerated = false, + isDefaultPolicy = false, } = props; const styles = useStyles2(getStyles); - const isDefaultPolicy = currentRoute === routeTree; - const contactPoint = currentRoute.receiver; const continueMatching = currentRoute.continue ?? false; @@ -353,7 +349,6 @@ const Policy = (props: PolicyComponentProps) => { return ( { onDeletePolicy={onDeletePolicy} onShowAlertInstances={onShowAlertInstances} alertManagerSourceName={alertManagerSourceName} - alertGroups={alertGroups} routesMatchingFilters={routesMatchingFilters} matchingInstancesPreview={matchingInstancesPreview} isAutoGenerated={isThisChildAutoGenerated} @@ -844,7 +838,6 @@ interface ContactPointDetailsProps { receivers: Receiver[]; } -// @TODO make this work for cloud AMs too const ContactPointsHoverDetails: FC = ({ alertManagerSourceName, contactPoint, @@ -852,67 +845,40 @@ const ContactPointsHoverDetails: FC = ({ }) => { const details = receivers.find((receiver) => receiver.name === contactPoint); if (!details) { + // If we can't find details, then it's possible (likely) that the user doesn't have access to this + // contact point, so we don't try and link to it return ( - + + ); } const integrations = details.grafana_managed_receiver_configs; - if (!integrations) { - return ( -{contactPoint} - - {contactPoint} - - ); - } - const groupedIntegrations = groupBy(details.grafana_managed_receiver_configs, (config) => config.type); + const contactPointLink = + 'id' in details && details.id + ? createContactPointLink(details.id, alertManagerSourceName) + : createContactPointSearchLink(details.name, alertManagerSourceName); return (- diff --git a/public/app/features/alerting/unified/components/rule-editor/QueryRows.tsx b/public/app/features/alerting/unified/components/rule-editor/QueryRows.tsx index b3cdcafcc3b..22dc6e98528 100644 --- a/public/app/features/alerting/unified/components/rule-editor/QueryRows.tsx +++ b/public/app/features/alerting/unified/components/rule-editor/QueryRows.tsx @@ -17,6 +17,8 @@ import { QueryOperationRow } from 'app/core/components/QueryOperationRow/QueryOp import { getDatasourceSrv } from 'app/features/plugins/datasource_srv'; import { AlertDataQuery, AlertQuery } from 'app/types/unified-alerting-dto'; +import { getInstantFromDataQuery } from '../../utils/rule-form'; + import { AlertQueryOptions, EmptyQueryWrapper, QueryWrapper } from './QueryWrapper'; import { errorFromCurrentCondition, errorFromPreviewData, getThresholdsForQueries } from './util'; @@ -234,6 +236,7 @@ function copyModel(item: AlertQuery, settings: DataSourceInstanceSettings): Omit } function newModel(item: AlertQuery, settings: DataSourceInstanceSettings): Omit-Contact Point -{contactPoint} } key={uniqueId()} content={ -- {/* use "label" to indicate how many of that type we have in the contact point */} - {Object.entries(groupedIntegrations).map(([type, integrations]) => ( - ++ } > -+ + {contactPoint} (undefined); diff --git a/public/app/features/alerting/unified/components/rule-editor/notificaton-preview/NotificationRouteDetailsModal.tsx b/public/app/features/alerting/unified/components/rule-editor/notificaton-preview/NotificationRouteDetailsModal.tsx index 42e0bc67804..8d3dfdae77a 100644 --- a/public/app/features/alerting/unified/components/rule-editor/notificaton-preview/NotificationRouteDetailsModal.tsx +++ b/public/app/features/alerting/unified/components/rule-editor/notificaton-preview/NotificationRouteDetailsModal.tsx @@ -9,7 +9,7 @@ import { AlertmanagerAction } from '../../../hooks/useAbilities'; import { AlertmanagerProvider } from '../../../state/AlertmanagerContext'; import { getAmMatcherFormatter } from '../../../utils/alertmanager'; import { MatcherFormatter } from '../../../utils/matchers'; -import { makeAMLink } from '../../../utils/misc'; +import { createContactPointSearchLink } from '../../../utils/misc'; import { Authorize } from '../../Authorize'; import { Matchers } from '../../notification-policies/Matchers'; @@ -98,10 +98,7 @@ export function NotificationRouteDetailsModal({ query.model.type === ExpressionQueryType.reduce && query.refId === SIMPLE_CONDITION_REDUCER_ID + (query) => query.model.type === ExpressionQueryType.reduce && query.refId === SimpleConditionIdentifier.reducerId ); const reduceExpression = expressionQueries.at(reduceExpressionIndex); const reduceOk = @@ -112,13 +109,16 @@ export function areQueriesTransformableToSimpleCondition( reduceExpression.model.settings?.mode === undefined); const thresholdExpressionIndex = expressionQueries.findIndex( - (query) => query.model.type === ExpressionQueryType.threshold && query.refId === SIMPLE_CONDITION_THRESHOLD_ID + (query) => + query.model.type === ExpressionQueryType.threshold && query.refId === SimpleConditionIdentifier.thresholdId ); const thresholdExpression = expressionQueries.at(thresholdExpressionIndex); const conditions = thresholdExpression?.model.conditions ?? []; - const thresholdOk = - thresholdExpression && thresholdExpressionIndex === 1 && conditions[0]?.unloadEvaluator === undefined; - return Boolean(reduceOk) && Boolean(thresholdOk); + const thresholdIndexOk = singleReduceExpressionInInstantQuery + ? thresholdExpressionIndex === 0 + : thresholdExpressionIndex === 1; + const thresholdOk = thresholdExpression && thresholdIndexOk && conditions[0]?.unloadEvaluator === undefined; + return (Boolean(reduceOk) || Boolean(singleReduceExpressionInInstantQuery)) && Boolean(thresholdOk); } interface Props { @@ -200,8 +200,8 @@ export const QueryAndExpressionsStep = ({ editingExistingRule, onDataChange }: P } // we need to be sure the condition is set once we switch to simple mode if (!isAdvancedMode) { - setValue('condition', SIMPLE_CONDITION_THRESHOLD_ID); - runQueries(getValues('queries'), SIMPLE_CONDITION_THRESHOLD_ID); + setValue('condition', SimpleConditionIdentifier.thresholdId); + runQueries(getValues('queries'), SimpleConditionIdentifier.thresholdId); } else { runQueries(getValues('queries'), condition || (getValues('condition') ?? '')); } @@ -285,6 +285,12 @@ export const QueryAndExpressionsStep = ({ editingExistingRule, onDataChange }: P setValue('queries', [...updatedQueries, ...expressionQueries], { shouldValidate: false }); updateExpressionAndDatasource(updatedQueries); + // we only remove or add the reducer(optimize reducer) expression when creating a new alert. + // When editing an alert, we assume the user wants to manually adjust expressions and queries for more control and customization. + if (!editingExistingRule) { + dispatch(optimizeReduceExpression({ updatedQueries, expressionQueries })); + } + dispatch(setDataQueries(updatedQueries)); dispatch(updateExpressionTimeRange()); @@ -294,7 +300,7 @@ export const QueryAndExpressionsStep = ({ editingExistingRule, onDataChange }: P dispatch(rewireExpressions({ oldRefId, newRefId })); } }, - [queries, updateExpressionAndDatasource, getValues, setValue] + [queries, updateExpressionAndDatasource, getValues, setValue, editingExistingRule] ); const onChangeRecordingRulesQueries = useCallback( diff --git a/public/app/features/alerting/unified/components/rule-editor/query-and-alert-condition/SimpleCondition.tsx b/public/app/features/alerting/unified/components/rule-editor/query-and-alert-condition/SimpleCondition.tsx index 8d092e149f6..acd8402694d 100644 --- a/public/app/features/alerting/unified/components/rule-editor/query-and-alert-condition/SimpleCondition.tsx +++ b/public/app/features/alerting/unified/components/rule-editor/query-and-alert-condition/SimpleCondition.tsx @@ -17,12 +17,13 @@ import { ExpressionResult } from '../../expressions/Expression'; import { updateExpression } from './reducer'; -export const SIMPLE_CONDITION_QUERY_ID = 'A'; -export const SIMPLE_CONDITION_REDUCER_ID = 'B'; -export const SIMPLE_CONDITION_THRESHOLD_ID = 'C'; - +export const SimpleConditionIdentifier = { + queryId: 'A', + reducerId: 'B', + thresholdId: 'C', +} as const; export interface SimpleCondition { - whenField: string; + whenField?: string; evaluator: { params: number[]; type: EvalFunction; @@ -106,15 +107,17 @@ export const SimpleConditionEditor = ({ - - -+ {simpleCondition.whenField && ( + + + )} +{isRange ? ( @@ -156,7 +159,8 @@ function updateReduceExpression( dispatch: Dispatch ) { const reduceExpression = expressionQueriesList.find( - (query) => query.model.type === ExpressionQueryType.reduce && query.model.refId === SIMPLE_CONDITION_REDUCER_ID + (query) => + query.model.type === ExpressionQueryType.reduce && query.model.refId === SimpleConditionIdentifier.reducerId ); const newReduceExpression = reduceExpression @@ -176,7 +180,8 @@ function updateThresholdFunction( dispatch: Dispatch ) { const thresholdExpression = expressionQueriesList.find( - (query) => query.model.type === ExpressionQueryType.threshold && query.model.refId === SIMPLE_CONDITION_THRESHOLD_ID + (query) => + query.model.type === ExpressionQueryType.threshold && query.model.refId === SimpleConditionIdentifier.thresholdId ); const newThresholdExpression = produce(thresholdExpression, (draft) => { @@ -194,7 +199,8 @@ function updateThresholdValue( dispatch: Dispatch ) { const thresholdExpression = expressionQueriesList.find( - (query) => query.model.type === ExpressionQueryType.threshold && query.model.refId === SIMPLE_CONDITION_THRESHOLD_ID + (query) => + query.model.type === ExpressionQueryType.threshold && query.model.refId === SimpleConditionIdentifier.thresholdId ); const newThresholdExpression = produce(thresholdExpression, (draft) => { @@ -207,13 +213,14 @@ function updateThresholdValue( export function getSimpleConditionFromExpressions(expressions: Array = { + refId: SimpleConditionIdentifier.reducerId, + queryType: 'expression', + datasourceUid: '__expr__', + model: { + type: ExpressionQueryType.reduce, + refId: SimpleConditionIdentifier.reducerId, + settings: { mode: ReducerMode.Strict }, + }, +}; +const thresholdExpression: AlertQuery = { + refId: SimpleConditionIdentifier.thresholdId, + queryType: 'expression', + datasourceUid: '__expr__', + model: { + type: ExpressionQueryType.threshold, + refId: SimpleConditionIdentifier.thresholdId, + }, +}; + jest.mock('@grafana/runtime', () => ({ ...jest.requireActual('@grafana/runtime'), getDataSourceSrv: getDataSourceSrv, @@ -358,4 +385,70 @@ describe('Query and expressions reducer', () => { expect(newState).toMatchSnapshot(); }); + it('should remove first reducer', () => { + const initialState: QueriesAndExpressionsState = { + queries: [alertQuery, reduceExpression, thresholdExpression], + }; + + const newState = queriesAndExpressionsReducer( + initialState, + optimizeReduceExpression({ + updatedQueries: [alertQuery], + expressionQueries: [reduceExpression, thresholdExpression], + }) + ); + expect(newState).toMatchSnapshot(); + }); + + it('should not remove first reducer if reducer is not the first expression', () => { + const initialState: QueriesAndExpressionsState = { + queries: [alertQuery, thresholdExpression, reduceExpression], + }; + + const newState = queriesAndExpressionsReducer( + initialState, + optimizeReduceExpression({ + updatedQueries: [alertQuery], + expressionQueries: [thresholdExpression, reduceExpression], + }) + ); + expect(newState).toEqual(initialState); + }); + + it('should not remove first reducer if reducer is not the second query', () => { + const initialState: QueriesAndExpressionsState = { + queries: [alertQuery, alertQuery, reduceExpression, thresholdExpression], + }; + + const newState = queriesAndExpressionsReducer( + initialState, + optimizeReduceExpression({ + updatedQueries: [alertQuery, alertQuery], + expressionQueries: [reduceExpression, thresholdExpression], + }) + ); + expect(newState).toEqual(initialState); + }); + + it('should add reduce expression if there is no reduce expression and the query is not instant', () => { + const alertQuery: AlertQuery = { + refId: 'A', + queryType: 'query', + datasourceUid: 'abc123', + model: { + refId: 'A', + instant: false, + }, + }; + + const initialState: QueriesAndExpressionsState = { + queries: [alertQuery, thresholdExpression], + }; + + const newState = queriesAndExpressionsReducer( + initialState, + optimizeReduceExpression({ updatedQueries: [alertQuery], expressionQueries: [thresholdExpression] }) + ); + expect(newState).toMatchSnapshot(); + }); }); diff --git a/public/app/features/alerting/unified/components/rule-editor/query-and-alert-condition/reducer.ts b/public/app/features/alerting/unified/components/rule-editor/query-and-alert-condition/reducer.ts index e1e7f66092b..00142d111f8 100644 --- a/public/app/features/alerting/unified/components/rule-editor/query-and-alert-condition/reducer.ts +++ b/public/app/features/alerting/unified/components/rule-editor/query-and-alert-condition/reducer.ts @@ -6,8 +6,10 @@ import { getDefaultRelativeTimeRange, getNextRefId, rangeUtil, + ReducerID, RelativeTimeRange, } from '@grafana/data'; +import { getDataSourceSrv } from '@grafana/runtime'; import { dataSource as expressionDatasource } from 'app/features/expressions/ExpressionDatasource'; import { isExpressionQuery } from 'app/features/expressions/guards'; import { ExpressionDatasourceUID, ExpressionQuery, ExpressionQueryType } from 'app/features/expressions/types'; @@ -15,11 +17,13 @@ import { defaultCondition } from 'app/features/expressions/utils/expressionTypes import { AlertQuery } from 'app/types/unified-alerting-dto'; import { logError } from '../../../Analytics'; -import { getDefaultOrFirstCompatibleDataSource } from '../../../utils/datasource'; -import { getDefaultQueries } from '../../../utils/rule-form'; +import { DataSourceType, getDefaultOrFirstCompatibleDataSource } from '../../../utils/datasource'; +import { getDefaultQueries, getInstantFromDataQuery } from '../../../utils/rule-form'; import { createDagFromQueries, getOriginOfRefId } from '../dag'; import { queriesWithUpdatedReferences, refIdExists } from '../util'; +import { SimpleConditionIdentifier } from './SimpleCondition'; + export interface QueriesAndExpressionsState { queries: AlertQuery[]; } @@ -60,7 +64,9 @@ export const updateMaxDataPoints = createAction<{ refId: string; maxDataPoints: export const updateMinInterval = createAction<{ refId: string; minInterval: string }>('updateMinInterval'); export const resetToSimpleCondition = createAction('resetToSimpleCondition'); - +export const optimizeReduceExpression = createAction<{ updatedQueries: AlertQuery[]; expressionQueries: AlertQuery[] }>( + 'optimizeReduceExpression' +); export const setRecordingRulesQueries = createAction<{ recordingRuleQueries: AlertQuery[]; expression: string }>( 'setRecordingRulesQueries' ); @@ -225,6 +231,71 @@ export const queriesAndExpressionsReducer = createReducer(initialState, (builder .addCase(rewireExpressions, (state, { payload }) => { state.queries = queriesWithUpdatedReferences(state.queries, payload.oldRefId, payload.newRefId); }) + .addCase(optimizeReduceExpression, (state, { payload }) => { + const { updatedQueries, expressionQueries } = payload; + + if (updatedQueries.length !== 1) { + // we only optimize when we have one data query + return; + } + + //sometimes we dont have data source in the model yet + const getDataSourceSettingsForFirstQuery = getDataSourceSrv().getInstanceSettings( + updatedQueries[0].datasourceUid + ); + + if (!getDataSourceSettingsForFirstQuery) { + return; + } + const type = getDataSourceSettingsForFirstQuery?.type; + + const firstQueryIsPromOrLoki = type === DataSourceType.Prometheus || type === DataSourceType.Loki; + + const isInstant = getInstantFromDataQuery(updatedQueries[0].model, type); + + const shouldRemoveReducer = + firstQueryIsPromOrLoki && updatedQueries.length === 1 && isInstant && expressionQueries.length === 2; + + const onlyOneExpressionNotReducer = + expressionQueries.length === 1 && + 'type' in expressionQueries[0].model && + expressionQueries[0].model.type !== ExpressionQueryType.reduce; + + // we only add the reduce expression if we have one data query and one expression query. For other cases we don't do anything, + // and let the user add the reducer manually. + const shouldAddReduceExpression = + firstQueryIsPromOrLoki && updatedQueries.length === 1 && !isInstant && onlyOneExpressionNotReducer; + + if (shouldRemoveReducer) { + const reduceExpressionIndex = state.queries.findIndex( + (query) => isExpressionQuery(query.model) && query.model.type === ExpressionQueryType.reduce + ); + + if (reduceExpressionIndex === 1) { + // means the reduce expression is the second query + state.queries.splice(reduceExpressionIndex, 1); + state.queries[1].model.expression = SimpleConditionIdentifier.queryId; + } + } + if (shouldAddReduceExpression) { + // add reducer to the second position + // we only update the refid and the model to point to the reducer expression + state.queries[1].model.expression = SimpleConditionIdentifier.reducerId; + // insert in second position the reducer expression + state.queries.splice(1, 0, { + datasourceUid: ExpressionDatasourceUID, + model: expressionDatasource.newQuery({ + type: ExpressionQueryType.reduce, + reducer: ReducerID.last, + conditions: [{ ...defaultCondition, query: { params: [] } }], + expression: SimpleConditionIdentifier.queryId, + refId: SimpleConditionIdentifier.reducerId, + }), + refId: SimpleConditionIdentifier.reducerId, + queryType: 'expression', + }); + } + }) .addCase(updateExpressionType, (state, action) => { state.queries = state.queries.map((query) => { return query.refId === action.payload.refId diff --git a/public/app/features/alerting/unified/components/rule-viewer/RuleViewer.tsx b/public/app/features/alerting/unified/components/rule-viewer/RuleViewer.tsx index f317be6043a..1ef1f681913 100644 --- a/public/app/features/alerting/unified/components/rule-viewer/RuleViewer.tsx +++ b/public/app/features/alerting/unified/components/rule-viewer/RuleViewer.tsx @@ -15,6 +15,7 @@ import { PromAlertingRuleState, PromRuleType } from 'app/types/unified-alerting- import { defaultPageNav } from '../../RuleViewer'; import { shouldUsePrometheusRulesPrimary } from '../../featureToggles'; import { usePrometheusCreationConsistencyCheck } from '../../hooks/usePrometheusConsistencyCheck'; +import { useReturnTo } from '../../hooks/useReturnTo'; import { PluginOriginBadge } from '../../plugins/PluginOriginBadge'; import { Annotation } from '../../utils/constants'; import { makeDashboardLink, makePanelLink, stringifyErrorLike } from '../../utils/misc'; @@ -242,9 +243,9 @@ interface TitleProps { } export const Title = ({ name, paused = false, state, health, ruleType, ruleOrigin }: TitleProps) => { - const [queryParams] = useQueryParams(); const isRecordingRule = ruleType === PromRuleType.Recording; - const returnTo = queryParams.returnTo ? String(queryParams.returnTo) : '/alerting/list'; + + const { returnTo } = useReturnTo('/alerting/list'); return ( diff --git a/public/app/features/alerting/unified/hooks/useAbilities.ts b/public/app/features/alerting/unified/hooks/useAbilities.ts index c60acd5e7f2..b2df0f55f52 100644 --- a/public/app/features/alerting/unified/hooks/useAbilities.ts +++ b/public/app/features/alerting/unified/hooks/useAbilities.ts @@ -1,6 +1,11 @@ import { useMemo } from 'react'; import { contextSrv as ctx } from 'app/core/services/context_srv'; +import { PERMISSIONS_CONTACT_POINTS_READ } from 'app/features/alerting/unified/components/contact-points/permissions'; +import { + PERMISSIONS_TIME_INTERVALS_MODIFY, + PERMISSIONS_TIME_INTERVALS_READ, +} from 'app/features/alerting/unified/components/mute-timings/permissions'; import { useFolder } from 'app/features/alerting/unified/hooks/useFolder'; import { AlertmanagerChoice } from 'app/plugins/datasource/alertmanager/types'; import { AccessControlAction } from 'app/types'; @@ -229,22 +234,22 @@ export function useAllAlertmanagerAbilities(): Abilities { hasConfigurationAPI, notificationsPermissions.create, // TODO: Move this into the permissions config and generalise that code to allow for an array of permissions - isGrafanaFlavoredAlertmanager ? AccessControlAction.AlertingReceiversCreate : null + ...(isGrafanaFlavoredAlertmanager ? [AccessControlAction.AlertingReceiversCreate] : []) ), [AlertmanagerAction.ViewContactPoint]: toAbility( AlwaysSupported, notificationsPermissions.read, - isGrafanaFlavoredAlertmanager ? AccessControlAction.AlertingReceiversRead : null + ...(isGrafanaFlavoredAlertmanager ? PERMISSIONS_CONTACT_POINTS_READ : []) ), [AlertmanagerAction.UpdateContactPoint]: toAbility( hasConfigurationAPI, notificationsPermissions.update, - isGrafanaFlavoredAlertmanager ? AccessControlAction.AlertingReceiversWrite : null + ...(isGrafanaFlavoredAlertmanager ? [AccessControlAction.AlertingReceiversWrite] : []) ), [AlertmanagerAction.DeleteContactPoint]: toAbility( hasConfigurationAPI, notificationsPermissions.delete, - isGrafanaFlavoredAlertmanager ? AccessControlAction.AlertingReceiversWrite : null + ...(isGrafanaFlavoredAlertmanager ? [AccessControlAction.AlertingReceiversWrite] : []) ), // At the time of writing, only Grafana flavored alertmanager supports exporting, // and if a user can view the contact point, then they can also export it @@ -254,17 +259,17 @@ export function useAllAlertmanagerAbilities(): Abilities { [AlertmanagerAction.CreateNotificationTemplate]: toAbility( hasConfigurationAPI, notificationsPermissions.create, - isGrafanaFlavoredAlertmanager ? AccessControlAction.AlertingTemplatesWrite : null + ...(isGrafanaFlavoredAlertmanager ? [AccessControlAction.AlertingTemplatesWrite] : []) ), [AlertmanagerAction.ViewNotificationTemplate]: toAbility( AlwaysSupported, notificationsPermissions.read, - isGrafanaFlavoredAlertmanager ? AccessControlAction.AlertingTemplatesRead : null + ...(isGrafanaFlavoredAlertmanager ? [AccessControlAction.AlertingTemplatesRead] : []) ), [AlertmanagerAction.UpdateNotificationTemplate]: toAbility( hasConfigurationAPI, notificationsPermissions.update, - isGrafanaFlavoredAlertmanager ? AccessControlAction.AlertingTemplatesWrite : null + ...(isGrafanaFlavoredAlertmanager ? [AccessControlAction.AlertingTemplatesWrite] : []) ), [AlertmanagerAction.DeleteNotificationTemplate]: toAbility(hasConfigurationAPI, notificationsPermissions.delete), // -- notification policies -- @@ -287,11 +292,27 @@ export function useAllAlertmanagerAbilities(): Abilities { [AlertmanagerAction.ViewSilence]: toAbility(AlwaysSupported, instancePermissions.read), [AlertmanagerAction.UpdateSilence]: toAbility(AlwaysSupported, instancePermissions.update), [AlertmanagerAction.PreviewSilencedInstances]: toAbility(AlwaysSupported, instancePermissions.read), - // -- mute timtings -- - [AlertmanagerAction.CreateMuteTiming]: toAbility(hasConfigurationAPI, notificationsPermissions.create), - [AlertmanagerAction.ViewMuteTiming]: toAbility(AlwaysSupported, notificationsPermissions.read), - [AlertmanagerAction.UpdateMuteTiming]: toAbility(hasConfigurationAPI, notificationsPermissions.update), - [AlertmanagerAction.DeleteMuteTiming]: toAbility(hasConfigurationAPI, notificationsPermissions.delete), + // -- mute timings -- + [AlertmanagerAction.CreateMuteTiming]: toAbility( + hasConfigurationAPI, + notificationsPermissions.create, + ...(isGrafanaFlavoredAlertmanager ? PERMISSIONS_TIME_INTERVALS_MODIFY : []) + ), + [AlertmanagerAction.ViewMuteTiming]: toAbility( + AlwaysSupported, + notificationsPermissions.read, + ...(isGrafanaFlavoredAlertmanager ? PERMISSIONS_TIME_INTERVALS_READ : []) + ), + [AlertmanagerAction.UpdateMuteTiming]: toAbility( + hasConfigurationAPI, + notificationsPermissions.update, + ...(isGrafanaFlavoredAlertmanager ? PERMISSIONS_TIME_INTERVALS_MODIFY : []) + ), + [AlertmanagerAction.DeleteMuteTiming]: toAbility( + hasConfigurationAPI, + notificationsPermissions.delete, + ...(isGrafanaFlavoredAlertmanager ? PERMISSIONS_TIME_INTERVALS_MODIFY : []) + ), [AlertmanagerAction.ExportMuteTimings]: toAbility(isGrafanaFlavoredAlertmanager, notificationsPermissions.read), }; @@ -355,7 +376,8 @@ function useCanSilence(rule: CombinedRule): [boolean, boolean] { } // just a convenient function -const toAbility = (supported: boolean, ...actions: Array ): Ability => [ - supported, - actions.some((action) => action && ctx.hasPermission(action)), -]; +const toAbility = ( + supported: boolean, + /** If user has any of these permissions, then they are allowed to perform the action */ + ...actions: AccessControlAction[] +): Ability => [supported, actions.some((action) => action && ctx.hasPermission(action))]; diff --git a/public/app/features/alerting/unified/hooks/useReturnTo.test.tsx b/public/app/features/alerting/unified/hooks/useReturnTo.test.tsx new file mode 100644 index 00000000000..80adb1661cc --- /dev/null +++ b/public/app/features/alerting/unified/hooks/useReturnTo.test.tsx @@ -0,0 +1,48 @@ +import { MemoryRouter } from 'react-router-dom-v5-compat'; +import { renderHook } from 'test/test-utils'; + +import { useReturnTo } from './useReturnTo'; + +describe('useReturnTo', () => { + beforeAll(() => { + // @ts-expect-error + delete window.location; + window.location = { origin: 'https://play.grafana.net' } as Location; + }); + + it('should return the fallback value when `returnTo` is not present in the query string', () => { + const { result } = renderHook(() => useReturnTo('/fallback'), { wrapper: MemoryRouter }); + + expect(result.current.returnTo).toBe('/fallback'); + }); + + it('should return the sanitized `returnTo` value when it is present in the query string and is a valid URL within the Grafana app', () => { + const { result } = renderHook(() => useReturnTo('/fallback'), { + wrapper: ({ children }) => ( + {children} + ), + }); + + expect(result.current.returnTo).toBe('/dashboard/db/my-dashboard'); + }); + + it('should return the fallback value when `returnTo` is present in the query string but is not a valid URL within the Grafana app', () => { + const { result } = renderHook(() => useReturnTo('/fallback'), { + wrapper: ({ children }) => ( +{children} + ), + }); + + expect(result.current.returnTo).toBe('/fallback'); + }); + + it('should return the fallback value when `returnTo` is present in the query string but is a malicious JavaScript URL', () => { + const { result } = renderHook(() => useReturnTo('/fallback'), { + wrapper: ({ children }) => ( +{children} + ), + }); + + expect(result.current.returnTo).toBe('/fallback'); + }); +}); diff --git a/public/app/features/alerting/unified/hooks/useReturnTo.ts b/public/app/features/alerting/unified/hooks/useReturnTo.ts new file mode 100644 index 00000000000..b522bf2c8f6 --- /dev/null +++ b/public/app/features/alerting/unified/hooks/useReturnTo.ts @@ -0,0 +1,49 @@ +import { textUtil } from '@grafana/data'; +import { config } from '@grafana/runtime'; + +import { logWarning } from '../Analytics'; + +import { useURLSearchParams } from './useURLSearchParams'; + +/** + * This hook provides a safe way to obtain the `returnTo` URL from the query string parameter + * It validates the origin and protocol to ensure the URL is withing the Grafana app + */ +export function useReturnTo(fallback?: string): { returnTo: string | undefined } { + const emptyResult = { returnTo: fallback }; + + const [searchParams] = useURLSearchParams(); + const returnTo = searchParams.get('returnTo'); + + if (!returnTo) { + return emptyResult; + } + + const sanitizedReturnTo = textUtil.sanitizeUrl(returnTo); + const baseUrl = `${window.location.origin}/${config.appSubUrl}`; + + const sanitizedUrl = tryParseURL(sanitizedReturnTo, baseUrl); + + if (!sanitizedUrl) { + logWarning('Malformed returnTo parameter', { returnTo }); + return emptyResult; + } + + const { protocol, origin, pathname, search } = sanitizedUrl; + if (['http:', 'https:'].includes(protocol) === false || origin !== window.location.origin) { + logWarning('Malformed returnTo parameter', { returnTo }); + return emptyResult; + } + + return { returnTo: `${pathname}${search}` }; +} + +// Tries to mimic URL.parse method https://developer.mozilla.org/en-US/docs/Web/API/URL/parse_static +function tryParseURL(sanitizedReturnTo: string, baseUrl: string) { + try { + const url = new URL(sanitizedReturnTo, baseUrl); + return url; + } catch (error) { + return null; + } +} diff --git a/public/app/features/alerting/unified/mocks.ts b/public/app/features/alerting/unified/mocks.ts index 0564b60507a..806e13b9a01 100644 --- a/public/app/features/alerting/unified/mocks.ts +++ b/public/app/features/alerting/unified/mocks.ts @@ -64,11 +64,7 @@ import { import { DashboardSearchItem, DashboardSearchItemType } from '../../search/types'; -import { - SIMPLE_CONDITION_QUERY_ID, - SIMPLE_CONDITION_REDUCER_ID, - SIMPLE_CONDITION_THRESHOLD_ID, -} from './components/rule-editor/query-and-alert-condition/SimpleCondition'; +import { SimpleConditionIdentifier } from './components/rule-editor/query-and-alert-condition/SimpleCondition'; import { parsePromQLStyleMatcherLooseSafe } from './utils/matchers'; let nextDataSourceId = 1; @@ -855,29 +851,29 @@ export function mockDashboardDto( } export const dataQuery: AlertQuery= { - refId: SIMPLE_CONDITION_QUERY_ID, + refId: SimpleConditionIdentifier.queryId, datasourceUid: 'abc123', queryType: '', - model: { refId: SIMPLE_CONDITION_QUERY_ID }, + model: { refId: SimpleConditionIdentifier.queryId }, }; export const reduceExpression: AlertQuery = { - refId: SIMPLE_CONDITION_REDUCER_ID, + refId: SimpleConditionIdentifier.reducerId, queryType: 'expression', datasourceUid: '__expr__', model: { type: ExpressionQueryType.reduce, - refId: SIMPLE_CONDITION_REDUCER_ID, + refId: SimpleConditionIdentifier.reducerId, settings: { mode: ReducerMode.Strict }, reducer: ReducerID.last, }, }; export const thresholdExpression: AlertQuery = { - refId: SIMPLE_CONDITION_THRESHOLD_ID, + refId: SimpleConditionIdentifier.thresholdId, queryType: 'expression', datasourceUid: '__expr__', model: { type: ExpressionQueryType.threshold, - refId: SIMPLE_CONDITION_THRESHOLD_ID, + refId: SimpleConditionIdentifier.thresholdId, }, }; diff --git a/public/app/features/alerting/unified/rule-list/components/AlertRuleListItem.tsx b/public/app/features/alerting/unified/rule-list/components/AlertRuleListItem.tsx index 3e89460e872..741a62fbe35 100644 --- a/public/app/features/alerting/unified/rule-list/components/AlertRuleListItem.tsx +++ b/public/app/features/alerting/unified/rule-list/components/AlertRuleListItem.tsx @@ -15,7 +15,7 @@ import { ProvisioningBadge } from '../../components/Provisioning'; import { PluginOriginBadge } from '../../plugins/PluginOriginBadge'; import { GRAFANA_RULES_SOURCE_NAME } from '../../utils/datasource'; import { labelsSize } from '../../utils/labels'; -import { createContactPointLink } from '../../utils/misc'; +import { createContactPointSearchLink } from '../../utils/misc'; import { RulePluginOrigin } from '../../utils/rules'; import { ListItem } from './ListItem'; @@ -106,7 +106,7 @@ export const AlertRuleListItem = (props: AlertRuleListItemProps) => { Delivered to {' '}{ const dataSource = getDefaultOrFirstCompatibleDataSource(); - if (!dataSource) { const expressions = isRecordingRule ? getDefaultExpressionsForRecording('A') : getDefaultExpressions('A', 'B'); return [...expressions]; @@ -507,6 +511,7 @@ export const getDefaultQueries = (isRecordingRule = false): AlertQuery[] => { const relativeTimeRange = getDefaultRelativeTimeRange(); const expressions = isRecordingRule ? getDefaultExpressionsForRecording('B') : getDefaultExpressions('B', 'C'); + const isLokiOrPrometheus = dataSource?.type === DataSourceType.Prometheus || dataSource?.type === DataSourceType.Loki; return [ { refId: 'A', @@ -515,6 +520,7 @@ export const getDefaultQueries = (isRecordingRule = false): AlertQuery[] => { relativeTimeRange, model: { refId: 'A', + instant: isLokiOrPrometheus ? true : undefined, }, }, ...expressions, @@ -899,3 +905,24 @@ export const ignoreHiddenQueries = (ruleDefinition: RuleFormValues): RuleFormVal export function formValuesFromExistingRule(rule: RuleWithLocation ) { return ignoreHiddenQueries(rulerRuleToFormValues(rule)); } + +export function getInstantFromDataQuery(model: AlertDataQuery, type: string): boolean | undefined { + // if the datasource is not prometheus or loki, instant is defined in the model or defaults to undefined + if (type !== DataSourceType.Prometheus && type !== DataSourceType.Loki) { + if ('instant' in model) { + return model.instant; + } else { + if ('queryType' in model) { + return model.queryType === 'instant'; + } else { + return undefined; + } + } + } + // if the datasource is prometheus or loki, instant is defined in the model, or defaults to true + const isInstantForPrometheus = 'instant' in model && model.instant !== undefined ? model.instant : true; + const isInstantForLoki = 'queryType' in model && model.queryType !== undefined ? model.queryType === 'instant' : true; + + const isInstant = type === DataSourceType.Prometheus ? isInstantForPrometheus : isInstantForLoki; + return isInstant; +} diff --git a/public/app/core/components/Bookmarks/BookmarksPage.tsx b/public/app/features/bookmarks/BookmarksPage.tsx similarity index 87% rename from public/app/core/components/Bookmarks/BookmarksPage.tsx rename to public/app/features/bookmarks/BookmarksPage.tsx index d7e48ac68bb..810baa17ed9 100644 --- a/public/app/core/components/Bookmarks/BookmarksPage.tsx +++ b/public/app/features/bookmarks/BookmarksPage.tsx @@ -2,14 +2,13 @@ import { css } from '@emotion/css'; import { GrafanaTheme2, NavModelItem } from '@grafana/data'; import { EmptyState, useStyles2 } from '@grafana/ui'; +import { usePinnedItems } from 'app/core/components/AppChrome/MegaMenu/hooks'; +import { findByUrl } from 'app/core/components/AppChrome/MegaMenu/utils'; +import { NavLandingPageCard } from 'app/core/components/NavLandingPage/NavLandingPageCard'; import { Page } from 'app/core/components/Page/Page'; import { t, Trans } from 'app/core/internationalization'; import { useSelector } from 'app/types'; -import { usePinnedItems } from '../AppChrome/MegaMenu/hooks'; -import { findByUrl } from '../AppChrome/MegaMenu/utils'; -import { NavLandingPageCard } from '../NavLandingPage/NavLandingPageCard'; - export function BookmarksPage() { const styles = useStyles2(getStyles); const pinnedItems = usePinnedItems(); @@ -63,3 +62,5 @@ const getStyles = (theme: GrafanaTheme2) => ({ padding: theme.spacing(2, 0), }), }); + +export default BookmarksPage; diff --git a/public/app/features/dashboard-scene/panel-edit/PanelDataPane/PanelDataPane.tsx b/public/app/features/dashboard-scene/panel-edit/PanelDataPane/PanelDataPane.tsx index c137b83f5b5..7a15b4fbab7 100644 --- a/public/app/features/dashboard-scene/panel-edit/PanelDataPane/PanelDataPane.tsx +++ b/public/app/features/dashboard-scene/panel-edit/PanelDataPane/PanelDataPane.tsx @@ -11,8 +11,7 @@ import { SceneObjectUrlValues, VizPanel, } from '@grafana/scenes'; -import { Container, TabContent, TabsBar, useStyles2 } from '@grafana/ui'; -import { ScrollContainer } from '@grafana/ui/src/unstable'; +import { Container, ScrollContainer, TabContent, TabsBar, useStyles2 } from '@grafana/ui'; import { getConfig } from 'app/core/config'; import { contextSrv } from 'app/core/core'; import { getRulesPermissions } from 'app/features/alerting/unified/utils/access-control'; diff --git a/public/app/features/dashboard-scene/panel-edit/PanelEditor.tsx b/public/app/features/dashboard-scene/panel-edit/PanelEditor.tsx index aefd435b48e..b0073be67ed 100644 --- a/public/app/features/dashboard-scene/panel-edit/PanelEditor.tsx +++ b/public/app/features/dashboard-scene/panel-edit/PanelEditor.tsx @@ -266,7 +266,7 @@ export class PanelEditor extends SceneObjectBase { this.setState({ isDirty: false }); // Remember that we have done changes - this._changesHaveBeenMade = false; + this._changesHaveBeenMade = true; } public onSaveLibraryPanel = () => { diff --git a/public/app/features/dashboard-scene/panel-edit/PanelOptionsPane.tsx b/public/app/features/dashboard-scene/panel-edit/PanelOptionsPane.tsx index 128e0049791..d5f37b83297 100644 --- a/public/app/features/dashboard-scene/panel-edit/PanelOptionsPane.tsx +++ b/public/app/features/dashboard-scene/panel-edit/PanelOptionsPane.tsx @@ -22,8 +22,16 @@ import { VizPanel, sceneGraph, } from '@grafana/scenes'; -import { Button, Card, FilterInput, RadioButtonGroup, Stack, ToolbarButton, useStyles2 } from '@grafana/ui'; -import { ScrollContainer } from '@grafana/ui/src/unstable'; +import { + Button, + Card, + FilterInput, + RadioButtonGroup, + ScrollContainer, + Stack, + ToolbarButton, + useStyles2, +} from '@grafana/ui'; import { Trans } from 'app/core/internationalization'; import { OptionFilter } from 'app/features/dashboard/components/PanelEditor/OptionsPaneOptions'; import { getPanelPluginNotFound } from 'app/features/panel/components/PanelPluginError'; diff --git a/public/app/features/dashboard-scene/panel-edit/PanelVizTypePicker.tsx b/public/app/features/dashboard-scene/panel-edit/PanelVizTypePicker.tsx index 32d5614fb83..1361b268ee6 100644 --- a/public/app/features/dashboard-scene/panel-edit/PanelVizTypePicker.tsx +++ b/public/app/features/dashboard-scene/panel-edit/PanelVizTypePicker.tsx @@ -7,8 +7,7 @@ import { GrafanaTheme2, PanelData, SelectableValue } from '@grafana/data'; import { selectors } from '@grafana/e2e-selectors'; import { reportInteraction } from '@grafana/runtime'; import { VizPanel } from '@grafana/scenes'; -import { Button, Field, FilterInput, RadioButtonGroup, useStyles2 } from '@grafana/ui'; -import { ScrollContainer } from '@grafana/ui/src/unstable'; +import { Button, Field, FilterInput, RadioButtonGroup, ScrollContainer, useStyles2 } from '@grafana/ui'; import { LS_VISUALIZATION_SELECT_TAB_KEY } from 'app/core/constants'; import { VisualizationSelectPaneTab } from 'app/features/dashboard/components/PanelEditor/types'; import { VisualizationSuggestions } from 'app/features/panel/components/VizTypePicker/VisualizationSuggestions'; diff --git a/public/app/features/dashboard/components/PanelEditor/OptionsPaneOptions.tsx b/public/app/features/dashboard/components/PanelEditor/OptionsPaneOptions.tsx index 0ad106559d9..20ef00f4069 100644 --- a/public/app/features/dashboard/components/PanelEditor/OptionsPaneOptions.tsx +++ b/public/app/features/dashboard/components/PanelEditor/OptionsPaneOptions.tsx @@ -4,8 +4,7 @@ import * as React from 'react'; import { GrafanaTheme2, SelectableValue } from '@grafana/data'; import { config } from '@grafana/runtime'; -import { FilterInput, RadioButtonGroup, useStyles2 } from '@grafana/ui'; -import { ScrollContainer } from '@grafana/ui/src/unstable'; +import { FilterInput, RadioButtonGroup, ScrollContainer, useStyles2 } from '@grafana/ui'; import { AngularDeprecationPluginNotice } from 'app/features/plugins/angularDeprecation/AngularDeprecationPluginNotice'; import { isPanelModelLibraryPanel } from '../../../library-panels/guard'; diff --git a/public/app/features/dashboard/components/PanelEditor/VisualizationSelectPane.tsx b/public/app/features/dashboard/components/PanelEditor/VisualizationSelectPane.tsx index 4b516a253bc..7d96f861177 100644 --- a/public/app/features/dashboard/components/PanelEditor/VisualizationSelectPane.tsx +++ b/public/app/features/dashboard/components/PanelEditor/VisualizationSelectPane.tsx @@ -4,9 +4,8 @@ import { useLocalStorage } from 'react-use'; import { GrafanaTheme2, PanelData, SelectableValue } from '@grafana/data'; import { selectors } from '@grafana/e2e-selectors'; -import { Button, FilterInput, RadioButtonGroup, useStyles2 } from '@grafana/ui'; +import { Button, FilterInput, RadioButtonGroup, ScrollContainer, useStyles2 } from '@grafana/ui'; import { Field } from '@grafana/ui/src/components/Forms/Field'; -import { ScrollContainer } from '@grafana/ui/src/unstable'; import { LS_VISUALIZATION_SELECT_TAB_KEY } from 'app/core/constants'; import { PanelLibraryOptionsGroup } from 'app/features/library-panels/components/PanelLibraryOptionsGroup/PanelLibraryOptionsGroup'; import { VisualizationSuggestions } from 'app/features/panel/components/VizTypePicker/VisualizationSuggestions'; diff --git a/public/app/features/dashboard/components/ShareModal/ThemePicker.tsx b/public/app/features/dashboard/components/ShareModal/ThemePicker.tsx index e38af724303..14a7bb2991b 100644 --- a/public/app/features/dashboard/components/ShareModal/ThemePicker.tsx +++ b/public/app/features/dashboard/components/ShareModal/ThemePicker.tsx @@ -5,9 +5,10 @@ import { t } from 'app/core/internationalization'; interface Props { selectedTheme: string; onChange: (value: string) => void; + description?: string; } -export const ThemePicker = ({ selectedTheme = 'current', onChange }: Props) => { +export const ThemePicker = ({ selectedTheme = 'current', onChange, description }: Props) => { const themeOptions: Array + ; + return ; } diff --git a/public/app/plugins/datasource/grafana-postgresql-datasource/tsconfig.json b/public/app/plugins/datasource/grafana-postgresql-datasource/tsconfig.json index 1690bc6f49f..baaaea04185 100644 --- a/public/app/plugins/datasource/grafana-postgresql-datasource/tsconfig.json +++ b/public/app/plugins/datasource/grafana-postgresql-datasource/tsconfig.json @@ -1,5 +1,7 @@ { - "jsx": "react-jsx", + "compilerOptions": { + "jsx": "react-jsx" + }, "extends": "@grafana/plugin-configs/tsconfig.json", "include": ["."] } diff --git a/public/app/plugins/datasource/influxdb/components/editor/query/fsql/FSQLEditor.tsx b/public/app/plugins/datasource/influxdb/components/editor/query/fsql/FSQLEditor.tsx index a9d61dccaee..df20529d40d 100644 --- a/public/app/plugins/datasource/influxdb/components/editor/query/fsql/FSQLEditor.tsx +++ b/public/app/plugins/datasource/influxdb/components/editor/query/fsql/FSQLEditor.tsx @@ -2,7 +2,7 @@ import { css, cx } from '@emotion/css'; import { PureComponent } from 'react'; import { GrafanaTheme2 } from '@grafana/data/src'; -import { SQLQuery, SqlQueryEditor, applyQueryDefaults } from '@grafana/sql'; +import { SQLQuery, SqlQueryEditorLazy, applyQueryDefaults } from '@grafana/sql'; import { InlineFormLabel, LinkButton, Themeable2, withTheme2 } from '@grafana/ui/src'; import InfluxDatasource from '../../../../datasource'; @@ -89,7 +89,7 @@ class UnthemedSQLQueryEditor extends PureComponent { return ( <> - (MssqlDatasource) - .setQueryEditor(SqlQueryEditor) + .setQueryEditor(SqlQueryEditorLazy) .setQueryEditorHelp(CheatSheet) .setConfigEditor(ConfigurationEditor); diff --git a/public/app/plugins/datasource/mysql/module.ts b/public/app/plugins/datasource/mysql/module.ts index c2c6616c492..571021f347a 100644 --- a/public/app/plugins/datasource/mysql/module.ts +++ b/public/app/plugins/datasource/mysql/module.ts @@ -1,5 +1,5 @@ import { DataSourcePlugin } from '@grafana/data'; -import { SQLQuery, SqlQueryEditor } from '@grafana/sql'; +import { SQLQuery, SqlQueryEditorLazy } from '@grafana/sql'; import { CheatSheet } from './CheatSheet'; import { MySqlDatasource } from './MySqlDatasource'; @@ -7,6 +7,6 @@ import { ConfigurationEditor } from './configuration/ConfigurationEditor'; import { MySQLOptions } from './types'; export const plugin = new DataSourcePlugin { expect(getScale()).toBe(1); }); + it('can zoom while pressing ctrl/command key with cooperative zoom mode', async () => { + render( + []} + /> + ); + + await screen.findByLabelText('Node: service:1'); + + scrollView({ deltaY: -2, ctrlKey: false }); + expect(getScale()).toBe(1); + + scrollView({ deltaY: -2, ctrlKey: true }); + expect(getScale()).toBe(1.03); + }); + + it('can zoom without pressing ctrl/command key with greedy zoom mode', async () => { + render( + []} + /> + ); + + await screen.findByLabelText('Node: service:1'); + + scrollView({ deltaY: -2, ctrlKey: true }); + expect(getScale()).toBe(1.03); + + scrollView({ deltaY: -2, ctrlKey: true }); + expect(getScale()).toBe(1.06); + }); + it('can pan the graph', async () => { render( LinkModel[]; nodeLimit?: number; panelId?: string; + zoomMode?: ZoomMode; } -export function NodeGraph({ getLinks, dataFrames, nodeLimit, panelId }: Props) { +export function NodeGraph({ getLinks, dataFrames, nodeLimit, panelId, zoomMode }: Props) { const nodeCountLimit = nodeLimit || defaultNodeCountLimit; const { edges: edgesDataFrames, nodes: nodesDataFrames } = useCategorizeFrames(dataFrames); @@ -173,7 +174,8 @@ export function NodeGraph({ getLinks, dataFrames, nodeLimit, panelId }: Props) { const focusPosition = useFocusPositionOnLayout(config, nodes, focusedNodeId); const { panRef, zoomRef, onStepUp, onStepDown, isPanning, position, scale, isMaxZoom, isMinZoom } = usePanAndZoom( bounds, - focusPosition + focusPosition, + zoomMode ); const { onEdgeOpen, onNodeOpen, MenuComponent } = useContextMenu( @@ -392,8 +394,8 @@ const EdgeLabels = memo(function EdgeLabels(props: EdgeLabelsProps) { ); }); -function usePanAndZoom(bounds: Bounds, focus?: { x: number; y: number }) { - const { scale, onStepDown, onStepUp, ref, isMax, isMin } = useZoom(); +function usePanAndZoom(bounds: Bounds, focus?: { x: number; y: number }, zoomMode?: ZoomMode) { + const { scale, onStepDown, onStepUp, ref, isMax, isMin } = useZoom({ zoomMode }); const { state: panningState, ref: panRef } = usePanning ({ scale, bounds, diff --git a/public/app/plugins/panel/nodeGraph/NodeGraphPanel.tsx b/public/app/plugins/panel/nodeGraph/NodeGraphPanel.tsx index 9ee64616c17..72bfa35f4bf 100644 --- a/public/app/plugins/panel/nodeGraph/NodeGraphPanel.tsx +++ b/public/app/plugins/panel/nodeGraph/NodeGraphPanel.tsx @@ -28,6 +28,7 @@ export const NodeGraphPanel = ({ width, height, data, options }: PanelProps (NodeGraphPanel) disableStandardOptions: Object.values(FieldConfigProperty).filter((v) => v !== FieldConfigProperty.Links), }) .setPanelOptions((builder, context) => { + builder.addSelect({ + name: 'Zoom mode', + path: 'zoomMode', + defaultValue: 'cooperative', + settings: { + options: [ + { value: 'cooperative', label: 'Cooperative', description: 'Lets you scroll the page normally' }, + { value: 'greedy', label: 'Greedy', description: 'Reacts to all zoom gestures' }, + ], + }, + }); builder.addNestedOptions({ category: ['Nodes'], path: 'nodes', diff --git a/public/app/plugins/panel/nodeGraph/panelcfg.cue b/public/app/plugins/panel/nodeGraph/panelcfg.cue index d3d5d5bc96d..1f82a965df9 100644 --- a/public/app/plugins/panel/nodeGraph/panelcfg.cue +++ b/public/app/plugins/panel/nodeGraph/panelcfg.cue @@ -43,9 +43,12 @@ composableKinds: PanelCfg: { // Unit for the secondary stat to override what ever is set in the data frame. secondaryStatUnit?: string } + ZoomMode: "cooperative" | "greedy" @cuetsy(kind="enum") Options: { nodes?: NodeOptions edges?: EdgeOptions + // How to handle zoom/scroll events in the node graph + zoomMode?: ZoomMode } @cuetsy(kind="interface") } }] diff --git a/public/app/plugins/panel/nodeGraph/panelcfg.gen.ts b/public/app/plugins/panel/nodeGraph/panelcfg.gen.ts index d09f8d207cb..be922346006 100644 --- a/public/app/plugins/panel/nodeGraph/panelcfg.gen.ts +++ b/public/app/plugins/panel/nodeGraph/panelcfg.gen.ts @@ -19,6 +19,11 @@ export interface ArcOption { field?: string; } +export enum ZoomMode { + Cooperative = 'cooperative', + Greedy = 'greedy', +} + export interface Options { edges?: { /** @@ -44,4 +49,8 @@ export interface Options { */ arcs?: Array ; }; + /** + * How to handle zoom/scroll events in the node graph + */ + zoomMode?: ZoomMode; } diff --git a/public/app/plugins/panel/nodeGraph/types.ts b/public/app/plugins/panel/nodeGraph/types.ts index 59b7e03b367..377c5df5526 100644 --- a/public/app/plugins/panel/nodeGraph/types.ts +++ b/public/app/plugins/panel/nodeGraph/types.ts @@ -2,7 +2,7 @@ import { SimulationNodeDatum, SimulationLinkDatum } from 'd3-force'; import { DataFrame, Field, IconName } from '@grafana/data'; -export type { Options as NodeGraphOptions, ArcOption } from './panelcfg.gen'; +export type { Options as NodeGraphOptions, ArcOption, ZoomMode } from './panelcfg.gen'; export type NodeDatum = SimulationNodeDatum & { id: string; diff --git a/public/app/plugins/panel/nodeGraph/useZoom.ts b/public/app/plugins/panel/nodeGraph/useZoom.ts index 34cc4954b90..dc9eee08c8a 100644 --- a/public/app/plugins/panel/nodeGraph/useZoom.ts +++ b/public/app/plugins/panel/nodeGraph/useZoom.ts @@ -1,18 +1,21 @@ import { useCallback, useEffect, useRef, useState } from 'react'; -const defaultOptions: Options = { - stepDown: (s) => s / 1.5, +import { ZoomMode } from './panelcfg.gen'; + +const defaultOptions: Required = { stepUp: (s) => s * 1.5, + stepDown: (s) => s / 1.5, min: 0.13, max: 2.25, + zoomMode: ZoomMode.Cooperative, }; interface Options { /** * Allows you to specify how the step up will be handled so you can do fractional steps based on previous value. */ - stepUp: (scale: number) => number; - stepDown: (scale: number) => number; + stepUp?: (scale: number) => number; + stepDown?: (scale: number) => number; /** * Set max and min values. If stepUp/down overshoots these bounds this will return min or max but internal scale value @@ -20,6 +23,11 @@ interface Options { */ min?: number; max?: number; + + /** + * Sets how to handle zoom events when user is interacting with the page + */ + zoomMode?: ZoomMode; } /** @@ -27,7 +35,11 @@ interface Options { * 'transform: scale'. It returns handler for manual buttons with zoom in/zoom out function and a ref that can be * used to zoom in/out with mouse wheel. */ -export function useZoom({ stepUp, stepDown, min, max } = defaultOptions) { +export function useZoom(options: Options = defaultOptions) { + const { min, max, zoomMode } = { ...defaultOptions, ...options }; + const stepUp = options.stepUp ?? defaultOptions.stepUp; + const stepDown = options.stepDown ?? defaultOptions.stepDown; + const ref = useRef (null); const [scale, setScale] = useState(1); @@ -49,7 +61,7 @@ export function useZoom({ stepUp, stepDown, min, max } = defaultOptions) { // Only do this with special key pressed similar to how google maps work. // TODO: I would guess this won't work very well with touch right now - if (wheelEvent.ctrlKey || wheelEvent.metaKey) { + if (wheelEvent.ctrlKey || wheelEvent.metaKey || zoomMode === ZoomMode.Greedy) { wheelEvent.preventDefault(); setScale(Math.min(Math.max(min ?? -Infinity, scale + Math.min(wheelEvent.deltaY, 2) * -0.01), max ?? Infinity)); @@ -63,7 +75,7 @@ export function useZoom({ stepUp, stepDown, min, max } = defaultOptions) { } } }, - [min, max, scale] + [min, max, scale, zoomMode] ); useEffect(() => { diff --git a/public/app/plugins/panel/text/TextPanel.tsx b/public/app/plugins/panel/text/TextPanel.tsx index 62fec48d51b..a98c75b9707 100644 --- a/public/app/plugins/panel/text/TextPanel.tsx +++ b/public/app/plugins/panel/text/TextPanel.tsx @@ -4,8 +4,7 @@ import { useState } from 'react'; import { useDebounce } from 'react-use'; import { GrafanaTheme2, PanelProps, renderTextPanelMarkdown, textUtil, InterpolateFunction } from '@grafana/data'; -import { CodeEditor, useStyles2 } from '@grafana/ui'; -import { ScrollContainer } from '@grafana/ui/src/unstable'; +import { CodeEditor, ScrollContainer, useStyles2 } from '@grafana/ui'; import config from 'app/core/config'; import { defaultCodeOptions, Options, TextMode } from './panelcfg.gen'; diff --git a/public/app/plugins/panel/xychart/AutoEditor.tsx b/public/app/plugins/panel/xychart/AutoEditor.tsx deleted file mode 100644 index 07632384c9b..00000000000 --- a/public/app/plugins/panel/xychart/AutoEditor.tsx +++ /dev/null @@ -1,165 +0,0 @@ -import { css } from '@emotion/css'; -import { useMemo } from 'react'; - -import { - SelectableValue, - getFrameDisplayName, - StandardEditorProps, - getFieldDisplayName, - GrafanaTheme2, -} from '@grafana/data'; -import { Field, IconButton, Select, useStyles2 } from '@grafana/ui'; - -import { getXYDimensions, isGraphable } from './dims'; -import { XYDimensionConfig, Options } from './panelcfg.gen'; - -interface XYInfo { - numberFields: Array ; - yFields: Array No data...; - } - - return ( --- ); -}; - -const getStyles = (theme: GrafanaTheme2) => ({ - sorter: css({ - marginTop: '10px', - display: 'flex', - flexDirection: 'row', - flexWrap: 'nowrap', - alignItems: 'center', - cursor: 'pointer', - }), - - row: css({ - padding: theme.spacing(0.5, 1), - borderRadius: theme.shape.radius.default, - background: theme.colors.background.secondary, - minHeight: theme.spacing(4), - display: 'flex', - flexDirection: 'row', - flexWrap: 'nowrap', - alignItems: 'center', - marginBottom: '3px', - border: `1px solid ${theme.components.input.borderColor}`, - }), -}); diff --git a/public/app/plugins/panel/xychart/ManualEditor.tsx b/public/app/plugins/panel/xychart/ManualEditor.tsx deleted file mode 100644 index 6459e778fe9..00000000000 --- a/public/app/plugins/panel/xychart/ManualEditor.tsx +++ /dev/null @@ -1,199 +0,0 @@ -import { css, cx } from '@emotion/css'; -import { useState, useEffect, useMemo } from 'react'; - -import { - GrafanaTheme2, - StandardEditorProps, - FieldNamePickerBaseNameMode, - StandardEditorsRegistryItem, - getFrameDisplayName, -} from '@grafana/data'; -import { Button, Field, IconButton, Select, useStyles2 } from '@grafana/ui'; -import { LayerName } from 'app/core/components/Layers/LayerName'; - -import { ScatterSeriesEditor } from './ScatterSeriesEditor'; -import { Options, ScatterSeriesConfig, defaultFieldConfig } from './panelcfg.gen'; - -export const ManualEditor = ({ - value, - onChange, - context, -}: StandardEditorProps- -- -- -- {info.yFields.map((v) => ( ---- ))} -{ - const exclude: string[] = value?.exclude ? [...value.exclude] : []; - let idx = exclude.indexOf(v.label!); - if (idx < 0) { - exclude.push(v.label!); - } else { - exclude.splice(idx, 1); - } - onChange({ - ...value, - exclude, - }); - }} - tooltip={v.value ? 'Disable' : 'Enable'} - /> - {v.label} - - {value.map((series, index) => { - return ( -- - {selected >= 0 && value[selected] && ( - <> - {frameNames.length > 1 && ( -setSelected(index)} - role="button" - aria-label={`Select series ${index + 1}`} - tabIndex={0} - onKeyPress={(e) => { - if (e.key === 'Enter') { - setSelected(index); - } - }} - > -- ); - })} -onFieldChange(v, index, 'name')} - /> - - onSeriesDelete(index)} - tooltip="Delete series" - /> - - - )} -{ - onChange( - value.map((obj, i) => { - if (i === selected) { - return val!; - } - return obj; - }) - ); - }} - frameFilter={value[selected].frame ?? undefined} - /> - - )} - - ); -}; - -const getStyles = (theme: GrafanaTheme2) => ({ - marginBot: css({ - marginBottom: '20px', - }), - row: css({ - padding: `${theme.spacing(0.5, 1)}`, - borderRadius: `${theme.shape.radius.default}`, - background: `${theme.colors.background.secondary}`, - minHeight: `${theme.spacing(4)}`, - display: 'flex', - alignItems: 'center', - justifyContent: 'space-between', - marginBottom: '3px', - cursor: 'pointer', - - border: `1px solid ${theme.components.input.borderColor}`, - '&:hover': { - border: `1px solid ${theme.components.input.borderHover}`, - }, - }), - sel: css({ - border: `1px solid ${theme.colors.primary.border}`, - '&:hover': { - border: `1px solid ${theme.colors.primary.border}`, - }, - }), - actionIcon: css({ - color: `${theme.colors.text.secondary}`, - '&:hover': { - color: `${theme.colors.text}`, - }, - }), -}); diff --git a/public/app/plugins/panel/xychart/ScatterSeriesEditor.tsx b/public/app/plugins/panel/xychart/ScatterSeriesEditor.tsx deleted file mode 100644 index f1283135229..00000000000 --- a/public/app/plugins/panel/xychart/ScatterSeriesEditor.tsx +++ /dev/null @@ -1,89 +0,0 @@ -import { StandardEditorProps, FieldNamePickerBaseNameMode } from '@grafana/data'; -import { Field } from '@grafana/ui'; -import { FieldNamePicker } from '@grafana/ui/src/components/MatchersUI/FieldNamePicker'; -import { ColorDimensionEditor, ScaleDimensionEditor } from 'app/features/dimensions/editors'; - -import { Options, ScatterSeriesConfig } from './panelcfg.gen'; - -export interface Props extends StandardEditorProps -- ); -}; diff --git a/public/app/plugins/panel/xychart/v2/SeriesEditor.tsx b/public/app/plugins/panel/xychart/SeriesEditor.tsx similarity index 100% rename from public/app/plugins/panel/xychart/v2/SeriesEditor.tsx rename to public/app/plugins/panel/xychart/SeriesEditor.tsx diff --git a/public/app/plugins/panel/xychart/SymbolEditor.tsx b/public/app/plugins/panel/xychart/SymbolEditor.tsx deleted file mode 100644 index b0f176054cf..00000000000 --- a/public/app/plugins/panel/xychart/SymbolEditor.tsx +++ /dev/null @@ -1,29 +0,0 @@ -import { StandardEditorProps } from '@grafana/data'; -import { ResourceDimensionConfig, ResourceDimensionMode } from '@grafana/schema'; -import { RadioButtonGroup } from '@grafana/ui'; -import { ResourceDimensionOptions } from 'app/features/dimensions'; - -export const SymbolEditor = ( - props: StandardEditorProps- -onFieldChange(field, 'x')} - item={{ - id: 'x', - name: 'x', - settings: { - filter: (field) => - frame?.fields.some((obj) => obj.state?.displayName === field.state?.displayName) ?? true, - baseNameMode, - placeholderText: 'select X field', - }, - }} - /> - - -onFieldChange(field, 'y')} - item={{ - id: 'y', - name: 'y', - settings: { - filter: (field) => - frame?.fields.some((obj) => obj.state?.displayName === field.state?.displayName) ?? true, - baseNameMode, - placeholderText: 'select Y field', - }, - }} - /> - - -onFieldChange(field, 'pointColor')} - item={{ - id: 'x', - name: 'x', - settings: { - baseNameMode, - isClearable: true, - placeholder: 'Use standard color scheme', - }, - }} - /> - - -onFieldChange(field, 'pointSize')} - item={{ - id: 'x', - name: 'x', - settings: { - min: 1, - max: 100, - }, - }} - /> - -- ); -}; diff --git a/public/app/plugins/panel/xychart/XYChartPanel.tsx b/public/app/plugins/panel/xychart/XYChartPanel.tsx index 7fc3ca9d7c1..f22fd8248e1 100644 --- a/public/app/plugins/panel/xychart/XYChartPanel.tsx +++ b/public/app/plugins/panel/xychart/XYChartPanel.tsx @@ -1,117 +1,103 @@ import { css } from '@emotion/css'; -import { useState, useEffect, useCallback } from 'react'; -import { usePrevious } from 'react-use'; +import { useMemo } from 'react'; -import { PanelProps } from '@grafana/data'; +import { FALLBACK_COLOR, PanelProps } from '@grafana/data'; import { alpha } from '@grafana/data/src/themes/colorManipulator'; import { config } from '@grafana/runtime'; import { TooltipDisplayMode, TooltipPlugin2, UPlotChart, - UPlotConfigBuilder, - useTheme2, VizLayout, VizLegend, VizLegendItem, + useStyles2, + useTheme2, } from '@grafana/ui'; import { TooltipHoverMode } from '@grafana/ui/src/components/uPlot/plugins/TooltipPlugin2'; -import { FacetedData } from '@grafana/ui/src/components/uPlot/types'; import { getDisplayValuesForCalcs } from '@grafana/ui/src/components/uPlot/utils'; import { XYChartTooltip } from './XYChartTooltip'; -import { Options, SeriesMapping } from './panelcfg.gen'; -import { prepData, prepScatter, ScatterPanelInfo } from './scatter'; -import { ScatterSeries } from './types'; +import { Options } from './panelcfg.gen'; +import { prepConfig } from './scatter'; +import { prepSeries } from './utils'; -type Props = PanelProps- {!basicSymbols.find((v) => v.value === value.fixed) && {value.fixed}} -; +type Props2 = PanelProps ; -export const XYChartPanel = (props: Props) => { +export const XYChartPanel2 = (props: Props2) => { + const styles = useStyles2(getStyles); const theme = useTheme2(); - const [error, setError] = useState (); - const [series, setSeries] = useState (); - const [facets, setFacets] = useState (); + let { mapping, series: mappedSeries } = props.options; - const oldOptions = usePrevious(props.options); - const oldData = usePrevious(props.data); - - const initSeries = useCallback(() => { - const getData = () => props.data.series; - const info: ScatterPanelInfo = prepScatter(props.options, getData, config.theme2); - - if (info.error) { - setError(info.error); - } else if (info.series.length && props.data.series) { - setBuilder(info.builder); - setSeries(info.series); - setFacets(() => prepData(info, props.data.series)); - setError(undefined); - } - }, [props.data.series, props.options]); - - const initFacets = useCallback(() => { - setFacets(() => prepData({ error, series }, props.data.series)); - }, [props.data.series, error, series]); - - useEffect(() => { - if (oldOptions !== props.options || oldData?.structureRev !== props.data.structureRev) { - initSeries(); - } else if (oldData?.series !== props.data.series) { - initFacets(); - } + // regenerate series schema when mappings or data changes + let series = useMemo( + () => prepSeries(mapping, mappedSeries, props.data.series, props.fieldConfig), // eslint-disable-next-line react-hooks/exhaustive-deps - }, [props]); + [mapping, mappedSeries, props.data.series, props.fieldConfig] + ); + // if series changed due to mappings or data structure, re-init config & renderers + let { builder, prepData } = useMemo( + () => prepConfig(series, config.theme2), + // eslint-disable-next-line react-hooks/exhaustive-deps + [mapping, mappedSeries, props.data.structureRev, props.fieldConfig, props.options.tooltip] + ); + + // generate data struct for uPlot mode: 2 + let data = useMemo( + () => prepData(series), + // eslint-disable-next-line react-hooks/exhaustive-deps + [series] + ); + + // todo: handle errors + let error = builder == null || data.length === 0 ? 'Err' : ''; + + // TODO: React.memo() const renderLegend = () => { - const items: VizLegendItem[] = []; - - for (let si = 0; si < series.length; si++) { - const s = series[si]; - const frame = s.frame(props.data.series); - if (frame) { - for (const item of s.legend()) { - const field = s.y(frame); - item.getDisplayValues = () => getDisplayValuesForCalcs(props.options.legend.calcs, field, theme); - item.disabled = !(s.show ?? true); - - if (props.options.seriesMapping === SeriesMapping.Manual) { - item.label = props.options.series?.[si]?.name ?? `Series ${si + 1}`; - } - - item.color = alpha(s.lineColor(frame) as string, 1); - - items.push(item); - } - } - } - if (!props.options.legend.showLegend) { return null; } - const legendStyle = { - flexStart: css({ - div: { - justifyContent: 'flex-start', - }, - }), - }; + const items: VizLegendItem[] = []; + + series.forEach((s, idx) => { + let yField = s.y.field; + let config = yField.config; + let custom = config.custom; + + if (!custom.hideFrom?.legend) { + items.push({ + yAxis: 1, // TODO: pull from y field + label: s.name.value, + color: alpha(s.color.fixed ?? FALLBACK_COLOR, 1), + getItemKey: () => `${idx}-${s.name.value}`, + fieldName: yField.state?.displayName ?? yField.name, + disabled: yField.state?.hideFrom?.viz ?? false, + getDisplayValues: () => getDisplayValuesForCalcs(props.options.legend.calcs, yField, theme), + }); + } + }); + + const { placement, displayMode, width, sortBy, sortDesc } = props.options.legend; return ( - + {error}
@@ -120,33 +106,39 @@ export const XYChartPanel = (props: Props) => { } return ( - <> -- {(vizWidth: number, vizHeight: number) => ( - - +- {props.options.tooltip.mode !== TooltipDisplayMode.None && ( - - )} -{ - return ( - - ); - }} - maxWidth={props.options.tooltip.maxWidth} - /> - )} - + {(vizWidth: number, vizHeight: number) => ( + ); }; + +const getStyles = () => ({ + legend: css({ + div: { + justifyContent: 'flex-start', + }, + }), +}); diff --git a/public/app/plugins/panel/xychart/XYChartTooltip.test.tsx b/public/app/plugins/panel/xychart/XYChartTooltip.test.tsx deleted file mode 100644 index 5ea82819990..00000000000 --- a/public/app/plugins/panel/xychart/XYChartTooltip.test.tsx +++ /dev/null @@ -1,179 +0,0 @@ -import { render } from '@testing-library/react'; - -import { DataFrame, FieldType, ValueLinkConfig, LinkTarget } from '@grafana/data'; -import { SortOrder, VisibilityMode } from '@grafana/schema'; -import { LegendDisplayMode, TooltipDisplayMode } from '@grafana/ui'; - -import { XYChartTooltip, Props } from './XYChartTooltip'; -import { ScatterSeries } from './types'; - -describe('XYChartTooltip', () => { - it('should render null when `allSeries` is empty', () => { - const { container } = render(+ {props.options.tooltip.mode !== TooltipDisplayMode.None && ( + + )} +{ + return ( + + ); + }} + maxWidth={props.options.tooltip.maxWidth} + /> + )} + ); - - expect(container.firstChild).toBeNull(); - }); - - it('should render null when `dataIdxs` is null', () => { - const { container } = render( ); - - expect(container.firstChild).toBeNull(); - }); - - it('should render the tooltip header label with series name', () => { - const seriesName = 'seriesName_1'; - const { getByText } = render( - - ); - - expect(getByText(seriesName)).toBeInTheDocument(); - }); - - it('should render the tooltip content with x and y field names and values', () => { - const field1Name = 'test_field_1'; - const field2Name = 'test_field_2'; - const { getByText } = render( - - ); - - expect(getByText(field1Name)).toBeInTheDocument(); - expect(getByText('32.799')).toBeInTheDocument(); - expect(getByText(field2Name)).toBeInTheDocument(); - expect(getByText(300)).toBeInTheDocument(); - }); - - it('should render the tooltip footer with data links', () => { - const dataLinkTitle = 'Google'; - const { getByText } = render( - - ); - - expect(getByText(dataLinkTitle)).toBeInTheDocument(); - }); -}); - -function getProps(additionalProps: Partial | null = null): Props { - if (!additionalProps) { - return getDefaultProps(); - } - - return { ...getDefaultProps(), ...additionalProps }; -} - -function getDefaultProps(): Props { - return { - data: [], - allSeries: [], - dataIdxs: [], - seriesIdx: null, - isPinned: false, - dismiss: jest.fn(), - options: { - dims: { - frame: 0, - }, - series: [], - legend: { - calcs: [], - displayMode: LegendDisplayMode.List, - placement: 'bottom', - showLegend: true, - }, - tooltip: { - mode: TooltipDisplayMode.Single, - sort: SortOrder.Ascending, - }, - }, - }; -} - -function buildAllSeries(testSeriesName = 'test'): ScatterSeries[] { - return [ - { - name: testSeriesName, - legend: jest.fn(), - frame: (frames: DataFrame[]) => frames[0], - x: (frame: DataFrame) => frame.fields[0], - y: (frame: DataFrame) => frame.fields[1], - pointColor: (_frame: DataFrame) => '#111', - showLine: false, - lineWidth: 1, - lineStyle: {}, - lineColor: jest.fn(), - showPoints: VisibilityMode.Always, - pointSize: jest.fn(), - pointSymbol: jest.fn(), - label: VisibilityMode.Always, - labelValue: jest.fn(), - show: true, - hints: { - pointSize: { fixed: 10, max: 10, min: 1 }, - pointColor: { - mode: { - id: 'threshold', - name: 'Threshold', - getCalculator: jest.fn(), - }, - }, - }, - }, - ]; -} - -function buildData({ dataLinkTitle = 'Grafana', field1Name = 'field_1', field2Name = 'field_2' } = {}): DataFrame[] { - return [ - { - fields: [ - { - name: field1Name, - type: FieldType.number, - config: {}, - values: [ - 61.385, 32.799, 33.7712, 36.17, 39.0646, 27.8333, 42.0046, 40.3363, 39.8647, 37.669, 42.2373, 43.3504, - 35.6411, 40.314, 34.8375, 40.3736, 44.5672, - ], - }, - { - name: field2Name, - type: FieldType.number, - config: { - links: [ - { - title: dataLinkTitle, - targetBlank: true, - url: 'http://www.someWebsite.com', - }, - ], - }, - values: [500, 300, 150, 250, 600, 500, 700, 400, 540, 630, 460, 250, 500, 400, 800, 930, 360], - getLinks: (_config: ValueLinkConfig) => [ - { - href: 'http://www.someWebsite.com', - title: dataLinkTitle, - target: '_blank' as LinkTarget, - origin: { name: '', type: FieldType.boolean, config: {}, values: [] }, - }, - ], - }, - ], - length: 17, - }, - ]; -} diff --git a/public/app/plugins/panel/xychart/XYChartTooltip.tsx b/public/app/plugins/panel/xychart/XYChartTooltip.tsx index b8046935bb3..abd3cb32bc2 100644 --- a/public/app/plugins/panel/xychart/XYChartTooltip.tsx +++ b/public/app/plugins/panel/xychart/XYChartTooltip.tsx @@ -1,6 +1,6 @@ import { ReactNode } from 'react'; -import { DataFrame, Field, getFieldDisplayName } from '@grafana/data'; +import { DataFrame, InterpolateFunction } from '@grafana/data'; import { alpha } from '@grafana/data/src/themes/colorManipulator'; import { VizTooltipContent } from '@grafana/ui/src/components/VizTooltip/VizTooltipContent'; import { VizTooltipFooter } from '@grafana/ui/src/components/VizTooltip/VizTooltipFooter'; @@ -8,10 +8,9 @@ import { VizTooltipHeader } from '@grafana/ui/src/components/VizTooltip/VizToolt import { VizTooltipWrapper } from '@grafana/ui/src/components/VizTooltip/VizTooltipWrapper'; import { ColorIndicator, VizTooltipItem } from '@grafana/ui/src/components/VizTooltip/types'; -import { getDataLinks } from '../status-history/utils'; +import { getDataLinks, getFieldActions } from '../status-history/utils'; -import { Options } from './panelcfg.gen'; -import { ScatterSeries } from './types'; +import { XYSeries } from './types2'; import { fmt } from './utils'; export interface Props { @@ -19,73 +18,87 @@ export interface Props { seriesIdx: number | null | undefined; isPinned: boolean; dismiss: () => void; - options: Options; - data: DataFrame[]; // source data - allSeries: ScatterSeries[]; + data: DataFrame[]; + xySeries: XYSeries[]; + replaceVariables: InterpolateFunction; } -export const XYChartTooltip = ({ dataIdxs, seriesIdx, data, allSeries, dismiss, options, isPinned }: Props) => { - const rowIndex = dataIdxs.find((idx) => idx !== null); - // @todo: remove -1 when uPlot v2 arrive - // context: first value in dataIdxs always null and represent X series - const hoveredPointIndex = seriesIdx! - 1; - - if (!allSeries || rowIndex == null) { - return null; +function stripSeriesName(fieldName: string, seriesName: string) { + if (fieldName !== seriesName && fieldName.includes(' ')) { + fieldName = fieldName.replace(seriesName, '').trim(); } - const series = allSeries[hoveredPointIndex]; - const frame = series.frame(data); - const xField = series.x(frame); - const yField = series.y(frame); + return fieldName; +} - let label = series.name; - if (options.seriesMapping === 'manual') { - label = options.series?.[hoveredPointIndex]?.name ?? `Series ${hoveredPointIndex + 1}`; - } +export const XYChartTooltip = ({ dataIdxs, seriesIdx, data, xySeries, dismiss, isPinned, replaceVariables }: Props) => { + const rowIndex = dataIdxs.find((idx) => idx !== null)!; - let colorThing = series.pointColor(frame); + const series = xySeries[seriesIdx! - 1]; + const xField = series.x.field; + const yField = series.y.field; - if (Array.isArray(colorThing)) { - colorThing = colorThing[rowIndex]; - } + const sizeField = series.size.field; + const colorField = series.color.field; + + let label = series.name.value; + + let seriesColor = series.color.fixed; + // let colorField = series.color.field; + // let pointColor: string; + + // if (colorField != null) { + // pointColor = colorField.display?.(colorField.values[rowIndex]).color!; + // } const headerItem: VizTooltipItem = { label, value: '', - // eslint-disable-next-line @typescript-eslint/consistent-type-assertions - color: alpha(colorThing as string, 0.5), + color: alpha(seriesColor ?? '#fff', 0.5), colorIndicator: ColorIndicator.marker_md, }; const contentItems: VizTooltipItem[] = [ { - label: getFieldDisplayName(xField, frame), + label: stripSeriesName(xField.state?.displayName ?? xField.name, label), value: fmt(xField, xField.values[rowIndex]), }, { - label: getFieldDisplayName(yField, frame), + label: stripSeriesName(yField.state?.displayName ?? yField.name, label), value: fmt(yField, yField.values[rowIndex]), }, ]; - // add extra fields - const extraFields: Field[] = frame.fields.filter((f) => f !== xField && f !== yField); - if (extraFields) { - extraFields.forEach((field) => { - contentItems.push({ - label: field.name, - value: fmt(field, field.values[rowIndex]), - }); + // mapped fields for size/color + if (sizeField != null && sizeField !== yField) { + contentItems.push({ + label: stripSeriesName(sizeField.state?.displayName ?? sizeField.name, label), + value: fmt(sizeField, sizeField.values[rowIndex]), }); } + if (colorField != null && colorField !== yField) { + contentItems.push({ + label: stripSeriesName(colorField.state?.displayName ?? colorField.name, label), + value: fmt(colorField, colorField.values[rowIndex]), + }); + } + + series._rest.forEach((field) => { + contentItems.push({ + label: stripSeriesName(field.state?.displayName ?? field.name, label), + value: fmt(field, field.values[rowIndex]), + }); + }); + let footer: ReactNode; if (isPinned && seriesIdx != null) { const links = getDataLinks(yField, rowIndex); + const yFieldFrame = data.find((frame) => frame.fields.includes(yField))!; + const actions = getFieldActions(yFieldFrame, yField, replaceVariables, rowIndex); - footer = ; + footer = ; } return ( diff --git a/public/app/plugins/panel/xychart/config.ts b/public/app/plugins/panel/xychart/config.ts index fc776971d6e..c3e958c8c12 100644 --- a/public/app/plugins/panel/xychart/config.ts +++ b/public/app/plugins/panel/xychart/config.ts @@ -10,7 +10,7 @@ import { commonOptionsBuilder } from '@grafana/ui'; import { LineStyleEditor } from '../timeseries/LineStyleEditor'; -import { FieldConfig, ScatterShow } from './panelcfg.gen'; +import { FieldConfig, XYShowMode, PointShape } from './panelcfg.gen'; export const DEFAULT_POINT_SIZE = 5; @@ -58,9 +58,9 @@ export function getScatterFieldConfig(cfg: FieldConfig): SetFieldConfigOptionsAr defaultValue: cfg.show, settings: { options: [ - { label: 'Points', value: ScatterShow.Points }, - { label: 'Lines', value: ScatterShow.Lines }, - { label: 'Both', value: ScatterShow.PointsAndLines }, + { label: 'Points', value: XYShowMode.Points }, + { label: 'Lines', value: XYShowMode.Lines }, + { label: 'Both', value: XYShowMode.PointsAndLines }, ], }, }) @@ -92,24 +92,56 @@ export function getScatterFieldConfig(cfg: FieldConfig): SetFieldConfigOptionsAr max: 100, step: 1, }, - showIf: (c) => c.show !== ScatterShow.Lines, + showIf: (c) => c.show !== XYShowMode.Lines, + }) + .addNumberInput({ + path: 'pointSize.min', + name: 'Min point size', + showIf: (c) => c.show !== XYShowMode.Lines, + }) + .addNumberInput({ + path: 'pointSize.max', + name: 'Max point size', + showIf: (c) => c.show !== XYShowMode.Lines, + }) + .addRadio({ + path: 'pointShape', + name: 'Point shape', + defaultValue: PointShape.Circle, + settings: { + options: [ + { value: PointShape.Circle, label: 'Circle' }, + { value: PointShape.Square, label: 'Square' }, + ], + }, + showIf: (c) => c.show !== XYShowMode.Lines, + }) + .addSliderInput({ + path: 'pointStrokeWidth', + name: 'Point stroke width', + defaultValue: 1, + settings: { + min: 0, + max: 10, + }, + showIf: (c) => c.show !== XYShowMode.Lines, + }) + .addSliderInput({ + path: 'fillOpacity', + name: 'Fill opacity', + defaultValue: 50, + settings: { + min: 0, + max: 100, + step: 1, + }, + showIf: (c) => c.show !== XYShowMode.Lines, }) - // .addSliderInput({ - // path: 'fillOpacity', - // name: 'Fill opacity', - // defaultValue: 0.4, // defaultFieldConfig.fillOpacity, - // settings: { - // min: 0, // hidden? or just outlines? - // max: 1, - // step: 0.05, - // }, - // showIf: (c) => c.show !== ScatterShow.Lines, - // }) .addCustomEditor ; - frame: number; - x?: string; +export interface MatcherConfig { + /** + * The matcher id. This is used to find the matcher implementation from registry. + */ + id: string; + /** + * The matcher options. This is specific to the matcher implementation. + */ + options?: unknown; } -export const defaultXYDimensionConfig: Partial = { - exclude: [], +export const defaultMatcherConfig: Partial = { + id: '', }; export interface FieldConfig extends common.HideableFieldConfig, common.AxisConfig { - label?: common.VisibilityMode; - labelValue?: common.TextDimensionConfig; - lineColor?: common.ColorDimensionConfig; + fillOpacity?: number; lineStyle?: common.LineStyle; lineWidth?: number; - pointColor?: common.ColorDimensionConfig; - pointSize?: common.ScaleDimensionConfig; - show?: ScatterShow; + pointShape?: PointShape; + pointSize?: { + fixed?: number; + min?: number; + max?: number; + }; + pointStrokeWidth?: number; + show?: XYShowMode; } export const defaultFieldConfig: Partial = { - label: common.VisibilityMode.Auto, - show: ScatterShow.Points, + fillOpacity: 50, + show: XYShowMode.Points, }; -export interface ScatterSeriesConfig extends FieldConfig { - frame?: number; - name?: string; - x?: string; - y?: string; +export interface XYSeriesConfig { + color?: { + matcher: MatcherConfig; + }; + frame?: { + matcher: MatcherConfig; + }; + name?: { + fixed?: string; + }; + size?: { + matcher: MatcherConfig; + }; + x?: { + matcher: MatcherConfig; + }; + y?: { + matcher: MatcherConfig; + }; } export interface Options extends common.OptionsWithLegend, common.OptionsWithTooltip { - /** - * Table Mode (auto) - */ - dims: XYDimensionConfig; - /** - * Manual Mode - */ - series: Array ; - seriesMapping?: SeriesMapping; + mapping: SeriesMapping; + series: Array ; } export const defaultOptions: Partial = { diff --git a/public/app/plugins/panel/xychart/panelcfgold.gen.ts b/public/app/plugins/panel/xychart/panelcfgold.gen.ts new file mode 100644 index 00000000000..09f7869c536 --- /dev/null +++ b/public/app/plugins/panel/xychart/panelcfgold.gen.ts @@ -0,0 +1,77 @@ +// Code generated - EDITING IS FUTILE. DO NOT EDIT. +// +// Generated by: +// public/app/plugins/gen.go +// Using jennies: +// TSTypesJenny +// PluginTsTypesJenny +// +// Run 'make gen-cue' from repository root to regenerate. + +import * as common from '@grafana/schema'; + +/** + * Auto is "table" in the UI + */ +export enum SeriesMapping { + Auto = 'auto', + Manual = 'manual', +} + +export enum ScatterShow { + Lines = 'lines', + Points = 'points', + PointsAndLines = 'points+lines', +} + +/** + * Configuration for the Table/Auto mode + */ +export interface XYDimensionConfig { + exclude?: Array ; + frame: number; + x?: string; +} + +export const defaultXYDimensionConfig: Partial = { + exclude: [], +}; + +export interface FieldConfig extends common.HideableFieldConfig, common.AxisConfig { + label?: common.VisibilityMode; + labelValue?: common.TextDimensionConfig; + lineColor?: common.ColorDimensionConfig; + lineStyle?: common.LineStyle; + lineWidth?: number; + pointColor?: common.ColorDimensionConfig; + pointSize?: common.ScaleDimensionConfig; + show?: ScatterShow; +} + +export const defaultFieldConfig: Partial = { + label: common.VisibilityMode.Auto, + show: ScatterShow.Points, +}; + +export interface ScatterSeriesConfig extends FieldConfig { + frame?: number; + name?: string; + x?: string; + y?: string; +} + +export interface Options extends common.OptionsWithLegend, common.OptionsWithTooltip { + /** + * Table Mode (auto) + */ + dims: XYDimensionConfig; + /** + * Manual Mode + */ + series: Array ; + seriesMapping?: SeriesMapping; +} + +export const defaultOptions: Partial = { + series: [], +}; diff --git a/public/app/plugins/panel/xychart/plugin.json b/public/app/plugins/panel/xychart/plugin.json index 13721d65fb0..974ee96fa2b 100644 --- a/public/app/plugins/panel/xychart/plugin.json +++ b/public/app/plugins/panel/xychart/plugin.json @@ -2,7 +2,6 @@ "type": "panel", "name": "XY Chart", "id": "xychart", - "state": "beta", "info": { "description": "Supports arbitrary X vs Y in a graph to visualize the relationship between two variables.", diff --git a/public/app/plugins/panel/xychart/scatter.ts b/public/app/plugins/panel/xychart/scatter.ts index bb2f413d1a0..5f741b92323 100644 --- a/public/app/plugins/panel/xychart/scatter.ts +++ b/public/app/plugins/panel/xychart/scatter.ts @@ -1,280 +1,28 @@ +import tinycolor from 'tinycolor2'; import uPlot from 'uplot'; import { - DataFrame, - FieldColorModeId, - fieldColorModeRegistry, + FALLBACK_COLOR, + Field, + FieldType, formattedValueToString, - getDisplayProcessor, getFieldColorModeForField, - getFieldDisplayName, - getFieldSeriesColor, GrafanaTheme2, + MappingType, + SpecialValueMatch, + ThresholdsMode, } from '@grafana/data'; import { alpha } from '@grafana/data/src/themes/colorManipulator'; -import { config } from '@grafana/runtime'; -import { - AxisPlacement, - ScaleDirection, - ScaleOrientation, - VisibilityMode, - ScaleDimensionConfig, - ScaleDimensionMode, -} from '@grafana/schema'; +import { AxisPlacement, FieldColorModeId, ScaleDirection, ScaleOrientation, VisibilityMode } from '@grafana/schema'; import { UPlotConfigBuilder } from '@grafana/ui'; import { FacetedData, FacetSeries } from '@grafana/ui/src/components/uPlot/types'; -import { findFieldIndex, getScaledDimensionForField } from 'app/features/dimensions'; import { pointWithin, Quadtree, Rect } from '../barchart/quadtree'; +import { valuesToFills } from '../heatmap/utils'; -import { DEFAULT_POINT_SIZE } from './config'; -import { isGraphable } from './dims'; -import { FieldConfig, defaultFieldConfig, Options, ScatterShow } from './panelcfg.gen'; -import { DimensionValues, ScatterSeries } from './types'; - -export interface ScatterPanelInfo { - error?: string; - series: ScatterSeries[]; - builder?: UPlotConfigBuilder; -} - -/** - * This is called when options or structure rev changes - */ -export function prepScatter(options: Options, getData: () => DataFrame[], theme: GrafanaTheme2): ScatterPanelInfo { - let series: ScatterSeries[]; - let builder: UPlotConfigBuilder; - - try { - series = prepSeries(options, getData()); - builder = prepConfig(getData, series, theme); - } catch (e) { - let errorMsg = 'Unknown error in prepScatter'; - if (typeof e === 'string') { - errorMsg = e; - } else if (e instanceof Error) { - errorMsg = e.message; - } - - return { - error: errorMsg, - series: [], - }; - } - - return { - series, - builder, - }; -} - -interface Dims { - pointColorIndex?: number; - pointColorFixed?: string; - - pointSizeIndex?: number; - pointSizeConfig?: ScaleDimensionConfig; -} - -function getScatterSeries( - seriesIndex: number, - frames: DataFrame[], - frameIndex: number, - xIndex: number, - yIndex: number, - dims: Dims -): ScatterSeries { - const frame = frames[frameIndex]; - const y = frame.fields[yIndex]; - let state = y.state ?? {}; - state.seriesIndex = seriesIndex; - y.state = state; - - // Color configs - //---------------- - let seriesColor = dims.pointColorFixed - ? config.theme2.visualization.getColorByName(dims.pointColorFixed) - : getFieldSeriesColor(y, config.theme2).color; - let pointColor: DimensionValues = () => seriesColor; - const fieldConfig: FieldConfig = { ...defaultFieldConfig, ...y.config.custom }; - let pointColorMode = fieldColorModeRegistry.get(FieldColorModeId.PaletteClassic); - if (dims.pointColorIndex) { - const f = frames[frameIndex].fields[dims.pointColorIndex]; - if (f) { - pointColorMode = getFieldColorModeForField(y); - if (pointColorMode.isByValue) { - const index = dims.pointColorIndex; - pointColor = (frame: DataFrame) => { - const field = frame.fields[index]; - - if (field.state?.range) { - // this forces local min/max recalc, rather than using global min/max from field.state - field.state.range = undefined; - } - - field.display = getDisplayProcessor({ field, theme: config.theme2 }); - - return field.values.map((v) => field.display!(v).color!); // slow! - }; - } else { - seriesColor = pointColorMode.getCalculator(f, config.theme2)(f.values[0], 1); - pointColor = () => seriesColor; - } - } - } - - // Size configs - //---------------- - let pointSizeHints = dims.pointSizeConfig; - let pointSizeFixed = dims.pointSizeConfig?.fixed ?? y.config.custom?.pointSize?.fixed ?? DEFAULT_POINT_SIZE; - let pointSize: DimensionValues = () => pointSizeFixed; - if (dims.pointSizeIndex) { - pointSize = (frame) => { - const s = getScaledDimensionForField( - frame.fields[dims.pointSizeIndex!], - dims.pointSizeConfig!, - ScaleDimensionMode.Quad - ); - const vals = Array(frame.length); - for (let i = 0; i < frame.length; i++) { - vals[i] = s.get(i); - } - return vals; - }; - } else { - pointSizeHints = { - fixed: pointSizeFixed, - min: pointSizeFixed, - max: pointSizeFixed, - }; - } - - // Series config - //---------------- - const name = getFieldDisplayName(y, frame, frames); - return { - name, - - frame: (frames) => frames[frameIndex], - - x: (frame) => frame.fields[xIndex], - y: (frame) => frame.fields[yIndex], - legend: () => { - return [ - { - label: name, - color: seriesColor, // single color for series? - getItemKey: () => name, - yAxis: yIndex, // << but not used - }, - ]; - }, - - showLine: fieldConfig.show !== ScatterShow.Points, - lineWidth: fieldConfig.lineWidth ?? 2, - lineStyle: fieldConfig.lineStyle!, - lineColor: () => seriesColor, - - showPoints: fieldConfig.show !== ScatterShow.Lines ? VisibilityMode.Always : VisibilityMode.Never, - pointSize, - pointColor, - pointSymbol: (frame: DataFrame, from?: number) => 'circle', // single field, multiple symbols.... kinda equals multiple series 🤔 - - label: VisibilityMode.Never, - labelValue: () => '', - show: !frame.fields[yIndex].config.custom.hideFrom?.viz, - - hints: { - pointSize: pointSizeHints!, - pointColor: { - mode: pointColorMode, - }, - }, - }; -} - -function prepSeries(options: Options, frames: DataFrame[]): ScatterSeries[] { - let seriesIndex = 0; - if (!frames.length) { - throw 'Missing data'; - } - - if (options.seriesMapping === 'manual') { - if (!options.series?.length) { - throw 'Missing series config'; - } - - const scatterSeries: ScatterSeries[] = []; - - for (const series of options.series) { - if (!series?.x) { - throw 'Select X dimension'; - } - - if (!series?.y) { - throw 'Select Y dimension'; - } - - for (let frameIndex = 0; frameIndex < frames.length; frameIndex++) { - // When a frame filter is applied, only include matching frame index - if (series.frame !== undefined && series.frame !== frameIndex) { - continue; - } - const frame = frames[frameIndex]; - const xIndex = findFieldIndex(series.x, frame, frames); - - if (xIndex != null) { - // TODO: this should find multiple y fields - const yIndex = findFieldIndex(series.y, frame, frames); - - if (yIndex == null) { - throw 'Y must be in the same frame as X'; - } - - const dims: Dims = { - pointColorFixed: series.pointColor?.fixed, - pointColorIndex: findFieldIndex(series.pointColor?.field, frame, frames), - pointSizeConfig: series.pointSize, - pointSizeIndex: findFieldIndex(series.pointSize?.field, frame, frames), - }; - scatterSeries.push(getScatterSeries(seriesIndex++, frames, frameIndex, xIndex, yIndex, dims)); - } - } - } - - return scatterSeries; - } - - // Default behavior - const dims = options.dims ?? {}; - const frameIndex = dims.frame ?? 0; - const frame = frames[frameIndex]; - const numericIndices: number[] = []; - - let xIndex = findFieldIndex(dims.x, frame, frames); - for (let i = 0; i < frame.fields.length; i++) { - if (isGraphable(frame.fields[i])) { - if (xIndex == null || i === xIndex) { - xIndex = i; - continue; - } - if (dims.exclude && dims.exclude.includes(getFieldDisplayName(frame.fields[i], frame, frames))) { - continue; // skip - } - - numericIndices.push(i); - } - } - - if (xIndex == null) { - throw 'Missing X dimension'; - } - - if (!numericIndices.length) { - throw 'No Y values'; - } - return numericIndices.map((yIndex) => getScatterSeries(seriesIndex++, frames, frameIndex, xIndex!, yIndex, {})); -} +import { PointShape } from './panelcfg.gen'; +import { XYSeries } from './types2'; +import { getCommonPrefixSuffix } from './utils'; interface DrawBubblesOpts { each: (u: uPlot, seriesIdx: number, dataIdx: number, lft: number, top: number, wid: number, hgt: number) => void; @@ -285,12 +33,15 @@ interface DrawBubblesOpts { }; color: { values: (u: uPlot, seriesIdx: number) => string[]; - alpha: number; }; }; } -const prepConfig = (getData: () => DataFrame[], scatterSeries: ScatterSeries[], theme: GrafanaTheme2) => { +export const prepConfig = (xySeries: XYSeries[], theme: GrafanaTheme2) => { + if (xySeries.length === 0) { + return { builder: null, prepData: () => [] }; + } + let qt: Quadtree; let hRect: Rect | null; @@ -317,29 +68,26 @@ const prepConfig = (getData: () => DataFrame[], scatterSeries: ScatterSeries[], arc ) => { const pxRatio = uPlot.pxRatio; - const scatterInfo = scatterSeries[seriesIdx - 1]; + const scatterInfo = xySeries[seriesIdx - 1]; let d = u.data[seriesIdx] as unknown as FacetSeries; + // showLine: boolean; + // lineStyle: common.LineStyle; + // showPoints: common.VisibilityMode; + let showLine = scatterInfo.showLine; let showPoints = scatterInfo.showPoints === VisibilityMode.Always; - if (!showPoints && scatterInfo.showPoints === VisibilityMode.Auto) { - showPoints = d[0].length < 1000; - } - - // always show something - if (!showPoints && !showLine) { - showLine = true; - } - - let strokeWidth = 1; + let strokeWidth = scatterInfo.pointStrokeWidth ?? 0; u.ctx.save(); u.ctx.rect(u.bbox.left, u.bbox.top, u.bbox.width, u.bbox.height); u.ctx.clip(); - u.ctx.fillStyle = (series.fill as any)(); // assumes constant - u.ctx.strokeStyle = (series.stroke as any)(); + let pointAlpha = scatterInfo.fillOpacity / 100; + + u.ctx.fillStyle = alpha((series.fill as any)(), pointAlpha); + u.ctx.strokeStyle = alpha((series.stroke as any)(), 1); u.ctx.lineWidth = strokeWidth; let deg360 = 2 * Math.PI; @@ -347,10 +95,11 @@ const prepConfig = (getData: () => DataFrame[], scatterSeries: ScatterSeries[], let xKey = scaleX.key!; let yKey = scaleY.key!; - let pointHints = scatterInfo.hints.pointSize; - const colorByValue = scatterInfo.hints.pointColor.mode.isByValue; + //const colorMode = getFieldColorModeForField(field); // isByValue + const pointSize = scatterInfo.y.field.config.custom.pointSize; + const colorByValue = scatterInfo.color.field != null; // && colorMode.isByValue; - let maxSize = (pointHints.max ?? pointHints.fixed) * pxRatio; + let maxSize = (pointSize.max ?? pointSize.fixed) * pxRatio; // todo: this depends on direction & orientation // todo: calc once per redraw, not per path @@ -360,19 +109,23 @@ const prepConfig = (getData: () => DataFrame[], scatterSeries: ScatterSeries[], let filtTop = u.posToVal(-maxSize / 2, yKey); let sizes = opts.disp.size.values(u, seriesIdx); - let pointColors = opts.disp.color.values(u, seriesIdx); - let pointAlpha = opts.disp.color.alpha; + // let pointColors = opts.disp.color.values(u, seriesIdx); + let pointColors = dispColors[seriesIdx - 1].values; // idxs + let pointPalette = dispColors[seriesIdx - 1].index as Array (frame: DataFrame, lookup: DimensionValues ): T[] { - const r = lookup(frame); - if (Array.isArray(r)) { - return r; - } - return Array(frame.length).fill(r); +interface FieldColorValues { + index: unknown[]; + getOne: GetOneValue; + getAll: GetAllValues; } +interface FieldColorValuesWithCache extends FieldColorValues { + values: number[]; + hasAlpha: boolean; +} +type GetAllValues = (values: unknown[], min?: number, max?: number) => number[]; +type GetOneValue = (value: unknown, min?: number, max?: number) => number; -function asSingleValue (frame: DataFrame, lookup: DimensionValues ): T { - const r = lookup(frame); - if (Array.isArray(r)) { - return r[0]; +/** compiler for values to palette color idxs (from thresholds, mappings, by-value gradients) */ +function fieldValueColors(f: Field, theme: GrafanaTheme2): FieldColorValues { + let index: unknown[] = []; + let getAll: GetAllValues = () => []; + let getOne: GetOneValue = () => -1; + + let conds = ''; + + // if any mappings exist, use them regardless of other settings + if (f.config.mappings?.length ?? 0 > 0) { + let mappings = f.config.mappings!; + + for (let i = 0; i < mappings.length; i++) { + let m = mappings[i]; + + if (m.type === MappingType.ValueToText) { + for (let k in m.options) { + let { color } = m.options[k]; + + if (color != null) { + let rhs = f.type === FieldType.string ? JSON.stringify(k) : Number(k); + conds += `v === ${rhs} ? ${index.length} : `; + index.push(getHex8Color(color, theme)); + } + } + } else if (m.options.result.color != null) { + let { color } = m.options.result; + + if (m.type === MappingType.RangeToText) { + let range = []; + + if (m.options.from != null) { + range.push(`v >= ${Number(m.options.from)}`); + } + + if (m.options.to != null) { + range.push(`v <= ${Number(m.options.to)}`); + } + + if (range.length > 0) { + conds += `${range.join(' && ')} ? ${index.length} : `; + index.push(getHex8Color(color, theme)); + } + } else if (m.type === MappingType.SpecialValue) { + let spl = m.options.match; + + if (spl === SpecialValueMatch.NaN) { + conds += `isNaN(v)`; + } else if (spl === SpecialValueMatch.NullAndNaN) { + conds += `v == null || isNaN(v)`; + } else { + conds += `v ${ + spl === SpecialValueMatch.True + ? '=== true' + : spl === SpecialValueMatch.False + ? '=== false' + : spl === SpecialValueMatch.Null + ? '== null' + : spl === SpecialValueMatch.Empty + ? '=== ""' + : '== null' + }`; + } + + conds += ` ? ${index.length} : `; + index.push(getHex8Color(color, theme)); + } else if (m.type === MappingType.RegexToText) { + // TODO + } + } + } + + conds += '-1'; // ?? what default here? null? FALLBACK_COLOR? + } else if (f.config.color?.mode === FieldColorModeId.Thresholds) { + if (f.config.thresholds?.mode === ThresholdsMode.Absolute) { + let steps = f.config.thresholds.steps; + let lasti = steps.length - 1; + + for (let i = lasti; i > 0; i--) { + conds += `v >= ${steps[i].value} ? ${i} : `; + } + + conds += '0'; + + index = steps.map((s) => getHex8Color(s.color, theme)); + } else { + // TODO: percent thresholds? + } + } else if (f.config.color?.mode?.startsWith('continuous')) { + let calc = getFieldColorModeForField(f).getCalculator(f, theme); + + index = Array(32); + + for (let i = 0; i < index.length; i++) { + let pct = i / (index.length - 1); + index[i] = getHex8Color(calc(pct, pct), theme); + } + + getAll = (vals, min, max) => valuesToFills(vals as number[], index as string[], min!, max!); } - return r; + + if (conds !== '') { + getOne = new Function('v', `return ${conds};`) as GetOneValue; + + getAll = new Function( + 'vals', + ` + let idxs = Array(vals.length); + + for (let i = 0; i < vals.length; i++) { + let v = vals[i]; + idxs[i] = ${conds}; + } + + return idxs; + ` + ) as GetAllValues; + } + + return { + index, + getOne, + getAll, + }; } diff --git a/public/app/plugins/panel/xychart/types.ts b/public/app/plugins/panel/xychart/types.ts deleted file mode 100644 index 25f3a70edca..00000000000 --- a/public/app/plugins/panel/xychart/types.ts +++ /dev/null @@ -1,43 +0,0 @@ -import { DataFrame, Field, FieldColorMode } from '@grafana/data'; -import { LineStyle, ScaleDimensionConfig, VisibilityMode } from '@grafana/schema'; -import { VizLegendItem } from '@grafana/ui'; - -/** - * @internal - */ -export type DimensionValues = (frame: DataFrame, from?: number) => T | T[]; - -// Using field where we will need formatting/scale/axis info -// Use raw or DimensionValues when the values can be used directly -export interface ScatterSeries { - name: string; - - /** Finds the relevant frame from the raw panel data */ - frame: (frames: DataFrame[]) => DataFrame; - - x: (frame: DataFrame) => Field; - y: (frame: DataFrame) => Field; - - legend: () => VizLegendItem[]; // could be single if symbol is constant - - showLine: boolean; - lineWidth: number; - lineStyle: LineStyle; - lineColor: (frame: DataFrame) => CanvasRenderingContext2D['strokeStyle']; - - showPoints: VisibilityMode; - pointSize: DimensionValues ; - pointColor: DimensionValues ; // single field, multiple symbols.... kinda equals multiple series - - label: VisibilityMode; - labelValue: DimensionValues ; - show: boolean; - - hints: { - pointSize: ScaleDimensionConfig; - pointColor: { - mode: FieldColorMode; - }; - }; -} diff --git a/public/app/plugins/panel/xychart/v2/types2.ts b/public/app/plugins/panel/xychart/types2.ts similarity index 100% rename from public/app/plugins/panel/xychart/v2/types2.ts rename to public/app/plugins/panel/xychart/types2.ts diff --git a/public/app/plugins/panel/xychart/utils.ts b/public/app/plugins/panel/xychart/utils.ts index 512a46d3d7a..2df8612b398 100644 --- a/public/app/plugins/panel/xychart/utils.ts +++ b/public/app/plugins/panel/xychart/utils.ts @@ -1,4 +1,23 @@ -import { Field, formattedValueToString } from '@grafana/data'; +import { + Field, + formattedValueToString, + getFieldMatcher, + FieldType, + getFieldDisplayName, + DataFrame, + FrameMatcherID, + MatcherConfig, + FieldColorModeId, + cacheFieldDisplayNames, + FieldMatcherID, + FieldConfigSource, +} from '@grafana/data'; +import { decoupleHideFromState } from '@grafana/data/src/field/fieldState'; +import { config } from '@grafana/runtime'; +import { VisibilityMode } from '@grafana/schema'; + +import { XYShowMode, SeriesMapping, XYSeriesConfig } from './panelcfg.gen'; +import { XYSeries } from './types2'; export function fmt(field: Field, val: number): string { if (field.display) { @@ -7,3 +26,301 @@ export function fmt(field: Field, val: number): string { return `${val}`; } + +// cause we dont have a proper matcher for this currently +function getFrameMatcher2(config: MatcherConfig) { + if (config.id === FrameMatcherID.byIndex) { + return (frame: DataFrame, index: number) => index === config.options; + } + + return () => false; +} + +export function prepSeries( + mapping: SeriesMapping, + mappedSeries: XYSeriesConfig[], + frames: DataFrame[], + fieldConfig: FieldConfigSource +) { + cacheFieldDisplayNames(frames); + decoupleHideFromState(frames, fieldConfig); + + let series: XYSeries[] = []; + + if (mappedSeries.length === 0) { + mappedSeries = [{}]; + } + + const { palette, getColorByName } = config.theme2.visualization; + + mappedSeries.forEach((seriesCfg, seriesIdx) => { + if (mapping === SeriesMapping.Manual) { + if (seriesCfg.frame?.matcher == null || seriesCfg.x?.matcher == null || seriesCfg.y?.matcher == null) { + return; + } + } + + let xMatcher = getFieldMatcher( + seriesCfg.x?.matcher ?? { + id: FieldMatcherID.byType, + options: 'number', + } + ); + let yMatcher = getFieldMatcher( + seriesCfg.y?.matcher ?? { + id: FieldMatcherID.byType, + options: 'number', + } + ); + let colorMatcher = seriesCfg.color ? getFieldMatcher(seriesCfg.color.matcher) : null; + let sizeMatcher = seriesCfg.size ? getFieldMatcher(seriesCfg.size.matcher) : null; + // let frameMatcher = seriesCfg.frame ? getFrameMatchers(seriesCfg.frame) : null; + let frameMatcher = seriesCfg.frame ? getFrameMatcher2(seriesCfg.frame.matcher) : null; + + // loop over all frames and fields, adding a new series for each y dim + frames.forEach((frame, frameIdx) => { + // must match frame in manual mode + if (frameMatcher != null && !frameMatcher(frame, frameIdx)) { + return; + } + + // shared across each series in this frame + let restFields: Field[] = []; + + let frameSeries: XYSeries[] = []; + + // only grabbing number fields (exclude time, string, enum, other) + let onlyNumFields = frame.fields.filter((field) => field.type === FieldType.number); + + // only one of these per frame + let x = onlyNumFields.find((field) => xMatcher(field, frame, frames)); + let color = + colorMatcher != null + ? onlyNumFields.find((field) => field !== x && colorMatcher!(field, frame, frames)) + : undefined; + let size = + sizeMatcher != null + ? onlyNumFields.find((field) => field !== x && field !== color && sizeMatcher!(field, frame, frames)) + : undefined; + + // x field is required + if (x != null) { + // match y fields and create series + onlyNumFields.forEach((field) => { + if (field === x) { + return; + } + + // in auto mode don't reuse already-mapped fields + if (mapping === SeriesMapping.Auto && (field === color || field === size)) { + return; + } + + // in manual mode only add single series for this config + if (mapping === SeriesMapping.Manual && frameSeries.length > 0) { + return; + } + + // if we match non-excluded y, create series + if (yMatcher(field, frame, frames) && !field.config.custom?.hideFrom?.viz) { + let y = field; + let name = seriesCfg.name?.fixed ?? getFieldDisplayName(y, frame, frames); + + let ser: XYSeries = { + // these typically come from y field + name: { + value: name, + }, + + showPoints: y.config.custom.show === XYShowMode.Lines ? VisibilityMode.Never : VisibilityMode.Always, + pointShape: y.config.custom.pointShape, + pointStrokeWidth: y.config.custom.pointStrokeWidth, + fillOpacity: y.config.custom.fillOpacity, + + showLine: y.config.custom.show !== XYShowMode.Points, + lineWidth: y.config.custom.lineWidth ?? 2, + lineStyle: y.config.custom.lineStyle, + + x: { + field: x!, + }, + y: { + field: y, + }, + color: {}, + size: {}, + _rest: restFields, + }; + + if (color != null) { + ser.color.field = color; + } + + if (size != null) { + ser.size.field = size; + ser.size.min = size.config.custom.pointSize?.min ?? 5; + ser.size.max = size.config.custom.pointSize?.max ?? 100; + // ser.size.mode = + } + + frameSeries.push(ser); + } + }); + + if (frameSeries.length === 0) { + // TODO: could not create series, skip & show error? + } + + // populate rest fields + frame.fields.forEach((field) => { + let isUsedField = frameSeries.some( + ({ x, y, color, size }) => + x.field === field || y.field === field || color.field === field || size.field === field + ); + + if (!isUsedField) { + restFields.push(field); + } + }); + + series.push(...frameSeries); + } else { + // x is missing in this frame! + } + }); + }); + + if (series.length === 0) { + // TODO: could not create series, skip & show error? + } else { + // assign classic palette colors by index, as fallbacks for all series + + let paletteIdx = 0; + + // todo: populate min, max, mode from field + hints + series.forEach((s, i) => { + if (s.color.field == null) { + // derive fixed color from y field config + let colorCfg = s.y.field.config.color ?? { mode: FieldColorModeId.PaletteClassic }; + + let value = ''; + + if (colorCfg.mode === FieldColorModeId.PaletteClassic) { + value = getColorByName(palette[paletteIdx++ % palette.length]); // todo: do this via state.seriesIdx and re-init displayProcessor + } else if (colorCfg.mode === FieldColorModeId.Fixed) { + value = getColorByName(colorCfg.fixedColor!); + } + + s.color.fixed = value; + } + + if (s.size.field == null) { + // derive fixed size from y field config + s.size.fixed = s.y.field.config.custom.pointSize?.fixed ?? 5; + // ser.size.mode = + } + }); + + autoNameSeries(series); + + // TODO: re-assign y display names? + // y.state = { + // ...y.state, + // seriesIndex: series.length + , + // }; + // y.display = getDisplayProcessor({ field, theme }); + } + + return series; +} + +// strip common prefixes and suffixes from y field names +function autoNameSeries(series: XYSeries[]) { + let names = series.map((s) => s.name.value.split(/\s+/g)); + + const { prefix, suffix } = findCommonPrefixSuffixLengths(names); + + if (prefix < Infinity || suffix < Infinity) { + series.forEach((s, i) => { + s.name.value = names[i].slice(prefix, names[i].length - suffix).join(' '); + }); + } +} + +export function getCommonPrefixSuffix(strs: string[]) { + let names = strs.map((s) => s.split(/\s+/g)); + + let { prefix, suffix } = findCommonPrefixSuffixLengths(names); + + let n = names[0]; + + if (n.length === 1 && prefix === 1 && suffix === 1) { + return ''; + } + + let parts = []; + + if (prefix > 0) { + parts.push(...n.slice(0, prefix)); + } + + if (suffix > 0) { + parts.push(...n.slice(-suffix)); + } + + return parts.join(' '); +} + +// lengths are in number of tokens (segments) in a phrase +function findCommonPrefixSuffixLengths(names: string[][]) { + let commonPrefixLen = Infinity; + let commonSuffixLen = Infinity; + + // if auto naming strategy, rename fields by stripping common prefixes and suffixes + let segs0: string[] = names[0]; + + for (let i = 1; i < names.length; i++) { + if (names[i].length < segs0.length) { + segs0 = names[i]; + } + } + + for (let i = 1; i < names.length; i++) { + let segs = names[i]; + + if (segs !== segs0) { + // prefixes + let preLen = 0; + for (let j = 0; j < segs0.length; j++) { + if (segs[j] === segs0[j]) { + preLen++; + } else { + break; + } + } + + if (preLen < commonPrefixLen) { + commonPrefixLen = preLen; + } + + // suffixes + let sufLen = 0; + for (let j = segs0.length - 1; j >= 0; j--) { + if (segs[j] === segs0[j]) { + sufLen++; + } else { + break; + } + } + + if (sufLen < commonSuffixLen) { + commonSuffixLen = sufLen; + } + } + } + + return { + prefix: commonPrefixLen, + suffix: commonSuffixLen, + }; +} diff --git a/public/app/plugins/panel/xychart/v2/README.md b/public/app/plugins/panel/xychart/v2/README.md deleted file mode 100644 index bfe0168a329..00000000000 --- a/public/app/plugins/panel/xychart/v2/README.md +++ /dev/null @@ -1,3 +0,0 @@ -# XY Chart - Native Plugin - -Support arbitrary X vs Y in graph diff --git a/public/app/plugins/panel/xychart/v2/XYChartPanel.tsx b/public/app/plugins/panel/xychart/v2/XYChartPanel.tsx deleted file mode 100644 index f22fd8248e1..00000000000 --- a/public/app/plugins/panel/xychart/v2/XYChartPanel.tsx +++ /dev/null @@ -1,144 +0,0 @@ -import { css } from '@emotion/css'; -import { useMemo } from 'react'; - -import { FALLBACK_COLOR, PanelProps } from '@grafana/data'; -import { alpha } from '@grafana/data/src/themes/colorManipulator'; -import { config } from '@grafana/runtime'; -import { - TooltipDisplayMode, - TooltipPlugin2, - UPlotChart, - VizLayout, - VizLegend, - VizLegendItem, - useStyles2, - useTheme2, -} from '@grafana/ui'; -import { TooltipHoverMode } from '@grafana/ui/src/components/uPlot/plugins/TooltipPlugin2'; -import { getDisplayValuesForCalcs } from '@grafana/ui/src/components/uPlot/utils'; - -import { XYChartTooltip } from './XYChartTooltip'; -import { Options } from './panelcfg.gen'; -import { prepConfig } from './scatter'; -import { prepSeries } from './utils'; - -type Props2 = PanelProps ; - -export const XYChartPanel2 = (props: Props2) => { - const styles = useStyles2(getStyles); - const theme = useTheme2(); - - let { mapping, series: mappedSeries } = props.options; - - // regenerate series schema when mappings or data changes - let series = useMemo( - () => prepSeries(mapping, mappedSeries, props.data.series, props.fieldConfig), - // eslint-disable-next-line react-hooks/exhaustive-deps - [mapping, mappedSeries, props.data.series, props.fieldConfig] - ); - - // if series changed due to mappings or data structure, re-init config & renderers - let { builder, prepData } = useMemo( - () => prepConfig(series, config.theme2), - // eslint-disable-next-line react-hooks/exhaustive-deps - [mapping, mappedSeries, props.data.structureRev, props.fieldConfig, props.options.tooltip] - ); - - // generate data struct for uPlot mode: 2 - let data = useMemo( - () => prepData(series), - // eslint-disable-next-line react-hooks/exhaustive-deps - [series] - ); - - // todo: handle errors - let error = builder == null || data.length === 0 ? 'Err' : ''; - - // TODO: React.memo() - const renderLegend = () => { - if (!props.options.legend.showLegend) { - return null; - } - - const items: VizLegendItem[] = []; - - series.forEach((s, idx) => { - let yField = s.y.field; - let config = yField.config; - let custom = config.custom; - - if (!custom.hideFrom?.legend) { - items.push({ - yAxis: 1, // TODO: pull from y field - label: s.name.value, - color: alpha(s.color.fixed ?? FALLBACK_COLOR, 1), - getItemKey: () => `${idx}-${s.name.value}`, - fieldName: yField.state?.displayName ?? yField.name, - disabled: yField.state?.hideFrom?.viz ?? false, - getDisplayValues: () => getDisplayValuesForCalcs(props.options.legend.calcs, yField, theme), - }); - } - }); - - const { placement, displayMode, width, sortBy, sortDesc } = props.options.legend; - - return ( - - - ); - }; - - if (error) { - return ( -- -- ); - } - - return ( -{error}
-- {(vizWidth: number, vizHeight: number) => ( - - ); -}; - -const getStyles = () => ({ - legend: css({ - div: { - justifyContent: 'flex-start', - }, - }), -}); diff --git a/public/app/plugins/panel/xychart/v2/XYChartTooltip.tsx b/public/app/plugins/panel/xychart/v2/XYChartTooltip.tsx deleted file mode 100644 index 8976c807278..00000000000 --- a/public/app/plugins/panel/xychart/v2/XYChartTooltip.tsx +++ /dev/null @@ -1,111 +0,0 @@ -import { ReactNode } from 'react'; - -import { DataFrame, InterpolateFunction } from '@grafana/data'; -import { alpha } from '@grafana/data/src/themes/colorManipulator'; -import { VizTooltipContent } from '@grafana/ui/src/components/VizTooltip/VizTooltipContent'; -import { VizTooltipFooter } from '@grafana/ui/src/components/VizTooltip/VizTooltipFooter'; -import { VizTooltipHeader } from '@grafana/ui/src/components/VizTooltip/VizTooltipHeader'; -import { VizTooltipWrapper } from '@grafana/ui/src/components/VizTooltip/VizTooltipWrapper'; -import { ColorIndicator, VizTooltipItem } from '@grafana/ui/src/components/VizTooltip/types'; - -import { getDataLinks, getFieldActions } from '../../status-history/utils'; - -import { XYSeries } from './types2'; -import { fmt } from './utils'; - -export interface Props { - dataIdxs: Array- {props.options.tooltip.mode !== TooltipDisplayMode.None && ( - - )} -{ - return ( - - ); - }} - maxWidth={props.options.tooltip.maxWidth} - /> - )} - ; - seriesIdx: number | null | undefined; - isPinned: boolean; - dismiss: () => void; - data: DataFrame[]; - xySeries: XYSeries[]; - replaceVariables: InterpolateFunction; -} - -function stripSeriesName(fieldName: string, seriesName: string) { - if (fieldName !== seriesName && fieldName.includes(' ')) { - fieldName = fieldName.replace(seriesName, '').trim(); - } - - return fieldName; -} - -export const XYChartTooltip = ({ dataIdxs, seriesIdx, data, xySeries, dismiss, isPinned, replaceVariables }: Props) => { - const rowIndex = dataIdxs.find((idx) => idx !== null)!; - - const series = xySeries[seriesIdx! - 1]; - const xField = series.x.field; - const yField = series.y.field; - - const sizeField = series.size.field; - const colorField = series.color.field; - - let label = series.name.value; - - let seriesColor = series.color.fixed; - // let colorField = series.color.field; - // let pointColor: string; - - // if (colorField != null) { - // pointColor = colorField.display?.(colorField.values[rowIndex]).color!; - // } - - const headerItem: VizTooltipItem = { - label, - value: '', - color: alpha(seriesColor ?? '#fff', 0.5), - colorIndicator: ColorIndicator.marker_md, - }; - - const contentItems: VizTooltipItem[] = [ - { - label: stripSeriesName(xField.state?.displayName ?? xField.name, label), - value: fmt(xField, xField.values[rowIndex]), - }, - { - label: stripSeriesName(yField.state?.displayName ?? yField.name, label), - value: fmt(yField, yField.values[rowIndex]), - }, - ]; - - // mapped fields for size/color - if (sizeField != null && sizeField !== yField) { - contentItems.push({ - label: stripSeriesName(sizeField.state?.displayName ?? sizeField.name, label), - value: fmt(sizeField, sizeField.values[rowIndex]), - }); - } - - if (colorField != null && colorField !== yField) { - contentItems.push({ - label: stripSeriesName(colorField.state?.displayName ?? colorField.name, label), - value: fmt(colorField, colorField.values[rowIndex]), - }); - } - - series._rest.forEach((field) => { - contentItems.push({ - label: stripSeriesName(field.state?.displayName ?? field.name, label), - value: fmt(field, field.values[rowIndex]), - }); - }); - - let footer: ReactNode; - - if (isPinned && seriesIdx != null) { - const links = getDataLinks(yField, rowIndex); - const yFieldFrame = data.find((frame) => frame.fields.includes(yField))!; - const actions = getFieldActions(yFieldFrame, yField, replaceVariables, rowIndex); - - footer = ; - } - - return ( - - - ); -}; diff --git a/public/app/plugins/panel/xychart/v2/config.ts b/public/app/plugins/panel/xychart/v2/config.ts deleted file mode 100644 index 41a157a68a6..00000000000 --- a/public/app/plugins/panel/xychart/v2/config.ts +++ /dev/null @@ -1,166 +0,0 @@ -import { - FieldColorModeId, - FieldConfigProperty, - FieldType, - identityOverrideProcessor, - SetFieldConfigOptionsArgs, -} from '@grafana/data'; -import { LineStyle } from '@grafana/schema'; -import { commonOptionsBuilder } from '@grafana/ui'; - -import { LineStyleEditor } from '../../timeseries/LineStyleEditor'; - -import { FieldConfig, XYShowMode, PointShape } from './panelcfg.gen'; - -export const DEFAULT_POINT_SIZE = 5; - -export function getScatterFieldConfig(cfg: FieldConfig): SetFieldConfigOptionsArgs- - {footer} - { - return { - standardOptions: { - [FieldConfigProperty.Min]: { - hideFromDefaults: true, - }, - [FieldConfigProperty.Max]: { - hideFromDefaults: true, - }, - [FieldConfigProperty.Unit]: { - hideFromDefaults: true, - }, - [FieldConfigProperty.Decimals]: { - hideFromDefaults: true, - }, - [FieldConfigProperty.NoValue]: { - hideFromDefaults: true, - }, - [FieldConfigProperty.DisplayName]: { - hideFromDefaults: true, - }, - - // TODO: this still leaves Color series by: [ Last | Min | Max ] - // because item.settings?.bySeriesSupport && colorMode.isByValue - [FieldConfigProperty.Color]: { - settings: { - byValueSupport: true, - bySeriesSupport: true, - preferThresholdsMode: false, - }, - defaultValue: { - mode: FieldColorModeId.PaletteClassic, - }, - }, - }, - - useCustomConfig: (builder) => { - builder - .addRadio({ - path: 'show', - name: 'Show', - defaultValue: cfg.show, - settings: { - options: [ - { label: 'Points', value: XYShowMode.Points }, - { label: 'Lines', value: XYShowMode.Lines }, - { label: 'Both', value: XYShowMode.PointsAndLines }, - ], - }, - }) - // .addGenericEditor( - // { - // path: 'pointSymbol', - // name: 'Point symbol', - // defaultValue: defaultFieldConfig.pointSymbol ?? { - // mode: 'fixed', - // fixed: 'img/icons/marker/circle.svg', - // }, - // settings: { - // resourceType: MediaType.Icon, - // folderName: ResourceFolderName.Marker, - // placeholderText: 'Select a symbol', - // placeholderValue: 'img/icons/marker/circle.svg', - // showSourceRadio: false, - // }, - // showIf: (c) => c.show !== ScatterShow.Lines, - // }, - // SymbolEditor // ResourceDimensionEditor - // ) - .addSliderInput({ - path: 'pointSize.fixed', - name: 'Point size', - defaultValue: cfg.pointSize?.fixed ?? DEFAULT_POINT_SIZE, - settings: { - min: 1, - max: 100, - step: 1, - }, - showIf: (c) => c.show !== XYShowMode.Lines, - }) - .addNumberInput({ - path: 'pointSize.min', - name: 'Min point size', - showIf: (c) => c.show !== XYShowMode.Lines, - }) - .addNumberInput({ - path: 'pointSize.max', - name: 'Max point size', - showIf: (c) => c.show !== XYShowMode.Lines, - }) - .addRadio({ - path: 'pointShape', - name: 'Point shape', - defaultValue: PointShape.Circle, - settings: { - options: [ - { value: PointShape.Circle, label: 'Circle' }, - { value: PointShape.Square, label: 'Square' }, - ], - }, - showIf: (c) => c.show !== XYShowMode.Lines, - }) - .addSliderInput({ - path: 'pointStrokeWidth', - name: 'Point stroke width', - defaultValue: 1, - settings: { - min: 0, - max: 10, - }, - showIf: (c) => c.show !== XYShowMode.Lines, - }) - .addSliderInput({ - path: 'fillOpacity', - name: 'Fill opacity', - defaultValue: 50, - settings: { - min: 0, - max: 100, - step: 1, - }, - showIf: (c) => c.show !== XYShowMode.Lines, - }) - .addCustomEditor = { - id: '', -}; - -export interface FieldConfig extends common.HideableFieldConfig, common.AxisConfig { - fillOpacity?: number; - lineStyle?: common.LineStyle; - lineWidth?: number; - pointShape?: PointShape; - pointSize?: { - fixed?: number; - min?: number; - max?: number; - }; - pointStrokeWidth?: number; - show?: XYShowMode; -} - -export const defaultFieldConfig: Partial = { - fillOpacity: 50, - show: XYShowMode.Points, -}; - -export interface XYSeriesConfig { - color?: { - matcher: MatcherConfig; - }; - frame?: { - matcher: MatcherConfig; - }; - name?: { - fixed?: string; - }; - size?: { - matcher: MatcherConfig; - }; - x?: { - matcher: MatcherConfig; - }; - y?: { - matcher: MatcherConfig; - }; -} - -export interface Options extends common.OptionsWithLegend, common.OptionsWithTooltip { - mapping: SeriesMapping; - series: Array ; -} - -export const defaultOptions: Partial = { - series: [], -}; diff --git a/public/app/plugins/panel/xychart/v2/plugin.json b/public/app/plugins/panel/xychart/v2/plugin.json deleted file mode 100644 index 13721d65fb0..00000000000 --- a/public/app/plugins/panel/xychart/v2/plugin.json +++ /dev/null @@ -1,19 +0,0 @@ -{ - "type": "panel", - "name": "XY Chart", - "id": "xychart", - "state": "beta", - - "info": { - "description": "Supports arbitrary X vs Y in a graph to visualize the relationship between two variables.", - "keywords": ["scatter", "plot"], - "author": { - "name": "Grafana Labs", - "url": "https://grafana.com" - }, - "logos": { - "small": "img/icn-xychart.svg", - "large": "img/icn-xychart.svg" - } - } -} diff --git a/public/app/plugins/panel/xychart/v2/scatter.ts b/public/app/plugins/panel/xychart/v2/scatter.ts deleted file mode 100644 index 904d35ec73a..00000000000 --- a/public/app/plugins/panel/xychart/v2/scatter.ts +++ /dev/null @@ -1,689 +0,0 @@ -import tinycolor from 'tinycolor2'; -import uPlot from 'uplot'; - -import { - FALLBACK_COLOR, - Field, - FieldType, - formattedValueToString, - getFieldColorModeForField, - GrafanaTheme2, - MappingType, - SpecialValueMatch, - ThresholdsMode, -} from '@grafana/data'; -import { alpha } from '@grafana/data/src/themes/colorManipulator'; -import { AxisPlacement, FieldColorModeId, ScaleDirection, ScaleOrientation, VisibilityMode } from '@grafana/schema'; -import { UPlotConfigBuilder } from '@grafana/ui'; -import { FacetedData, FacetSeries } from '@grafana/ui/src/components/uPlot/types'; - -import { pointWithin, Quadtree, Rect } from '../../barchart/quadtree'; -import { valuesToFills } from '../../heatmap/utils'; - -import { PointShape } from './panelcfg.gen'; -import { XYSeries } from './types2'; -import { getCommonPrefixSuffix } from './utils'; - -interface DrawBubblesOpts { - each: (u: uPlot, seriesIdx: number, dataIdx: number, lft: number, top: number, wid: number, hgt: number) => void; - disp: { - //unit: 3, - size: { - values: (u: uPlot, seriesIdx: number) => number[]; - }; - color: { - values: (u: uPlot, seriesIdx: number) => string[]; - }; - }; -} - -export const prepConfig = (xySeries: XYSeries[], theme: GrafanaTheme2) => { - if (xySeries.length === 0) { - return { builder: null, prepData: () => [] }; - } - - let qt: Quadtree; - let hRect: Rect | null; - - function drawBubblesFactory(opts: DrawBubblesOpts) { - const drawBubbles: uPlot.Series.PathBuilder = (u, seriesIdx, idx0, idx1) => { - uPlot.orient( - u, - seriesIdx, - ( - series, - dataX, - dataY, - scaleX, - scaleY, - valToPosX, - valToPosY, - xOff, - yOff, - xDim, - yDim, - moveTo, - lineTo, - rect, - arc - ) => { - const pxRatio = uPlot.pxRatio; - const scatterInfo = xySeries[seriesIdx - 1]; - let d = u.data[seriesIdx] as unknown as FacetSeries; - - // showLine: boolean; - // lineStyle: common.LineStyle; - // showPoints: common.VisibilityMode; - - let showLine = scatterInfo.showLine; - let showPoints = scatterInfo.showPoints === VisibilityMode.Always; - let strokeWidth = scatterInfo.pointStrokeWidth ?? 0; - - u.ctx.save(); - - u.ctx.rect(u.bbox.left, u.bbox.top, u.bbox.width, u.bbox.height); - u.ctx.clip(); - - let pointAlpha = scatterInfo.fillOpacity / 100; - - u.ctx.fillStyle = alpha((series.fill as any)(), pointAlpha); - u.ctx.strokeStyle = alpha((series.stroke as any)(), 1); - u.ctx.lineWidth = strokeWidth; - - let deg360 = 2 * Math.PI; - - let xKey = scaleX.key!; - let yKey = scaleY.key!; - - //const colorMode = getFieldColorModeForField(field); // isByValue - const pointSize = scatterInfo.y.field.config.custom.pointSize; - const colorByValue = scatterInfo.color.field != null; // && colorMode.isByValue; - - let maxSize = (pointSize.max ?? pointSize.fixed) * pxRatio; - - // todo: this depends on direction & orientation - // todo: calc once per redraw, not per path - let filtLft = u.posToVal(-maxSize / 2, xKey); - let filtRgt = u.posToVal(u.bbox.width / pxRatio + maxSize / 2, xKey); - let filtBtm = u.posToVal(u.bbox.height / pxRatio + maxSize / 2, yKey); - let filtTop = u.posToVal(-maxSize / 2, yKey); - - let sizes = opts.disp.size.values(u, seriesIdx); - // let pointColors = opts.disp.color.values(u, seriesIdx); - let pointColors = dispColors[seriesIdx - 1].values; // idxs - let pointPalette = dispColors[seriesIdx - 1].index as Array -++{/* Sidecar */} - {activePluginId && ( + {sidecarOpen && ( <>-diff --git a/public/app/routes/routes.tsx b/public/app/routes/routes.tsx index a3a88ca83b8..3543f334cdf 100644 --- a/public/app/routes/routes.tsx +++ b/public/app/routes/routes.tsx @@ -19,7 +19,6 @@ import { getAppPluginRoutes } from 'app/features/plugins/routes'; import { getProfileRoutes } from 'app/features/profile/routes'; import { AccessControlAction, DashboardRoutes } from 'app/types'; -import { BookmarksPage } from '../core/components/Bookmarks/BookmarksPage'; import { SafeDynamicImport } from '../core/components/DynamicImports/SafeDynamicImport'; import { RouteDescriptor } from '../core/navigation/types'; import { getPublicDashboardRoutes } from '../features/dashboard/routes'; @@ -530,7 +529,9 @@ export function getAppRoutes(): RouteDescriptor[] { }, { path: '/bookmarks', - component: () =>- + + @@ -115,11 +113,13 @@ export function ExperimentalSplitPaneRouterWrapper(props: RouterWrapperProps) { style={{ margin: '8px' }} name={'times'} aria-label={'close'} - onClick={() => closeApp(activePluginId)} + onClick={() => closeApp()} />-+ {/*We don't render anything other than app plugin but we want to keep the same routing layout so*/} + {/*there are is no difference with matching relative routes between main and sidecar view.*/} + {props.routes} , + component: SafeDynamicImport( + () => import(/* webpackChunkName: "BookmarksPage"*/ 'app/features/bookmarks/BookmarksPage') + ), }, ...getPluginCatalogRoutes(), ...getSupportBundleRoutes(), diff --git a/public/app/routes/utils.ts b/public/app/routes/utils.ts index 1680f11e55d..745776d76d9 100644 --- a/public/app/routes/utils.ts +++ b/public/app/routes/utils.ts @@ -1,6 +1,3 @@ -import * as H from 'history'; -import { pick } from 'lodash'; - import { NavLinkDTO } from '@grafana/data'; export function isSoloRoute(path: string): boolean { @@ -15,85 +12,3 @@ export function pluginHasRootPage(pluginId: string, navTree: NavLinkDTO[]): bool ?.children?.some((page) => page.url?.endsWith(`/a/${pluginId}`)) ); } - -type LocalStorageHistoryOptions = { - storageKey: string; -}; - -/** - * Simple wrapper over the memory history that persists the location in the localStorage. - * @param options - */ -export function createLocationStorageHistory(options: LocalStorageHistoryOptions): H.MemoryHistory { - const storedLocation = localStorage.getItem(options.storageKey); - const initialEntry = storedLocation ? JSON.parse(storedLocation) : '/'; - - const memoryHistory = H.createMemoryHistory({ initialEntries: [initialEntry] }); - - // We have to check whether location was actually changed by this way because the function don't actually offer - // a return value that would tell us whether the change was successful or not and there are a few ways where the - // actual location change could be blocked. - let currentLocation = memoryHistory.location; - function maybeUpdateLocation() { - if (memoryHistory.location !== currentLocation) { - localStorage.setItem( - options.storageKey, - JSON.stringify(pick(memoryHistory.location, 'pathname', 'search', 'hash')) - ); - currentLocation = memoryHistory.location; - } - } - - // This creates a sort of proxy over the memory location just to add the localStorage persistence. We could achieve - // the same effect by a listener but that would create a memory leak as there would be no reasonable way to - // unsubcribe the listener later on. - return { - get index() { - return memoryHistory.index; - }, - get entries() { - return memoryHistory.entries; - }, - canGo(n: number) { - return memoryHistory.canGo(n); - }, - get length() { - return memoryHistory.length; - }, - get action() { - return memoryHistory.action; - }, - get location() { - return memoryHistory.location; - }, - push(location: H.Path | H.LocationDescriptor , state?: H.LocationState) { - memoryHistory.push(location, state); - maybeUpdateLocation(); - }, - replace(location: H.Path | H.LocationDescriptor , state?: H.LocationState) { - memoryHistory.replace(location, state); - maybeUpdateLocation(); - }, - go(n: number) { - memoryHistory.go(n); - maybeUpdateLocation(); - }, - goBack() { - memoryHistory.goBack(); - maybeUpdateLocation(); - }, - goForward() { - memoryHistory.goForward(); - maybeUpdateLocation(); - }, - block(prompt?: boolean | string | H.TransitionPromptHook ) { - return memoryHistory.block(prompt); - }, - listen(listener: H.LocationListener ) { - return memoryHistory.listen(listener); - }, - createHref(location: H.LocationDescriptorObject ) { - return memoryHistory.createHref(location); - }, - }; -} diff --git a/public/app/types/accessControl.ts b/public/app/types/accessControl.ts index 01f5b4e1f6b..4ae6fcfda75 100644 --- a/public/app/types/accessControl.ts +++ b/public/app/types/accessControl.ts @@ -134,6 +134,10 @@ export enum AccessControlAction { AlertingReceiversWrite = 'alert.notifications.receivers:write', AlertingReceiversRead = 'alert.notifications.receivers:read', + // Alerting time intervals actions + AlertingTimeIntervalsRead = 'alert.notifications.time-intervals:read', + AlertingTimeIntervalsWrite = 'alert.notifications.time-intervals:write', + // Alerting templates actions AlertingTemplatesRead = 'alert.notifications.templates:read', AlertingTemplatesWrite = 'alert.notifications.templates:write', diff --git a/public/emails/passwordless_verify_existing_user.html b/public/emails/passwordless_verify_existing_user.html new file mode 100644 index 00000000000..fca20f91c71 --- /dev/null +++ b/public/emails/passwordless_verify_existing_user.html @@ -0,0 +1,273 @@ + + + + + {{ Subject .Subject .TemplateData "Verify your email" }} + + + + + + + + + + + + + + + + + + ++ ++ + + diff --git a/public/emails/passwordless_verify_existing_user.txt b/public/emails/passwordless_verify_existing_user.txt new file mode 100644 index 00000000000..18a13b74480 --- /dev/null +++ b/public/emails/passwordless_verify_existing_user.txt @@ -0,0 +1,12 @@ +[[HiddenSubject .Subject "Verify your email"]] + +Hi, + +Copy and paste the confirmation code in the login form to verify your email address. + +Copy and paste the email verification code: +[[.ConfirmationCode]] +in the in the login form to verify your email address. This confirmation code will expire in {{ .Expire }} minutes. +Alternatively, you can use the button below to verify your email address. + +[[.AppUrl]]login/?code=[[.Code]]&confirmationCode=[[.ConfirmationCode]] diff --git a/public/emails/passwordless_verify_new_user.html b/public/emails/passwordless_verify_new_user.html new file mode 100644 index 00000000000..d6c04cfa58b --- /dev/null +++ b/public/emails/passwordless_verify_new_user.html @@ -0,0 +1,273 @@ + + + + +++ ++ +
++ + ++ + +++ ++ +
++ + ++ ++ +
++ + ++ +
+ ++ ++ +
++ + ++ + +++ ++ +
++ + ++ + +++ ++ +
++ ++ +++Please verify your email
++ + ++ +Copy and paste the confirmation code in the login form to verify your email address. This confirmation code will expire in {{ .Expire }} minutes.+++ ++ +
++ + ++ + +++ ++ +
++ + ++ +{{ .ConfirmationCode }}+++ ++ +
++ + ++ + +++ ++ +
++ ++ +Alternatively, you can use the button below to verify your email address.++ ++ ++ +
++ + ++ Verify your email + ++ ++ +You can also copy and paste this link into your browser directly:++ + ++ + +++ ++ +
++ + ++ + +++ ++ +
++ + ++ +© {{ now | date "2006" }} Grafana Labs. Sent by Grafana v{{ .BuildVersion }}.+{{ Subject .Subject .TemplateData "Welcome to Grafana, please complete your sign up!" }} + + + + + + + + + + + + + + + + + + ++ ++ + + diff --git a/public/emails/passwordless_verify_new_user.txt b/public/emails/passwordless_verify_new_user.txt new file mode 100644 index 00000000000..9ea5b80c931 --- /dev/null +++ b/public/emails/passwordless_verify_new_user.txt @@ -0,0 +1,12 @@ +[[HiddenSubject .Subject "Welcome to Grafana, please complete your signup!"]] + +Hi, + +Copy and paste the confirmation code in the login form to verify your email address. + +Copy and paste the email verification code: +[[.ConfirmationCode]] +in the in the login form to verify your email address. This confirmation code will expire in {{ .Expire }} minutes. +Alternatively, you can use the button below to verify your email address. + +[[.AppUrl]]login/?code=[[.Code]]&confirmationCode=[[.ConfirmationCode]] diff --git a/public/locales/de-DE/grafana.json b/public/locales/de-DE/grafana.json index d0015279be0..f8ab3710cfd 100644 --- a/public/locales/de-DE/grafana.json +++ b/public/locales/de-DE/grafana.json @@ -137,7 +137,6 @@ "export-all": "", "view": "" }, - "contact-point": "", "contact-points": { "create": "", "custom-template-value": "", @@ -155,6 +154,7 @@ }, "last-delivery-attempt": "", "last-delivery-failed": "", + "no-contact-points-found": "", "no-delivery-attempts": "", "no-integrations": "", "only-firing": "", @@ -455,7 +455,7 @@ "title": "" }, "custom-value": { - "create": "" + "label": "" }, "options": { "no-found": "" @@ -1459,6 +1459,14 @@ }, "forgot-password": "Passwort vergessen?", "form": { + "confirmation-code": "", + "confirmation-code-label": "", + "confirmation-code-placeholder": "", + "email-label": "", + "email-placeholder": "", + "email-required": "", + "name-label": "", + "name-placeholder": "", "password-label": "Passwort", "password-placeholder": "", "password-required": "Passwort ist erforderlich", @@ -1466,7 +1474,9 @@ "submit-loading-label": "Einloggen...", "username-label": "E-Mail oder Benutzername", "username-placeholder": "", - "username-required": "E-Mail oder Benutzername ist erforderlich" + "username-required": "E-Mail oder Benutzername ist erforderlich", + "verify-email-label": "", + "verify-email-loading-label": "" }, "services": { "sing-in-with-prefix": "Mit {{serviceName}} anmelden" diff --git a/public/locales/en-US/grafana.json b/public/locales/en-US/grafana.json index f014ea0f91b..2d0005e46dc 100644 --- a/public/locales/en-US/grafana.json +++ b/public/locales/en-US/grafana.json @@ -137,7 +137,6 @@ "export-all": "Export all", "view": "View" }, - "contact-point": "Contact Point", "contact-points": { "create": "Create contact point", "custom-template-value": "Custom template value", @@ -155,6 +154,7 @@ }, "last-delivery-attempt": "Last delivery attempt", "last-delivery-failed": "Last delivery attempt failed", + "no-contact-points-found": "No contact points found", "no-delivery-attempts": "No delivery attempts", "no-integrations": "No integrations configured", "only-firing": "Delivering <1>only firing notifications", @@ -455,7 +455,7 @@ "title": "Clear value" }, "custom-value": { - "create": "Create custom value" + "label": "Custom value: " }, "options": { "no-found": "No options found." @@ -1459,6 +1459,14 @@ }, "forgot-password": "Forgot your password?", "form": { + "confirmation-code": "Confirmation code is required", + "confirmation-code-label": "Confirmation code", + "confirmation-code-placeholder": "confirmation code", + "email-label": "Email", + "email-placeholder": "email", + "email-required": "Email is required", + "name-label": "Name", + "name-placeholder": "name", "password-label": "Password", "password-placeholder": "password", "password-required": "Password is required", @@ -1466,7 +1474,9 @@ "submit-loading-label": "Logging in...", "username-label": "Email or username", "username-placeholder": "email or username", - "username-required": "Email or username is required" + "username-required": "Email or username is required", + "verify-email-label": "Send a verification email", + "verify-email-loading-label": "Sending email..." }, "services": { "sing-in-with-prefix": "Sign in with {{serviceName}}" diff --git a/public/locales/es-ES/grafana.json b/public/locales/es-ES/grafana.json index 064c2400063..49dfe11e437 100644 --- a/public/locales/es-ES/grafana.json +++ b/public/locales/es-ES/grafana.json @@ -137,7 +137,6 @@ "export-all": "", "view": "" }, - "contact-point": "", "contact-points": { "create": "", "custom-template-value": "", @@ -155,6 +154,7 @@ }, "last-delivery-attempt": "", "last-delivery-failed": "", + "no-contact-points-found": "", "no-delivery-attempts": "", "no-integrations": "", "only-firing": "", @@ -455,7 +455,7 @@ "title": "" }, "custom-value": { - "create": "" + "label": "" }, "options": { "no-found": "" @@ -1459,6 +1459,14 @@ }, "forgot-password": "¿Has olvidado tu contraseña?", "form": { + "confirmation-code": "", + "confirmation-code-label": "", + "confirmation-code-placeholder": "", + "email-label": "", + "email-placeholder": "", + "email-required": "", + "name-label": "", + "name-placeholder": "", "password-label": "Contraseña", "password-placeholder": "", "password-required": "La contraseña es obligatoria", @@ -1466,7 +1474,9 @@ "submit-loading-label": "Iniciando sesión...", "username-label": "Correo o nombre de usuario", "username-placeholder": "", - "username-required": "El correo o el nombre de usuario es obligatorio" + "username-required": "El correo o el nombre de usuario es obligatorio", + "verify-email-label": "", + "verify-email-loading-label": "" }, "services": { "sing-in-with-prefix": "Iniciar sesión con {{serviceName}}" diff --git a/public/locales/fr-FR/grafana.json b/public/locales/fr-FR/grafana.json index 6fed2945c2a..0eb4f7abae5 100644 --- a/public/locales/fr-FR/grafana.json +++ b/public/locales/fr-FR/grafana.json @@ -137,7 +137,6 @@ "export-all": "", "view": "" }, - "contact-point": "", "contact-points": { "create": "", "custom-template-value": "", @@ -155,6 +154,7 @@ }, "last-delivery-attempt": "", "last-delivery-failed": "", + "no-contact-points-found": "", "no-delivery-attempts": "", "no-integrations": "", "only-firing": "", @@ -455,7 +455,7 @@ "title": "" }, "custom-value": { - "create": "" + "label": "" }, "options": { "no-found": "" @@ -1459,6 +1459,14 @@ }, "forgot-password": "Vous avez oublié votre mot de passe ?", "form": { + "confirmation-code": "", + "confirmation-code-label": "", + "confirmation-code-placeholder": "", + "email-label": "", + "email-placeholder": "", + "email-required": "", + "name-label": "", + "name-placeholder": "", "password-label": "Mot de passe", "password-placeholder": "", "password-required": "Vous devez renseigner le mot de passe", @@ -1466,7 +1474,9 @@ "submit-loading-label": "Connexion…", "username-label": "E-mail ou nom d'utilisateur", "username-placeholder": "", - "username-required": "Vous devez renseigner l'e-mail ou le nom d'utilisateur" + "username-required": "Vous devez renseigner l'e-mail ou le nom d'utilisateur", + "verify-email-label": "", + "verify-email-loading-label": "" }, "services": { "sing-in-with-prefix": "Se connecter avec {{serviceName}}" diff --git a/public/locales/pseudo-LOCALE/grafana.json b/public/locales/pseudo-LOCALE/grafana.json index bc936363a98..4be0ea99904 100644 --- a/public/locales/pseudo-LOCALE/grafana.json +++ b/public/locales/pseudo-LOCALE/grafana.json @@ -137,7 +137,6 @@ "export-all": "Ēχpőřŧ äľľ", "view": "Vįęŵ" }, - "contact-point": "Cőʼnŧäčŧ Pőįʼnŧ", "contact-points": { "create": "Cřęäŧę čőʼnŧäčŧ pőįʼnŧ", "custom-template-value": "Cūşŧőm ŧęmpľäŧę väľūę", @@ -155,6 +154,7 @@ }, "last-delivery-attempt": "Ŀäşŧ đęľįvęřy äŧŧęmpŧ", "last-delivery-failed": "Ŀäşŧ đęľįvęřy äŧŧęmpŧ ƒäįľęđ", + "no-contact-points-found": "Ńő čőʼnŧäčŧ pőįʼnŧş ƒőūʼnđ", "no-delivery-attempts": "Ńő đęľįvęřy äŧŧęmpŧş", "no-integrations": "Ńő įʼnŧęģřäŧįőʼnş čőʼnƒįģūřęđ", "only-firing": "Đęľįvęřįʼnģ <1>őʼnľy ƒįřįʼnģ ʼnőŧįƒįčäŧįőʼnş", @@ -455,7 +455,7 @@ "title": "Cľęäř väľūę" }, "custom-value": { - "create": "Cřęäŧę čūşŧőm väľūę" + "label": "Cūşŧőm väľūę: " }, "options": { "no-found": "Ńő őpŧįőʼnş ƒőūʼnđ." @@ -1459,6 +1459,14 @@ }, "forgot-password": "Főřģőŧ yőūř päşşŵőřđ?", "form": { + "confirmation-code": "Cőʼnƒįřmäŧįőʼn čőđę įş řęqūįřęđ", + "confirmation-code-label": "Cőʼnƒįřmäŧįőʼn čőđę", + "confirmation-code-placeholder": "čőʼnƒįřmäŧįőʼn čőđę", + "email-label": "Ēmäįľ", + "email-placeholder": "ęmäįľ", + "email-required": "Ēmäįľ įş řęqūįřęđ", + "name-label": "Ńämę", + "name-placeholder": "ʼnämę", "password-label": "Päşşŵőřđ", "password-placeholder": "päşşŵőřđ", "password-required": "Päşşŵőřđ įş řęqūįřęđ", @@ -1466,7 +1474,9 @@ "submit-loading-label": "Ŀőģģįʼnģ įʼn...", "username-label": "Ēmäįľ őř ūşęřʼnämę", "username-placeholder": "ęmäįľ őř ūşęřʼnämę", - "username-required": "Ēmäįľ őř ūşęřʼnämę įş řęqūįřęđ" + "username-required": "Ēmäįľ őř ūşęřʼnämę įş řęqūįřęđ", + "verify-email-label": "Ŝęʼnđ ä vęřįƒįčäŧįőʼn ęmäįľ", + "verify-email-loading-label": "Ŝęʼnđįʼnģ ęmäįľ..." }, "services": { "sing-in-with-prefix": "Ŝįģʼn įʼn ŵįŧĥ {{serviceName}}" diff --git a/public/locales/pt-BR/grafana.json b/public/locales/pt-BR/grafana.json index 8862f24545f..51f5e606ca7 100644 --- a/public/locales/pt-BR/grafana.json +++ b/public/locales/pt-BR/grafana.json @@ -137,7 +137,6 @@ "export-all": "", "view": "" }, - "contact-point": "", "contact-points": { "create": "", "custom-template-value": "", @@ -155,6 +154,7 @@ }, "last-delivery-attempt": "", "last-delivery-failed": "", + "no-contact-points-found": "", "no-delivery-attempts": "", "no-integrations": "", "only-firing": "", @@ -455,7 +455,7 @@ "title": "" }, "custom-value": { - "create": "" + "label": "" }, "options": { "no-found": "" @@ -1459,6 +1459,14 @@ }, "forgot-password": "Esqueceu sua senha?", "form": { + "confirmation-code": "", + "confirmation-code-label": "", + "confirmation-code-placeholder": "", + "email-label": "", + "email-placeholder": "", + "email-required": "", + "name-label": "", + "name-placeholder": "", "password-label": "Senha", "password-placeholder": "", "password-required": "A senha é obrigatória", @@ -1466,7 +1474,9 @@ "submit-loading-label": "Fazendo login...", "username-label": "E-mail ou nome de usuário", "username-placeholder": "", - "username-required": "O e-mail ou nome de usuário é obrigatório" + "username-required": "O e-mail ou nome de usuário é obrigatório", + "verify-email-label": "", + "verify-email-loading-label": "" }, "services": { "sing-in-with-prefix": "Fazer login com {{serviceName}}" diff --git a/public/locales/zh-Hans/grafana.json b/public/locales/zh-Hans/grafana.json index 244d087dc88..e9cdca18209 100644 --- a/public/locales/zh-Hans/grafana.json +++ b/public/locales/zh-Hans/grafana.json @@ -137,7 +137,6 @@ "export-all": "", "view": "" }, - "contact-point": "", "contact-points": { "create": "", "custom-template-value": "", @@ -155,6 +154,7 @@ }, "last-delivery-attempt": "", "last-delivery-failed": "", + "no-contact-points-found": "", "no-delivery-attempts": "", "no-integrations": "", "only-firing": "", @@ -446,7 +446,7 @@ "title": "" }, "custom-value": { - "create": "" + "label": "" }, "options": { "no-found": "" @@ -1449,6 +1449,14 @@ }, "forgot-password": "忘记密码？", "form": { + "confirmation-code": "", + "confirmation-code-label": "", + "confirmation-code-placeholder": "", + "email-label": "", + "email-placeholder": "", + "email-required": "", + "name-label": "", + "name-placeholder": "", "password-label": "密码", "password-placeholder": "", "password-required": "必须输入密码", @@ -1456,7 +1464,9 @@ "submit-loading-label": "正在登录...", "username-label": "电子邮箱或用户名", "username-placeholder": "", - "username-required": "电子邮箱或用户名是必填项" + "username-required": "电子邮箱或用户名是必填项", + "verify-email-label": "", + "verify-email-loading-label": "" }, "services": { "sing-in-with-prefix": "使用 {{serviceName}} 登录" diff --git a/public/openapi3.json b/public/openapi3.json index 51429db556e..67c19b89eae 100644 --- a/public/openapi3.json +++ b/public/openapi3.json @@ -9624,6 +9624,9 @@ "branding": { "$ref": "#/components/schemas/ReportBrandingOptions" }, + "embeddedImageTheme": { + "type": "string" + }, "id": { "format": "int64", "type": "integer" @@ -9632,6 +9635,9 @@ "format": "int64", "type": "integer" }, + "pdfTheme": { + "type": "string" + }, "userId": { "format": "int64", "type": "integer" diff --git a/scripts/webpack/sass.rule.js b/scripts/webpack/sass.rule.js index 7843e15749a..9ca29cde4af 100644 --- a/scripts/webpack/sass.rule.js +++ b/scripts/webpack/sass.rule.js @@ -34,6 +34,10 @@ module.exports = function (options) { loader: 'sass-loader', options: { sourceMap: options.sourceMap, + sassOptions: { + // silencing these warnings since we're planning to remove sass when angular is gone + silenceDeprecations: ['import', 'global-builtin'], + }, }, }, ], diff --git a/yarn.lock b/yarn.lock index 7f27e129d50..6810e628334 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1507,7 +1507,7 @@ __metadata: languageName: node linkType: hard -"@babel/runtime@npm:7.26.0, @babel/runtime@npm:^7.0.0, @babel/runtime@npm:^7.1.2, @babel/runtime@npm:^7.10.1, @babel/runtime@npm:^7.11.1, @babel/runtime@npm:^7.11.2, @babel/runtime@npm:^7.12.0, @babel/runtime@npm:^7.12.1, @babel/runtime@npm:^7.12.13, @babel/runtime@npm:^7.12.5, @babel/runtime@npm:^7.13.10, @babel/runtime@npm:^7.14.0, @babel/runtime@npm:^7.16.3, @babel/runtime@npm:^7.17.8, @babel/runtime@npm:^7.18.0, @babel/runtime@npm:^7.18.3, @babel/runtime@npm:^7.20.0, @babel/runtime@npm:^7.20.7, @babel/runtime@npm:^7.23.2, @babel/runtime@npm:^7.23.9, @babel/runtime@npm:^7.24.1, @babel/runtime@npm:^7.24.5, @babel/runtime@npm:^7.25.6, @babel/runtime@npm:^7.3.1, @babel/runtime@npm:^7.5.5, @babel/runtime@npm:^7.7.6, @babel/runtime@npm:^7.8.4, @babel/runtime@npm:^7.8.7": +"@babel/runtime@npm:7.26.0, @babel/runtime@npm:^7.0.0, @babel/runtime@npm:^7.1.2, @babel/runtime@npm:^7.10.1, @babel/runtime@npm:^7.11.1, @babel/runtime@npm:^7.11.2, @babel/runtime@npm:^7.12.0, @babel/runtime@npm:^7.12.1, @babel/runtime@npm:^7.12.13, @babel/runtime@npm:^7.12.5, @babel/runtime@npm:^7.13.10, @babel/runtime@npm:^7.14.0, @babel/runtime@npm:^7.16.3, @babel/runtime@npm:^7.17.8, @babel/runtime@npm:^7.18.0, @babel/runtime@npm:^7.18.3, @babel/runtime@npm:^7.20.0, @babel/runtime@npm:^7.20.7, @babel/runtime@npm:^7.23.2, @babel/runtime@npm:^7.23.9, @babel/runtime@npm:^7.24.1, @babel/runtime@npm:^7.24.5, @babel/runtime@npm:^7.25.6, @babel/runtime@npm:^7.25.7, @babel/runtime@npm:^7.3.1, @babel/runtime@npm:^7.5.5, @babel/runtime@npm:^7.7.6, @babel/runtime@npm:^7.8.4, @babel/runtime@npm:^7.8.7": version: 7.26.0 resolution: "@babel/runtime@npm:7.26.0" dependencies: @@ -1712,12 +1712,12 @@ __metadata: languageName: node linkType: hard -"@bundled-es-modules/cookie@npm:^2.0.0": - version: 2.0.0 - resolution: "@bundled-es-modules/cookie@npm:2.0.0" +"@bundled-es-modules/cookie@npm:^2.0.1": + version: 2.0.1 + resolution: "@bundled-es-modules/cookie@npm:2.0.1" dependencies: - cookie: "npm:^0.5.0" - checksum: 10/c8ef02aa5d3f6c786cfa407e1c93b4af29c600eb09990973f47a7a49e4771c1bec37c8f8e567638bb9cbc41f4e38d065ff1d8eaf9bf91f0c3613a6d60bc82c8c + cookie: "npm:^0.7.2" + checksum: 10/0038a5e82c41bfcd722afedabeb6961a5f15747b3681d7f4b61e35eb1e33130039e10ee9250dc9c9e4d3915ce1aeee717c0fb92225111574f0a030411abc0987 languageName: node linkType: hard @@ -2773,14 +2773,14 @@ __metadata: linkType: hard "@eslint/compat@npm:^1.2.0": - version: 1.2.2 - resolution: "@eslint/compat@npm:1.2.2" + version: 1.2.3 + resolution: "@eslint/compat@npm:1.2.3" peerDependencies: eslint: ^9.10.0 peerDependenciesMeta: eslint: optional: true - checksum: 10/81648b00e0b629de43d9aece18bb683340684a02f2cf1df2672bf3b16531371ce11492a106d0fb18e91b2bb3af97885e0209f8cefc520e62a872d0730cf7bfee + checksum: 10/5a8fc6ecb127a1ce757c2b94e4a71fd72939c3e9007eb80c0a819618e1c7cc98ffe3e5229a504c52e6f5b5dc0f6be3b899fa6a3dedb220cb4a02c8d5d0c333df languageName: node linkType: hard @@ -2891,7 +2891,7 @@ __metadata: languageName: node linkType: hard -"@floating-ui/react-dom@npm:^2.1.0, @floating-ui/react-dom@npm:^2.1.2": +"@floating-ui/react-dom@npm:^2.1.2": version: 2.1.2 resolution: "@floating-ui/react-dom@npm:2.1.2" dependencies: @@ -2903,23 +2903,9 @@ __metadata: languageName: node linkType: hard -"@floating-ui/react@npm:0.26.16": - version: 0.26.16 - resolution: "@floating-ui/react@npm:0.26.16" - dependencies: - "@floating-ui/react-dom": "npm:^2.1.0" - "@floating-ui/utils": "npm:^0.2.0" - tabbable: "npm:^6.0.0" - peerDependencies: - react: ">=16.8.0" - react-dom: ">=16.8.0" - checksum: 10/4d5216ba10c05f08a94730c0899578ead75a6cdfa9e531461e8d7ef7fea43d6b5818869c38a3c30c36f2e557c0af58b52b2325248d19029e2a89f34bfcc8c421 - languageName: node - linkType: hard - -"@floating-ui/react@npm:0.26.27": - version: 0.26.27 - resolution: "@floating-ui/react@npm:0.26.27" +"@floating-ui/react@npm:0.26.28, @floating-ui/react@npm:^0.26.16": + version: 0.26.28 + resolution: "@floating-ui/react@npm:0.26.28" dependencies: "@floating-ui/react-dom": "npm:^2.1.2" "@floating-ui/utils": "npm:^0.2.8" @@ -2927,7 +2913,7 @@ __metadata: peerDependencies: react: ">=16.8.0" react-dom: ">=16.8.0" - checksum: 10/ab6d05e5cc2c29272a6830c06dff07e8330f2b90234674f2d74ed8084659ebe3ac9472770a5f0e76007dd2ae89f9da75189d188437aea4b8ac2789afc21bb6b2 + checksum: 10/7f8e6b27db48b68ca94756687af21857be04e7360ac922d7c8e22411f2895df6384af7bd40f4b48663d3cc5809bb5c6574cd9c9ea15543ec747b9a8e1c8c3008 languageName: node linkType: hard @@ -3671,32 +3657,32 @@ __metadata: languageName: node linkType: hard -"@grafana/faro-core@npm:^1.11.0, @grafana/faro-core@npm:^1.3.6": - version: 1.11.0 - resolution: "@grafana/faro-core@npm:1.11.0" +"@grafana/faro-core@npm:^1.12.0, @grafana/faro-core@npm:^1.3.6": + version: 1.12.0 + resolution: "@grafana/faro-core@npm:1.12.0" dependencies: "@opentelemetry/api": "npm:^1.9.0" "@opentelemetry/otlp-transformer": "npm:^0.53.0" - checksum: 10/1f7983e2c5edd6c5f6835884c78e5c9ed016d0dd0ac113c7bc3d5d456b45f50f27ce6eb35a978bc89c1459f73ccf3f5ca434b32ae3d49cf9811caeca11eb434b + checksum: 10/beb747ad360263737e3576ad8d0dccab0828e538797032cf97eed4a3e1c31232750285afb4c3840de80bc25b17defb3ab75976c59622778131311548ebd86100 languageName: node linkType: hard -"@grafana/faro-web-sdk@npm:1.11.0, @grafana/faro-web-sdk@npm:^1.11.0, @grafana/faro-web-sdk@npm:^1.3.6": - version: 1.11.0 - resolution: "@grafana/faro-web-sdk@npm:1.11.0" +"@grafana/faro-web-sdk@npm:1.12.0, @grafana/faro-web-sdk@npm:^1.12.0, @grafana/faro-web-sdk@npm:^1.3.6": + version: 1.12.0 + resolution: "@grafana/faro-web-sdk@npm:1.12.0" dependencies: - "@grafana/faro-core": "npm:^1.11.0" + "@grafana/faro-core": "npm:^1.12.0" ua-parser-js: "npm:^1.0.32" web-vitals: "npm:^4.0.1" - checksum: 10/751d7374b536aef6959869c18fdcb07c81857f3601dda5c347f8a55c19ce0114c40d4329d50e7e65b279908b2f271422608b956c63727bd9c5ba4683f06873a9 + checksum: 10/220c31d90b18150e42ab69ace544a10ca8bc3710f95d44d95dd5ea8d8318dc6938daec67a5ab0c288b0470edda373a796ea32f231c71c6fb1f248d1f8632b397 languageName: node linkType: hard "@grafana/faro-web-tracing@npm:^1.8.2": - version: 1.11.0 - resolution: "@grafana/faro-web-tracing@npm:1.11.0" + version: 1.12.0 + resolution: "@grafana/faro-web-tracing@npm:1.12.0" dependencies: - "@grafana/faro-web-sdk": "npm:^1.11.0" + "@grafana/faro-web-sdk": "npm:^1.12.0" "@opentelemetry/api": "npm:^1.9.0" "@opentelemetry/context-zone": "npm:1.26.0" "@opentelemetry/core": "npm:^1.26.0" @@ -3708,7 +3694,7 @@ __metadata: "@opentelemetry/resources": "npm:^1.26.0" "@opentelemetry/sdk-trace-web": "npm:^1.26.0" "@opentelemetry/semantic-conventions": "npm:^1.27.0" - checksum: 10/d9e46b42d574f8e012bb113a5f3bd03699433cab01f57c548a3461102dd1a5882b7e53c340b4a8374a340cfff69d30af49049b7c6f580c9d78ed7377819e1ecd + checksum: 10/287df82d928846ec35b5947a776fa066c76ccd1bceee57b68276825f3f2dffd05e003460668340bde3a0b163f420db74285bebff32cf33f954accf3a594c1702 languageName: node linkType: hard @@ -3855,16 +3841,16 @@ __metadata: linkType: soft "@grafana/plugin-e2e@npm:^1.11.0": - version: 1.12.0 - resolution: "@grafana/plugin-e2e@npm:1.12.0" + version: 1.12.1 + resolution: "@grafana/plugin-e2e@npm:1.12.1" dependencies: - "@grafana/e2e-selectors": "npm:^11.4.0-205692" + "@grafana/e2e-selectors": "npm:^11.4.0-207766" semver: "npm:^7.5.4" uuid: "npm:^11.0.2" yaml: "npm:^2.3.4" peerDependencies: "@playwright/test": ^1.41.2 - checksum: 10/7e378bed8ad7a6f07a834fc9a02ca9fbcc63e5d842545e9fa443b0f24fcb62001f61a3592a45b0893af87a31f022b2646d388d152325f92df94213d94ecfcaad + checksum: 10/24ff737be1f005b350cd9d9588c851f179ee12c3305ff435f353a8a457ba49e476d51c826cbae43463ab1e7c5ad19958ee7f700d19bd5e682549c624317f8b7e languageName: node linkType: hard @@ -3874,11 +3860,11 @@ __metadata: dependencies: "@emotion/css": "npm:11.13.4" "@emotion/eslint-plugin": "npm:11.12.0" - "@floating-ui/react": "npm:0.26.27" + "@floating-ui/react": "npm:0.26.28" "@grafana/data": "npm:11.4.0-pre" "@grafana/e2e-selectors": "npm:11.4.0-pre" "@grafana/experimental": "npm:2.1.2" - "@grafana/faro-web-sdk": "npm:1.11.0" + "@grafana/faro-web-sdk": "npm:1.12.0" "@grafana/runtime": "npm:11.4.0-pre" "@grafana/schema": "npm:11.4.0-pre" "@grafana/tsconfig": "npm:^2.0.0" @@ -3960,7 +3946,7 @@ __metadata: rollup-plugin-esbuild: "npm:6.1.1" rollup-plugin-node-externals: "npm:^7.1.3" rxjs: "npm:7.8.1" - sass: "npm:1.79.5" + sass: "npm:1.80.7" sass-loader: "npm:16.0.3" semver: "npm:7.6.3" style-loader: "npm:4.0.0" @@ -4056,44 +4042,45 @@ __metadata: languageName: unknown linkType: soft -"@grafana/scenes-react@npm:5.23.1": - version: 5.23.1 - resolution: "@grafana/scenes-react@npm:5.23.1" +"@grafana/scenes-react@npm:5.25.0": + version: 5.25.0 + resolution: "@grafana/scenes-react@npm:5.25.0" dependencies: - "@grafana/e2e-selectors": "npm:^11.0.0" - "@grafana/scenes": "npm:5.23.1" - react-use: "npm:17.4.0" + "@grafana/scenes": "npm:5.25.0" + lru-cache: "npm:^10.2.2" + react-use: "npm:^17.4.0" peerDependencies: "@grafana/data": ^11.0.0 + "@grafana/e2e-selectors": ^11.0.0 "@grafana/runtime": ^11.0.0 "@grafana/schema": ^11.0.0 "@grafana/ui": ^11.0.0 react: ^18.0.0 react-dom: ^18.0.0 - checksum: 10/83a17169e3382fa6d6e83ec3aec619b3591602fe8ab45bea883c293fc8460f1869596efe1f90758e364319c143345e3ef19015e684224c3325bf503d8ddeca6a + checksum: 10/7b1b253aab445ef8e8ed17ed8168c456066ccd518020ed217a0bfecc10635089e7ec5ff4acd0ccf2f86b506ee868602b2c2835de1dffc005b04fe73ce5154170 languageName: node linkType: hard -"@grafana/scenes@npm:5.23.1": - version: 5.23.1 - resolution: "@grafana/scenes@npm:5.23.1" +"@grafana/scenes@npm:5.25.0": + version: 5.25.0 + resolution: "@grafana/scenes@npm:5.25.0" dependencies: - "@floating-ui/react": "npm:0.26.16" - "@grafana/e2e-selectors": "npm:^11.0.0" + "@floating-ui/react": "npm:^0.26.16" "@leeoniya/ufuzzy": "npm:^1.0.14" "@tanstack/react-virtual": "npm:^3.9.0" - react-grid-layout: "npm:1.3.4" - react-use: "npm:17.5.0" - react-virtualized-auto-sizer: "npm:1.0.24" + react-grid-layout: "npm:^1.3.4" + react-use: "npm:^17.5.0" + react-virtualized-auto-sizer: "npm:^1.0.24" uuid: "npm:^9.0.0" peerDependencies: "@grafana/data": ">=10.4" + "@grafana/e2e-selectors": ">=10.4" "@grafana/runtime": ">=10.4" "@grafana/schema": ">=10.4" "@grafana/ui": ">=10.4" react: ^18.0.0 react-dom: ^18.0.0 - checksum: 10/74cc74cc42102638ab3388e910242f3f641b325da5e42a2ab9bd18d9e6d14e55adbc93f25dcfad594ecc97003f1920c27b2e166e73e1a5f17459e0573615a1fd + checksum: 10/bef40f88970de1486ba49afca03d2538b1c72ba7d7cfd1df42978ad369b842c66c30d87c814438fe00187d77112520c7ea508fc77d31a9045f37e043ecf12bf7 languageName: node linkType: hard @@ -4176,7 +4163,7 @@ __metadata: "@emotion/react": "npm:11.13.3" "@emotion/serialize": "npm:1.3.2" "@faker-js/faker": "npm:^9.0.0" - "@floating-ui/react": "npm:0.26.27" + "@floating-ui/react": "npm:0.26.28" "@grafana/data": "npm:11.4.0-pre" "@grafana/e2e-selectors": "npm:11.4.0-pre" "@grafana/faro-web-sdk": "npm:^1.3.6" @@ -4262,13 +4249,13 @@ __metadata: ol: "npm:7.4.0" prismjs: "npm:1.29.0" process: "npm:^0.11.10" - rc-cascader: "npm:3.28.1" + rc-cascader: "npm:3.30.0" rc-drawer: "npm:7.2.0" rc-slider: "npm:11.1.7" rc-time-picker: "npm:^3.7.3" rc-tooltip: "npm:6.2.1" react: "npm:18.2.0" - react-calendar: "npm:5.0.0" + react-calendar: "npm:5.1.0" react-colorful: "npm:5.6.1" react-custom-scrollbars-2: "npm:4.5.0" react-dom: "npm:18.2.0" @@ -4403,49 +4390,48 @@ __metadata: languageName: node linkType: hard -"@inquirer/confirm@npm:^4.0.0": - version: 4.0.1 - resolution: "@inquirer/confirm@npm:4.0.1" +"@inquirer/confirm@npm:^5.0.0": + version: 5.0.2 + resolution: "@inquirer/confirm@npm:5.0.2" dependencies: - "@inquirer/core": "npm:^9.2.1" - "@inquirer/type": "npm:^2.0.0" - checksum: 10/9f80834fcba308b047f4953abee4ff3837693400402797bd160dee64c019a63d9d9d866bbbf03d56f4aae8013c27991a0d405765120fe49aea2a57103af53426 + "@inquirer/core": "npm:^10.1.0" + "@inquirer/type": "npm:^3.0.1" + peerDependencies: + "@types/node": ">=18" + checksum: 10/4e775b80b689adeb0b2852ed79b368ef23a82fe3d5f580a562f4af7cdf002a19e0ec1b3b95acc6d49427a72c0fcb5b6548e0cdcafe2f0d3f3d6a923e04aabd0c languageName: node linkType: hard -"@inquirer/core@npm:^9.2.1": - version: 9.2.1 - resolution: "@inquirer/core@npm:9.2.1" +"@inquirer/core@npm:^10.1.0": + version: 10.1.0 + resolution: "@inquirer/core@npm:10.1.0" dependencies: - "@inquirer/figures": "npm:^1.0.6" - "@inquirer/type": "npm:^2.0.0" - "@types/mute-stream": "npm:^0.0.4" - "@types/node": "npm:^22.5.5" - "@types/wrap-ansi": "npm:^3.0.0" + "@inquirer/figures": "npm:^1.0.8" + "@inquirer/type": "npm:^3.0.1" ansi-escapes: "npm:^4.3.2" cli-width: "npm:^4.1.0" - mute-stream: "npm:^1.0.0" + mute-stream: "npm:^2.0.0" signal-exit: "npm:^4.1.0" strip-ansi: "npm:^6.0.1" wrap-ansi: "npm:^6.2.0" yoctocolors-cjs: "npm:^2.1.2" - checksum: 10/bf35e46e70add8ffa9e9d4ae6b528ac660484afca082bca31af95ce8a145a2f8c8d0d07cc7a8627771452e68ade9849c9c9c450a004133ed10ac2d6730900452 + checksum: 10/5d097d0484c1b758f788b792d29395199bdc84af3e8cd4d9273e31de2c5202839b6edf299056956044ba7fb097c4cee7b5c0288e094a380c045082b044f9946e languageName: node linkType: hard -"@inquirer/figures@npm:^1.0.6": - version: 1.0.7 - resolution: "@inquirer/figures@npm:1.0.7" - checksum: 10/ce896860de9d822a7c2a212667bcfd0f04cf2ce86d9a2411cc9c077bb59cd61732cb5f72ac66e88d52912466eec433f005bf8a25efa658f41e1a32f3977080bd +"@inquirer/figures@npm:^1.0.8": + version: 1.0.8 + resolution: "@inquirer/figures@npm:1.0.8" + checksum: 10/0e5e4fbb15e799e818c598fcc3558ef076daf78662149711b046723fd6316381e95f7d5573d6ef0062095ad22c6ac98833033f0948df5c722932107a567fd9c3 languageName: node linkType: hard -"@inquirer/type@npm:^2.0.0": - version: 2.0.0 - resolution: "@inquirer/type@npm:2.0.0" - dependencies: - mute-stream: "npm:^1.0.0" - checksum: 10/e85f359866c28cce06272d2d51cc17788a5c9de9fda7f181c27775dd26821de0dacbc947b521cfe2009cd2965ec54696799035ef3a25a9a5794e47d8e8bdf794 +"@inquirer/type@npm:^3.0.1": + version: 3.0.1 + resolution: "@inquirer/type@npm:3.0.1" + peerDependencies: + "@types/node": ">=18" + checksum: 10/af412f1e7541d43554b02199ae71a2039a1bff5dc51ceefd87de9ece55b199682733b28810fb4b6cb3ed4a159af4cc4a26d4bb29c58dd127e7d9dbda0797d8e7 languageName: node linkType: hard @@ -7126,114 +7112,128 @@ __metadata: languageName: node linkType: hard -"@rollup/rollup-android-arm-eabi@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-android-arm-eabi@npm:4.24.0" +"@rollup/rollup-android-arm-eabi@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-android-arm-eabi@npm:4.26.0" conditions: os=android & cpu=arm languageName: node linkType: hard -"@rollup/rollup-android-arm64@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-android-arm64@npm:4.24.0" +"@rollup/rollup-android-arm64@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-android-arm64@npm:4.26.0" conditions: os=android & cpu=arm64 languageName: node linkType: hard -"@rollup/rollup-darwin-arm64@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-darwin-arm64@npm:4.24.0" +"@rollup/rollup-darwin-arm64@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-darwin-arm64@npm:4.26.0" conditions: os=darwin & cpu=arm64 languageName: node linkType: hard -"@rollup/rollup-darwin-x64@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-darwin-x64@npm:4.24.0" +"@rollup/rollup-darwin-x64@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-darwin-x64@npm:4.26.0" conditions: os=darwin & cpu=x64 languageName: node linkType: hard -"@rollup/rollup-linux-arm-gnueabihf@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-linux-arm-gnueabihf@npm:4.24.0" +"@rollup/rollup-freebsd-arm64@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-freebsd-arm64@npm:4.26.0" + conditions: os=freebsd & cpu=arm64 + languageName: node + linkType: hard + +"@rollup/rollup-freebsd-x64@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-freebsd-x64@npm:4.26.0" + conditions: os=freebsd & cpu=x64 + languageName: node + linkType: hard + +"@rollup/rollup-linux-arm-gnueabihf@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-linux-arm-gnueabihf@npm:4.26.0" conditions: os=linux & cpu=arm & libc=glibc languageName: node linkType: hard -"@rollup/rollup-linux-arm-musleabihf@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-linux-arm-musleabihf@npm:4.24.0" +"@rollup/rollup-linux-arm-musleabihf@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-linux-arm-musleabihf@npm:4.26.0" conditions: os=linux & cpu=arm & libc=musl languageName: node linkType: hard -"@rollup/rollup-linux-arm64-gnu@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-linux-arm64-gnu@npm:4.24.0" +"@rollup/rollup-linux-arm64-gnu@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-linux-arm64-gnu@npm:4.26.0" conditions: os=linux & cpu=arm64 & libc=glibc languageName: node linkType: hard -"@rollup/rollup-linux-arm64-musl@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-linux-arm64-musl@npm:4.24.0" +"@rollup/rollup-linux-arm64-musl@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-linux-arm64-musl@npm:4.26.0" conditions: os=linux & cpu=arm64 & libc=musl languageName: node linkType: hard -"@rollup/rollup-linux-powerpc64le-gnu@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-linux-powerpc64le-gnu@npm:4.24.0" +"@rollup/rollup-linux-powerpc64le-gnu@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-linux-powerpc64le-gnu@npm:4.26.0" conditions: os=linux & cpu=ppc64 & libc=glibc languageName: node linkType: hard -"@rollup/rollup-linux-riscv64-gnu@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-linux-riscv64-gnu@npm:4.24.0" +"@rollup/rollup-linux-riscv64-gnu@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-linux-riscv64-gnu@npm:4.26.0" conditions: os=linux & cpu=riscv64 & libc=glibc languageName: node linkType: hard -"@rollup/rollup-linux-s390x-gnu@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-linux-s390x-gnu@npm:4.24.0" +"@rollup/rollup-linux-s390x-gnu@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-linux-s390x-gnu@npm:4.26.0" conditions: os=linux & cpu=s390x & libc=glibc languageName: node linkType: hard -"@rollup/rollup-linux-x64-gnu@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-linux-x64-gnu@npm:4.24.0" +"@rollup/rollup-linux-x64-gnu@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-linux-x64-gnu@npm:4.26.0" conditions: os=linux & cpu=x64 & libc=glibc languageName: node linkType: hard -"@rollup/rollup-linux-x64-musl@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-linux-x64-musl@npm:4.24.0" +"@rollup/rollup-linux-x64-musl@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-linux-x64-musl@npm:4.26.0" conditions: os=linux & cpu=x64 & libc=musl languageName: node linkType: hard -"@rollup/rollup-win32-arm64-msvc@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-win32-arm64-msvc@npm:4.24.0" +"@rollup/rollup-win32-arm64-msvc@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-win32-arm64-msvc@npm:4.26.0" conditions: os=win32 & cpu=arm64 languageName: node linkType: hard -"@rollup/rollup-win32-ia32-msvc@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-win32-ia32-msvc@npm:4.24.0" +"@rollup/rollup-win32-ia32-msvc@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-win32-ia32-msvc@npm:4.26.0" conditions: os=win32 & cpu=ia32 languageName: node linkType: hard -"@rollup/rollup-win32-x64-msvc@npm:4.24.0": - version: 4.24.0 - resolution: "@rollup/rollup-win32-x64-msvc@npm:4.24.0" +"@rollup/rollup-win32-x64-msvc@npm:4.26.0": + version: 4.26.0 + resolution: "@rollup/rollup-win32-x64-msvc@npm:4.26.0" conditions: os=win32 & cpu=x64 languageName: node linkType: hard @@ -10415,15 +10415,6 @@ __metadata: languageName: node linkType: hard -"@types/mute-stream@npm:^0.0.4": - version: 0.0.4 - resolution: "@types/mute-stream@npm:0.0.4" - dependencies: - "@types/node": "npm:*" - checksum: 10/af8d83ad7b68ea05d9357985daf81b6c9b73af4feacb2f5c2693c7fd3e13e5135ef1bd083ce8d5bdc8e97acd28563b61bb32dec4e4508a8067fcd31b8a098632 - languageName: node - linkType: hard - "@types/node-forge@npm:^1, @types/node-forge@npm:^1.3.0": version: 1.3.11 resolution: "@types/node-forge@npm:1.3.11" @@ -10433,7 +10424,7 @@ __metadata: languageName: node linkType: hard -"@types/node@npm:*, @types/node@npm:>=13.7.0, @types/node@npm:^22.5.5": +"@types/node@npm:*, @types/node@npm:>=13.7.0": version: 22.7.8 resolution: "@types/node@npm:22.7.8" dependencies: @@ -10968,13 +10959,6 @@ __metadata: languageName: node linkType: hard -"@types/wrap-ansi@npm:^3.0.0": - version: 3.0.0 - resolution: "@types/wrap-ansi@npm:3.0.0" - checksum: 10/8aa644946ca4e859668c36b8e2bcf2ac4bdee59dac760414730ea57be8a93ae9166ebd40a088f2ab714843aaea2a2a67f0e6e6ec11cfc9c8701b2466ca1c4089 - languageName: node - linkType: hard - "@types/ws@npm:^8.5.10": version: 8.5.10 resolution: "@types/ws@npm:8.5.10" @@ -11186,7 +11170,7 @@ __metadata: languageName: node linkType: hard -"@typescript-eslint/utils@npm:^5.25.0, @typescript-eslint/utils@npm:^5.58.0": +"@typescript-eslint/utils@npm:^5.25.0, @typescript-eslint/utils@npm:^5.62.0": version: 5.62.0 resolution: "@typescript-eslint/utils@npm:5.62.0" dependencies: @@ -12194,13 +12178,6 @@ __metadata: languageName: node linkType: hard -"array-tree-filter@npm:^2.1.0": - version: 2.1.0 - resolution: "array-tree-filter@npm:2.1.0" - checksum: 10/ca65dbeb80777eadadfcd4dbd2658d9eb0be66e426a6b6d64f1a71dff5351f2e6f370e0cbcc418e9e6e01d06b337b128441a71c7143abe4d925d027d5aa0100f - languageName: node - linkType: hard - "array-union@npm:^2.1.0": version: 2.1.0 resolution: "array-union@npm:2.1.0" @@ -12406,10 +12383,10 @@ __metadata: languageName: node linkType: hard -"attr-accept@npm:^2.2.2": - version: 2.2.2 - resolution: "attr-accept@npm:2.2.2" - checksum: 10/c867ed41ed749988ad2a6fc70eb2498b9c3c2d58aaad2a8d05422a383058f9d29e50c4bca363c5ee7433df738a7920cc95377bbce8678e817fb498299dd82010 +"attr-accept@npm:^2.2.2, attr-accept@npm:^2.2.4": + version: 2.2.5 + resolution: "attr-accept@npm:2.2.5" + checksum: 10/474b1c53e62c5b881c745d1f098196f190c8b493245e95d4b0fea9298d3acb56f551868fc12806885277e55e9d8ad3c5963e92d93456f4e4081dfc5190977bfd languageName: node linkType: hard @@ -14149,10 +14126,10 @@ __metadata: languageName: node linkType: hard -"cookie@npm:^0.5.0": - version: 0.5.0 - resolution: "cookie@npm:0.5.0" - checksum: 10/aae7911ddc5f444a9025fbd979ad1b5d60191011339bce48e555cb83343d0f98b865ff5c4d71fecdfb8555a5cafdc65632f6fce172f32aaf6936830a883a0380 +"cookie@npm:^0.7.2": + version: 0.7.2 + resolution: "cookie@npm:0.7.2" + checksum: 10/24b286c556420d4ba4e9bc09120c9d3db7d28ace2bd0f8ccee82422ce42322f73c8312441271e5eefafbead725980e5996cc02766dbb89a90ac7f5636ede608f languageName: node linkType: hard @@ -16963,13 +16940,13 @@ __metadata: linkType: hard "eslint-plugin-testing-library@npm:^6.3.0": - version: 6.3.0 - resolution: "eslint-plugin-testing-library@npm:6.3.0" + version: 6.4.0 + resolution: "eslint-plugin-testing-library@npm:6.4.0" dependencies: - "@typescript-eslint/utils": "npm:^5.58.0" + "@typescript-eslint/utils": "npm:^5.62.0" peerDependencies: - eslint: ^7.5.0 || ^8.0.0 - checksum: 10/192b112f84f90cc7eee28965b3e7792e8d4cda71aa29690d8180f1ae9cd0e8d6a8851ee992d37285a76750f8638c04e76f768e1885168f060ca169b72ac9ec6c + eslint: ^7.5.0 || ^8.0.0 || ^9.0.0 + checksum: 10/b9461e6662542fbfb3c0b768e6038bbaa56e345cb0600c7f07e26ff8154166abb9f7dcdc08d565c314cd9ccf0416eca8c3ce3c235b375c5fbf3f152a81142969 languageName: node linkType: hard @@ -17628,6 +17605,15 @@ __metadata: languageName: node linkType: hard +"file-selector@npm:^2.1.0": + version: 2.1.0 + resolution: "file-selector@npm:2.1.0" + dependencies: + tslib: "npm:^2.7.0" + checksum: 10/050c24a27b8582a9c5d010a3ea77b22ccbe3969733a044bcb210ba2f85454fb7a6d8b6f91de468517fe59998e94d5c9533447ad063b9e74a67161946474164d4 + languageName: node + linkType: hard + "file-system-cache@npm:2.3.0": version: 2.3.0 resolution: "file-system-cache@npm:2.3.0" @@ -18689,7 +18675,7 @@ __metadata: "@emotion/react": "npm:11.13.3" "@eslint/compat": "npm:^1.2.0" "@fingerprintjs/fingerprintjs": "npm:^3.4.2" - "@floating-ui/react": "npm:0.26.27" + "@floating-ui/react": "npm:0.26.28" "@formatjs/intl-durationformat": "npm:^0.6.0" "@glideapps/glide-data-grid": "npm:^6.0.0" "@grafana/aws-sdk": "npm:0.5.0" @@ -18711,8 +18697,8 @@ __metadata: "@grafana/prometheus": "workspace:*" "@grafana/runtime": "workspace:*" "@grafana/saga-icons": "workspace:*" - "@grafana/scenes": "npm:5.23.1" - "@grafana/scenes-react": "npm:5.23.1" + "@grafana/scenes": "npm:5.25.0" + "@grafana/scenes-react": "npm:5.25.0" "@grafana/schema": "workspace:*" "@grafana/sql": "workspace:*" "@grafana/tsconfig": "npm:^2.0.0" @@ -18919,7 +18905,7 @@ __metadata: moment-timezone: "npm:0.5.46" monaco-editor: "npm:0.34.1" moveable: "npm:0.53.0" - msw: "npm:2.4.13" + msw: "npm:2.6.4" mutationobserver-shim: "npm:0.3.7" nanoid: "npm:^5.0.4" ngtemplate-loader: "npm:2.1.0" @@ -18938,7 +18924,7 @@ __metadata: pseudoizer: "npm:^0.1.0" rc-slider: "npm:11.1.7" rc-time-picker: "npm:3.7.3" - rc-tree: "npm:5.9.0" + rc-tree: "npm:5.10.1" re-resizable: "npm:6.10.1" react: "npm:18.2.0" react-diff-viewer-continued: "npm:^3.4.0" @@ -18980,7 +18966,7 @@ __metadata: rimraf: "npm:6.0.1" rudder-sdk-js: "npm:2.48.26" rxjs: "npm:7.8.1" - sass: "npm:1.79.5" + sass: "npm:1.80.7" sass-loader: "npm:16.0.3" selecto: "npm:1.26.3" semver: "npm:7.6.3" @@ -19599,8 +19585,8 @@ __metadata: linkType: hard "http-proxy-middleware@npm:^2.0.3": - version: 2.0.4 - resolution: "http-proxy-middleware@npm:2.0.4" + version: 2.0.7 + resolution: "http-proxy-middleware@npm:2.0.7" dependencies: "@types/http-proxy": "npm:^1.17.8" http-proxy: "npm:^1.18.1" @@ -19612,7 +19598,7 @@ __metadata: peerDependenciesMeta: "@types/express": optional: true - checksum: 10/642092bcd98a37375846438e069cea42df6f65df86d516fce388f6bf08e8f1436f52b19cfc557e9d1933dff9b16e53865c5785b930f50c5aa9d46fe0b6e30eb8 + checksum: 10/4a51bf612b752ad945701995c1c029e9501c97e7224c0cf3f8bf6d48d172d6a8f2b57c20fec469534fdcac3aa8a6f332224a33c6b0d7f387aa2cfff9b67216fd languageName: node linkType: hard @@ -19762,11 +19748,11 @@ __metadata: linkType: hard "i18next@npm:^23.0.0, i18next@npm:^23.11.5, i18next@npm:^23.5.1": - version: 23.15.2 - resolution: "i18next@npm:23.15.2" + version: 23.16.5 + resolution: "i18next@npm:23.16.5" dependencies: "@babel/runtime": "npm:^7.23.2" - checksum: 10/ed14a290ba8e761a06b6a6ce5e608861f367eb0806fa1b4eb77494340502ad20491748ab2b27423ba186f5602b89cbcb87565683a03443d0368cd4b182ae6ef9 + checksum: 10/842b6d35d6e0822f1c8c3c2ca8af0fec9d8d9e37a54f63cdf42c0fcc7908d980082daff6ab77ad248324d2c45a0f1fe1e40efe23ba84d950722ece36b61d647c languageName: node linkType: hard @@ -19834,7 +19820,7 @@ __metadata: languageName: node linkType: hard -"immutable@npm:4.3.7, immutable@npm:^4.0.0, immutable@npm:^4.3.6": +"immutable@npm:4.3.7, immutable@npm:^4.3.6": version: 4.3.7 resolution: "immutable@npm:4.3.7" checksum: 10/37d963c5050f03ae5f3714ba7a43d469aa482051087f4c65d673d1501c309ea231d87480c792e19fa85e2eaf965f76af5d0aa92726505f3cfe4af91619dfb80b @@ -19848,6 +19834,13 @@ __metadata: languageName: node linkType: hard +"immutable@npm:^5.0.2": + version: 5.0.2 + resolution: "immutable@npm:5.0.2" + checksum: 10/89b1117c610024b7a9214eade8b9f1ed38b00c82235f119515cfa5eaf26270eccbc803296d4c3c12f53e50802f042f84d811998910b866363913720da768472e + languageName: node + linkType: hard + "import-fresh@npm:^3.2.1, import-fresh@npm:^3.3.0": version: 3.3.0 resolution: "import-fresh@npm:3.3.0" @@ -21419,12 +21412,12 @@ __metadata: languageName: node linkType: hard -"jiti@npm:^2.3.3": - version: 2.3.3 - resolution: "jiti@npm:2.3.3" +"jiti@npm:^2.4.0": + version: 2.4.0 + resolution: "jiti@npm:2.4.0" bin: jiti: lib/jiti-cli.mjs - checksum: 10/21d1e89d909101c702769537e75ad87b433f980bc6938a6f64a90d1fbe7cb1510a0d4b82d4020b3093b47cebff5568af5e39d883e26aa4413564ced43b8cfd84 + checksum: 10/10aa999a4f9bccc82b1dab9ebaf4484a8770450883c1bf7fafc07f8fca1e417fd8e7731e651337d1060c9e2ff3f97362dcdfd27e86d1f385db97f4adf7b5a21d languageName: node linkType: hard @@ -21891,18 +21884,18 @@ __metadata: linkType: hard "knip@npm:^5.10.0": - version: 5.33.3 - resolution: "knip@npm:5.33.3" + version: 5.37.0 + resolution: "knip@npm:5.37.0" dependencies: "@nodelib/fs.walk": "npm:1.2.8" "@snyk/github-codeowners": "npm:1.1.0" easy-table: "npm:1.2.0" enhanced-resolve: "npm:^5.17.1" fast-glob: "npm:^3.3.2" - jiti: "npm:^2.3.3" + jiti: "npm:^2.4.0" js-yaml: "npm:^4.1.0" minimist: "npm:^1.2.8" - picocolors: "npm:^1.0.0" + picocolors: "npm:^1.1.0" picomatch: "npm:^4.0.1" pretty-ms: "npm:^9.0.0" smol-toml: "npm:^1.3.0" @@ -21916,7 +21909,7 @@ __metadata: bin: knip: bin/knip.js knip-bun: bin/knip-bun.js - checksum: 10/d6227a43666ce9732fe6b797a0c348bc46f59603826766c2049f44682ce96c23f0fb85b659d243dd36f98098a83a4e500d1044f3114a32564a39cf92dce8e853 + checksum: 10/f3b789d22fe9711ee01eb7c87d28836d5d1616a5d050ad0ce8a4366ca50a10cdaf42b72078edaa2f9b80d248468b4f925c9f654174652e4aed6268c9bf68a7bf languageName: node linkType: hard @@ -23935,15 +23928,16 @@ __metadata: languageName: node linkType: hard -"msw@npm:2.4.13": - version: 2.4.13 - resolution: "msw@npm:2.4.13" +"msw@npm:2.6.4": + version: 2.6.4 + resolution: "msw@npm:2.6.4" dependencies: - "@bundled-es-modules/cookie": "npm:^2.0.0" + "@bundled-es-modules/cookie": "npm:^2.0.1" "@bundled-es-modules/statuses": "npm:^1.0.1" "@bundled-es-modules/tough-cookie": "npm:^0.1.6" - "@inquirer/confirm": "npm:^4.0.0" + "@inquirer/confirm": "npm:^5.0.0" "@mswjs/interceptors": "npm:^0.36.5" + "@open-draft/deferred-promise": "npm:^2.2.0" "@open-draft/until": "npm:^2.1.0" "@types/cookie": "npm:^0.6.0" "@types/statuses": "npm:^2.0.4" @@ -23963,7 +23957,7 @@ __metadata: optional: true bin: msw: cli/index.js - checksum: 10/db48a8897f6ee97457c227aed47460d27a4add8200bd576d323edae32fcd863bb746c2b6fa2aba4f3c4956ab18c97f366dbf78a4dc122c7d442a5202757dab7a + checksum: 10/8420b389e4f223a1a21c2114fab6f4aa6a088de85f8c266f51dd9e44c4579cebb571a52f2acdda67a2849979d2694bf62286c9b5e4a79851c1bda166aa87abad languageName: node linkType: hard @@ -24013,6 +24007,13 @@ __metadata: languageName: node linkType: hard +"mute-stream@npm:^2.0.0": + version: 2.0.0 + resolution: "mute-stream@npm:2.0.0" + checksum: 10/d2e4fd2f5aa342b89b98134a8d899d8ef9b0a6d69274c4af9df46faa2d97aeb1f2ce83d867880d6de63643c52386579b99139801e24e7526c3b9b0a6d1e18d6c + languageName: node + linkType: hard + "nan@npm:^2.14.0, nan@npm:^2.17.0, nan@npm:^2.18.0": version: 2.20.0 resolution: "nan@npm:2.20.0" @@ -24022,7 +24023,7 @@ __metadata: languageName: node linkType: hard -"nano-css@npm:^5.3.1, nano-css@npm:^5.6.1, nano-css@npm:^5.6.2": +"nano-css@npm:^5.6.2": version: 5.6.2 resolution: "nano-css@npm:5.6.2" dependencies: @@ -26719,20 +26720,19 @@ __metadata: languageName: node linkType: hard -"rc-cascader@npm:3.28.1": - version: 3.28.1 - resolution: "rc-cascader@npm:3.28.1" +"rc-cascader@npm:3.30.0": + version: 3.30.0 + resolution: "rc-cascader@npm:3.30.0" dependencies: - "@babel/runtime": "npm:^7.12.5" - array-tree-filter: "npm:^2.1.0" + "@babel/runtime": "npm:^7.25.7" classnames: "npm:^2.3.1" - rc-select: "npm:~14.15.0" - rc-tree: "npm:~5.9.0" - rc-util: "npm:^5.37.0" + rc-select: "npm:~14.16.2" + rc-tree: "npm:~5.10.1" + rc-util: "npm:^5.43.0" peerDependencies: react: ">=16.9.0" react-dom: ">=16.9.0" - checksum: 10/bb2feb79c0db19f459b265e9a0afb87611f4ba06c4776a5ea8ddcb0bfc81403292ada3a1c29cd7511872f8d2bfda7c29eab6dbc32052a60baf49576a50866d77 + checksum: 10/c4ed8e122ad2dcc37fb1b190f4514fc040bf60b74bf90735c7485054978687387c039a977b151b28164fd41301f073c5491acd8557cd8841c9cd71c19b8166ee languageName: node linkType: hard @@ -26796,9 +26796,9 @@ __metadata: languageName: node linkType: hard -"rc-select@npm:~14.15.0": - version: 14.15.1 - resolution: "rc-select@npm:14.15.1" +"rc-select@npm:~14.16.2": + version: 14.16.3 + resolution: "rc-select@npm:14.16.3" dependencies: "@babel/runtime": "npm:^7.10.1" "@rc-component/trigger": "npm:^2.1.1" @@ -26810,7 +26810,7 @@ __metadata: peerDependencies: react: "*" react-dom: "*" - checksum: 10/8b42d88b2da1b6ef4c67068a0574d57225c2d9934b04122609fa03a7137d0bea8c00155c66211417a0a848c1a298b4b24641a476980795e63a2ad229a5b700bf + checksum: 10/fa647ee1f2e8fbeadc81de1e3c24ade9b48e64d2e7e554da5a7d30e9802243d5d5035d7ceedafdf5c9599689ddb3a40c28adbbec95f594e444e07145c0130304 languageName: node linkType: hard @@ -26856,9 +26856,9 @@ __metadata: languageName: node linkType: hard -"rc-tree@npm:5.9.0, rc-tree@npm:~5.9.0": - version: 5.9.0 - resolution: "rc-tree@npm:5.9.0" +"rc-tree@npm:5.10.1, rc-tree@npm:~5.10.1": + version: 5.10.1 + resolution: "rc-tree@npm:5.10.1" dependencies: "@babel/runtime": "npm:^7.10.1" classnames: "npm:2.x" @@ -26868,7 +26868,7 @@ __metadata: peerDependencies: react: "*" react-dom: "*" - checksum: 10/d7525c4a524c6de8e177ebc90fe9b924046951a02bacee85efd4529fb05a66add936802b43d5ca8d84469f9c63b8d542437365b911480f62a78e03e2c7fbaca0 + checksum: 10/3fd1ad26ecce4435212aba83a87af8256805a8c2a3be3729995043848d7af267bcfc89dd09393fc5962f7a802b83184ad2736d407e18f007ce1a4c9ebd7a5629 languageName: node linkType: hard @@ -26900,16 +26900,16 @@ __metadata: languageName: node linkType: hard -"rc-util@npm:^5.15.0, rc-util@npm:^5.16.1, rc-util@npm:^5.21.0, rc-util@npm:^5.24.4, rc-util@npm:^5.27.0, rc-util@npm:^5.36.0, rc-util@npm:^5.37.0, rc-util@npm:^5.38.0, rc-util@npm:^5.38.1": - version: 5.39.1 - resolution: "rc-util@npm:5.39.1" +"rc-util@npm:^5.15.0, rc-util@npm:^5.16.1, rc-util@npm:^5.21.0, rc-util@npm:^5.24.4, rc-util@npm:^5.27.0, rc-util@npm:^5.36.0, rc-util@npm:^5.37.0, rc-util@npm:^5.38.0, rc-util@npm:^5.38.1, rc-util@npm:^5.43.0": + version: 5.43.0 + resolution: "rc-util@npm:5.43.0" dependencies: "@babel/runtime": "npm:^7.18.3" react-is: "npm:^18.2.0" peerDependencies: react: ">=16.9.0" react-dom: ">=16.9.0" - checksum: 10/475e7755f8a8aaf8428c535e14ad1475d3d764108852a011cb5186fb7d905e064c0d56b77818ddaea0c5fbde439d3606b52f459cef7725fde8abf15e3e2ece2b + checksum: 10/6d5be9d79182c6b4c5a033ad6517b2940d3d2ac42a8e77ef5735591d182f8236f61bc7628d61e82a122d2046ec849462f3fe57c08d3a2a20279646785c34ec4a languageName: node linkType: hard @@ -26952,9 +26952,9 @@ __metadata: languageName: node linkType: hard -"react-calendar@npm:5.0.0": - version: 5.0.0 - resolution: "react-calendar@npm:5.0.0" +"react-calendar@npm:5.1.0": + version: 5.1.0 + resolution: "react-calendar@npm:5.1.0" dependencies: "@wojtekmaj/date-utils": "npm:^1.1.3" clsx: "npm:^2.0.0" @@ -26967,7 +26967,7 @@ __metadata: peerDependenciesMeta: "@types/react": optional: true - checksum: 10/1172828652e796a946beec4f7f4125bfbe775a39c4cdab2179cef04b0688e892062f628ec9263bdfea6d9be41c3de1414586036d03d6694e6008cd4763649581 + checksum: 10/69c5f809646edae64dc75d8709ccac979723fde2d5752f0992e429d09a1caf45e6c2d340563dfec2cf27e22a19b5f51f65c05decfcae9860c34470c08261de43 languageName: node linkType: hard @@ -27109,7 +27109,7 @@ __metadata: languageName: node linkType: hard -"react-dropzone@npm:14.2.10, react-dropzone@npm:^14.2.3": +"react-dropzone@npm:14.2.10": version: 14.2.10 resolution: "react-dropzone@npm:14.2.10" dependencies: @@ -27122,6 +27122,19 @@ __metadata: languageName: node linkType: hard +"react-dropzone@npm:^14.2.3": + version: 14.3.5 + resolution: "react-dropzone@npm:14.3.5" + dependencies: + attr-accept: "npm:^2.2.4" + file-selector: "npm:^2.1.0" + prop-types: "npm:^15.8.1" + peerDependencies: + react: ">= 16.8 || 18.0.0" + checksum: 10/6124bacd2138002d721c86c2b507a5c1889cfde73344fe474855a4e2e81fecb2c318edb0ab3333a75fd502fb6da44a6f8e9cdee317ec916331fd520d454e6297 + languageName: node + linkType: hard + "react-easy-swipe@npm:^0.0.21": version: 0.0.21 resolution: "react-easy-swipe@npm:0.0.21" @@ -27773,57 +27786,7 @@ __metadata: languageName: node linkType: hard -"react-use@npm:17.4.0": - version: 17.4.0 - resolution: "react-use@npm:17.4.0" - dependencies: - "@types/js-cookie": "npm:^2.2.6" - "@xobotyi/scrollbar-width": "npm:^1.9.5" - copy-to-clipboard: "npm:^3.3.1" - fast-deep-equal: "npm:^3.1.3" - fast-shallow-equal: "npm:^1.0.0" - js-cookie: "npm:^2.2.1" - nano-css: "npm:^5.3.1" - react-universal-interface: "npm:^0.6.2" - resize-observer-polyfill: "npm:^1.5.1" - screenfull: "npm:^5.1.0" - set-harmonic-interval: "npm:^1.0.1" - throttle-debounce: "npm:^3.0.1" - ts-easing: "npm:^0.2.0" - tslib: "npm:^2.1.0" - peerDependencies: - react: ^16.8.0 || ^17.0.0 || ^18.0.0 - react-dom: ^16.8.0 || ^17.0.0 || ^18.0.0 - checksum: 10/98566c4817b00251107824743ea9dff41f167b548bd5f249f6eb9e2ec09388a2de1e89988e4432cead3f8aa83cf706e0255db8a20c0615768c670751973d2761 - languageName: node - linkType: hard - -"react-use@npm:17.5.0": - version: 17.5.0 - resolution: "react-use@npm:17.5.0" - dependencies: - "@types/js-cookie": "npm:^2.2.6" - "@xobotyi/scrollbar-width": "npm:^1.9.5" - copy-to-clipboard: "npm:^3.3.1" - fast-deep-equal: "npm:^3.1.3" - fast-shallow-equal: "npm:^1.0.0" - js-cookie: "npm:^2.2.1" - nano-css: "npm:^5.6.1" - react-universal-interface: "npm:^0.6.2" - resize-observer-polyfill: "npm:^1.5.1" - screenfull: "npm:^5.1.0" - set-harmonic-interval: "npm:^1.0.1" - throttle-debounce: "npm:^3.0.1" - ts-easing: "npm:^0.2.0" - tslib: "npm:^2.1.0" - peerDependencies: - react: "*" - react-dom: "*" - checksum: 10/5d81fe0902303d3ed7810cdd56c6cae12b08124a3d4fcbfa3924327105b81447b039ea9d6aff20aac3c13999f949000870a7a2fa29fe20ed844ac26606462fa0 - languageName: node - linkType: hard - -"react-use@npm:17.5.1, react-use@npm:^17.4.2": +"react-use@npm:17.5.1, react-use@npm:^17.4.0, react-use@npm:^17.4.2, react-use@npm:^17.5.0": version: 17.5.1 resolution: "react-use@npm:17.5.1" dependencies: @@ -27859,7 +27822,7 @@ __metadata: languageName: node linkType: hard -"react-virtualized-auto-sizer@npm:1.0.24": +"react-virtualized-auto-sizer@npm:1.0.24, react-virtualized-auto-sizer@npm:^1.0.24": version: 1.0.24 resolution: "react-virtualized-auto-sizer@npm:1.0.24" peerDependencies: @@ -28764,25 +28727,27 @@ __metadata: linkType: hard "rollup@npm:^4.22.4": - version: 4.24.0 - resolution: "rollup@npm:4.24.0" + version: 4.26.0 + resolution: "rollup@npm:4.26.0" dependencies: - "@rollup/rollup-android-arm-eabi": "npm:4.24.0" - "@rollup/rollup-android-arm64": "npm:4.24.0" - "@rollup/rollup-darwin-arm64": "npm:4.24.0" - "@rollup/rollup-darwin-x64": "npm:4.24.0" - "@rollup/rollup-linux-arm-gnueabihf": "npm:4.24.0" - "@rollup/rollup-linux-arm-musleabihf": "npm:4.24.0" - "@rollup/rollup-linux-arm64-gnu": "npm:4.24.0" - "@rollup/rollup-linux-arm64-musl": "npm:4.24.0" - "@rollup/rollup-linux-powerpc64le-gnu": "npm:4.24.0" - "@rollup/rollup-linux-riscv64-gnu": "npm:4.24.0" - "@rollup/rollup-linux-s390x-gnu": "npm:4.24.0" - "@rollup/rollup-linux-x64-gnu": "npm:4.24.0" - "@rollup/rollup-linux-x64-musl": "npm:4.24.0" - "@rollup/rollup-win32-arm64-msvc": "npm:4.24.0" - "@rollup/rollup-win32-ia32-msvc": "npm:4.24.0" - "@rollup/rollup-win32-x64-msvc": "npm:4.24.0" + "@rollup/rollup-android-arm-eabi": "npm:4.26.0" + "@rollup/rollup-android-arm64": "npm:4.26.0" + "@rollup/rollup-darwin-arm64": "npm:4.26.0" + "@rollup/rollup-darwin-x64": "npm:4.26.0" + "@rollup/rollup-freebsd-arm64": "npm:4.26.0" + "@rollup/rollup-freebsd-x64": "npm:4.26.0" + "@rollup/rollup-linux-arm-gnueabihf": "npm:4.26.0" + "@rollup/rollup-linux-arm-musleabihf": "npm:4.26.0" + "@rollup/rollup-linux-arm64-gnu": "npm:4.26.0" + "@rollup/rollup-linux-arm64-musl": "npm:4.26.0" + "@rollup/rollup-linux-powerpc64le-gnu": "npm:4.26.0" + "@rollup/rollup-linux-riscv64-gnu": "npm:4.26.0" + "@rollup/rollup-linux-s390x-gnu": "npm:4.26.0" + "@rollup/rollup-linux-x64-gnu": "npm:4.26.0" + "@rollup/rollup-linux-x64-musl": "npm:4.26.0" + "@rollup/rollup-win32-arm64-msvc": "npm:4.26.0" + "@rollup/rollup-win32-ia32-msvc": "npm:4.26.0" + "@rollup/rollup-win32-x64-msvc": "npm:4.26.0" "@types/estree": "npm:1.0.6" fsevents: "npm:~2.3.2" dependenciesMeta: @@ -28794,6 +28759,10 @@ __metadata: optional: true "@rollup/rollup-darwin-x64": optional: true + "@rollup/rollup-freebsd-arm64": + optional: true + "@rollup/rollup-freebsd-x64": + optional: true "@rollup/rollup-linux-arm-gnueabihf": optional: true "@rollup/rollup-linux-arm-musleabihf": @@ -28822,7 +28791,7 @@ __metadata: optional: true bin: rollup: dist/bin/rollup - checksum: 10/291dce8f180628a73d6749119a3e50aa917c416075302bc6f6ac655affc7f0ce9d7f025bef7318d424d0c5623dcb83e360f9ea0125273b6a2285c232172800cc + checksum: 10/aec4d876617298400c0c03d35fed67e5193addc82a76f2b2a2f4c2b000cafbca84a33cf2e686dea1d1caa06fe4028dd94b8e6cd1f5bc3bbd19026a188bb2ec55 languageName: node linkType: hard @@ -28965,17 +28934,20 @@ __metadata: languageName: node linkType: hard -"sass@npm:1.79.5": - version: 1.79.5 - resolution: "sass@npm:1.79.5" +"sass@npm:1.80.7": + version: 1.80.7 + resolution: "sass@npm:1.80.7" dependencies: "@parcel/watcher": "npm:^2.4.1" chokidar: "npm:^4.0.0" - immutable: "npm:^4.0.0" + immutable: "npm:^5.0.2" source-map-js: "npm:>=0.6.2 <2.0.0" + dependenciesMeta: + "@parcel/watcher": + optional: true bin: sass: sass.js - checksum: 10/86f6ebe9c3c8d86cf8fff2e12f93109697140090604fb6180c8792c0e4fc98377c433dbd4c86a0272c47ba4c307edf24435a06d7e5995956048a23f9e187fedc + checksum: 10/617966d361968d6354bc17c0e2a66c6e0d822684b3694590441035e4966418304bbd4912ff4ee55e7a5751f94624057cd99ebc27964b102619e4e755b1f94f0e languageName: node linkType: hard @@ -31420,7 +31392,7 @@ __metadata: languageName: node linkType: hard -"tslib@npm:2, tslib@npm:^2.0.0, tslib@npm:^2.0.1, tslib@npm:^2.0.3, tslib@npm:^2.1.0, tslib@npm:^2.3.0, tslib@npm:^2.3.1, tslib@npm:^2.4.0, tslib@npm:^2.4.1, tslib@npm:^2.6.2, tslib@npm:^2.8.0": +"tslib@npm:2, tslib@npm:^2.0.0, tslib@npm:^2.0.1, tslib@npm:^2.0.3, tslib@npm:^2.1.0, tslib@npm:^2.3.0, tslib@npm:^2.3.1, tslib@npm:^2.4.0, tslib@npm:^2.4.1, tslib@npm:^2.6.2, tslib@npm:^2.7.0, tslib@npm:^2.8.0": version: 2.8.1 resolution: "tslib@npm:2.8.1" checksum: 10/3e2e043d5c2316461cb54e5c7fe02c30ef6dccb3384717ca22ae5c6b5bc95232a6241df19c622d9c73b809bea33b187f6dbc73030963e29950c2141bc32a79f7++ ++ +
++ + ++ + +++ ++ +
++ + ++ ++ +
++ + ++ +
+ ++ ++ +
++ + ++ + +++ ++ +
++ + ++ + +++ ++ +
++ ++ +++Please complete your signup
++ + ++ +Copy and paste the confirmation code in the sign up form to verify your email address. This confirmation code will expire in {{ .Expire }} minutes.+++ ++ +
++ + ++ + +++ ++ +
++ + ++ +{{ .ConfirmationCode }}+++ ++ +
++ + ++ + +++ ++ +
++ ++ +Alternatively, you can use the button below to complete your sign up.++ ++ ++ +
++ + ++ Complete Sign Up + ++ ++ +You can also copy and paste this link into your browser directly:++ + ++ + +++ ++ +
++ + ++ + +++ ++ +
++ + ++ +© {{ now | date "2006" }} Grafana Labs. Sent by Grafana v{{ .BuildVersion }}.+