Skip to content

Fix setCallbackContext for wildcard and ordinary inputs#237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
HammadTheOne merged 6 commits into from
Oct 30, 2020
Merged

Fix setCallbackContext for wildcard and ordinary inputs #237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
80f8cae
Update setCallbackContext
HammadTheOne Oct 29, 2020
eaa9ca2
Adding graphs test
HammadTheOne Oct 29, 2020
b9462c5
Slight fix
HammadTheOne Oct 30, 2020
5834c4e
bump version and update CHANGELOG
Oct 30, 2020
ea95da8
Less flaky test
HammadTheOne Oct 30, 2020
aac2546
Merge branch 'wildcards-patch' of https://github.com/plotly/dashr int…
HammadTheOne Oct 30, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,10 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.8.1] - 2020-10-29
### Fixed
- Fixes a minor bug in `setCallbackContext` (described in [#236](https://github.com/plotly/dashR/issues/236)) which prevented pattern-matching callbacks from working properly if one or more `input` statements did not include a selector. [#237](https://github.com/plotly/dashR/pull/237)

## [0.8.0] - 2020-10-27
### Fixed
- Usage of `glue` has been corrected to address [#232](https://github.com/plotly/dashR/issues/232) via [#233](https://github.com/plotly/dashR/pull/233).
Expand Down
2 changes: 1 addition & 1 deletion DESCRIPTION
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
Package: dash
Title: An Interface to the Dash Ecosystem for Authoring Reactive Web Applications
Version: 0.8.0
Version: 0.8.1
Authors@R: c(person("Chris", "Parmer", role = c("aut"), email = "chris@plotly.com"), person("Ryan Patrick", "Kyle", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5829-9867"), email = "ryan@plotly.com"), person("Carson", "Sievert", role = c("aut"), comment = c(ORCID = "0000-0002-4958-2844")), person("Hammad", "Khan", role = c("aut"), comment = c(ORCID = "0000-0003-2479-9841"), email = "hammadkhan@plotly.com"), person(family = "Plotly Technologies", role = "cph"))
Description: A framework for building analytical web applications, Dash offers a pleasant and productive development experience. No JavaScript required.
Depends:
Expand Down
14 changes: 9 additions & 5 deletions R/utils.R
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1054,26 +1054,30 @@ setCallbackContext <- function(callback_elements) {
function(x) {
input_id <- splitIdProp(x)[1]
prop <- splitIdProp(x)[2]

# The following conditionals check whether the callback is a pattern-matching callback and if it has been triggered.
if (startsWith(input_id, "{")){
id_match <- vapply(callback_elements$inputs, function(x) {
x <- unlist(x)
any(x[grepl("id.", names(x))] %in% jsonlite::fromJSON(input_id)[[1]])
}, logical(1))[[1]]
} else {
id_match <- vapply(callback_elements$inputs, function(x) x$id %in% input_id, logical(1))
id_match <- vapply(callback_elements$inputs, function(x) {
unlist(x)
any(x$id %in% input_id)}, logical(1))
}

if (startsWith(input_id, "{")){
prop_match <- vapply(callback_elements$inputs, function(x) {
x <- unlist(x)
any(x[names(x) == "property"] %in% prop)
}, logical(1))[[1]]
} else {
prop_match <- vapply(callback_elements$inputs, function(x) x$property %in% prop, logical(1))
prop_match <- vapply(callback_elements$inputs, function(x) {
unlist(x)
any(x$property %in% prop)}, logical(1))
}

if (startsWith(input_id, "{")){
if (length(callback_elements$inputs) == 1 || !is.null(unlist(callback_elements$inputs, recursive = F)$value)) {
value <- sapply(callback_elements$inputs[id_match & prop_match], `[[`, "value")
Expand Down
127 changes: 127 additions & 0 deletions tests/integration/callbacks/test_pattern_matching.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,120 @@
"""


graphs_app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
library(plotly)

df <- read.csv(
file = "https://raw.githubusercontent.com/plotly/datasets/master/gapminderDataFiveYear.csv",
stringsAsFactor=FALSE,
check.names=FALSE
)

app <- Dash$new()

app$layout(
htmlDiv(
list(
htmlDiv(
list(
dccDropdown(options = lapply(unique(df[,"country"]), function(x) {
list(label = x, value = x)
}),
value = "Canada",
id = "country",
style = list(display = "inline-block",
width = 200)
),
htmlButton(
"add Chart",
id = "add-chart",
n_clicks = 0,
style = list(display = "inline-block")
)
)
),
htmlDiv(id = "container", children=list()),
htmlDiv(id = "output-delay")
)
)
)

create_figure <- function(df, column_x, column_y, country) {
df <- df[which(df[, "country"] == country),]
if (column_x == "year") {
fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "lines")
} else {
fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "markers")
}
fig <- plotly::layout(fig, plot_bgcolor="lightblue", xaxis = list(title=""),
yaxis = list(title=""), title=list(text=paste(country, column_y, "vs", column_x),
xanchor="right", margin_l=10, margin_r=0, margin_b=30))
return(fig)
}

app$callback(
output = list(
output(id = "container", property = "children"),
output(id = "output-delay", property = "children")
),
params = list(
input(id = "add-chart", property = "n_clicks"),
state(id = "country", property = "value"),
state(id = "container", property = "children")
),
function(n_clicks, country, children) {
default_column_x <- "year"
default_column_y <- "gdpPercap"

new_element <- htmlDiv(
style = list(width = "23%", display = "inline-block", outline = "thin lightgrey solid", padding = 10),
children = list(
dccGraph(
id = list(type = "dynamic-output", index = n_clicks),
style = list(height = 300),
figure = create_figure(df, default_column_x, default_column_y, country)
),
dccDropdown(
id = list(type = "dynamic-dropdown-x", index = n_clicks),
options = lapply(colnames(df), function(x) {
list(label = x, value = x)
}),
value = default_column_x
),
dccDropdown(
id = list(type = "dynamic-dropdown-y", index = n_clicks),
options = lapply(colnames(df), function(x) {
list(label = x, value = x)
}),
value = default_column_y
)
)
)

children <- c(children, list(new_element))
return(list(children, n_clicks))
}
)

app$callback(
output(id = list("index" = MATCH, "type" = "dynamic-output"), property = "figure"),
params = list(
input(id = list("index" = MATCH, "type" = "dynamic-dropdown-x"), property = "value"),
input(id = list("index" = MATCH, "type" = "dynamic-dropdown-y"), property = "value"),
input(id = "country", property = "value")
),
function(column_x, column_y, country) {
return(create_figure(df, column_x, column_y, country))
}
)

app$run_server()
"""


def test_rpmc001_pattern_matching_all(dashr):
dashr.start_server(all_app)
dashr.find_element("#add-filter").click()
Expand DownExpand Up@@ -370,3 +484,16 @@ def test_rpmc004_pattern_matching_todo(dashr):
dashr.find_element("#add").click()
dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"done\\"\\}').click()
assert dashr.wait_for_text_to_equal("#totals", "1 of 1 items completed - 100%")


def test_rpmc005_pattern_matching_graphs(dashr):
dashr.start_server(graphs_app)
dashr.select_dcc_dropdown("#country", "Cameroon")

@rpkylerpkyleOct 30, 2020

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I often have a statement like dashr.wait_for_text_to_equal initially before selecting anything, and then I have an htmlDiv with some content that renders which I can watch -- just in case there's a slight delay, in my (very limited) experience this seems to help avoid flaky tests, and can also take the place of a sleep statement.

@HammadTheOneHammadTheOneOct 30, 2020

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds good, I'm going to make a small update to it with those elements, then I'll merge it once the final tests pass.

dashr.wait_for_text_to_equal("#output-delay", "0")
dashr.find_element("#add-chart").click()
dashr.wait_for_text_to_equal("#output-delay", "1")
dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')
dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-x\\"\\}', "year")
dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-y\\"\\}', "pop")
dashr.percy_snapshot("r-pmc-graphs")
dashr.wait_for_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Fix setCallbackContext for wildcard and ordinary inputs by HammadTheOne · Pull Request #237 · plotly/dashR · GitHub
Skip to content
Fix setCallbackContext for wildcard and ordinary inputs#237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

HammadTheOne
merged 6 commits into

from

Oct 30, 2020
 Merged


Fix setCallbackContext for wildcard and ordinary inputs
#237
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
80f8cae

Update setCallbackContext


HammadTheOne Oct 29, 2020
eaa9ca2

Adding graphs test


HammadTheOne Oct 29, 2020
b9462c5

Slight fix


HammadTheOne Oct 30, 2020
5834c4e

bump version and update CHANGELOG

Oct 30, 2020
ea95da8

Less flaky test


HammadTheOne Oct 30, 2020
aac2546

Merge branch 'wildcards-patch' of https://github.com/plotly/dashr int…


HammadTheOne Oct 30, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,10 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.8.1] - 2020-10-29
### Fixed
- Fixes a minor bug in `setCallbackContext` (described in [#236](https://github.com/plotly/dashR/issues/236)) which prevented pattern-matching callbacks from working properly if one or more `input` statements did not include a selector. [#237](https://github.com/plotly/dashR/pull/237)

## [0.8.0] - 2020-10-27
### Fixed
- Usage of `glue` has been corrected to address [#232](https://github.com/plotly/dashR/issues/232) via [#233](https://github.com/plotly/dashR/pull/233).
Expand Down

2 changes: 1 addition & 1 deletion
DESCRIPTION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
Package: dash
Title: An Interface to the Dash Ecosystem for Authoring Reactive Web Applications
Version: 0.8.0
Version: 0.8.1
Authors@R: c(person("Chris", "Parmer", role = c("aut"), email = "chris@plotly.com"), person("Ryan Patrick", "Kyle", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5829-9867"), email = "ryan@plotly.com"), person("Carson", "Sievert", role = c("aut"), comment = c(ORCID = "0000-0002-4958-2844")), person("Hammad", "Khan", role = c("aut"), comment = c(ORCID = "0000-0003-2479-9841"), email = "hammadkhan@plotly.com"), person(family = "Plotly Technologies", role = "cph")) 
Description: A framework for building analytical web applications, Dash offers a pleasant and productive development experience. No JavaScript required.
Depends:
Expand Down

14 changes: 9 additions & 5 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1054,26 +1054,30 @@ setCallbackContext <- function(callback_elements) {
 function(x) {
 input_id <- splitIdProp(x)[1]
 prop <- splitIdProp(x)[2]

 # The following conditionals check whether the callback is a pattern-matching callback and if it has been triggered. 
 if (startsWith(input_id, "{")){
 id_match <- vapply(callback_elements$inputs, function(x) {
 x <- unlist(x)
 any(x[grepl("id.", names(x))] %in% jsonlite::fromJSON(input_id)[[1]])
 }, logical(1))[[1]]
 } else {
 id_match <- vapply(callback_elements$inputs, function(x) x$id %in% input_id, logical(1))
 id_match <- vapply(callback_elements$inputs, function(x) {
 unlist(x)
 any(x$id %in% input_id)}, logical(1))
 }

 if (startsWith(input_id, "{")){
 prop_match <- vapply(callback_elements$inputs, function(x) {
 x <- unlist(x)
 any(x[names(x) == "property"] %in% prop)
 }, logical(1))[[1]]
 } else {
 prop_match <- vapply(callback_elements$inputs, function(x) x$property %in% prop, logical(1))
 prop_match <- vapply(callback_elements$inputs, function(x) {
 unlist(x)
 any(x$property %in% prop)}, logical(1))
 }

 if (startsWith(input_id, "{")){
 if (length(callback_elements$inputs) == 1 || !is.null(unlist(callback_elements$inputs, recursive = F)$value)) {
 value <- sapply(callback_elements$inputs[id_match & prop_match], `[[`, "value")
Expand Down

127 changes: 127 additions & 0 deletions
tests/integration/callbacks/test_pattern_matching.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,120 @@
"""


graphs_app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
library(plotly)

df <- read.csv(
 file = "https://raw.githubusercontent.com/plotly/datasets/master/gapminderDataFiveYear.csv",
 stringsAsFactor=FALSE,
 check.names=FALSE
)

app <- Dash$new()

app$layout(
 htmlDiv(
 list(
 htmlDiv(
 list(
 dccDropdown(options = lapply(unique(df[,"country"]), function(x) {
 list(label = x, value = x)
 }),
 value = "Canada",
 id = "country",
 style = list(display = "inline-block",
 width = 200)
 ),
 htmlButton(
 "add Chart",
 id = "add-chart",
 n_clicks = 0,
 style = list(display = "inline-block")
 )
 )
 ),
 htmlDiv(id = "container", children=list()),
 htmlDiv(id = "output-delay")
 )
 )
)

create_figure <- function(df, column_x, column_y, country) {
 df <- df[which(df[, "country"] == country),]
 if (column_x == "year") {
 fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "lines")
 } else {
 fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "markers")
 }
 fig <- plotly::layout(fig, plot_bgcolor="lightblue", xaxis = list(title=""),
 yaxis = list(title=""), title=list(text=paste(country, column_y, "vs", column_x),
 xanchor="right", margin_l=10, margin_r=0, margin_b=30))
 return(fig)
}

app$callback(
 output = list(
 output(id = "container", property = "children"),
 output(id = "output-delay", property = "children")
 ),
 params = list(
 input(id = "add-chart", property = "n_clicks"),
 state(id = "country", property = "value"),
 state(id = "container", property = "children")
 ),
 function(n_clicks, country, children) {
 default_column_x <- "year"
 default_column_y <- "gdpPercap"

 new_element <- htmlDiv(
 style = list(width = "23%", display = "inline-block", outline = "thin lightgrey solid", padding = 10),
 children = list(
 dccGraph(
 id = list(type = "dynamic-output", index = n_clicks),
 style = list(height = 300),
 figure = create_figure(df, default_column_x, default_column_y, country)
 ),
 dccDropdown(
 id = list(type = "dynamic-dropdown-x", index = n_clicks),
 options = lapply(colnames(df), function(x) {
 list(label = x, value = x)
 }),
 value = default_column_x
 ),
 dccDropdown(
 id = list(type = "dynamic-dropdown-y", index = n_clicks),
 options = lapply(colnames(df), function(x) {
 list(label = x, value = x)
 }),
 value = default_column_y
 )
 )
 )

 children <- c(children, list(new_element))
 return(list(children, n_clicks))
 }
)

app$callback(
 output(id = list("index" = MATCH, "type" = "dynamic-output"), property = "figure"),
 params = list(
 input(id = list("index" = MATCH, "type" = "dynamic-dropdown-x"), property = "value"),
 input(id = list("index" = MATCH, "type" = "dynamic-dropdown-y"), property = "value"),
 input(id = "country", property = "value")
 ),
 function(column_x, column_y, country) {
 return(create_figure(df, column_x, column_y, country))
 }
)

app$run_server()
"""


def test_rpmc001_pattern_matching_all(dashr):
 dashr.start_server(all_app)
 dashr.find_element("#add-filter").click()
Expand DownExpand Up@@ -370,3 +484,16 @@ def test_rpmc004_pattern_matching_todo(dashr):
 dashr.find_element("#add").click()
 dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"done\\"\\}').click()
 assert dashr.wait_for_text_to_equal("#totals", "1 of 1 items completed - 100%")


def test_rpmc005_pattern_matching_graphs(dashr):
 dashr.start_server(graphs_app)
 dashr.select_dcc_dropdown("#country", "Cameroon")
@rpkylerpkyleOct 30, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I often have a statement like  dashr.wait_for_text_to_equal initially before selecting anything, and then I have an htmlDiv with some content that renders which I can watch -- just in case there's a slight delay, in my (very limited) experience this seems to help avoid flaky tests, and can also take the place of a sleep statement.
@HammadTheOneHammadTheOneOct 30, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds good, I'm going to make a small update to it with those elements, then I'll merge it once the final tests pass.
 dashr.wait_for_text_to_equal("#output-delay", "0")
 dashr.find_element("#add-chart").click()
 dashr.wait_for_text_to_equal("#output-delay", "1")
 dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')
 dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-x\\"\\}', "year")
 dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-y\\"\\}', "pop")
 dashr.percy_snapshot("r-pmc-graphs")
 dashr.wait_for_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Fix setCallbackContext for wildcard and ordinary inputs by HammadTheOne · Pull Request #237 · plotly/dashR · GitHub
Skip to content
Fix setCallbackContext for wildcard and ordinary inputs#237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

HammadTheOne
merged 6 commits into

from

Oct 30, 2020
 Merged


Fix setCallbackContext for wildcard and ordinary inputs
#237
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
80f8cae

Update setCallbackContext


HammadTheOne Oct 29, 2020
eaa9ca2

Adding graphs test


HammadTheOne Oct 29, 2020
b9462c5

Slight fix


HammadTheOne Oct 30, 2020
5834c4e

bump version and update CHANGELOG

Oct 30, 2020
ea95da8

Less flaky test


HammadTheOne Oct 30, 2020
aac2546

Merge branch 'wildcards-patch' of https://github.com/plotly/dashr int…


HammadTheOne Oct 30, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,10 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.8.1] - 2020-10-29
### Fixed
- Fixes a minor bug in `setCallbackContext` (described in [#236](https://github.com/plotly/dashR/issues/236)) which prevented pattern-matching callbacks from working properly if one or more `input` statements did not include a selector. [#237](https://github.com/plotly/dashR/pull/237)

## [0.8.0] - 2020-10-27
### Fixed
- Usage of `glue` has been corrected to address [#232](https://github.com/plotly/dashR/issues/232) via [#233](https://github.com/plotly/dashR/pull/233).
Expand Down

2 changes: 1 addition & 1 deletion
DESCRIPTION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
Package: dash
Title: An Interface to the Dash Ecosystem for Authoring Reactive Web Applications
Version: 0.8.0
Version: 0.8.1
Authors@R: c(person("Chris", "Parmer", role = c("aut"), email = "chris@plotly.com"), person("Ryan Patrick", "Kyle", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5829-9867"), email = "ryan@plotly.com"), person("Carson", "Sievert", role = c("aut"), comment = c(ORCID = "0000-0002-4958-2844")), person("Hammad", "Khan", role = c("aut"), comment = c(ORCID = "0000-0003-2479-9841"), email = "hammadkhan@plotly.com"), person(family = "Plotly Technologies", role = "cph")) 
Description: A framework for building analytical web applications, Dash offers a pleasant and productive development experience. No JavaScript required.
Depends:
Expand Down

14 changes: 9 additions & 5 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1054,26 +1054,30 @@ setCallbackContext <- function(callback_elements) {
 function(x) {
 input_id <- splitIdProp(x)[1]
 prop <- splitIdProp(x)[2]

 # The following conditionals check whether the callback is a pattern-matching callback and if it has been triggered. 
 if (startsWith(input_id, "{")){
 id_match <- vapply(callback_elements$inputs, function(x) {
 x <- unlist(x)
 any(x[grepl("id.", names(x))] %in% jsonlite::fromJSON(input_id)[[1]])
 }, logical(1))[[1]]
 } else {
 id_match <- vapply(callback_elements$inputs, function(x) x$id %in% input_id, logical(1))
 id_match <- vapply(callback_elements$inputs, function(x) {
 unlist(x)
 any(x$id %in% input_id)}, logical(1))
 }

 if (startsWith(input_id, "{")){
 prop_match <- vapply(callback_elements$inputs, function(x) {
 x <- unlist(x)
 any(x[names(x) == "property"] %in% prop)
 }, logical(1))[[1]]
 } else {
 prop_match <- vapply(callback_elements$inputs, function(x) x$property %in% prop, logical(1))
 prop_match <- vapply(callback_elements$inputs, function(x) {
 unlist(x)
 any(x$property %in% prop)}, logical(1))
 }

 if (startsWith(input_id, "{")){
 if (length(callback_elements$inputs) == 1 || !is.null(unlist(callback_elements$inputs, recursive = F)$value)) {
 value <- sapply(callback_elements$inputs[id_match & prop_match], `[[`, "value")
Expand Down

127 changes: 127 additions & 0 deletions
tests/integration/callbacks/test_pattern_matching.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,120 @@
"""


graphs_app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
library(plotly)

df <- read.csv(
 file = "https://raw.githubusercontent.com/plotly/datasets/master/gapminderDataFiveYear.csv",
 stringsAsFactor=FALSE,
 check.names=FALSE
)

app <- Dash$new()

app$layout(
 htmlDiv(
 list(
 htmlDiv(
 list(
 dccDropdown(options = lapply(unique(df[,"country"]), function(x) {
 list(label = x, value = x)
 }),
 value = "Canada",
 id = "country",
 style = list(display = "inline-block",
 width = 200)
 ),
 htmlButton(
 "add Chart",
 id = "add-chart",
 n_clicks = 0,
 style = list(display = "inline-block")
 )
 )
 ),
 htmlDiv(id = "container", children=list()),
 htmlDiv(id = "output-delay")
 )
 )
)

create_figure <- function(df, column_x, column_y, country) {
 df <- df[which(df[, "country"] == country),]
 if (column_x == "year") {
 fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "lines")
 } else {
 fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "markers")
 }
 fig <- plotly::layout(fig, plot_bgcolor="lightblue", xaxis = list(title=""),
 yaxis = list(title=""), title=list(text=paste(country, column_y, "vs", column_x),
 xanchor="right", margin_l=10, margin_r=0, margin_b=30))
 return(fig)
}

app$callback(
 output = list(
 output(id = "container", property = "children"),
 output(id = "output-delay", property = "children")
 ),
 params = list(
 input(id = "add-chart", property = "n_clicks"),
 state(id = "country", property = "value"),
 state(id = "container", property = "children")
 ),
 function(n_clicks, country, children) {
 default_column_x <- "year"
 default_column_y <- "gdpPercap"

 new_element <- htmlDiv(
 style = list(width = "23%", display = "inline-block", outline = "thin lightgrey solid", padding = 10),
 children = list(
 dccGraph(
 id = list(type = "dynamic-output", index = n_clicks),
 style = list(height = 300),
 figure = create_figure(df, default_column_x, default_column_y, country)
 ),
 dccDropdown(
 id = list(type = "dynamic-dropdown-x", index = n_clicks),
 options = lapply(colnames(df), function(x) {
 list(label = x, value = x)
 }),
 value = default_column_x
 ),
 dccDropdown(
 id = list(type = "dynamic-dropdown-y", index = n_clicks),
 options = lapply(colnames(df), function(x) {
 list(label = x, value = x)
 }),
 value = default_column_y
 )
 )
 )

 children <- c(children, list(new_element))
 return(list(children, n_clicks))
 }
)

app$callback(
 output(id = list("index" = MATCH, "type" = "dynamic-output"), property = "figure"),
 params = list(
 input(id = list("index" = MATCH, "type" = "dynamic-dropdown-x"), property = "value"),
 input(id = list("index" = MATCH, "type" = "dynamic-dropdown-y"), property = "value"),
 input(id = "country", property = "value")
 ),
 function(column_x, column_y, country) {
 return(create_figure(df, column_x, column_y, country))
 }
)

app$run_server()
"""


def test_rpmc001_pattern_matching_all(dashr):
 dashr.start_server(all_app)
 dashr.find_element("#add-filter").click()
Expand DownExpand Up@@ -370,3 +484,16 @@ def test_rpmc004_pattern_matching_todo(dashr):
 dashr.find_element("#add").click()
 dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"done\\"\\}').click()
 assert dashr.wait_for_text_to_equal("#totals", "1 of 1 items completed - 100%")


def test_rpmc005_pattern_matching_graphs(dashr):
 dashr.start_server(graphs_app)
 dashr.select_dcc_dropdown("#country", "Cameroon")
@rpkylerpkyleOct 30, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I often have a statement like  dashr.wait_for_text_to_equal initially before selecting anything, and then I have an htmlDiv with some content that renders which I can watch -- just in case there's a slight delay, in my (very limited) experience this seems to help avoid flaky tests, and can also take the place of a sleep statement.
@HammadTheOneHammadTheOneOct 30, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds good, I'm going to make a small update to it with those elements, then I'll merge it once the final tests pass.
 dashr.wait_for_text_to_equal("#output-delay", "0")
 dashr.find_element("#add-chart").click()
 dashr.wait_for_text_to_equal("#output-delay", "1")
 dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')
 dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-x\\"\\}', "year")
 dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-y\\"\\}', "pop")
 dashr.percy_snapshot("r-pmc-graphs")
 dashr.wait_for_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Fix setCallbackContext for wildcard and ordinary inputs by HammadTheOne · Pull Request #237 · plotly/dashR · GitHub
Skip to content
Fix setCallbackContext for wildcard and ordinary inputs#237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

HammadTheOne
merged 6 commits into

from

Oct 30, 2020
 Merged


Fix setCallbackContext for wildcard and ordinary inputs
#237
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
80f8cae

Update setCallbackContext


HammadTheOne Oct 29, 2020
eaa9ca2

Adding graphs test


HammadTheOne Oct 29, 2020
b9462c5

Slight fix


HammadTheOne Oct 30, 2020
5834c4e

bump version and update CHANGELOG

Oct 30, 2020
ea95da8

Less flaky test


HammadTheOne Oct 30, 2020
aac2546

Merge branch 'wildcards-patch' of https://github.com/plotly/dashr int…


HammadTheOne Oct 30, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,10 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.8.1] - 2020-10-29
### Fixed
- Fixes a minor bug in `setCallbackContext` (described in [#236](https://github.com/plotly/dashR/issues/236)) which prevented pattern-matching callbacks from working properly if one or more `input` statements did not include a selector. [#237](https://github.com/plotly/dashR/pull/237)

## [0.8.0] - 2020-10-27
### Fixed
- Usage of `glue` has been corrected to address [#232](https://github.com/plotly/dashR/issues/232) via [#233](https://github.com/plotly/dashR/pull/233).
Expand Down

2 changes: 1 addition & 1 deletion
DESCRIPTION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
Package: dash
Title: An Interface to the Dash Ecosystem for Authoring Reactive Web Applications
Version: 0.8.0
Version: 0.8.1
Authors@R: c(person("Chris", "Parmer", role = c("aut"), email = "chris@plotly.com"), person("Ryan Patrick", "Kyle", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5829-9867"), email = "ryan@plotly.com"), person("Carson", "Sievert", role = c("aut"), comment = c(ORCID = "0000-0002-4958-2844")), person("Hammad", "Khan", role = c("aut"), comment = c(ORCID = "0000-0003-2479-9841"), email = "hammadkhan@plotly.com"), person(family = "Plotly Technologies", role = "cph")) 
Description: A framework for building analytical web applications, Dash offers a pleasant and productive development experience. No JavaScript required.
Depends:
Expand Down

14 changes: 9 additions & 5 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1054,26 +1054,30 @@ setCallbackContext <- function(callback_elements) {
 function(x) {
 input_id <- splitIdProp(x)[1]
 prop <- splitIdProp(x)[2]

 # The following conditionals check whether the callback is a pattern-matching callback and if it has been triggered. 
 if (startsWith(input_id, "{")){
 id_match <- vapply(callback_elements$inputs, function(x) {
 x <- unlist(x)
 any(x[grepl("id.", names(x))] %in% jsonlite::fromJSON(input_id)[[1]])
 }, logical(1))[[1]]
 } else {
 id_match <- vapply(callback_elements$inputs, function(x) x$id %in% input_id, logical(1))
 id_match <- vapply(callback_elements$inputs, function(x) {
 unlist(x)
 any(x$id %in% input_id)}, logical(1))
 }

 if (startsWith(input_id, "{")){
 prop_match <- vapply(callback_elements$inputs, function(x) {
 x <- unlist(x)
 any(x[names(x) == "property"] %in% prop)
 }, logical(1))[[1]]
 } else {
 prop_match <- vapply(callback_elements$inputs, function(x) x$property %in% prop, logical(1))
 prop_match <- vapply(callback_elements$inputs, function(x) {
 unlist(x)
 any(x$property %in% prop)}, logical(1))
 }

 if (startsWith(input_id, "{")){
 if (length(callback_elements$inputs) == 1 || !is.null(unlist(callback_elements$inputs, recursive = F)$value)) {
 value <- sapply(callback_elements$inputs[id_match & prop_match], `[[`, "value")
Expand Down

127 changes: 127 additions & 0 deletions
tests/integration/callbacks/test_pattern_matching.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,120 @@
"""


graphs_app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
library(plotly)

df <- read.csv(
 file = "https://raw.githubusercontent.com/plotly/datasets/master/gapminderDataFiveYear.csv",
 stringsAsFactor=FALSE,
 check.names=FALSE
)

app <- Dash$new()

app$layout(
 htmlDiv(
 list(
 htmlDiv(
 list(
 dccDropdown(options = lapply(unique(df[,"country"]), function(x) {
 list(label = x, value = x)
 }),
 value = "Canada",
 id = "country",
 style = list(display = "inline-block",
 width = 200)
 ),
 htmlButton(
 "add Chart",
 id = "add-chart",
 n_clicks = 0,
 style = list(display = "inline-block")
 )
 )
 ),
 htmlDiv(id = "container", children=list()),
 htmlDiv(id = "output-delay")
 )
 )
)

create_figure <- function(df, column_x, column_y, country) {
 df <- df[which(df[, "country"] == country),]
 if (column_x == "year") {
 fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "lines")
 } else {
 fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "markers")
 }
 fig <- plotly::layout(fig, plot_bgcolor="lightblue", xaxis = list(title=""),
 yaxis = list(title=""), title=list(text=paste(country, column_y, "vs", column_x),
 xanchor="right", margin_l=10, margin_r=0, margin_b=30))
 return(fig)
}

app$callback(
 output = list(
 output(id = "container", property = "children"),
 output(id = "output-delay", property = "children")
 ),
 params = list(
 input(id = "add-chart", property = "n_clicks"),
 state(id = "country", property = "value"),
 state(id = "container", property = "children")
 ),
 function(n_clicks, country, children) {
 default_column_x <- "year"
 default_column_y <- "gdpPercap"

 new_element <- htmlDiv(
 style = list(width = "23%", display = "inline-block", outline = "thin lightgrey solid", padding = 10),
 children = list(
 dccGraph(
 id = list(type = "dynamic-output", index = n_clicks),
 style = list(height = 300),
 figure = create_figure(df, default_column_x, default_column_y, country)
 ),
 dccDropdown(
 id = list(type = "dynamic-dropdown-x", index = n_clicks),
 options = lapply(colnames(df), function(x) {
 list(label = x, value = x)
 }),
 value = default_column_x
 ),
 dccDropdown(
 id = list(type = "dynamic-dropdown-y", index = n_clicks),
 options = lapply(colnames(df), function(x) {
 list(label = x, value = x)
 }),
 value = default_column_y
 )
 )
 )

 children <- c(children, list(new_element))
 return(list(children, n_clicks))
 }
)

app$callback(
 output(id = list("index" = MATCH, "type" = "dynamic-output"), property = "figure"),
 params = list(
 input(id = list("index" = MATCH, "type" = "dynamic-dropdown-x"), property = "value"),
 input(id = list("index" = MATCH, "type" = "dynamic-dropdown-y"), property = "value"),
 input(id = "country", property = "value")
 ),
 function(column_x, column_y, country) {
 return(create_figure(df, column_x, column_y, country))
 }
)

app$run_server()
"""


def test_rpmc001_pattern_matching_all(dashr):
 dashr.start_server(all_app)
 dashr.find_element("#add-filter").click()
Expand DownExpand Up@@ -370,3 +484,16 @@ def test_rpmc004_pattern_matching_todo(dashr):
 dashr.find_element("#add").click()
 dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"done\\"\\}').click()
 assert dashr.wait_for_text_to_equal("#totals", "1 of 1 items completed - 100%")


def test_rpmc005_pattern_matching_graphs(dashr):
 dashr.start_server(graphs_app)
 dashr.select_dcc_dropdown("#country", "Cameroon")
@rpkylerpkyleOct 30, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I often have a statement like  dashr.wait_for_text_to_equal initially before selecting anything, and then I have an htmlDiv with some content that renders which I can watch -- just in case there's a slight delay, in my (very limited) experience this seems to help avoid flaky tests, and can also take the place of a sleep statement.
@HammadTheOneHammadTheOneOct 30, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds good, I'm going to make a small update to it with those elements, then I'll merge it once the final tests pass.
 dashr.wait_for_text_to_equal("#output-delay", "0")
 dashr.find_element("#add-chart").click()
 dashr.wait_for_text_to_equal("#output-delay", "1")
 dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')
 dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-x\\"\\}', "year")
 dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-y\\"\\}', "pop")
 dashr.percy_snapshot("r-pmc-graphs")
 dashr.wait_for_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
Fix setCallbackContext for wildcard and ordinary inputs by HammadTheOne · Pull Request #237 · plotly/dashR · GitHub
Skip to content
Fix setCallbackContext for wildcard and ordinary inputs#237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

HammadTheOne
merged 6 commits into

from

Oct 30, 2020
 Merged


Fix setCallbackContext for wildcard and ordinary inputs
#237
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
80f8cae

Update setCallbackContext


HammadTheOne Oct 29, 2020
eaa9ca2

Adding graphs test


HammadTheOne Oct 29, 2020
b9462c5

Slight fix


HammadTheOne Oct 30, 2020
5834c4e

bump version and update CHANGELOG

Oct 30, 2020
ea95da8

Less flaky test


HammadTheOne Oct 30, 2020
aac2546

Merge branch 'wildcards-patch' of https://github.com/plotly/dashr int…


HammadTheOne Oct 30, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,10 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.8.1] - 2020-10-29
### Fixed
- Fixes a minor bug in `setCallbackContext` (described in [#236](https://github.com/plotly/dashR/issues/236)) which prevented pattern-matching callbacks from working properly if one or more `input` statements did not include a selector. [#237](https://github.com/plotly/dashR/pull/237)

## [0.8.0] - 2020-10-27
### Fixed
- Usage of `glue` has been corrected to address [#232](https://github.com/plotly/dashR/issues/232) via [#233](https://github.com/plotly/dashR/pull/233).
Expand Down

2 changes: 1 addition & 1 deletion
DESCRIPTION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
Package: dash
Title: An Interface to the Dash Ecosystem for Authoring Reactive Web Applications
Version: 0.8.0
Version: 0.8.1
Authors@R: c(person("Chris", "Parmer", role = c("aut"), email = "chris@plotly.com"), person("Ryan Patrick", "Kyle", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5829-9867"), email = "ryan@plotly.com"), person("Carson", "Sievert", role = c("aut"), comment = c(ORCID = "0000-0002-4958-2844")), person("Hammad", "Khan", role = c("aut"), comment = c(ORCID = "0000-0003-2479-9841"), email = "hammadkhan@plotly.com"), person(family = "Plotly Technologies", role = "cph")) 
Description: A framework for building analytical web applications, Dash offers a pleasant and productive development experience. No JavaScript required.
Depends:
Expand Down

14 changes: 9 additions & 5 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1054,26 +1054,30 @@ setCallbackContext <- function(callback_elements) {
 function(x) {
 input_id <- splitIdProp(x)[1]
 prop <- splitIdProp(x)[2]

 # The following conditionals check whether the callback is a pattern-matching callback and if it has been triggered. 
 if (startsWith(input_id, "{")){
 id_match <- vapply(callback_elements$inputs, function(x) {
 x <- unlist(x)
 any(x[grepl("id.", names(x))] %in% jsonlite::fromJSON(input_id)[[1]])
 }, logical(1))[[1]]
 } else {
 id_match <- vapply(callback_elements$inputs, function(x) x$id %in% input_id, logical(1))
 id_match <- vapply(callback_elements$inputs, function(x) {
 unlist(x)
 any(x$id %in% input_id)}, logical(1))
 }

 if (startsWith(input_id, "{")){
 prop_match <- vapply(callback_elements$inputs, function(x) {
 x <- unlist(x)
 any(x[names(x) == "property"] %in% prop)
 }, logical(1))[[1]]
 } else {
 prop_match <- vapply(callback_elements$inputs, function(x) x$property %in% prop, logical(1))
 prop_match <- vapply(callback_elements$inputs, function(x) {
 unlist(x)
 any(x$property %in% prop)}, logical(1))
 }

 if (startsWith(input_id, "{")){
 if (length(callback_elements$inputs) == 1 || !is.null(unlist(callback_elements$inputs, recursive = F)$value)) {
 value <- sapply(callback_elements$inputs[id_match & prop_match], `[[`, "value")
Expand Down

127 changes: 127 additions & 0 deletions
tests/integration/callbacks/test_pattern_matching.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,120 @@
"""


graphs_app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
library(plotly)

df <- read.csv(
 file = "https://raw.githubusercontent.com/plotly/datasets/master/gapminderDataFiveYear.csv",
 stringsAsFactor=FALSE,
 check.names=FALSE
)

app <- Dash$new()

app$layout(
 htmlDiv(
 list(
 htmlDiv(
 list(
 dccDropdown(options = lapply(unique(df[,"country"]), function(x) {
 list(label = x, value = x)
 }),
 value = "Canada",
 id = "country",
 style = list(display = "inline-block",
 width = 200)
 ),
 htmlButton(
 "add Chart",
 id = "add-chart",
 n_clicks = 0,
 style = list(display = "inline-block")
 )
 )
 ),
 htmlDiv(id = "container", children=list()),
 htmlDiv(id = "output-delay")
 )
 )
)

create_figure <- function(df, column_x, column_y, country) {
 df <- df[which(df[, "country"] == country),]
 if (column_x == "year") {
 fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "lines")
 } else {
 fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "markers")
 }
 fig <- plotly::layout(fig, plot_bgcolor="lightblue", xaxis = list(title=""),
 yaxis = list(title=""), title=list(text=paste(country, column_y, "vs", column_x),
 xanchor="right", margin_l=10, margin_r=0, margin_b=30))
 return(fig)
}

app$callback(
 output = list(
 output(id = "container", property = "children"),
 output(id = "output-delay", property = "children")
 ),
 params = list(
 input(id = "add-chart", property = "n_clicks"),
 state(id = "country", property = "value"),
 state(id = "container", property = "children")
 ),
 function(n_clicks, country, children) {
 default_column_x <- "year"
 default_column_y <- "gdpPercap"

 new_element <- htmlDiv(
 style = list(width = "23%", display = "inline-block", outline = "thin lightgrey solid", padding = 10),
 children = list(
 dccGraph(
 id = list(type = "dynamic-output", index = n_clicks),
 style = list(height = 300),
 figure = create_figure(df, default_column_x, default_column_y, country)
 ),
 dccDropdown(
 id = list(type = "dynamic-dropdown-x", index = n_clicks),
 options = lapply(colnames(df), function(x) {
 list(label = x, value = x)
 }),
 value = default_column_x
 ),
 dccDropdown(
 id = list(type = "dynamic-dropdown-y", index = n_clicks),
 options = lapply(colnames(df), function(x) {
 list(label = x, value = x)
 }),
 value = default_column_y
 )
 )
 )

 children <- c(children, list(new_element))
 return(list(children, n_clicks))
 }
)

app$callback(
 output(id = list("index" = MATCH, "type" = "dynamic-output"), property = "figure"),
 params = list(
 input(id = list("index" = MATCH, "type" = "dynamic-dropdown-x"), property = "value"),
 input(id = list("index" = MATCH, "type" = "dynamic-dropdown-y"), property = "value"),
 input(id = "country", property = "value")
 ),
 function(column_x, column_y, country) {
 return(create_figure(df, column_x, column_y, country))
 }
)

app$run_server()
"""


def test_rpmc001_pattern_matching_all(dashr):
 dashr.start_server(all_app)
 dashr.find_element("#add-filter").click()
Expand DownExpand Up@@ -370,3 +484,16 @@ def test_rpmc004_pattern_matching_todo(dashr):
 dashr.find_element("#add").click()
 dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"done\\"\\}').click()
 assert dashr.wait_for_text_to_equal("#totals", "1 of 1 items completed - 100%")


def test_rpmc005_pattern_matching_graphs(dashr):
 dashr.start_server(graphs_app)
 dashr.select_dcc_dropdown("#country", "Cameroon")
@rpkylerpkyleOct 30, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I often have a statement like  dashr.wait_for_text_to_equal initially before selecting anything, and then I have an htmlDiv with some content that renders which I can watch -- just in case there's a slight delay, in my (very limited) experience this seems to help avoid flaky tests, and can also take the place of a sleep statement.
@HammadTheOneHammadTheOneOct 30, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds good, I'm going to make a small update to it with those elements, then I'll merge it once the final tests pass.
 dashr.wait_for_text_to_equal("#output-delay", "0")
 dashr.find_element("#add-chart").click()
 dashr.wait_for_text_to_equal("#output-delay", "1")
 dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')
 dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-x\\"\\}', "year")
 dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-y\\"\\}', "pop")
 dashr.percy_snapshot("r-pmc-graphs")
 dashr.wait_for_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
Fix setCallbackContext for wildcard and ordinary inputs by HammadTheOne · Pull Request #237 · plotly/dashR · GitHub
Skip to content
Fix setCallbackContext for wildcard and ordinary inputs#237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

HammadTheOne
merged 6 commits into

from

Oct 30, 2020
 Merged


Fix setCallbackContext for wildcard and ordinary inputs
#237
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
80f8cae

Update setCallbackContext


HammadTheOne Oct 29, 2020
eaa9ca2

Adding graphs test


HammadTheOne Oct 29, 2020
b9462c5

Slight fix


HammadTheOne Oct 30, 2020
5834c4e

bump version and update CHANGELOG

Oct 30, 2020
ea95da8

Less flaky test


HammadTheOne Oct 30, 2020
aac2546

Merge branch 'wildcards-patch' of https://github.com/plotly/dashr int…


HammadTheOne Oct 30, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,10 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.8.1] - 2020-10-29
### Fixed
- Fixes a minor bug in `setCallbackContext` (described in [#236](https://github.com/plotly/dashR/issues/236)) which prevented pattern-matching callbacks from working properly if one or more `input` statements did not include a selector. [#237](https://github.com/plotly/dashR/pull/237)

## [0.8.0] - 2020-10-27
### Fixed
- Usage of `glue` has been corrected to address [#232](https://github.com/plotly/dashR/issues/232) via [#233](https://github.com/plotly/dashR/pull/233).
Expand Down

2 changes: 1 addition & 1 deletion
DESCRIPTION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
Package: dash
Title: An Interface to the Dash Ecosystem for Authoring Reactive Web Applications
Version: 0.8.0
Version: 0.8.1
Authors@R: c(person("Chris", "Parmer", role = c("aut"), email = "chris@plotly.com"), person("Ryan Patrick", "Kyle", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5829-9867"), email = "ryan@plotly.com"), person("Carson", "Sievert", role = c("aut"), comment = c(ORCID = "0000-0002-4958-2844")), person("Hammad", "Khan", role = c("aut"), comment = c(ORCID = "0000-0003-2479-9841"), email = "hammadkhan@plotly.com"), person(family = "Plotly Technologies", role = "cph")) 
Description: A framework for building analytical web applications, Dash offers a pleasant and productive development experience. No JavaScript required.
Depends:
Expand Down

14 changes: 9 additions & 5 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1054,26 +1054,30 @@ setCallbackContext <- function(callback_elements) {
 function(x) {
 input_id <- splitIdProp(x)[1]
 prop <- splitIdProp(x)[2]

 # The following conditionals check whether the callback is a pattern-matching callback and if it has been triggered. 
 if (startsWith(input_id, "{")){
 id_match <- vapply(callback_elements$inputs, function(x) {
 x <- unlist(x)
 any(x[grepl("id.", names(x))] %in% jsonlite::fromJSON(input_id)[[1]])
 }, logical(1))[[1]]
 } else {
 id_match <- vapply(callback_elements$inputs, function(x) x$id %in% input_id, logical(1))
 id_match <- vapply(callback_elements$inputs, function(x) {
 unlist(x)
 any(x$id %in% input_id)}, logical(1))
 }

 if (startsWith(input_id, "{")){
 prop_match <- vapply(callback_elements$inputs, function(x) {
 x <- unlist(x)
 any(x[names(x) == "property"] %in% prop)
 }, logical(1))[[1]]
 } else {
 prop_match <- vapply(callback_elements$inputs, function(x) x$property %in% prop, logical(1))
 prop_match <- vapply(callback_elements$inputs, function(x) {
 unlist(x)
 any(x$property %in% prop)}, logical(1))
 }

 if (startsWith(input_id, "{")){
 if (length(callback_elements$inputs) == 1 || !is.null(unlist(callback_elements$inputs, recursive = F)$value)) {
 value <- sapply(callback_elements$inputs[id_match & prop_match], `[[`, "value")
Expand Down

127 changes: 127 additions & 0 deletions
tests/integration/callbacks/test_pattern_matching.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,120 @@
"""


graphs_app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
library(plotly)

df <- read.csv(
 file = "https://raw.githubusercontent.com/plotly/datasets/master/gapminderDataFiveYear.csv",
 stringsAsFactor=FALSE,
 check.names=FALSE
)

app <- Dash$new()

app$layout(
 htmlDiv(
 list(
 htmlDiv(
 list(
 dccDropdown(options = lapply(unique(df[,"country"]), function(x) {
 list(label = x, value = x)
 }),
 value = "Canada",
 id = "country",
 style = list(display = "inline-block",
 width = 200)
 ),
 htmlButton(
 "add Chart",
 id = "add-chart",
 n_clicks = 0,
 style = list(display = "inline-block")
 )
 )
 ),
 htmlDiv(id = "container", children=list()),
 htmlDiv(id = "output-delay")
 )
 )
)

create_figure <- function(df, column_x, column_y, country) {
 df <- df[which(df[, "country"] == country),]
 if (column_x == "year") {
 fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "lines")
 } else {
 fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "markers")
 }
 fig <- plotly::layout(fig, plot_bgcolor="lightblue", xaxis = list(title=""),
 yaxis = list(title=""), title=list(text=paste(country, column_y, "vs", column_x),
 xanchor="right", margin_l=10, margin_r=0, margin_b=30))
 return(fig)
}

app$callback(
 output = list(
 output(id = "container", property = "children"),
 output(id = "output-delay", property = "children")
 ),
 params = list(
 input(id = "add-chart", property = "n_clicks"),
 state(id = "country", property = "value"),
 state(id = "container", property = "children")
 ),
 function(n_clicks, country, children) {
 default_column_x <- "year"
 default_column_y <- "gdpPercap"

 new_element <- htmlDiv(
 style = list(width = "23%", display = "inline-block", outline = "thin lightgrey solid", padding = 10),
 children = list(
 dccGraph(
 id = list(type = "dynamic-output", index = n_clicks),
 style = list(height = 300),
 figure = create_figure(df, default_column_x, default_column_y, country)
 ),
 dccDropdown(
 id = list(type = "dynamic-dropdown-x", index = n_clicks),
 options = lapply(colnames(df), function(x) {
 list(label = x, value = x)
 }),
 value = default_column_x
 ),
 dccDropdown(
 id = list(type = "dynamic-dropdown-y", index = n_clicks),
 options = lapply(colnames(df), function(x) {
 list(label = x, value = x)
 }),
 value = default_column_y
 )
 )
 )

 children <- c(children, list(new_element))
 return(list(children, n_clicks))
 }
)

app$callback(
 output(id = list("index" = MATCH, "type" = "dynamic-output"), property = "figure"),
 params = list(
 input(id = list("index" = MATCH, "type" = "dynamic-dropdown-x"), property = "value"),
 input(id = list("index" = MATCH, "type" = "dynamic-dropdown-y"), property = "value"),
 input(id = "country", property = "value")
 ),
 function(column_x, column_y, country) {
 return(create_figure(df, column_x, column_y, country))
 }
)

app$run_server()
"""


def test_rpmc001_pattern_matching_all(dashr):
 dashr.start_server(all_app)
 dashr.find_element("#add-filter").click()
Expand DownExpand Up@@ -370,3 +484,16 @@ def test_rpmc004_pattern_matching_todo(dashr):
 dashr.find_element("#add").click()
 dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"done\\"\\}').click()
 assert dashr.wait_for_text_to_equal("#totals", "1 of 1 items completed - 100%")


def test_rpmc005_pattern_matching_graphs(dashr):
 dashr.start_server(graphs_app)
 dashr.select_dcc_dropdown("#country", "Cameroon")
@rpkylerpkyleOct 30, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I often have a statement like  dashr.wait_for_text_to_equal initially before selecting anything, and then I have an htmlDiv with some content that renders which I can watch -- just in case there's a slight delay, in my (very limited) experience this seems to help avoid flaky tests, and can also take the place of a sleep statement.
@HammadTheOneHammadTheOneOct 30, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds good, I'm going to make a small update to it with those elements, then I'll merge it once the final tests pass.
 dashr.wait_for_text_to_equal("#output-delay", "0")
 dashr.find_element("#add-chart").click()
 dashr.wait_for_text_to_equal("#output-delay", "1")
 dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')
 dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-x\\"\\}', "year")
 dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-y\\"\\}', "pop")
 dashr.percy_snapshot("r-pmc-graphs")
 dashr.wait_for_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
Fix setCallbackContext for wildcard and ordinary inputs by HammadTheOne · Pull Request #237 · plotly/dashR · GitHub
Skip to content
Fix setCallbackContext for wildcard and ordinary inputs#237

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

HammadTheOne
merged 6 commits into

from

Oct 30, 2020
 Merged


Fix setCallbackContext for wildcard and ordinary inputs
#237
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


6 commits


Select commit
Hold shift + click to select a range
80f8cae

Update setCallbackContext


HammadTheOne Oct 29, 2020
eaa9ca2

Adding graphs test


HammadTheOne Oct 29, 2020
b9462c5

Slight fix


HammadTheOne Oct 30, 2020
5834c4e

bump version and update CHANGELOG

Oct 30, 2020
ea95da8

Less flaky test


HammadTheOne Oct 30, 2020
aac2546

Merge branch 'wildcards-patch' of https://github.com/plotly/dashr int…


HammadTheOne Oct 30, 2020

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


4 changes: 4 additions & 0 deletions
CHANGELOG.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,6 +2,10 @@
All notable changes to `dash` will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.8.1] - 2020-10-29
### Fixed
- Fixes a minor bug in `setCallbackContext` (described in [#236](https://github.com/plotly/dashR/issues/236)) which prevented pattern-matching callbacks from working properly if one or more `input` statements did not include a selector. [#237](https://github.com/plotly/dashR/pull/237)

## [0.8.0] - 2020-10-27
### Fixed
- Usage of `glue` has been corrected to address [#232](https://github.com/plotly/dashR/issues/232) via [#233](https://github.com/plotly/dashR/pull/233).
Expand Down

2 changes: 1 addition & 1 deletion
DESCRIPTION

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
Package: dash
Title: An Interface to the Dash Ecosystem for Authoring Reactive Web Applications
Version: 0.8.0
Version: 0.8.1
Authors@R: c(person("Chris", "Parmer", role = c("aut"), email = "chris@plotly.com"), person("Ryan Patrick", "Kyle", role = c("aut", "cre"), comment = c(ORCID = "0000-0001-5829-9867"), email = "ryan@plotly.com"), person("Carson", "Sievert", role = c("aut"), comment = c(ORCID = "0000-0002-4958-2844")), person("Hammad", "Khan", role = c("aut"), comment = c(ORCID = "0000-0003-2479-9841"), email = "hammadkhan@plotly.com"), person(family = "Plotly Technologies", role = "cph")) 
Description: A framework for building analytical web applications, Dash offers a pleasant and productive development experience. No JavaScript required.
Depends:
Expand Down

14 changes: 9 additions & 5 deletions
R/utils.R

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1054,26 +1054,30 @@ setCallbackContext <- function(callback_elements) {
 function(x) {
 input_id <- splitIdProp(x)[1]
 prop <- splitIdProp(x)[2]

 # The following conditionals check whether the callback is a pattern-matching callback and if it has been triggered. 
 if (startsWith(input_id, "{")){
 id_match <- vapply(callback_elements$inputs, function(x) {
 x <- unlist(x)
 any(x[grepl("id.", names(x))] %in% jsonlite::fromJSON(input_id)[[1]])
 }, logical(1))[[1]]
 } else {
 id_match <- vapply(callback_elements$inputs, function(x) x$id %in% input_id, logical(1))
 id_match <- vapply(callback_elements$inputs, function(x) {
 unlist(x)
 any(x$id %in% input_id)}, logical(1))
 }

 if (startsWith(input_id, "{")){
 prop_match <- vapply(callback_elements$inputs, function(x) {
 x <- unlist(x)
 any(x[names(x) == "property"] %in% prop)
 }, logical(1))[[1]]
 } else {
 prop_match <- vapply(callback_elements$inputs, function(x) x$property %in% prop, logical(1))
 prop_match <- vapply(callback_elements$inputs, function(x) {
 unlist(x)
 any(x$property %in% prop)}, logical(1))
 }

 if (startsWith(input_id, "{")){
 if (length(callback_elements$inputs) == 1 || !is.null(unlist(callback_elements$inputs, recursive = F)$value)) {
 value <- sapply(callback_elements$inputs[id_match & prop_match], `[[`, "value")
Expand Down

127 changes: 127 additions & 0 deletions
tests/integration/callbacks/test_pattern_matching.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -318,6 +318,120 @@
"""


graphs_app = """
library(dash)
library(dashHtmlComponents)
library(dashCoreComponents)
library(plotly)

df <- read.csv(
 file = "https://raw.githubusercontent.com/plotly/datasets/master/gapminderDataFiveYear.csv",
 stringsAsFactor=FALSE,
 check.names=FALSE
)

app <- Dash$new()

app$layout(
 htmlDiv(
 list(
 htmlDiv(
 list(
 dccDropdown(options = lapply(unique(df[,"country"]), function(x) {
 list(label = x, value = x)
 }),
 value = "Canada",
 id = "country",
 style = list(display = "inline-block",
 width = 200)
 ),
 htmlButton(
 "add Chart",
 id = "add-chart",
 n_clicks = 0,
 style = list(display = "inline-block")
 )
 )
 ),
 htmlDiv(id = "container", children=list()),
 htmlDiv(id = "output-delay")
 )
 )
)

create_figure <- function(df, column_x, column_y, country) {
 df <- df[which(df[, "country"] == country),]
 if (column_x == "year") {
 fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "lines")
 } else {
 fig <- plot_ly(df, x = df[,column_x], y = df[,column_y], name = column_x, type = "scatter", mode = "markers")
 }
 fig <- plotly::layout(fig, plot_bgcolor="lightblue", xaxis = list(title=""),
 yaxis = list(title=""), title=list(text=paste(country, column_y, "vs", column_x),
 xanchor="right", margin_l=10, margin_r=0, margin_b=30))
 return(fig)
}

app$callback(
 output = list(
 output(id = "container", property = "children"),
 output(id = "output-delay", property = "children")
 ),
 params = list(
 input(id = "add-chart", property = "n_clicks"),
 state(id = "country", property = "value"),
 state(id = "container", property = "children")
 ),
 function(n_clicks, country, children) {
 default_column_x <- "year"
 default_column_y <- "gdpPercap"

 new_element <- htmlDiv(
 style = list(width = "23%", display = "inline-block", outline = "thin lightgrey solid", padding = 10),
 children = list(
 dccGraph(
 id = list(type = "dynamic-output", index = n_clicks),
 style = list(height = 300),
 figure = create_figure(df, default_column_x, default_column_y, country)
 ),
 dccDropdown(
 id = list(type = "dynamic-dropdown-x", index = n_clicks),
 options = lapply(colnames(df), function(x) {
 list(label = x, value = x)
 }),
 value = default_column_x
 ),
 dccDropdown(
 id = list(type = "dynamic-dropdown-y", index = n_clicks),
 options = lapply(colnames(df), function(x) {
 list(label = x, value = x)
 }),
 value = default_column_y
 )
 )
 )

 children <- c(children, list(new_element))
 return(list(children, n_clicks))
 }
)

app$callback(
 output(id = list("index" = MATCH, "type" = "dynamic-output"), property = "figure"),
 params = list(
 input(id = list("index" = MATCH, "type" = "dynamic-dropdown-x"), property = "value"),
 input(id = list("index" = MATCH, "type" = "dynamic-dropdown-y"), property = "value"),
 input(id = "country", property = "value")
 ),
 function(column_x, column_y, country) {
 return(create_figure(df, column_x, column_y, country))
 }
)

app$run_server()
"""


def test_rpmc001_pattern_matching_all(dashr):
 dashr.start_server(all_app)
 dashr.find_element("#add-filter").click()
Expand DownExpand Up@@ -370,3 +484,16 @@ def test_rpmc004_pattern_matching_todo(dashr):
 dashr.find_element("#add").click()
 dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"done\\"\\}').click()
 assert dashr.wait_for_text_to_equal("#totals", "1 of 1 items completed - 100%")


def test_rpmc005_pattern_matching_graphs(dashr):
 dashr.start_server(graphs_app)
 dashr.select_dcc_dropdown("#country", "Cameroon")
@rpkylerpkyleOct 30, 2020

Copy link


Copy Markdown

Contributor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I often have a statement like  dashr.wait_for_text_to_equal initially before selecting anything, and then I have an htmlDiv with some content that renders which I can watch -- just in case there's a slight delay, in my (very limited) experience this seems to help avoid flaky tests, and can also take the place of a sleep statement.
@HammadTheOneHammadTheOneOct 30, 2020

Copy link


Copy Markdown

ContributorAuthor
Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds good, I'm going to make a small update to it with those elements, then I'll merge it once the final tests pass.
 dashr.wait_for_text_to_equal("#output-delay", "0")
 dashr.find_element("#add-chart").click()
 dashr.wait_for_text_to_equal("#output-delay", "1")
 dashr.find_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')
 dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-x\\"\\}', "year")
 dashr.select_dcc_dropdown('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-dropdown-y\\"\\}', "pop")
 dashr.percy_snapshot("r-pmc-graphs")
 dashr.wait_for_element('#\\{\\"index\\"\\:1\\,\\"type\\"\\:\\"dynamic-output\\"\\}')