onspring-api-docs/tests/unit/Markdoc.spec.tsx

import Clients from '@/app/components/Clients';
import CodeSnippet from '@/app/components/CodeSnippet';
import Fence from '@/app/components/Fence';
import { DOCS_PATH } from '@/app/constants';
import * as MarkdocLibrary from '@/app/lib/markdoc';
import { Doc } from '@/app/types/types';
import { default as Markdoc } from '@markdoc/markdoc';
import fs from 'fs';
import path from 'path';
import React from 'react';

describe('Markdoc lib functions', () => {
  describe('getCopyPath', () => {
    const version = 'v1.0.0';

    const doc: Doc = {
      title: 'Title',
      folder: 'folder',
      copy: 'copy.md',
    };

    const docPath = 'path/to/doc';

    it('returns empty string if doc.copy is undefined', () => {
      const doc: Doc = {
        title: 'Title',
        folder: 'folder',
      };

      const result = MarkdocLibrary.getCopyPath(
        version,
        doc,
        docPath
      );

      expect(result).toEqual('');
    });

    it('returns correct copy path', () => {
      const result = MarkdocLibrary.getCopyPath(
        version,
        doc,
        docPath
      );

      const expected = path.join(
        DOCS_PATH,
        version,
        docPath,
        doc.copy!
      );

      expect(result).toEqual(expected);
    });

    it('returns correct copy path with leading/trailing slashes in docPath', () => {
      const result = MarkdocLibrary.getCopyPath(
        version,
        doc,
        '/path/to/doc/'
      );

      const expected = path.join(
        DOCS_PATH,
        version,
        docPath,
        doc.copy!
      );

      expect(result).toEqual(expected);
    });

    it('returns correct copy path with different version', () => {
      const result = MarkdocLibrary.getCopyPath(
        'v2.0.0',
        doc,
        docPath
      );

      const expected = path.join(
        DOCS_PATH,
        'v2.0.0',
        docPath,
        doc.copy!
      );

      expect(result).toEqual(expected);
    });

    it('returns correct copy path with nested docPath', () => {
      const result = MarkdocLibrary.getCopyPath(
        version,
        doc,
        'path/to/nested/doc'
      );

      const expected = path.join(
        DOCS_PATH,
        version,
        'path/to/nested/doc',
        doc.copy!
      );

      expect(result).toEqual(expected);
    });
  });

  describe('getExamplePath', () => {
    const version = 'v1.0.0';

    const doc: Doc = {
      title: 'Title',
      folder: 'folder',
      example: 'example.md',
    };

    const docPath = 'path/to/doc';

    it('returns empty string if doc.example is undefined', () => {
      const doc: Doc = {
        title: 'Title',
        folder: 'folder',
      };

      const result = MarkdocLibrary.getExamplePath(
        version,
        doc,
        docPath
      );

      expect(result).toEqual('');
    });

    it('returns correct example path', () => {
      const result = MarkdocLibrary.getExamplePath(
        version,
        doc,
        docPath
      );

      const expected = path.join(
        DOCS_PATH,
        version,
        docPath,
        doc.example!
      );

      expect(result).toEqual(expected);
    });

    it('returns correct example path with leading/trailing slashes in docPath', () => {
      const result = MarkdocLibrary.getExamplePath(
        version,
        doc,
        '/path/to/doc/'
      );

      const expected = path.join(
        DOCS_PATH,
        version,
        docPath,
        doc.example!
      );

      expect(result).toEqual(expected);
    });

    it('returns correct example path with different version', () => {
      const result = MarkdocLibrary.getExamplePath(
        'v2.0.0',
        doc,
        docPath
      );

      const expected = path.join(
        DOCS_PATH,
        'v2.0.0',
        docPath,
        doc.example!
      );

      expect(result).toEqual(expected);
    });

    it('returns correct example path with nested docPath', () => {
      const result = MarkdocLibrary.getExamplePath(
        version,
        doc,
        'path/to/nested/doc'
      );

      const expected = path.join(
        DOCS_PATH,
        version,
        'path/to/nested/doc',
        doc.example!
      );

      expect(result).toEqual(expected);
    });
  });

  describe('parseMarkdown', () => {
    const sourcePath = 'test.md';
    const sourceContent = '# Test Heading';

    beforeAll(() => {
      jest
        .spyOn(fs, 'readFileSync')
        .mockReturnValue(sourceContent);
    });

    afterAll(() => {
      jest.restoreAllMocks();
    });

    it('should parse markdown file and return react node', () => {
      const expected = (
        <article>
          <h1>Test Heading</h1>
        </article>
      );

      const result =
        MarkdocLibrary.parseMarkdown(sourcePath);

      expect(result).toEqual(expected);
    });

    it('should read source file using the correct path', () => {
      MarkdocLibrary.parseMarkdown(sourcePath);

      expect(fs.readFileSync).toHaveBeenCalledWith(
        sourcePath,
        'utf8'
      );
    });

    it('should transform the AST using markDocConfig', () => {
      const ast = Markdoc.parse(sourceContent);
      const spy = jest.spyOn(Markdoc, 'transform');

      MarkdocLibrary.parseMarkdown(sourcePath);

      expect(spy).toHaveBeenCalledWith(
        ast,
        MarkdocLibrary.markDocConfig as any
      );
    });

    it('should render react components using Markdoc.renderers', () => {
      const ast = Markdoc.parse(sourceContent);

      const content = Markdoc.transform(
        ast,
        MarkdocLibrary.markDocConfig as any
      );

      const expected = (
        <article>
          <h1>Test Heading</h1>
        </article>
      );

      const spy = jest.spyOn(Markdoc.renderers, 'react');
      const result =
        MarkdocLibrary.parseMarkdown(sourcePath);

      expect(spy).toHaveBeenCalledWith(content, React, {
        components: {
          CodeSnippet: CodeSnippet,
          Fence: Fence,
          Clients: Clients,
        },
      });

      expect(result).toEqual(expected);
    });
  });

  describe('getCopyChild', () => {
    it('should return the correct child copy react nodes for the given doc', () => {
      const result = MarkdocLibrary.getCopyPath(
        'version',
        { title: 'hello', folder: 'hello' },
        'hello'
      );

      expect(result).toEqual('hello');
    });
  });
});