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

feat(playground): support state param in playground #12168

Merged
merged 2 commits into from
Nov 22, 2024
+69 −18
Merged

feat(playground): support state param in playground #12168

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e5c706b
feat(playground): support state param in playground
fiji-flo Nov 22, 2024
5216d82
remove logs
fiji-flo Nov 22, 2024
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
60 changes: 42 additions & 18 deletions client/src/playground/index.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,12 @@ import prettierPluginHTML from "prettier/plugins/html";
import { Button } from "../ui/atoms/button";
import Editor, { EditorHandle } from "./editor";
import { SidePlacement } from "../ui/organisms/placement";
import { compressAndBase64Encode, EditorContent, SESSION_KEY } from "./utils";
import {
compressAndBase64Encode,
decompressFromBase64,
EditorContent,
SESSION_KEY,
} from "./utils";

import "./index.scss";
import { PLAYGROUND_BASE_HOST } from "../env";
Expand Down Expand Up @@ -68,6 +73,7 @@ export default function Playground() {
const gleanClick = useGleanClick();
let [searchParams, setSearchParams] = useSearchParams();
const gistId = searchParams.get("id");
const stateParam = searchParams.get("state");
let [dialogState, setDialogState] = useState(DialogState.none);
let [shared, setShared] = useState(false);
let [shareUrl, setShareUrl] = useState<URL | null>(null);
Expand All @@ -80,7 +86,9 @@ export default function Playground() {
null
);
let { data: initialCode } = useSWRImmutable<EditorContent>(
!shared && gistId ? `/api/v1/play/${encodeURIComponent(gistId)}` : null,
!stateParam && !shared && gistId
? `/api/v1/play/${encodeURIComponent(gistId)}`
: null,
async (url) => {
const response = await fetch(url);

Expand All @@ -98,7 +106,11 @@ export default function Playground() {
},
{
fallbackData:
(!gistId && state === State.initial && load(SESSION_KEY)) || undefined,
(!stateParam &&
!gistId &&
state === State.initial &&
load(SESSION_KEY)) ||
undefined,
}
);
const htmlRef = useRef<EditorHandle | null>(null);
Expand Down Expand Up @@ -172,23 +184,35 @@ export default function Playground() {
};

useEffect(() => {
if (state === State.initial || state === State.remote) {
if (initialCode && Object.values(initialCode).some(Boolean)) {
setEditorContent(initialCode);
if (!gistId) {
// don't auto run shared code
updateWithCode(initialCode);
(async () => {
if (state === State.initial || state === State.remote) {
if (initialCode && Object.values(initialCode).some(Boolean)) {
setEditorContent(initialCode);
if (!gistId) {
// don't auto run shared code
updateWithCode(initialCode);
}
} else if (stateParam) {
try {
let { state } = await decompressFromBase64(stateParam);
console.log(state);
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
console.log(state);

let code = JSON.parse(state || "{}") as EditorContent;
console.log(code);
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
console.log(code);

setEditorContent(code);
} catch (e) {
console.error(e);
}
} else {
setEditorContent({
html: HTML_DEFAULT,
css: CSS_DEFAULT,
js: JS_DEFAULT,
});
}
} else {
setEditorContent({
html: HTML_DEFAULT,
css: CSS_DEFAULT,
js: JS_DEFAULT,
});
setState(State.ready);
}
setState(State.ready);
}
}, [initialCode, state, gistId]);
})();
}, [initialCode, state, gistId, stateParam]);

useEffect(() => {
window.addEventListener("message", messageListener);
Expand Down
29 changes: 29 additions & 0 deletions client/src/playground/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,3 +78,32 @@ export async function compressAndBase64Encode(inputString: string) {

return { state, hash };
}

function base64ToBytes(base64: string): ArrayBuffer {
const binString = atob(base64);
const len = binString.length;
const bytes = new Uint8Array(len);
for (let i = 0; i < len; i++) {
bytes[i] = binString.charCodeAt(i);
}
return bytes.buffer;
}

export async function decompressFromBase64(base64String: string) {
Copy link
Member

Choose a reason for hiding this comment

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

Looks like the only difference between this and the function in libs/play/index.js is the use of the above base64ToBytes instead of Buffer.from - which I presume is a node built in. But could we move the above function into libs/play/index.js as well and use this code in node as well? It would be nice to use the same code in both places.

Copy link
Member

Choose a reason for hiding this comment

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

Ah, it's a bit of a pain isn't it - would need to extract the node specific bits into another file in the lib - the current form is ok

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I agree in principal. But I'd want to look at this a bit deeper. The base64ToBytes is rather inefficient, and that's probably one the expensive paths in the cloud function. I'll add a task to investigate but wouldn't block on this.

if (!base64String) {
return { state: null, hash: null };
}
const bytes = base64ToBytes(base64String);
const hashBuffer = await window.crypto.subtle.digest("SHA-256", bytes);
const hashArray = Array.from(new Uint8Array(hashBuffer)).slice(0, 20);
const hash = hashArray.map((b) => b.toString(16).padStart(2, "0")).join("");

const decompressionStream = new DecompressionStream("deflate-raw");

const decompressedStream = new Response(
new Blob([bytes]).stream().pipeThrough(decompressionStream)
).arrayBuffer();

const state = new TextDecoder().decode(await decompressedStream);
return { state, hash };
}
Loading