fix(wsdl): use client catalog on backend side to load definition

.changeset/silent-jars-worry.md

@@ -0,0 +1,6 @@
+---
+'@dweber019/backstage-plugin-api-docs-module-wsdl-backend': patch
+'@dweber019/backstage-plugin-api-docs-module-wsdl': patch
+---
+
+Use client catalog on backend side to load definition instead of providing definition from frontend.

app-config.yaml

@@ -71,6 +71,8 @@ catalog:
     # Local example data, file locations are relative to the backend process, typically `packages/backend`
     - type: file
       target: ../entities/wsdl-api-example.yaml
+    - type: file
+      target: ../entities/wsdl-api-example-big.yaml
     - type: file
       target: ../entities/end-of-life-resource-examples.yaml
 

packages/backend/src/plugins/apiDocsModuleWsdl.ts

@@ -5,5 +5,5 @@ import { PluginEnvironment } from '../types';
 export default async function createPlugin(
   env: PluginEnvironment,
 ): Promise<Router> {
-  return await createRouter({ logger: env.logger });
+  return await createRouter({ logger: env.logger, discovery: env.discovery });
 }

plugins/api-docs-module-wsdl-backend/README.md

@@ -18,7 +18,7 @@ import { PluginEnvironment } from '../types';
 export default async function createPlugin(
   env: PluginEnvironment,
 ): Promise<Router> {
-  return await createRouter({ logger: env.logger });
+  return await createRouter({ logger: env.logger, discovery: env.discovery });
 }
 ```
 

plugins/api-docs-module-wsdl-backend/package.json

@@ -30,6 +30,8 @@
   "dependencies": {
     "@backstage/backend-common": "^0.20.1",
     "@backstage/backend-plugin-api": "^0.6.9",
+    "@backstage/catalog-client": "^1.6.0",
+    "@backstage/catalog-model": "^1.4.4",
     "@types/express": "^4.17.6",
     "cross-fetch": "^3.1.5",
     "express": "^4.17.1",

plugins/api-docs-module-wsdl-backend/src/plugin.ts

@@ -16,11 +16,13 @@ export const apiDocsModuleWsdlPlugin = createBackendPlugin({
       deps: {
         logger: coreServices.logger,
         httpRouter: coreServices.httpRouter,
+        discovery: coreServices.discovery,
       },
-      async init({ logger, httpRouter }) {
+      async init({ logger, httpRouter, discovery }) {
         httpRouter.use(
           await createRouter({
             logger: loggerToWinstonLogger(logger),
+            discovery,
           }),
         );
       },

plugins/api-docs-module-wsdl-backend/src/service/router.ts

@@ -2,14 +2,13 @@ import express from 'express';
 import Router from 'express-promise-router';
 import fetch from 'cross-fetch';
 import { Logger } from 'winston';
+import { CatalogClient } from '@backstage/catalog-client';
+import { PluginEndpointDiscovery } from '@backstage/backend-common';
+import { ApiEntity } from '@backstage/catalog-model';
 // @ts-ignore
 import SaxonJS from 'saxon-js';
 import styleSheet from '../stylesheet.sef.json';
 
-export interface RouterOptions {
-  logger: Logger;
-}
-
 const downloadExternalSchema = async (uri: string, logger: Logger) => {
   try {
     const value = await fetch(uri);
@@ -100,11 +99,19 @@ const wsdlToHtml = async (xml: string, logger: Logger) => {
   ).then((output: { principalResult: string }) => output.principalResult);
 };
 
+export interface RouterOptions {
+  logger: Logger;
+  discovery: PluginEndpointDiscovery;
+}
+
 /** @public */
 export async function createRouter(
   options: RouterOptions,
 ): Promise<express.Router> {
-  const { logger } = options;
+  const { logger, discovery } = options;
+
+  const catalogClient = new CatalogClient({ discoveryApi: discovery });
+
   const router = Router();
   router.use(express.text());
 
@@ -113,9 +120,13 @@ export async function createRouter(
     response.json({ status: 'ok' });
   });
 
-  router.post('/v1/convert', async (req, res) => {
-    const entityLogger = logger.child({ entity: req.query.entityRef });
-    const result = await wsdlToHtml(req.body.toString(), entityLogger);
+  router.get('/v1/convert', async (req, res) => {
+    const entityRef = req.query.entityRef as string;
+    const entityLogger = logger.child({ entity: entityRef });
+    const apiEntity = (await catalogClient.getEntityByRef(
+      entityRef,
+    )) as ApiEntity;
+    const result = await wsdlToHtml(apiEntity.spec.definition, entityLogger);
     res.send(result);
   });
 

plugins/api-docs-module-wsdl-backend/src/service/standaloneServer.ts

@@ -1,4 +1,8 @@
-import { createServiceBuilder } from '@backstage/backend-common';
+import {
+  createServiceBuilder,
+  HostDiscovery,
+  loadBackendConfig,
+} from '@backstage/backend-common';
 import { Server } from 'http';
 import { Logger } from 'winston';
 import { createRouter } from './router';
@@ -16,7 +20,11 @@ export async function startStandaloneServer(
     service: 'api-docs-module-wsdl-backend',
   });
   logger.info('Starting application server...');
-  const router = await createRouter({ logger });
+  const config = await loadBackendConfig({ logger, argv: process.argv });
+  const router = await createRouter({
+    logger,
+    discovery: HostDiscovery.fromConfig(config),
+  });
 
   let service = createServiceBuilder(module)
     .setPort(options.port)

plugins/api-docs-module-wsdl/src/api/ApiDocsModuleWsdlClient.ts

@@ -26,18 +26,17 @@ export class ApiDocsModuleWsdlClient implements ApiDocsModuleWsdlApi {
     this.identityApi = options.identityApi;
   }
 
-  async convert(xml: string, entityRef: string): Promise<string> {
+  async convert(entityRef: string): Promise<string> {
     const baseUrl = await this.discoveryApi.getBaseUrl('api-docs-module-wsdl');
     const { token } = await this.identityApi.getCredentials();
 
     const res = await fetch(`${baseUrl}/v1/convert?entityRef=${entityRef}`, {
-      method: 'POST',
+      method: 'GET',
       headers: token
         ? {
             Authorization: `Bearer ${token}`,
           }
         : undefined,
-      body: xml,
     });
 
     if (!res.ok) {

plugins/api-docs-module-wsdl/src/api/types.ts

@@ -11,7 +11,7 @@ export interface ApiDocsModuleWsdlApi {
    *
    * @public
    */
-  convert(xml: string, entityRef: string): Promise<string>;
+  convert(entityRef: string): Promise<string>;
 }
 
 /**

plugins/api-docs-module-wsdl/src/components/WsdlDefinitionWidget/WsdlDefinition.tsx

@@ -15,10 +15,7 @@ export const WsdlDefinition = ({ definition }: WsdlDefinitionProps) => {
   const apiDocsModuleWsdlDocApi = useApi(apiDocsModuleWsdlApiRef);
   const { entity } = useEntity();
   const result = useAsync(() => {
-    return apiDocsModuleWsdlDocApi.convert(
-      definition,
-      stringifyEntityRef(entity),
-    );
+    return apiDocsModuleWsdlDocApi.convert(stringifyEntityRef(entity));
   }, [definition]);
 
   if (result.loading) {