Skip to content

FUI - Console body improvements and bug fixes #2674

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 3 commits into from
Sep 13, 2024
Merged

FUI - Console body improvements and bug fixes #2674

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7bdc293
FUI - code review & minor changes
JMach1 Jul 25, 2024
e3c7291
FUI - Console body improvements and bug fixes
jsorohova Sep 13, 2024
21dc080
FUI - Reports charts npm package
jsorohova Sep 13, 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
460 changes: 454 additions & 6 deletions package-lock.json
View file
Open in desktop

Large diffs are not rendered by default.

1 change: 1 addition & 0 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@
"@braintree/sanitize-url": "6.0.4",
"@fluentui/font-icons-mdl2": "^8.5.9",
"@fluentui/react": "^8.117.7",
"@fluentui/react-charting": "^5.22.5",
"@fluentui/react-components": "^9.49.0",
"@fluentui/react-icons": "^2.0.237",
"@microsoft/applicationinsights-web": "^3.0.2",
Expand Down
51 changes: 32 additions & 19 deletions src/components/operations/operation-details/react/runtime/OperationConsole.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,8 +34,8 @@ import { OAuthService } from "../../../../../services/oauthService";
import { ProductService } from "../../../../../services/productService";
import { TenantService } from "../../../../../services/tenantService";
import { UsersService } from "../../../../../services/usersService";
import { ServiceSkuName, TypeOfApi } from "../../../../../constants";
import { ConsoleAuthorization } from "./operation-console/ConsoleAuthorization";
import { RequestBodyType, ServiceSkuName, TypeOfApi } from "../../../../../constants";
import { ConsoleAuthorization, ProductSubscriptionKeys } from "./operation-console/ConsoleAuthorization";
import { ConsoleBody } from "./operation-console/ConsoleBody";
import { ConsoleHeaders } from "./operation-console/ConsoleHeaders";
import { ConsoleHosts } from "./operation-console/ConsoleHosts";
Expand Down Expand Up @@ -66,10 +66,6 @@ interface StoredCredentials {
accessToken: string;
}

interface OAuthSession {
[apiName: string]: StoredCredentials;
}

