docs(changeset): Fix missing routes and normalise collection/container names in adapter

Author: GuptaSiddhant

.changeset/busy-sloths-brake.md

@@ -0,0 +1,8 @@
+---
+"@storybooker/adapter-azure": minor
+"@storybooker/core": minor
+"@storybooker/adapter-fs": minor
+"@storybooker/azure-functions": minor
+---
+
+Fix missing routes and normalise collection/container names in adapter

packages/adapter-azure/src/blob-storage.ts

@@ -18,7 +18,8 @@ export class AzureBlobStorageService implements StorageService {
     containerId,
     options,
   ) => {
-    await this.#client.createContainer(containerId, {
+    const containerName = genContainerNameFromContainerId(containerId);
+    await this.#client.createContainer(containerName, {
       abortSignal: options.abortSignal,
     });
   };
@@ -27,7 +28,8 @@ export class AzureBlobStorageService implements StorageService {
     containerId,
     options,
   ) => {
-    await this.#client.getContainerClient(containerId).deleteIfExists({
+    const containerName = genContainerNameFromContainerId(containerId);
+    await this.#client.getContainerClient(containerName).deleteIfExists({
       abortSignal: options.abortSignal,
     });
   };
@@ -36,7 +38,8 @@ export class AzureBlobStorageService implements StorageService {
     containerId,
     options,
   ) => {
-    return await this.#client.getContainerClient(containerId).exists({
+    const containerName = genContainerNameFromContainerId(containerId);
+    return await this.#client.getContainerClient(containerName).exists({
       abortSignal: options.abortSignal,
     });
   };
