SingleStat: add a gauge migration call to action button in the editor #18604

ryantxu · 2019-08-16T20:35:34Z

First step towards #14554

This adds a notice to the singlestat panel asking to be migrated to gauge:

TODO: Help wanted!

actually migrate! how do we get an event from angular to react context?
refine language / wording
Add warnings that some settings will be lost: (when configured)
- singlestat
- prefix / suffix
- datalink

ryantxu · 2019-08-16T20:37:11Z

public/app/plugins/panel/singlestat/module.ts

+
+      // debugger;
+      // const panel = this.panel as PanelModel;
+      // importPanelPlugin('gauge').then( gauge => {


this does not work... we need the DashboardPanel to call its update function

I'm not sure how to best get an event there

torkelo · 2019-08-17T20:26:50Z

Made some progress. Figured out a way to trigger panel plugin type change from within an angular panel and made a start on the migration. But then I discovered that the migration handler is not executed on panel type change only on plugin load.

So might have to change something in how the migration handler is executed or trigger it from the angular code before panel change.

ryantxu · 2019-08-18T06:22:38Z

Excellent -- works great. I changed from using the

  .setMigrationHandler(gaugePanelMigrationCheck);

To:

  .setPanelChangeHandler(gaugePanelChangedCheck)

And then needed to rework how the change hander gets triggered so that it passes angular properties along

ryantxu · 2019-08-18T17:08:40Z

public/app/features/dashboard/state/PanelModel.test.ts

