Merge pull request #2812 from spotify/sebastianq/techdocs-new-component-url

[TechDocs] Use new url scheme for techdocs

plugins/techdocs-backend/src/service/router.ts

@@ -78,7 +78,7 @@ export async function createRouter({
     }
   });
 
-  router.get('/metadata/entity/:kind/:namespace/:name', async (req, res) => {
+  router.get('/metadata/entity/:namespace/:kind/:name', async (req, res) => {
     const baseUrl = config.getString('backend.baseUrl');
     const { kind, namespace, name } = req.params;
 
@@ -101,7 +101,7 @@ export async function createRouter({
     }
   });
 
-  router.get('/docs/:kind/:namespace/:name/*', async (req, res) => {
+  router.get('/docs/:namespace/:kind/:name/*', async (req, res) => {
     const storageUrl = config.getString('techdocs.storageUrl');
 
     const { kind, namespace, name } = req.params;

plugins/techdocs-backend/src/techdocs/stages/publish/local.test.ts

@@ -53,7 +53,7 @@ describe('local publisher', () => {
 
     const resultDir = path.resolve(
       __dirname,
-      `../../../../static/docs/${mockEntity.kind}/default/${mockEntity.metadata.name}`,
+      `../../../../static/docs/default/${mockEntity.kind}/${mockEntity.metadata.name}`,
     );
 
     expect(fs.existsSync(resultDir)).toBeTruthy();

plugins/techdocs-backend/src/techdocs/stages/publish/local.ts

@@ -42,8 +42,8 @@ export class LocalPublish implements PublisherBase {
     const publishDir = resolvePackagePath(
       '@backstage/plugin-techdocs-backend',
       'static/docs',
-      entity.kind,
       entityNamespace,
+      entity.kind,
       entity.metadata.name,
     );
 

plugins/techdocs/src/EntityPageDocs.tsx

@@ -23,7 +23,7 @@ export const EntityPageDocs = ({ entity }: { entity: Entity }) => {
     <Reader
       entityId={{
         kind: entity.kind,
-        namespace: entity.metadata.namespace,
+        namespace: entity.metadata.namespace ?? 'default',
         name: entity.metadata.name,
       }}
     />

plugins/techdocs/src/api.test.ts

@@ -28,7 +28,7 @@ describe('TechDocsStorageApi', () => {
     const storageApi = new TechDocsStorageApi({ apiOrigin: DOC_STORAGE_URL });
 
     expect(storageApi.getBaseUrl('test.js', mockEntity, '')).toEqual(
-      `${DOC_STORAGE_URL}/docs/${mockEntity.kind}/${mockEntity.namespace}/${mockEntity.name}/test.js`,
+      `${DOC_STORAGE_URL}/docs/${mockEntity.namespace}/${mockEntity.kind}/${mockEntity.name}/test.js`,
     );
   });
 
@@ -36,7 +36,7 @@ describe('TechDocsStorageApi', () => {
     const storageApi = new TechDocsStorageApi({ apiOrigin: DOC_STORAGE_URL });
 
     expect(storageApi.getBaseUrl('test/', mockEntity, '')).toEqual(
-      `${DOC_STORAGE_URL}/docs/${mockEntity.kind}/${mockEntity.namespace}/${mockEntity.name}/test/`,
+      `${DOC_STORAGE_URL}/docs/${mockEntity.namespace}/${mockEntity.kind}/${mockEntity.name}/test/`,
     );
   });
 });

plugins/techdocs/src/api.ts

@@ -51,9 +51,7 @@ export class TechDocsApi implements TechDocs {
   async getMetadata(metadataType: string, entityId: ParsedEntityId) {
     const { kind, namespace, name } = entityId;
 
-    const requestUrl = `${this.apiOrigin}/metadata/${metadataType}/${kind}/${
-      namespace ? namespace : 'default'
-    }/${name}`;
+    const requestUrl = `${this.apiOrigin}/metadata/${metadataType}/${namespace}/${kind}/${name}`;
 
     const request = await fetch(`${requestUrl}`);
     const res = await request.json();
@@ -72,9 +70,7 @@ export class TechDocsStorageApi implements TechDocsStorage {
   async getEntityDocs(entityId: ParsedEntityId, path: string) {
     const { kind, namespace, name } = entityId;
 
-    const url = `${this.apiOrigin}/docs/${kind}/${
-      namespace ? namespace : 'default'
-    }/${name}/${path}`;
+    const url = `${this.apiOrigin}/docs/${namespace}/${kind}/${name}/${path}`;
 
     const request = await fetch(
       `${url.endsWith('/') ? url : `${url}/`}index.html`,
@@ -96,9 +92,7 @@ export class TechDocsStorageApi implements TechDocsStorage {
 
     return new URL(
       oldBaseUrl,
-      `${this.apiOrigin}/docs/${kind}/${
-        namespace ? namespace : 'default'
-      }/${name}/${path}`,
+      `${this.apiOrigin}/docs/${namespace}/${kind}/${name}/${path}`,
     ).toString();
   }
 }

plugins/techdocs/src/plugin.ts

@@ -48,7 +48,7 @@ export const rootRouteRef = createRouteRef({
 });
 
 export const rootDocsRouteRef = createRouteRef({
-  path: ':entityId/*',
+  path: ':namespace/:kind/:name/*',
   title: 'Docs',
 });
 

plugins/techdocs/src/reader/components/TechDocsHome.tsx

@@ -84,9 +84,9 @@ export const TechDocsHome = () => {
                     onClick={() =>
                       navigate(
                         generatePath(rootDocsRouteRef.path, {
-                          entityId: `${entity.kind}:${
-                            entity.metadata.namespace ?? ''
-                          }:${entity.metadata.name}`,
+                          namespace: entity.metadata.namespace ?? 'default',
+                          kind: entity.kind,
+                          name: entity.metadata.name,
                         }),
                       )
                     }

plugins/techdocs/src/reader/components/TechDocsPage.tsx

@@ -24,8 +24,7 @@ import { techdocsApiRef } from '../../api';
 
 export const TechDocsPage = () => {
   const [documentReady, setDocumentReady] = useState<boolean>(false);
-  const { entityId } = useParams();
-  const [kind, namespace, name] = entityId.split(':');
+  const { namespace, kind, name } = useParams();
 
   const techDocsApi = useApi(techdocsApiRef);