Skip to content

Add CORS handling for web-components (complete PR 2006) #2773

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

Open
emanb29 wants to merge 7 commits into
base: main
Choose a base branch
from
Open

Add CORS handling for web-components (complete PR 2006) #2773

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
2eead18
Add parameter to configure CORS withCredentials handling when resolvi…
danpat Jan 28, 2022
d8f0da4
Merge branch 'main' into refs_withcredentials
danpat Jan 28, 2022
c3364c9
Merge branch 'main' into refs_withcredentials
danpat Feb 10, 2022
214dd81
Merge branch 'main' into refs_withcredentials
mnaumanali94 Feb 28, 2022
409f8b2
Merge branch 'main' into refs_withcredentials
mnaumanali94 Mar 10, 2022
f76c429
Merge branch 'main' into refs_withcredentials
Nezteb Mar 10, 2022
d31fc03
Merge branch 'main' into merge-danpat-refs_withcredentials
emanb29 Feb 16, 2025
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
15 changes: 11 additions & 4 deletions packages/elements-core/src/hooks/useBundleRefsIntoDocument.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ import * as React from 'react';

interface Options {
baseUrl?: string;
withCredentials?: boolean;
}

/**
Expand All @@ -18,6 +19,7 @@ export function useBundleRefsIntoDocument(document: unknown, options?: Options)
const [bundledData, setBundledData] = React.useState(document);

const baseUrl = options?.baseUrl;
const withCredentials = options?.withCredentials;

React.useEffect(() => {
if (!isObject(document)) {
Expand All @@ -26,7 +28,7 @@ export function useBundleRefsIntoDocument(document: unknown, options?: Options)
}

let isMounted = true;
doBundle(document, baseUrl)
doBundle(document, baseUrl, withCredentials)
.then(res => {
if (isMounted) {
setBundledData({ ...res }); // this hmm....library mutates document so a shallow copy is required to force a rerender in all cases
Expand All @@ -45,13 +47,18 @@ export function useBundleRefsIntoDocument(document: unknown, options?: Options)
return () => {
isMounted = false;
};
}, [document, baseUrl]);
}, [document, baseUrl, withCredentials]);

return bundledData;
}

const commonBundleOptions = { continueOnError: true };
const doBundle = (data: object, baseUrl?: string) => {
const doBundle = (data: object, baseUrl?: string, withCredentials?: boolean) => {
const commonBundleOptions: $RefParser.Options = {
continueOnError: true,
resolve: {
http: <$RefParser.HTTPResolverOptions>{ withCredentials },
},
};
if (!baseUrl) {
return $RefParser.bundle(data, commonBundleOptions);
} else {
Expand Down
10 changes: 9 additions & 1 deletion packages/elements/src/containers/API.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -112,6 +112,13 @@ export interface CommonAPIProps extends RoutingProps {
*/
tryItCorsProxy?: string;

/**
* Whether to include CORS credentials (cookies, authorization headers, TLS client certificates)
* in remote ref requests
* @default: false
*/
withCredentials?: boolean;

/**
* The amount of references deep should be presented.
* @default undefined
Expand Down Expand Up @@ -145,6 +152,7 @@ export const APIImpl: React.FC<APIProps> = props => {
hideExport,
tryItCredentialsPolicy,
tryItCorsProxy,
withCredentials,
maxRefDepth,
renderExtensionAddon,
basePath,
Expand All @@ -170,7 +178,7 @@ export const APIImpl: React.FC<APIProps> = props => {

const document = apiDescriptionDocument || fetchedDocument || '';
const parsedDocument = useParsedValue(document);
const bundledDocument = useBundleRefsIntoDocument(parsedDocument, { baseUrl: apiDescriptionUrl });
const bundledDocument = useBundleRefsIntoDocument(parsedDocument, { baseUrl: apiDescriptionUrl, withCredentials });
const serviceNode = React.useMemo(() => transformOasToServiceNode(bundledDocument), [bundledDocument]);
const exportProps = useExportDocumentProps({ originalDocument: document, bundledDocument });

Expand Down
1 change: 1 addition & 0 deletions packages/elements/src/web-components/components.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ export const ApiElement = createElementClass(API, {
logo: { type: 'string' },
tryItCredentialsPolicy: { type: 'string' },
tryItCorsProxy: { type: 'string' },
withCredentials: { type: 'boolean' },
maxRefDepth: { type: 'number' },
renderExtensionAddon: { type: 'function' },
outerRouter: { type: 'boolean' },
Expand Down