Skip to content
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

fix(livesamples): use correct legacy url #9158

Merged
merged 4 commits into from
Jun 26, 2023
+39 −30
Merged

fix(livesamples): use correct legacy url #9158

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0ee23f9
fix(livesamples): use correct legacy url
fiji-flo Jun 26, 2023
2d782c2
clean up macro
fiji-flo Jun 26, 2023
035b44b
fix test
fiji-flo Jun 26, 2023
73a163c
clean up more
fiji-flo Jun 26, 2023
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
20 changes: 11 additions & 9 deletions kumascript/macros/LiveSampleURL.ejs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,25 +4,27 @@
//
// Parameters:
//
// $0 The ID of the sample's section or containing block.
// $1 The URL from which to pull the sample; if not provided,
// $0 - The ID of the sample's section or containing block.
// $1 - (Deprecated) The URL from which to pull the sample; if not provided,
// the current page is assumed.

var pagePath = env.url;
let pagePath = env.url;
let baseUrl = env.live_samples.base_url;
let samplePath = `${pagePath}/runner.html`.replace(/\/\/+/g, "/");

if ($1 && $1.length > 0) {
Copy link
Contributor

Choose a reason for hiding this comment

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

Since you're cleaning up the macro anyways, can you assign $0 and $1 to variables id and url or similar to avoid referencing $0 and $1 below?

mdn.deprecatedParams("The second parameter of 'LiveSampleURL' is deprecated");
Copy link
Contributor

Choose a reason for hiding this comment

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

Ideally, the message would have an actionable suggestion on how to proceed. I guess in this case the original example has to be copied into the page, right?

pagePath = $1;
baseUrl = env.live_samples.legacy_url;
samplePath = `${pagePath}/_sample_.${web.slugify(web.safeDecodeURIComponent($0))}.html`.replace(/\/\/+/g, "/");
}

const searchParams = new URLSearchParams([["id", $0], ["url", $1]].filter(([_,v]) => Boolean(v)));
wiki.ensureExistence(pagePath);
const samplePath = $1 ?
`${pagePath}/_sample_.${web.slugify(web.safeDecodeURIComponent($0))}.html`.replace(/\/\/+/g, "/")
: `${pagePath}/runner.html`.replace(/\/\/+/g, "/");
const searchParams = new URLSearchParams([["id", $0], ["url", $1]].filter(([_,v]) => Boolean(v)));