@@ -57,7 +60,8 @@ export class AzureBlobStorageService implements StorageService {
     filePathsOrPrefix,
     options,
   ) => {
-    const containerClient = this.#client.getContainerClient(containerId);
+    const containerName = genContainerNameFromContainerId(containerId);
+    const containerClient = this.#client.getContainerClient(containerName);
     const blobClientsToDelete: BlobClient[] = [];
 
     if (typeof filePathsOrPrefix === "string") {
@@ -94,7 +98,8 @@ export class AzureBlobStorageService implements StorageService {
     files,
     options,
   ) => {
-    const containerClient = this.#client.getContainerClient(containerId);
+    const containerName = genContainerNameFromContainerId(containerId);
+    const containerClient = this.#client.getContainerClient(containerName);
     // oxlint-disable-next-line require-await
     const promises = files.map(async ({ content, path, mimeType }) =>
       this.#uploadFile(
@@ -149,7 +154,8 @@ export class AzureBlobStorageService implements StorageService {
     filepath,
     options,
   ) => {
-    const containerClient = this.#client.getContainerClient(containerId);
+    const containerName = genContainerNameFromContainerId(containerId);
+    const containerClient = this.#client.getContainerClient(containerName);
     const blockBlobClient = containerClient.getBlockBlobClient(filepath);
     return await blockBlobClient.exists({ abortSignal: options.abortSignal });
   };
@@ -159,7 +165,8 @@ export class AzureBlobStorageService implements StorageService {
     filepath,
     options,
   ) => {
-    const containerClient = this.#client.getContainerClient(containerId);
+    const containerName = genContainerNameFromContainerId(containerId);
+    const containerClient = this.#client.getContainerClient(containerName);
     const blockBlobClient = containerClient.getBlockBlobClient(filepath);
 
     if (!(await blockBlobClient.exists())) {
@@ -185,3 +192,10 @@ export class AzureBlobStorageService implements StorageService {
     };
   };
 }
+
+function genContainerNameFromContainerId(containerId: string): string {
+  return containerId
+    .replaceAll(/[^\w-]+/g, "-")
+    .slice(0, 255)
+    .toLowerCase();
+}

packages/adapter-azure/src/data-tables.ts

@@ -38,7 +38,8 @@ export class AzureDataTablesDatabaseService implements DatabaseService {
     collectionId,
     options,
   ) => {
-    await this.#serviceClient.createTable(collectionId, {
+    const tableName = genTableNameFromCollectionId(collectionId);
+    await this.#serviceClient.createTable(tableName, {
       abortSignal: options.abortSignal,
     });
     return;
@@ -49,9 +50,10 @@ export class AzureDataTablesDatabaseService implements DatabaseService {
     options,
   ) => {
     try {
+      const tableName = genTableNameFromCollectionId(collectionId);
       const iterator = this.#serviceClient.listTables({
         abortSignal: options.abortSignal,
-        queryOptions: { filter: odata`TableName eq ${collectionId}` },
+        queryOptions: { filter: odata`TableName eq ${tableName}` },
       });
       for await (const table of iterator) {
         if (table.name === collectionId) {
@@ -69,7 +71,8 @@ export class AzureDataTablesDatabaseService implements DatabaseService {
     collectionId,
     options,
   ) => {
-    await this.#serviceClient.deleteTable(collectionId, {
+    const tableName = genTableNameFromCollectionId(collectionId);
+    await this.#serviceClient.deleteTable(tableName, {
       abortSignal: options.abortSignal,
     });
     return;
@@ -83,9 +86,11 @@ export class AzureDataTablesDatabaseService implements DatabaseService {
     options: DatabaseServiceOptions,
   ): Promise<Document[]> => {
     const { filter, limit, select, sort } = listOptions || {};
+
+    const tableName = genTableNameFromCollectionId(collectionId);
     const tableClient = TableClient.fromConnectionString(
       this.#connectionString,
-      collectionId,
+      tableName,
     );
     const pageIterator = tableClient
       .listEntities({
@@ -127,9 +132,10 @@ export class AzureDataTablesDatabaseService implements DatabaseService {
     documentId: string,
     options: DatabaseServiceOptions,
   ): Promise<Document> => {
+    const tableName = genTableNameFromCollectionId(collectionId);
     const tableClient = TableClient.fromConnectionString(
       this.#connectionString,
-      collectionId,
+      tableName,
     );
     const entity = await tableClient.getEntity(collectionId, documentId, {
       abortSignal: options.abortSignal,
@@ -155,9 +161,10 @@ export class AzureDataTablesDatabaseService implements DatabaseService {
     documentData,
     options,
   ) => {
+    const tableName = genTableNameFromCollectionId(collectionId);
     const tableClient = TableClient.fromConnectionString(
       this.#connectionString,
-      collectionId,
+      tableName,
     );
     await tableClient.createEntity(
       {
@@ -176,9 +183,10 @@ export class AzureDataTablesDatabaseService implements DatabaseService {
     documentId,
     options,
   ) => {
+    const tableName = genTableNameFromCollectionId(collectionId);
     const tableClient = TableClient.fromConnectionString(
       this.#connectionString,
-      collectionId,
+      tableName,
     );
     await tableClient.deleteEntity(collectionId, documentId, {
       abortSignal: options.abortSignal,
@@ -194,9 +202,10 @@ export class AzureDataTablesDatabaseService implements DatabaseService {
     documentData,
     options,
   ) => {
+    const tableName = genTableNameFromCollectionId(collectionId);
     const tableClient = TableClient.fromConnectionString(
       this.#connectionString,
-      collectionId,
+      tableName,
     );
     await tableClient.updateEntity(
       { ...documentData, partitionKey: collectionId, rowKey: documentId },
@@ -216,3 +225,11 @@ export class AzureDataTablesDatabaseService implements DatabaseService {
     } as unknown as Item;
   };
 }
+
+function genTableNameFromCollectionId(collectionId: string): string {
+  if (/^[A-Za-z][A-Za-z0-9]{2,62}$/.test(collectionId)) {
+    return collectionId;
+  }
+
+  return collectionId.replaceAll(/\W/g, "").slice(0, 63).padEnd(3, "X");
+}

packages/core/package.json

@@ -75,11 +75,6 @@
       "import": "./dist/constants.js",
       "require": "./dist/constants.cjs"
     },
-    "./router": {
-      "source": "./src/router.ts",
-      "import": "./dist/router.js",
-      "require": "./dist/router.cjs"
-    },
     "./translations": {
       "source": "./src/translations/index.ts",
       "import": "./dist/translations.js",
@@ -113,10 +108,6 @@
         "import": "./dist/constants.js",
         "require": "./dist/constants.cjs"
       },
-      "./router": {
-        "import": "./dist/router.js",
-        "require": "./dist/router.cjs"
-      },
       "./translations": {
         "import": "./dist/translations.js",
         "require": "./dist/translations.cjs"

packages/core/src/builds/model.ts

@@ -12,8 +12,8 @@ import { getStore } from "#store";
 import { writeStreamToFile } from "#utils/file-utils";
 import { getMimeType } from "#utils/mime-utils";
 import {
-  generateProjectCollectionName,
-  generateProjectContainerName,
+  generateDatabaseCollectionId,
+  generateStorageContainerId,
   Model,
   type BaseModel,
   type ListOptions,
@@ -30,7 +30,7 @@ import {
 
 export class BuildsModel extends Model<BuildType> {
   constructor(projectId: string) {
-    super(projectId, generateProjectCollectionName(projectId, "Builds"));
+    super(projectId, generateDatabaseCollectionId(projectId, "Builds"));
   }
 
   async list(options: ListOptions<BuildType> = {}): Promise<BuildType[]> {
@@ -41,7 +41,7 @@ export class BuildsModel extends Model<BuildType> {
     }
 
     const items = await this.database.listDocuments(
-      this.collectionName,
+      this.collectionId,
       options,
       this.dbOptions,
     );
@@ -81,7 +81,7 @@ export class BuildsModel extends Model<BuildType> {
       updatedAt: now,
     };
     await this.database.createDocument<BuildType>(
-      this.collectionName,
+      this.collectionId,
       build,
       this.dbOptions,
     );
@@ -103,7 +103,7 @@ export class BuildsModel extends Model<BuildType> {
     this.log("Get build '%s'...", id);
 
     const item = await this.database.getDocument(
-      this.collectionName,
+      this.collectionId,
       id,
       this.dbOptions,
     );
@@ -115,7 +115,7 @@ export class BuildsModel extends Model<BuildType> {
     this.log("Check build '%s'...", id);
 
     return await this.database.hasDocument(
-      this.collectionName,
+      this.collectionId,
       id,
       this.dbOptions,
     );
@@ -125,7 +125,7 @@ export class BuildsModel extends Model<BuildType> {
     this.log("Update build '%s''...", id);
     const parsedData = BuildUpdateSchema.parse(data);
     await this.database.updateDocument(
-      this.collectionName,
+      this.collectionId,
       id,
       { ...parsedData, updatedAt: new Date().toISOString() },
       this.dbOptions,
@@ -141,15 +141,15 @@ export class BuildsModel extends Model<BuildType> {
 
     this.debug("Delete document '%s'", buildId);
     await this.database.deleteDocument(
-      this.collectionName,
+      this.collectionId,
       buildId,
       this.dbOptions,
     );
 
     try {
       this.debug("Delete files '%s'", buildId);
       await this.storage.deleteFiles(
-        generateProjectContainerName(this.projectId),
+        generateStorageContainerId(this.projectId),
         buildId,
         this.storageOptions,
       );
@@ -325,7 +325,7 @@ export class BuildsModel extends Model<BuildType> {
 
       this.debug("(%s-%s) Upload uncompressed dir", buildSHA, variant);
       await this.storage.uploadFiles(
-        generateProjectContainerName(this.projectId),
+        generateStorageContainerId(this.projectId),
         await this.#dirToFiles(dirpath, buildSHA),
         this.storageOptions,
       );

packages/core/src/handlers/handle-purge.ts

@@ -35,7 +35,7 @@ async function purgeProject(project: ProjectType): Promise<void> {
     Date.now() - purgeBuildsAfterDays * ONE_DAY_IN_MS,
   );
   logger.log(
-    `[Project: ${projectId}] Purge builds which were last modified more than ${purgeBuildsAfterDays} days ago - since ${new Date(
+    `[Project: ${projectId}] Purge builds which were last modified more than ${purgeBuildsAfterDays} days ago - before ${new Date(
       expiryTime,
     ).toLocaleString(locale)}`,
   );

packages/core/src/handlers/handle-serve-storybook.ts

@@ -5,7 +5,7 @@ import { urlBuilder } from "#urls";
 import { authenticateOrThrow } from "#utils/auth";
 import { getMimeType } from "#utils/mime-utils";
 import { responseError } from "#utils/response";
-import { generateProjectContainerName } from "#utils/shared-model";
+import { generateStorageContainerId } from "#utils/shared-model";
 
 export async function handleServeStoryBook({
   buildSHA,
@@ -22,7 +22,7 @@ export async function handleServeStoryBook({
 
   try {
     const { content, mimeType } = await storage.downloadFile(
-      generateProjectContainerName(projectId),
+      generateStorageContainerId(projectId),
       storageFilepath,
       { abortSignal },
     );

packages/core/src/index.ts

@@ -1,12 +1,17 @@
 // oxlint-disable max-lines-per-function
 
+import * as buildsRoutes from "#builds/routes";
 import { DEFAULT_LOCALE, HEADERS } from "#constants";
+import * as labelsRoutes from "#labels/routes";
+import * as projectsRoutes from "#projects/routes";
+import { router } from "#router";
 import { localStore } from "#store";
 import { parseErrorMessage } from "#utils/error";
 import { createMiddlewaresPipelineRequestHandler } from "#utils/middleware-utils";
+import * as accountRoutes from "./account/routes";
 import { handlePurge, type HandlePurge } from "./handlers/handle-purge";
 import { handleStaticFileRoute } from "./handlers/handle-static-file-route";
-import { router } from "./router";
+import * as rootRoutes from "./root/routes";
 import { translations_enGB } from "./translations/en-gb";
 import type {
   AuthService,
@@ -16,6 +21,14 @@ import type {
   StoryBookerUser,
 } from "./types";
 
+router.registerGroup(rootRoutes);
+router.registerGroup(projectsRoutes);
+router.registerGroup(labelsRoutes);
+router.registerGroup(buildsRoutes);
+router.registerGroup(accountRoutes);
+
+export { router };
+
 export type {
   OpenAPIOptions,
   RequestHandler,