Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.
Mirrored from https://github.com/Camo67/composio.git
Synced Nov 21, 03:37 UTC
| 1 | import { afterEach, describe, expect, test } from 'bun:test'; |
| 2 | import { mkdir, mkdtemp, readFile, rm, writeFile } from 'node:fs/promises'; |
| 3 | import { tmpdir } from 'node:os'; |
| 4 | import { join, resolve } from 'node:path'; |
| 5 | import type { FileObject } from 'next-validate-link'; |
| 6 | import { validateSdkMarkdownLinks } from '../../scripts/validate-sdk-doc-links'; |
| 7 | |
| 8 | let temporaryDirectory: string | undefined; |
| 9 | |
| 10 | afterEach(async () => { |
| 11 | if (!temporaryDirectory) return; |
| 12 | await rm(temporaryDirectory, { recursive: true, force: true }); |
| 13 | temporaryDirectory = undefined; |
| 14 | }); |
| 15 | |
| 16 | async function fixtureFiles(sourceContent: string): Promise<FileObject[]> { |
| 17 | temporaryDirectory = await mkdtemp(join(tmpdir(), 'sdk-doc-links-')); |
| 18 | const sourcePath = join(temporaryDirectory, 'api', 'composio.md'); |
| 19 | const targetPath = join(temporaryDirectory, 'advanced', 'guide.md'); |
| 20 | await mkdir(join(temporaryDirectory, 'api'), { recursive: true }); |
| 21 | await mkdir(join(temporaryDirectory, 'advanced'), { recursive: true }); |
| 22 | await writeFile(sourcePath, sourceContent); |
| 23 | await writeFile( |
| 24 | targetPath, |
| 25 | '## Security: **sensitive** `local` paths\n\n~~~md\n## Heading in example\n~~~\n' |
| 26 | ); |
| 27 | |
| 28 | return Promise.all( |
| 29 | [sourcePath, targetPath].map(async (path, index) => ({ |
| 30 | path: resolve(path), |
| 31 | content: await readFile(path, 'utf-8'), |
| 32 | url: index === 0 ? '/sdk-docs/api/composio.md' : '/sdk-docs/advanced/guide.md', |
| 33 | })) |
| 34 | ); |
| 35 | } |
| 36 | |
| 37 | describe('SDK documentation links', () => { |
| 38 | test('accepts an existing relative Markdown target and heading anchor', async () => { |
| 39 | const files = await fixtureFiles( |
| 40 | '[Guide](../advanced/guide.md#security-sensitive-local-paths)\n' |
| 41 | ); |
| 42 | |
| 43 | expect(await validateSdkMarkdownLinks(files)).toEqual([]); |
| 44 | }); |
| 45 | |
| 46 | test('rejects missing Markdown targets and missing heading anchors', async () => { |
| 47 | const files = await fixtureFiles( |
| 48 | [ |
| 49 | '[Missing file](./advanced/guide.md#security-sensitive-local-paths)', |
| 50 | '[Missing heading](../advanced/guide.md#not-a-real-heading)', |
| 51 | '[Heading in example](../advanced/guide.md#heading-in-example)', |
| 52 | '[Missing page heading](#not-a-real-heading)', |
| 53 | '', |
| 54 | ].join('\n') |
| 55 | ); |
| 56 | |
| 57 | const errors = await validateSdkMarkdownLinks(files); |
| 58 | |
| 59 | expect(errors.flatMap(result => result.errors.map(error => error.url)).sort()).toEqual( |
| 60 | [ |
| 61 | './advanced/guide.md#security-sensitive-local-paths', |
| 62 | '../advanced/guide.md#not-a-real-heading', |
| 63 | '../advanced/guide.md#heading-in-example', |
| 64 | '#not-a-real-heading', |
| 65 | '../assets/example.png', |
| 66 | ].sort() |
| 67 | ); |
| 68 | }); |
| 69 | |
| 70 | test('checks anchors in linked Markdown files outside the SDK docs folder', async () => { |
| 71 | const files = await fixtureFiles('[Provider](../packages/provider.md#missing-heading)\n'); |
| 72 | const targetPath = join(temporaryDirectory!, 'packages', 'provider.md'); |
| 73 | await mkdir(join(temporaryDirectory!, 'packages'), { recursive: true }); |
| 74 | await writeFile(targetPath, '## Provider setup\n'); |
| 75 | |
| 76 | const errors = await validateSdkMarkdownLinks(files); |
| 77 | |
| 78 | expect(errors.flatMap(result => result.errors.map(error => error.url))).toEqual([ |
| 79 | '../packages/provider.md#missing-heading', |
| 80 | ]); |
| 81 | }); |
| 82 | }); |