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

Jump to bottom

fix: sidebar problems #766

Merged
merged 3 commits into from
Sep 13, 2023
Merged

fix: sidebar problems #766

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
a4ac199
fix sidebar and add test
jonaslagoni Sep 12, 2023
a7e6242
rename test
jonaslagoni Sep 12, 2023
e127a13
fix codesmells
jonaslagoni Sep 12, 2023
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
59 changes: 59 additions & 0 deletions library/src/__tests__/index.test.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -155,4 +155,63 @@ describe('AsyncAPI component', () => {
expect(result.container.querySelector('#introduction')).toBeDefined(),
);
});

test('should work with all options', async () => {
const schema = {
asyncapi: '2.0.0',
info: {
title: 'Example AsyncAPI',
version: '0.1.0',
},
servers: {
'example-server': {
url: 'test.example.org',
protocol: 'mqtt',
},
},
channels: {
'example-channel': {
subscribe: {
message: {
payload: {
type: 'object',
properties: {
exampleField: {
type: 'string',
},
exampleNumber: {
type: 'number',
},
exampleDate: {
type: 'string',
format: 'date-time',
},
},
},
},
},
},
},
};
const result = render(
<AsyncApiComponent
schema={schema}
config={{
show: {
sidebar: true,
info: true,
servers: true,
operations: true,
messages: true,
schemas: true,
errors: true,
},
}}
/>,
);

await waitFor(() =>
expect(result.container.querySelector('#introduction')).toBeDefined(),
);
});
});
76 changes: 31 additions & 45 deletions library/src/containers/Sidebar/Sidebar.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,11 @@ export const Sidebar: React.FunctionComponent = () => {
.get('x-logo')
?.value();
const components = asyncapi.components();
const messages = components && components.messages();
const schemas = components && components.schemas();
const hasOperations =
asyncapi.channels().length > 0 &&
Object.values(asyncapi.channels()).some(
channel => channel.operations().length > 0,
);
const messages = components?.messages().all();
const schemas = components?.schemas().all();
const hasOperations = asyncapi.operations().length > 0;

const messagesList = messages && Object.keys(messages).length > 0 && (
const messagesList = messages?.length > 0 && (
<li className="mb-3 mt-9">
<a
className="text-xs uppercase text-gray-700 mt-10 mb-4 font-thin hover:text-gray-900"
Expand All @@ -41,11 +37,11 @@ export const Sidebar: React.FunctionComponent = () => {
Messages
</a>
<ul className="text-sm mt-2">
{Object.entries(messages).map(([messageName, message]) => (
<li key={messageName}>
{messages.map(message => (
<li key={message.name()}>
<a
className="flex break-words no-underline text-gray-700 mt-2 hover:text-gray-900"
href={`#message-${messageName}`}
href={`#message-${message.name()}`}
onClick={() => setShowSidebar(false)}
>
<div className="break-all inline-block">{message.id()}</div>
Expand All @@ -56,7 +52,7 @@ export const Sidebar: React.FunctionComponent = () => {
</li>
);

const schemasList = schemas && Object.keys(schemas).length > 0 && (
const schemasList = schemas?.length > 0 && (
<li className="mb-3 mt-9">
<a
className="text-xs uppercase text-gray-700 mt-10 mb-4 font-thin hover:text-gray-900"
Expand All @@ -66,14 +62,14 @@ export const Sidebar: React.FunctionComponent = () => {
Schemas
</a>
<ul className="text-sm mt-2">
{Object.keys(schemas).map(schemaName => (
<li key={schemaName}>
{schemas.map(schema => (
<li key={schema.id()}>
<a
className="flex break-words no-underline text-gray-700 mt-2 hover:text-gray-900"
href={`#schema-${schemaName}`}
href={`#schema-${schema.id()}`}
onClick={() => setShowSidebar(false)}
>
<div className="break-all inline-block">{schemaName}</div>
<div className="break-all inline-block">{schema.id()}</div>
</a>
</li>
))}
Expand Down Expand Up @@ -216,14 +212,14 @@ function filterObjectsByTags<T = any>(
const ServersList: React.FunctionComponent = () => {
const sidebarConfig = useConfig().sidebar;
const asyncapi = useSpec();
const servers = asyncapi.servers();
const servers = asyncapi.servers().all();
const showServers = sidebarConfig?.showServers || 'byDefault';

if (showServers === 'byDefault') {
return (
<ul className="text-sm mt-2">
{Object.keys(servers).map(serverName => (
<ServerItem serverName={serverName} key={serverName} />
{servers.map(server => (
<ServerItem serverName={server.id()} key={server.id()} />
))}
</ul>
);
Expand All @@ -234,22 +230,17 @@ const ServersList: React.FunctionComponent = () => {
specTagNames = (asyncapi.info().tags() || []).map(tag => tag.name());
} else {
const serverTagNamesSet = new Set<string>();
Object.values(servers).forEach(server => {
if (typeof server.tags !== 'function') {
return;
}
servers.forEach(server => {
server.tags().forEach(t => serverTagNamesSet.add(t.name()));
});
specTagNames = Array.from(serverTagNamesSet);
}

const serializedServers: TagObject[] = Object.entries(servers).map(
([serverName, server]) => ({
name: serverName,
object: server,
data: {},
}),
);
const serializedServers: TagObject[] = servers.map(server => ({
name: server.id(),
object: server,
data: {},
}));
const { tagged, untagged } = filterObjectsByTags(
specTagNames,
serializedServers,
Expand Down Expand Up @@ -281,40 +272,35 @@ const ServersList: React.FunctionComponent = () => {
const OperationsList: React.FunctionComponent = () => {
const sidebarConfig = useConfig().sidebar;
const asyncapi = useSpec();
const operations = asyncapi.operations();
const operations = asyncapi.operations().all();
const showOperations = sidebarConfig?.showOperations || 'byDefault';

const processedOperations: Array<TagObject<{
channelName: string;
summary: string;
kind: 'publish' | 'subscribe';
}>> = [];
Object.entries(operations).forEach(([operationId, operation]) => {
operations.forEach(operation => {
const operationChannel = operation.channels();
const operationChannels = operationChannel.all();
const channelAddress = operationChannels[0]?.address();
if (operation.isSend()) {
processedOperations.push({
name: `publish-${operationId}`,
name: `publish-${operation.id()}`,
object: operation,
data: {
channelName:
operation
.channels()
.all()[0]
.address() || '',
channelName: channelAddress || '',
kind: 'publish',
summary: operation.summary() || '',
},
});
}
if (operation.isReceive()) {
processedOperations.push({
name: `subscribe-${operationId}`,
name: `subscribe-${operation.id()}`,
object: operation,
data: {
channelName:
operation
.channels()
.all()[0]
.address() || '',
channelName: channelAddress || '',
kind: 'subscribe',
summary: operation.summary() || '',
},
Expand All @@ -337,7 +323,7 @@ const OperationsList: React.FunctionComponent = () => {
operationTagNames = (asyncapi.info().tags() || []).map(tag => tag.name());
} else {
const operationTagNamesSet = new Set<string>();
Object.values(operations).forEach(operation => {
operations.forEach(operation => {
operation.tags().forEach(t => operationTagNamesSet.add(t.name()));
});
operationTagNames = Array.from(operationTagNamesSet);
Expand Down
Loading