signoz.io/tests/api-reference-version-markdown.test.js at f088a927b3af52699a2c9ef9aa1e62868d447a56 · SigNoz/signoz.io · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
const test = require('node:test')
const assert = require('node:assert/strict')
const { loadTsModule } = require('./helpers/loadTsModule')

const {
  parseApiReferenceVersionPath,
  shouldRewriteApiReferenceVersionToMarkdown,
  buildApiReferenceVersionMarkdownRewritePath,
  shouldRewriteApiReferenceToOpenAPISpec,
  shouldRewriteApiReferenceIndexToMarkdown,
} = loadTsModule('utils/apiReferenceMarkdownRouting.ts')

test('parseApiReferenceVersionPath accepts release tags, latest, and .md twins', () => {
  assert.equal(parseApiReferenceVersionPath('/api-reference/v0.139.0'), 'v0.139.0')
  assert.equal(parseApiReferenceVersionPath('/api-reference/v0.139.0/'), 'v0.139.0')
  assert.equal(parseApiReferenceVersionPath('/api-reference/v0.139.0.md'), 'v0.139.0')
  assert.equal(parseApiReferenceVersionPath('/api-reference/latest'), 'latest')
  assert.equal(parseApiReferenceVersionPath('/api-reference/latest.md'), 'latest')
})

test('parseApiReferenceVersionPath rejects the index and non-version segments', () => {
  assert.equal(parseApiReferenceVersionPath('/api-reference'), null)
  assert.equal(parseApiReferenceVersionPath('/api-reference/'), null)
  assert.equal(parseApiReferenceVersionPath('/api-reference/not-a-version'), null)
  assert.equal(parseApiReferenceVersionPath('/api-reference/v0.139.0/query-range'), null)
  assert.equal(parseApiReferenceVersionPath('/docs/introduction'), null)
})

// 31 requests over 30 days across 7 release tags, all previously 404.
test('versioned .md URLs rewrite to the markdown twin', () => {
  assert.equal(
    shouldRewriteApiReferenceVersionToMarkdown('/api-reference/v0.139.0.md', false),
    true
  )
  assert.equal(shouldRewriteApiReferenceVersionToMarkdown('/api-reference/latest.md', false), true)
  assert.equal(
    buildApiReferenceVersionMarkdownRewritePath('/api-reference/v0.139.0.md'),
    '/api/api-reference-markdown/v0.139.0'
  )
  assert.equal(
    buildApiReferenceVersionMarkdownRewritePath('/api-reference/latest'),
    '/api/api-reference-markdown/latest'
  )
})

test('Accept: text/markdown on a version now gets markdown, not YAML', () => {
  assert.equal(shouldRewriteApiReferenceVersionToMarkdown('/api-reference/v0.139.0', true), true)
  assert.equal(
    shouldRewriteApiReferenceToOpenAPISpec('/api-reference/v0.139.0', 'text/markdown'),
    false
  )
})

test('YAML is still served when the client actually asks for YAML', () => {
  ;['text/yaml', 'application/yaml', 'application/x-yaml', 'application/vnd.oai.openapi'].forEach(
    (accept) => {
      assert.equal(
        shouldRewriteApiReferenceToOpenAPISpec('/api-reference/v0.139.0', accept),
        true,
        `expected YAML for Accept: ${accept}`
      )
    }
  )
  assert.equal(shouldRewriteApiReferenceToOpenAPISpec('/api-reference/latest', 'text/yaml'), true)
})

test('the YAML path no longer depends on user-agent sniffing', () => {
  // Previously gated on isBot, so a browser UA sending the same header got HTML.
  assert.equal(shouldRewriteApiReferenceToOpenAPISpec('/api-reference/v0.139.0', 'text/yaml'), true)
  assert.equal(
    shouldRewriteApiReferenceToOpenAPISpec('/api-reference/v0.139.0', 'text/html'),
    false
  )
  assert.equal(shouldRewriteApiReferenceToOpenAPISpec('/api-reference/v0.139.0', ''), false)
})

test('the index keeps its own markdown twin and is never treated as a version', () => {
  assert.equal(shouldRewriteApiReferenceIndexToMarkdown('/api-reference', true), true)
  assert.equal(shouldRewriteApiReferenceVersionToMarkdown('/api-reference', true), false)
  assert.equal(shouldRewriteApiReferenceToOpenAPISpec('/api-reference', 'text/yaml'), false)
})

test('plain HTML requests to a version are untouched', () => {
  assert.equal(shouldRewriteApiReferenceVersionToMarkdown('/api-reference/v0.139.0', false), false)
  assert.equal(
    shouldRewriteApiReferenceToOpenAPISpec('/api-reference/v0.139.0', 'text/html'),
    false
  )
})