Add ability to specify sub categories in sidebar.json (#891)

lib/server/__tests__/__fixtures__/metadata-subcategories.js

@@ -0,0 +1,65 @@
+module.exports = {
+  'en-doc1': {
+    id: 'en-doc1',
+    title: 'Document 1',
+    source: 'doc1.md',
+    version: 'next',
+    permalink: 'docs/en/next/doc1.html',
+    localized_id: 'doc1',
+    language: 'en',
+    sidebar: 'docs',
+    category: 'Test',
+    next_id: 'doc2',
+    next: 'en-doc2',
+    next_title: 'Document 2',
+    sub_category: 'Sub Cat 1',
+    sort: 1,
+  },
+  'en-doc2': {
+    id: 'en-doc2',
+    title: 'Document 2',
+    source: 'doc2.md',
+    version: 'next',
+    permalink: 'docs/en/next/doc2.html',
+    localized_id: 'doc2',
+    language: 'en',
+    sidebar: 'docs',
+    category: 'Test',
+    previous_id: 'doc1',
+    previous: 'en-doc1',
+    previous_title: 'Document 1',
+    sub_category: 'Sub Cat 1',
+    sort: 2,
+  },
+  'en-doc3': {
+    id: 'en-doc3',
+    title: 'Document 3',
+    source: 'doc3.md',
+    version: 'next',
+    permalink: 'docs/en/next/doc3.html',
+    localized_id: 'doc3',
+    language: 'en',
+    sidebar: 'docs',
+    category: 'Test',
+    previous_id: 'doc2',
+    previous: 'en-doc2',
+    previous_title: 'Document 2',
+    sub_category: 'Sub Cat 2',
+    sort: 3,
+  },
+  'en-doc4': {
+    id: 'en-doc4',
+    title: 'Document 4',
+    source: 'doc4.md',
+    version: 'next',
+    permalink: 'docs/en/next/doc4.html',
+    localized_id: 'doc4',
+    language: 'en',
+    sidebar: 'docs',
+    category: 'Test 2',
+    previous_id: 'doc3',
+    previous: 'en-doc3',
+    previous_title: 'Document 3',
+    sort: 4,
+  },
+};

lib/server/__tests__/__fixtures__/metadata.js

@@ -12,6 +12,7 @@ module.exports = {
     next_id: 'doc2',
     next: 'en-doc2',
     next_title: 'Document 2',
+    sort: 1,
   },
   'en-doc2': {
     id: 'en-doc2',
@@ -26,6 +27,22 @@ module.exports = {
     previous_id: 'doc1',
     previous: 'en-doc1',
     previous_title: 'Document 1',
+    sort: 2,
+  },
+  'en-doc3': {
+    id: 'en-doc3',
+    title: 'Document 3',
+    source: 'doc3.md',
+    version: 'next',
+    permalink: 'docs/en/next/doc3.html',
+    localized_id: 'doc3',
+    language: 'en',
+    sidebar: 'docs',
+    category: 'Test 2',
+    previous_id: 'doc2',
+    previous: 'en-doc2',
+    previous_title: 'Document 2',
+    sort: 3,
   },
   'ko-doc1': {
     id: 'ko-doc1',

lib/server/__tests__/__fixtures__/sidebar-subcategories.js

@@ -0,0 +1,11 @@
+module.exports = {
+  docs: {
+    'First Category': {
+      'Sub Cat One': ['doc2', 'doc1'],
+      'Sub Cat Two': ['doc3', 'doc5'],
+    },
+    'Second Category': {
+      Hello: ['doc4'],
+    },
+  },
+};

lib/server/__tests__/__fixtures__/sidebar.js

@@ -0,0 +1,6 @@
+module.exports = {
+  docs: {
+    'First Category': ['doc1', 'doc2'],
+    'Second Category': ['doc4', 'doc3'],
+  },
+};

lib/server/__tests__/readCategories.test.js

@@ -0,0 +1,91 @@
+/**
+ * Copyright (c) 2017-present, Facebook, Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+const readCategories = require('../readCategories');
+const generalMetadata = require('./__fixtures__/metadata.js');
+const subCategoryMetadata = require('./__fixtures__/metadata-subcategories.js');
+
+const languages = [
+  {
+    enabled: true,
+    name: 'English',
+    tag: 'en',
+  },
+  {
+    enabled: true,
+    name: 'Foo',
+    tag: 'ko',
+  },
+];
+
+const languagesMultiple = [
+  {
+    enabled: false,
+    name: 'English',
+    tag: 'en',
+  },
+  {
+    enabled: true,
+    name: 'Foo',
+    tag: 'ko',
+  },
+];
+
+describe('readCategories', () => {
+  test('should return proper categories and their pages', () => {
+    const categories = readCategories('docs', generalMetadata, languages);
+
+    expect(categories.en).toBeDefined();
+    expect(categories.en.length).toBe(2);
+
+    expect(categories.en[0].name).toBe('Test');
+    expect(categories.en[0].links.length).toBe(2);
+    expect(categories.en[0].links[0].id).toBe('en-doc1');
+    expect(categories.en[0].links[1].id).toBe('en-doc2');
+
+    expect(categories.en[1].name).toBe('Test 2');
+    expect(categories.en[1].links.length).toBe(1);
+    expect(categories.en[1].links[0].id).toBe('en-doc3');
+  });
+
+  test('should return proper data with categories and sub categories', () => {
+    const categories = readCategories('docs', subCategoryMetadata, languages);
+
+    expect(categories.en).toBeDefined();
+    expect(categories.ko).toBeDefined();
+    expect(categories.en.length).toBe(2);
+
+    expect(categories.en[0].name).toBe('Test');
+    expect(categories.en[0].links.length).toBe(0);
+    expect(categories.en[0].sub_categories.length).toBe(2);
+
+    expect(categories.en[0].sub_categories[0].name).toBe('Sub Cat 1');
+    expect(categories.en[0].sub_categories[0].links.length).toBe(2);
+    expect(categories.en[0].sub_categories[0].links[0].id).toBe('en-doc1');
+    expect(categories.en[0].sub_categories[0].links[1].id).toBe('en-doc2');
+
+    expect(categories.en[0].sub_categories[1].name).toBe('Sub Cat 2');
+    expect(categories.en[0].sub_categories[1].links.length).toBe(1);
+    expect(categories.en[0].sub_categories[1].links[0].id).toBe('en-doc3');
+
+    expect(categories.en[1].name).toBe('Test 2');
+    expect(categories.en[1].links.length).toBe(1);
+    expect(categories.en[1].links[0].id).toBe('en-doc4');
+    expect(categories.en[1].sub_categories).not.toBeDefined();
+  });
+
+  test('should return proper languages when not enabled', () => {
+    const categories = readCategories(
+      'docs',
+      generalMetadata,
+      languagesMultiple
+    );
+
+    expect(categories.en).not.toBeDefined();
+    expect(categories.ko).toBeDefined();
+  });
+});

lib/server/__tests__/readMetadata.test.js

@@ -0,0 +1,77 @@
+/**
+ * Copyright (c) 2017-present, Facebook, Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+const {readSidebar} = require('../readMetadata');
+const sidebar = require('./__fixtures__/sidebar');
+const sidebarSubCategories = require('./__fixtures__/sidebar-subcategories');
+
+jest.mock('../env', () => ({
+  translation: {
+    enabled: true,
+    enabledLanguages: () => [
+      {
+        enabled: true,
+        name: 'English',
+        tag: 'en',
+      },
+      {
+        enabled: true,
+        name: '한국어',
+        tag: 'ko',
+      },
+    ],
+  },
+  versioning: {
+    enabled: true,
+    defaultVersion: '1.0.0',
+  },
+}));
+
+jest.mock(`${process.cwd()}/siteConfig.js`, () => true, {virtual: true});
+jest.mock(`${process.cwd()}/sidebar.json`, () => true, {virtual: true});
+
+describe('readMetadata', () => {
+  describe('readSidebar', () => {
+    it('should verify regular category data and verify sort', () => {
+      const order = readSidebar(sidebar);
+
+      // Put in this order to verify sort
+      ['doc1', 'doc2', 'doc4', 'doc3'].forEach((id, index) => {
+        expect(order[id]).toBeDefined();
+        expect(order[id].sort).toBe(index + 1);
+      });
+
+      expect(order.doc1.previous).toBeUndefined();
+      expect(order.doc2.previous).toBe('doc1');
+
+      expect(order.doc1.next).toBe('doc2');
+      expect(order.doc2.next).toBe('doc4');
+
+      expect(order.doc1.sub_category).toBeFalsy();
+    });
+
+    test('should verify sub category data and verify sort', () => {
+      const order = readSidebar(sidebarSubCategories);
+
+      // Put in this order to verify sort
+      ['doc2', 'doc1', 'doc3', 'doc5', 'doc4'].forEach((id, index) => {
+        expect(order[id]).toBeDefined();
+        expect(order[id].sort).toBe(index + 1);
+      });
+
+      expect(order.doc2.sidebar).toBe('docs');
+      expect(order.doc2.category).toBe('First Category');
+      expect(order.doc2.sub_category).toBe('Sub Cat One');
+
+      expect(order.doc1.category).toBe('First Category');
+      expect(order.doc1.sub_category).toBe('Sub Cat One');
+
+      expect(order.doc3.category).toBe('First Category');
+      expect(order.doc3.sub_category).toBe('Sub Cat Two');
+    });
+  });
+});

lib/server/__tests__/utils.test.js

@@ -88,4 +88,63 @@ describe('server utils', () => {
     expect(utils.getSubDir(docE, docsDir)).toBeNull();
     expect(utils.getSubDir(docE, translatedDir)).toEqual('lol/lah');
   });
+
+  describe('validateSidebar', () => {
+    test('should throw an error for invalid pages', () => {
+      const metadata = {
+        id: 'doc1',
+        sidebar: 'docs',
+        next_id: 'doc2',
+        next: 'doc2',
+      };
+
+      const pages = {
+        doc1: {},
+      };
+
+      expect(() => {
+        utils.validateSidebar(metadata, pages);
+      }).toThrow(
+        `Improper sidebars.json file, document with id 'doc2' not found. Make sure that documents with the ids specified in sidebars.json exist and that no ids are repeated.`
+      );
+    });
+
+    test('should throw an error for invalid version pages', () => {
+      const metadata = {
+        id: 'doc1',
+        version: 'foo',
+        sidebar: 'docs',
+        next_id: 'doc2',
+        next: 'doc2',
+      };
+
+      const pages = {
+        doc1: {},
+      };
+
+      expect(() => {
+        utils.validateSidebar(metadata, pages);
+      }).toThrow(
+        `Improper sidebars file for version foo, document with id 'doc2' not found. Make sure that all documents with ids specified in this version's sidebar file exist and that no ids are repeated.`
+      );
+    });
+
+    test('should pass validate', () => {
+      const metadata = {
+        id: 'doc1',
+        sidebar: 'docs',
+        next_id: 'doc2',
+        next: 'doc2',
+      };
+
+      const pages = {
+        doc1: {},
+        doc2: {},
+      };
+
+      expect(() => {
+        utils.validateSidebar(metadata, pages);
+      }).not.toThrow();
+    });
+  });
 });