export const OperationConsole = ({
isOpen,
setIsOpen,
Expand All @@ -89,7 +85,7 @@ export const OperationConsole = ({
}: OperationConsoleProps) => {
const [working, setWorking] = useState<boolean>(false);
const [authorizationServers, setAuthorizationServers] = useState<AuthorizationServer[]>([]);
const [products, setProducts] = useState<any[]>([]);
const [products, setProducts] = useState<ProductSubscriptionKeys[]>([]);
const [selectedSubscriptionKey, setSelectedSubscriptionKey] = useState<string>(null);
const [isConsumptionMode, setIsConsumptionMode] = useState<boolean>(false);
const [backendUrl, setBackendUrl] = useState<string>("");
Expand All @@ -100,12 +96,12 @@ export const OperationConsole = ({

useEffect(() => {
setWorking(true);
consoleOperation.current.host.hostname(hostnames[0]);
Promise.all([
consoleOperation.current.host.hostname(hostnames[0]);
Promise.all([
getAuthServers(api, oauthService).then(authServers => {
setAuthorizationServers(authServers);
if (authServers.length > 0) {
setupOAuth(api, authServers[0], consoleOperation.current.request.headers(), sessionManager).then(newHeaders => {
setupOAuth(api, authServers?.[0], consoleOperation.current.request.headers(), sessionManager).then(newHeaders => {
consoleOperation.current.request.headers(newHeaders);
});
}
Expand All @@ -127,7 +123,7 @@ export const OperationConsole = ({

useEffect(() => {
if (!isConsumptionMode && api.type !== TypeOfApi.webSocket) {
if (!consoleOperation.current.request.headers().some(header => header.name() === KnownHttpHeaders.CacheControl)) {
if (!consoleOperation.current.request.headers()?.some(header => header.name() === KnownHttpHeaders.CacheControl)) {
consoleOperation.current.setHeader(KnownHttpHeaders.CacheControl, "no-cache", "string", "Disable caching.");
}
}
Expand All @@ -143,9 +139,9 @@ export const OperationConsole = ({
}

const setSubscriptionHeader = (key?: string): ConsoleHeader[] => {
const headers = consoleOperation.current.request.headers();
const headers = consoleOperation.current.request.headers() ?? [];
let subscriptionHeaderName: string = KnownHttpHeaders.OcpApimSubscriptionKey;

if (api.subscriptionKeyParameterNames && api.subscriptionKeyParameterNames.header) {
subscriptionHeaderName = api.subscriptionKeyParameterNames.header;
}
Expand All @@ -160,9 +156,9 @@ export const OperationConsole = ({
subscriptionHeader.secret(true);
subscriptionHeader.type = "string";
subscriptionHeader.inputTypeValue("password");

newHeaders.push(subscriptionHeader);

return newHeaders;
}

Expand All @@ -188,14 +184,24 @@ export const OperationConsole = ({
rerender();
}

const updateBody = (body: string) => {
consoleOperation.current.request.body(body);
const updateHasBody = (hasBody: boolean) => {
consoleOperation.current.hasBody(hasBody);
rerender();
}

const updateBodyBinary = (body: File) => {
const updateBody = useCallback((body: string) => {
consoleOperation.current.request.body(body);
rerender();
}, [consoleOperation, rerender]);

const updateBodyBinary = useCallback((body: File) => {
consoleOperation.current.request.binary(body);
rerender();
}, [consoleOperation, rerender]);

const updateBodyFormat = (bodyFormat: RequestBodyType) => {
consoleOperation.current.request.bodyFormat(bodyFormat);
rerender();
}

const getApiReferenceUrl = (): string => {
Expand Down Expand Up @@ -302,9 +308,16 @@ export const OperationConsole = ({
{(consoleOperation.current.canHaveBody || consoleOperation.current.hasBody()) &&
<ConsoleBody
hasBody={consoleOperation.current.hasBody()}
request={consoleOperation.current.request}
body={consoleOperation.current.request.body()}
binary={consoleOperation.current.request.binary()}
bodyDataItems={consoleOperation.current.request.bodyDataItems()}
bodyFormat={consoleOperation.current.request.bodyFormat()}
readonlyBodyFormat={consoleOperation.current.request.readonlyBodyFormat}
representations={consoleOperation.current.request.representations}
updateHasBody={updateHasBody}
updateBody={updateBody}
updateBodyBinary={updateBodyBinary}
updateBodyFormat={updateBodyFormat}
/>
}
<ConsoleRequestResponse
Expand Down
13 changes: 10 additions & 3 deletions src/components/operations/operation-details/react/runtime/OperationConsoleGql.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import * as React from "react";
import { useCallback, useEffect, useState } from "react";
import { Prism as SyntaxHighlighter } from "react-syntax-highlighter";
import { a11yLight } from "react-syntax-highlighter/dist/esm/styles/hljs";
import Editor, { Monaco } from '@monaco-editor/react';
import { ISettingsProvider } from "@paperbits/common/configuration";
import { SessionManager } from "@paperbits/common/persistence/sessionManager";
Expand Down Expand Up @@ -46,6 +48,7 @@ import { ProductService } from "../../../../../services/productService";
import { UsersService } from "../../../../../services/usersService";
import { GraphqlService, TGraphqlTypes } from "../../../../../services/graphqlService";
import { GraphqlProtocols } from "../../../../../constants";
import { MarkdownProcessor } from "../../../../utils/react/MarkdownProcessor";
import { Utils } from "../../../../../utils";
import { ConsoleAuthorization } from "./operation-console/ConsoleAuthorization";
import { ConsoleHeaders } from "./operation-console/ConsoleHeaders";
Expand Down Expand Up @@ -116,6 +119,7 @@ export const OperationConsoleGql = ({
const [pattern, setPattern] = useState<string>("");
const [queryVariables, setQueryVariables] = useState<string>("");
const [response, setResponse] = useState<string>("");
const [requestError, setRequestError] = useState<string>(null);

const generateDocument = useCallback((globalNodes) => {
const document = createFieldStringFromNodes(globalNodes, 0);
Expand Down Expand Up @@ -301,7 +305,8 @@ export const OperationConsoleGql = ({
setResponse(responseStr);
}
catch (error) {
return;
setSelectedTab(ConsoleTab.response);
setRequestError(error.message);
}
finally {
setSendingRequest(false);
Expand Down Expand Up @@ -525,13 +530,15 @@ export const OperationConsoleGql = ({
/>
}
{selectedTab === ConsoleTab.response &&
response
requestError
? <MarkdownProcessor markdownToDisplay={requestError} />
: response && <SyntaxHighlighter children={response} language={"html"} style={a11yLight} />
}
</div>
</Stack.Item>
</Stack>
</Stack.Item>
</Stack>
</Stack>
</>
}
</DrawerBody>
Expand Down
1 change: 0 additions & 1 deletion src/components/operations/operation-details/react/runtime/OperationDetailsWebsocket.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,6 @@ export const OperationDetailsWebsocket = ({

try {
api = await apiService.getApi(`apis/${apiName}`);
console.log(api);
} catch (error) {
throw new Error(`Unable to load the API. Error: ${error.message}`);
}
Expand Down
16 changes: 13 additions & 3 deletions ...nts/operations/operation-details/react/runtime/operation-console/ConsoleAuthorization.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,20 @@ import { ConsoleHeader } from "../../../../../../models/console/consoleHeader";
import { OAuthService } from "../../../../../../services/oauthService";
import { authenticateOAuthWithPassword, onGrantTypeChange } from "./consoleUtils";

interface SubscriptionKey {
name: string,
value: string,
}

export interface ProductSubscriptionKeys {
name: string,
subscriptionKeys: SubscriptionKey[]
}

type ConsoleAuthorizationProps = {
api: Api;
headers: ConsoleHeader[];
products: any[];
products: ProductSubscriptionKeys[];
subscriptionRequired: boolean;
subscriptionKey: string;
authorizationServers: AuthorizationServer[];
Expand All @@ -40,12 +50,12 @@ export const ConsoleAuthorization = ({
isGqlConsole
}: ConsoleAuthorizationProps) => {
const [isAuthorizationCollapsed, setIsAuthorizationCollapsed] = useState<boolean>(false);
const [selectedAuthorizationServer, setSelectedAuthorizationServer] = useState<AuthorizationServer>(authorizationServers[0] ?? null);
const [selectedAuthorizationServer, setSelectedAuthorizationServer] = useState<AuthorizationServer>(authorizationServers?.[0] ?? null);
const [selectedAuthorizationFlow, setSelectedAuthorizationFlow] = useState<string>(noAuthFlow);
const [selectedSubscriptionKey, setSelectedSubscriptionKey] = useState<{ name: string, value: string }>(
subscriptionKey
? products.flatMap(p => p.subscriptionKeys).find(k => k.value === subscriptionKey)
: products[0]?.subscriptionKeys[0] ?? null
: products?.[0]?.subscriptionKeys[0] ?? null
);
const [username, setUsername] = useState<string>("");
const [password, setPassword] = useState<string>("");
Expand Down
Loading