let url;
if (env.live_samples.base_url.includes('://')) {
url = new URL(env.live_samples.base_url);
if (baseUrl.includes('://')) {
url = new URL(baseUrl);
url.pathname = samplePath;
url.search = searchParams.toString();
} else {
Expand Down
27 changes: 14 additions & 13 deletions kumascript/tests/macros/EmbedLiveSample.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ import { assert, itMacro, describeMacro, beforeEachMacro } from "./utils.js";
describeMacro("EmbedLiveSample", function () {
beforeEachMacro(function (macro) {
macro.ctx.env.live_samples = {
base_url: "https://mdn.mozillademos.org",
base_url: "https://live.mdnplay.dev",
legacy_url: "https://mdn.mozillademos.org",
};
macro.ctx.info.hasPage = jest.fn(() => true);
});
Expand All @@ -15,7 +16,7 @@ describeMacro("EmbedLiveSample", function () {
'<div class="code-example"><p class="example-header"></p><iframe class="sample-code-frame"' +
' title="Quotations sample"' +
' id="frame_quotations"' +
' src="https://mdn.mozillademos.org/en-US/docs/Web/HTML/Element/figure/runner.html?id=quotations">' +
' src="https://live.mdnplay.dev/en-US/docs/Web/HTML/Element/figure/runner.html?id=quotations">' +
"</iframe></div>"
);
});
Expand All @@ -27,7 +28,7 @@ describeMacro("EmbedLiveSample", function () {
'<div class="code-example"><p class="example-header"></p><iframe class="sample-code-frame"' +
' title="SVG &amp;lt;switch&amp;gt; example sample"' +
' id="frame_svg_ltswitchgt_example"' +
' src="https://mdn.mozillademos.org/en-US/docs/Web/SVG/Element/switch/runner.html?id=svg_ltswitchgt_example">' +
' src="https://live.mdnplay.dev/en-US/docs/Web/SVG/Element/switch/runner.html?id=svg_ltswitchgt_example">' +
"</iframe></div>"
);
});
Expand All @@ -38,7 +39,7 @@ describeMacro("EmbedLiveSample", function () {
'<div class="code-example"><p class="example-header"></p><iframe class="sample-code-frame"' +
' title="SVG %3Cswitch%3E example sample"' +
' id="frame_svg_switch_example"' +
' src="https://mdn.mozillademos.org/en-US/docs/Web/SVG/Element/switch/runner.html?id=svg_switch_example">' +
' src="https://live.mdnplay.dev/en-US/docs/Web/SVG/Element/switch/runner.html?id=svg_switch_example">' +
"</iframe></div>"
);
});
Expand All @@ -50,7 +51,7 @@ describeMacro("EmbedLiveSample", function () {
'<div class="code-example"><p class="example-header"></p><iframe class="sample-code-frame"' +
' title="Dégradés linéaires simples sample"' +
' id="frame_dégradés_linéaires_simples"' +
' src="https://mdn.mozillademos.org/fr/docs/Web/CSS/Utilisation_de_d%C3%A9grad%C3%A9s_CSS/runner.html?id=d%C3%A9grad%C3%A9s_lin%C3%A9aires_simples">' +
' src="https://live.mdnplay.dev/fr/docs/Web/CSS/Utilisation_de_d%C3%A9grad%C3%A9s_CSS/runner.html?id=d%C3%A9grad%C3%A9s_lin%C3%A9aires_simples">' +
"</iframe></div>"
);
});
Expand All @@ -61,7 +62,7 @@ describeMacro("EmbedLiveSample", function () {
'<div class="code-example"><p class="example-header"></p><iframe class="sample-code-frame"' +
' title="&#34;&gt;&lt;script&gt;alert(&#34;XSS&#34;);&lt;/script&gt; sample"' +
' id="frame_scriptalertxssscript"' +
' src="https://mdn.mozillademos.org/en-US/docs/Web/HTML/Element/figure/runner.html?id=scriptalertxssscript">' +
' src="https://live.mdnplay.dev/en-US/docs/Web/HTML/Element/figure/runner.html?id=scriptalertxssscript">' +
"</iframe></div>"
);
});
Expand All @@ -73,7 +74,7 @@ describeMacro("EmbedLiveSample", function () {
' title="Example sample"' +
' id="frame_example"' +
' width="100%"' +
' src="https://mdn.mozillademos.org/en-US/docs/Web/CSS/border-top-width/runner.html?id=example">' +
' src="https://live.mdnplay.dev/en-US/docs/Web/CSS/border-top-width/runner.html?id=example">' +
"</iframe></div>"
);
});
Expand All @@ -85,7 +86,7 @@ describeMacro("EmbedLiveSample", function () {
' title="Example sample"' +
' id="frame_example"' +
' width="&#34;&gt;&lt;script&gt;alert(&#34;XSS&#34;);&lt;/script&gt;"' +
' src="https://mdn.mozillademos.org/en-US/docs/Web/CSS/border-top-width/runner.html?id=example">' +
' src="https://live.mdnplay.dev/en-US/docs/Web/CSS/border-top-width/runner.html?id=example">' +
"</iframe></div>"
);
});
Expand All @@ -97,7 +98,7 @@ describeMacro("EmbedLiveSample", function () {
' title="Images sample"' +
' id="frame_images"' +
' width="100%" height="250"' +
' src="https://mdn.mozillademos.org/en-US/docs/Web/HTML/Element/figure/runner.html?id=images">' +
' src="https://live.mdnplay.dev/en-US/docs/Web/HTML/Element/figure/runner.html?id=images">' +
"</iframe></div>"
);
});
Expand All @@ -110,7 +111,7 @@ describeMacro("EmbedLiveSample", function () {
' title="增加关键帧 sample"' +
' id="frame_增加关键帧"' +
' width="100%" height="250"' +
' src="https://mdn.mozillademos.org/zh-CN/docs/Web/CSS/CSS_Animations/Using_CSS_animations/runner.html?id=%E5%A2%9E%E5%8A%A0%E5%85%B3%E9%94%AE%E5%B8%A7">' +
' src="https://live.mdnplay.dev/zh-CN/docs/Web/CSS/CSS_Animations/Using_CSS_animations/runner.html?id=%E5%A2%9E%E5%8A%A0%E5%85%B3%E9%94%AE%E5%B8%A7">' +
"</iframe></div>"
);
});
Expand All @@ -126,7 +127,7 @@ describeMacro("EmbedLiveSample", function () {
' title="%E4%B8%80%E4%B8%AA%E6%A8%A1%E6%9D%BF%E9%AA%A8%E6%9E%B6 sample"' +
' id="frame_一个模板骨架"' +
' width="160" height="160"' +
' src="https://mdn.mozillademos.org/zh-CN/docs/Web/API/Canvas_API/Tutorial/Basic_usage/runner.html?id=%E4%B8%80%E4%B8%AA%E6%A8%A1%E6%9D%BF%E9%AA%A8%E6%9E%B6">' +
' src="https://live.mdnplay.dev/zh-CN/docs/Web/API/Canvas_API/Tutorial/Basic_usage/runner.html?id=%E4%B8%80%E4%B8%AA%E6%A8%A1%E6%9D%BF%E9%AA%A8%E6%9E%B6">' +
"</iframe></div>"
);
});
Expand All @@ -138,7 +139,7 @@ describeMacro("EmbedLiveSample", function () {
' title="Images sample"' +
' id="frame_images"' +
' width="100%" height="&#34;&gt;&lt;script&gt;alert(&#34;XSS&#34;);&lt;/script&gt;"' +
' src="https://mdn.mozillademos.org/en-US/docs/Web/HTML/Element/figure/runner.html?id=images">' +
' src="https://live.mdnplay.dev/en-US/docs/Web/HTML/Element/figure/runner.html?id=images">' +
"</iframe></div>"
);
});
Expand All @@ -147,7 +148,7 @@ describeMacro("EmbedLiveSample", function () {
' title="Examples sample"' +
' id="frame_examples"' +
' width="700px" height="700px"' +
' src="https://mdn.mozillademos.org/en-US/docs/Web/CSS/flex-wrap/runner.html?id=examples">' +
' src="https://live.mdnplay.dev/en-US/docs/Web/CSS/flex-wrap/runner.html?id=examples">' +
"</iframe></div>";
itMacro("Three arguments: ID, width, height (same slug)", function (macro) {
macro.ctx.env.url = "/en-US/docs/Web/CSS/flex-wrap";
Expand Down
21 changes: 13 additions & 8 deletions kumascript/tests/macros/LiveSampleURL.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,19 @@ describeMacro("LiveSampleURL", function () {
});
itMacro("Production settings", function (macro) {
macro.ctx.env.live_samples = {
base_url: "https://mdn.mozillademos.org",
base_url: "https://live.mdnplay.dev",
legacy_url: "https://mdn.mozillademos.org",
};
macro.ctx.env.url = "/en-US/docs/Web/HTML/Element/p";
return assert.eventually.equal(
macro.call("Example"),
"https://mdn.mozillademos.org/en-US/docs/Web/HTML/Element/p/runner.html?id=Example"
"https://live.mdnplay.dev/en-US/docs/Web/HTML/Element/p/runner.html?id=Example"
);
});
itMacro("Override page URL", function (macro) {
macro.ctx.env.live_samples = {
base_url: "https://mdn.mozillademos.org",
base_url: "https://live.mdnplay.dev",
legacy_url: "https://mdn.mozillademos.org",
};
macro.ctx.env.url =
"/en-US/docs/Learn/HTML/Forms/How_to_build_custom_form_widgets";
Expand All @@ -31,7 +33,8 @@ describeMacro("LiveSampleURL", function () {
});
itMacro("Override with nonexistent page URL", async (macro) => {
macro.ctx.env.live_samples = {
base_url: "https://mdn.mozillademos.org",
base_url: "https://live.mdnplay.dev",
legacy_url: "https://mdn.mozillademos.org",
};
macro.ctx.info.hasPage = jest.fn(() => false);
macro.ctx.info.getDescription = jest.fn((url: string) => url.toLowerCase());
Expand All @@ -44,12 +47,13 @@ describeMacro("LiveSampleURL", function () {
});
itMacro("Staging settings", function (macro) {
macro.ctx.env.live_samples = {
base_url: "https://files-stage.mdn.mozit.cloud",
base_url: "https://live.mdnyalp.dev",
legacy_url: "https://mdn.mozillademos.org",
};
macro.ctx.env.url = "/en-US/docs/Web/CSS/background-color";
return assert.eventually.equal(
macro.call("Examples"),
"https://files-stage.mdn.mozit.cloud/en-US/docs/Web/CSS/background-color/runner.html?id=Examples"
"https://live.mdnyalp.dev/en-US/docs/Web/CSS/background-color/runner.html?id=Examples"
);
});
itMacro("Development default settings", function (macro) {
Expand All @@ -62,12 +66,13 @@ describeMacro("LiveSampleURL", function () {
});
itMacro("Unicode ID", function (macro) {
macro.ctx.env.live_samples = {
base_url: "https://mdn.mozillademos.org",
base_url: "https://live.mdnplay.dev",
legacy_url: "https://mdn.mozillademos.org",
};
macro.ctx.env.url = "/zh-CN/docs/Web/CSS/flex-direction";
return assert.eventually.equal(
macro.call("例子"),
"https://mdn.mozillademos.org/zh-CN/docs/Web/CSS/flex-direction/runner.html?id=%E4%BE%8B%E5%AD%90"
"https://live.mdnplay.dev/zh-CN/docs/Web/CSS/flex-direction/runner.html?id=%E4%BE%8B%E5%AD%90"
);
});
itMacro("Development demo settings", function (macro) {
Expand Down