diff --git a/.eslintrc b/.eslintrc
index aaedb7c2cbd0eada529e19bfd83946776f0c8064..483af44e716721de3bf3108885c53cf68755d000 100644
--- a/.eslintrc
+++ b/.eslintrc
@@ -43,7 +43,8 @@
},
"globals": {
"pending": false,
- "t": false
+ "t": false,
+ "jt": false
},
"env": {
"browser": true,
diff --git a/docs/api-documentation.md b/docs/api-documentation.md
index cc23fffd5a56d5be31d344cfaf6074e891da5654..2b303f31424308f677dd11b22e406cc1e4ad53a1 100644
--- a/docs/api-documentation.md
+++ b/docs/api-documentation.md
@@ -1,4 +1,4 @@
-# API Documentation for Metabase v0.24.0-snapshot
+# API Documentation for Metabase v0.27.0-snapshot
## `GET /api/activity/`
@@ -10,6 +10,92 @@ Get recent activity.
Get the list of 10 things the current user has been viewing most recently.
+## `DELETE /api/alert/:id`
+
+Remove an alert
+
+##### PARAMS:
+
+* **`id`**
+
+
+## `GET /api/alert/`
+
+Fetch all alerts
+
+
+## `GET /api/alert/question/:id`
+
+Fetch all questions for the given question (`Card`) id
+
+##### PARAMS:
+
+* **`id`**
+
+
+## `POST /api/alert/`
+
+Create a new alert (`Pulse`)
+
+##### PARAMS:
+
+* **`alert_condition`** value must be one of: `goal`, `rows`.
+
+* **`card`** value must be a map.
+
+* **`channels`** value must be an array. Each value must be a map. The array cannot be empty.
+
+* **`alert_first_only`** value must be a boolean.
+
+* **`alert_above_goal`** value may be nil, or if non-nil, value must be a boolean.
+
+* **`req`**
+
+
+## `PUT /api/alert/:id`
+
+Update a `Alert` with ID.
+
+##### PARAMS:
+
+* **`id`**
+
+* **`alert_condition`** value must be one of: `goal`, `rows`.
+
+* **`card`** value must be a map.
+
+* **`channels`** value must be an array. Each value must be a map. The array cannot be empty.
+
+* **`alert_first_only`** value must be a boolean.
+
+* **`alert_above_goal`** value may be nil, or if non-nil, value must be a boolean.
+
+* **`req`**
+
+
+## `PUT /api/alert/:id/unsubscribe`
+
+Unsubscribes a user from the given alert
+
+##### PARAMS:
+
+* **`id`**
+
+
+## `GET /api/async/:id`
+
+Get result of async computation job with ID.
+
+##### PARAMS:
+
+* **`id`**
+
+
+## `GET /api/async/running-jobs`
+
+Get all running jobs belonging to the current user.
+
+
## `DELETE /api/card/:card-id/favorite`
Unfavorite a Card.
@@ -105,6 +191,10 @@ Create a new `Card`.
* **`collection_id`** value may be nil, or if non-nil, value must be an integer greater than zero.
+* **`result_metadata`** value may be nil, or if non-nil, value must be an array of valid results column metadata maps.
+
+* **`metadata_checksum`** value may be nil, or if non-nil, value must be a non-blank string.
+
## `POST /api/card/:card-id/favorite`
@@ -190,6 +280,10 @@ Update a `Card`.
* **`archived`** value may be nil, or if non-nil, value must be a boolean.
+* **`result_metadata`** value may be nil, or if non-nil, value must be an array of valid results column metadata maps.
+
+* **`metadata_checksum`** value may be nil, or if non-nil, value must be a non-blank string.
+
* **`enable_embedding`** value may be nil, or if non-nil, value must be a boolean.
* **`collection_id`** value may be nil, or if non-nil, value must be an integer greater than zero.
@@ -372,6 +466,8 @@ Create a new `Dashboard`.
* **`name`** value must be a non-blank string.
+* **`description`** value may be nil, or if non-nil, value must be a string.
+
* **`parameters`** value must be an array. Each value must be a map.
* **`dashboard`**
@@ -495,7 +591,9 @@ Fetch all `Databases`.
##### PARAMS:
-* **`include_tables`**
+* **`include_tables`** value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').
+
+* **`include_cards`** value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').
## `GET /api/database/:id`
@@ -551,6 +649,12 @@ Get metadata about a `Database`, including all of its `Tables` and `Fields`.
* **`id`**
+## `GET /api/database/:virtual-db/metadata`
+
+Endpoint that provides metadata for the Saved Questions 'virtual' database. Used for fooling the frontend
+ and allowing it to treat the Saved Questions virtual DB just like any other database.
+
+
## `POST /api/database/`
Add a new `Database`.
@@ -565,12 +669,49 @@ You must be a superuser to do this.
* **`details`** value must be a map.
-* **`is_full_sync`**
+* **`is_full_sync`** value may be nil, or if non-nil, value must be a boolean.
+
+* **`is_on_demand`** value may be nil, or if non-nil, value must be a boolean.
+
+* **`schedules`** value may be nil, or if non-nil, value must be a valid map of schedule maps for a DB.
+
+
+## `POST /api/database/:id/discard_values`
+
+Discards all saved field values for this `Database`.
+
+You must be a superuser to do this.
+
+##### PARAMS:
+
+* **`id`**
+
+
+## `POST /api/database/:id/rescan_values`
+
+Trigger a manual scan of the field values for this `Database`.
+
+You must be a superuser to do this.
+
+##### PARAMS:
+
+* **`id`**
## `POST /api/database/:id/sync`
-Update the metadata for this `Database`.
+Update the metadata for this `Database`. This happens asynchronously.
+
+##### PARAMS:
+
+* **`id`**
+
+
+## `POST /api/database/:id/sync_schema`
+
+Trigger a manual update of the schema metadata for this `Database`.
+
+You must be a superuser to do this.
##### PARAMS:
@@ -584,6 +725,19 @@ Add the sample dataset as a new `Database`.
You must be a superuser to do this.
+## `POST /api/database/validate`
+
+Validate that we can connect to a database given a set of details.
+
+You must be a superuser to do this.
+
+##### PARAMS:
+
+* **`engine`** value must be a valid database engine.
+
+* **`details`** value must be a map.
+
+
## `PUT /api/database/:id`
Update a `Database`.
@@ -592,21 +746,25 @@ You must be a superuser to do this.
##### PARAMS:
-* **`id`**
+* **`engine`** value may be nil, or if non-nil, value must be a valid database engine.
-* **`name`** value must be a non-blank string.
+* **`schedules`** value may be nil, or if non-nil, value must be a valid map of schedule maps for a DB.
-* **`engine`** value must be a valid database engine.
+* **`points_of_interest`** value may be nil, or if non-nil, value must be a string.
-* **`details`** value must be a map.
+* **`description`** value may be nil, or if non-nil, value must be a string.
+
+* **`name`** value may be nil, or if non-nil, value must be a non-blank string.
+
+* **`caveats`** value may be nil, or if non-nil, value must be a string.
* **`is_full_sync`**
-* **`description`**
+* **`details`** value may be nil, or if non-nil, value must be a map.
-* **`caveats`**
+* **`id`**
-* **`points_of_interest`**
+* **`is_on_demand`**
## `POST /api/dataset/`
@@ -615,7 +773,9 @@ Execute a query and retrieve the results in the usual format.
##### PARAMS:
-* **`database`**
+* **`database`** value must be an integer.
+
+* **`query`**
## `POST /api/dataset/:export-format`
@@ -741,6 +901,15 @@ Fetch the results of running a Card belonging to a Dashboard using a JSON Web To
* **`query-params`**
+## `DELETE /api/field/:id/dimension`
+
+Remove the dimension associated to field at ID
+
+##### PARAMS:
+
+* **`id`**
+
+
## `GET /api/field/:id`
Get `Field` with ID.
@@ -769,16 +938,66 @@ If `Field`'s special type derives from `type/Category`, or its base type is `typ
* **`id`**
-## `POST /api/field/:id/value_map_update`
+## `GET /api/field/field-literal%2C:field-name%2Ctype%2F:field-type/values`
+
+Implementation of the field values endpoint for fields in the Saved Questions 'virtual' DB.
+ This endpoint is just a convenience to simplify the frontend code. It just returns the standard
+ 'empty' field values response.
+
+##### PARAMS:
+
+* **`_`**
+
+
+## `POST /api/field/:id/dimension`
+
+Sets the dimension for the given field at ID
+
+##### PARAMS:
+
+* **`id`**
+
+* **`type`** value must be one of: `external`, `internal`.
+
+* **`name`** value must be a non-blank string.
+
+* **`human_readable_field_id`** value may be nil, or if non-nil, value must be an integer greater than zero.
+
+
+## `POST /api/field/:id/discard_values`
+
+Discard the FieldValues belonging to this Field. Only applies to fields that have FieldValues. If this Field's
+ Database is set up to automatically sync FieldValues, they will be recreated during the next cycle.
+
+You must be a superuser to do this.
+
+##### PARAMS:
+
+* **`id`**
+
+
+## `POST /api/field/:id/rescan_values`
-Update the human-readable values for a `Field` whose special type is `category`/`city`/`state`/`country`
- or whose base type is `type/Boolean`.
+Manually trigger an update for the FieldValues for this Field. Only applies to Fields that are eligible for
+ FieldValues.
+
+You must be a superuser to do this.
+
+##### PARAMS:
+
+* **`id`**
+
+
+## `POST /api/field/:id/values`
+
+Update the fields values and human-readable values for a `Field` whose special type is `category`/`city`/`state`/`country`
+ or whose base type is `type/Boolean`. The human-readable values are optional.
##### PARAMS:
* **`id`**
-* **`values_map`** value must be a map.
+* **`value-pairs`** value must be an array.
## `PUT /api/field/:id`
@@ -795,7 +1014,7 @@ Update `Field` with ID.
* **`display_name`** value may be nil, or if non-nil, value must be a non-blank string.
-* **`fk_target_field_id`** value may be nil, or if non-nil, value must be an integer.
+* **`fk_target_field_id`** value may be nil, or if non-nil, value must be an integer greater than zero.
* **`points_of_interest`** value may be nil, or if non-nil, value must be a non-blank string.
@@ -856,6 +1075,17 @@ Fetch basic info for the Getting Started guide.
* **`icon`** value may be nil, or if non-nil, value must be a non-blank string.
+## `PUT /api/ldap/settings`
+
+Update LDAP related settings. You must be a superuser to do this.
+
+You must be a superuser to do this.
+
+##### PARAMS:
+
+* **`settings`** value must be a map.
+
+
## `DELETE /api/metric/:id`
Delete a `Metric`.
@@ -1138,7 +1368,8 @@ Fetch the results of running a Card belonging to a Dashboard you're considering
## `GET /api/public/card/:uuid`
-Fetch a publically-accessible Card an return query results as well as `:card` information. Does not require auth credentials. Public sharing must be enabled.
+Fetch a publically-accessible Card an return query results as well as `:card` information. Does not require auth
+ credentials. Public sharing must be enabled.
##### PARAMS:
@@ -1147,7 +1378,8 @@ Fetch a publically-accessible Card an return query results as well as `:card` in
## `GET /api/public/card/:uuid/query`
-Fetch a publically-accessible Card an return query results as well as `:card` information. Does not require auth credentials. Public sharing must be enabled.
+Fetch a publically-accessible Card an return query results as well as `:card` information. Does not require auth
+ credentials. Public sharing must be enabled.
##### PARAMS:
@@ -1158,7 +1390,8 @@ Fetch a publically-accessible Card an return query results as well as `:card` in
## `GET /api/public/card/:uuid/query/:export-format`
-Fetch a publically-accessible Card and return query results in the specified format. Does not require auth credentials. Public sharing must be enabled.
+Fetch a publically-accessible Card and return query results in the specified format. Does not require auth
+ credentials. Public sharing must be enabled.
##### PARAMS:
@@ -1180,7 +1413,8 @@ Fetch a publically-accessible Dashboard. Does not require auth credentials. Publ
## `GET /api/public/dashboard/:uuid/card/:card-id`
-Fetch the results for a Card in a publically-accessible Dashboard. Does not require auth credentials. Public sharing must be enabled.
+Fetch the results for a Card in a publically-accessible Dashboard. Does not require auth credentials. Public
+ sharing must be enabled.
##### PARAMS:
@@ -1193,7 +1427,7 @@ Fetch the results for a Card in a publically-accessible Dashboard. Does not requ
## `GET /api/public/oembed`
-oEmbed endpoint used to retrieve embed code and metadata for a (public) Metabase URL.
+oEmbed endpoint used to retreive embed code and metadata for a (public) Metabase URL.
##### PARAMS:
@@ -1448,7 +1682,7 @@ Login.
##### PARAMS:
-* **`email`** value must be a valid email address.
+* **`username`** value must be a non-blank string.
* **`password`** value must be a non-blank string.
@@ -1538,6 +1772,8 @@ Special endpoint for creating the first user during setup.
* **`engine`**
+* **`schedules`** value may be nil, or if non-nil, value must be a valid map of schedule maps for a DB.
+
* **`allow_tracking`** value may be nil, or if non-nil, value must satisfy one of the following requirements: 1) value must be a boolean. 2) value must be a valid boolean string ('true' or 'false').
* **`email`** value must be a valid email address.
@@ -1556,6 +1792,8 @@ Special endpoint for creating the first user during setup.
* **`details`**
+* **`is_on_demand`**
+
* **`last_name`** value must be a non-blank string.
@@ -1629,6 +1867,45 @@ Get metadata about a `Table` useful for running queries.
* **`include_sensitive_fields`** value may be nil, or if non-nil, value must be a valid boolean string ('true' or 'false').
+## `GET /api/table/card__:id/fks`
+
+Return FK info for the 'virtual' table for a Card. This is always empty, so this endpoint
+ serves mainly as a placeholder to avoid having to change anything on the frontend.
+
+
+## `GET /api/table/card__:id/query_metadata`
+
+Return metadata for the 'virtual' table for a Card.
+
+##### PARAMS:
+
+* **`id`**
+
+
+## `POST /api/table/:id/discard_values`
+
+Discard the FieldValues belonging to the Fields in this Table. Only applies to fields that have FieldValues. If
+ this Table's Database is set up to automatically sync FieldValues, they will be recreated during the next cycle.
+
+You must be a superuser to do this.
+
+##### PARAMS:
+
+* **`id`**
+
+
+## `POST /api/table/:id/rescan_values`
+
+Manually trigger an update for the FieldValues for the Fields belonging to this Table. Only applies to Fields that
+ are eligible for FieldValues.
+
+You must be a superuser to do this.
+
+##### PARAMS:
+
+* **`id`**
+
+
## `PUT /api/table/:id`
Update `Table` with ID.
@@ -1643,13 +1920,13 @@ Update `Table` with ID.
* **`visibility_type`** value may be nil, or if non-nil, value must be one of: `cruft`, `hidden`, `technical`.
-* **`description`**
+* **`description`** value may be nil, or if non-nil, value must be a non-blank string.
-* **`caveats`**
+* **`caveats`** value may be nil, or if non-nil, value must be a non-blank string.
-* **`points_of_interest`**
+* **`points_of_interest`** value may be nil, or if non-nil, value must be a non-blank string.
-* **`show_in_getting_started`**
+* **`show_in_getting_started`** value may be nil, or if non-nil, value must be a boolean.
## `GET /api/tiles/:zoom/:x/:y/:lat-field-id/:lon-field-id/:lat-col-idx/:lon-col-idx/`
@@ -1709,7 +1986,7 @@ Fetch the current `User`.
## `POST /api/user/`
-Create a new `User`, or or reactivate an existing one.
+Create a new `User`, or or reäctivate an existing one.
You must be a superuser to do this.
@@ -1783,7 +2060,7 @@ You must be a superuser to do this.
## `GET /api/util/random_token`
-Return a cryptographically secure random 32-byte token, encoded as a hexadecimal string.
+Return a cryptographically secure random 32-byte token, encoded as a hexidecimal string.
Intended for use when creating a value for `embedding-secret-key`.
@@ -1802,3 +2079,276 @@ Endpoint that checks if the supplied password meets the currently configured pas
##### PARAMS:
* **`password`** Insufficient password strength
+
+
+## `GET /api/x-ray/card/:id`
+
+X-ray a card.
+
+##### PARAMS:
+
+* **`id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/compare/card/:card-id/segment/:segment-id`
+
+Get comparison x-ray of a card and a segment.
+
+##### PARAMS:
+
+* **`card-id`**
+
+* **`segment-id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/compare/card/:card-id/table/:table-id`
+
+Get comparison x-ray of a table and a card.
+
+##### PARAMS:
+
+* **`card-id`**
+
+* **`table-id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/compare/cards/:card1-id/:card2-id`
+
+Get comparison x-ray of two cards.
+
+##### PARAMS:
+
+* **`card1-id`**
+
+* **`card2-id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/compare/fields/:field1-id/:field2-id`
+
+Get comparison x-ray of two fields.
+
+##### PARAMS:
+
+* **`field1-id`**
+
+* **`field2-id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/compare/segment/:segment-id/card/:card-id`
+
+Get comparison x-ray of a card and a segment.
+
+##### PARAMS:
+
+* **`segment-id`**
+
+* **`card-id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/compare/segment/:segment-id/table/:table-id`
+
+Get comparison x-ray of a table and a segment.
+
+##### PARAMS:
+
+* **`segment-id`**
+
+* **`table-id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/compare/segments/:segment1-id/:segment2-id`
+
+Get comparison x-ray of two segments.
+
+##### PARAMS:
+
+* **`segment1-id`**
+
+* **`segment2-id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/compare/table/:table-id/card/:card-id`
+
+Get comparison x-ray of a table and a card.
+
+##### PARAMS:
+
+* **`table-id`**
+
+* **`card-id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/compare/table/:table-id/segment/:segment-id`
+
+Get comparison x-ray of a table and a segment.
+
+##### PARAMS:
+
+* **`table-id`**
+
+* **`segment-id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/compare/tables/:table1-id/:table2-id`
+
+Get comparison x-ray of two tables.
+
+##### PARAMS:
+
+* **`table1-id`**
+
+* **`table2-id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/field/:id`
+
+X-ray a field.
+
+##### PARAMS:
+
+* **`id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/metric/:id`
+
+X-ray a metric.
+
+##### PARAMS:
+
+* **`id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/segment/:id`
+
+X-ray a segment.
+
+##### PARAMS:
+
+* **`id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `GET /api/x-ray/table/:id`
+
+X-ray a table.
+
+##### PARAMS:
+
+* **`id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+
+## `POST /api/x-ray/compare/card/:id/query`
+
+Get comparison x-ray of card and ad-hoc query.
+
+##### PARAMS:
+
+* **`id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+* **`query`**
+
+
+## `POST /api/x-ray/compare/segment/:id/query`
+
+Get comparison x-ray of segment and ad-hoc query.
+
+##### PARAMS:
+
+* **`id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+* **`query`**
+
+
+## `POST /api/x-ray/compare/table/:id/query`
+
+Get comparison x-ray of table and ad-hoc query.
+
+##### PARAMS:
+
+* **`id`**
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+* **`query`**
+
+
+## `POST /api/x-ray/query`
+
+X-ray a query.
+
+##### PARAMS:
+
+* **`max_query_cost`** value may be nil, or if non-nil, value must be one of: `cache`, `full-scan`, `joins`, `sample`.
+
+* **`max_computation_cost`** value may be nil, or if non-nil, value must be one of: `linear`, `unbounded`, `yolo`.
+
+* **`query`**
\ No newline at end of file
diff --git a/frontend/src/metabase-lib/lib/Alert.js b/frontend/src/metabase-lib/lib/Alert.js
new file mode 100644
index 0000000000000000000000000000000000000000..8fdb52cfc231118cd3b82c6ee030b2a3e8f9fe16
--- /dev/null
+++ b/frontend/src/metabase-lib/lib/Alert.js
@@ -0,0 +1,36 @@
+export const ALERT_TYPE_ROWS = "alert-type-rows";
+export const ALERT_TYPE_TIMESERIES_GOAL = "alert-type-timeseries-goal";
+export const ALERT_TYPE_PROGRESS_BAR_GOAL = "alert-type-progress-bar-goal";
+
+export type AlertType =
+ | ALERT_TYPE_ROWS
+ | ALERT_TYPE_TIMESERIES_GOAL
+ | ALERT_TYPE_PROGRESS_BAR_GOAL;
+
+export const getDefaultAlert = (question, user) => {
+ const alertType = question.alertType();
+
+ const typeDependentAlertFields = alertType === ALERT_TYPE_ROWS
+ ? { alert_condition: "rows", alert_first_only: false }
+ : {
+ alert_condition: "goal",
+ alert_first_only: true,
+ alert_above_goal: true
+ };
+
+ const defaultEmailChannel = {
+ enabled: true,
+ channel_type: "email",
+ recipients: [user],
+ schedule_day: "mon",
+ schedule_frame: null,
+ schedule_hour: 0,
+ schedule_type: "daily"
+ };
+
+ return {
+ card: { id: question.id() },
+ channels: [defaultEmailChannel],
+ ...typeDependentAlertFields
+ };
+};
diff --git a/frontend/src/metabase-lib/lib/Question.js b/frontend/src/metabase-lib/lib/Question.js
index f3c73e9b6d97e1068f09a63b4f2ac1da9d03b953..4856f6db62ddd22d61031b35dafa9c881f9d8a17 100644
--- a/frontend/src/metabase-lib/lib/Question.js
+++ b/frontend/src/metabase-lib/lib/Question.js
@@ -36,7 +36,8 @@ import type {
} from "metabase/meta/types/Parameter";
import type {
DatasetQuery,
- Card as CardObject
+ Card as CardObject,
+ VisualizationSettings
} from "metabase/meta/types/Card";
import { MetabaseApi, CardApi } from "metabase/services";
@@ -47,6 +48,11 @@ import type { TableId } from "metabase/meta/types/Table";
import type { DatabaseId } from "metabase/meta/types/Database";
import * as Urls from "metabase/lib/urls";
import Mode from "metabase-lib/lib/Mode";
+import {
+ ALERT_TYPE_PROGRESS_BAR_GOAL,
+ ALERT_TYPE_ROWS,
+ ALERT_TYPE_TIMESERIES_GOAL
+} from "metabase-lib/lib/Alert";
/**
* This is a wrapper around a question/card object, which may contain one or more Query objects
@@ -159,6 +165,10 @@ export default class Question {
throw new Error("Unknown query type: " + datasetQuery.type);
}
+ isNative(): boolean {
+ return this.query() instanceof NativeQuery;
+ }
+
/**
* Returns a new Question object with an updated query.
* The query is saved to the `dataset_query` field of the Card object.
@@ -197,6 +207,15 @@ export default class Question {
return this.setCard(assoc(this.card(), "display", display));
}
+ visualizationSettings(): VisualizationSettings {
+ return this._card && this._card.visualization_settings;
+ }
+ setVisualizationSettings(settings: VisualizationSettings) {
+ return this.setCard(
+ assoc(this.card(), "visualization_settings", settings)
+ );
+ }
+
isEmpty(): boolean {
return this.query().isEmpty();
}
@@ -211,6 +230,30 @@ export default class Question {
return this._card && this._card.can_write;
}
+ alertType() {
+ const mode = this.mode();
+ const display = this.display();
+
+ if (!this.canRun()) {
+ return null;
+ }
+
+ if (display === "progress") {
+ return ALERT_TYPE_PROGRESS_BAR_GOAL;
+ } else if (mode && mode.name() === "timeseries") {
+ const vizSettings = this.card().visualization_settings;
+ // NOTE Atte Keinänen 11/6/17: Seems that `graph.goal_value` setting can be missing if
+ // only the "Show goal" toggle has been toggled but "Goal value" value hasn't explicitly been set
+ if (vizSettings["graph.show_goal"] === true) {
+ return ALERT_TYPE_TIMESERIES_GOAL;
+ } else {
+ return ALERT_TYPE_ROWS;
+ }
+ } else {
+ return ALERT_TYPE_ROWS;
+ }
+ }
+
/**
* Visualization drill-through and action widget actions
*
diff --git a/frontend/src/metabase/alert/alert.js b/frontend/src/metabase/alert/alert.js
new file mode 100644
index 0000000000000000000000000000000000000000..c36f3cb71189c00d09a5039651938bd4bf7ae32a
--- /dev/null
+++ b/frontend/src/metabase/alert/alert.js
@@ -0,0 +1,147 @@
+import React from "react";
+import _ from "underscore"
+import { handleActions } from "redux-actions";
+import { combineReducers } from "redux";
+import { addUndo, createUndo } from "metabase/redux/undo";
+
+import { AlertApi } from "metabase/services";
+import { RestfulRequest } from "metabase/lib/request";
+import Icon from "metabase/components/Icon.jsx";
+
+export const FETCH_ALL_ALERTS = 'metabase/alerts/FETCH_ALL_ALERTS'
+const fetchAllAlertsRequest = new RestfulRequest({
+ endpoint: AlertApi.list,
+ actionPrefix: FETCH_ALL_ALERTS,
+ storeAsDictionary: true
+})
+export const fetchAllAlerts = () => {
+ return async (dispatch, getState) => {
+ await dispatch(fetchAllAlertsRequest.trigger())
+ dispatch.action(FETCH_ALL_ALERTS)
+ }
+}
+
+export const FETCH_ALERTS_FOR_QUESTION_CLEAR_OLD_ALERTS = 'metabase/alerts/FETCH_ALERTS_FOR_QUESTION_CLEAR_OLD_ALERTS'
+export const FETCH_ALERTS_FOR_QUESTION = 'metabase/alerts/FETCH_ALERTS_FOR_QUESTION'
+const fetchAlertsForQuestionRequest = new RestfulRequest({
+ endpoint: AlertApi.list_for_question,
+ actionPrefix: FETCH_ALERTS_FOR_QUESTION,
+ storeAsDictionary: true
+})
+export const fetchAlertsForQuestion = (questionId) => {
+ return async (dispatch, getState) => {
+ dispatch.action(FETCH_ALERTS_FOR_QUESTION_CLEAR_OLD_ALERTS, questionId)
+ await dispatch(fetchAlertsForQuestionRequest.trigger({ questionId }))
+ dispatch.action(FETCH_ALERTS_FOR_QUESTION)
+ }
+}
+
+export const CREATE_ALERT = 'metabase/alerts/CREATE_ALERT'
+const createAlertRequest = new RestfulRequest({
+ endpoint: AlertApi.create,
+ actionPrefix: CREATE_ALERT,
+ storeAsDictionary: true
+})
+export const createAlert = (alert) => {
+ return async (dispatch, getState) => {
+ // TODO: How to handle a failed creation and display it to a user?
+ // Maybe RestfulRequest.trigger should throw an exception
+ // that the React component calling createAlert could catch ...?
+ await dispatch(createAlertRequest.trigger(alert))
+
+ dispatch(addUndo(createUndo({
+ type: "create-alert",
+ // eslint-disable-next-line react/display-name
+ message: () => <div className="flex align-center text-bold"><Icon name="alertConfirm" size="19" className="mr2 text-success" />Your alert is all set up.</div>,
+ action: null // alert creation is not undoable
+ })));
+
+ dispatch.action(CREATE_ALERT)
+ }
+}
+
+export const UPDATE_ALERT = 'metabase/alerts/UPDATE_ALERT'
+const updateAlertRequest = new RestfulRequest({
+ endpoint: AlertApi.update,
+ actionPrefix: UPDATE_ALERT,
+ storeAsDictionary: true
+})
+export const updateAlert = (alert) => {
+ return async (dispatch, getState) => {
+ await dispatch(updateAlertRequest.trigger(alert))
+
+ dispatch(addUndo(createUndo({
+ type: "update-alert",
+ // eslint-disable-next-line react/display-name
+ message: () => <div className="flex align-center text-bold"><Icon name="alertConfirm" size="19" className="mr2 text-success" />Your alert was updated.</div>,
+ action: null // alert updating is not undoable
+ })));
+
+ dispatch.action(UPDATE_ALERT)
+ }
+}
+
+export const UNSUBSCRIBE_FROM_ALERT = 'metabase/alerts/UNSUBSCRIBE_FROM_ALERT'
+export const UNSUBSCRIBE_FROM_ALERT_CLEANUP = 'metabase/alerts/UNSUBSCRIBE_FROM_ALERT_CLEANUP'
+const unsubscribeFromAlertRequest = new RestfulRequest({
+ endpoint: AlertApi.unsubscribe,
+ actionPrefix: UNSUBSCRIBE_FROM_ALERT,
+ storeAsDictionary: true
+})
+export const unsubscribeFromAlert = (alert) => {
+ return async (dispatch, getState) => {
+ await dispatch(unsubscribeFromAlertRequest.trigger(alert))
+ dispatch.action(UNSUBSCRIBE_FROM_ALERT)
+
+ // This delay lets us to show "You're unsubscribed" text in place of an
+ // alert list item for a while before removing the list item completely
+ setTimeout(() => dispatch.action(UNSUBSCRIBE_FROM_ALERT_CLEANUP, alert.id), 5000)
+ }
+}
+
+export const DELETE_ALERT = 'metabase/alerts/DELETE_ALERT'
+const deleteAlertRequest = new RestfulRequest({
+ endpoint: AlertApi.delete,
+ actionPrefix: DELETE_ALERT,
+ storeAsDictionary: true
+})
+export const deleteAlert = (alertId) => {
+ return async (dispatch, getState) => {
+ await dispatch(deleteAlertRequest.trigger({ id: alertId }))
+
+ dispatch(addUndo(createUndo({
+ type: "delete-alert",
+ // eslint-disable-next-line react/display-name
+ message: () => <div className="flex align-center text-bold"><Icon name="alertConfirm" size="19" className="mr2 text-success" />The alert was successfully deleted.</div>,
+ action: null // alert deletion is not undoable
+ })));
+ dispatch.action(DELETE_ALERT, alertId)
+ }
+}
+
+// removal from the result dictionary (not supported by RestfulRequest yet)
+const removeAlertReducer = (state, { payload: alertId }) => ({
+ ...state,
+ result: _.omit(state.result || {}, alertId)
+})
+
+const removeAlertsForQuestionReducer = (state, { payload: questionId }) => {
+ return ({
+ ...state,
+ result: _.omit(state.result || {}, (alert) => alert.card.id === questionId)
+ })
+}
+
+const alerts = handleActions({
+ ...fetchAllAlertsRequest.getReducers(),
+ [FETCH_ALERTS_FOR_QUESTION_CLEAR_OLD_ALERTS]: removeAlertsForQuestionReducer,
+ ...fetchAlertsForQuestionRequest.getReducers(),
+ ...createAlertRequest.getReducers(),
+ ...updateAlertRequest.getReducers(),
+ [DELETE_ALERT]: removeAlertReducer,
+ [UNSUBSCRIBE_FROM_ALERT_CLEANUP]: removeAlertReducer,
+}, []);
+
+export default combineReducers({
+ alerts
+});
diff --git a/frontend/src/metabase/alert/selectors.js b/frontend/src/metabase/alert/selectors.js
new file mode 100644
index 0000000000000000000000000000000000000000..c59f42e77c9fe85419a038efd4717d014da19fb4
--- /dev/null
+++ b/frontend/src/metabase/alert/selectors.js
@@ -0,0 +1 @@
+export const getAlerts = (state) => state.alert.alerts.result
diff --git a/frontend/src/metabase/components/ButtonWithStatus.jsx b/frontend/src/metabase/components/ButtonWithStatus.jsx
index 6b00d74988356ebedf6f84a6e66b373ca881e009..d042ecba11d2a44d99d78899c3e489a730803ecd 100644
--- a/frontend/src/metabase/components/ButtonWithStatus.jsx
+++ b/frontend/src/metabase/components/ButtonWithStatus.jsx
@@ -21,7 +21,7 @@ export default class ButtonWithStatus extends Component {
onClickOperation: (any) => Promise<void>,
titleForState?: string[],
disabled?: boolean,
- className?: string
+ className?: string,
}
state = {
@@ -44,7 +44,7 @@ export default class ButtonWithStatus extends Component {
render() {
const { progressState } = this.state;
- const titleForState = this.props.titleForState || defaultTitleForState
+ const titleForState = {...defaultTitleForState, ...(this.props.titleForState || {})}
const title = titleForState[progressState];
const disabled = this.props.disabled || progressState !== "default";
diff --git a/frontend/src/metabase/pulse/components/SetupMessage.jsx b/frontend/src/metabase/components/ChannelSetupMessage.jsx
similarity index 92%
rename from frontend/src/metabase/pulse/components/SetupMessage.jsx
rename to frontend/src/metabase/components/ChannelSetupMessage.jsx
index 6b50514798e3baa15e1cdddff96c28bbe9d0636f..96ad7087777cbec1d12c0c001ae16c44cf558867 100644
--- a/frontend/src/metabase/pulse/components/SetupMessage.jsx
+++ b/frontend/src/metabase/components/ChannelSetupMessage.jsx
@@ -5,14 +5,14 @@ import { Link } from "react-router";
import Settings from "metabase/lib/settings";
-export default class SetupMessage extends Component {
+export default class ChannelSetupMessage extends Component {
static propTypes = {
user: PropTypes.object.isRequired,
channels: PropTypes.array.isRequired
};
static defaultProps = {
- channels: ["Email", "Slack"]
+ channels: ["email", "Slack"]
}
render() {
diff --git a/frontend/src/metabase/components/ChannelSetupModal.jsx b/frontend/src/metabase/components/ChannelSetupModal.jsx
new file mode 100644
index 0000000000000000000000000000000000000000..e42ca76ff1c3b16e988dcee6681c9915e2fd2aac
--- /dev/null
+++ b/frontend/src/metabase/components/ChannelSetupModal.jsx
@@ -0,0 +1,39 @@
+/* eslint "react/prop-types": "warn" */
+import React, { Component } from "react";
+import PropTypes from "prop-types";
+import cx from "classnames";
+
+import ModalContent from "metabase/components/ModalContent.jsx";
+import ChannelSetupMessage from "metabase/components/ChannelSetupMessage";
+
+export default class ChannelSetupModal extends Component {
+ static propTypes = {
+ onClose: PropTypes.func.isRequired,
+ user: PropTypes.object.isRequired,
+ entityNamePlural: PropTypes.string.isRequired,
+ channels: PropTypes.array,
+ fullPageModal: PropTypes.boolean,
+ };
+
+ static defaultProps = {
+ channels: ["email", "Slack"]
+ }
+
+ render() {
+ const { onClose, user, entityNamePlural, fullPageModal, channels } = this.props
+
+
+ return (
+ <ModalContent
+ onClose={onClose}
+ fullPageModal={fullPageModal}
+ title={`To send ${entityNamePlural}, ${ user.is_superuser ? "you'll need" : "an admin needs"} to set up ${channels.join(" or ")} integration.`}
+ >
+ <div className={cx("ml-auto mb4", { "mr4": !fullPageModal, "mr-auto text-centered": fullPageModal })}>
+ <ChannelSetupMessage user={this.props.user} />
+ </div>
+ </ModalContent>
+ );
+ }
+}
+
diff --git a/frontend/src/metabase/components/DeleteModalWithConfirm.jsx b/frontend/src/metabase/components/DeleteModalWithConfirm.jsx
index 4a2113099b5b70e1612af9f5e36f5d64390f16ea..45651ba60d6de5d76150ef7d9860c6cf69f968d8 100644
--- a/frontend/src/metabase/components/DeleteModalWithConfirm.jsx
+++ b/frontend/src/metabase/components/DeleteModalWithConfirm.jsx
@@ -18,7 +18,7 @@ export default class DeleteModalWithConfirm extends Component {
}
static propTypes = {
- objectName: PropTypes.string.isRequired,
+ title: PropTypes.string.isRequired,
objectType: PropTypes.string.isRequired,
confirmItems: PropTypes.array.isRequired,
onClose: PropTypes.func.isRequired,
@@ -31,12 +31,12 @@ export default class DeleteModalWithConfirm extends Component {
}
render() {
- const { objectName, objectType, confirmItems } = this.props;
+ const { title, objectType, confirmItems } = this.props;
const { checked } = this.state;
let confirmed = confirmItems.reduce((acc, item, index) => acc && checked[index], true);
return (
<ModalContent
- title={"Delete \"" + objectName + "\"?"}
+ title={title}
onClose={this.props.onClose}
>
<div className="px4">
diff --git a/frontend/src/metabase/components/EntityMenu.jsx b/frontend/src/metabase/components/EntityMenu.jsx
index 54bda7a710d520540437b9f12ef59af7575d6223..68914a64acf39c6771c262e7c1e4de3ffb171494 100644
--- a/frontend/src/metabase/components/EntityMenu.jsx
+++ b/frontend/src/metabase/components/EntityMenu.jsx
@@ -1,4 +1,3 @@
-/* @flow */
import React, { Component } from 'react'
import { Motion, spring } from 'react-motion'
@@ -25,17 +24,29 @@ class EntityMenu extends Component {
props: Props
state = {
- open: false
+ open: false,
+ freezeMenu: false,
+ menuItemContent: null
}
toggleMenu = () => {
+ if (this.state.freezeMenu) return;
+
const open = !this.state.open
- this.setState({ open })
+ this.setState({ open, menuItemContent: null })
+ }
+
+ setFreezeMenu = (freezeMenu: boolean) => {
+ this.setState({ freezeMenu })
+ }
+
+ replaceMenuWithItemContent = (menuItemContent: any) => {
+ this.setState({ menuItemContent })
}
render () {
const { items, triggerIcon } = this.props
- const { open } = this.state
+ const { open, menuItemContent } = this.state
return (
<div className="relative">
<EntityMenuTrigger
@@ -70,20 +81,34 @@ class EntityMenu extends Component {
}}
>
<Card>
- <ol className="py1" style={{ minWidth: 210 }}>
- {items.map(item => {
- return (
- <li key={item.title}>
- <EntityMenuItem
- icon={item.icon}
- title={item.title}
- action={item.action}
- link={item.link}
- />
- </li>
- )
- })}
- </ol>
+ { menuItemContent ||
+ <ol className="py1" style={{ minWidth: 210 }}>
+ {items.map(item => {
+ if (item.content) {
+ return (
+ <li key={item.title}>
+ <EntityMenuItem
+ icon={item.icon}
+ title={item.title}
+ action={() => this.replaceMenuWithItemContent(item.content(this.toggleMenu, this.setFreezeMenu))}
+ />
+ </li>
+ )
+ } else {
+ return (
+ <li key={item.title}>
+ <EntityMenuItem
+ icon={item.icon}
+ title={item.title}
+ action={() => {item.action(); this.toggleMenu()}}
+ link={item.link}
+ />
+ </li>
+ )
+ }
+ })}
+ </ol>
+ }
</Card>
</div>
</OnClickOutsideWrapper>
diff --git a/frontend/src/metabase/components/EntityMenuTrigger.jsx b/frontend/src/metabase/components/EntityMenuTrigger.jsx
index de2d086421dd7ec014e4cd0163ddde382e949f2b..0ab4c6a42881976bbfdb9123a3bc25be1c5987e8 100644
--- a/frontend/src/metabase/components/EntityMenuTrigger.jsx
+++ b/frontend/src/metabase/components/EntityMenuTrigger.jsx
@@ -2,7 +2,7 @@ import React from 'react'
import Icon from 'metabase/components/Icon'
import cxs from 'cxs'
-const EntityzMenuTrigger = ({ icon, onClick, open }) => {
+const EntityMenuTrigger = ({ icon, onClick, open }) => {
const interactionColor = '#F2F4F5'
const classes = cxs({
display: 'flex',
@@ -34,4 +34,4 @@ const EntityzMenuTrigger = ({ icon, onClick, open }) => {
)
}
-export default EntityzMenuTrigger
+export default EntityMenuTrigger
diff --git a/frontend/src/metabase/components/ModalContent.jsx b/frontend/src/metabase/components/ModalContent.jsx
index 85e133f8f6e333275cbd5f5aa0c19ce6ce4d34e4..111d2d7ba314df806153627df7a22920299fdb2b 100644
--- a/frontend/src/metabase/components/ModalContent.jsx
+++ b/frontend/src/metabase/components/ModalContent.jsx
@@ -1,7 +1,6 @@
import React, { Component } from "react";
import PropTypes from "prop-types";
import cx from "classnames";
-
import Icon from "metabase/components/Icon.jsx";
export default class ModalContent extends Component {
@@ -89,4 +88,3 @@ export const ModalFooter = ({ children, fullPageModal, formModal }) =>
}
</div>
</div>
-
diff --git a/frontend/src/metabase/components/SchedulePicker.jsx b/frontend/src/metabase/components/SchedulePicker.jsx
index d1d6c999b719fb9a39abd74657fc3e2efb07185f..306719b50dcf8a4965d441bde43e9f46936ced54 100644
--- a/frontend/src/metabase/components/SchedulePicker.jsx
+++ b/frontend/src/metabase/components/SchedulePicker.jsx
@@ -9,16 +9,16 @@ import { capitalize } from "metabase/lib/formatting";
import _ from "underscore";
-const HOUR_OPTIONS = _.times(12, (n) => (
+export const HOUR_OPTIONS = _.times(12, (n) => (
{ name: (n === 0 ? 12 : n)+":00", value: n }
));
-const AM_PM_OPTIONS = [
+export const AM_PM_OPTIONS = [
{ name: "AM", value: 0 },
{ name: "PM", value: 1 }
];
-const DAY_OF_WEEK_OPTIONS = [
+export const DAY_OF_WEEK_OPTIONS = [
{ name: "Sunday", value: "sun" },
{ name: "Monday", value: "mon" },
{ name: "Tuesday", value: "tue" },
@@ -28,7 +28,7 @@ const DAY_OF_WEEK_OPTIONS = [
{ name: "Saturday", value: "sat" }
];
-const MONTH_DAY_OPTIONS = [
+export const MONTH_DAY_OPTIONS = [
{ name: "First", value: "first" },
{ name: "Last", value: "last" },
{ name: "15th (Midpoint)", value: "mid" }
diff --git a/frontend/src/metabase/containers/SaveQuestionModal.jsx b/frontend/src/metabase/containers/SaveQuestionModal.jsx
index 3b4cf1976e80bcd2d25523e4e72b144d2c352843..aed43642d7404599a0b884751f0273965ab1bc95 100644
--- a/frontend/src/metabase/containers/SaveQuestionModal.jsx
+++ b/frontend/src/metabase/containers/SaveQuestionModal.jsx
@@ -14,6 +14,7 @@ import Query from "metabase/lib/query";
import { cancelable } from "metabase/lib/promise";
import "./SaveQuestionModal.css";
+import ButtonWithStatus from "metabase/components/ButtonWithStatus";
export default class SaveQuestionModal extends Component {
@@ -40,7 +41,8 @@ export default class SaveQuestionModal extends Component {
tableMetadata: PropTypes.object, // can't be required, sometimes null
createFn: PropTypes.func.isRequired,
saveFn: PropTypes.func.isRequired,
- onClose: PropTypes.func.isRequired
+ onClose: PropTypes.func.isRequired,
+ multiStep: PropTypes.bool
}
componentDidMount() {
@@ -83,7 +85,7 @@ export default class SaveQuestionModal extends Component {
}
let { details } = this.state;
- let { card, originalCard, addToDashboard, createFn, saveFn } = this.props;
+ let { card, originalCard, createFn, saveFn } = this.props;
card = {
...card,
@@ -100,10 +102,10 @@ export default class SaveQuestionModal extends Component {
};
if (details.saveType === "create") {
- this.requestPromise = cancelable(createFn(card, addToDashboard));
+ this.requestPromise = cancelable(createFn(card));
} else if (details.saveType === "overwrite") {
card.id = this.props.originalCard.id;
- this.requestPromise = cancelable(saveFn(card, addToDashboard));
+ this.requestPromise = cancelable(saveFn(card));
}
await this.requestPromise;
@@ -113,6 +115,9 @@ export default class SaveQuestionModal extends Component {
if (error && !error.isCanceled) {
this.setState({ error: error });
}
+
+ // Throw error for ButtonWithStatus
+ throw error;
}
}
@@ -161,7 +166,7 @@ export default class SaveQuestionModal extends Component {
);
}
- let title = this.props.addToDashboard ? "First, save your question" : "Save question";
+ let title = this.props.multiStep ? "First, save your question" : "Save question";
return (
<ModalContent
@@ -172,9 +177,10 @@ export default class SaveQuestionModal extends Component {
<Button onClick={this.props.onClose}>
Cancel
</Button>,
- <Button primary={this.state.valid} disabled={!this.state.valid} onClick={this.formSubmitted}>
- Save
- </Button>
+ <ButtonWithStatus
+ disabled={!this.state.valid}
+ onClickOperation={this.formSubmitted}
+ />
]}
onClose={this.props.onClose}
>
diff --git a/frontend/src/metabase/containers/UndoListing.jsx b/frontend/src/metabase/containers/UndoListing.jsx
index 672fcd1d86906f66496fcda45e0851e480ac17e0..f6c24b29c66d207e3bcca219de5b0b1b6d1d1ebe 100644
--- a/frontend/src/metabase/containers/UndoListing.jsx
+++ b/frontend/src/metabase/containers/UndoListing.jsx
@@ -48,10 +48,12 @@ export default class UndoListing extends Component {
{typeof undo.message === "function" ? undo.message(undo) : undo.message}
</div>
- <div className={S.actions}>
- <a className={S.undoButton} onClick={() => performUndo(undo.id)}>Undo</a>
- <Icon className={S.dismissButton} name="close" onClick={() => dismissUndo(undo.id)} />
- </div>
+ { undo.actions &&
+ <div className={S.actions}>
+ <a className={S.undoButton} onClick={() => performUndo(undo.id)}>Undo</a>
+ <Icon className={S.dismissButton} name="close" onClick={() => dismissUndo(undo.id)} />
+ </div>
+ }
</li>
)}
</ReactCSSTransitionGroup>
diff --git a/frontend/src/metabase/dashboards/dashboards.js b/frontend/src/metabase/dashboards/dashboards.js
index a37b1b0f1cbda75326702a77bfd81e3dd472816b..76e5578256c38a8f407ece5532a24dc786da235b 100644
--- a/frontend/src/metabase/dashboards/dashboards.js
+++ b/frontend/src/metabase/dashboards/dashboards.js
@@ -4,11 +4,11 @@ import { handleActions, combineReducers, createThunkAction } from "metabase/lib/
import MetabaseAnalytics from "metabase/lib/analytics";
import * as Urls from "metabase/lib/urls";
import { DashboardApi } from "metabase/services";
-import { addUndo } from "metabase/redux/undo";
+import { addUndo, createUndo } from "metabase/redux/undo";
-import React from "react";
import { push } from "react-router-redux";
import moment from 'moment';
+import React from "react";
import type { Dashboard } from "metabase/meta/types/Dashboard";
@@ -117,17 +117,6 @@ export const setFavorited: SetFavoritedAction = createThunkAction(SET_FAVORITED,
}
});
-// A simplified version of a similar method in questions/questions.js
-function createUndo(type, action) {
- return {
- type: type,
- count: 1,
- message: (undo) => // eslint-disable-line react/display-name
- <div> { "Dashboard was " + type + "."} </div>,
- actions: [action]
- };
-}
-
export type SetArchivedAction = (dashId: number, archived: boolean, undoable?: boolean) => void;
export const setArchived = createThunkAction(SET_ARCHIVED, (dashId, archived, undoable = false) => {
return async (dispatch, getState) => {
@@ -137,8 +126,10 @@ export const setArchived = createThunkAction(SET_ARCHIVED, (dashId, archived, un
});
if (undoable) {
+ const type = archived ? "archived" : "unarchived"
dispatch(addUndo(createUndo(
- archived ? "archived" : "unarchived",
+ type,
+ <div>{`Dashboard was ${type}.`}</div>,
setArchived(dashId, !archived)
)));
}
diff --git a/frontend/src/metabase/icon_paths.js b/frontend/src/metabase/icon_paths.js
index c0970a906f3c302c66f2a497df0902d58956f283..2fcc0bc2d7ee2119e0e0aabc5ff3dc0887f698b9 100644
--- a/frontend/src/metabase/icon_paths.js
+++ b/frontend/src/metabase/icon_paths.js
@@ -17,6 +17,10 @@ export var ICON_PATHS = {
path: 'M14.677 7.339c-4.77.562-5.23 4.75-5.23 7.149 0 2.576 0 3.606-.53 4.121-.352.344-1.058.515-2.117.515V21.7h18v-2.576c-1.059 0-1.588 0-2.118-.515-.353-.343-.53-2.06-.53-5.151-.316-3.705-2.06-5.745-5.23-6.12a1.52 1.52 0 0 0 .466-1.093c0-.853-.71-1.545-1.588-1.545-.877 0-1.588.692-1.588 1.545 0 .427.178.814.465 1.094zM16.05 0c2.473 0 5.57 1.851 6.22 4.12 3.057 1.58 4.868 4.503 5.223 8.706l.013.158v.157c0 .905.014 1.682.042 2.327H30.6V25.73H1.5V15.468h3.091c.002-.326.003-.725.003-1.222 0-2.308.316-4.322 1.26-6.233.881-1.784 2.223-2.988 3.976-3.893C10.48 1.85 13.576 0 16.05 0zM13.1 25.8c.25 1.6 1.166 2.4 2.75 2.4s2.5-.8 2.75-2.4h-5.5zm-4.35-3.16h14.191l-.586 3.261c-.497 3.607-2.919 6.001-6.51 6.001-3.59 0-6.012-2.394-6.508-6L8.75 22.64z',
attrs: { fillRule: 'nonzero' }
},
+ alertConfirm: {
+ path:'M24.326 7.184a9.604 9.604 0 0 0-.021-.034c-.876-1.39-2.056-2.47-3.518-3.19-.509-2.269-2.51-3.96-4.9-3.96-2.361 0-4.344 1.652-4.881 3.88C7.113 5.63 5.68 9.55 5.68 14.424c0 .88-.003 1.473-.01 1.902H2.8v9.605h26.175v-9.602h-3.297v6.257H6.097V19.67c1.152 0 1.92-.194 2.304-.583.576-.583.576-1.75.576-4.664 0-2.716.5-7.456 5.69-8.091a1.754 1.754 0 0 1-.507-1.238c0-.966.773-1.749 1.727-1.749.955 0 1.728.783 1.728 1.75 0 .483-.194.92-.507 1.237 2.2.27 3.768 1.308 4.705 3.112.037-.04.874-.793 2.513-2.26zm-11.312 18.7H9.741C10.214 29.398 12.48 32 15.887 32c3.409 0 5.674-2.602 6.147-6.116H18.76c-.27 1.911-1.228 2.77-2.874 2.77-1.645 0-2.603-.859-2.873-2.77zm.297-12.466l2.504-2.707 3.819 4.106 7.653-8.254L29.8 9.38 19.636 20.295l-6.325-6.877z',
+ attrs: { fillRule: 'nonzero'}
+ },
all: 'M30.595 13.536c1.85.755 1.879 2.05.053 2.9l-11.377 5.287c-1.82.846-4.763.858-6.583.022L1.344 16.532c-1.815-.835-1.785-2.131.05-2.89l1.637-.677 8.977 4.125c2.194 1.009 5.74.994 7.934-.026l9.022-4.193 1.63.665zm-1.63 7.684l1.63.666c1.85.755 1.879 2.05.053 2.898l-11.377 5.288c-1.82.847-4.763.859-6.583.022L1.344 24.881c-1.815-.834-1.785-2.131.05-2.89l1.637-.677 8.977 4.126c2.194 1.008 5.74.993 7.934-.026l9.022-4.194zM12.686 1.576c1.843-.762 4.834-.77 6.687-.013l11.22 4.578c1.85.755 1.88 2.05.054 2.899l-11.377 5.288c-1.82.846-4.763.858-6.583.022L1.344 9.136c-1.815-.834-1.785-2.13.05-2.89l11.293-4.67z',
archive: {
path: 'M27.557 1v2.356a1 1 0 0 1-1 1H5.443a1 1 0 0 1-1-1V1a1 1 0 0 1 1-1h21.114a1 1 0 0 1 1 1zM4.356 26.644h23.288v-15.57H4.356v15.57zM32 8.718V29a2 2 0 0 1-2 2H2a2 2 0 0 1-2-2V8.718a2 2 0 0 1 2-2h28a2 2 0 0 1 2 2zM16.116 25.076l5.974-6.57h-3.983V12.93h-3.982v5.575h-3.982l5.973 6.571z',
@@ -145,6 +149,7 @@ export var ICON_PATHS = {
attrs: { fillRule: 'evenodd' }
},
left: "M21,0 L5,16 L21,32 L21,5.47117907e-13 L21,0 Z",
+ lightbulb: 'M16.1 11.594L18.756 8.9a1.03 1.03 0 0 1 1.446-.018c.404.39.412 1.03.018 1.43l-3.193 3.24v4.975c0 .559-.458 1.011-1.022 1.011a1.017 1.017 0 0 1-1.023-1.01v-5.17l-3.003-3.046c-.394-.4-.386-1.04.018-1.43a1.03 1.03 0 0 1 1.446.018l2.657 2.695zM11.03 28.815h9.938a1.01 1.01 0 1 1 0 2.02 376.72 376.72 0 0 0-2.964.002C18.005 31.857 16.767 32 16 32c-.767 0-1.993-.139-1.993-1.163H11.03a1.011 1.011 0 0 1 0-2.022zm0-3.033h9.938a1.011 1.011 0 0 1 0 2.022H11.03a1.011 1.011 0 1 1 0-2.022zM8.487 20.43A11.659 11.659 0 0 1 4.5 11.627C4.5 5.214 9.64 0 16 0s11.5 5.214 11.5 11.627c0 3.43-1.481 6.617-3.987 8.803v1.308c0 1.954-1.601 3.538-3.577 3.538h-7.872c-1.976 0-3.577-1.584-3.577-3.538V20.43zm2.469-1.915l.597.455v2.768c0 .279.23.505.511.505h7.872a.508.508 0 0 0 .51-.505V18.97l.598-.455a8.632 8.632 0 0 0 3.39-6.888c0-4.755-3.785-8.594-8.434-8.594-4.649 0-8.433 3.84-8.433 8.594a8.632 8.632 0 0 0 3.389 6.888z',
link: "M12.56 17.04c-1.08 1.384-1.303 1.963 1.755 4.04 3.058 2.076 7.29.143 8.587-1.062 1.404-1.304 4.81-4.697 7.567-7.842 2.758-3.144 1.338-8.238-.715-9.987-5.531-4.71-9.5-.554-11.088.773-2.606 2.176-5.207 5.144-5.207 5.144s1.747-.36 2.784 0c1.036.36 2.102.926 2.102.926l4.003-3.969s2.367-1.907 4.575 0 .674 4.404 0 5.189c-.674.784-6.668 6.742-6.668 6.742s-1.52.811-2.37.811c-.85 0-2.582-.528-2.582-.932 0-.405-1.665-1.22-2.744.166zm7.88-2.08c1.08-1.384 1.303-1.963-1.755-4.04-3.058-2.076-7.29-.143-8.587 1.062-1.404 1.304-4.81 4.697-7.567 7.842-2.758 3.144-1.338 8.238.715 9.987 5.531 4.71 9.5.554 11.088-.773 2.606-2.176 5.207-5.144 5.207-5.144s-1.747.36-2.784 0a17.379 17.379 0 0 1-2.102-.926l-4.003 3.969s-2.367 1.907-4.575 0-.674-4.404 0-5.189c.674-.784 6.668-6.742 6.668-6.742s1.52-.811 2.37-.811c.85 0 2.582.528 2.582.932 0 .405 1.665 1.22 2.744-.166z",
line: 'M18.867 16.377l-3.074-3.184-.08.077-.002-.002.01-.01-.53-.528-.066-.07-.001.002-2.071-2.072L-.002 23.645l2.668 2.668 10.377-10.377 3.074 3.183.08-.076.001.003-.008.008.5.501.094.097.002-.001 2.072 2.072L31.912 8.669 29.244 6 18.867 16.377z',
list: 'M3 8 A3 3 0 0 0 9 8 A3 3 0 0 0 3 8 M12 6 L28 6 L28 10 L12 10z M3 16 A3 3 0 0 0 9 16 A3 3 0 0 0 3 16 M12 14 L28 14 L28 18 L12 18z M3 24 A3 3 0 0 0 9 24 A3 3 0 0 0 3 24 M12 22 L28 22 L28 26 L12 26z',
@@ -157,10 +162,7 @@ export var ICON_PATHS = {
attrs: { fillRule: "evenodd" }
},
lockoutline: 'M7 12H5.546A3.548 3.548 0 0 0 2 15.553v12.894A3.547 3.547 0 0 0 5.546 32h20.908C28.414 32 30 30.41 30 28.447V15.553A3.547 3.547 0 0 0 26.454 12H25V8.99C25 4.029 20.97 0 16 0c-4.972 0-9 4.025-9 8.99V12zm4-3.766c0-2.338 1.89-4.413 4.219-4.634L16 3.525l.781.075C19.111 3.82 21 5.896 21 8.234V12H11V8.234zm-5 9.537C6 16.793 6.796 16 7.775 16h16.45c.98 0 1.775.787 1.775 1.77v8.46c0 .977-.796 1.77-1.775 1.77H7.775A1.77 1.77 0 0 1 6 26.23v-8.46zM16 25a3 3 0 1 0 0-6 3 3 0 0 0 0 6z',
- mail: {
- path: 'M0 6 L16 16 L32 6 z M0 9 L0 26 L32 26 L32 9 L16 19 z',
- attrs: { viewBox: '0 0 32 32' }
- },
+ mail: 'M1.503 6h28.994C31.327 6 32 6.673 32 7.503v16.06A3.436 3.436 0 0 1 28.564 27H3.436A3.436 3.436 0 0 1 0 23.564V7.504C0 6.673.673 6 1.503 6zm4.403 2.938l10.63 8.052 10.31-8.052H5.906zm-2.9 1.632v11.989c0 .83.674 1.503 1.504 1.503h23.087c.83 0 1.504-.673 1.504-1.503V11.005l-11.666 8.891a1.503 1.503 0 0 1-1.806.013l-12.622-9.34z',
mine: 'M28.4907419,50 C25.5584999,53.6578499 21.0527692,56 16,56 C10.9472308,56 6.44150015,53.6578499 3.50925809,50 L28.4907419,50 Z M29.8594823,31.9999955 C27.0930063,27.217587 21.922257,24 16,24 C10.077743,24 4.9069937,27.217587 2.1405177,31.9999955 L29.8594849,32 Z M16,21 C19.8659932,21 23,17.1944204 23,12.5 C23,7.80557963 22,3 16,3 C10,3 9,7.80557963 9,12.5 C9,17.1944204 12.1340068,21 16,21 Z',
moon: 'M11.6291702,1.84239429e-11 C19.1234093,1.22958025 24.8413559,7.73631246 24.8413559,15.5785426 C24.8413559,24.2977683 17.7730269,31.3660972 9.05380131,31.3660972 C7.28632096,31.3660972 5.58667863,31.0756481 4,30.5398754 C11.5007933,28.2096945 16.9475786,21.2145715 16.9475786,12.9472835 C16.9475786,7.90001143 14.9174312,3.32690564 11.6291702,1.70246039e-11 L11.6291702,1.84239429e-11 Z',
move: 'M23 27h-8v-5h8v-4l8 6-8 7v-4zM17.266 0h.86a2 2 0 0 1 1.42.592L27.49 8.61a2 2 0 0 1 .58 1.407v6h-5.01v-5.065L17.133 5H0V2a2 2 0 0 1 2-2h15.266zM5 27h7v5H2a2 2 0 0 1-2-2V5h5v22z',
@@ -198,6 +200,7 @@ export var ICON_PATHS = {
ruler: 'M0.595961814,24.9588734 C-0.196619577,24.166292 -0.200005392,22.8846495 0.593926984,22.0907171 L22.0908075,0.593836573 C22.8822651,-0.197621013 24.1641442,-0.198948234 24.9589638,0.595871404 L31.4040382,7.04094576 C32.1966196,7.83352715 32.2000054,9.11516967 31.406073,9.90910205 L9.90919246,31.4059826 C9.11773487,32.1974402 7.83585581,32.1987674 7.04103617,31.4039478 L0.595961814,24.9588734 Z M17.8319792,7.8001489 L16.3988585,9.23326963 L18.548673,11.3830842 C18.9443414,11.7787526 18.9470387,12.4175604 18.5485351,12.816064 C18.1527906,13.2118086 17.5140271,13.2146738 17.1155553,12.816202 L14.9657407,10.6663874 L13.5326229,12.0995052 L15.6824375,14.2493198 C16.0781059,14.6449881 16.0808032,15.283796 15.6822996,15.6822996 C15.286555,16.0780441 14.6477916,16.0809094 14.2493198,15.6824375 L12.0995052,13.5326229 L10.6663845,14.9657436 C10.6670858,14.9664411 10.6677865,14.9671398 10.6684864,14.9678397 L14.2470828,18.5464361 C14.6439866,18.9433399 14.6476854,19.5831493 14.2491818,19.9816529 C13.8534373,20.3773974 13.2188552,20.384444 12.813965,19.9795538 L9.23536867,16.4009575 C9.23466875,16.4002576 9.23397006,16.3995569 9.2332726,16.3988555 L7.80015186,17.8319762 L9.94996646,19.9817908 C10.3456348,20.3774592 10.3483321,21.016267 9.94982851,21.4147706 C9.55408397,21.8105152 8.91532053,21.8133804 8.51684869,21.4149086 L6.3670341,19.265094 L4.93391633,20.6982118 L7.08373093,22.8480263 C7.47939928,23.2436947 7.48209658,23.8825026 7.08359298,24.2810062 C6.68784844,24.6767507 6.049085,24.6796159 5.65061316,24.2811441 L3.50079857,22.1313295 L2.02673458,23.6053935 L8.47576453,30.0544235 L30.0544235,8.47576453 L23.6053935,2.02673458 L22.1313295,3.50079857 L24.2811441,5.65061316 C24.6768125,6.04628152 24.6795098,6.68508938 24.2810062,7.08359298 C23.8852616,7.47933752 23.2464982,7.48220276 22.8480263,7.08373093 L20.6982118,4.93391633 L19.2650911,6.36703697 C19.2657924,6.36773446 19.2664931,6.36843318 19.267193,6.36913314 L22.8457894,9.94772948 C23.2426932,10.3446333 23.246392,10.9844427 22.8478884,11.3829463 C22.4521439,11.7786908 21.8175617,11.7857374 21.4126716,11.3808472 L17.8340753,7.8022509 C17.8333753,7.80155099 17.8326767,7.80085032 17.8319792,7.8001489 Z',
search: 'M12 0 A12 12 0 0 0 0 12 A12 12 0 0 0 12 24 A12 12 0 0 0 18.5 22.25 L28 32 L32 28 L22.25 18.5 A12 12 0 0 0 24 12 A12 12 0 0 0 12 0 M12 4 A8 8 0 0 1 12 20 A8 8 0 0 1 12 4 ',
segment: 'M2.99631547,14.0294075 L2.99631579,1.99517286 C2.99631582,0.893269315 3.89614282,0 4.98985651,0 L30.0064593,0 C31.1074614,0 32,0.895880847 32,2.00761243 L32,26.8688779 C32,27.9776516 31.1071386,28.8764903 30.0003242,28.8764903 L17.7266598,28.8764903 L17.7266594,14.0294075 L2.99631547,14.0294075 Z M-7.10651809e-15,16.9955967 L-7.10651809e-15,30.0075311 C-7.10651809e-15,31.1079413 0.900469916,32 2.00155906,32 L14.3949712,32 L14.3949712,16.9955967 L-7.10651809e-15,16.9955967 Z',
+ slackIcon: 'M11.432 13.934l1.949 5.998 5.573-1.864-1.949-6-5.573 1.866zm-5.266 1.762l-2.722.91a2.776 2.776 0 1 1-1.762-5.265l2.768-.926-.956-2.943a2.776 2.776 0 0 1 5.28-1.716l.942 2.897 5.573-1.865-1.023-3.151a2.776 2.776 0 1 1 5.28-1.716l1.009 3.105 3.67-1.228a2.776 2.776 0 1 1 1.762 5.265l-3.716 1.244 1.949 5.999 3.336-1.117a2.776 2.776 0 0 1 1.762 5.266l-3.382 1.131.956 2.942a2.776 2.776 0 0 1-5.28 1.716l-.942-2.896-5.573 1.865 1.023 3.15a2.776 2.776 0 0 1-5.28 1.716L9.83 26.975l-3.056 1.022a2.776 2.776 0 1 1-1.762-5.265l3.102-1.038-1.949-5.998z',
star: 'M16 0 L21 11 L32 12 L23 19 L26 31 L16 25 L6 31 L9 19 L0 12 L11 11',
staroutline: "M16 21.935l5.967 3.14-1.14-6.653 4.828-4.712-6.671-.97L16 6.685l-2.984 6.053-6.67.971 4.827 4.712-1.14 6.654L16 21.935zm-9.892 8.547l1.89-11.029L0 11.647l11.053-1.609L16 0l4.947 10.038L32 11.647l-7.997 7.806 1.889 11.03L16 25.274l-9.892 5.207z",
string: {
@@ -229,7 +232,7 @@ export var ICON_PATHS = {
},
x: 'm11.271709,16 l-3.19744231e-13,4.728291 l4.728291,0 l16,11.271709 l27.271709,2.39808173e-13 l32,4.728291 l20.728291,16 l31.1615012,26.4332102 l26.4332102,31.1615012 l16,20.728291 l5.56678976,31.1615012 l0.838498756,26.4332102 l11.271709,16 z',
zoom: 'M12.416 12.454V8.37h3.256v4.083h4.07v3.266h-4.07v4.083h-3.256V15.72h-4.07v-3.266h4.07zm10.389 13.28c-5.582 4.178-13.543 3.718-18.632-1.37-5.58-5.581-5.595-14.615-.031-20.179 5.563-5.563 14.597-5.55 20.178.031 5.068 5.068 5.545 12.985 1.422 18.563l5.661 5.661a2.08 2.08 0 0 1 .003 2.949 2.085 2.085 0 0 1-2.95-.003l-5.651-5.652zm-1.486-4.371c3.895-3.895 3.885-10.218-.021-14.125-3.906-3.906-10.23-3.916-14.125-.021-3.894 3.894-3.885 10.218.022 14.124 3.906 3.907 10.23 3.916 14.124.022z',
- "slack": {
+ slack: {
img: "app/assets/img/slack.png"
}
};
diff --git a/frontend/src/metabase/lib/cookies.js b/frontend/src/metabase/lib/cookies.js
index 705fd7bfd5a02882b4c02a7a32150e1570223c3d..eb1b777d7d06682346f5309ecd877ab108dd50ab 100644
--- a/frontend/src/metabase/lib/cookies.js
+++ b/frontend/src/metabase/lib/cookies.js
@@ -4,6 +4,7 @@ import { clearGoogleAuthCredentials } from "metabase/lib/auth";
import Cookies from "js-cookie";
export const METABASE_SESSION_COOKIE = 'metabase.SESSION_ID';
+export const METABASE_SEEN_ALERT_SPLASH_COOKIE = 'metabase.SEEN_ALERT_SPLASH'
// Handles management of Metabase cookie work
var MetabaseCookies = {
@@ -31,6 +32,29 @@ var MetabaseCookies = {
} catch (e) {
console.error("setSessionCookie:", e);
}
+ },
+
+ setHasSeenAlertSplash: (hasSeen) => {
+ const options = {
+ path: window.MetabaseRoot || '/',
+ expires: 365,
+ secure: window.location.protocol === "https:"
+ };
+
+ try {
+ Cookies.set(METABASE_SEEN_ALERT_SPLASH_COOKIE, hasSeen, options);
+ } catch (e) {
+ console.error("setSeenAlertSplash:", e);
+ }
+ },
+
+ getHasSeenAlertSplash: () => {
+ try {
+ return Cookies.get(METABASE_SEEN_ALERT_SPLASH_COOKIE) || false;
+ } catch(e) {
+ console.error("getSeenAlertSplash:", e);
+ return false;
+ }
}
}
diff --git a/frontend/src/metabase/lib/request.js b/frontend/src/metabase/lib/request.js
index 609d95565cd1e1b34a6bd960aff0f659a70d7dfb..e30316147814ea74b46ca582ceaa85dab7ca396d 100644
--- a/frontend/src/metabase/lib/request.js
+++ b/frontend/src/metabase/lib/request.js
@@ -1,4 +1,5 @@
import { AsyncApi } from "metabase/services";
+import _ from "underscore";
export class RestfulRequest {
// API endpoint that is used for the request
@@ -13,10 +14,16 @@ export class RestfulRequest {
// can make the migration process from old implementation to this request API a lot easier
resultPropName = 'result'
- constructor({ endpoint, actionPrefix, resultPropName } = {}) {
+ // If `true`, then the result (either an object an array) will be converted to a dictionary
+ // where the dictionary key is the `id` field of the result.
+ // This dictionary is merged to the possibly pre-existing dictionary.
+ storeAsDictionary = false
+
+ constructor({ endpoint, actionPrefix, resultPropName, storeAsDictionary } = {}) {
this.endpoint = endpoint
this.actionPrefix = actionPrefix
this.resultPropName = resultPropName || this.resultPropName
+ this.storeAsDictionary = storeAsDictionary
this.actions = {
requestStarted: `${this.actionPrefix}/REQUEST_STARTED`,
@@ -34,21 +41,33 @@ export class RestfulRequest {
const result = await this.endpoint(params)
dispatch.action(this.actions.requestSuccessful, { result })
} catch(error) {
- console.error(error)
dispatch.action(this.actions.requestFailed, { error })
+ throw error;
}
}
reset = () => (dispatch) => dispatch(this.actions.reset)
+ mergeToDictionary = (dict, result) => {
+ dict = dict || {}
+ result = _.isArray(result)
+ ? _.indexBy(result, "id")
+ : { [result.id]: result }
+
+ return { ...dict, ...result }
+ }
+
getReducers = () => ({
- [this.actions.requestStarted]: (state) => ({...state, loading: true}),
+ [this.actions.requestStarted]: (state) => ({ ...state, loading: true, error: null }),
[this.actions.requestSuccessful]: (state, { payload: { result }}) => ({
...state,
- [this.resultPropName]: result,
+ [this.resultPropName]: this.storeAsDictionary
+ ? this.mergeToDictionary(state[this.resultPropName], result)
+ : result,
loading: false,
- fetched: true
+ fetched: true,
+ error: null
}),
[this.actions.requestFailed]: (state, { payload: { error } }) => ({
...state,
@@ -106,8 +125,8 @@ export class BackgroundJobRequest {
const result = await this._pollForResult(newJobId)
dispatch.action(this.actions.requestSuccessful, { result })
} catch(error) {
- console.error(error)
dispatch.action(this.actions.requestFailed, { error })
+ throw error;
}
}
}
@@ -128,6 +147,8 @@ export class BackgroundJobRequest {
if (response.status === 'done') {
resolve(response.result)
+ } else if (response.status === 'error') {
+ throw new Error(response.result.cause)
} else if (response.status === 'result-not-available') {
// The job result has been deleted; this is an unexpected state as we just
// created the job so simply throw a descriptive error
@@ -148,12 +169,13 @@ export class BackgroundJobRequest {
reset = () => (dispatch) => dispatch(this.actions.reset)
getReducers = () => ({
- [this.actions.requestStarted]: (state) => ({...state, loading: true}),
+ [this.actions.requestStarted]: (state) => ({...state, loading: true, error: null }),
[this.actions.requestSuccessful]: (state, { payload: { result }}) => ({
...state,
[this.resultPropName]: result,
loading: false,
- fetched: true
+ fetched: true,
+ error: null
}),
[this.actions.requestFailed]: (state, { payload: { error } }) => ({
...state,
diff --git a/frontend/src/metabase/pulse/components/PulseEdit.jsx b/frontend/src/metabase/pulse/components/PulseEdit.jsx
index e4065ce17026888e44b281a3b6cdaf04c1831825..1fd2baa6afe6876c45ee179f182de2a376181dc9 100644
--- a/frontend/src/metabase/pulse/components/PulseEdit.jsx
+++ b/frontend/src/metabase/pulse/components/PulseEdit.jsx
@@ -117,7 +117,10 @@ export default class PulseEdit extends Component {
<div className="PulseEdit-content pt2 pb4">
<PulseEditName {...this.props} setPulse={this.setPulse} />
<PulseEditCards {...this.props} setPulse={this.setPulse} />
- <PulseEditChannels {...this.props} setPulse={this.setPulse} pulseIsValid={isValid} />
+ <div className="py1 mb4">
+ <h2 className="mb3">Where should this data go?</h2>
+ <PulseEditChannels {...this.props} setPulse={this.setPulse} pulseIsValid={isValid} />
+ </div>
<PulseEditSkip {...this.props} setPulse={this.setPulse} />
{ pulse && pulse.id != null &&
<div className="DangerZone mb2 p3 rounded bordered relative">
@@ -133,7 +136,7 @@ export default class PulseEdit extends Component {
>
<DeleteModalWithConfirm
objectType="pulse"
- objectName={pulse.name}
+ title={"Delete \"" + pulse.name + "\"?"}
confirmItems={this.getConfirmItems()}
onClose={() => this.refs["deleteModal"+pulse.id].close()}
onDelete={this.delete}
diff --git a/frontend/src/metabase/pulse/components/PulseEditChannels.jsx b/frontend/src/metabase/pulse/components/PulseEditChannels.jsx
index f662a365dc356cf7cbfd4664c6e3e55e847f0b6b..963eb4086266621de89c5168b6c810e0f719ec25 100644
--- a/frontend/src/metabase/pulse/components/PulseEditChannels.jsx
+++ b/frontend/src/metabase/pulse/components/PulseEditChannels.jsx
@@ -5,13 +5,13 @@ import _ from "underscore";
import { assoc, assocIn } from "icepick";
import RecipientPicker from "./RecipientPicker.jsx";
-import SetupMessage from "./SetupMessage.jsx";
import SchedulePicker from "metabase/components/SchedulePicker.jsx";
import ActionButton from "metabase/components/ActionButton.jsx";
import Select from "metabase/components/Select.jsx";
import Toggle from "metabase/components/Toggle.jsx";
import Icon from "metabase/components/Icon.jsx";
+import ChannelSetupMessage from "metabase/components/ChannelSetupMessage";
import MetabaseAnalytics from "metabase/lib/analytics";
@@ -19,7 +19,7 @@ import { channelIsValid } from "metabase/lib/pulse";
import cx from "classnames";
-const CHANNEL_ICONS = {
+export const CHANNEL_ICONS = {
email: "mail",
slack: "slack"
};
@@ -43,8 +43,10 @@ export default class PulseEditChannels extends Component {
user: PropTypes.object.isRequired,
userList: PropTypes.array.isRequired,
setPulse: PropTypes.func.isRequired,
- testPulse: PropTypes.func.isRequired,
- cardPreviews: PropTypes.array
+ testPulse: PropTypes.func,
+ cardPreviews: PropTypes.array,
+ hideSchedulePicker: PropTypes.bool,
+ emailRecipientText: PropTypes.string
};
static defaultProps = {};
@@ -178,7 +180,7 @@ export default class PulseEditChannels extends Component {
}
{ channelSpec.recipients &&
<div>
- <div className="h4 text-bold mb1">To:</div>
+ <div className="h4 text-bold mb1">{ this.props.emailRecipientText || "To:" }</div>
<RecipientPicker
isNewPulse={this.props.pulseId === undefined}
recipients={channel.recipients}
@@ -191,7 +193,7 @@ export default class PulseEditChannels extends Component {
{ channelSpec.fields &&
this.renderFields(channel, index, channelSpec)
}
- { channelSpec.schedules &&
+ { !this.props.hideSchedulePicker && channelSpec.schedules &&
<SchedulePicker
schedule={_.pick(channel, "schedule_day", "schedule_frame", "schedule_hour", "schedule_type") }
scheduleOptions={channelSpec.schedules}
@@ -200,19 +202,21 @@ export default class PulseEditChannels extends Component {
onScheduleChange={this.onChannelScheduleChange.bind(this, index)}
/>
}
- <div className="pt2">
- <ActionButton
- actionFn={this.onTestPulseChannel.bind(this, channel)}
- className={cx("Button", { disabled: !isValid })}
- normalText={channelSpec.type === "email" ?
- "Send email now" :
- "Send to " + channelSpec.name + " now"}
- activeText="Sending…"
- failedText="Sending failed"
- successText={ this.willPulseSkip() ? "Didn’t send because the pulse has no results." : "Pulse sent"}
- forceActiveStyle={ this.willPulseSkip() }
- />
- </div>
+ { this.props.testPulse &&
+ <div className="pt2">
+ <ActionButton
+ actionFn={this.onTestPulseChannel.bind(this, channel)}
+ className={cx("Button", { disabled: !isValid })}
+ normalText={channelSpec.type === "email" ?
+ "Send email now" :
+ "Send to " + channelSpec.name + " now"}
+ activeText="Sending…"
+ failedText="Sending failed"
+ successText={ this.willPulseSkip() ? "Didn’t send because the pulse has no results." : "Pulse sent"}
+ forceActiveStyle={ this.willPulseSkip() }
+ />
+ </div>
+ }
</li>
);
}
@@ -234,7 +238,7 @@ export default class PulseEditChannels extends Component {
: channels.length > 0 && !channelSpec.configured ?
<div className="p4 text-centered">
<h3 className="mb2">{channelSpec.name} needs to be set up by an administrator.</h3>
- <SetupMessage user={user} channels={[channelSpec.name]} />
+ <ChannelSetupMessage user={user} channels={[channelSpec.name]} />
</div>
: null
}
@@ -250,14 +254,11 @@ export default class PulseEditChannels extends Component {
slack: { name: "Slack", type: "slack" }
};
return (
- <div className="py1 mb4">
- <h2 className="mb3">Where should this data go?</h2>
- <ul className="bordered rounded">
- {Object.values(channels).map(channelSpec =>
- this.renderChannelSection(channelSpec)
- )}
- </ul>
- </div>
+ <ul className="bordered rounded">
+ {Object.values(channels).map(channelSpec =>
+ this.renderChannelSection(channelSpec)
+ )}
+ </ul>
);
}
}
diff --git a/frontend/src/metabase/pulse/components/PulseList.jsx b/frontend/src/metabase/pulse/components/PulseList.jsx
index e560516d847ae2e1a43acedc46b8d41f7736b698..3dc1fc8c0aebbaf6055bcdf4e4884e554bfefc2e 100644
--- a/frontend/src/metabase/pulse/components/PulseList.jsx
+++ b/frontend/src/metabase/pulse/components/PulseList.jsx
@@ -2,9 +2,9 @@ import React, { Component } from "react";
import PulseListItem from "./PulseListItem.jsx";
import WhatsAPulse from "./WhatsAPulse.jsx";
-import SetupModal from "./SetupModal.jsx";
import LoadingAndErrorWrapper from "metabase/components/LoadingAndErrorWrapper.jsx";
+import ChannelSetupModal from "metabase/components/ChannelSetupModal";
import Modal from "metabase/components/Modal.jsx";
import _ from "underscore";
@@ -29,8 +29,7 @@ export default class PulseList extends Component {
}
create() {
- let hasConfiguredChannel = !this.props.formInput.channels || _.some(Object.values(this.props.formInput.channels), (c) => c.configured);
- if (hasConfiguredChannel) {
+ if (this.props.hasConfiguredAnyChannel) {
this.props.onChangeLocation("/pulse/create");
} else {
this.setState({ showSetupModal: true });
@@ -71,10 +70,11 @@ export default class PulseList extends Component {
}
</LoadingAndErrorWrapper>
<Modal isOpen={this.state.showSetupModal}>
- <SetupModal
+ <ChannelSetupModal
user={user}
onClose={() => this.setState({ showSetupModal: false })}
onChangeLocation={this.props.onChangeLocation}
+ entityNamePlural={t`pulses`}
/>
</Modal>
</div>
diff --git a/frontend/src/metabase/pulse/components/SetupModal.jsx b/frontend/src/metabase/pulse/components/SetupModal.jsx
deleted file mode 100644
index a32f78165fdb35a28f19bd46bf01fa4cf4e72ab8..0000000000000000000000000000000000000000
--- a/frontend/src/metabase/pulse/components/SetupModal.jsx
+++ /dev/null
@@ -1,26 +0,0 @@
-/* eslint "react/prop-types": "warn" */
-import React, { Component } from "react";
-import PropTypes from "prop-types";
-
-import SetupMessage from "./SetupMessage.jsx";
-import ModalContent from "metabase/components/ModalContent.jsx";
-
-export default class SetupModal extends Component {
- static propTypes = {
- onClose: PropTypes.func.isRequired,
- user: PropTypes.object.isRequired
- };
-
- render() {
- return (
- <ModalContent
- onClose={this.props.onClose}
- title={`To send pulses, ${ this.props.user.is_superuser ? "you'll need" : "an admin needs"} to set up email or Slack integration.`}
- >
- <div className="ml-auto mb4 mr4">
- <SetupMessage user={this.props.user} />
- </div>
- </ModalContent>
- );
- }
-}
diff --git a/frontend/src/metabase/pulse/selectors.js b/frontend/src/metabase/pulse/selectors.js
index 7386a312f2a43ac4f3f96aa9a8beb3f882bee1dd..c63968494f600c5d46fa20a52138680d02c27a7a 100644
--- a/frontend/src/metabase/pulse/selectors.js
+++ b/frontend/src/metabase/pulse/selectors.js
@@ -1,5 +1,5 @@
-
import { createSelector } from 'reselect';
+import _ from "underscore";
const pulsesSelector = state => state.pulse.pulses;
const pulseIdListSelector = state => state.pulse.pulseList;
@@ -16,7 +16,20 @@ const cardIdListSelector = state => state.pulse.cardList
const usersSelector = state => state.pulse.users
-const formInputSelector = state => state.pulse.formInput
+export const formInputSelector = state => state.pulse.formInput
+
+export const hasLoadedChannelInfoSelector = createSelector(
+ [formInputSelector],
+ (formInput) => !!formInput.channels
+)
+export const hasConfiguredAnyChannelSelector = createSelector(
+ [formInputSelector],
+ (formInput) => formInput.channels && _.some(Object.values(formInput.channels), (c) => c.configured) || false
+)
+export const hasConfiguredEmailChannelSelector = createSelector(
+ [formInputSelector],
+ (formInput) => formInput.channels && _.some(Object.values(formInput.channels), (c) => c.type === "email" && c.configured) || false
+)
const cardPreviewsSelector = state => state.pulse.cardPreviews
@@ -25,7 +38,7 @@ const cardListSelector = createSelector(
(cardIdList, cards) => cardIdList && cardIdList.map(id => cards[id])
);
-const userListSelector = createSelector(
+export const userListSelector = createSelector(
[usersSelector],
(users) => Object.values(users)
);
@@ -34,8 +47,8 @@ const getPulseId = (state, props) => props.params.pulseId ? parseInt(props.param
// LIST
export const listPulseSelectors = createSelector(
- [getPulseId, pulseListSelector, formInputSelector],
- (pulseId, pulses, formInput) => ({ pulseId, pulses, formInput })
+ [getPulseId, pulseListSelector, formInputSelector, hasConfiguredAnyChannelSelector],
+ (pulseId, pulses, formInput, hasConfiguredAnyChannel) => ({ pulseId, pulses, formInput, hasConfiguredAnyChannel })
);
// EDIT
diff --git a/frontend/src/metabase/query_builder/actions.js b/frontend/src/metabase/query_builder/actions.js
index 44c694797d1e281cefadba4afa10282df3f0f99a..eb20e90bedd5f62838191e1caeb5aa5c291f488e 100644
--- a/frontend/src/metabase/query_builder/actions.js
+++ b/frontend/src/metabase/query_builder/actions.js
@@ -1,4 +1,6 @@
/*@flow weak*/
+import { fetchAlertsForQuestion } from "metabase/alert/alert";
+
declare var ace: any;
import React from 'react'
@@ -18,7 +20,7 @@ import { isPK } from "metabase/lib/types";
import Utils from "metabase/lib/utils";
import { getEngineNativeType, formatJsonQuery } from "metabase/lib/engine";
import { defer } from "metabase/lib/promise";
-import { addUndo } from "metabase/redux/undo";
+import { addUndo, createUndo } from "metabase/redux/undo";
import Question from "metabase-lib/lib/Question";
import { cardIsEquivalent } from "metabase/meta/Card";
@@ -289,6 +291,9 @@ export const initializeQB = (location, params) => {
uiControls
});
+ // Fetch alerts for the current question if the question is saved
+ card && card.id && dispatch(fetchAlertsForQuestion(card.id))
+
// Fetch the question metadata
card && dispatch(loadMetadataForCard(card));
@@ -518,6 +523,7 @@ export const setParameterValue = createAction(SET_PARAMETER_VALUE, (parameterId,
return { id: parameterId, value };
});
+// Used after a question is successfully created in QueryHeader component code
export const NOTIFY_CARD_CREATED = "metabase/qb/NOTIFY_CARD_CREATED";
export const notifyCardCreatedFn = createThunkAction(NOTIFY_CARD_CREATED, (card) => {
return (dispatch, getState) => {
@@ -529,6 +535,7 @@ export const notifyCardCreatedFn = createThunkAction(NOTIFY_CARD_CREATED, (card)
}
});
+// Used after a question is successfully updated in QueryHeader component code
export const NOTIFY_CARD_UPDATED = "metabase/qb/NOTIFY_CARD_UPDATED";
export const notifyCardUpdatedFn = createThunkAction(NOTIFY_CARD_UPDATED, (card) => {
return (dispatch, getState) => {
@@ -618,11 +625,11 @@ export const navigateToNewCardInsideQB = createThunkAction(NAVIGATE_TO_NEW_CARD,
* Also shows/hides the template tag editor if the number of template tags has changed.
*/
export const UPDATE_QUESTION = "metabase/qb/UPDATE_QUESTION";
-export const updateQuestion = (newQuestion) => {
+export const updateQuestion = (newQuestion, { doNotClearNameAndId } = {}) => {
return (dispatch, getState) => {
// TODO Atte Keinänen 6/2/2017 Ways to have this happen automatically when modifying a question?
// Maybe the Question class or a QB-specific question wrapper class should know whether it's being edited or not?
- if (!getIsEditing(getState()) && newQuestion.isSaved()) {
+ if (!doNotClearNameAndId && !getIsEditing(getState()) && newQuestion.isSaved()) {
newQuestion = newQuestion.withoutNameAndId();
}
@@ -1139,20 +1146,6 @@ export const loadObjectDetailFKReferences = createThunkAction(LOAD_OBJECT_DETAIL
};
});
-// TODO - this is pretty much a duplicate of SET_ARCHIVED in questions/questions.js
-// unfortunately we have to do this because that action relies on its part of the store
-// for the card lookup
-// A simplified version of a similar method in questions/questions.js
-function createUndo(type, action) {
- return {
- type: type,
- count: 1,
- message: (undo) => // eslint-disable-line react/display-name
- <div> { "Question was " + type + "."} </div>,
- actions: [action]
- };
-}
-
export const ARCHIVE_QUESTION = 'metabase/qb/ARCHIVE_QUESTION';
export const archiveQuestion = createThunkAction(ARCHIVE_QUESTION, (questionId, archived = true) =>
async (dispatch, getState) => {
@@ -1162,10 +1155,14 @@ export const archiveQuestion = createThunkAction(ARCHIVE_QUESTION, (questionId,
}
let response = await CardApi.update(card)
- dispatch(addUndo(createUndo(
- archived ? "archived" : "unarchived",
- archiveQuestion(card.id, !archived)
- )));
+ const type = archived ? "archived" : "unarchived"
+
+ dispatch(addUndo(createUndo({
+ type,
+ // eslint-disable-next-line react/display-name
+ message: () => <div> { "Question was " + type + "."} </div>,
+ action: archiveQuestion(card.id, !archived)
+ })));
dispatch(push('/questions'))
return response
diff --git a/frontend/src/metabase/query_builder/components/AlertListPopoverContent.jsx b/frontend/src/metabase/query_builder/components/AlertListPopoverContent.jsx
new file mode 100644
index 0000000000000000000000000000000000000000..82591e32ea14c5b3cea41ba3245904166351d071
--- /dev/null
+++ b/frontend/src/metabase/query_builder/components/AlertListPopoverContent.jsx
@@ -0,0 +1,271 @@
+import React, { Component } from "react";
+import { connect } from "react-redux";
+import { getQuestionAlerts } from "metabase/query_builder/selectors";
+import { getUser } from "metabase/selectors/user";
+import { deleteAlert, unsubscribeFromAlert } from "metabase/alert/alert";
+import { AM_PM_OPTIONS, DAY_OF_WEEK_OPTIONS, HOUR_OPTIONS } from "metabase/components/SchedulePicker"
+import Icon from "metabase/components/Icon";
+import Modal from "metabase/components/Modal";
+import { CreateAlertModalContent, UpdateAlertModalContent } from "metabase/query_builder/components/AlertModals";
+import _ from "underscore";
+import cx from "classnames";
+import cxs from 'cxs';
+
+const unsubscribedClasses = cxs ({
+ marginLeft: '10px'
+})
+const ownAlertClasses = cxs ({
+ marginLeft: '9px',
+ marginRight: '17px'
+})
+const unsubscribeButtonClasses = cxs ({
+ transform: `translateY(4px)`
+})
+const popoverClasses = cxs ({
+ minWidth: '410px'
+})
+
+@connect((state) => ({ questionAlerts: getQuestionAlerts(state), user: getUser(state) }), null)
+export class AlertListPopoverContent extends Component {
+ props: {
+ questionAlerts: any[],
+ setMenuFreeze: (boolean) => void,
+ closeMenu: () => void
+ }
+
+ state = {
+ adding: false,
+ hasJustUnsubscribedFromOwnAlert: false
+ }
+
+ onAdd = () => {
+ this.props.setMenuFreeze(true)
+ this.setState({ adding: true })
+ }
+
+ onEndAdding = (closeMenu = false) => {
+ this.props.setMenuFreeze(false)
+ this.setState({ adding: false })
+ if (closeMenu) this.props.closeMenu()
+ }
+
+ isCreatedByCurrentUser = (alert) => {
+ const { user } = this.props;
+ return alert.creator.id === user.id
+ }
+
+ onUnsubscribe = (alert) => {
+ if (this.isCreatedByCurrentUser(alert)) {
+ this.setState({ hasJustUnsubscribedFromOwnAlert: true })
+ }
+ }
+
+ render() {
+ const { questionAlerts, setMenuFreeze, user, closeMenu } = this.props;
+ const { adding, hasJustUnsubscribedFromOwnAlert } = this.state
+
+ const isNonAdmin = !user.is_superuser
+ const [ownAlerts, othersAlerts] = _.partition(questionAlerts, this.isCreatedByCurrentUser)
+ // user's own alert should be shown first if it exists
+ const sortedQuestionAlerts = [...ownAlerts, ...othersAlerts]
+ const hasOwnAlerts = ownAlerts.length > 0
+ const hasOwnAndOthers = hasOwnAlerts && othersAlerts.length > 0
+
+ return (
+ <div className={popoverClasses}>
+ <ul>
+ { Object.values(sortedQuestionAlerts).map((alert) =>
+ <AlertListItem
+ alert={alert}
+ setMenuFreeze={setMenuFreeze}
+ closeMenu={closeMenu}
+ highlight={isNonAdmin && hasOwnAndOthers && this.isCreatedByCurrentUser(alert)}
+ onUnsubscribe={this.onUnsubscribe}
+ />)
+ }
+ </ul>
+ { (!hasOwnAlerts || hasJustUnsubscribedFromOwnAlert) &&
+ <div className="border-top p2 bg-light-blue">
+ <a className="link flex align-center text-bold text-small" onClick={this.onAdd}>
+ <Icon name="add" className={ownAlertClasses} /> {t`Set up your own alert`}
+ </a>
+ </div>
+ }
+ { adding && <Modal full onClose={this.onEndAdding}>
+ <CreateAlertModalContent onCancel={this.onEndAdding} onAlertCreated={() => this.onEndAdding(true) } />
+ </Modal> }
+ </div>
+ )
+ }
+}
+
+@connect((state) => ({ user: getUser(state) }), { unsubscribeFromAlert, deleteAlert })
+export class AlertListItem extends Component {
+ props: {
+ alert: any,
+ user: any,
+ setMenuFreeze: (boolean) => void,
+ closeMenu: () => void,
+ onUnsubscribe: () => void
+ }
+
+ state = {
+ unsubscribingProgress: null,
+ hasJustUnsubscribed: false,
+ editing: false
+ }
+
+ onUnsubscribe = async () => {
+ const { alert } = this.props
+
+ try {
+ this.setState({ unsubscribingProgress: t`Unsubscribing...` })
+ await this.props.unsubscribeFromAlert(alert)
+ this.setState({ hasJustUnsubscribed: true })
+ this.props.onUnsubscribe(alert)
+ } catch(e) {
+ this.setState({ unsubscribingProgress: t`Failed to unsubscribe` })
+ }
+ }
+
+ onEdit = () => {
+ this.props.setMenuFreeze(true)
+ this.setState({ editing: true })
+ }
+
+ onEndEditing = (shouldCloseMenu = false) => {
+ this.props.setMenuFreeze(false)
+ this.setState({ editing: false })
+ if (shouldCloseMenu) this.props.closeMenu()
+ }
+
+ render() {
+ const { user, alert, highlight } = this.props
+ const { editing, hasJustUnsubscribed, unsubscribingProgress } = this.state
+
+ const isAdmin = user.is_superuser
+ const isCurrentUser = alert.creator.id === user.id
+
+ const emailChannel = alert.channels.find((c) => c.channel_type === "email")
+ const emailEnabled = emailChannel && emailChannel.enabled
+ const slackChannel = alert.channels.find((c) => c.channel_type === "slack")
+ const slackEnabled = slackChannel && slackChannel.enabled
+
+ if (hasJustUnsubscribed) {
+ return <UnsubscribedListItem />
+ }
+
+ return (
+ <li className={cx("flex p3 text-grey-4 border-bottom", { "bg-light-blue": highlight })}>
+ <Icon name="alert" size="20" />
+ <div className="full ml2">
+ <div className="flex align-top">
+ <div>
+ <AlertCreatorTitle alert={alert} user={user} />
+ </div>
+ <div className={`${unsubscribeButtonClasses} ml-auto text-bold text-small`}>
+ { (isAdmin || isCurrentUser) && <a className="link" onClick={this.onEdit}>{jt`Edit`}</a> }
+ { !isAdmin && !unsubscribingProgress && <a className="link ml2" onClick={this.onUnsubscribe}>{jt`Unsubscribe`}</a> }
+ { !isAdmin && unsubscribingProgress && <span> {unsubscribingProgress}</span>}
+ </div>
+ </div>
+
+ {
+ // To-do: @kdoh wants to look into overall alignment
+ }
+ <ul className="flex mt2 text-small">
+ <li className="flex align-center">
+ <Icon name="clock" size="12" className="mr1" /> <AlertScheduleText schedule={alert.channels[0]} verbose={!isAdmin} />
+ </li>
+ { isAdmin && emailEnabled &&
+ <li className="ml3 flex align-center">
+ <Icon name="mail" className="mr1" />
+ { emailChannel.recipients.length }
+ </li>
+ }
+ { isAdmin && slackEnabled &&
+ <li className="ml3 flex align-center">
+ <Icon name="slack" size={16} className="mr1" />
+ { slackChannel.details && slackChannel.details.channel.replace("#","") || t`No channel` }
+ </li>
+ }
+ </ul>
+ </div>
+
+ { editing && <Modal full onClose={this.onEndEditing}>
+ <UpdateAlertModalContent
+ alert={alert}
+ onCancel={this.onEndEditing}
+ onAlertUpdated={() => this.onEndEditing(true)}
+ />
+ </Modal> }
+ </li>
+ )
+ }
+}
+
+export const UnsubscribedListItem = () =>
+ <li className="border-bottom flex align-center py4 text-bold">
+ <div className="circle flex align-center justify-center p1 bg-grey-0 ml2">
+ <Icon name="check" className="text-success" />
+ </div>
+ <h3 className={`${unsubscribedClasses} text-dark`} >{jt`Okay, you're unsubscribed`}</h3>
+ </li>
+
+export class AlertScheduleText extends Component {
+ getScheduleText = () => {
+ const { schedule, verbose } = this.props
+ const scheduleType = schedule.schedule_type
+
+ // these are pretty much copy-pasted from SchedulePicker
+ if (scheduleType === "hourly") {
+ return verbose ? "hourly" : "Hourly";
+ } else if (scheduleType === "daily") {
+ const hourOfDay = schedule.schedule_hour;
+ const hour = _.find(HOUR_OPTIONS, (opt) => opt.value === hourOfDay % 12).name;
+ const amPm = _.find(AM_PM_OPTIONS, (opt) => opt.value === (hourOfDay >= 12 ? 1 : 0)).name;
+
+ return `${verbose ? "daily at " : "Daily, "} ${hour} ${amPm}`
+ } else if (scheduleType === "weekly") {
+ console.log(schedule)
+ const hourOfDay = schedule.schedule_hour;
+ const day = _.find(DAY_OF_WEEK_OPTIONS, (o) => o.value === schedule.schedule_day).name
+ const hour = _.find(HOUR_OPTIONS, (opt) => opt.value === (hourOfDay % 12)).name;
+ const amPm = _.find(AM_PM_OPTIONS, (opt) => opt.value === (hourOfDay >= 12 ? 1 : 0)).name;
+
+ if (verbose) {
+ return `weekly on ${day}s at ${hour} ${amPm}`
+ } else {
+ // omit the minute part of time
+ return `${day}s, ${hour.substr(0, hour.indexOf(':'))} ${amPm}`
+ }
+ }
+ }
+
+ render() {
+ const { verbose } = this.props
+
+ const scheduleText = this.getScheduleText()
+
+ if (verbose) {
+ return <span>Checking <b>{ scheduleText }</b></span>
+ } else {
+ return <span>{ scheduleText }</span>
+ }
+ }
+}
+
+export class AlertCreatorTitle extends Component {
+ render () {
+ const { alert, user } = this.props
+
+ const isAdmin = user.is_superuser
+ const isCurrentUser = alert.creator.id === user.id
+ const creator = alert.creator.id === user.id ? "You" : alert.creator.first_name
+ const text = (!isCurrentUser && !isAdmin)
+ ? t`You're receiving ${creator}'s alerts`
+ : t`${creator} set up an alert`
+
+ return <h3 className="text-dark">{text}</h3>
+ }
+}
diff --git a/frontend/src/metabase/query_builder/components/AlertModals.jsx b/frontend/src/metabase/query_builder/components/AlertModals.jsx
new file mode 100644
index 0000000000000000000000000000000000000000..d46c5828aa9bcbcd999f96a9d6c91918e34e92ae
--- /dev/null
+++ b/frontend/src/metabase/query_builder/components/AlertModals.jsx
@@ -0,0 +1,505 @@
+import React, { Component } from "react";
+import Button from "metabase/components/Button";
+import SchedulePicker from "metabase/components/SchedulePicker";
+import { connect } from "react-redux";
+import { createAlert, deleteAlert, updateAlert } from "metabase/alert/alert";
+import ModalContent from "metabase/components/ModalContent";
+import { getUser, getUserIsAdmin } from "metabase/selectors/user";
+import { getQuestion } from "metabase/query_builder/selectors";
+import _ from "underscore";
+import PulseEditChannels from "metabase/pulse/components/PulseEditChannels";
+import { fetchPulseFormInput, fetchUsers } from "metabase/pulse/actions";
+import {
+ formInputSelector, hasConfiguredAnyChannelSelector, hasConfiguredEmailChannelSelector, hasLoadedChannelInfoSelector,
+ userListSelector
+} from "metabase/pulse/selectors";
+import DeleteModalWithConfirm from "metabase/components/DeleteModalWithConfirm";
+import ModalWithTrigger from "metabase/components/ModalWithTrigger";
+import { inflect } from "metabase/lib/formatting";
+import {
+ ALERT_TYPE_PROGRESS_BAR_GOAL, ALERT_TYPE_ROWS, ALERT_TYPE_TIMESERIES_GOAL,
+ getDefaultAlert
+} from "metabase-lib/lib/Alert";
+import type { AlertType } from "metabase-lib/lib/Alert";
+import Radio from "metabase/components/Radio";
+import RetinaImage from "react-retina-image";
+import Icon from "metabase/components/Icon";
+import MetabaseCookies from "metabase/lib/cookies";
+import cxs from 'cxs';
+import ChannelSetupModal from "metabase/components/ChannelSetupModal";
+import ButtonWithStatus from "metabase/components/ButtonWithStatus";
+
+const getScheduleFromChannel = (channel) =>
+ _.pick(channel, "schedule_day", "schedule_frame", "schedule_hour", "schedule_type")
+const classes = cxs ({
+ width: '162px',
+})
+
+@connect((state) => ({
+ question: getQuestion(state),
+ isAdmin: getUserIsAdmin(state),
+ user: getUser(state),
+ hasLoadedChannelInfo: hasLoadedChannelInfoSelector(state),
+ hasConfiguredAnyChannel: hasConfiguredAnyChannelSelector(state),
+ hasConfiguredEmailChannel: hasConfiguredEmailChannelSelector(state)
+}), { createAlert, fetchPulseFormInput })
+export class CreateAlertModalContent extends Component {
+ props: {
+ onCancel: () => void,
+ onAlertCreated: () => void
+ }
+
+ constructor(props) {
+ super()
+
+ const { question, user } = props
+
+ this.state = {
+ hasSeenEducationalScreen: MetabaseCookies.getHasSeenAlertSplash(),
+ alert: getDefaultAlert(question, user)
+ }
+ }
+
+ componentWillReceiveProps(newProps) {
+ // NOTE Atte Keinänen 11/6/17: Don't fill in the card information yet
+ // Because `onCreate` and `onSave` of QueryHeader mix Redux action dispatches and `setState` calls,
+ // we don't have up-to-date card information in the constructor yet
+ // TODO: Refactor QueryHeader so that `onCreate` and `onSave` only call Redux actions and don't modify the local state
+ if (this.props.question !== newProps.question) {
+ this.setState({
+ alert: {
+ ...this.state.alert,
+ card: { id: newProps.question.id() }
+ }
+ })
+ }
+ }
+
+ componentWillMount() {
+ // loads the channel information
+ this.props.fetchPulseFormInput();
+ }
+
+ onAlertChange = (alert) => this.setState({ alert })
+
+ onCreateAlert = async () => {
+ const { createAlert, onAlertCreated } = this.props
+ const { alert } = this.state
+
+ await createAlert(alert)
+ // should close be triggered manually like this
+ // but the creation notification would appear automatically ...?
+ // OR should the modal visibility be part of QB redux state
+ // (maybe check how other modals are implemented)
+ onAlertCreated()
+ }
+
+ proceedFromEducationalScreen = () => {
+ MetabaseCookies.setHasSeenAlertSplash(true)
+ this.setState({ hasSeenEducationalScreen: true })
+ }
+
+ render() {
+ const {
+ question,
+ onCancel,
+ hasConfiguredAnyChannel,
+ hasConfiguredEmailChannel,
+ isAdmin,
+ user,
+ hasLoadedChannelInfo
+ } = this.props
+ const { alert, hasSeenEducationalScreen } = this.state
+
+ const channelRequirementsMet = isAdmin ? hasConfiguredAnyChannel : hasConfiguredEmailChannel
+
+ if (hasLoadedChannelInfo && !channelRequirementsMet) {
+ return (
+ <ChannelSetupModal
+ user={user}
+ onClose={onCancel}
+ entityNamePlural={t`alerts`}
+ channels={isAdmin ? ["email", "Slack"] : ["email"]}
+ fullPageModal
+ />
+ )
+ }
+ if (!hasSeenEducationalScreen) {
+ return (
+ <ModalContent onClose={onCancel}>
+ <AlertEducationalScreen onProceed={this.proceedFromEducationalScreen} />
+ </ModalContent>
+ )
+ }
+
+ // TODO: Remove PulseEdit css hack
+ return (
+ <ModalContent
+ onClose={onCancel}
+ >
+ <div className="PulseEdit ml-auto mr-auto mb4" style={{maxWidth: "550px"}}>
+ <AlertModalTitle text={t`Let's set up your alert`} />
+ <AlertEditForm
+ alertType={question.alertType()}
+ alert={alert}
+ onAlertChange={this.onAlertChange}
+ />
+ <div className="flex align-center mt4">
+ <div className="flex-full" />
+ <Button onClick={onCancel} className="mr2">{t`Cancel`}</Button>
+ <ButtonWithStatus
+ titleForState={{default: t`Done`}}
+ onClickOperation={this.onCreateAlert}
+ />
+ </div>
+ </div>
+ </ModalContent>
+ )
+ }
+}
+
+export class AlertEducationalScreen extends Component {
+ props: {
+ onProceed: () => void
+ }
+
+ render() {
+ const { onProceed } = this.props;
+
+ return (
+ <div className="pt2 pb4 ml-auto mr-auto text-centered">
+ <div className="pt4">
+ <h1 className="mb1 text-dark">{t`The wide world of alerts`}</h1>
+ <h3 className="mb4 text-normal text-dark">{t`There are a few different kinds of alerts you can get`}</h3>
+ </div>
+ {
+ // @mazameli: needed to do some negative margin spacing to match the designs
+ }
+ <div className="text-normal pt3">
+ <div className="relative flex align-center pr4" style={{marginLeft: -80}}>
+ <RetinaImage src="app/assets/img/alerts/education-illustration-01-raw-data.png" />
+ <p className={`${classes} ml2 text-left`}>{jt`When a raw data question ${<strong>returns any results</strong>}`}</p>
+ </div>
+ <div className="relative flex align-center flex-reverse pl4" style={{marginTop: -50, marginRight: -80}}>
+ <RetinaImage src="app/assets/img/alerts/education-illustration-02-goal.png" />
+ <p className={`${classes} mr2 text-right`}>{jt`When a line or bar ${<strong>crosses a goal line</strong>}`}</p>
+ </div>
+ <div className="relative flex align-center" style={{marginTop: -60, marginLeft: -55}}>
+ <RetinaImage src="app/assets/img/alerts/education-illustration-03-progress.png" />
+ <p className={`${classes} ml2 text-left`}>{jt`When a progress bar ${<strong>reaches its goal</strong>}`}</p>
+ </div>
+ </div>
+ <Button primary className="mt4" onClick={onProceed}>{t`Set up an alert`}</Button>
+ </div>
+ )
+ }
+}
+
+@connect((state) => ({
+ user: getUser(state),
+ isAdmin: getUserIsAdmin(state),
+ question: getQuestion(state),
+}), { updateAlert, deleteAlert })
+export class UpdateAlertModalContent extends Component {
+ props: {
+ alert: any,
+ onCancel: boolean,
+ onAlertUpdated: (any) => void,
+ updateAlert: (any) => void,
+ deleteAlert: (any) => void,
+ isAdmin: boolean
+ }
+
+ constructor(props) {
+ super()
+ this.state = {
+ modifiedAlert: props.alert
+ }
+ }
+
+ onAlertChange = (modifiedAlert) => this.setState({ modifiedAlert })
+
+ onUpdateAlert = async () => {
+ const { updateAlert, onAlertUpdated } = this.props
+ const { modifiedAlert } = this.state
+ await updateAlert(modifiedAlert)
+ onAlertUpdated()
+ }
+
+ onDeleteAlert = async () => {
+ const { alert, deleteAlert, onAlertUpdated } = this.props
+ await deleteAlert(alert.id)
+ onAlertUpdated()
+ }
+
+ render() {
+ const { onCancel, question, alert, user, isAdmin } = this.props
+ const { modifiedAlert } = this.state
+
+ const isCurrentUser = alert.creator.id === user.id
+ const title = isCurrentUser ? t`Edit your alert` : t`Edit alert`
+ // TODO: Remove PulseEdit css hack
+ return (
+ <ModalContent
+ onClose={onCancel}
+ >
+ <div className="PulseEdit ml-auto mr-auto mb4" style={{maxWidth: "550px"}}>
+ <AlertModalTitle text={title} />
+ <AlertEditForm
+ alertType={question.alertType()}
+ alert={modifiedAlert}
+ onAlertChange={this.onAlertChange}
+ />
+ { isAdmin && <DeleteAlertSection alert={alert} onDeleteAlert={this.onDeleteAlert} /> }
+
+ <div className="flex align-center mt4">
+ <div className="flex-full" />
+ <Button onClick={onCancel} className="mr2">{t`Cancel`}</Button>
+ <ButtonWithStatus
+ titleForState={{default: t`Save changes`}}
+ onClickOperation={this.onUpdateAlert}
+ />
+ </div>
+ </div>
+ </ModalContent>
+ )
+ }
+}
+
+export class DeleteAlertSection extends Component {
+ deleteModal: any
+
+ getConfirmItems() {
+ // same as in PulseEdit but with some changes to copy
+ return this.props.alert.channels.map(c =>
+ c.channel_type === "email" ?
+ <span>{jt`This alert will no longer be emailed to ${<strong>{c.recipients.length} {inflect("address", c.recipients.length)}</strong>}.`}</span>
+ : c.channel_type === "slack" ?
+ <span>{jt`Slack channel ${<strong>{c.details && c.details.channel}</strong>} will no longer get this alert.`}</span>
+ :
+ <span>{jt`Channel ${<strong>{c.channel_type}</strong>} will no longer receive this alert.`}</span>
+ );
+ }
+
+ render() {
+ const { onDeleteAlert } = this.props
+
+ return (
+ <div className="DangerZone mt4 pt4 mb2 p3 rounded bordered relative">
+ <h3 className="text-error absolute top bg-white px1" style={{ marginTop: "-12px" }}>{jt`Danger Zone`}</h3>
+ <div className="ml1">
+ <h4 className="text-bold mb1">{jt`Delete this alert`}</h4>
+ <div className="flex">
+ <p className="h4 pr2">{jt`Stop delivery and delete this alert. There's no undo, so be careful.`}</p>
+ <ModalWithTrigger
+ ref={(ref) => this.deleteModal = ref}
+ triggerClasses="Button Button--danger flex-align-right flex-no-shrink"
+ triggerElement="Delete this Alert"
+ >
+ <DeleteModalWithConfirm
+ objectType="alert"
+ title={t`Delete this alert?`}
+ confirmItems={this.getConfirmItems()}
+ onClose={() => this.deleteModal.close()}
+ onDelete={onDeleteAlert}
+ />
+ </ModalWithTrigger>
+ </div>
+ </div>
+ </div>
+ )
+ }
+}
+
+const AlertModalTitle = ({ text }) =>
+ <div className="ml-auto mr-auto my4 pb2 text-centered">
+ <RetinaImage className="mb3" src="app/assets/img/alerts/alert-bell-confetti-illustration.png" />
+ <h1 className="text-dark">{ text }</h1>
+ </div>
+
+@connect((state) => ({ isAdmin: getUserIsAdmin(state) }), null)
+export class AlertEditForm extends Component {
+ props: {
+ alertType: AlertType,
+ alert: any,
+ onAlertChange: (any) => void,
+ isAdmin: boolean
+ }
+
+ onScheduleChange = (schedule) => {
+ const { alert, onAlertChange } = this.props;
+
+ // update the same schedule to all channels at once
+ onAlertChange({
+ ...alert,
+ channels: alert.channels.map((channel) => ({ ...channel, ...schedule }))
+ })
+ }
+
+ render() {
+ const { alertType, alert, isAdmin, onAlertChange } = this.props
+
+ // the schedule should be same for all channels so we can use the first one
+ const schedule = getScheduleFromChannel(alert.channels[0])
+
+ return (
+ <div>
+ <AlertGoalToggles
+ alertType={alertType}
+ alert={alert}
+ onAlertChange={onAlertChange}
+ />
+ <AlertEditSchedule
+ alertType={alertType}
+ schedule={schedule}
+ onScheduleChange={this.onScheduleChange}
+ />
+ { isAdmin &&
+ <AlertEditChannels
+ alert={alert}
+ onAlertChange={onAlertChange}
+ />
+ }
+ </div>
+ )
+ }
+}
+
+export const AlertGoalToggles = ({ alertType, alert, onAlertChange }) => {
+ const isTimeseries = alertType === ALERT_TYPE_TIMESERIES_GOAL
+ const isProgress = alertType === ALERT_TYPE_PROGRESS_BAR_GOAL
+
+ if (!isTimeseries && !isProgress) {
+ // not a goal alert
+ return null
+ }
+
+ return (
+ <div>
+ <AlertAboveGoalToggle
+ alert={alert}
+ onAlertChange={onAlertChange}
+ title={isTimeseries ? t`Alert me when the line…` : t`Alert me when the progress bar…`}
+ trueText={isTimeseries ? t`Goes above the goal line` : t`Reaches the goal`}
+ falseText={isTimeseries ? t`Goes below the goal line` : t`Goes below the goal`}
+ />
+ <AlertFirstOnlyToggle
+ alert={alert}
+ onAlertChange={onAlertChange}
+ title={isTimeseries
+ ? t`The first time it crosses, or every time?`
+ : t`The first time it reaches the goal, or every time?`
+ }
+ trueText={t`The first time`}
+ falseText={t`Every time` }
+ />
+ </div>
+ )
+}
+
+export const AlertAboveGoalToggle = (props) =>
+ <AlertSettingToggle {...props} setting="alert_above_goal" />
+
+export const AlertFirstOnlyToggle = (props) =>
+ <AlertSettingToggle {...props} setting="alert_first_only" />
+
+export const AlertSettingToggle = ({ alert, onAlertChange, title, trueText, falseText, setting }) =>
+ <div className="mb4 pb2">
+ <h3 className="text-dark mb1">{title}</h3>
+ <Radio
+ value={alert[setting]}
+ onChange={(value) => onAlertChange({ ...alert, [setting]: value })}
+ options={[{ name: trueText, value: true }, { name: falseText, value: false }]}
+ />
+ </div>
+
+
+export class AlertEditSchedule extends Component {
+ render() {
+ const { alertType, schedule } = this.props;
+
+ return (
+ <div>
+ <h3 className="mt4 mb3 text-dark">How often should we check for results?</h3>
+
+ <div className="bordered rounded mb2">
+ { alertType === ALERT_TYPE_ROWS && <RawDataAlertTip /> }
+ <div className="p3 bg-grey-0">
+ <SchedulePicker
+ schedule={schedule}
+ scheduleOptions={["hourly", "daily", "weekly"]}
+ onScheduleChange={this.props.onScheduleChange}
+ textBeforeInterval="Check"
+ />
+ </div>
+ </div>
+ </div>
+ )
+ }
+}
+
+@connect(
+ (state) => ({ user: getUser(state), userList: userListSelector(state), formInput: formInputSelector(state) }),
+ { fetchPulseFormInput, fetchUsers }
+)
+export class AlertEditChannels extends Component {
+ props: {
+ onChannelsChange: (any) => void,
+ user: any,
+ userList: any[],
+ // this stupidly named property contains different channel options, nothing else
+ formInput: any,
+ fetchPulseFormInput: () => void,
+ fetchUsers: () => void
+ }
+
+ componentDidMount() {
+ this.props.fetchPulseFormInput();
+ this.props.fetchUsers();
+ }
+
+ // Technically pulse definition is equal to alert definition
+ onSetPulse = (alert) => {
+ // If the pulse channel has been added, it PulseEditChannels puts the default schedule to it
+ // We want to have same schedule for all channels
+ const schedule = getScheduleFromChannel(alert.channels.find((c) => c.channel_type === "email"))
+
+ this.props.onAlertChange({
+ ...alert,
+ channels: alert.channels.map((channel) => ({ ...channel, ...schedule }))
+ })
+ }
+
+ render() {
+ const { alert, user, userList, formInput } = this.props;
+ return (
+ <div className="mt4 pt2">
+ <h3 className="text-dark mb3">{jt`Where do you want to send these alerts?`}</h3>
+ <div className="mb2">
+ <PulseEditChannels
+ pulse={alert}
+ pulseId={alert.id}
+ pulseIsValid={true}
+ formInput={formInput}
+ user={user}
+ userList={userList}
+ setPulse={this.onSetPulse}
+ hideSchedulePicker={true}
+ emailRecipientText={t`Email alerts to:`}
+ />
+ </div>
+ </div>
+ )
+ }
+}
+
+// TODO: Not sure how to translate text with formatting properly
+export const RawDataAlertTip = () =>
+ <div className="border-row-divider p3 flex align-center">
+ <div className="circle flex align-center justify-center bg-grey-0 p2 mr2 text-grey-3">
+ <Icon name="lightbulb" size="20" />
+ </div>
+ <div>
+ {jt`${<strong>Tip:</strong>} This kind of alert is most useful when your saved question doesn’t ${<em>usually</em>} return any results, but you want to know when it does.`}
+ </div>
+ </div>
diff --git a/frontend/src/metabase/query_builder/components/QueryHeader.jsx b/frontend/src/metabase/query_builder/components/QueryHeader.jsx
index 1542e065b46305a46574249ea81e6037fddc5b47..82550ab31df4c265be0ba0792acac0ccd49774cc 100644
--- a/frontend/src/metabase/query_builder/components/QueryHeader.jsx
+++ b/frontend/src/metabase/query_builder/components/QueryHeader.jsx
@@ -33,14 +33,25 @@ import cx from "classnames";
import _ from "underscore";
import NativeQuery from "metabase-lib/lib/queries/NativeQuery";
import Utils from "metabase/lib/utils";
+import EntityMenu from "metabase/components/EntityMenu";
+import { CreateAlertModalContent } from "metabase/query_builder/components/AlertModals";
+import { AlertListPopoverContent } from "metabase/query_builder/components/AlertListPopoverContent";
+import { getQuestionAlerts } from "metabase/query_builder/selectors";
+import { getUser } from "metabase/home/selectors";
+import { fetchAlertsForQuestion } from "metabase/alert/alert";
+
+const mapStateToProps = (state, props) => ({
+ questionAlerts: getQuestionAlerts(state),
+ user: getUser(state)
+})
const mapDispatchToProps = {
+ fetchAlertsForQuestion,
clearRequestState
};
-
const ICON_SIZE = 16
-@connect(null, mapDispatchToProps)
+@connect(mapStateToProps, mapDispatchToProps)
export default class QueryHeader extends Component {
constructor(props, context) {
super(props, context);
@@ -59,6 +70,7 @@ export default class QueryHeader extends Component {
}
static propTypes = {
+ question: PropTypes.object.isRequired,
card: PropTypes.object.isRequired,
originalCard: PropTypes.object,
isEditing: PropTypes.bool.isRequired,
@@ -120,7 +132,7 @@ export default class QueryHeader extends Component {
this.props.clearRequestState({ statePath: ["metadata", "databases"] });
}
- onCreate(card, addToDash) {
+ onCreate(card, showSavedModal = true) {
// MBQL->NATIVE
// if we are a native query with an MBQL query definition, remove the old MBQL stuff (happens when going from mbql -> native)
// if (card.dataset_query.type === "native" && card.dataset_query.query) {
@@ -141,12 +153,12 @@ export default class QueryHeader extends Component {
this.setState({
recentlySaved: "created",
- modal: addToDash ? "add-to-dashboard" : "saved"
+ ...(showSavedModal ? { modal: "saved" } : {})
}, this.resetStateOnTimeout);
});
}
- onSave(card, addToDash) {
+ onSave = async (card, showSavedModal = true) => {
// MBQL->NATIVE
// if we are a native query with an MBQL query definition, remove the old MBQL stuff (happens when going from mbql -> native)
// if (card.dataset_query.type === "native" && card.dataset_query.query) {
@@ -154,13 +166,18 @@ export default class QueryHeader extends Component {
// } else if (card.dataset_query.type === "query" && card.dataset_query.native) {
// delete card.dataset_query.native;
// }
+ const { fetchAlertsForQuestion } = this.props
const cleanedCard = this._getCleanedCard(card);
this.addResultMetadata(cleanedCard);
// TODO: reduxify
this.requestPromise = cancelable(CardApi.update(cleanedCard));
- return this.requestPromise.then(updatedCard => {
+ return this.requestPromise.then(async updatedCard => {
+ // reload the question alerts for the current question
+ // (some of the old alerts might be removed during update)
+ await fetchAlertsForQuestion(updatedCard.id)
+
this.clearQBDatabases();
if (this.props.fromUrl) {
@@ -172,7 +189,7 @@ export default class QueryHeader extends Component {
this.setState({
recentlySaved: "updated",
- modal: addToDash ? "add-to-dashboard" : null
+ ...(showSavedModal ? { modal: "saved" } : {})
}, this.resetStateOnTimeout);
});
}
@@ -225,7 +242,7 @@ export default class QueryHeader extends Component {
}
getHeaderButtons() {
- const { question, card ,isNew, isDirty, isEditing, tableMetadata, databases } = this.props;
+ const { question, questionAlerts, card ,isNew, isDirty, isEditing, tableMetadata, databases } = this.props;
const database = _.findWhere(databases, { id: card && card.dataset_query && card.dataset_query.database });
var buttonSections = [];
@@ -244,7 +261,6 @@ export default class QueryHeader extends Component {
card={this.props.card}
originalCard={this.props.originalCard}
tableMetadata={this.props.tableMetadata}
- addToDashboard={false}
saveFn={this.onSave}
createFn={this.onCreate}
onClose={() => this.refs.saveModal.toggle()}
@@ -368,10 +384,16 @@ export default class QueryHeader extends Component {
card={this.props.card}
originalCard={this.props.originalCard}
tableMetadata={this.props.tableMetadata}
- addToDashboard={true}
- saveFn={this.onSave}
- createFn={this.onCreate}
+ saveFn={async (card) => {
+ await this.onSave(card, false);
+ this.setState({ modal: "add-to-dashboard"})
+ }}
+ createFn={async (card) => {
+ await this.onCreate(card, false);
+ this.setState({ modal: "add-to-dashboard"})
+ }}
onClose={() => this.refs.addToDashSaveModal.toggle()}
+ multiStep
/>
</ModalWithTrigger>
</Tooltip>
@@ -419,7 +441,7 @@ export default class QueryHeader extends Component {
]);
// data reference button
- var dataReferenceButtonClasses = cx('mr1 transition-color', {
+ var dataReferenceButtonClasses = cx('transition-color', {
'text-brand': this.props.isShowingDataReference,
'text-brand-hover': !this.state.isShowingDataReference
});
@@ -431,6 +453,38 @@ export default class QueryHeader extends Component {
</Tooltip>
]);
+ if (!isEditing && card && question.alertType() !== null) {
+ const createAlertItem = {
+ title: t`Get alerts about this`,
+ icon: "alert",
+ action: () => this.setState({ modal: "create-alert" })
+ }
+ const createAlertAfterSavingQuestionItem = {
+ title: t`Get alerts about this`,
+ icon: "alert",
+ action: () => this.setState({ modal: "save-question-before-alert" })
+ }
+
+ const updateAlertItem = {
+ title: t`Alerts are on`,
+ icon: "alert",
+ content: (toggleMenu, setMenuFreeze) => <AlertListPopoverContent closeMenu={toggleMenu} setMenuFreeze={setMenuFreeze} />
+ }
+
+ buttonSections.push([
+ <div className="mr1" style={{ marginLeft: "-15px" }}>
+ <EntityMenu
+ triggerIcon='burger'
+ items={[
+ (!isNew && Object.values(questionAlerts).length > 0)
+ ? updateAlertItem
+ : (isNew ? createAlertAfterSavingQuestionItem : createAlertItem)
+ ]}
+ />
+ </div>
+ ]);
+ }
+
return (
<ButtonBar buttons={buttonSections} className="Header-buttonSection borderless" />
);
@@ -440,6 +494,21 @@ export default class QueryHeader extends Component {
this.setState({ modal: null });
}
+ showAlertsAfterQuestionSaved = () => {
+ const { questionAlerts, user } = this.props
+
+ const hasAlertsCreatedByCurrentUser =
+ Object.values(questionAlerts).some((alert) => alert.creator.id === user.id)
+
+ if (hasAlertsCreatedByCurrentUser) {
+ // TODO Atte Keinänen 11/10/17: The question was replaced and there is already an alert created by current user.
+ // Should we show pop up the alerts list in this case or do nothing (as we do currently)?
+ this.setState({ modal: null })
+ } else {
+ this.setState({ modal: "create-alert" })
+ }
+ }
+
render() {
return (
<div className="relative">
@@ -469,6 +538,7 @@ export default class QueryHeader extends Component {
/>
</Modal>
+
<Modal isOpen={this.state.modal === "add-to-dashboard"} onClose={this.onCloseModal}>
<AddToDashSelectDashModal
card={this.props.card}
@@ -476,6 +546,30 @@ export default class QueryHeader extends Component {
onChangeLocation={this.props.onChangeLocation}
/>
</Modal>
+
+ <Modal full isOpen={this.state.modal === "create-alert"} onClose={this.onCloseModal}>
+ <CreateAlertModalContent onCancel={this.onCloseModal} onAlertCreated={this.onCloseModal} />
+ </Modal>
+
+ <Modal isOpen={this.state.modal === "save-question-before-alert"} onClose={this.onCloseModal}>
+ <SaveQuestionModal
+ card={this.props.card}
+ originalCard={this.props.originalCard}
+ tableMetadata={this.props.tableMetadata}
+ saveFn={async (card) => {
+ await this.onSave(card, false);
+ this.showAlertsAfterQuestionSaved()
+ }}
+ createFn={async (card) => {
+ await this.onCreate(card, false);
+ this.showAlertsAfterQuestionSaved()
+ }}
+ // only close the modal if we are closing the dialog without saving
+ // otherwise we are in some alerts modal already
+ onClose={() => this.state.modal === "save-question-before-alert" && this.setState({ modal: null }) }
+ multiStep
+ />
+ </Modal>
</div>
);
}
diff --git a/frontend/src/metabase/query_builder/components/VisualizationResult.jsx b/frontend/src/metabase/query_builder/components/VisualizationResult.jsx
index 3b05fa3b2b21e7b3000042d9c6196db96a48cb7b..9c7bf3222356932d31bac0a0178c8c5a8e112ef5 100644
--- a/frontend/src/metabase/query_builder/components/VisualizationResult.jsx
+++ b/frontend/src/metabase/query_builder/components/VisualizationResult.jsx
@@ -5,51 +5,85 @@ import VisualizationErrorMessage from './VisualizationErrorMessage';
import Visualization from "metabase/visualizations/components/Visualization.jsx";
import { datasetContainsNoResults } from "metabase/lib/dataset";
import { DatasetQuery } from "metabase/meta/types/Card";
+import { CreateAlertModalContent } from "metabase/query_builder/components/AlertModals";
+import { Component } from "react/lib/ReactBaseClasses";
+import Modal from "metabase/components/Modal";
+import { ALERT_TYPE_ROWS } from "metabase-lib/lib/Alert";
type Props = {
question: Question,
isObjectDetail: boolean,
result: any,
results: any[],
+ isDirty: boolean,
lastRunDatasetQuery: DatasetQuery,
navigateToNewCardInsideQB: (any) => void
}
-const VisualizationResult = ({question, isObjectDetail, lastRunDatasetQuery, navigateToNewCardInsideQB, result, results, ...props}: Props) => {
- const noResults = datasetContainsNoResults(result.data);
- if (noResults) {
- // successful query but there were 0 rows returned with the result
- return <VisualizationErrorMessage
- type='noRows'
- title='No results!'
- message='This may be the answer you’re looking for. If not, chances are your filters are too specific. Try removing or changing your filters to see more data.'
- action={
- <button className="Button" onClick={() => window.history.back() }>
- Back to last run
- </button>
- }
- />
- } else {
- // we want to provide the visualization with a card containing the latest
- // "display", "visualization_settings", etc, (to ensure the correct visualization is shown)
- // BUT the last executed "dataset_query" (to ensure data matches the query)
- const series = question.atomicQueries().map((metricQuery, index) => ({
- card: {
- ...question.card(),
- display: isObjectDetail ? "object" : question.card().display,
- dataset_query: lastRunDatasetQuery
- },
- data: results[index] && results[index].data
- }));
-
- return <Visualization
- series={series}
- onChangeCardAndRun={navigateToNewCardInsideQB}
- isEditing={true}
- card={question.card()}
- // Table:
- {...props}
- />
+
+export default class VisualizationResult extends Component {
+ props: Props
+ state = {
+ showCreateAlertModal: false
+ }
+
+ showCreateAlertModal = () => {
+ this.setState({ showCreateAlertModal: true })
+ }
+
+ onCloseCreateAlertModal = () => {
+ this.setState({ showCreateAlertModal: false })
}
-};
-export default VisualizationResult;
+ render() {
+ const { question, isDirty, isObjectDetail, lastRunDatasetQuery, navigateToNewCardInsideQB, result, results, ...props } = this.props
+ const { showCreateAlertModal } = this.state
+
+ const noResults = datasetContainsNoResults(result.data);
+ if (noResults) {
+ const supportsRowsPresentAlert = question.alertType() === ALERT_TYPE_ROWS
+
+ // successful query but there were 0 rows returned with the result
+ return <div className="flex flex-full">
+ <VisualizationErrorMessage
+ type='noRows'
+ title='No results!'
+ message='This may be the answer you’re looking for. If not, try removing or changing your filters to make them less specific.'
+ action={
+ <div>
+ { supportsRowsPresentAlert && !isDirty && <p>
+ You can also <a className="link" onClick={this.showCreateAlertModal}>get an alert</a> when there are any results.
+ </p> }
+ <button className="Button" onClick={() => window.history.back() }>
+ Back to last run
+ </button>
+ </div>
+ }
+ />
+ { showCreateAlertModal && <Modal full onClose={this.onCloseCreateAlertModal}>
+ <CreateAlertModalContent onCancel={this.onCloseCreateAlertModal} onAlertCreated={this.onCloseCreateAlertModal} />
+ </Modal> }
+ </div>
+ } else {
+ // we want to provide the visualization with a card containing the latest
+ // "display", "visualization_settings", etc, (to ensure the correct visualization is shown)
+ // BUT the last executed "dataset_query" (to ensure data matches the query)
+ const series = question.atomicQueries().map((metricQuery, index) => ({
+ card: {
+ ...question.card(),
+ display: isObjectDetail ? "object" : question.card().display,
+ dataset_query: lastRunDatasetQuery
+ },
+ data: results[index] && results[index].data
+ }));
+
+ return <Visualization
+ series={series}
+ onChangeCardAndRun={navigateToNewCardInsideQB}
+ isEditing={true}
+ card={question.card()}
+ // Table:
+ {...props}
+ />
+ }
+ }
+}
diff --git a/frontend/src/metabase/query_builder/reducers.js b/frontend/src/metabase/query_builder/reducers.js
index 0365d2801a01375ab0a9bf3075fbc4b4c244f893..904f3b1f2be56dd8de0d169b3150b276a9c62b96 100644
--- a/frontend/src/metabase/query_builder/reducers.js
+++ b/frontend/src/metabase/query_builder/reducers.js
@@ -168,3 +168,4 @@ export const parameterValues = handleActions({
export const currentState = handleActions({
[SET_CURRENT_STATE]: { next: (state, { payload }) => payload }
}, null);
+
diff --git a/frontend/src/metabase/query_builder/selectors.js b/frontend/src/metabase/query_builder/selectors.js
index 6dffe0319d318cc42c64259115363f4ea9c79f12..790bfc2aeb8d9fde010dc098d34e8e99e3ebea84 100644
--- a/frontend/src/metabase/query_builder/selectors.js
+++ b/frontend/src/metabase/query_builder/selectors.js
@@ -96,6 +96,7 @@ export const getDatabaseFields = createSelector(
import { getMode as getMode_ } from "metabase/qb/lib/modes";
+import { getAlerts } from "metabase/alert/selectors";
export const getMode = createSelector(
[getLastRunCard, getTableMetadata],
@@ -156,3 +157,8 @@ export const getQuery = createSelector(
)
export const getIsRunnable = createSelector([getQuestion], (question) => question && question.canRun())
+
+export const getQuestionAlerts = createSelector(
+ [getAlerts, getCard],
+ (alerts, card) => card && card.id && _.pick(alerts, (alert) => alert.card.id === card.id) || {}
+)
diff --git a/frontend/src/metabase/reducers-main.js b/frontend/src/metabase/reducers-main.js
index b38c91f21d2f208bd196a4d78740318038235496..a222bd3a05a2d945075b85a811b391affe71a180 100644
--- a/frontend/src/metabase/reducers-main.js
+++ b/frontend/src/metabase/reducers-main.js
@@ -30,6 +30,9 @@ import * as qb from "metabase/query_builder/reducers";
/* data reference */
import reference from "metabase/reference/reference";
+/* alerts */
+import alert from "metabase/alert/alert";
+
/* pulses */
import * as pulse from "metabase/pulse/reducers";
@@ -41,6 +44,7 @@ export default {
...commonReducers,
// main app reducers
+ alert,
dashboards,
dashboard,
home: combineReducers(home),
diff --git a/frontend/src/metabase/redux/undo.js b/frontend/src/metabase/redux/undo.js
index f1ffb2d649def870ec9b90c33062c7eb81280ecc..230a943e896ef60102f9b3daa20ba48ae2143b3e 100644
--- a/frontend/src/metabase/redux/undo.js
+++ b/frontend/src/metabase/redux/undo.js
@@ -1,17 +1,26 @@
/* @flow weak */
-import { createAction, createThunkAction } from "metabase/lib/redux";
+import _ from "underscore";
+import { createAction, createThunkAction } from "metabase/lib/redux";
import MetabaseAnalytics from "metabase/lib/analytics";
-import _ from "underscore";
-
const ADD_UNDO = 'metabase/questions/ADD_UNDO';
const DISMISS_UNDO = 'metabase/questions/DISMISS_UNDO';
const PERFORM_UNDO = 'metabase/questions/PERFORM_UNDO';
let nextUndoId = 0;
+// A convenience shorthand for creating single undos
+export function createUndo({ type, message, action }) {
+ return {
+ type: type,
+ count: 1,
+ message,
+ actions: action ? [action] : null
+ };
+}
+
export const addUndo = createThunkAction(ADD_UNDO, (undo) => {
return (dispatch, getState) => {
let id = nextUndoId++;
diff --git a/frontend/src/metabase/services.js b/frontend/src/metabase/services.js
index f1536ecafadf60f1c0527fd8b8e8ae7c61d87123..df8bdc4d69b6a083d0d83dc5b5e1730c607ae019 100644
--- a/frontend/src/metabase/services.js
+++ b/frontend/src/metabase/services.js
@@ -184,6 +184,15 @@ export const PulseApi = {
preview_card: GET("/api/pulse/preview_card_info/:id"),
};
+export const AlertApi = {
+ list: GET("/api/alert"),
+ list_for_question: GET("/api/alert/question/:questionId"),
+ create: POST("/api/alert"),
+ update: PUT("/api/alert/:id"),
+ delete: DELETE("/api/alert/:id"),
+ unsubscribe: PUT("/api/alert/:id/unsubscribe"),
+};
+
export const SegmentApi = {
list: GET("/api/segment"),
create: POST("/api/segment"),
diff --git a/frontend/test/__support__/integrated_tests.js b/frontend/test/__support__/integrated_tests.js
index 30be032a9020a4868a038dd7e940c47dc57df83c..6f7b1477ce555170d5aa98b355e701f8d1f12c12 100644
--- a/frontend/test/__support__/integrated_tests.js
+++ b/frontend/test/__support__/integrated_tests.js
@@ -43,6 +43,20 @@ let simulateOfflineMode = false;
let apiRequestCompletedCallback = null;
let skippedApiRequests = [];
+
+// These i18n settings are same is beginning of app.js
+
+// make the i18n function "t" global so we don't have to import it in basically every file
+import { t, jt } from "c-3po";
+global.t = t;
+global.jt = jt;
+
+// set the locale before loading anything else
+import { setLocalization } from "metabase/lib/i18n";
+if (window.MetabaseLocalization) {
+ setLocalization(window.MetabaseLocalization)
+}
+
const warnAboutCreatingStoreBeforeLogin = () => {
if (!loginSession && hasStartedCreatingStore) {
console.warn(
diff --git a/frontend/test/alert/alert.integ.spec.js b/frontend/test/alert/alert.integ.spec.js
new file mode 100644
index 0000000000000000000000000000000000000000..e80b44cd78886877db2bd0fda8c1d237a40ad417
--- /dev/null
+++ b/frontend/test/alert/alert.integ.spec.js
@@ -0,0 +1,428 @@
+import {
+ createSavedQuestion,
+ createTestStore,
+ forBothAdminsAndNormalUsers,
+ useSharedAdminLogin,
+ useSharedNormalLogin
+} from "__support__/integrated_tests";
+import {
+ click, clickButton
+} from "__support__/enzyme_utils"
+
+import { fetchTableMetadata } from "metabase/redux/metadata";
+import { mount } from "enzyme";
+import { setIn } from "icepick";
+import { AlertApi, CardApi, PulseApi, UserApi } from "metabase/services";
+import Question from "metabase-lib/lib/Question";
+import * as Urls from "metabase/lib/urls";
+import { INITIALIZE_QB, QUERY_COMPLETED } from "metabase/query_builder/actions";
+import QueryHeader from "metabase/query_builder/components/QueryHeader";
+import EntityMenu from "metabase/components/EntityMenu";
+import { delay } from "metabase/lib/promise";
+import Icon from "metabase/components/Icon";
+import {
+ AlertEducationalScreen,
+ AlertSettingToggle,
+ CreateAlertModalContent,
+ RawDataAlertTip, UpdateAlertModalContent
+} from "metabase/query_builder/components/AlertModals";
+import Button from "metabase/components/Button";
+import {
+ CREATE_ALERT,
+ FETCH_ALERTS_FOR_QUESTION,
+ UNSUBSCRIBE_FROM_ALERT,
+ UPDATE_ALERT,
+} from "metabase/alert/alert";
+import MetabaseCookies from "metabase/lib/cookies";
+import Radio from "metabase/components/Radio";
+import { getQuestionAlerts } from "metabase/query_builder/selectors";
+import { FETCH_PULSE_FORM_INPUT, FETCH_USERS } from "metabase/pulse/actions";
+import ChannelSetupModal from "metabase/components/ChannelSetupModal";
+import { getDefaultAlert } from "metabase-lib/lib/Alert";
+import { getMetadata } from "metabase/selectors/metadata";
+import { AlertListItem, AlertListPopoverContent } from "metabase/query_builder/components/AlertListPopoverContent";
+
+
+async function removeAllCreatedAlerts() {
+ useSharedAdminLogin()
+ const alerts = await AlertApi.list()
+ await Promise.all(alerts.map((alert) => AlertApi.delete({ id: alert.id })))
+}
+
+const initQbWithAlertMenuItemClicked = async (question, { hasSeenAlertSplash = true } = {}) => {
+ MetabaseCookies.getHasSeenAlertSplash = () => hasSeenAlertSplash
+
+ const store = await createTestStore()
+ store.pushPath(Urls.question(question.id()))
+ const app = mount(store.getAppContainer());
+
+ await store.waitForActions([INITIALIZE_QB, QUERY_COMPLETED, FETCH_ALERTS_FOR_QUESTION])
+ await delay(500);
+
+ const actionsMenu = app.find(QueryHeader).find(EntityMenu)
+ click(actionsMenu.childAt(0))
+
+ const alertsMenuItem = actionsMenu.find(Icon).filterWhere(i => i.prop("name") === "alert")
+ click(alertsMenuItem)
+
+ return { store, app }
+}
+
+describe("Alerts", () => {
+ let rawDataQuestion = null;
+ let timeSeriesQuestion = null;
+ let timeSeriesWithGoalQuestion = null;
+ let progressBarQuestion = null;
+
+ beforeAll(async () => {
+ useSharedAdminLogin()
+
+ const store = await createTestStore()
+
+ // table metadata is needed for `Question.alertType()` calls
+ await store.dispatch(fetchTableMetadata(1))
+ const metadata = getMetadata(store.getState())
+
+ rawDataQuestion = await createSavedQuestion(
+ Question.create({databaseId: 1, tableId: 1, metadata })
+ .query()
+ .addFilter(["=", ["field-id", 4], 123456])
+ .question()
+ .setDisplayName("Just raw, untamed data")
+ )
+
+ timeSeriesQuestion = await createSavedQuestion(
+ Question.create({databaseId: 1, tableId: 1, metadata })
+ .query()
+ .addAggregation(["count"])
+ .addBreakout(["datetime-field", ["field-id", 1], "day"])
+ .question()
+ .setDisplay("line")
+ .setDisplayName("Time series line")
+ )
+
+ timeSeriesWithGoalQuestion = await createSavedQuestion(
+ Question.create({databaseId: 1, tableId: 1, metadata })
+ .query()
+ .addAggregation(["count"])
+ .addBreakout(["datetime-field", ["field-id", 1], "day"])
+ .question()
+ .setDisplay("line")
+ .setVisualizationSettings({ "graph.show_goal": true, "graph.goal_value": 10 })
+ .setDisplayName("Time series line with goal")
+ )
+
+ progressBarQuestion = await createSavedQuestion(
+ Question.create({databaseId: 1, tableId: 1, metadata })
+ .query()
+ .addAggregation(["count"])
+ .question()
+ .setDisplay("progress")
+ .setVisualizationSettings({ "progress.goal": 50 })
+ .setDisplayName("Progress bar question")
+ )
+ })
+
+ afterAll(async () => {
+ await CardApi.delete({cardId: rawDataQuestion.id()})
+ await CardApi.delete({cardId: timeSeriesQuestion.id()})
+ await CardApi.delete({cardId: timeSeriesWithGoalQuestion.id()})
+ await CardApi.delete({cardId: progressBarQuestion.id()})
+ })
+
+ describe("missing email/slack credentials", () => {
+ it("should prompt you to add email/slack credentials", async () => {
+ await forBothAdminsAndNormalUsers(async () => {
+ MetabaseCookies.getHasSeenAlertSplash = () => false
+
+ const store = await createTestStore()
+ store.pushPath(Urls.question(rawDataQuestion.id()))
+ const app = mount(store.getAppContainer());
+
+ await store.waitForActions([INITIALIZE_QB, QUERY_COMPLETED, FETCH_ALERTS_FOR_QUESTION])
+
+ const actionsMenu = app.find(QueryHeader).find(EntityMenu)
+ click(actionsMenu.childAt(0))
+
+ const alertsMenuItem = actionsMenu.find(Icon).filterWhere(i => i.prop("name") === "alert")
+ click(alertsMenuItem)
+
+ await store.waitForActions([FETCH_PULSE_FORM_INPUT])
+ const alertModal = app.find(QueryHeader).find(".test-modal")
+ expect(alertModal.find(ChannelSetupModal).length).toBe(1)
+ })
+ })
+ })
+
+ describe("with only slack set", () => {
+ const normalFormInput = PulseApi.form_input
+ beforeAll(async () => {
+ const formInput = await PulseApi.form_input()
+ PulseApi.form_input = () => ({
+ channels: {
+ ...formInput.channels,
+ "slack": {
+ ...formInput.channels.slack,
+ "configured": true
+ }
+ }
+ })
+ })
+ afterAll(() => {
+ PulseApi.form_input = normalFormInput
+ })
+
+ it("should let admins create alerts", async () => {
+ useSharedAdminLogin()
+ const store = await createTestStore()
+ store.pushPath(Urls.question(rawDataQuestion.id()))
+ const app = mount(store.getAppContainer());
+
+ await store.waitForActions([INITIALIZE_QB, QUERY_COMPLETED, FETCH_ALERTS_FOR_QUESTION])
+
+ const actionsMenu = app.find(QueryHeader).find(EntityMenu)
+ click(actionsMenu.childAt(0))
+
+ const alertsMenuItem = actionsMenu.find(Icon).filterWhere(i => i.prop("name") === "alert")
+ click(alertsMenuItem)
+
+ await store.waitForActions([FETCH_PULSE_FORM_INPUT])
+ const alertModal = app.find(QueryHeader).find(".test-modal")
+ expect(alertModal.find(ChannelSetupModal).length).toBe(0)
+ expect(alertModal.find(AlertEducationalScreen).length).toBe(1)
+ })
+
+ it("should say to non-admins that admin must add email credentials", async () => {
+ useSharedNormalLogin()
+ const store = await createTestStore()
+ store.pushPath(Urls.question(rawDataQuestion.id()))
+ const app = mount(store.getAppContainer());
+
+ await store.waitForActions([INITIALIZE_QB, QUERY_COMPLETED, FETCH_ALERTS_FOR_QUESTION])
+
+ const actionsMenu = app.find(QueryHeader).find(EntityMenu)
+ click(actionsMenu.childAt(0))
+
+ const alertsMenuItem = actionsMenu.find(Icon).filterWhere(i => i.prop("name") === "alert")
+ click(alertsMenuItem)
+
+ await store.waitForActions([FETCH_PULSE_FORM_INPUT])
+ const alertModal = app.find(QueryHeader).find(".test-modal")
+ expect(alertModal.find(ChannelSetupModal).length).toBe(1)
+ expect(alertModal.find(ChannelSetupModal).prop("channels")).toEqual(["email"])
+ })
+ })
+
+ describe("alert creation", () => {
+ const normalFormInput = PulseApi.form_input
+ beforeAll(async () => {
+ // all channels configured
+ const formInput = await PulseApi.form_input()
+ PulseApi.form_input = () => ({
+ channels: {
+ ...formInput.channels,
+ "email": {
+ ...formInput.channels.email,
+ configured: true
+ },
+ "slack": {
+ ...formInput.channels.slack,
+ configured: true
+ }
+ }
+ })
+ })
+ afterAll(async () => {
+ PulseApi.form_input = normalFormInput
+ await removeAllCreatedAlerts()
+ })
+
+ it("should show you the first time educational screen", async () => {
+ await forBothAdminsAndNormalUsers(async () => {
+ useSharedNormalLogin()
+ const { app, store } = await initQbWithAlertMenuItemClicked(rawDataQuestion, { hasSeenAlertSplash: false })
+
+ await store.waitForActions([FETCH_PULSE_FORM_INPUT])
+ const alertModal = app.find(QueryHeader).find(".test-modal")
+ const educationalScreen = alertModal.find(AlertEducationalScreen)
+
+ clickButton(educationalScreen.find(Button))
+ const creationScreen = alertModal.find(CreateAlertModalContent)
+ expect(creationScreen.length).toBe(1)
+ })
+ });
+
+ it("should support 'rows present' alert for raw data questions", async () => {
+ useSharedNormalLogin()
+ const { app, store } = await initQbWithAlertMenuItemClicked(rawDataQuestion)
+
+ await store.waitForActions([FETCH_PULSE_FORM_INPUT])
+ const alertModal = app.find(QueryHeader).find(".test-modal")
+ const creationScreen = alertModal.find(CreateAlertModalContent)
+ expect(creationScreen.find(RawDataAlertTip).length).toBe(1)
+ expect(creationScreen.find(AlertSettingToggle).length).toBe(0)
+
+ clickButton(creationScreen.find(".Button.Button--primary"))
+ await store.waitForActions([CREATE_ALERT])
+ })
+
+ it("should support 'rows present' alert for timeseries questions without a goal", async () => {
+ useSharedNormalLogin()
+ const { app, store } = await initQbWithAlertMenuItemClicked(timeSeriesQuestion)
+
+ await store.waitForActions([FETCH_PULSE_FORM_INPUT])
+ const alertModal = app.find(QueryHeader).find(".test-modal")
+ const creationScreen = alertModal.find(CreateAlertModalContent)
+ expect(creationScreen.find(RawDataAlertTip).length).toBe(1)
+ expect(creationScreen.find(AlertSettingToggle).length).toBe(0)
+ })
+
+ it("should work for timeseries questions with a set goal", async () => {
+ useSharedNormalLogin()
+ const { app, store } = await initQbWithAlertMenuItemClicked(timeSeriesWithGoalQuestion)
+
+ await store.waitForActions([FETCH_PULSE_FORM_INPUT])
+ const alertModal = app.find(QueryHeader).find(".test-modal")
+ // why sometimes the educational screen is shown for a second ...?
+ expect(alertModal.find(AlertEducationalScreen).length).toBe(0)
+
+ const creationScreen = alertModal.find(CreateAlertModalContent)
+ expect(creationScreen.find(RawDataAlertTip).length).toBe(0)
+
+ const toggles = creationScreen.find(AlertSettingToggle)
+ expect(toggles.length).toBe(2)
+
+ const aboveGoalToggle = toggles.at(0)
+ expect(aboveGoalToggle.find(Radio).prop("value")).toBe(true)
+ click(aboveGoalToggle.find("li").last())
+ expect(aboveGoalToggle.find(Radio).prop("value")).toBe(false)
+
+ const firstOnlyToggle = toggles.at(1)
+ expect(firstOnlyToggle.find(Radio).prop("value")).toBe(true)
+
+ click(creationScreen.find(".Button.Button--primary"))
+ await store.waitForActions([CREATE_ALERT])
+
+ const alert = Object.values(getQuestionAlerts(store.getState()))[0]
+ expect(alert.alert_above_goal).toBe(false)
+ expect(alert.alert_first_only).toBe(true)
+ })
+ })
+
+ describe("alert list for a question", () => {
+ beforeAll(async () => {
+ // Both raw data and timeseries questions contain both an alert created by a normal user and by an admin.
+ // The difference is that the admin-created alert in raw data question contains also the normal user
+ // as a recipient.
+ useSharedAdminLogin()
+ const adminUser = await UserApi.current();
+ // TODO TODO TODO THIS ALERT HAZ A COMP-LETELY WRONG TYPE!
+ await AlertApi.create(getDefaultAlert(timeSeriesWithGoalQuestion, adminUser))
+
+ useSharedNormalLogin()
+ const normalUser = await UserApi.current();
+ await AlertApi.create(getDefaultAlert(timeSeriesWithGoalQuestion, normalUser))
+ await AlertApi.create(getDefaultAlert(rawDataQuestion, normalUser))
+
+ useSharedAdminLogin()
+ const defaultRawDataAlert = getDefaultAlert(rawDataQuestion, adminUser)
+ const alertWithTwoRecipients = setIn(
+ defaultRawDataAlert,
+ ["channels", 0, "recipients"],
+ [adminUser, normalUser]
+ )
+ await AlertApi.create(alertWithTwoRecipients)
+ })
+
+ afterAll(async () => {
+ await removeAllCreatedAlerts()
+ })
+
+ describe("as an admin", () => {
+ it("should let you see all created alerts", async () => {
+ useSharedAdminLogin()
+ const { app } = await initQbWithAlertMenuItemClicked(timeSeriesWithGoalQuestion)
+
+ const alertListPopover = app.find(AlertListPopoverContent)
+
+ const alertListItems = alertListPopover.find(AlertListItem)
+ expect(alertListItems.length).toBe(2)
+ expect(alertListItems.at(1).text()).toMatch(/Robert/)
+ })
+
+ it("should let you edit an alert", async () => {
+ // let's in this case try editing someone else's alert
+ useSharedAdminLogin()
+ const { app, store } = await initQbWithAlertMenuItemClicked(timeSeriesWithGoalQuestion)
+
+ const alertListPopover = app.find(AlertListPopoverContent)
+
+ const alertListItems = alertListPopover.find(AlertListItem)
+ expect(alertListItems.length).toBe(2)
+ expect(alertListItems.at(1).text()).toMatch(/Robert/)
+
+ const othersAlertListItem = alertListItems.at(1)
+
+ click(othersAlertListItem.find("a").filterWhere((item) => /Edit/.test(item.text())))
+
+ const editingScreen = app.find(UpdateAlertModalContent)
+ expect(editingScreen.length).toBe(1)
+
+ await store.waitForActions([FETCH_USERS, FETCH_PULSE_FORM_INPUT])
+
+ const toggles = editingScreen.find(AlertSettingToggle)
+ const aboveGoalToggle = toggles.at(0)
+ expect(aboveGoalToggle.find(Radio).prop("value")).toBe(true)
+ click(aboveGoalToggle.find("li").last())
+ expect(aboveGoalToggle.find(Radio).prop("value")).toBe(false)
+
+ click(editingScreen.find(".Button.Button--primary").last())
+ await store.waitForActions([UPDATE_ALERT])
+
+ const alerts = Object.values(getQuestionAlerts(store.getState()))
+ const othersAlert = alerts.find((alert) => alert.creator_id === 2)
+ expect(othersAlert.alert_above_goal).toBe(false)
+ })
+ })
+
+ describe("as a non-admin / normal user", () => {
+ it("should let you see your own alerts", async () => {
+ useSharedNormalLogin()
+ const { app } = await initQbWithAlertMenuItemClicked(timeSeriesWithGoalQuestion)
+
+ const alertListPopover = app.find(AlertListPopoverContent)
+
+ const alertListItems = alertListPopover.find(AlertListItem)
+ expect(alertListItems.length).toBe(1)
+ })
+
+ it("should let you see also other alerts where you are a recipient", async () => {
+ useSharedNormalLogin()
+ const { app } = await initQbWithAlertMenuItemClicked(rawDataQuestion)
+
+ const alertListPopover = app.find(AlertListPopoverContent)
+
+ const alertListItems = alertListPopover.find(AlertListItem)
+ expect(alertListItems.length).toBe(2)
+ expect(alertListItems.at(1).text()).toMatch(/Bobby/)
+ })
+
+ it("should let you unsubscribe from both your own and others' alerts", async () => {
+ useSharedNormalLogin()
+ const { app, store } = await initQbWithAlertMenuItemClicked(rawDataQuestion)
+
+ const alertListPopover = app.find(AlertListPopoverContent)
+
+ const alertListItems = alertListPopover.find(AlertListItem)
+ expect(alertListItems.length).toBe(2)
+ const ownAlertListItem = alertListItems.at(0)
+ // const otherAlertListItem = alertListItems.at(1)
+
+ // unsubscribe from the alert of some other user
+ click(ownAlertListItem.find("a").filterWhere((item) => /Unsubscribe/.test(item.text())))
+ await store.waitForActions([UNSUBSCRIBE_FROM_ALERT])
+
+ })
+ })
+ })
+})
\ No newline at end of file
diff --git a/frontend/test/containers/SaveQuestionModal.unit.spec.js b/frontend/test/containers/SaveQuestionModal.unit.spec.js
index 9ed2510b6e06a155ee7ee253961af25cb3b2e0dc..86f46ba51a682dcb88870fc3a830703ace08e336 100644
--- a/frontend/test/containers/SaveQuestionModal.unit.spec.js
+++ b/frontend/test/containers/SaveQuestionModal.unit.spec.js
@@ -11,7 +11,7 @@ import {
ORDERS_TOTAL_FIELD_ID
} from "__support__/sample_dataset_fixture";
-const createFnMock = jest.fn();
+const createFnMock = jest.fn(() => Promise.resolve());
let saveFnMock;
const getSaveQuestionModal = (question, originalQuestion) =>
@@ -28,7 +28,7 @@ describe('SaveQuestionModal', () => {
beforeEach(() => {
// we need to create a new save mock before each test to ensure that each
// test has its own instance
- saveFnMock = jest.fn();
+ saveFnMock = jest.fn(() => Promise.resolve());
})
it("should call createFn correctly for a new question", async () => {
diff --git a/resources/frontend_client/app/assets/img/alerts/alert-bell-confetti-illustration.png b/resources/frontend_client/app/assets/img/alerts/alert-bell-confetti-illustration.png
new file mode 100644
index 0000000000000000000000000000000000000000..4f5f60f8fe63b34deda90c60d5cc259fae8feb54
Binary files /dev/null and b/resources/frontend_client/app/assets/img/alerts/alert-bell-confetti-illustration.png differ
diff --git a/resources/frontend_client/app/assets/img/alerts/alert-bell-confetti-illustration@2x.png b/resources/frontend_client/app/assets/img/alerts/alert-bell-confetti-illustration@2x.png
new file mode 100644
index 0000000000000000000000000000000000000000..6746d0225eda05ab68d6f1b3256faa76c2d6b5d2
Binary files /dev/null and b/resources/frontend_client/app/assets/img/alerts/alert-bell-confetti-illustration@2x.png differ
diff --git a/resources/frontend_client/app/assets/img/alerts/education-illustration-01-raw-data.png b/resources/frontend_client/app/assets/img/alerts/education-illustration-01-raw-data.png
new file mode 100644
index 0000000000000000000000000000000000000000..e9735ef789cb3034184d97246df4d98a824965e1
Binary files /dev/null and b/resources/frontend_client/app/assets/img/alerts/education-illustration-01-raw-data.png differ
diff --git a/resources/frontend_client/app/assets/img/alerts/education-illustration-01-raw-data@2x.png b/resources/frontend_client/app/assets/img/alerts/education-illustration-01-raw-data@2x.png
new file mode 100644
index 0000000000000000000000000000000000000000..ca178fbc36b4f7c998bca3b3dc26c22bd8b077a7
Binary files /dev/null and b/resources/frontend_client/app/assets/img/alerts/education-illustration-01-raw-data@2x.png differ
diff --git a/resources/frontend_client/app/assets/img/alerts/education-illustration-02-goal.png b/resources/frontend_client/app/assets/img/alerts/education-illustration-02-goal.png
new file mode 100644
index 0000000000000000000000000000000000000000..f91e3ca22c0eb07a6531e02d7b27ab6c2b3d5997
Binary files /dev/null and b/resources/frontend_client/app/assets/img/alerts/education-illustration-02-goal.png differ
diff --git a/resources/frontend_client/app/assets/img/alerts/education-illustration-02-goal@2x.png b/resources/frontend_client/app/assets/img/alerts/education-illustration-02-goal@2x.png
new file mode 100644
index 0000000000000000000000000000000000000000..a85de70c7c634430e9d306879d769665991475f9
Binary files /dev/null and b/resources/frontend_client/app/assets/img/alerts/education-illustration-02-goal@2x.png differ
diff --git a/resources/frontend_client/app/assets/img/alerts/education-illustration-03-progress.png b/resources/frontend_client/app/assets/img/alerts/education-illustration-03-progress.png
new file mode 100644
index 0000000000000000000000000000000000000000..90f497bc2a56730817de7807cfcd57aacbf34079
Binary files /dev/null and b/resources/frontend_client/app/assets/img/alerts/education-illustration-03-progress.png differ
diff --git a/resources/frontend_client/app/assets/img/alerts/education-illustration-03-progress@2x.png b/resources/frontend_client/app/assets/img/alerts/education-illustration-03-progress@2x.png
new file mode 100644
index 0000000000000000000000000000000000000000..421b2d056b599f3be2a148623e3fd56b231d984d
Binary files /dev/null and b/resources/frontend_client/app/assets/img/alerts/education-illustration-03-progress@2x.png differ
diff --git a/resources/migrations/000_migrations.yaml b/resources/migrations/000_migrations.yaml
index 0335e6267f758f9c15910f9273e5b5c727fbadd6..3f703605eeede22832689855506c684a3e4a938b 100644
--- a/resources/migrations/000_migrations.yaml
+++ b/resources/migrations/000_migrations.yaml
@@ -3939,4 +3939,30 @@ databaseChangeLog:
type: text
- column:
name: ended_at
- type: DATETIME
\ No newline at end of file
+ type: DATETIME
+ - changeSet:
+ id: 69
+ author: senior
+ comment: 'Added 0.27.0'
+ remarks: 'Add columns to the pulse table for alerts'
+ changes:
+ - addColumn:
+ tableName: pulse
+ columns:
+ - column:
+ name: alert_condition
+ type: varchar(254)
+ remarks: 'Condition (i.e. "rows" or "goal") used as a guard for alerts'
+ - column:
+ name: alert_first_only
+ type: boolean
+ remarks: 'True if the alert should be disabled after the first notification'
+ - column:
+ name: alert_above_goal
+ type: boolean
+ remarks: 'For a goal condition, alert when above the goal'
+ # There is no name for an alert, so this column is only required for pulses
+ - dropNotNullConstraint:
+ tableName: pulse
+ columnName: name
+ columnDataType: varchar(254)
diff --git a/src/metabase/api/alert.clj b/src/metabase/api/alert.clj
new file mode 100644
index 0000000000000000000000000000000000000000..31c67719bbe8ab402d3b28626c285a6c81c485da
--- /dev/null
+++ b/src/metabase/api/alert.clj
@@ -0,0 +1,184 @@
+(ns metabase.api.alert
+ "/api/alert endpoints"
+ (:require [clojure.data :as data]
+ [compojure.core :refer [DELETE GET POST PUT]]
+ [medley.core :as m]
+ [metabase
+ [email :as email]
+ [util :as u]]
+ [metabase.api
+ [common :as api]
+ [pulse :as pulse-api]]
+ [metabase.email.messages :as messages]
+ [metabase.models
+ [interface :as mi]
+ [pulse :as pulse :refer [Pulse]]]
+ [metabase.util.schema :as su]
+ [schema.core :as s]
+ [toucan.db :as db]))
+
+(defn- add-read-only-flag [alerts]
+ (for [alert alerts
+ :let [can-read? (mi/can-read? alert)
+ can-write? (mi/can-write? alert)]
+ :when (or can-read?
+ can-write?)]
+ (assoc alert :read_only (not can-write?))))
+
+(api/defendpoint GET "/"
+ "Fetch all alerts"
+ []
+ (add-read-only-flag (pulse/retrieve-alerts)))
+
+(api/defendpoint GET "/question/:id"
+ "Fetch all questions for the given question (`Card`) id"
+ [id]
+ (add-read-only-flag (if api/*is-superuser?*
+ (pulse/retrieve-alerts-for-card id)
+ (pulse/retrieve-user-alerts-for-card id api/*current-user-id*))))
+
+(def ^:private AlertConditions
+ (s/enum "rows" "goal"))
+
+(defn- only-alert-keys [request]
+ (select-keys request [:alert_condition :alert_first_only :alert_above_goal]))
+
+(api/defendpoint POST "/"
+ "Create a new alert (`Pulse`)"
+ [:as {{:keys [alert_condition card channels alert_first_only alert_above_goal] :as req} :body}]
+ {alert_condition AlertConditions
+ alert_first_only s/Bool
+ alert_above_goal (s/maybe s/Bool)
+ card su/Map
+ channels (su/non-empty [su/Map])}
+ (pulse-api/check-card-read-permissions [card])
+ (let [new-alert (api/check-500
+ (-> req
+ only-alert-keys
+ (pulse/create-alert! api/*current-user-id* (u/get-id card) channels)))]
+ (when (email/email-configured?)
+ (messages/send-new-alert-email! new-alert))
+
+ new-alert))
+
+(defn- recipient-ids [{:keys [channels] :as alert}]
+ (reduce (fn [acc {:keys [channel_type recipients]}]
+ (if (= :email channel_type)
+ (into acc (map :id recipients))
+ acc))
+ #{} channels))
+
+(defn- check-alert-update-permissions
+ "Admin users can update all alerts. Non-admin users can update alerts that they created as long as they are still a
+ recipient of that alert"
+ [alert]
+ (when-not api/*is-superuser?*
+ (api/write-check alert)
+ (api/check-403 (and (= api/*current-user-id* (:creator_id alert))
+ (contains? (recipient-ids alert) api/*current-user-id*)))))
+
+(defn- email-channel [alert]
+ (m/find-first #(= :email (:channel_type %)) (:channels alert)))
+
+(defn- slack-channel [alert]
+ (m/find-first #(= :slack (:channel_type %)) (:channels alert)))
+
+(defn- key-by [key-fn coll]
+ (zipmap (map key-fn coll) coll))
+
+(defn- notify-recipient-changes!
+ "This function compares `OLD-ALERT` and `UPDATED-ALERT` to determine if there have been any recipient related
+ changes. Recipients that have been added or removed will be notified."
+ [old-alert updated-alert]
+ (let [{old-recipients :recipients} (email-channel old-alert)
+ {new-recipients :recipients} (email-channel updated-alert)
+ old-ids->users (key-by :id old-recipients)
+ new-ids->users (key-by :id new-recipients)
+ [removed-ids added-ids _] (data/diff (set (keys old-ids->users))
+ (set (keys new-ids->users)))]
+ (doseq [old-id removed-ids
+ :let [removed-user (get old-ids->users old-id)]]
+ (messages/send-admin-unsubscribed-alert-email! old-alert removed-user @api/*current-user*))
+
+ (doseq [new-id added-ids
+ :let [added-user (get new-ids->users new-id)]]
+ (messages/send-you-were-added-alert-email! updated-alert added-user @api/*current-user*))))
+
+(api/defendpoint PUT "/:id"
+ "Update a `Alert` with ID."
+ [id :as {{:keys [alert_condition card channels alert_first_only alert_above_goal card channels] :as req} :body}]
+ {alert_condition AlertConditions
+ alert_first_only s/Bool
+ alert_above_goal (s/maybe s/Bool)
+ card su/Map
+ channels (su/non-empty [su/Map])}
+ (let [old-alert (pulse/retrieve-alert id)
+ _ (check-alert-update-permissions old-alert)
+ updated-alert (-> req
+ only-alert-keys
+ (assoc :id id :card (u/get-id card) :channels channels)
+ pulse/update-alert!)]
+
+ ;; Only admins can update recipients
+ (when (and api/*is-superuser?* (email/email-configured?))
+ (notify-recipient-changes! old-alert updated-alert))
+
+ updated-alert))
+
+(defn- should-unsubscribe-delete?
+ "An alert should be deleted instead of unsubscribing if
+ - the unsubscriber is the creator
+ - they are the only recipient
+ - there is no slack channel"
+ [alert unsubscribing-user-id]
+ (let [{:keys [recipients]} (email-channel alert)]
+ (and (= unsubscribing-user-id (:creator_id alert))
+ (= 1 (count recipients))
+ (= unsubscribing-user-id (:id (first recipients)))
+ (nil? (slack-channel alert)))))
+
+(api/defendpoint PUT "/:id/unsubscribe"
+ "Unsubscribes a user from the given alert"
+ [id]
+ ;; Admins are not allowed to unsubscribe from alerts, they should edit the alert
+ (api/check (not api/*is-superuser?*)
+ [400 "Admin user are not allowed to unsubscribe from alerts"])
+ (let [alert (pulse/retrieve-alert id)]
+ (api/read-check alert)
+
+ (if (should-unsubscribe-delete? alert api/*current-user-id*)
+ ;; No need to unsubscribe if we're just going to delete the Pulse
+ (db/delete! Pulse :id id)
+ ;; There are other receipieints, remove current user only
+ (pulse/unsubscribe-from-alert id api/*current-user-id*))
+
+ (when (email/email-configured?)
+ (messages/send-you-unsubscribed-alert-email! alert @api/*current-user*))
+
+ api/generic-204-no-content))
+
+(defn- collect-alert-recipients [alert]
+ (set (:recipients (email-channel alert))))
+
+(api/defendpoint DELETE "/:id"
+ "Remove an alert"
+ [id]
+ (api/let-404 [alert (pulse/retrieve-alert id)]
+ (api/check-superuser)
+
+ ;; When an alert is deleted, we notify the creator that their alert is being deleted and any recipieint that they
+ ;; are no longer going to be receiving that alert
+ (let [creator (:creator alert)
+ ;; The creator might also be a recipient, no need to notify them twice
+ recipients (remove #(= (:id creator) (:id %)) (collect-alert-recipients alert))]
+
+ (db/delete! Pulse :id id)
+
+ (when (email/email-configured?)
+ (doseq [recipient recipients]
+ (messages/send-admin-unsubscribed-alert-email! alert recipient @api/*current-user*))
+ (messages/send-admin-deleted-your-alert! alert creator @api/*current-user*)))
+
+ api/generic-204-no-content))
+
+(api/define-routes)
diff --git a/src/metabase/api/card.clj b/src/metabase/api/card.clj
index 413d7f3c73901c7f2d6e7998f513fbbd4ab9b1bd..1b350273d70cca412cb35e1354cab47f3505f854 100644
--- a/src/metabase/api/card.clj
+++ b/src/metabase/api/card.clj
@@ -3,6 +3,7 @@
[clojure.data :as data]
[clojure.tools.logging :as log]
[compojure.core :refer [DELETE GET POST PUT]]
+ [medley.core :as m]
[metabase
[events :as events]
[middleware :as middleware]
@@ -14,6 +15,7 @@
[dataset :as dataset-api]
[label :as label-api]]
[metabase.api.common.internal :refer [route-fn-name]]
+ [metabase.email.messages :as messages]
[metabase.models
[card :as card :refer [Card]]
[card-favorite :refer [CardFavorite]]
@@ -23,6 +25,7 @@
[interface :as mi]
[label :refer [Label]]
[permissions :as perms]
+ [pulse :as pulse :refer [Pulse]]
[query :as query]
[table :refer [Table]]
[view-log :refer [ViewLog]]]
@@ -334,6 +337,86 @@
:else :card-update)]
(events/publish-event! event (assoc card :actor_id api/*current-user-id*))))
+(defn- card-archived? [old-card new-card]
+ (and (not (:archived old-card))
+ (:archived new-card)))
+
+(defn- line-area-bar? [display]
+ (contains? #{:line :area :bar} display))
+
+(defn- progress? [display]
+ (= :progress display))
+
+(defn- allows-rows-alert? [display]
+ (not (contains? #{:line :bar :area :progress} display)))
+
+(defn- display-change-broke-alert?
+ "Alerts no longer make sense when the kind of question being alerted on significantly changes. Setting up an alert
+ when a time series query reaches 10 is no longer valid if the question switches from a line graph to a table. This
+ function goes through various scenarios that render an alert no longer valid"
+ [{old-display :display} {new-display :display}]
+ (when-not (= old-display new-display)
+ (or
+ ;; Did the alert switch from a table type to a line/bar/area/progress graph type?
+ (and (allows-rows-alert? old-display)
+ (or (line-area-bar? new-display)
+ (progress? new-display)))
+ ;; Switching from a line/bar/area to another type that is not those three invalidates the alert
+ (and (line-area-bar? old-display)
+ (not (line-area-bar? new-display)))
+ ;; Switching from a progress graph to anything else invalidates the alert
+ (and (progress? old-display)
+ (not (progress? new-display))))))
+
+(defn- goal-missing?
+ "If we had a goal before, and now it's gone, the alert is no longer valid"
+ [old-card new-card]
+ (and
+ (get-in old-card [:visualization_settings :graph.goal_value])
+ (not (get-in new-card [:visualization_settings :graph.goal_value]))))
+
+(defn- multiple-breakouts?
+ "If there are multiple breakouts and a goal, we don't know which breakout to compare to the goal, so it invalidates
+ the alert"
+ [{:keys [display] :as new-card}]
+ (and (or (line-area-bar? display)
+ (progress? display))
+ (< 1 (count (get-in new-card [:dataset_query :query :breakout])))))
+
+(defn- delete-alert-and-notify!
+ "Removes all of the alerts and notifies all of the email recipients of the alerts change via `NOTIFY-FN!`"
+ [notify-fn! alerts]
+ (db/delete! Pulse :id [:in (map :id alerts)])
+ (doseq [{:keys [channels] :as alert} alerts
+ :let [email-channel (m/find-first #(= :email (:channel_type %)) channels)]]
+ (doseq [recipient (:recipients email-channel)]
+ (notify-fn! alert recipient @api/*current-user*))))
+
+(defn delete-alert-and-notify-archived!
+ "Removes all alerts and will email each recipient letting them know"
+ [alerts]
+ (delete-alert-and-notify! messages/send-alert-stopped-because-archived-email! alerts))
+
+(defn- delete-alert-and-notify-changed! [alerts]
+ (delete-alert-and-notify! messages/send-alert-stopped-because-changed-email! alerts))
+
+(defn- delete-alerts-if-needed! [old-card {card-id :id :as new-card}]
+ ;; If there are alerts, we need to check to ensure the card change doesn't invalidate the alert
+ (when-let [alerts (seq (pulse/retrieve-alerts-for-card card-id))]
+ (cond
+
+ (card-archived? old-card new-card)
+ (delete-alert-and-notify-archived! alerts)
+
+ (or (display-change-broke-alert? old-card new-card)
+ (goal-missing? old-card new-card)
+ (multiple-breakouts? new-card))
+ (delete-alert-and-notify-changed! alerts)
+
+ ;; The change doesn't invalidate the alert, do nothing
+ :else
+ nil)))
+
(api/defendpoint PUT "/:id"
"Update a `Card`."
[id :as {{:keys [dataset_query description display name visualization_settings archived collection_id enable_embedding embedding_params result_metadata metadata_checksum], :as body} :body}]
@@ -348,14 +431,14 @@
collection_id (s/maybe su/IntGreaterThanZero)
result_metadata (s/maybe results-metadata/ResultsMetadata)
metadata_checksum (s/maybe su/NonBlankString)}
- (let [card (api/write-check Card id)]
+ (let [card-before-update (api/write-check Card id)]
;; Do various permissions checks
- (check-allowed-to-change-collection card collection_id)
- (check-allowed-to-modify-query card dataset_query)
- (check-allowed-to-unarchive card archived)
- (check-allowed-to-change-embedding card enable_embedding embedding_params)
+ (check-allowed-to-change-collection card-before-update collection_id)
+ (check-allowed-to-modify-query card-before-update dataset_query)
+ (check-allowed-to-unarchive card-before-update archived)
+ (check-allowed-to-change-embedding card-before-update enable_embedding embedding_params)
;; make sure we have the correct `result_metadata`
- (let [body (assoc body :result_metadata (result-metadata-for-updating card dataset_query result_metadata metadata_checksum))]
+ (let [body (assoc body :result_metadata (result-metadata-for-updating card-before-update dataset_query result_metadata metadata_checksum))]
;; ok, now save the Card
(db/update! Card id
;; `collection_id` and `description` can be `nil` (in order to unset them). Other values should only be modified if they're passed in as non-nil
@@ -364,6 +447,9 @@
:non-nil #{:dataset_query :display :name :visualization_settings :archived :enable_embedding :embedding_params :result_metadata})))
;; Fetch the updated Card from the DB
(let [card (Card id)]
+
+ (delete-alerts-if-needed! card-before-update card)
+
(publish-card-update! card archived)
;; include same information returned by GET /api/card/:id since frontend replaces the Card it currently has with returned one -- See #4142
(hydrate card :creator :dashboard_count :labels :can_write :collection))))
diff --git a/src/metabase/api/collection.clj b/src/metabase/api/collection.clj
index a148fffd7c1912d81782d49a07ad84acfac6a55e..9eb4bbffc489c936ff97e8ba3e4602abab33ad29 100644
--- a/src/metabase/api/collection.clj
+++ b/src/metabase/api/collection.clj
@@ -1,11 +1,14 @@
(ns metabase.api.collection
"/api/collection endpoints."
(:require [compojure.core :refer [GET POST PUT]]
- [metabase.api.common :as api]
+ [metabase.api
+ [card :as card-api]
+ [common :as api]]
[metabase.models
[card :refer [Card]]
[collection :as collection :refer [Collection]]
- [interface :as mi]]
+ [interface :as mi]
+ [pulse :as pulse]]
[metabase.util.schema :as su]
[schema.core :as s]
[toucan
@@ -45,14 +48,22 @@
{name su/NonBlankString, color collection/hex-color-regex, description (s/maybe su/NonBlankString), archived (s/maybe s/Bool)}
;; you have to be a superuser to modify a Collection itself, but `/collection/:id/` perms are sufficient for adding/removing Cards
(api/check-superuser)
- (api/check-exists? Collection id)
- (db/update! Collection id
- :name name
- :color color
- :description description
- :archived (if (nil? archived)
- false
- archived))
+ (api/api-let [404 "Not Found"] [collection-before-update (Collection id)]
+ (db/update! Collection id
+ :name name
+ :color color
+ :description description
+ :archived (if (nil? archived)
+ false
+ archived))
+ (when (and (not (:archived collection-before-update))
+ archived)
+ (when-let [alerts (seq (apply pulse/retrieve-alerts-for-card (db/select-ids Card, :collection_id id)))]
+ ;; When a collection is archived, all of it's cards are also marked as archived, but this is down in the model
+ ;; layer which will not cause the archive notification code to fire. This will delete the relevant alerts and
+ ;; notify the users just as if they had be archived individually via the card API
+ (card-api/delete-alert-and-notify-archived! alerts))))
+
;; return the updated object
(Collection id))
diff --git a/src/metabase/api/pulse.clj b/src/metabase/api/pulse.clj
index c5884e213e5e9624a212f471892b5c1a5d1ddd23..e7479c95bfbbdb5446cffe635e9b4e7a85859613 100644
--- a/src/metabase/api/pulse.clj
+++ b/src/metabase/api/pulse.clj
@@ -33,9 +33,11 @@
can-write?)]
(assoc pulse :read_only (not can-write?))))
-
-(defn- check-card-read-permissions [cards]
- (doseq [{card-id :id} cards]
+(defn check-card-read-permissions
+ "Users can only create a pulse for `CARDS` they have access to"
+ [cards]
+ (doseq [card cards
+ :let [card-id (u/get-id card)]]
(assert (integer? card-id))
(api/read-check Card card-id)))
diff --git a/src/metabase/api/routes.clj b/src/metabase/api/routes.clj
index 03c46e43b93acea4f7f1171b1f35d9368657aeed..c31b77af151e906e01224ea0e43e88e25be427a6 100644
--- a/src/metabase/api/routes.clj
+++ b/src/metabase/api/routes.clj
@@ -4,6 +4,7 @@
[route :as route]]
[metabase.api
[activity :as activity]
+ [alert :as alert]
[async :as async]
[card :as card]
[collection :as collection]
@@ -55,6 +56,7 @@
(defroutes ^{:doc "Ring routes for API endpoints."} routes
(context "/activity" [] (+auth activity/routes))
+ (context "/alert" [] (+auth alert/routes))
(context "/async" [] (+auth async/routes))
(context "/card" [] (+auth card/routes))
(context "/collection" [] (+auth collection/routes))
diff --git a/src/metabase/email/alert.mustache b/src/metabase/email/alert.mustache
new file mode 100644
index 0000000000000000000000000000000000000000..7b63947376755bd2fb3eeeadf4e007ac391d66ae
--- /dev/null
+++ b/src/metabase/email/alert.mustache
@@ -0,0 +1,7 @@
+{{> metabase/email/_header}}
+ <p><a href="{{questionURL}}">{{questionName}}</a> has {{alertCondition}}.</p>
+ {{#firstRunOnly?}}
+ <p>We’ll stop sending you alerts about this question now.</p>
+ {{/firstRunOnly?}}
+ {{{pulse}}}
+{{> metabase/email/_footer}}
diff --git a/src/metabase/email/alert_admin_unsubscribed_you.mustache b/src/metabase/email/alert_admin_unsubscribed_you.mustache
new file mode 100644
index 0000000000000000000000000000000000000000..65cd4962a13a17f40c23ab22183cec4655f9527b
--- /dev/null
+++ b/src/metabase/email/alert_admin_unsubscribed_you.mustache
@@ -0,0 +1,5 @@
+{{> metabase/email/_header }}
+ <div style="padding: 2em 4em; border: 1px solid #dddddd; border-radius: 2px; background-color: white; box-shadow: 0 1px 2px rgba(0, 0, 0, .08);">
+ <p>Just letting you know that {{adminName}} unsubscribed you from alerts about <a href="{{questionURL}}">{{questionName}}</a>.</p>
+ </div>
+{{> metabase/email/_footer}}
diff --git a/src/metabase/email/alert_new_confirmation.mustache b/src/metabase/email/alert_new_confirmation.mustache
new file mode 100644
index 0000000000000000000000000000000000000000..6150cdbaa739ec2d7e2847497af8663681c36ab3
--- /dev/null
+++ b/src/metabase/email/alert_new_confirmation.mustache
@@ -0,0 +1,6 @@
+{{> metabase/email/_header }}
+ <div style="padding: 2em 4em; border: 1px solid #dddddd; border-radius: 2px; background-color: white; box-shadow: 0 1px 2px rgba(0, 0, 0, .08);">
+ <p>This is just a confirmation that your alert about <a href="{{questionURL}}">{{questionName}}</a> has been set up.</p>
+ <p>This alert will be sent {{alertCondition}}.</p>
+ </div>
+{{> metabase/email/_footer}}
diff --git a/src/metabase/email/alert_stopped_working.mustache b/src/metabase/email/alert_stopped_working.mustache
new file mode 100644
index 0000000000000000000000000000000000000000..40a2ca7f47d24e58b37ee954b4c46e6069b67324
--- /dev/null
+++ b/src/metabase/email/alert_stopped_working.mustache
@@ -0,0 +1,5 @@
+{{> metabase/email/_header }}
+ <div style="padding: 2em 4em; border: 1px solid #dddddd; border-radius: 2px; background-color: white; box-shadow: 0 1px 2px rgba(0, 0, 0, .08);">
+ <p>Alerts about {{questionName}} have stopped because {{deletionCause}}.
+ </div>
+{{> metabase/email/_footer}}
diff --git a/src/metabase/email/alert_unsubscribed.mustache b/src/metabase/email/alert_unsubscribed.mustache
new file mode 100644
index 0000000000000000000000000000000000000000..a1878974d7d788900dd200c8e72210cb025969a1
--- /dev/null
+++ b/src/metabase/email/alert_unsubscribed.mustache
@@ -0,0 +1,5 @@
+{{> metabase/email/_header }}
+ <div style="padding: 2em 4em; border: 1px solid #dddddd; border-radius: 2px; background-color: white; box-shadow: 0 1px 2px rgba(0, 0, 0, .08);">
+ <p>You’re no longer receiving alerts about <a href="{{questionURL}}">{{questionName}}</a>.</p>
+ </div>
+{{> metabase/email/_footer}}
diff --git a/src/metabase/email/alert_was_deleted.mustache b/src/metabase/email/alert_was_deleted.mustache
new file mode 100644
index 0000000000000000000000000000000000000000..7366e6f60c436c03bda96ed2bd87bf35d3fb8268
--- /dev/null
+++ b/src/metabase/email/alert_was_deleted.mustache
@@ -0,0 +1,6 @@
+{{> metabase/email/_header }}
+ <div style="padding: 2em 4em; border: 1px solid #dddddd; border-radius: 2px; background-color: white; box-shadow: 0 1px 2px rgba(0, 0, 0, .08);">
+ <p>{{adminName}} deleted an alert you created about <a href="{{questionURL}}">{{questionName}}.</p>
+ <p>Since we're in the business of alerts, we thought we'd alert you.</p>
+ </div>
+{{> metabase/email/_footer}}
diff --git a/src/metabase/email/alert_you_were_added.mustache b/src/metabase/email/alert_you_were_added.mustache
new file mode 100644
index 0000000000000000000000000000000000000000..fe64cd54668e2e1c2df45691fd5b1f71ebcd3558
--- /dev/null
+++ b/src/metabase/email/alert_you_were_added.mustache
@@ -0,0 +1,7 @@
+{{> metabase/email/_header }}
+ <div style="padding: 2em 4em; border: 1px solid #dddddd; border-radius: 2px; background-color: white; box-shadow: 0 1px 2px rgba(0, 0, 0, .08);">
+ <p>You’re now getting alerts about <a href="{{questionURL}}">{{questionName}}</a>.</p>
+ <p>We’ll send you an email {{alertCondition}}</p>
+ <p>If you don’t want to receive these alerts, you can <a href="{{questionURL}}">go to this question</a> and unsubscribe from the menu in the top-right.</p>
+ </div>
+{{> metabase/email/_footer}}
diff --git a/src/metabase/email/messages.clj b/src/metabase/email/messages.clj
index 2acba778b203f10ed27cb6f7af6c5a06eb46b8b2..b7f8a30f76bc3b618c356652c1ef7c4cfa319e5c 100644
--- a/src/metabase/email/messages.clj
+++ b/src/metabase/email/messages.clj
@@ -226,3 +226,121 @@
(vec (cons :div (for [result results]
(render/render-pulse-section timezone result)))))]
(render-message-body "metabase/email/pulse" (pulse-context body pulse) (seq @images))))
+
+(defn pulse->alert-condition-kwd
+ "Given an `ALERT` return a keyword representing what kind of goal needs to be met."
+ [{:keys [alert_above_goal alert_condition card creator] :as alert}]
+ (if (= "goal" alert_condition)
+ (if (true? alert_above_goal)
+ :meets
+ :below)
+ :rows))
+
+(defn- first-card
+ "Alerts only have a single card, so the alerts API accepts a `:card` key, while pulses have `:cards`. Depending on
+ whether the data comes from the alert API or pulse tasks, the card could be under `:card` or `:cards`"
+ [alert]
+ (or (:card alert)
+ (first (:cards alert))))
+
+(defn- default-alert-context
+ ([alert]
+ (default-alert-context alert nil))
+ ([alert alert-condition-map]
+ (let [{card-id :id, card-name :name} (first-card alert)]
+ (merge {:questionURL (url/card-url card-id)
+ :questionName card-name
+ :emailType "alert"
+ :sectionStyle render/section-style
+ :colorGrey4 render/color-gray-4
+ :logoFooter true}
+ (random-quote-context)
+ (when alert-condition-map
+ {:alertCondition (get alert-condition-map (pulse->alert-condition-kwd alert))})))))
+
+(defn- alert-results-condition-text [goal-value]
+ {:meets (format "reached its goal of %s" goal-value)
+ :below (format "gone below its goal of %s" goal-value)
+ :rows "results for you to see"})
+
+(defn render-alert-email
+ "Take a pulse object and list of results, returns an array of attachment objects for an email"
+ [timezone {:keys [alert_first_only] :as alert} results goal-value]
+ (let [images (atom {})
+ body (binding [render/*include-title* true
+ render/*render-img-fn* (partial render-image images)]
+ (html (vec (cons :div (for [result results]
+ (render/render-pulse-section timezone result))))))
+ message-ctx (default-alert-context alert (alert-results-condition-text goal-value))]
+ (render-message-body "metabase/email/alert"
+ (assoc message-ctx :pulse body :firstRunOnly? alert_first_only)
+ (seq @images))))
+
+(def ^:private alert-condition-text
+ {:meets "when this question meets its goal"
+ :below "when this question goes below its goal"
+ :rows "whenever this question has any results"})
+
+(defn- send-email! [user subject template-path template-context]
+ (email/send-message!
+ :recipients [(:email user)]
+ :message-type :html
+ :subject subject
+ :message (stencil/render-file template-path template-context)))
+
+(defn- template-path [template-name]
+ (str "metabase/email/" template-name ".mustache"))
+
+;; Paths to the templates for all of the alerts emails
+(def ^:private new-alert-template (template-path "alert_new_confirmation"))
+(def ^:private you-unsubscribed-template (template-path "alert_unsubscribed"))
+(def ^:private admin-unsubscribed-template (template-path "alert_admin_unsubscribed_you"))
+(def ^:private added-template (template-path "alert_you_were_added"))
+(def ^:private stopped-template (template-path "alert_stopped_working"))
+(def ^:private deleted-template (template-path "alert_was_deleted"))
+
+(defn send-new-alert-email!
+ "Send out the initial 'new alert' email to the `CREATOR` of the alert"
+ [{:keys [creator] :as alert}]
+ (send-email! creator "You setup an alert" new-alert-template
+ (default-alert-context alert alert-condition-text)))
+
+(defn send-you-unsubscribed-alert-email!
+ "Send an email to `WHO-UNSUBSCRIBED` letting them know they've unsubscribed themselves from `ALERT`"
+ [alert who-unsubscribed]
+ (send-email! who-unsubscribed "You unsubscribed from an alert" you-unsubscribed-template
+ (default-alert-context alert)))
+
+(defn send-admin-unsubscribed-alert-email!
+ "Send an email to `USER-ADDED` letting them know `ADMIN` has unsubscribed them from `ALERT`"
+ [alert user-added {:keys [first_name last_name] :as admin}]
+ (let [admin-name (format "%s %s" first_name last_name)]
+ (send-email! user-added "You’ve been unsubscribed from an alert" admin-unsubscribed-template
+ (assoc (default-alert-context alert) :adminName admin-name))))
+
+(defn send-you-were-added-alert-email!
+ "Send an email to `USER-ADDED` letting them know `ADMIN-ADDER` has added them to `ALERT`"
+ [alert user-added {:keys [first_name last_name] :as admin-adder}]
+ (let [subject (format "%s %s added you to an alert" first_name last_name)]
+ (send-email! user-added subject added-template (default-alert-context alert alert-condition-text))))
+
+(def ^:private not-working-subject "One of your alerts has stopped working")
+
+(defn send-alert-stopped-because-archived-email!
+ "Email to notify users when a card associated to their alert has been archived"
+ [alert user {:keys [first_name last_name] :as archiver}]
+ (let [deletion-text (format "the question was archived by %s %s" first_name last_name)]
+ (send-email! user not-working-subject stopped-template (assoc (default-alert-context alert) :deletionCause deletion-text))))
+
+(defn send-alert-stopped-because-changed-email!
+ "Email to notify users when a card associated to their alert changed in a way that invalidates their alert"
+ [alert user {:keys [first_name last_name] :as archiver}]
+ (let [edited-text (format "the question was edited by %s %s" first_name last_name)]
+ (send-email! user not-working-subject stopped-template (assoc (default-alert-context alert) :deletionCause edited-text))))
+
+(defn send-admin-deleted-your-alert!
+ "Email to notify users when an admin has deleted their alert"
+ [alert user {:keys [first_name last_name] :as deletor}]
+ (let [subject (format "%s %s deleted an alert you created" first_name last_name)
+ admin-name (format "%s %s" first_name last_name)]
+ (send-email! user subject deleted-template (assoc (default-alert-context alert) :adminName admin-name))))
diff --git a/src/metabase/email/password_reset.mustache b/src/metabase/email/password_reset.mustache
index 80f349b80ba627b92f67f9afc3a8cb5a2f304a5b..d948cfecbeeb3ec0ffbe233296f16eedd01b0622 100644
--- a/src/metabase/email/password_reset.mustache
+++ b/src/metabase/email/password_reset.mustache
@@ -12,4 +12,4 @@
</div>
{{/sso}}
</div>
-{{> metabase/email/footer }}
+{{> metabase/email/_footer }}
diff --git a/src/metabase/models/pulse.clj b/src/metabase/models/pulse.clj
index d4584e058c866c2d18aaf6359ecc8771b36159d1..d376e8cffbcaab8b13bfb045acd066a6ca4c4dec 100644
--- a/src/metabase/models/pulse.clj
+++ b/src/metabase/models/pulse.clj
@@ -1,5 +1,6 @@
(ns metabase.models.pulse
(:require [clojure.set :as set]
+ [clojure.tools.logging :as log]
[medley.core :as m]
[metabase
[db :as mdb]
@@ -10,7 +11,8 @@
[card :refer [Card]]
[interface :as i]
[pulse-card :refer [PulseCard]]
- [pulse-channel :as pulse-channel :refer [PulseChannel]]]
+ [pulse-channel :as pulse-channel :refer [PulseChannel]]
+ [pulse-channel-recipient :refer [PulseChannelRecipient]]]
[toucan
[db :as db]
[hydrate :refer [hydrate]]
@@ -85,22 +87,97 @@
;;; ------------------------------------------------------------ Pulse Fetching Helper Fns ------------------------------------------------------------
+(defn- hydrate-pulse [pulse]
+ (-> pulse
+ (hydrate :creator :cards [:channels :recipients])
+ (m/dissoc-in [:details :emails])))
+
+(defn- remove-alert-fields [pulse]
+ (dissoc pulse :alert_condition :alert_above_goal :alert_first_only))
+
(defn retrieve-pulse
"Fetch a single `Pulse` by its ID value."
[id]
{:pre [(integer? id)]}
- (-> (Pulse id)
- (hydrate :creator :cards [:channels :recipients])
- (m/dissoc-in [:details :emails])))
+ (-> (db/select-one Pulse {:where [:and
+ [:= :id id]
+ [:= :alert_condition nil]]})
+ hydrate-pulse
+ remove-alert-fields))
+
+(defn retrieve-pulse-or-alert
+ "Fetch an alert or pulse by its ID value."
+ [id]
+ {:pre [(integer? id)]}
+ (-> (db/select-one Pulse {:where [:= :id id]})
+ hydrate-pulse))
+(defn- pulse->alert
+ "Convert a pulse to an alert"
+ [pulse]
+ (-> pulse
+ (assoc :card (first (:cards pulse)))
+ (dissoc :cards)))
+
+(defn retrieve-alert
+ "Fetch a single alert by its pulse `ID` value."
+ [id]
+ {:pre [(integer? id)]}
+ (-> (db/select-one Pulse {:where [:and
+ [:= :id id]
+ [:not= :alert_condition nil]]})
+ hydrate-pulse
+ pulse->alert))
+
+(defn retrieve-alerts
+ "Fetch all alerts"
+ []
+ (for [pulse (db/select Pulse, {:where [:not= :alert_condition nil]
+ :order-by [[:name :asc]]})]
+
+ (-> pulse
+ hydrate-pulse
+ pulse->alert)))
(defn retrieve-pulses
"Fetch all `Pulses`."
[]
- (for [pulse (-> (db/select Pulse, {:order-by [[:name :asc]]})
- (hydrate :creator :cards [:channels :recipients]))]
- (m/dissoc-in pulse [:details :emails])))
-
+ (for [pulse (db/select Pulse, {:where [:= :alert_condition nil]
+ :order-by [[:name :asc]]} )]
+ (-> pulse
+ hydrate-pulse
+ remove-alert-fields)))
+
+(defn- query-as [model query]
+ (db/do-post-select model (db/query query)))
+
+(defn retrieve-user-alerts-for-card
+ "Find all alerts for `CARD-ID` that `USER-ID` is set to receive"
+ [card-id user-id]
+ (map (comp pulse->alert hydrate-pulse)
+ (query-as Pulse
+ {:select [:p.*]
+ :from [[Pulse :p]]
+ :join [[PulseCard :pc] [:= :p.id :pc.pulse_id]
+ [PulseChannel :pchan] [:= :pchan.pulse_id :p.id]
+ [PulseChannelRecipient :pcr] [:= :pchan.id :pcr.pulse_channel_id]]
+ :where [:and
+ [:not= :p.alert_condition nil]
+ [:= :pc.card_id card-id]
+ [:= :pcr.user_id user-id]]})))
+
+(defn retrieve-alerts-for-card
+ "Find all alerts for `CARD-IDS`, used for admin users"
+ [& card-ids]
+ (when (seq card-ids)
+ (map (comp pulse->alert hydrate-pulse)
+ (query-as Pulse
+ {:select [:p.*]
+ :from [[Pulse :p]]
+ :join [[PulseCard :pc] [:= :p.id :pc.pulse_id]]
+ :where [:and
+ [:not= :p.alert_condition nil]
+ [:in :pc.card_id card-ids]]}))))
;;; ------------------------------------------------------------ Other Persistence Functions ------------------------------------------------------------
@@ -166,6 +243,16 @@
(doseq [[channel-type] pulse-channel/channel-types]
(handle-channel channel-type))))
+(defn- create-notification [pulse card-ids channels retrieve-pulse-fn]
+ (db/transaction
+ (let [{:keys [id] :as pulse} (db/insert! Pulse pulse)]
+ ;; add card-ids to the Pulse
+ (update-pulse-cards! pulse card-ids)
+ ;; add channels to the Pulse
+ (update-pulse-channels! pulse channels)
+ ;; return the full Pulse (and record our create event)
+ (events/publish-event! :pulse-create (retrieve-pulse-fn id)))))
+
(defn create-pulse!
"Create a new `Pulse` by inserting it into the database along with all associated pieces of data such as:
@@ -180,18 +267,31 @@
(every? integer? card-ids)
(coll? channels)
(every? map? channels)]}
+ (create-notification {:creator_id creator-id
+ :name pulse-name
+ :skip_if_empty skip-if-empty?}
+ card-ids channels retrieve-pulse))
+
+(defn create-alert!
+ "Creates a pulse with the correct fields specified for an alert"
+ [alert creator-id card-id channels]
+ (-> alert
+ (assoc :skip_if_empty true :creator_id creator-id)
+ (create-notification [card-id] channels retrieve-alert)))
+
+(defn update-notification!
+ "Updates the pulse/alert and updates the related channels"
+ [{:keys [id name cards channels skip-if-empty?] :as pulse}]
(db/transaction
- (let [{:keys [id] :as pulse} (db/insert! Pulse
- :creator_id creator-id
- :name pulse-name
- :skip_if_empty skip-if-empty?)]
- ;; add card-ids to the Pulse
- (update-pulse-cards! pulse card-ids)
- ;; add channels to the Pulse
- (update-pulse-channels! pulse channels)
- ;; return the full Pulse (and record our create event)
- (events/publish-event! :pulse-create (retrieve-pulse id)))))
-
+ ;; update the pulse itself
+ (db/update-non-nil-keys! Pulse id (-> pulse
+ (select-keys [:name :alert_condition :alert_above_goal :alert_first_only])
+ (assoc :skip_if_empty skip-if-empty?)))
+ ;; update cards (only if they changed). Order for the cards is important which is why we're not using select-field
+ (when (not= cards (map :card_id (db/select [PulseCard :card_id], :pulse_id id, {:order-by [[:position :asc]]})))
+ (update-pulse-cards! pulse cards))
+ ;; update channels
+ (update-pulse-channels! pulse channels)))
(defn update-pulse!
"Update an existing `Pulse`, including all associated data such as: `PulseCards`, `PulseChannels`, and `PulseChannelRecipients`.
@@ -205,14 +305,40 @@
(every? integer? cards)
(coll? channels)
(every? map? channels)]}
- (db/transaction
- ;; update the pulse itself
- (db/update! Pulse id, :name name, :skip_if_empty skip-if-empty?)
- ;; update cards (only if they changed). Order for the cards is important which is why we're not using select-field
- (when (not= cards (map :card_id (db/select [PulseCard :card_id], :pulse_id id, {:order-by [[:position :asc]]})))
- (update-pulse-cards! pulse cards))
- ;; update channels
- (update-pulse-channels! pulse channels)
- ;; fetch the fully updated pulse and return it (and fire off an event)
- (->> (retrieve-pulse id)
- (events/publish-event! :pulse-update))))
+ (update-notification! pulse)
+ ;; fetch the fully updated pulse and return it (and fire off an event)
+ (->> (retrieve-pulse id)
+ (events/publish-event! :pulse-update)))
+
+(defn update-alert!
+ "Updates the given `ALERT` and returns it"
+ [{:keys [id card] :as alert}]
+ (-> alert
+ (assoc :skip-if-empty? true :cards [card])
+ (dissoc :card)
+ update-notification!)
+ ;; fetch the fully updated pulse and return it (and fire off an event)
+ (->> (retrieve-alert id)
+ (events/publish-event! :pulse-update)))
+
+(defn unsubscribe-from-alert
+ "Removes `USER-ID` from `PULSE-ID`"
+ [pulse-id user-id]
+ (let [[result] (db/execute! {:delete-from PulseChannelRecipient
+ ;; The below select * clause is required for the query to work on MySQL (PG and H2 work
+ ;; without it). MySQL will fail if the delete has an implicit join. By wrapping the
+ ;; query in a select *, it forces that query to use a temp table rather than trying to
+ ;; make the join directly, which works in MySQL, PG and H2
+ :where [:= :id {:select [:*]
+ :from [[{:select [:pcr.id]
+ :from [[PulseChannelRecipient :pcr]]
+ :join [[PulseChannel :pchan] [:= :pchan.id :pcr.pulse_channel_id]
+ [Pulse :p] [:= :p.id :pchan.pulse_id]]
+ :where [:and
+ [:= :p.id pulse-id]
+ [:not= :p.alert_condition nil]
+ [:= :pcr.user_id user-id]]} "r"]]}]})]
+ (when (zero? result)
+ (log/warnf "Failed to remove user-id '%s' from pulse-id '%s'" user-id pulse-id))
+
+ result))
diff --git a/src/metabase/pulse.clj b/src/metabase/pulse.clj
index 48d4bae1980221e332c8201846087bae49858cf7..01cf90cc321009c38232af78de90cc3604a6f952 100644
--- a/src/metabase/pulse.clj
+++ b/src/metabase/pulse.clj
@@ -8,10 +8,17 @@
[util :as u]]
[metabase.email.messages :as messages]
[metabase.integrations.slack :as slack]
- [metabase.models.card :refer [Card]]
+ [metabase.models
+ [card :refer [Card]]
+ [pulse :refer [Pulse]]]
[metabase.pulse.render :as render]
+ [metabase.util
+ [ui-logic :as ui]
+ [urls :as urls]]
[metabase.util.urls :as urls]
- [schema.core :as s])
+ [puppetlabs.i18n.core :refer [tru]]
+ [schema.core :as s]
+ [toucan.db :as db])
(:import java.util.TimeZone))
;;; ## ---------------------------------------- PULSE SENDING ----------------------------------------
@@ -44,24 +51,13 @@
(System/getProperty "user.timezone"))]
(TimeZone/getTimeZone timezone-str)))
-(defn- create-email-notification [{:keys [id name] :as pulse} results recipients]
- (log/debug (format "Sending Pulse (%d: %s) via Channel :email" id name))
- (let [email-subject (str "Pulse: " name)
- email-recipients (filterv u/is-email? (map :email recipients))
- timezone (-> results first :card defaulted-timezone)]
- {:subject email-subject
- :recipients email-recipients
- :message-type :attachments
- :message (messages/render-pulse-email timezone pulse results)}))
+(defn- first-question-name [pulse]
+ (-> pulse :cards first :name))
-(defn- send-email-pulse!
- "Send a `Pulse` email given a list of card results to render and a list of recipients to send to."
- [{:keys [subject recipients message-type message]}]
- (email/send-message!
- :subject subject
- :recipients recipients
- :message-type message-type
- :message message))
+(def ^:private alert-notification-condition-text
+ {:meets "reached its goal"
+ :below "gone below its goal"
+ :rows "results"})
(defn create-slack-attachment-data
"Returns a seq of slack attachment data structures, used in `create-and-upload-slack-attachments!`"
@@ -75,12 +71,6 @@
:channel-id channel-id
:fallback card-name})))
-(defn- create-slack-notification [pulse results channel-id]
- (log/debug (u/format-color 'cyan "Sending Pulse (%d: %s) via Slack" (:id pulse) (:name pulse)))
- {:channel-id channel-id
- :message (str "Pulse: " (:name pulse))
- :attachments (create-slack-attachment-data results)})
-
(defn create-and-upload-slack-attachments!
"Create an attachment in Slack for a given Card by rendering its result into an image and uploading it."
[attachments]
@@ -91,13 +81,6 @@
(select-keys [:title :title_link :fallback])
(assoc :image_url slack-file-url))))))
-(defn- send-slack-pulse!
- "Post a `Pulse` to a slack channel given a list of card results to render and details about the slack destination."
- [{:keys [channel-id message attachments]}]
- {:pre [(string? channel-id)]}
- (let [attachments (create-and-upload-slack-attachments! attachments)]
- (slack/post-chat-message! channel-id message attachments)))
-
(defn- is-card-empty?
"Check if the card is empty"
[card]
@@ -112,25 +95,131 @@
[results]
(every? is-card-empty? results))
+(defn- goal-met? [{:keys [alert_above_goal] :as pulse} results]
+ (let [first-result (first results)
+ goal-comparison (if alert_above_goal <= >=)
+ comparison-col-index (ui/goal-comparison-column first-result)
+ goal-val (ui/find-goal-value first-result)]
+
+ (when-not (and goal-val comparison-col-index)
+ (throw (Exception. (str (tru "Unable to compare results to goal for alert.")
+ (tru "Question ID is '{0}' with visualization settings '{1}'"
+ (get-in results [:card :id])
+ (pr-str (get-in results [:card :visualization_settings])))))))
+
+ (some (fn [row]
+ (goal-comparison goal-val (nth row comparison-col-index)))
+ (get-in first-result [:result :data :rows]))))
+
+(defn- alert-or-pulse [pulse]
+ (if (:alert_condition pulse)
+ :alert
+ :pulse))
+
+(defmulti ^:private should-send-notification?
+ "Returns true if given the pulse type and resultset a new notification (pulse or alert) should be sent"
+ (fn [pulse results] (alert-or-pulse pulse)))
+
+(defmethod should-send-notification? :alert
+ [{:keys [alert_condition] :as alert} results]
+ (cond
+ (= "rows" alert_condition)
+ (not (are-all-cards-empty? results))
+
+ (= "goal" alert_condition)
+ (goal-met? alert results)
+
+ :else
+ (let [^String error-text (tru "Unrecognized alert with condition '{0}'" alert_condition)]
+ (throw (IllegalArgumentException. error-text)))))
+
+(defmethod should-send-notification? :pulse
+ [{:keys [alert_condition] :as pulse} results]
+ (if (:skip_if_empty pulse)
+ (not (are-all-cards-empty? results))
+ true))
+
+(defmulti ^:private create-notification
+ "Polymorphoic function for creating notifications. This logic is different for pulse type (i.e. alert vs. pulse) and
+ channel_type (i.e. email vs. slack)"
+ (fn [pulse _ {:keys [channel_type] :as channel}]
+ [(alert-or-pulse pulse) channel_type]))
+
+(defmethod create-notification [:pulse :email]
+ [{:keys [id name] :as pulse} results {:keys [recipients] :as channel}]
+ (log/debug (format "Sending Pulse (%d: %s) via Channel :email" id name))
+ (let [email-subject (str "Pulse: " name)
+ email-recipients (filterv u/is-email? (map :email recipients))
+ timezone (-> results first :card defaulted-timezone)]
+ {:subject email-subject
+ :recipients email-recipients
+ :message-type :attachments
+ :message (messages/render-pulse-email timezone pulse results)}))
+
+(defmethod create-notification [:pulse :slack]
+ [pulse results {{channel-id :channel} :details :as channel}]
+ (log/debug (u/format-color 'cyan "Sending Pulse (%d: %s) via Slack" (:id pulse) (:name pulse)))
+ {:channel-id channel-id
+ :message (str "Pulse: " (:name pulse))
+ :attachments (create-slack-attachment-data results)})
+
+(defmethod create-notification [:alert :email]
+ [{:keys [id] :as pulse} results {:keys [recipients] :as channel}]
+ (log/debug (format "Sending Pulse (%d: %s) via Channel :email" id name))
+ (let [condition-kwd (messages/pulse->alert-condition-kwd pulse)
+ email-subject (format "Metabase alert: %s has %s"
+ (first-question-name pulse)
+ (get alert-notification-condition-text condition-kwd))
+ email-recipients (filterv u/is-email? (map :email recipients))
+ timezone (-> results first :card defaulted-timezone)]
+ {:subject email-subject
+ :recipients email-recipients
+ :message-type :attachments
+ :message (messages/render-alert-email timezone pulse results (ui/find-goal-value results))}))
+
+(defmethod create-notification [:alert :slack]
+ [pulse results {{channel-id :channel} :details :as channel}]
+ (log/debug (u/format-color 'cyan "Sending Alert (%d: %s) via Slack" (:id pulse) (:name pulse)))
+ {:channel-id channel-id
+ :message (str "Alert: " (first-question-name pulse))
+ :attachments (create-slack-attachment-data results)})
+
+(defmulti ^:private send-notification!
+ "Invokes the side-affecty function for sending emails/slacks depending on the notification type"
+ (fn [{:keys [channel-id] :as notification}]
+ (if channel-id :slack :email)))
+
+(defmethod send-notification! :slack
+ [{:keys [channel-id message attachments]}]
+ (let [attachments (create-and-upload-slack-attachments! attachments)]
+ (slack/post-chat-message! channel-id message attachments)))
+
+(defmethod send-notification! :email
+ [{:keys [subject recipients message-type message]}]
+ (email/send-message!
+ :subject subject
+ :recipients recipients
+ :message-type message-type
+ :message message))
+
+(defn- send-notifications! [notifications]
+ (doseq [notification notifications]
+ (send-notification! notification)))
+
(defn- pulse->notifications [{:keys [cards channel-ids], :as pulse}]
(let [results (for [card cards
:let [result (execute-card (:id card), :pulse-id (:id pulse))] ; Pulse ID may be `nil` if the Pulse isn't saved yet
:when result] ; some cards may return empty results, e.g. if the card has been archived
result)
channel-ids (or channel-ids (mapv :id (:channels pulse)))]
- (when-not (and (:skip_if_empty pulse) (are-all-cards-empty? results))
- (for [channel-id channel-ids
- :let [{:keys [channel_type details recipients]} (some #(when (= channel-id (:id %)) %)
- (:channels pulse))]]
- (case (keyword channel_type)
- :email (create-email-notification pulse results recipients)
- :slack (create-slack-notification pulse results (:channel details)))))))
+ (when (should-send-notification? pulse results)
-(defn- send-notifications! [notifications]
- (doseq [notification notifications]
- (if (contains? notification :channel-id)
- (send-slack-pulse! notification)
- (send-email-pulse! notification))))
+ (when (:alert_first_only pulse)
+ (db/delete! Pulse :id (:id pulse)))
+
+ (for [channel-id channel-ids
+ :let [channel (some #(when (= channel-id (:id %)) %) (:channels pulse))]]
+ (create-notification pulse results channel)))))
(defn send-pulse!
"Execute and Send a `Pulse`, optionally specifying the specific `PulseChannels`. This includes running each
diff --git a/src/metabase/task/send_pulses.clj b/src/metabase/task/send_pulses.clj
index 266b1d2b2fe2b4bda6d4a4ba2a0824847e3a5573..fe6dad68219670780913c5ca44417dfc2fbadec4 100644
--- a/src/metabase/task/send_pulses.clj
+++ b/src/metabase/task/send_pulses.clj
@@ -93,7 +93,7 @@
(doseq [pulse-id (keys channels-by-pulse)]
(try
(log/debug (format "Starting Pulse Execution: %d" pulse-id))
- (when-let [pulse (pulse/retrieve-pulse pulse-id)]
+ (when-let [pulse (pulse/retrieve-pulse-or-alert pulse-id)]
(p/send-pulse! pulse :channel-ids (mapv :id (get channels-by-pulse pulse-id))))
(log/debug (format "Finished Pulse Execution: %d" pulse-id))
(catch Throwable e
diff --git a/src/metabase/util/ui_logic.clj b/src/metabase/util/ui_logic.clj
new file mode 100644
index 0000000000000000000000000000000000000000..981b04e0b13a9e56a59176206fd867ae918b9cb5
--- /dev/null
+++ b/src/metabase/util/ui_logic.clj
@@ -0,0 +1,91 @@
+(ns metabase.util.ui-logic
+ "This namespace has clojure implementations of logic currently found in the UI, but is needed for the
+ backend. Idealling code here would be refactored such that the logic for this isn't needed in two places")
+
+(defn- dimension-column?
+ "A dimension column is any non-aggregation column"
+ [col]
+ (not= :aggregation (:source col)))
+
+(defn- summable-column?
+ "A summable column is any numeric column that isn't a special type like an FK or PK. It also excludes unix
+ timestamps that are numbers, but with a special type of DateTime"
+ [{:keys [base_type special_type]}]
+ (and (or (isa? base_type :type/Number)
+ (isa? special_type :type/Number))
+ (not (isa? special_type :type/Special))
+ (not (isa? special_type :type/DateTime))))
+
+(defn- metric-column?
+ "A metric column is any non-breakout column that is summable (numeric that isn't a special type like an FK/PK/Unix
+ timestamp)"
+ [col]
+ (and (not= :breakout (:source col))
+ (summable-column? col)))
+
+(defn- default-goal-column-index
+ "For graphs with goals, this function returns the index of the default column that should be used to compare against
+ the goal. This follows the frontend code getDefaultLineAreaBarColumns closely with a slight change (detailed in the
+ code)"
+ [results]
+ (let [graph-type (get-in results [:card :display])
+ [col-1 col-2 col-3 :as all-cols] (get-in results [:result :data :cols])
+ cols-count (count all-cols)]
+
+ (cond
+ ;; Progress goals return a single row and column, compare that
+ (= :progress graph-type)
+ 0
+
+ ;; Called DIMENSION_DIMENSION_METRIC in the UI, grab the metric third column for comparison
+ (and (= cols-count 3)
+ (dimension-column? col-1)
+ (dimension-column? col-2)
+ (metric-column? col-3))
+ 2
+
+ ;; Called DIMENSION_METRIC in the UI, use the metric column for comparison
+ (and (= cols-count 2)
+ (dimension-column? col-1)
+ (metric-column? col-2))
+ 1
+
+ ;; Called DIMENSION_METRIC_METRIC in the UI, use the metric column for comparison. The UI returns all of the
+ ;; metric columns here, but that causes an issue around which column the user intended to compare to the
+ ;; goal. The below code always takes the first metric column, this might diverge from the UI
+ (and (>= cols-count 3)
+ (dimension-column? col-1)
+ (every? metric-column? (rest all-cols)))
+ 1
+
+ ;; If none of the above is true, return nil as we don't know what to compare the goal to
+ :else nil)))
+
+(defn- column-name->index
+ "The results seq is seq of vectors, this function returns the index in that vector of the given `COLUMN-NAME`"
+ [results ^String column-name]
+ (when column-name
+ (first (map-indexed (fn [idx column]
+ (when (.equalsIgnoreCase column-name (:name column))
+ idx))
+ (get-in results [:result :data :cols])))))
+
+(defn goal-comparison-column
+ "For a given resultset, return the index of the column that should be used for the goal comparison. This can come
+ from the visualization settings if the column is specified, or from our default column logic"
+ [result]
+ (or (column-name->index result (get-in result [:card :visualization_settings :graph.metrics]))
+ (default-goal-column-index result)))
+
+(defn find-goal-value
+ "The goal value can come from a progress goal or a graph goal_value depending on it's type"
+ [result]
+ (case (get-in result [:card :display])
+
+ (:area :bar :line)
+ (get-in result [:card :visualization_settings :graph.goal_value])
+
+ :progress
+ (get-in result [:card :visualization_settings :progress.goal])
+
+ nil))
diff --git a/test/metabase/api/alert_test.clj b/test/metabase/api/alert_test.clj
new file mode 100644
index 0000000000000000000000000000000000000000..b7d32fe29d201b8087244d780aa291ea34dba525
--- /dev/null
+++ b/test/metabase/api/alert_test.clj
@@ -0,0 +1,671 @@
+(ns metabase.api.alert-test
+ (:require [expectations :refer :all]
+ [metabase
+ [email-test :as et]
+ [http-client :as http]
+ [middleware :as middleware]
+ [util :as u]]
+ [metabase.models
+ [card :refer [Card]]
+ [pulse :as pulse :refer [Pulse]]
+ [pulse-card :refer [PulseCard]]
+ [pulse-channel :refer [PulseChannel]]
+ [pulse-channel-recipient :refer [PulseChannelRecipient]]]
+ [metabase.test
+ [data :as data]
+ [util :as tu]]
+ [metabase.test.data.users :refer :all]
+ [metabase.test.mock.util :refer [pulse-channel-defaults]]
+ [toucan.db :as db]
+ [toucan.util.test :as tt]))
+
+(defn- user-details [user-kwd]
+ (-> user-kwd
+ fetch-user
+ (select-keys [:email :first_name :last_login :is_qbnewb :is_superuser :last_name :date_joined :common_name])
+ (assoc :id true)))
+
+(defn- pulse-card-details [card]
+ (-> card
+ (select-keys [:name :description :display])
+ (update :display name)
+ (assoc :id true)))
+
+(defn- recipient-details [user-kwd]
+ (-> user-kwd
+ user-details
+ (dissoc :last_login :is_qbnewb :is_superuser :date_joined)))
+
+(defn- alert-client
+ [username]
+ (comp tu/boolean-ids-and-timestamps (user->client username)))
+
+(defn- default-email-channel
+ ([pulse-card-id]
+ (default-email-channel pulse-card-id [(fetch-user :rasta)]))
+ ([pulse-card-id recipients]
+ {:id pulse-card-id
+ :enabled true
+ :channel_type "email"
+ :schedule_type "hourly"
+ :schedule_hour 12
+ :schedule_day "mon"
+ :recipients recipients
+ :details {}}))
+
+;; ## /api/alert/* AUTHENTICATION Tests
+;; We assume that all endpoints for a given context are enforced by the same middleware, so we don't run the same
+;; authentication test on every single individual endpoint
+
+(expect (get middleware/response-unauthentic :body) (http/client :get 401 "alert"))
+(expect (get middleware/response-unauthentic :body) (http/client :put 401 "alert/13"))
+
+
+;; ## POST /api/alert
+
+(expect
+ {:errors {:alert_condition "value must be one of: `goal`, `rows`."}}
+ ((user->client :rasta) :post 400 "alert" {:alert_condition "not rows"
+ :card "foobar"}))
+
+(expect
+ {:errors {:alert_first_only "value must be a boolean."}}
+ ((user->client :rasta) :post 400 "alert" {:alert_condition "rows"}))
+
+(expect
+ {:errors {:card "value must be a map."}}
+ ((user->client :rasta) :post 400 "alert" {:alert_condition "rows"
+ :alert_first_only false}))
+
+(expect
+ {:errors {:channels "value must be an array. Each value must be a map. The array cannot be empty."}}
+ ((user->client :rasta) :post 400 "alert" {:alert_condition "rows"
+ :alert_first_only false
+ :card {:id 100}}))
+
+(expect
+ {:errors {:channels "value must be an array. Each value must be a map. The array cannot be empty."}}
+ ((user->client :rasta) :post 400 "alert" {:alert_condition "rows"
+ :alert_first_only false
+ :card {:id 100}
+ :channels "foobar"}))
+
+(expect
+ {:errors {:channels "value must be an array. Each value must be a map. The array cannot be empty."}}
+ ((user->client :rasta) :post 400 "alert" {:alert_condition "rows"
+ :alert_first_only false
+ :card {:id 100}
+ :channels ["abc"]}))
+
+(defmacro ^:private with-test-email [& body]
+ `(tu/with-temporary-setting-values [~'site-url "https://metabase.com/testmb"]
+ (et/with-fake-inbox
+ ~@body)))
+
+(defmacro ^:private with-alert-setup
+ "Macro that will cleanup any created pulses and setups a fake-inbox to validate emails are sent for new alerts"
+ [& body]
+ `(tu/with-model-cleanup [Pulse]
+ (with-test-email
+ ~@body)))
+
+(defn- rasta-new-alert-email [body-map]
+ (et/email-to :rasta {:subject "You setup an alert",
+ :body (merge {"https://metabase.com/testmb" true,
+ "My question" true}
+ body-map)}))
+
+(defn- rasta-unsubscribe-email [body-map]
+ (et/email-to :rasta {:subject "You unsubscribed from an alert",
+ :body (merge {"https://metabase.com/testmb" true}
+ body-map)}))
+
+(defn- rasta-deleted-email [body-map]
+ (et/email-to :rasta {:subject "Crowberto Corv deleted an alert you created",
+ :body (merge {"Crowberto Corv deleted an alert" true}
+ body-map)}))
+
+(defn- default-alert [card]
+ {:id true
+ :name nil
+ :creator_id true
+ :creator (user-details :rasta)
+ :created_at true
+ :updated_at true
+ :card (pulse-card-details card)
+ :alert_condition "rows"
+ :alert_first_only false
+ :alert_above_goal nil
+ :channels [(merge pulse-channel-defaults
+ {:channel_type "email"
+ :schedule_type "hourly"
+ :schedule_hour nil
+ :recipients [(recipient-details :rasta)]
+ :updated_at true,
+ :pulse_id true,
+ :id true,
+ :created_at true})]
+ :skip_if_empty true})
+
+;; Check creation of a new rows alert with email notification
+(tt/expect-with-temp [Card [card1 {:name "My question"}]]
+ [(-> (default-alert card1)
+ (update-in [:channels 0] merge {:schedule_hour 12, :schedule_type "daily", :recipients []}))
+ (rasta-new-alert-email {"has any results" true})]
+ (with-alert-setup
+ [((alert-client :rasta) :post 200 "alert"
+ {:card {:id (:id card1)}
+ :alert_condition "rows"
+ :alert_first_only false
+ :channels [{:enabled true
+ :channel_type "email"
+ :schedule_type "daily"
+ :schedule_hour 12
+ :schedule_day nil
+ :recipients []}]})
+ (et/regex-email-bodies #"https://metabase.com/testmb"
+ #"has any results"
+ #"My question")]))
+
+;; Check creation of a below goal alert
+(tt/expect-with-temp [Card [card1 {:name "My question"
+ :display "line"}]]
+ (rasta-new-alert-email {"goes below its goal" true})
+ (with-alert-setup
+ ((user->client :rasta) :post 200 "alert"
+ {:card {:id (:id card1)}
+ :alert_condition "goal"
+ :alert_above_goal false
+ :alert_first_only false
+ :channels [{:enabled true
+ :channel_type "email"
+ :schedule_type "daily"
+ :schedule_hour 12
+ :schedule_day nil
+ :recipients []}]})
+ (et/regex-email-bodies #"https://metabase.com/testmb"
+ #"goes below its goal"
+ #"My question")))
+
+;; Check creation of a above goal alert
+(tt/expect-with-temp [Card [card1 {:name "My question"
+ :display "bar"}]]
+ (rasta-new-alert-email {"meets its goal" true})
+ (with-alert-setup
+ ((user->client :rasta) :post 200 "alert"
+ {:card {:id (:id card1)}
+ :alert_condition "goal"
+ :alert_above_goal true
+ :alert_first_only false
+ :channels [{:enabled true
+ :channel_type "email"
+ :schedule_type "daily"
+ :schedule_hour 12
+ :schedule_day nil
+ :recipients []}]})
+ (et/regex-email-bodies #"https://metabase.com/testmb"
+ #"meets its goal"
+ #"My question")))
+
+;; ## PUT /api/alert
+
+(expect
+ {:errors {:alert_condition "value must be one of: `goal`, `rows`."}}
+ ((user->client :rasta) :put 400 "alert/1" {}))
+
+(expect
+ {:errors {:alert_condition "value must be one of: `goal`, `rows`."}}
+ ((user->client :rasta) :put 400 "alert/1" {:alert_condition "not rows"}))
+
+(expect
+ {:errors {:alert_first_only "value must be a boolean."}}
+ ((user->client :rasta) :put 400 "alert/1" {:alert_condition "rows"}))
+
+(expect
+ {:errors {:card "value must be a map."}}
+ ((user->client :rasta) :put 400 "alert/1" {:alert_condition "rows"
+ :alert_first_only false}))
+
+(expect
+ {:errors {:card "value must be a map."}}
+ ((user->client :rasta) :put 400 "alert/1" {:alert_condition "rows"
+ :alert_first_only false
+ :card "foobar"}))
+
+(expect
+ {:errors {:channels "value must be an array. Each value must be a map. The array cannot be empty."}}
+ ((user->client :rasta) :put 400 "alert/1" {:alert_condition "rows"
+ :alert_first_only false
+ :card {:id 100}}))
+
+(expect
+ {:errors {:channels "value must be an array. Each value must be a map. The array cannot be empty."}}
+ ((user->client :rasta) :put 400 "alert/1" {:alert_condition "rows"
+ :alert_first_only false
+ :card {:id 100}
+ :channels "foobar"}))
+
+(expect
+ {:errors {:channels "value must be an array. Each value must be a map. The array cannot be empty."}}
+ ((user->client :rasta) :put 400 "alert/1" {:name "abc"
+ :alert_condition "rows"
+ :alert_first_only false
+ :card {:id 100}
+ :channels ["abc"]}))
+
+(defn- default-alert-req
+ ([card pulse-card]
+ (default-alert-req card pulse-card {} []))
+ ([card pulse-card alert-map users]
+ (merge {:card {:id (u/get-id card)}
+ :alert_condition "rows"
+ :alert_first_only false
+ :channels [(if (seq users)
+ (default-email-channel (u/get-id pulse-card) users)
+ (default-email-channel (u/get-id pulse-card)))]
+ :skip_if_empty false}
+ alert-map)))
+
+(defn- default-pulse-row []
+ {:alert_condition "rows"
+ :alert_first_only false
+ :creator_id (user->id :rasta)
+ :name nil})
+
+;; Non-admin users can update alerts they created
+(tt/expect-with-temp [Pulse [{pulse-id :id} (default-pulse-row)]
+ Card [{card-id :id :as card}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id :id} {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ (default-alert card)
+
+ (tu/with-model-cleanup [Pulse]
+ ((alert-client :rasta) :put 200 (format "alert/%d" pulse-id)
+ (default-alert-req card pc-id))))
+
+;; Admin users can update any alert
+(tt/expect-with-temp [Pulse [{pulse-id :id} (default-pulse-row)]
+ Card [{card-id :id :as card}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id :id} {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ (default-alert card)
+
+ (tu/with-model-cleanup [Pulse]
+ ((alert-client :crowberto) :put 200 (format "alert/%d" pulse-id)
+ (default-alert-req card pc-id))))
+
+;; Admin users can update any alert, changing the related alert attributes
+(tt/expect-with-temp [Pulse [{pulse-id :id} (default-pulse-row)]
+ Card [{card-id :id :as card}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id :id} {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ (merge (default-alert card)
+ {:alert_first_only true, :alert_above_goal true, :alert_condition "goal"})
+
+ (tu/with-model-cleanup [Pulse]
+ ((alert-client :crowberto) :put 200 (format "alert/%d" pulse-id)
+ (default-alert-req card pc-id {:alert_first_only true, :alert_above_goal true, :alert_condition "goal"}
+ [(fetch-user :rasta)]))))
+
+(defn- setify-recipient-emails [results]
+ (update results :channels (fn [channels]
+ (map #(update % :recipients set) channels))))
+
+;; Admin users can add a recipieint, that recipient should be notified
+(tt/expect-with-temp [Pulse [{pulse-id :id} (default-pulse-row)]
+ Card [{card-id :id :as card}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id :id} {:user_id (user->id :crowberto)
+ :pulse_channel_id pc-id}]]
+ [(-> (default-alert card)
+ (assoc-in [:channels 0 :recipients] (set (map recipient-details [:crowberto :rasta]))))
+ (et/email-to :rasta {:subject "Crowberto Corv added you to an alert",
+ :body {"https://metabase.com/testmb" true, "now getting alerts" true}})]
+
+ (with-alert-setup
+ [(setify-recipient-emails
+ ((alert-client :crowberto) :put 200 (format "alert/%d" pulse-id)
+ (default-alert-req card pc-id {} [(fetch-user :crowberto)
+ (fetch-user :rasta)])))
+ (et/regex-email-bodies #"https://metabase.com/testmb"
+ #"now getting alerts")]))
+
+;; Admin users can remove a recipieint, that recipient should be notified
+(tt/expect-with-temp [Pulse [{pulse-id :id} (default-pulse-row)]
+ Card [{card-id :id :as card}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id-1 :id} {:user_id (user->id :crowberto)
+ :pulse_channel_id pc-id}]
+ PulseChannelRecipient [{pcr-id-2 :id} {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ [(-> (default-alert card)
+ (assoc-in [:channels 0 :recipients] [(recipient-details :crowberto)]))
+ (et/email-to :rasta {:subject "You’ve been unsubscribed from an alert",
+ :body {"https://metabase.com/testmb" true,
+ "letting you know that Crowberto Corv" true}})]
+ (with-alert-setup
+ [((alert-client :crowberto) :put 200 (format "alert/%d" pulse-id)
+ (default-alert-req card pc-id {} [(fetch-user :crowberto)]))
+ (et/regex-email-bodies #"https://metabase.com/testmb"
+ #"letting you know that Crowberto Corv")]))
+
+;; Non-admin users can't edit alerts they didn't create
+(tt/expect-with-temp [Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :creator_id (user->id :crowberto)}]
+ Card [{card-id :id :as card}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id :id} {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ "You don't have permissions to do that."
+ (with-alert-setup
+ ((alert-client :rasta) :put 403 (format "alert/%d" pulse-id)
+ (default-alert-req card pc-id))))
+
+;; Non-admin users can't edit alerts if they're not in the recipient list
+(tt/expect-with-temp [Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :creator_id (user->id :rasta)}]
+ Card [{card-id :id :as card}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id :id} {:user_id (user->id :crowberto)
+ :pulse_channel_id pc-id}]]
+ "You don't have permissions to do that."
+ (with-alert-setup
+ ((alert-client :rasta) :put 403 (format "alert/%d" pulse-id)
+ (default-alert-req card pc-id))))
+
+(defn- basic-alert-query []
+ {:name "Foo"
+ :dataset_query {:database (data/id)
+ :type :query
+ :query {:source_table (data/id :checkins)
+ :aggregation [["count"]]
+ :breakout [["datetime-field" (data/id :checkins :date) "hour"]]}}})
+
+;; Basic test covering the /alert/question/:id call for a user
+(tt/expect-with-temp [Card [{card-id :id :as card} (basic-alert-query)]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :alert_above_goal nil
+ :skip_if_empty true
+ :name nil}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ [(-> (default-alert card)
+ ;; The read_only flag is used by the UI to determine what the user is allowed to update
+ (assoc :read_only false)
+ (update-in [:channels 0] merge {:schedule_hour 15 :schedule_type "daily"}))]
+ (with-alert-setup
+ ((alert-client :rasta) :get 200 (format "alert/question/%d" card-id))))
+
+;; Non-admin users shouldn't see alerts they created if they're no longer recipients
+(tt/expect-with-temp [Card [{card-id :id} (basic-alert-query)]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :alert_above_goal true
+ :creator_id (user->id :rasta)}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id :id} {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]
+ PulseChannelRecipient [_ {:user_id (user->id :crowberto)
+ :pulse_channel_id pc-id}]]
+ [1 0]
+ (with-alert-setup
+ [(count ((alert-client :rasta) :get 200 (format "alert/question/%d" card-id)))
+ (do
+ (db/delete! PulseChannelRecipient :id pcr-id)
+ (count ((alert-client :rasta) :get 200 (format "alert/question/%d" card-id))))]))
+
+;; Non-admin users should not see others alerts, admins see all alerts
+(tt/expect-with-temp [Card [{card-id :id} (basic-alert-query)]
+ Pulse [{pulse-id-1 :id} {:alert_condition "rows"
+ :alert_first_only false
+ :alert_above_goal false
+ :creator_id (user->id :rasta)}]
+ PulseCard [_ {:pulse_id pulse-id-1
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id-1 :id} {:pulse_id pulse-id-1}]
+ PulseChannelRecipient [_ {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id-1}]
+ ;; A separate admin created alert
+ Pulse [{pulse-id-2 :id} {:alert_condition "rows"
+ :alert_first_only false
+ :alert_above_goal false
+ :creator_id (user->id :crowberto)}]
+ PulseCard [_ {:pulse_id pulse-id-2
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id-2 :id} {:pulse_id pulse-id-2}]
+ PulseChannelRecipient [_ {:user_id (user->id :crowberto)
+ :pulse_channel_id pc-id-2}]
+ PulseChannel [{pc-id-3 :id} {:pulse_id pulse-id-2
+ :channel_type "slack"}]]
+ [1 2]
+ (with-alert-setup
+ [(count ((alert-client :rasta) :get 200 (format "alert/question/%d" card-id)))
+ (count ((alert-client :crowberto) :get 200 (format "alert/question/%d" card-id)))]))
+
+(expect
+ "Admin user are not allowed to unsubscribe from alerts"
+ ((user->client :crowberto) :put 400 (format "alert/1/unsubscribe")))
+
+(defn- recipient-emails [results]
+ (->> results
+ first
+ :channels
+ first
+ :recipients
+ (map :email)
+ set))
+
+;; Alert has two recipients, remove one
+(tt/expect-with-temp [Card [{card-id :id} (basic-alert-query)]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]
+ PulseChannelRecipient [_ {:user_id (user->id :crowberto)
+ :pulse_channel_id pc-id}]]
+ [#{"crowberto@metabase.com" "rasta@metabase.com"}
+ #{"crowberto@metabase.com"}
+ (rasta-unsubscribe-email {"Foo" true})]
+ (with-alert-setup
+ [(recipient-emails ((user->client :rasta) :get 200 (format "alert/question/%d" card-id)))
+ (do
+ ((user->client :rasta) :put 204 (format "alert/%d/unsubscribe" pulse-id))
+ (recipient-emails ((user->client :crowberto) :get 200 (format "alert/question/%d" card-id))))
+ (et/regex-email-bodies #"https://metabase.com/testmb"
+ #"Foo")]))
+
+;; Alert should be deleted if the creator unsubscribes and there's no one left
+(tt/expect-with-temp [Card [{card-id :id} (basic-alert-query)]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :creator_id (user->id :rasta)}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id
+ :channel_type :email}]
+ PulseChannelRecipient [_ {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ [1
+ 0
+ (rasta-unsubscribe-email {"Foo" true})]
+ (with-alert-setup
+ [(count ((user->client :rasta) :get 200 (format "alert/question/%d" card-id)))
+ (do
+ ((user->client :rasta) :put 204 (format "alert/%d/unsubscribe" pulse-id))
+ (count ((user->client :crowberto) :get 200 (format "alert/question/%d" card-id))))
+ (et/regex-email-bodies #"https://metabase.com/testmb"
+ #"Foo")]))
+
+;; Alert should not be deleted if there is a slack channel
+(tt/expect-with-temp [Card [{card-id :id} (basic-alert-query)]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :creator_id (user->id :rasta)}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id-1 :id} {:pulse_id pulse-id
+ :channel_type :email}]
+ PulseChannel [{pc-id-2 :id} {:pulse_id pulse-id
+ :channel_type :slack}]
+ PulseChannelRecipient [_ {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id-1}]]
+ [1
+ 1 ;<-- Alert should not be deleted
+ (rasta-unsubscribe-email {"Foo" true})]
+ (with-alert-setup
+ [(count ((user->client :rasta) :get 200 (format "alert/question/%d" card-id)))
+ (do
+ ((user->client :rasta) :put 204 (format "alert/%d/unsubscribe" pulse-id))
+ (count ((user->client :crowberto) :get 200 (format "alert/question/%d" card-id))))
+ (et/regex-email-bodies #"https://metabase.com/testmb"
+ #"Foo")]))
+
+;; Alert should not be deleted if the unsubscriber isn't the creator
+(tt/expect-with-temp [Card [{card-id :id} (basic-alert-query)]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :creator_id (user->id :crowberto)}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id-1 :id} {:pulse_id pulse-id
+ :channel_type :email}]
+ PulseChannel [{pc-id-2 :id} {:pulse_id pulse-id
+ :channel_type :slack}]
+ PulseChannelRecipient [_ {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id-1}]]
+ [1
+ 1 ;<-- Alert should not be deleted
+ (rasta-unsubscribe-email {"Foo" true})]
+ (with-alert-setup
+ [(count ((user->client :rasta) :get 200 (format "alert/question/%d" card-id)))
+ (do
+ ((user->client :rasta) :put 204 (format "alert/%d/unsubscribe" pulse-id))
+ (count ((user->client :crowberto) :get 200 (format "alert/question/%d" card-id))))
+ (et/regex-email-bodies #"https://metabase.com/testmb"
+ #"Foo")]))
+
+;; Only admins can delete an alert
+(tt/expect-with-temp [Card [{card-id :id} (basic-alert-query)]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :creator_id (user->id :rasta)}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ [1 "You don't have permissions to do that."]
+ (with-alert-setup
+ [(count ((user->client :rasta) :get 200 (format "alert/question/%d" card-id)))
+ ((user->client :rasta) :delete 403 (format "alert/%d" pulse-id))]))
+
+;; Testing a user can't delete an admin's alert
+(tt/expect-with-temp [Card [{card-id :id} (basic-alert-query)]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :creator_id (user->id :crowberto)}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ [1 nil 0]
+ (with-alert-setup
+ (let [original-alert-response ((user->client :crowberto) :get 200 (format "alert/question/%d" card-id))]
+
+ ;; A user can't delete an admin's alert
+ ((user->client :rasta) :delete 403 (format "alert/%d" pulse-id))
+
+ [(count original-alert-response)
+ ((user->client :crowberto) :delete 204 (format "alert/%d" pulse-id))
+ (count ((user->client :rasta) :get 200 (format "alert/question/%d" card-id)))])))
+
+;; An admin can delete a user's alert
+(tt/expect-with-temp [Card [{card-id :id} (basic-alert-query)]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :creator_id (user->id :rasta)}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ [1 nil 0
+ (rasta-deleted-email {})]
+ (with-alert-setup
+ [(count ((user->client :rasta) :get 200 (format "alert/question/%d" card-id)))
+ ((user->client :crowberto) :delete 204 (format "alert/%d" pulse-id))
+ (count ((user->client :rasta) :get 200 (format "alert/question/%d" card-id)))
+ (et/regex-email-bodies #"Crowberto Corv deleted an alert")]))
+
+;; A deleted alert should notify the creator and any recipients
+(tt/expect-with-temp [Card [{card-id :id} (basic-alert-query)]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :creator_id (user->id :rasta)}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]
+ PulseChannelRecipient [_ {:user_id (user->id :lucky)
+ :pulse_channel_id pc-id}]]
+ [1 nil 0
+ (merge
+ (rasta-deleted-email {"Crowberto Corv unsubscribed you from alerts" false})
+ (et/email-to :lucky {:subject "You’ve been unsubscribed from an alert",
+ :body {"Crowberto Corv deleted an alert" false
+ "Crowberto Corv unsubscribed you from alerts" true}}))]
+ (with-alert-setup
+ [(count ((user->client :rasta) :get 200 (format "alert/question/%d" card-id)))
+ ((user->client :crowberto) :delete 204 (format "alert/%d" pulse-id))
+ (count ((user->client :rasta) :get 200 (format "alert/question/%d" card-id)))
+ (et/regex-email-bodies #"Crowberto Corv deleted an alert"
+ #"Crowberto Corv unsubscribed you from alerts")]))
diff --git a/test/metabase/api/card_test.clj b/test/metabase/api/card_test.clj
index 1aaff3c520d77933a3fa6f18cdcbaf6ecb377f6e..e520da3f1b341f88857342dfc2620e8b40f15a9d 100644
--- a/test/metabase/api/card_test.clj
+++ b/test/metabase/api/card_test.clj
@@ -5,6 +5,7 @@
[expectations :refer :all]
[medley.core :as m]
[metabase
+ [email-test :as et]
[http-client :as http :refer :all]
[middleware :as middleware]
[util :as u]]
@@ -17,6 +18,10 @@
[label :refer [Label]]
[permissions :as perms]
[permissions-group :as perms-group]
+ [pulse :as pulse :refer [Pulse]]
+ [pulse-card :refer [PulseCard]]
+ [pulse-channel :refer [PulseChannel]]
+ [pulse-channel-recipient :refer [PulseChannelRecipient]]
[table :refer [Table]]
[view-log :refer [ViewLog]]]
[metabase.test
@@ -408,6 +413,154 @@
;; now check the metadata that was saved in the DB
(db/select-one-field :result_metadata Card :id (u/get-id card)))))
+;;; +------------------------------------------------------------------------------------------------------------------------+
+;;; | Card updates that impact alerts |
+;;; +------------------------------------------------------------------------------------------------------------------------+
+
+(defn- rasta-alert-not-working [body-map]
+ (et/email-to :rasta {:subject "One of your alerts has stopped working",
+ :body body-map}))
+
+(defn- crowberto-alert-not-working [body-map]
+ (et/email-to :crowberto {:subject "One of your alerts has stopped working",
+ :body body-map}))
+
+;; Validate archiving a card trigers alert deletion
+(tt/expect-with-temp [Card [{card-id :id :as card}]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :creator_id (user->id :rasta)
+ :name "Original Alert Name"}]
+
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id-1 :id} {:user_id (user->id :crowberto)
+ :pulse_channel_id pc-id}]
+ PulseChannelRecipient [{pcr-id-2 :id} {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ [(merge (crowberto-alert-not-working {"the question was archived by Rasta Toucan" true})
+ (rasta-alert-not-working {"the question was archived by Rasta Toucan" true}))
+ nil]
+ (et/with-fake-inbox
+ ((user->client :rasta) :put 200 (str "card/" card-id) {:archived true})
+ [(et/regex-email-bodies #"the question was archived by Rasta Toucan")
+ (Pulse pulse-id)]))
+
+;; Validate changing a display type trigers alert deletion
+(tt/expect-with-temp [Card [{card-id :id :as card} {:display :table}]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :creator_id (user->id :rasta)
+ :name "Original Alert Name"}]
+
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id-1 :id} {:user_id (user->id :crowberto)
+ :pulse_channel_id pc-id}]
+ PulseChannelRecipient [{pcr-id-2 :id} {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ [(merge (crowberto-alert-not-working {"the question was edited by Rasta Toucan" true})
+ (rasta-alert-not-working {"the question was edited by Rasta Toucan" true}))
+
+ nil]
+ (et/with-fake-inbox
+ ((user->client :rasta) :put 200 (str "card/" card-id) {:display :line})
+ [(et/regex-email-bodies #"the question was edited by Rasta Toucan")
+ (Pulse pulse-id)]))
+
+;; Changing the display type from line to table should force a delete
+(tt/expect-with-temp [Card [{card-id :id :as card} {:display :line
+ :visualization_settings {:graph.goal_value 10}}]
+ Pulse [{pulse-id :id} {:alert_condition "goal"
+ :alert_first_only false
+ :creator_id (user->id :rasta)
+ :name "Original Alert Name"}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id :id} {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ [(rasta-alert-not-working {"the question was edited by Rasta Toucan" true})
+ nil]
+ (et/with-fake-inbox
+ ((user->client :rasta) :put 200 (str "card/" card-id) {:display :table})
+ [(et/regex-email-bodies #"the question was edited by Rasta Toucan")
+ (Pulse pulse-id)]))
+
+;; Changing the display type from line to area/bar is fine and doesn't delete the alert
+(tt/expect-with-temp [Card [{card-id :id :as card} {:display :line
+ :visualization_settings {:graph.goal_value 10}}]
+ Pulse [{pulse-id :id} {:alert_condition "goal"
+ :alert_first_only false
+ :creator_id (user->id :rasta)
+ :name "Original Alert Name"}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id :id} {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ [{} true {} true]
+ (et/with-fake-inbox
+ [(do
+ ((user->client :rasta) :put 200 (str "card/" card-id) {:display :area})
+ (et/regex-email-bodies #"the question was edited by Rasta Toucan"))
+ (boolean (Pulse pulse-id))
+ (do
+ ((user->client :rasta) :put 200 (str "card/" card-id) {:display :bar})
+ (et/regex-email-bodies #"the question was edited by Rasta Toucan"))
+ (boolean (Pulse pulse-id))]))
+
+;; Removing the goal value will trigger the alert to be deleted
+(tt/expect-with-temp [Card [{card-id :id :as card} {:display :line
+ :visualization_settings {:graph.goal_value 10}}]
+ Pulse [{pulse-id :id} {:alert_condition "goal"
+ :alert_first_only false
+ :creator_id (user->id :rasta)
+ :name "Original Alert Name"}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id :id} {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ [(rasta-alert-not-working {"the question was edited by Rasta Toucan" true})
+ nil]
+ (et/with-fake-inbox
+ ((user->client :rasta) :put 200 (str "card/" card-id) {:visualization_settings {:something "else"}})
+ [(et/regex-email-bodies #"the question was edited by Rasta Toucan")
+ (Pulse pulse-id)]))
+
+;; Adding an additional breakout will cause the alert to be removed
+(tt/expect-with-temp [Database [{database-id :id}]
+ Table [{table-id :id} {:db_id database-id}]
+ Card [{card-id :id :as card} {:display :line
+ :visualization_settings {:graph.goal_value 10}
+ :dataset_query (assoc-in (mbql-count-query database-id table-id)
+ [:query :breakout] [["datetime-field" (data/id :checkins :date) "hour"]])}]
+ Pulse [{pulse-id :id} {:alert_condition "goal"
+ :alert_first_only false
+ :creator_id (user->id :rasta)
+ :name "Original Alert Name"}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id :id} {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ [(rasta-alert-not-working {"the question was edited by Crowberto Corv" true})
+ nil]
+ (et/with-fake-inbox
+ ((user->client :crowberto) :put 200 (str "card/" card-id) {:dataset_query (assoc-in (mbql-count-query database-id table-id)
+ [:query :breakout] [["datetime-field" (data/id :checkins :date) "hour"]
+ ["datetime-field" (data/id :checkins :date) "second"]])})
+ [(et/regex-email-bodies #"the question was edited by Crowberto Corv")
+ (Pulse pulse-id)]))
;;; +------------------------------------------------------------------------------------------------------------------------+
;;; | DELETING A CARD (DEPRECATED) |
diff --git a/test/metabase/api/collection_test.clj b/test/metabase/api/collection_test.clj
index e461c3bc0010030fa5ed4ed16e4d429952046ac5..5fdd136f1053d5685674c07002246714ed8d174a 100644
--- a/test/metabase/api/collection_test.clj
+++ b/test/metabase/api/collection_test.clj
@@ -1,12 +1,19 @@
(ns metabase.api.collection-test
"Tests for /api/collection endpoints."
(:require [expectations :refer :all]
+ [metabase
+ [email-test :as et]
+ [util :as u]]
[metabase.models
[card :refer [Card]]
[collection :refer [Collection]]
[permissions :as perms]
- [permissions-group :as group]]
- [metabase.test.data.users :refer [user->client]]
+ [permissions-group :as group]
+ [pulse :refer [Pulse]]
+ [pulse-card :refer [PulseCard]]
+ [pulse-channel :refer [PulseChannel]]
+ [pulse-channel-recipient :refer [PulseChannelRecipient]]]
+ [metabase.test.data.users :refer [user->client user->id]]
[metabase.test.util :as tu]
[metabase.util :as u]
[toucan.db :as db]
@@ -105,3 +112,34 @@
(tt/with-temp Collection [collection]
((user->client :rasta) :put 403 (str "collection/" (u/get-id collection))
{:name "My Beautiful Collection", :color "#ABCDEF"})))
+
+;; Archiving a collection should delete any alerts associated with questions in the collection
+(tt/expect-with-temp [Collection [{collection-id :id}]
+ Card [{card-id :id :as card} {:collection_id collection-id}]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false
+ :creator_id (user->id :rasta)
+ :name "Original Alert Name"}]
+
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [{pcr-id-1 :id} {:user_id (user->id :crowberto)
+ :pulse_channel_id pc-id}]
+ PulseChannelRecipient [{pcr-id-2 :id} {:user_id (user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ [{"crowberto@metabase.com" [{:from "notifications@metabase.com",
+ :to ["crowberto@metabase.com"],
+ :subject "One of your alerts has stopped working",
+ :body {"the question was archived by Crowberto Corv" true}}],
+ "rasta@metabase.com" [{:from "notifications@metabase.com",
+ :to ["rasta@metabase.com"],
+ :subject "One of your alerts has stopped working",
+ :body {"the question was archived by Crowberto Corv" true}}]}
+ nil]
+ (et/with-fake-inbox
+ ((user->client :crowberto) :put 200 (str "collection/" collection-id)
+ {:name "My Beautiful Collection", :color "#ABCDEF", :archived true})
+ [(et/regex-email-bodies #"the question was archived by Crowberto Corv")
+ (Pulse pulse-id)]))
diff --git a/test/metabase/api/pulse_test.clj b/test/metabase/api/pulse_test.clj
index 27d34baf1dceca392d661da50b34b736e4315392..1d9d803792b514045fc43dbd3277ac3f235abca6 100644
--- a/test/metabase/api/pulse_test.clj
+++ b/test/metabase/api/pulse_test.clj
@@ -14,6 +14,7 @@
[pulse-card :refer [PulseCard]]
[table :refer [Table]]]
[metabase.test.data.users :refer :all]
+ [metabase.test.mock.util :refer [pulse-channel-defaults]]
[metabase.test.util :as tu]
[toucan.db :as db]
[toucan.util.test :as tt]))
@@ -100,24 +101,23 @@
:created_at true
:updated_at true
:cards (mapv pulse-card-details [card1 card2])
- :channels [{:enabled true
- :channel_type "email"
- :schedule_type "daily"
- :schedule_hour 12
- :schedule_day nil
- :schedule_frame nil
- :recipients []}]
+ :channels [(merge pulse-channel-defaults
+ {:channel_type "email"
+ :schedule_type "daily"
+ :schedule_hour 12
+ :recipients []})]
:skip_if_empty false}
- (-> (pulse-response ((user->client :rasta) :post 200 "pulse" {:name "A Pulse"
- :cards [{:id (:id card1)} {:id (:id card2)}]
- :channels [{:enabled true
- :channel_type "email"
- :schedule_type "daily"
- :schedule_hour 12
- :schedule_day nil
- :recipients []}]
- :skip_if_empty false}))
- (update :channels remove-extra-channels-fields)))
+ (tu/with-model-cleanup [Pulse]
+ (-> (pulse-response ((user->client :rasta) :post 200 "pulse" {:name "A Pulse"
+ :cards [{:id (:id card1)} {:id (:id card2)}]
+ :channels [{:enabled true
+ :channel_type "email"
+ :schedule_type "daily"
+ :schedule_hour 12
+ :schedule_day nil
+ :recipients []}]
+ :skip_if_empty false}))
+ (update :channels remove-extra-channels-fields))))
;; ## PUT /api/pulse
@@ -158,14 +158,11 @@
:created_at true
:updated_at true
:cards [(pulse-card-details card)]
- :channels [{:enabled true
- :channel_type "slack"
- :schedule_type "hourly"
- :schedule_hour nil
- :schedule_day nil
- :schedule_frame nil
- :details {:channels "#general"}
- :recipients []}]
+ :channels [(merge pulse-channel-defaults
+ {:channel_type "slack"
+ :schedule_type "hourly"
+ :details {:channels "#general"}
+ :recipients []})]
:skip_if_empty false}
(-> (pulse-response ((user->client :rasta) :put 200 (format "pulse/%d" (:id pulse))
{:name "Updated Pulse"
@@ -217,8 +214,21 @@
(:id pulse2)}])
((user->client :rasta) :get 200 "pulse")))
+;; ## GET /api/pulse -- should not return alerts
+(tt/expect-with-temp [Pulse [pulse1 {:name "ABCDEF"}]
+ Pulse [pulse2 {:name "GHIJKL"}]
+ Pulse [pulse3 {:name "AAAAAA"
+ :alert_condition "rows"}]]
+ [(assoc (pulse-details pulse1) :read_only false)
+ (assoc (pulse-details pulse2) :read_only false)]
+ ((user->client :rasta) :get 200 "pulse"))
;; ## GET /api/pulse/:id
(tt/expect-with-temp [Pulse [pulse]]
(pulse-details pulse)
((user->client :rasta) :get 200 (str "pulse/" (:id pulse))))
+
+;; ## GET /api/pulse/:id on an alert should 404
+(tt/expect-with-temp [Pulse [{pulse-id :id} {:alert_condition "rows"}]]
+ "Not found."
+ ((user->client :rasta) :get 404 (str "pulse/" pulse-id)))
diff --git a/test/metabase/email_test.clj b/test/metabase/email_test.clj
index a09cff34abfa46ff8fa92140040496520d1bbe11..dfe307825e3e6b6eb304ac9721575815b9eb090a 100644
--- a/test/metabase/email_test.clj
+++ b/test/metabase/email_test.clj
@@ -2,7 +2,9 @@
"Various helper functions for testing email functionality."
;; TODO - Move to something like `metabase.test.util.email`?
(:require [expectations :refer :all]
+ [medley.core :as m]
[metabase.email :as email]
+ [metabase.test.data.users :as user]
[metabase.test.util :as tu]))
(def inbox
@@ -44,6 +46,33 @@
{:style/indent 0}
`(do-with-fake-inbox (fn [] ~@body)))
+(defn- create-email-body->regex-fn
+ "Returns a function expecting the email body structure. It will apply the regexes in `REGEX-SEQ` over the body and
+ return map of the stringified regex as the key and a boolean as the value. True if it returns results via `re-find`
+ false otherwise."
+ [regex-seq]
+ (fn [message-body-seq]
+ (let [{message-body :content} (first message-body-seq)]
+ (zipmap (map str regex-seq)
+ (map #(boolean (re-find % message-body)) regex-seq)))))
+
+(defn regex-email-bodies
+ "Will be apply each regex to each email body in the fake inbox. The body will be replaced by a map with the
+ stringified regex as it's key and a boolean indicated that the regex returned results."
+ [& regexes]
+ (let [email-body->regex-boolean (create-email-body->regex-fn regexes)]
+ (m/map-vals (fn [emails-for-recipient]
+ (for [email emails-for-recipient]
+ (update email :body email-body->regex-boolean)))
+ @inbox)))
+
+(defn email-to
+ "Creates a default email map for `USER-KWD` via `user/fetch-user`, as would be returned by `with-fake-inbox`"
+ [user-kwd & [email-map]]
+ (let [{:keys [email]} (user/fetch-user user-kwd)]
+ {email [(merge {:from "notifications@metabase.com",
+ :to [email]}
+ email-map)]}))
;; simple test of email sending capabilities
(expect
diff --git a/test/metabase/models/pulse_channel_test.clj b/test/metabase/models/pulse_channel_test.clj
index 5e7079f8033abea8cc485a0b1a2f42e18fee9616..0cdb7aae235f263b3c78453af369303090f926cd 100644
--- a/test/metabase/models/pulse_channel_test.clj
+++ b/test/metabase/models/pulse_channel_test.clj
@@ -5,7 +5,9 @@
[pulse :refer :all]
[pulse-channel :refer :all]
[pulse-channel-recipient :refer :all]]
- [metabase.test.data :refer :all]
+ [metabase.test
+ [data :refer :all]
+ [util :as tu]]
[metabase.test.data.users :refer :all]
[toucan
[db :as db]
@@ -121,22 +123,23 @@
;; create-pulse-channel!
(expect
- {:enabled true
- :channel_type :email
- :schedule_type :daily
- :schedule_hour 18
- :schedule_day nil
+ {:enabled true
+ :channel_type :email
+ :schedule_type :daily
+ :schedule_hour 18
+ :schedule_day nil
:schedule_frame nil
- :recipients [(user-details :crowberto)
- {:email "foo@bar.com"}
- (user-details :rasta)]}
+ :recipients [(user-details :crowberto)
+ {:email "foo@bar.com"}
+ (user-details :rasta)]}
(tt/with-temp Pulse [{:keys [id]}]
- (create-channel-then-select! {:pulse_id id
- :enabled true
- :channel_type :email
- :schedule_type :daily
- :schedule_hour 18
- :recipients [{:email "foo@bar.com"} {:id (user->id :rasta)} {:id (user->id :crowberto)}]})))
+ (tu/with-model-cleanup [Pulse]
+ (create-channel-then-select! {:pulse_id id
+ :enabled true
+ :channel_type :email
+ :schedule_type :daily
+ :schedule_hour 18
+ :recipients [{:email "foo@bar.com"} {:id (user->id :rasta)} {:id (user->id :crowberto)}]}))))
(expect
{:enabled true
@@ -148,24 +151,25 @@
:recipients []
:details {:something "random"}}
(tt/with-temp Pulse [{:keys [id]}]
- (create-channel-then-select! {:pulse_id id
- :enabled true
- :channel_type :slack
- :schedule_type :hourly
- :details {:something "random"}
- :recipients [{:email "foo@bar.com"} {:id (user->id :rasta)} {:id (user->id :crowberto)}]})))
+ (tu/with-model-cleanup [Pulse]
+ (create-channel-then-select! {:pulse_id id
+ :enabled true
+ :channel_type :slack
+ :schedule_type :hourly
+ :details {:something "random"}
+ :recipients [{:email "foo@bar.com"} {:id (user->id :rasta)} {:id (user->id :crowberto)}]}))))
;; update-pulse-channel!
;; simple starting case where we modify the schedule hour and add a recipient
(expect
- {:enabled true
- :channel_type :email
- :schedule_type :daily
- :schedule_hour 18
- :schedule_day nil
+ {:enabled true
+ :channel_type :email
+ :schedule_type :daily
+ :schedule_hour 18
+ :schedule_day nil
:schedule_frame nil
- :recipients [{:email "foo@bar.com"}]}
+ :recipients [{:email "foo@bar.com"}]}
(tt/with-temp* [Pulse [{pulse-id :id}]
PulseChannel [{channel-id :id, :as channel} {:pulse_id pulse-id}]]
(update-channel-then-select! {:id channel-id
@@ -284,7 +288,7 @@
[{:schedule_type :daily, :channel_type :email}
{:schedule_type :hourly, :channel_type :slack}]]
(tt/with-temp* [Pulse [{pulse-id :id}]
- PulseChannel [_ {:pulse_id pulse-id}]
+ PulseChannel [_ {:pulse_id pulse-id}] ;-> schedule_type = daily, schedule_hour = 15, channel_type = email
PulseChannel [_ {:pulse_id pulse-id, :channel_type :slack, :schedule_type :hourly}]
PulseChannel [_ {:pulse_id pulse-id, :channel_type :email, :schedule_type :hourly, :enabled false}]]
(let [retrieve-channels (fn [hour day]
diff --git a/test/metabase/models/pulse_test.clj b/test/metabase/models/pulse_test.clj
index a080de15b18ba802d0474e167b3f1d9ec4eb8486..600411d12da7a7a36589f778470ec4df642b9236 100644
--- a/test/metabase/models/pulse_test.clj
+++ b/test/metabase/models/pulse_test.clj
@@ -7,8 +7,11 @@
[pulse-card :refer :all]
[pulse-channel :refer :all]
[pulse-channel-recipient :refer :all]]
- [metabase.test.data :refer :all]
+ [metabase.test
+ [data :refer :all]
+ [util :as tu]]
[metabase.test.data.users :refer :all]
+ [metabase.test.mock.util :refer [pulse-channel-defaults]]
[metabase.util :as u]
[toucan
[db :as db]
@@ -40,7 +43,6 @@
(-> (dissoc channel :id :pulse_id :created_at :updated_at)
(m/dissoc-in [:details :emails])))))))
-
;; retrieve-pulse
;; this should cover all the basic Pulse attributes
(expect
@@ -50,15 +52,13 @@
:cards [{:name "Test Card"
:description nil
:display :table}]
- :channels [{:enabled true
- :schedule_type :daily
- :schedule_hour 15
- :schedule_frame nil
- :channel_type :email
- :details {:other "stuff"}
- :schedule_day nil
- :recipients [{:email "foo@bar.com"}
- (dissoc (user-details :rasta) :is_superuser :is_qbnewb)]}]
+ :channels [(merge pulse-channel-defaults
+ {:schedule_type :daily
+ :schedule_hour 15
+ :channel_type :email
+ :details {:other "stuff"}
+ :recipients [{:email "foo@bar.com"}
+ (dissoc (user-details :rasta) :is_superuser :is_qbnewb)]})]
:skip_if_empty false}
(tt/with-temp* [Pulse [{pulse-id :id} {:name "Lodi Dodi"}]
PulseChannel [{channel-id :id :as channel} {:pulse_id pulse-id
@@ -99,14 +99,12 @@
;; update-pulse-channels!
(expect
- {:enabled true
- :channel_type :email
- :schedule_type :daily
- :schedule_hour 4
- :schedule_day nil
- :schedule_frame nil
- :recipients [{:email "foo@bar.com"}
- (dissoc (user-details :rasta) :is_superuser :is_qbnewb)]}
+ (merge pulse-channel-defaults
+ {:channel_type :email
+ :schedule_type :daily
+ :schedule_hour 4
+ :recipients [{:email "foo@bar.com"}
+ (dissoc (user-details :rasta) :is_superuser :is_qbnewb)]})
(tt/with-temp Pulse [{:keys [id]}]
(update-pulse-channels! {:id id} [{:enabled true
:channel_type :email
@@ -123,26 +121,25 @@
(expect
{:creator_id (user->id :rasta)
:name "Booyah!"
- :channels [{:enabled true
- :schedule_type :daily
- :schedule_hour 18
- :schedule_frame nil
- :channel_type :email
- :recipients [{:email "foo@bar.com"}]
- :schedule_day nil}]
+ :channels [(merge pulse-channel-defaults
+ {:schedule_type :daily
+ :schedule_hour 18
+ :channel_type :email
+ :recipients [{:email "foo@bar.com"}]})]
:cards [{:name "Test Card"
:description nil
:display :table}]
:skip_if_empty false}
(tt/with-temp Card [{:keys [id]} {:name "Test Card"}]
- (create-pulse-then-select! "Booyah!"
- (user->id :rasta)
- [id]
- [{:channel_type :email
- :schedule_type :daily
- :schedule_hour 18
- :recipients [{:email "foo@bar.com"}]}]
- false)))
+ (tu/with-model-cleanup [Pulse]
+ (create-pulse-then-select! "Booyah!"
+ (user->id :rasta)
+ [id]
+ [{:channel_type :email
+ :schedule_type :daily
+ :schedule_hour 18
+ :recipients [{:email "foo@bar.com"}]}]
+ false))))
;; update-pulse!
;; basic update. we are testing several things here
@@ -161,14 +158,12 @@
{:name "Test Card"
:description nil
:display :table}]
- :channels [{:enabled true
- :schedule_type :daily
- :schedule_hour 18
- :schedule_frame nil
- :channel_type :email
- :schedule_day nil
- :recipients [{:email "foo@bar.com"}
- (dissoc (user-details :crowberto) :is_superuser :is_qbnewb)]}]
+ :channels [(merge pulse-channel-defaults
+ {:schedule_type :daily
+ :schedule_hour 18
+ :channel_type :email
+ :recipients [{:email "foo@bar.com"}
+ (dissoc (user-details :crowberto) :is_superuser :is_qbnewb)]})]
:skip_if_empty false}
(tt/with-temp* [Pulse [{pulse-id :id}]
Card [{card-id-1 :id} {:name "Test Card"}]
diff --git a/test/metabase/pulse_test.clj b/test/metabase/pulse_test.clj
index 3bbd7f4a75a486f6f538a49047d920a7b163e343..bfb14bcacb6f5caa14ce087f54840f196443be92 100644
--- a/test/metabase/pulse_test.clj
+++ b/test/metabase/pulse_test.clj
@@ -1,16 +1,22 @@
(ns metabase.pulse-test
- (:require [expectations :refer :all]
+ (:require [clojure.walk :as walk]
+ [expectations :refer :all]
+ [medley.core :as m]
+ [metabase.integrations.slack :as slack]
[metabase.models
[card :refer [Card]]
- [pulse :refer [Pulse retrieve-pulse]]
+ [pulse :refer [Pulse retrieve-pulse retrieve-pulse-or-alert]]
[pulse-card :refer [PulseCard]]
[pulse-channel :refer [PulseChannel]]
[pulse-channel-recipient :refer [PulseChannelRecipient]]]
[metabase.pulse :refer :all]
- [metabase.test.data :as data]
+ [metabase.test
+ [data :as data]
+ [util :as tu]]
[metabase.test.data
[dataset-definitions :as defs]
[users :as users]]
+ [toucan.db :as db]
[toucan.util.test :as tt]))
(defn- email-body? [{message-type :type content :content}]
@@ -23,25 +29,46 @@
(= "image/png" content-type)
(instance? java.io.File content)))
-(defn- checkins-query [query-map]
- {:dataset_query {:database (data/id)
+(defn checkins-query
+ "Basic query that will return results for an alert"
+ [query-map]
+ {:name "Test card"
+ :dataset_query {:database (data/id)
:type :query
- :query (merge {:source_table (data/id :checkins)
- :aggregation [["count"]]}
- query-map)}})
+ :query (merge {:source_table (data/id :checkins)
+ :aggregation [["count"]]}
+ query-map)}})
(defn- rasta-id []
(users/user->id :rasta))
+(defn- realize-lazy-seqs
+ "It's possible when data structures contain lazy sequences that the database will be torn down before the lazy seq
+ is realized, causing the data returned to be nil. This function walks the datastructure, realizing all the lazy
+ sequences it finds"
+ [data]
+ (walk/postwalk identity data))
+
(defmacro ^:private test-setup
"Macro that ensures test-data is present and disables sending of notifications"
[& body]
`(data/with-db (data/get-or-create-database! defs/test-data)
- (with-redefs [metabase.pulse/send-notifications! identity]
- ~@body)))
+ (tu/with-temporary-setting-values [~'site-url "https://metabase.com/testmb"]
+ (with-redefs [metabase.pulse/send-notifications! realize-lazy-seqs
+ slack/channels-list (constantly [{:name "metabase_files"
+ :id "FOO"}])]
+ ~@body))))
-;; Basic test, 1 card, 1 receipient
-(expect
+;; Basic test, 1 card, 1 recipient
+(tt/expect-with-temp [Card [{card-id :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "hour"]]})]
+ Pulse [{pulse-id :id} {:name "Pulse Name"
+ :skip_if_empty false}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id}]]
[true
{:subject "Pulse: Pulse Name"
:recipients [(:email (users/fetch-user :rasta))]
@@ -50,24 +77,25 @@
true
true]
(test-setup
- (tt/with-temp* [Card [{card-id :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "hour"]]})]
- Pulse [{pulse-id :id} {:name "Pulse Name"
- :skip_if_empty false}]
- PulseCard [_ {:pulse_id pulse-id
- :card_id card-id
- :position 0}]
- PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
- PulseChannelRecipient [_ {:user_id (rasta-id)
- :pulse_channel_id pc-id}]]
- (let [[result & no-more-results] (send-pulse! (retrieve-pulse pulse-id))]
- [(empty? no-more-results)
- (select-keys result [:subject :recipients :message-type])
- (count (:message result))
- (email-body? (first (:message result)))
- (attachment? (second (:message result)))]))))
+ (let [[result & no-more-results] (send-pulse! (retrieve-pulse pulse-id))]
+ [(empty? no-more-results)
+ (select-keys result [:subject :recipients :message-type])
+ (count (:message result))
+ (email-body? (first (:message result)))
+ (attachment? (second (:message result)))])))
-;; Pulse should be sent to two receipients
-(expect
+;; Pulse should be sent to two recipients
+(tt/expect-with-temp [Card [{card-id :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "hour"]]})]
+ Pulse [{pulse-id :id} {:name "Pulse Name"
+ :skip_if_empty false}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id}]
+ PulseChannelRecipient [_ {:user_id (users/user->id :crowberto)
+ :pulse_channel_id pc-id}]]
[true
{:subject "Pulse: Pulse Name"
:recipients (set (map (comp :email users/fetch-user) [:rasta :crowberto]))
@@ -76,95 +104,477 @@
true
true]
(test-setup
- (tt/with-temp* [Card [{card-id :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "hour"]]})]
- Pulse [{pulse-id :id} {:name "Pulse Name"
- :skip_if_empty false}]
+ (let [[result & no-more-results] (send-pulse! (retrieve-pulse pulse-id))]
+ [(empty? no-more-results)
+ (-> result
+ (select-keys [:subject :recipients :message-type])
+ (update :recipients set))
+ (count (:message result))
+ (email-body? (first (:message result)))
+ (attachment? (second (:message result)))])))
+
+;; 1 pulse that has 2 cards, should contain two attachments
+(tt/expect-with-temp [Card [{card-id-1 :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "hour"]]})]
+ Card [{card-id-2 :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "day-of-week"]]})]
+ Pulse [{pulse-id :id} {:name "Pulse Name"
+ :skip_if_empty false}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id-1
+ :position 0}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id-2
+ :position 1}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id}]]
+ [true
+ {:subject "Pulse: Pulse Name"
+ :recipients [(:email (users/fetch-user :rasta))]
+ :message-type :attachments}
+ 3
+ true
+ true]
+ (test-setup
+ (let [[result & no-more-results] (send-pulse! (retrieve-pulse pulse-id))]
+ [(empty? no-more-results)
+ (select-keys result [:subject :recipients :message-type])
+ (count (:message result))
+ (email-body? (first (:message result)))
+ (attachment? (second (:message result)))])))
+
+;; Pulse where the card has no results, but skip_if_empty is false, so should still send
+(tt/expect-with-temp [Card [{card-id :id} (checkins-query {:filter [">",["field-id" (data/id :checkins :date)],"2017-10-24"]
+ :breakout [["datetime-field" ["field-id" (data/id :checkins :date)] "hour"]]})]
+ Pulse [{pulse-id :id} {:name "Pulse Name"
+ :skip_if_empty false}]
+ PulseCard [pulse-card {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id}]]
+ [true
+ {:subject "Pulse: Pulse Name"
+ :recipients [(:email (users/fetch-user :rasta))]
+ :message-type :attachments}
+ 2
+ true
+ true]
+ (test-setup
+ (let [[result & no-more-results] (send-pulse! (retrieve-pulse pulse-id))]
+ [(empty? no-more-results)
+ (select-keys result [:subject :recipients :message-type])
+ (count (:message result))
+ (email-body? (first (:message result)))
+ (attachment? (second (:message result)))])))
+
+;; Pulse where the card has no results, skip_if_empty is true, so no pulse should be sent
+(tt/expect-with-temp [Card [{card-id :id} (checkins-query {:filter [">",["field-id" (data/id :checkins :date)],"2017-10-24"]
+ :breakout [["datetime-field" ["field-id" (data/id :checkins :date)] "hour"]]})]
+ Pulse [{pulse-id :id} {:name "Pulse Name"
+ :skip_if_empty true}]
+ PulseCard [pulse-card {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id}]]
+ nil
+ (test-setup
+ (send-pulse! (retrieve-pulse pulse-id))))
+
+;; Rows alert with no data
+(tt/expect-with-temp [Card [{card-id :id} (checkins-query {:filter [">",["field-id" (data/id :checkins :date)],"2017-10-24"]
+ :breakout [["datetime-field" ["field-id" (data/id :checkins :date)] "hour"]]})]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false}]
+ PulseCard [pulse-card {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id}]]
+ nil
+ (test-setup
+ (send-pulse! (retrieve-pulse-or-alert pulse-id))))
+
+(defn- rows-email-body?
+ [{:keys [content] :as message}]
+ (boolean (re-find #"has results for you" content)))
+
+(defn- goal-above-email-body?
+ [{:keys [content] :as message}]
+ (boolean (re-find #"has reached" content)))
+
+(defn- goal-below-email-body?
+ [{:keys [content] :as message}]
+ (boolean (re-find #"has gone below" content)))
+
+(defn- first-run-email-body?
+ [{:keys [content] :as message}]
+ (boolean (re-find #"stop sending you alerts" content)))
+
+;; Rows alert with data
+(tt/expect-with-temp [Card [{card-id :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "hour"]]})]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id}]]
+ [true
+ {:subject "Metabase alert: Test card has results"
+ :recipients [(:email (users/fetch-user :rasta))]
+ :message-type :attachments}
+ 2
+ true
+ true
+ true]
+ (test-setup
+ (let [[result & no-more-results] (send-pulse! (retrieve-pulse-or-alert pulse-id))]
+ [(empty? no-more-results)
+ (select-keys result [:subject :recipients :message-type])
+ (count (:message result))
+ (email-body? (first (:message result)))
+ (attachment? (second (:message result)))
+ (rows-email-body? (first (:message result)))])))
+
+;; Above goal alert with data
+(tt/expect-with-temp [Card [{card-id :id} (merge (checkins-query {:filter ["between",["field-id" (data/id :checkins :date)],"2014-04-01" "2014-06-01"]
+ :breakout [["datetime-field" (data/id :checkins :date) "day"]]})
+ {:display :line
+ :visualization_settings {:graph.show_goal true :graph.goal_value 5.9}})]
+ Pulse [{pulse-id :id} {:alert_condition "goal"
+ :alert_first_only false
+ :alert_above_goal true}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id}]]
+ [true
+ {:subject "Metabase alert: Test card has reached its goal"
+ :recipients [(:email (users/fetch-user :rasta))]
+ :message-type :attachments}
+ 2
+ true
+ true
+ true]
+ (test-setup
+ (let [[result & no-more-results] (send-pulse! (retrieve-pulse-or-alert pulse-id))]
+ [(empty? no-more-results)
+ (select-keys result [:subject :recipients :message-type])
+ (count (:message result))
+ (email-body? (first (:message result)))
+ (attachment? (second (:message result)))
+ (goal-above-email-body? (first (:message result)))])))
+
+;; Above goal alert, with no data above goal
+(tt/expect-with-temp [Card [{card-id :id} (merge (checkins-query {:filter ["between",["field-id" (data/id :checkins :date)],"2014-02-01" "2014-04-01"]
+ :breakout [["datetime-field" (data/id :checkins :date) "day"]]})
+ {:display :area
+ :visualization_settings {:graph.show_goal true :graph.goal_value 5.9}})]
+ Pulse [{pulse-id :id} {:alert_condition "goal"
+ :alert_first_only false
+ :alert_above_goal true}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id}]]
+ nil
+ (test-setup
+ (send-pulse! (retrieve-pulse-or-alert pulse-id))))
+
+;; Below goal alert with no satisfying data
+(tt/expect-with-temp [Card [{card-id :id} (merge (checkins-query {:filter ["between",["field-id" (data/id :checkins :date)],"2014-02-10" "2014-02-12"]
+ :breakout [["datetime-field" (data/id :checkins :date) "day"]]})
+ {:display :bar
+ :visualization_settings {:graph.show_goal true :graph.goal_value 1.1}})]
+ Pulse [{pulse-id :id} {:alert_condition "goal"
+ :alert_first_only false
+ :alert_above_goal false}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id}]]
+ nil
+ (test-setup
+ (send-pulse! (retrieve-pulse-or-alert pulse-id))))
+
+;; Below goal alert with data
+(tt/expect-with-temp [Card [{card-id :id} (merge (checkins-query {:filter ["between",["field-id" (data/id :checkins :date)],"2014-02-12" "2014-02-17"]
+ :breakout [["datetime-field" (data/id :checkins :date) "day"]]})
+ {:display :line
+ :visualization_settings {:graph.show_goal true :graph.goal_value 1.1}})]
+ Pulse [{pulse-id :id} {:alert_condition "goal"
+ :alert_first_only false
+ :alert_above_goal false}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id}]]
+ [true
+ {:subject "Metabase alert: Test card has gone below its goal"
+ :recipients [(:email (users/fetch-user :rasta))]
+ :message-type :attachments}
+ 2
+ true
+ true
+ true]
+ (test-setup
+ (let [[result & no-more-results] (send-pulse! (retrieve-pulse-or-alert pulse-id))]
+ [(empty? no-more-results)
+ (select-keys result [:subject :recipients :message-type])
+ (count (:message result))
+ (email-body? (first (:message result)))
+ (attachment? (second (:message result)))
+ (goal-below-email-body? (first (:message result)))])))
+
+(defn- thunk->boolean [{:keys [attachments] :as result}]
+ (assoc result :attachments (for [attachment-info attachments]
+ (update attachment-info :attachment-bytes-thunk fn?))))
+
+;; Basic slack test, 1 card, 1 recipient channel
+(tt/expect-with-temp [Card [{card-id :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "hour"]]})]
+ Pulse [{pulse-id :id} {:name "Pulse Name"
+ :skip_if_empty false}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id
+ :channel_type "slack"
+ :details {:channel "#general"}}]]
+ {:channel-id "#general",
+ :message "Pulse: Pulse Name",
+ :attachments
+ [{:title "Test card",
+ :attachment-bytes-thunk true
+ :title_link (str "https://metabase.com/testmb/question/" card-id),
+ :attachment-name "image.png",
+ :channel-id "FOO",
+ :fallback "Test card"}]}
+ (test-setup
+ (-> (send-pulse! (retrieve-pulse pulse-id))
+ first
+ thunk->boolean)))
+
+(defn- produces-bytes? [{:keys [attachment-bytes-thunk]}]
+ (< 0 (alength (attachment-bytes-thunk))))
+
+;; Basic slack test, 2 cards, 1 recipient channel
+(tt/expect-with-temp [Card [{card-id-1 :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "hour"]]})]
+ Card [{card-id-2 :id} (-> {:breakout [["datetime-field" (data/id :checkins :date) "minute"]]}
+ checkins-query
+ (assoc :name "Test card 2"))]
+ Pulse [{pulse-id :id} {:name "Pulse Name"
+ :skip_if_empty false}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id-1
+ :position 0}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id-2
+ :position 1}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id
+ :channel_type "slack"
+ :details {:channel "#general"}}]]
+ [{:channel-id "#general",
+ :message "Pulse: Pulse Name",
+ :attachments
+ [{:title "Test card",
+ :attachment-bytes-thunk true
+ :title_link (str "https://metabase.com/testmb/question/" card-id-1),
+ :attachment-name "image.png",
+ :channel-id "FOO",
+ :fallback "Test card"}
+ {:title "Test card 2",
+ :attachment-bytes-thunk true
+ :title_link (str "https://metabase.com/testmb/question/" card-id-2),
+ :attachment-name "image.png",
+ :channel-id "FOO",
+ :fallback "Test card 2"}]}
+ true]
+ (test-setup
+ (let [[slack-data] (send-pulse! (retrieve-pulse pulse-id))]
+ [(thunk->boolean slack-data)
+ (every? produces-bytes? (:attachments slack-data))])))
+
+;; Test with a slack channel and an email
+(tt/expect-with-temp [Card [{card-id :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "hour"]]})]
+ Pulse [{pulse-id :id} {:name "Pulse Name"
+ :skip_if_empty false}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id-1 :id} {:pulse_id pulse-id
+ :channel_type "slack"
+ :details {:channel "#general"}}]
+ PulseChannel [{pc-id-2 :id} {:pulse_id pulse-id
+ :channel_type "email"
+ :details {}}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id-2}]]
+ [{:channel-id "#general",
+ :message "Pulse: Pulse Name",
+ :attachments [{:title "Test card", :attachment-bytes-thunk true
+ :title_link (str "https://metabase.com/testmb/question/" card-id),
+ :attachment-name "image.png", :channel-id "FOO",
+ :fallback "Test card"}]}
+ true
+ {:subject "Pulse: Pulse Name",
+ :recipients ["rasta@metabase.com"],
+ :message-type :attachments}
+ 2
+ true
+ true]
+ (test-setup
+ (let [pulse-data (send-pulse! (retrieve-pulse pulse-id))
+ slack-data (m/find-first #(contains? % :channel-id) pulse-data)
+ email-data (m/find-first #(contains? % :subject) pulse-data)]
+ [(thunk->boolean slack-data)
+ (every? produces-bytes? (:attachments slack-data))
+ (select-keys email-data [:subject :recipients :message-type])
+ (count (:message email-data))
+ (email-body? (first (:message email-data)))
+ (attachment? (second (:message email-data)))])))
+
+;; Rows slack alert with data
+(tt/expect-with-temp [Card [{card-id :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "hour"]]})]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id
+ :channel_type "slack"
+ :details {:channel "#general"}}]]
+ [{:channel-id "#general",
+ :message "Alert: Test card",
+ :attachments [{:title "Test card", :attachment-bytes-thunk true,
+ :title_link (str "https://metabase.com/testmb/question/" card-id)
+ :attachment-name "image.png", :channel-id "FOO",
+ :fallback "Test card"}]}
+ true]
+ (test-setup
+ (let [[result] (send-pulse! (retrieve-pulse-or-alert pulse-id))]
+ [(thunk->boolean result)
+ (every? produces-bytes? (:attachments result))])))
+
+(defn- venues-query [aggregation-op]
+ {:name "Test card"
+ :dataset_query {:database (data/id)
+ :type :query
+ :query {:source_table (data/id :venues)
+ :aggregation [[aggregation-op (data/id :venues :price)]]}}})
+
+;; Above goal alert with a progress bar
+(expect
+ [true
+ {:subject "Metabase alert: Test card has reached its goal"
+ :recipients [(:email (users/fetch-user :rasta))]
+ :message-type :attachments}
+ 1
+ true]
+ (test-setup
+ (tt/with-temp* [Card [{card-id :id} (merge (venues-query "max")
+ {:display :progress
+ :visualization_settings {:progress.goal 3}})]
+ Pulse [{pulse-id :id} {:alert_condition "goal"
+ :alert_first_only false
+ :alert_above_goal true}]
PulseCard [_ {:pulse_id pulse-id
:card_id card-id
:position 0}]
PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
- PulseChannelRecipient [_ {:user_id (rasta-id)
- :pulse_channel_id pc-id}]
- PulseChannelRecipient [_ {:user_id (users/user->id :crowberto)
+ PulseChannelRecipient [_ {:user_id (rasta-id)
:pulse_channel_id pc-id}]]
- (let [[result & no-more-results] (send-pulse! (retrieve-pulse pulse-id))]
+ (let [[result & no-more-results] (send-pulse! (retrieve-pulse-or-alert pulse-id))]
[(empty? no-more-results)
- (-> result
- (select-keys [:subject :recipients :message-type])
- (update :recipients set))
+ (select-keys result [:subject :recipients :message-type])
+ ;; The pulse code interprets progress graphs as just a scalar, so there are no attachments
(count (:message result))
- (email-body? (first (:message result)))
- (attachment? (second (:message result)))]))))
+ (email-body? (first (:message result)))]))))
-;; 1 pulse that has 2 cards, should contain two attachments
+;; Below goal alert with progress bar
(expect
[true
- {:subject "Pulse: Pulse Name"
- :recipients [(:email (users/fetch-user :rasta))]
+ {:subject "Metabase alert: Test card has gone below its goal"
+ :recipients [(:email (users/fetch-user :rasta))]
:message-type :attachments}
- 3
+ 1
true
- true]
+ false]
(test-setup
- (tt/with-temp* [Card [{card-id-1 :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "hour"]]})]
- Card [{card-id-2 :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "day-of-week"]]})]
- Pulse [{pulse-id :id} {:name "Pulse Name"
- :skip_if_empty false}]
+ (tt/with-temp* [Card [{card-id :id} (merge (venues-query "min")
+ {:display :progress
+ :visualization_settings {:progress.goal 2}})]
+ Pulse [{pulse-id :id} {:alert_condition "goal"
+ :alert_first_only false
+ :alert_above_goal false}]
PulseCard [_ {:pulse_id pulse-id
- :card_id card-id-1
+ :card_id card-id
:position 0}]
- PulseCard [_ {:pulse_id pulse-id
- :card_id card-id-2
- :position 1}]
PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
- PulseChannelRecipient [_ {:user_id (rasta-id)
+ PulseChannelRecipient [_ {:user_id (rasta-id)
:pulse_channel_id pc-id}]]
- (let [[result & no-more-results] (send-pulse! (retrieve-pulse pulse-id))]
+ (let [[result & no-more-results] (send-pulse! (retrieve-pulse-or-alert pulse-id))]
[(empty? no-more-results)
(select-keys result [:subject :recipients :message-type])
(count (:message result))
(email-body? (first (:message result)))
- (attachment? (second (:message result)))]))))
+ (first-run-email-body? (first (:message result)))]))))
-;; Pulse where the card has no results, but skip_if_empty is false, so should still send
+
+;; Rows alert, first run only with data
(expect
[true
- {:subject "Pulse: Pulse Name"
- :recipients [(:email (users/fetch-user :rasta))]
+ {:subject "Metabase alert: Test card has results"
+ :recipients [(:email (users/fetch-user :rasta))]
:message-type :attachments}
2
true
- true]
+ true
+ true
+ false]
(test-setup
- (tt/with-temp* [Card [{card-id :id} (checkins-query {:filter [">",["field-id" (data/id :checkins :date)],"2017-10-24"]
- :breakout [["datetime-field" ["field-id" (data/id :checkins :date)] "hour"]]})]
- Pulse [{pulse-id :id} {:name "Pulse Name"
- :skip_if_empty false}]
- PulseCard [pulse-card {:pulse_id pulse-id
- :card_id card-id
- :position 0}]
- PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
- PulseChannelRecipient [_ {:user_id (rasta-id)
- :pulse_channel_id pc-id}]]
- (let [[result & no-more-results] (send-pulse! (retrieve-pulse pulse-id))]
+ (tt/with-temp* [Card [{card-id :id} (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "hour"]]})]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only true}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id}]]
+ (let [[result & no-more-results] (send-pulse! (retrieve-pulse-or-alert pulse-id))]
[(empty? no-more-results)
(select-keys result [:subject :recipients :message-type])
(count (:message result))
(email-body? (first (:message result)))
- (attachment? (second (:message result)))]))))
+ (first-run-email-body? (first (:message result)))
+ (attachment? (second (:message result)))
+ (db/exists? Pulse :id pulse-id)]))))
-;; Pulse where the card has no results, skip_if_empty is true, so no pulse should be sent
-(expect
- nil
+;; First run alert with no data
+(tt/expect-with-temp [Card [{card-id :id} (checkins-query {:filter [">",["field-id" (data/id :checkins :date)],"2017-10-24"]
+ :breakout [["datetime-field" ["field-id" (data/id :checkins :date)] "hour"]]})]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only true}]
+ PulseCard [pulse-card {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
+ PulseChannelRecipient [_ {:user_id (rasta-id)
+ :pulse_channel_id pc-id}]]
+ [nil true]
(test-setup
- (tt/with-temp* [Card [{card-id :id} (checkins-query {:filter [">",["field-id" (data/id :checkins :date)],"2017-10-24"]
- :breakout [["datetime-field" ["field-id" (data/id :checkins :date)] "hour"]]})]
- Pulse [{pulse-id :id} {:name "Pulse Name"
- :skip_if_empty true}]
- PulseCard [pulse-card {:pulse_id pulse-id
- :card_id card-id
- :position 0}]
- PulseChannel [{pc-id :id} {:pulse_id pulse-id}]
- PulseChannelRecipient [_ {:user_id (rasta-id)
- :pulse_channel_id pc-id}]]
- (send-pulse! (retrieve-pulse pulse-id)))))
+ [(send-pulse! (retrieve-pulse-or-alert pulse-id))
+ (db/exists? Pulse :id pulse-id)]))
diff --git a/test/metabase/task/send_pulses_test.clj b/test/metabase/task/send_pulses_test.clj
new file mode 100644
index 0000000000000000000000000000000000000000..2c5c1f0f6455a7962d83bdddb725e4708d673c85
--- /dev/null
+++ b/test/metabase/task/send_pulses_test.clj
@@ -0,0 +1,37 @@
+(ns metabase.task.send-pulses-test
+ (:require [metabase
+ [email-test :as et]
+ [pulse-test :refer [checkins-query]]]
+ [metabase.models
+ [card :refer [Card]]
+ [pulse :refer [Pulse]]
+ [pulse-card :refer [PulseCard]]
+ [pulse-channel :refer [PulseChannel]]
+ [pulse-channel-recipient :refer [PulseChannelRecipient]]]
+ [metabase.task.send-pulses :refer :all]
+ [metabase.test.data :as data]
+ [metabase.test.data
+ [dataset-definitions :as defs]
+ [users :as users]]
+ [toucan.util.test :as tt]))
+
+(tt/expect-with-temp [Card [{card-id :id} (assoc (checkins-query {:breakout [["datetime-field" (data/id :checkins :date) "hour"]]})
+ :name "My Question Name")]
+ Pulse [{pulse-id :id} {:alert_condition "rows"
+ :alert_first_only false}]
+ PulseCard [_ {:pulse_id pulse-id
+ :card_id card-id
+ :position 0}]
+ PulseChannel [{pc-id :id} {:pulse_id pulse-id
+ :schedule_hour nil
+ :schedule_type "hourly"
+ :channel_type :email}]
+ PulseChannelRecipient [_ {:user_id (users/user->id :rasta)
+ :pulse_channel_id pc-id}]]
+ (et/email-to :rasta
+ {:subject "Metabase alert: My Question Name has results",
+ :body {"My Question Name.*has results" true}})
+ (et/with-fake-inbox
+ (data/with-db (data/get-or-create-database! defs/test-data)
+ (#'metabase.task.send-pulses/send-pulses! 0 "fri" :first :first)
+ (et/regex-email-bodies #"My Question Name.*has results"))))
diff --git a/test/metabase/test/mock/util.clj b/test/metabase/test/mock/util.clj
index 2facf497e7cf15d967dc7d47d31fc04d1d2a4e26..a3a5b77455e4e2403b2b9684cedfbad71cbb6b19 100644
--- a/test/metabase/test/mock/util.clj
+++ b/test/metabase/test/mock/util.clj
@@ -37,7 +37,11 @@
:preview_display true
:created_at true})
-
+(def pulse-channel-defaults
+ {:schedule_frame nil
+ :schedule_hour nil
+ :schedule_day nil
+ :enabled true})
;; This is just a fake implementation that just swoops in and returns somewhat-correct looking results for different
;; queries we know will get ran as part of sync