feat: validate sidebar sort config

jpmorganchase · Nov 3, 2023 · 3de820f · 3de820f
1 parent 5c83b60
commit 3de820f
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 23 deletions.
diff --git a/packages/plugins/src/SidebarPlugin.ts b/packages/plugins/src/SidebarPlugin.ts
@@ -1,8 +1,9 @@
 import path from 'path';
 import type { Plugin as PluginType, Page } from '@jpmorganchase/mosaic-types';
+import { sidebarSortConfigSchema, type SortConfig } from '@jpmorganchase/mosaic-schemas';
 import { cloneDeep } from 'lodash-es';
 
-import { type SortConfig, type SidebarDataNode, sortSidebarData } from './utils/sortSidebarData.js';
+import { type SidebarDataNode, sortSidebarData } from './utils/sortSidebarData.js';
 
 function createFileGlob(patterns, pageExtensions) {
   if (Array.isArray(patterns)) {
@@ -149,7 +150,18 @@ const SidebarPlugin: PluginType<SidebarPluginPage, SidebarPluginOptions, Sidebar
           const sharedSortConfig = page?.sharedConfig?.sidebar?.sort;
 
           if (sharedSortConfig) {
-            sortConfigPages[`${path.posix.dirname(page.fullPath)}`] = sharedSortConfig;
+            try {
+              sidebarSortConfigSchema.parse(sharedSortConfig);
+              sortConfigPages[`${path.posix.dirname(page.fullPath)}`] = sharedSortConfig;
+            } catch (e) {
+              /**
+               * Don't throw a PluginError here as this will stop the sidebar being generated.
+               * Plugins need a way to log errors/warnings without exceptions
+               */
+              console.error(
+                `[Mosaic] SidebarPlugin - Invalid sidebar sort config found in ${page.fullPath}`
+              );
+            }
           }
 
           const priority = page.sidebar?.priority;

diff --git a/packages/plugins/src/utils/sortSidebarData.ts b/packages/plugins/src/utils/sortSidebarData.ts
@@ -1,12 +1,6 @@
-type FieldData = string | number;
-type SortConfigDataType = 'string' | 'number' | 'date';
-
-export interface SortConfig {
-  field: string;
-  dataType: SortConfigDataType;
-  arrange: 'asc' | 'desc';
-}
+import type { SortConfig } from '@jpmorganchase/mosaic-schemas';
 
+type FieldData = string | number;
 interface SortConfigWithValue extends SortConfig {
   fieldData: FieldData;
 }
@@ -21,9 +15,11 @@ export interface SidebarDataNode {
   sharedSortConfig?: SortConfigWithValue;
 }
 
-function doSort(dataType: SortConfigDataType, a: FieldData, b: FieldData) {
-  if (dataType === 'number' || dataType === 'date') {
-    return (a as number) - (b as number);
+const isNumber = (fieldData: FieldData): fieldData is number => typeof fieldData === 'number';
+
+function doSort(a: FieldData, b: FieldData) {
+  if (isNumber(a) && isNumber(b)) {
+    return a - b;
   }
   if (a > b) {
     return 1;
@@ -40,18 +36,10 @@ function sortBySharedSortConfig(pageA: SidebarDataNode, pageB: SidebarDataNode)
   }
 
   if (pageA.sharedSortConfig?.arrange === 'asc') {
-    return doSort(
-      pageA.sharedSortConfig.dataType,
-      pageA.sharedSortConfig.fieldData,
-      pageB.sharedSortConfig.fieldData
-    );
+    return doSort(pageA.sharedSortConfig.fieldData, pageB.sharedSortConfig.fieldData);
   }
 
-  return doSort(
-    pageB.sharedSortConfig.dataType,
-    pageB.sharedSortConfig.fieldData,
-    pageA.sharedSortConfig.fieldData
-  );
+  return doSort(pageB.sharedSortConfig.fieldData, pageA.sharedSortConfig.fieldData);
 }
 
 export function sortSidebarData(sidebarData: SidebarDataNode[]) {

diff --git a/packages/schemas/src/index.ts b/packages/schemas/src/index.ts
@@ -1,6 +1,7 @@
 export * from './breadcrumbsLayoutSchema.js';
 export * from './credentialsSchema.js';
 export * from './fileExtensionSchema.js';
+export * from './sidebarSortConfigSchema.js';
 export * from './validate.js';
 
 export * from './SnapshotFileEnvSchema.js';

diff --git a/packages/schemas/src/sidebarSortConfigSchema.ts b/packages/schemas/src/sidebarSortConfigSchema.ts
@@ -0,0 +1,9 @@
+import { z } from 'zod';
+
+export const sidebarSortConfigSchema = z.object({
+  field: z.string(),
+  dataType: z.union([z.literal('string'), z.literal('number'), z.literal('date')]),
+  arrange: z.union([z.literal('asc'), z.literal('desc')])
+});
+
+export type SortConfig = z.infer<typeof sidebarSortConfigSchema>;