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 error message with missing docs #17071

Merged
merged 2 commits into from
Sep 23, 2022
Merged

🪟 🐛 Fix error message with missing docs #17071

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b8f9c89
Fix error message with missing docs (#17014)
timroes Sep 22, 2022
42be270
Reverse type check logic
timroes Sep 23, 2022
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
4 changes: 2 additions & 2 deletions airbyte-webapp/src/components/DocumentationPanel/DocumentationPanel.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export const DocumentationPanel: React.FC = () => {
const { formatMessage } = useIntl();
const config = useConfig();
const { setDocumentationPanelOpen, documentationUrl } = useDocumentationPanelContext();
const { data: docs, isLoading } = useDocumentation(documentationUrl);
const { data: docs, isLoading, error } = useDocumentation(documentationUrl);

// @ts-expect-error rehype-slug currently has type conflicts due to duplicate vfile dependencies
const urlReplacerPlugin: PluggableList = useMemo<PluggableList>(() => {
Expand Down Expand Up @@ -55,7 +55,7 @@ export const DocumentationPanel: React.FC = () => {
<PageTitle withLine title={<FormattedMessage id="connector.setupGuide" />} />
<Markdown
className={styles.content}
content={!docs?.includes("<!DOCTYPE html>") ? docs : formatMessage({ id: "connector.setupGuide.notFound" })}
content={docs && !error ? docs : formatMessage({ id: "connector.setupGuide.notFound" })}
rehypePlugins={urlReplacerPlugin}
/>
</div>
Expand Down
14 changes: 14 additions & 0 deletions airbyte-webapp/src/core/domain/Documentation.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
import { fetchDocumentation } from "./Documentation";

describe("fetchDocumentation", () => {
afterEach(() => {
jest.resetAllMocks();
});

it("should throw on non markdown content-type", async () => {
global.fetch = jest.fn().mockResolvedValue({
Headers: new Headers([["Content-Type", "text/html; charset=utf-8"]]),
});
await expect(fetchDocumentation("/docs/integrations/destinations/firestore.md")).rejects.toThrow();
});
});
6 changes: 6 additions & 0 deletions airbyte-webapp/src/core/domain/Documentation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,11 @@ export const fetchDocumentation = async (url: string): Promise<string> => {
method: "GET",
});

const contentType = response.headers.get("content-type");

if (contentType?.toLowerCase().includes("text/html")) {
throw new Error(`Documentation was text/html and such ignored since markdown couldn't be found.`);
}

return await response.text();
};