Skip to content

Don't restrict REST debug webview to web apps in the current namespace #1487

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
merged 1 commit into from
Feb 18, 2025
Merged

Don't restrict REST debug webview to web apps in the current namespace #1487

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
88 changes: 11 additions & 77 deletions src/commands/restDebugPanel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import axios from "axios";
import * as httpsModule from "https";

import * as vscode from "vscode";
import { AtelierAPI } from "../api";
import { cspAppsForUri, handleError } from "../utils";
import { handleError } from "../utils";
import { iscIcon } from "../extension";

interface WebviewMessage {
Expand Down Expand Up @@ -83,24 +82,6 @@ export class RESTDebugPanel {
return;
}

// Build the list of all non-CSP web apps
const cspWebApps: string[] = cspAppsForUri(openEditor.document.uri);
const allWebApps: string[] | null = await api
.actionQuery("CALL %CSP.Apps_CSPAppList()", [])
.then((data) => data.result.content.map((obj) => obj.AppUrl))
.catch((error) => {
handleError(error, "Failed to fetch the list of web applications from the server.");
return null;
});
if (allWebApps == null) {
return;
}
const restWebApps = allWebApps.filter((app) => !cspWebApps.includes(app));
if (restWebApps.length == 0) {
vscode.window.showErrorMessage("No REST web applications are configured in the server's namespace.", "Dismiss");
return;
}

if (this.currentPanel !== undefined) {
// Can only have one panel open at once
if (!this.currentPanel._panel.visible) {
Expand Down Expand Up @@ -133,10 +114,10 @@ export class RESTDebugPanel {
panel.iconPath = iscIcon;

this._file = openEditor.document.uri;
this.currentPanel = new RESTDebugPanel(panel, webviewFolderUri, api, restWebApps);
this.currentPanel = new RESTDebugPanel(panel, webviewFolderUri, api);
}

private constructor(panel: vscode.WebviewPanel, webviewFolderUri: vscode.Uri, api: AtelierAPI, webApps: string[]) {
private constructor(panel: vscode.WebviewPanel, webviewFolderUri: vscode.Uri, api: AtelierAPI) {
this._panel = panel;
const serverInfo = `${api.config.https ? "https" : "http"}://${api.config.host}:${api.config.port}${
api.config.pathPrefix
Expand All @@ -153,12 +134,7 @@ export class RESTDebugPanel {
vscode.Uri.joinPath(webviewFolderUri, "elements-1.6.3.js")
)}"></script>
<title>${RESTDebugPanel._viewTitle}</title>
<style>
.path-grid {
display: grid;
grid-template-columns: 1fr 20fr;
column-gap: 0.5rem;
}
<style>
.component-container > * {
margin: 0.5rem 0;
}
Expand All @@ -168,15 +144,6 @@ export class RESTDebugPanel {
vscode-tabs {
display: contents;
}
.path-grid-container {
display: flex;
flex-direction: row;
align-items: flex-start;
justify-content: flex-start;
}
#webApp {
max-width: 45vw;
}
#button {
margin-top: 0.5rem;
}
Expand All @@ -198,15 +165,8 @@ export class RESTDebugPanel {
<vscode-tab-header id="bodyTab">BODY</vscode-tab-header>
<vscode-tab-panel id="methodPathView">
<section class="component-container">
<p>
Select a method for this request, then select the web application
to use from the dropdown and enter the rest of the path in the input field
next to the dropdown.
</p>
<p>
The connection information of the server definition
is shown for clarity but it cannot be edited.
</p>
<p>Select a method for this request, then enter the path in the bottom input field.</p>
<p>The connection information of the server definition is shown, but it cannot be edited.</p>
<vscode-radio-group id="method" name="method">
<vscode-radio value="GET" name="method" checked>GET</vscode-radio>
<vscode-radio value="POST" name="method">POST</vscode-radio>
Expand All @@ -217,14 +177,7 @@ export class RESTDebugPanel {
<vscode-radio value="OPTIONS" name="method">OPTIONS</vscode-radio>
</vscode-radio-group>
<vscode-textfield readonly id="serverInfo"></vscode-textfield>
<section class="path-grid">
<section class="path-grid-container">
<vscode-single-select id="webApp" name="webApp" position="below"></vscode-single-select>
</section>
<section class="path-grid-container">
<vscode-textfield id="path" name="path" placeholder="/path" pattern="^/.*$" required></vscode-textfield>
</section>
</section>
<vscode-textfield id="path" name="path" placeholder="/path" pattern="^/.*$" required></vscode-textfield>
</section>
</vscode-tab-panel>
<vscode-tab-panel id="headersView">
Expand Down Expand Up @@ -271,13 +224,12 @@ export class RESTDebugPanel {
const bodyType = document.getElementById("bodyType");
const bodyContent = document.getElementById("bodyContent");
const button = document.getElementById("button");
const webApp = document.getElementById("webApp");
const formFields = [method, serverInfo, path, headersText, paramsText, bodyType, bodyContent, webApp];
const formFields = [method, serverInfo, path, headersText, paramsText, bodyType, bodyContent];
const sendData = (submitted) => {
const data = Object.fromEntries(new FormData(form));
if (
Object.keys(data).length == (formFields.length - 1) &&
data.webApp != "" && data.method != "" && data.bodyType != "" &&
data.method != "" && data.bodyType != "" &&
(!submitted || (submitted && path.checkValidity()))
) {
vscode.postMessage({
Expand All @@ -290,24 +242,7 @@ export class RESTDebugPanel {
window.onmessage = (event) => {
const data = event.data, currentVals = new FormData(form);
formFields.forEach((field) => {
if (field.id == "webApp" && webApp.children.length == 0) {
// Create options and set the initial value
const initIdx = data.webApps.findIndex((e) => e == data.webApp) ?? 0;
data.webApps.forEach((webAppStr, idx) => {
const option = document.createElement("vscode-option");
option.innerText = webAppStr;
option.setAttribute("value",webAppStr);
if (idx == initIdx) {
option.selected = true;
}
webApp.appendChild(option);
});
// Update width of dropdown
const longest = data.webApps.reduce((a,b) => a.length > b.length ? a : b);
const context = document.createElement("canvas").getContext("2d");
context.font = window.getComputedStyle(webApp,null).getPropertyValue("font");
webApp.style.width = Math.ceil(context.measureText(longest).width*(4/3)) + "px";
} else if (data[field.id] != undefined && currentVals.get(field.id) != data[field.id]) {
if (data[field.id] != undefined && currentVals.get(field.id) != data[field.id]) {
if (["method","bodyType"].includes(field.id)) {
// Check the correct radio
for (const c of field.children) {
Expand Down Expand Up @@ -341,7 +276,7 @@ export class RESTDebugPanel {
// Bubble change events up to the form
bodyContent.onchange = headersText.onchange =
paramsText.onchange = path.onchange =
webApp.onchange = () => form.dispatchEvent(new Event("change"));
() => form.dispatchEvent(new Event("change"));
</script>
</body>
</html>`;
Expand Down Expand Up @@ -460,7 +395,6 @@ export class RESTDebugPanel {
// Restore the content
this._panel.webview.postMessage({
serverInfo,
webApps,
...RESTDebugPanel._cache,
});
}
Expand Down