From 96374da51e795c18a4acb82753469e9c686ab0ca Mon Sep 17 00:00:00 2001 From: Alexander Wang Date: Sat, 24 Dec 2022 12:45:12 -0800 Subject: [PATCH 1/2] fix icon query param escaping --- d2renderers/d2svg/d2svg.go | 5 +- e2etests/e2e_test.go | 1 + e2etests/regression_test.go | 7 +++ .../query_param_escape/dagre/board.exp.json | 58 +++++++++++++++++++ .../query_param_escape/dagre/sketch.exp.svg | 31 ++++++++++ .../query_param_escape/elk/board.exp.json | 58 +++++++++++++++++++ .../query_param_escape/elk/sketch.exp.svg | 31 ++++++++++ 7 files changed, 189 insertions(+), 2 deletions(-) create mode 100644 e2etests/testdata/regression/query_param_escape/dagre/board.exp.json create mode 100644 e2etests/testdata/regression/query_param_escape/dagre/sketch.exp.svg create mode 100644 e2etests/testdata/regression/query_param_escape/elk/board.exp.json create mode 100644 e2etests/testdata/regression/query_param_escape/elk/sketch.exp.svg diff --git a/d2renderers/d2svg/d2svg.go b/d2renderers/d2svg/d2svg.go index 46ae19a2d..07e0f84ed 100644 --- a/d2renderers/d2svg/d2svg.go +++ b/d2renderers/d2svg/d2svg.go @@ -8,6 +8,7 @@ import ( "errors" "fmt" "hash/fnv" + "html" "io" "sort" "strings" @@ -656,7 +657,7 @@ func drawShape(writer io.Writer, targetShape d2target.Shape, sketchRunner *d2ske case d2target.ShapeImage: fmt.Fprintf(writer, ``, - targetShape.Icon.String(), + html.EscapeString(targetShape.Icon.String()), targetShape.Pos.X, targetShape.Pos.Y, targetShape.Width, targetShape.Height, style) // TODO should standardize "" to rectangle @@ -716,7 +717,7 @@ func drawShape(writer io.Writer, targetShape d2target.Shape, sketchRunner *d2ske tl := iconPosition.GetPointOnBox(box, label.PADDING, float64(iconSize), float64(iconSize)) fmt.Fprintf(writer, ``, - targetShape.Icon.String(), + html.EscapeString(targetShape.Icon.String()), tl.X, tl.Y, iconSize, diff --git a/e2etests/e2e_test.go b/e2etests/e2e_test.go index df76d986a..ec6a2e2cc 100644 --- a/e2etests/e2e_test.go +++ b/e2etests/e2e_test.go @@ -139,6 +139,7 @@ func run(t *testing.T, tc testCase) { defer os.Remove(pathGotSVG) } + // Check that it's valid SVG var xmlParsed interface{} err = xml.Unmarshal(svgBytes, &xmlParsed) assert.Success(t, err) diff --git a/e2etests/regression_test.go b/e2etests/regression_test.go index 6498d9ef3..966e03af2 100644 --- a/e2etests/regression_test.go +++ b/e2etests/regression_test.go @@ -171,6 +171,13 @@ build_workflow: lambda-build.yaml { S3 <-> Terraform: Pulls zip to deploy Terraform -> AWS: Changes the live lambdas } +`, + }, + { + name: "query_param_escape", + script: `my network: { + icon: https://icons.terrastruct.com/infra/019-network.svg?fuga=1&hoge +} `, }, } diff --git a/e2etests/testdata/regression/query_param_escape/dagre/board.exp.json b/e2etests/testdata/regression/query_param_escape/dagre/board.exp.json new file mode 100644 index 000000000..fb0febb97 --- /dev/null +++ b/e2etests/testdata/regression/query_param_escape/dagre/board.exp.json @@ -0,0 +1,58 @@ +{ + "name": "", + "fontFamily": "SourceSansPro", + "shapes": [ + { + "id": "my network", + "type": "", + "pos": { + "x": 0, + "y": 0 + }, + "width": 190, + "height": 152, + "opacity": 1, + "strokeDash": 0, + "strokeWidth": 2, + "borderRadius": 0, + "fill": "#F7F8FE", + "stroke": "#0D32B2", + "shadow": false, + "3d": false, + "multiple": false, + "tooltip": "", + "link": "", + "icon": { + "Scheme": "https", + "Opaque": "", + "User": null, + "Host": "icons.terrastruct.com", + "Path": "/infra/019-network.svg", + "RawPath": "", + "ForceQuery": false, + "RawQuery": "fuga=1&hoge", + "Fragment": "", + "RawFragment": "" + }, + "iconPosition": "INSIDE_MIDDLE_CENTER", + "blend": false, + "fields": null, + "methods": null, + "columns": null, + "label": "my network", + "fontSize": 16, + "fontFamily": "DEFAULT", + "language": "", + "color": "#0A0F25", + "italic": false, + "bold": true, + "underline": false, + "labelWidth": 90, + "labelHeight": 26, + "labelPosition": "INSIDE_TOP_CENTER", + "zIndex": 0, + "level": 1 + } + ], + "connections": [] +} diff --git a/e2etests/testdata/regression/query_param_escape/dagre/sketch.exp.svg b/e2etests/testdata/regression/query_param_escape/dagre/sketch.exp.svg new file mode 100644 index 000000000..f9fe5a482 --- /dev/null +++ b/e2etests/testdata/regression/query_param_escape/dagre/sketch.exp.svg @@ -0,0 +1,31 @@ + +my network + + + \ No newline at end of file diff --git a/e2etests/testdata/regression/query_param_escape/elk/board.exp.json b/e2etests/testdata/regression/query_param_escape/elk/board.exp.json new file mode 100644 index 000000000..bce062b6f --- /dev/null +++ b/e2etests/testdata/regression/query_param_escape/elk/board.exp.json @@ -0,0 +1,58 @@ +{ + "name": "", + "fontFamily": "SourceSansPro", + "shapes": [ + { + "id": "my network", + "type": "", + "pos": { + "x": 12, + "y": 12 + }, + "width": 190, + "height": 152, + "opacity": 1, + "strokeDash": 0, + "strokeWidth": 2, + "borderRadius": 0, + "fill": "#F7F8FE", + "stroke": "#0D32B2", + "shadow": false, + "3d": false, + "multiple": false, + "tooltip": "", + "link": "", + "icon": { + "Scheme": "https", + "Opaque": "", + "User": null, + "Host": "icons.terrastruct.com", + "Path": "/infra/019-network.svg", + "RawPath": "", + "ForceQuery": false, + "RawQuery": "fuga=1&hoge", + "Fragment": "", + "RawFragment": "" + }, + "iconPosition": "INSIDE_MIDDLE_CENTER", + "blend": false, + "fields": null, + "methods": null, + "columns": null, + "label": "my network", + "fontSize": 16, + "fontFamily": "DEFAULT", + "language": "", + "color": "#0A0F25", + "italic": false, + "bold": true, + "underline": false, + "labelWidth": 90, + "labelHeight": 26, + "labelPosition": "INSIDE_TOP_CENTER", + "zIndex": 0, + "level": 1 + } + ], + "connections": [] +} diff --git a/e2etests/testdata/regression/query_param_escape/elk/sketch.exp.svg b/e2etests/testdata/regression/query_param_escape/elk/sketch.exp.svg new file mode 100644 index 000000000..0a13f7b0b --- /dev/null +++ b/e2etests/testdata/regression/query_param_escape/elk/sketch.exp.svg @@ -0,0 +1,31 @@ + +my network + + + \ No newline at end of file From 0fa4ee84aa5b8ca5be3689204f49d951343792aa Mon Sep 17 00:00:00 2001 From: Alexander Wang Date: Sat, 24 Dec 2022 12:47:25 -0800 Subject: [PATCH 2/2] changelog --- ci/release/changelogs/next.md | 1 + 1 file changed, 1 insertion(+) diff --git a/ci/release/changelogs/next.md b/ci/release/changelogs/next.md index dded33175..f96223703 100644 --- a/ci/release/changelogs/next.md +++ b/ci/release/changelogs/next.md @@ -16,5 +16,6 @@ - Fixed an issue where text could overflow in sql_table shapes. [#458](https://github.com/terrastruct/d2/pull/458) - Fixed an issue with elk layouts accounting for edge labels as if they were placed on the side of the edge. [#483](https://github.com/terrastruct/d2/pull/483) - Fixed an issue where dagre layouts may not have enough spacing for all edge labels. [#484](https://github.com/terrastruct/d2/pull/484) +- Icons with query parameters are now being escaped to valid SVG XML. [#438](https://github.com/terrastruct/d2/issues/438) - Fixed connections being clipped if they were at the very top or left edges of the diagram. [#493](https://github.com/terrastruct/d2/pull/493) - Fixed edge case where style being defined in same scope as sql_table caused compiler to skip compiling sql_table. [#506](https://github.com/terrastruct/d2/issues/506)