@@ -165,7 +165,7 @@ describe('PanelModel', () => {
      it('should call react onPanelTypeChanged', () => {
        expect(onPanelTypeChanged.mock.calls.length).toBe(1);
        expect(onPanelTypeChanged.mock.calls[0][1]).toBe('table');
-        expect(onPanelTypeChanged.mock.calls[0][2].fieldOptions).toBeDefined();
+        expect(onPanelTypeChanged.mock.calls[0][2].angular).toBeDefined();


This changes the test to make sure an angular object is passed to it.

I don't think the previous expectation is correct -- the old properties when changing from an angular panel would never have fieldOptons, but the setup (changed in the PR) applied defaults before asking the onPanelTypeChanged callback what it should do

ryantxu · 2019-08-18T17:10:37Z

public/app/features/dashboard/state/PanelModel.ts

+    // switch
+    this.type = pluginId;
+    this.plugin = newPlugin;
+    this.applyPluginOptionDefaults(newPlugin);


Biggest change here is that applyPluginOptionDefaults is called after newPlugin.onPanelTypeChanged

This also passes the whole panel object in when switching from angular panels (the angular options are not really stored on oldOptions.options, rather in oldOptions directly)

… singlestat-to-gauge

…rame * grafana/master: SingleStat: add a gauge migration call to action button in the editor (grafana#18604) Build: update revive dependency (grafana#18585) LDAP: multildap + ldap integration (grafana#18588) Docker: switch docker image to alpine base with phantomjs support (grafana#18468) Backend: Adds support for HTTP/2 (grafana#18358) Explore: Fixes error when switching from prometheus to loki data sources (grafana#18599) TimePicker: Set time to to 23:59:59 when setting To time using calendar (grafana#18595) Prometheus: Return labels in query results (grafana#18535) Docs: Update changelog and docs for annotation region change (grafana#18593) Refactor: move KeyValue and deprecation warning to @grafana/data (grafana#18582) Annotations: use a single row to represent a region (grafana#17673) Docs: Update upgrading guide (grafana#18547) Docs: Adds tests requirement to bugs checklist (grafana#18576)

* grafana/master: SingleStat: add a gauge migration call to action button in the editor (grafana#18604) Build: update revive dependency (grafana#18585) LDAP: multildap + ldap integration (grafana#18588) Docker: switch docker image to alpine base with phantomjs support (grafana#18468) Backend: Adds support for HTTP/2 (grafana#18358)

* grafana/master: SingleStat: add a gauge migration call to action button in the editor (grafana#18604) Build: update revive dependency (grafana#18585) LDAP: multildap + ldap integration (grafana#18588)

* grafana/master: (202 commits) Azure Monitor and Log Analytics converted and separated into components (grafana#18259) Rewrite user profile edit to react (grafana#17917) Docs: remove codecov badge (grafana#18623) Prometheus: Prevents panel editor crash when switching to Prometheus datasource (grafana#18616) Chore: Rename Popper to Popover (grafana#18543) SingleStat: add a gauge migration call to action button in the editor (grafana#18604) Build: update revive dependency (grafana#18585) LDAP: multildap + ldap integration (grafana#18588) Docker: switch docker image to alpine base with phantomjs support (grafana#18468) Backend: Adds support for HTTP/2 (grafana#18358) Explore: Fixes error when switching from prometheus to loki data sources (grafana#18599) TimePicker: Set time to to 23:59:59 when setting To time using calendar (grafana#18595) Prometheus: Return labels in query results (grafana#18535) Docs: Update changelog and docs for annotation region change (grafana#18593) Refactor: move KeyValue and deprecation warning to @grafana/data (grafana#18582) Annotations: use a single row to represent a region (grafana#17673) Docs: Update upgrading guide (grafana#18547) Docs: Adds tests requirement to bugs checklist (grafana#18576) DataFrame: convert from row based to a columnar value format (grafana#18391) Packages: Temporarily skip canary releases if packages build fail (grafana#18577) ...

* grafana/master: SingleStat: use DataFrame results rather than TimeSeries/TableData (grafana#18580) TestData: attach labels to series results (grafana#18653) Singlestat: Disable new singlestat gauge usage (grafana#18610) Explore: Fixes query field layout in splitted view for Safari browsers (grafana#18654) MSI: new long file names are causing error building MSI (grafana#18646) Auth: change the error HTTP status codes (grafana#18584) Refactor: EmptyListCTA (grafana#18516) Build: Upgrade to go 1.12.9 (grafana#18638) Chore: Revert React 16.9.0 bump (grafana#18634) Azure Monitor and Log Analytics converted and separated into components (grafana#18259) Rewrite user profile edit to react (grafana#17917) Docs: remove codecov badge (grafana#18623) Prometheus: Prevents panel editor crash when switching to Prometheus datasource (grafana#18616) Chore: Rename Popper to Popover (grafana#18543) SingleStat: add a gauge migration call to action button in the editor (grafana#18604) Build: update revive dependency (grafana#18585) LDAP: multildap + ldap integration (grafana#18588)

* grafana/master: SingleStat2: save options to defaults not override (grafana#18666) Packages: Fix path import from grafana/data (grafana#18667) SingleStat: use DataFrame results rather than TimeSeries/TableData (grafana#18580) TestData: attach labels to series results (grafana#18653) Singlestat: Disable new singlestat gauge usage (grafana#18610) Explore: Fixes query field layout in splitted view for Safari browsers (grafana#18654) MSI: new long file names are causing error building MSI (grafana#18646) Auth: change the error HTTP status codes (grafana#18584) Refactor: EmptyListCTA (grafana#18516) Build: Upgrade to go 1.12.9 (grafana#18638) Chore: Revert React 16.9.0 bump (grafana#18634) Azure Monitor and Log Analytics converted and separated into components (grafana#18259) Rewrite user profile edit to react (grafana#17917) Docs: remove codecov badge (grafana#18623) Prometheus: Prevents panel editor crash when switching to Prometheus datasource (grafana#18616) Chore: Rename Popper to Popover (grafana#18543) SingleStat: add a gauge migration call to action button in the editor (grafana#18604) Build: update revive dependency (grafana#18585) LDAP: multildap + ldap integration (grafana#18588)

add gauge migration button

d9638f4

ryantxu commented Aug 16, 2019

View reviewed changes

Singlestat/Gauge: progress on handling migration from singlestat

b6aa714

move migrations to panelChange

4b66038

ryantxu and others added 5 commits August 17, 2019 23:34

logic cleanup

6dec8fc

make the settings match

3ae55b9

Refactor: change method names from check to handler suffix

3e6729a

Fixed unit test

083d5a9

put angular options under angular object when changing

beafdc3

ryantxu commented Aug 18, 2019

View reviewed changes

Merge branch 'singlestat-to-gauge' of github.com:ryantxu/grafana into…

f67bf45

… singlestat-to-gauge

ryantxu changed the title ~~WIP: add a gauge migration button to singlestat panel~~ SingleStatt: add a gauge migration button to singlestat panel Aug 18, 2019

ryantxu changed the title ~~SingleStatt: add a gauge migration button to singlestat panel~~ SingleStat: add a gauge migration call to action button in the editor Aug 18, 2019

torkelo approved these changes Aug 18, 2019

View reviewed changes

update warnings

54b6a33

ryantxu merged commit 21948e8 into grafana:master Aug 18, 2019

ryantxu deleted the singlestat-to-gauge branch August 18, 2019 22:01

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

SingleStat: add a gauge migration call to action button in the editor #18604

SingleStat: add a gauge migration call to action button in the editor #18604

ryantxu commented Aug 16, 2019 •

edited

Loading

ryantxu Aug 16, 2019

torkelo commented Aug 17, 2019

ryantxu commented Aug 18, 2019

ryantxu Aug 18, 2019

ryantxu Aug 18, 2019

SingleStat: add a gauge migration call to action button in the editor #18604

SingleStat: add a gauge migration call to action button in the editor #18604

Conversation

ryantxu commented Aug 16, 2019 • edited Loading

ryantxu Aug 16, 2019

Choose a reason for hiding this comment

torkelo commented Aug 17, 2019

ryantxu commented Aug 18, 2019

ryantxu Aug 18, 2019

Choose a reason for hiding this comment

ryantxu Aug 18, 2019

Choose a reason for hiding this comment

ryantxu commented Aug 16, 2019 •

edited

Loading