@antora/content-aggregator 3.0.3 → 3.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,14 +1,15 @@
1
1
  'use strict'
2
2
 
3
- const camelCaseKeys = require('camelcase-keys')
3
+ const computeOrigin = require('./compute-origin')
4
4
  const { createHash } = require('crypto')
5
5
  const createGitHttpPlugin = require('./git-plugin-http')
6
6
  const decodeUint8Array = require('./decode-uint8-array')
7
+ const deepClone = require('./deep-clone')
8
+ const deepFlatten = require('./deep-flatten')
7
9
  const EventEmitter = require('events')
8
10
  const expandPath = require('@antora/expand-path-helper')
9
11
  const File = require('./file')
10
12
  const filterRefs = require('./filter-refs')
11
- const flattenDeep = require('./flatten-deep')
12
13
  const fs = require('fs')
13
14
  const { promises: fsp } = fs
14
15
  const getCacheDir = require('cache-directory')
@@ -17,11 +18,13 @@ const git = require('./git')
17
18
  const { NotFoundError, ObjectTypeError, UnknownTransportError, UrlParseError } = git.Errors
18
19
  const globStream = require('glob-stream')
19
20
  const invariably = require('./invariably')
21
+ const logger = require('./logger')
20
22
  const { makeMatcherRx, versionMatcherOpts: VERSION_MATCHER_OPTS } = require('./matcher')
21
23
  const MultiProgress = require('multi-progress') // calls require('progress') as a peer dependencies
22
24
  const ospath = require('path')
23
25
  const { posix: path } = ospath
24
- const posixify = ospath.sep === '\\' ? (p) => p.replace(/\\/g, '/') : undefined
26
+ const posixify = require('./posixify')
27
+ const removeGitSuffix = require('./remove-git-suffix')
25
28
  const { fs: resolvePathGlobsFs, git: resolvePathGlobsGit } = require('./resolve-path-globs')
26
29
  const { pipeline, Writable } = require('stream')
27
30
  const forEach = (write) => new Writable({ objectMode: true, write })
@@ -44,12 +47,9 @@ const {
44
47
  const ANY_SEPARATOR_RX = /[:/]/
45
48
  const CSV_RX = /\s*,\s*/
46
49
  const VENTILATED_CSV_RX = /\s*,\s+/
47
- const EDIT_URL_TEMPLATE_VAR_RX = /\{(web_url|ref(?:hash|name)|path)\}/g
48
- const GIT_SUFFIX_RX = /(?:(?:(?:\.git)?\/)?\.git|\/)$/
49
50
  const GIT_URI_DETECTOR_RX = /:(?:\/\/|[^/\\])/
50
- const HEADS_DIR_RX = /^heads\//
51
- const HOSTED_GIT_REPO_RX = /^(?:https?:\/\/|.+@)(git(?:hub|lab)\.com|bitbucket\.org|pagure\.io)[/:](.+?)(?:\.git)?$/
52
51
  const HTTP_ERROR_CODE_RX = new RegExp('^' + git.Errors.HttpError.code + '$', 'i')
52
+ const NEWLINE_RX = /\n/g
53
53
  const PATH_SEPARATOR_RX = /[/]/g
54
54
  const SHORTEN_REF_RX = /^refs\/(?:heads|remotes\/[^/]+|tags)\//
55
55
  const SPACE_RX = / /g
@@ -154,13 +154,14 @@ async function collectFiles (sourcesByUrl, loadOpts, concurrency) {
154
154
 
155
155
  function buildAggregate (componentVersionBuckets) {
156
156
  return [
157
- ...flattenDeep(componentVersionBuckets)
157
+ ...deepFlatten(componentVersionBuckets)
158
158
  .reduce((accum, batch) => {
159
159
  const key = batch.version + '@' + batch.name
160
160
  const entry = accum.get(key)
161
161
  if (!entry) return accum.set(key, batch)
162
- const files = batch.files
162
+ const { files, origins } = batch
163
163
  ;(batch.files = entry.files).push(...files)
164
+ ;(batch.origins = entry.origins).push(origins[0])
164
165
  Object.assign(entry, batch)
165
166
  return accum
166
167
  }, new Map())
@@ -257,9 +258,17 @@ function extractCredentials (url) {
257
258
 
258
259
  async function collectFilesFromSource (source, repo, remoteName, authStatus) {
259
260
  const originUrl = repo.url || (await resolveRemoteUrl(repo, remoteName))
260
- return selectReferences(source, repo, remoteName).then((refs) =>
261
- Promise.all(refs.map((ref) => collectFilesFromReference(source, repo, remoteName, authStatus, ref, originUrl)))
262
- )
261
+ return selectReferences(source, repo, remoteName).then((refs) => {
262
+ if (!refs.length) {
263
+ const { url, branches, tags, startPath, startPaths } = source
264
+ const startPathInfo =
265
+ 'startPaths' in source ? { 'start paths': startPaths || undefined } : { 'start path': startPath || undefined }
266
+ const sourceInfo = yaml.dump({ url, branches, tags, ...startPathInfo }, { flowLevel: 1 }).trimRight()
267
+ logger.info(`No matching references found for content source entry (${sourceInfo.replace(NEWLINE_RX, ' | ')})`)
268
+ return []
269
+ }
270
+ return Promise.all(refs.map((it) => collectFilesFromReference(source, repo, remoteName, authStatus, it, originUrl)))
271
+ })
263
272
  }
264
273
 
265
274
  // QUESTION should we resolve HEAD to a ref eagerly to avoid having to do a match on it?
@@ -267,7 +276,7 @@ async function selectReferences (source, repo, remote) {
267
276
  let { branches: branchPatterns, tags: tagPatterns, worktrees: worktreePatterns = '.' } = source
268
277
  const isBare = repo.noCheckout
269
278
  const patternCache = repo.cache[REF_PATTERN_CACHE_KEY]
270
- const noWorktree = repo.url ? undefined : null
279
+ const noWorktree = repo.url ? undefined : false
271
280
  const refs = new Map()
272
281
  if (
273
282
  tagPatterns &&
@@ -403,8 +412,9 @@ async function collectFilesFromReference (source, repo, remoteName, authStatus,
403
412
  ? resolvePathGlobsFs(worktreePath, startPaths)
404
413
  : resolvePathGlobsGit(repo, ref.oid, startPaths))
405
414
  if (!startPaths.length) {
406
- const refInfo = `ref: ${ref.fullname.replace(HEADS_DIR_RX, '')}${worktreePath ? ' <worktree>' : ''}`
407
- throw new Error(`no start paths found in ${displayUrl} (${refInfo})`)
415
+ const where = worktreePath || (worktreePath === false ? repo.gitdir : displayUrl)
416
+ const flag = worktreePath ? ' <worktree>' : ref.remote && worktreePath === false ? ` <remotes/${ref.remote}>` : ''
417
+ throw new Error(`no start paths found in ${where} (${ref.type}: ${ref.shortname}${flag})`)
408
418
  }
409
419
  return Promise.all(
410
420
  startPaths.map((startPath) =>
@@ -417,29 +427,30 @@ async function collectFilesFromReference (source, repo, remoteName, authStatus,
417
427
  }
418
428
 
419
429
  function collectFilesFromStartPath (startPath, repo, authStatus, ref, worktreePath, originUrl, editUrl, version) {
420
- return (
421
- worktreePath ? readFilesFromWorktree(worktreePath, startPath) : readFilesFromGitTree(repo, ref.oid, startPath)
422
- )
423
- .then((files) => {
424
- const componentVersionBucket = loadComponentDescriptor(files, ref, version)
425
- const origin = computeOrigin(originUrl, authStatus, repo.gitdir, ref, startPath, worktreePath, editUrl)
426
- componentVersionBucket.files = files.map((file) => assignFileProperties(file, origin))
427
- return componentVersionBucket
428
- })
430
+ const origin = computeOrigin(originUrl, authStatus, repo.gitdir, ref, startPath, worktreePath, editUrl)
431
+ return (worktreePath ? readFilesFromWorktree(origin) : readFilesFromGitTree(repo, ref.oid, startPath))
432
+ .then((files) =>
433
+ Object.assign(deepClone((origin.descriptor = loadComponentDescriptor(files, ref, version))), {
434
+ files: files.map((file) => assignFileProperties(file, origin)),
435
+ origins: [origin],
436
+ })
437
+ )
429
438
  .catch((err) => {
430
- const msg = err.message
431
- const refInfo = `ref: ${ref.fullname.replace(HEADS_DIR_RX, '')}${worktreePath ? ' <worktree>' : ''}`
432
- const pathInfo = !startPath || msg.startsWith('the start path ') ? '' : ' | path: ' + startPath
433
- throw Object.assign(err, { message: msg.replace(/$/m, ` in ${repo.url || repo.dir} (${refInfo}${pathInfo})`) })
439
+ const where = worktreePath || (worktreePath === false ? repo.gitdir : repo.url || repo.dir)
440
+ const flag = worktreePath ? ' <worktree>' : ref.remote && worktreePath === false ? ` <remotes/${ref.remote}>` : ''
441
+ const pathInfo = startPath ? (err.message.startsWith('the start path ') ? '' : ` | start path: ${startPath}`) : ''
442
+ const message = err.message.replace(/$/m, ` in ${where} (${ref.type}: ${ref.shortname}${flag}${pathInfo})`)
443
+ throw Object.assign(err, { message })
434
444
  })
435
445
  }
436
446
 
437
- function readFilesFromWorktree (worktreePath, startPath) {
438
- const cwd = ospath.join(worktreePath, startPath, '.') // . shaves off trailing slash
447
+ function readFilesFromWorktree (origin) {
448
+ const startPath = origin.startPath
449
+ const cwd = ospath.join(origin.worktree, startPath, '.') // . shaves off trailing slash
439
450
  return fsp.stat(cwd).then(
440
451
  (startPathStat) => {
441
452
  if (!startPathStat.isDirectory()) throw new Error(`the start path '${startPath}' is not a directory`)
442
- return srcFs(cwd)
453
+ return srcFs(cwd, origin)
443
454
  },
444
455
  () => {
445
456
  throw new Error(`the start path '${startPath}' does not exist`)
@@ -447,7 +458,7 @@ function readFilesFromWorktree (worktreePath, startPath) {
447
458
  )
448
459
  }
449
460
 
450
- function srcFs (cwd) {
461
+ function srcFs (cwd, origin) {
451
462
  const relpathStart = cwd.length + 1
452
463
  return new Promise((resolve, reject, cache = Object.create(null), files = []) =>
453
464
  pipeline(
@@ -465,20 +476,28 @@ function srcFs (cwd) {
465
476
  done()
466
477
  },
467
478
  (readErr) => {
468
- done(Object.assign(readErr, { message: readErr.message.replace(`'${abspath}'`, relpath) }))
479
+ const logObject = { file: { abspath, origin } }
480
+ readErr.code === 'ENOENT'
481
+ ? logger.warn(logObject, `ENOENT: file or directory disappeared, ${readErr.syscall} ${relpath}`)
482
+ : logger.error(logObject, readErr.message.replace(`'${abspath}'`, relpath))
483
+ done()
469
484
  }
470
485
  )
471
486
  },
472
487
  (statErr) => {
488
+ const logObject = { file: { abspath, origin } }
473
489
  if (statErr.symlink) {
474
- statErr.message =
475
- statErr.code === 'ELOOP'
476
- ? `Symbolic link cycle detected at ${relpath}`
477
- : `Broken symbolic link detected at ${relpath}`
490
+ logger.error(
491
+ logObject,
492
+ (statErr.code === 'ELOOP' ? 'ELOOP: symbolic link cycle, ' : 'ENOENT: broken symbolic link, ') +
493
+ `${relpath} -> ${statErr.symlink}`
494
+ )
495
+ } else if (statErr.code === 'ENOENT') {
496
+ logger.warn(logObject, `ENOENT: file or directory disappeared, ${statErr.syscall} ${relpath}`)
478
497
  } else {
479
- statErr.message = statErr.message.replace(`'${abspath}'`, relpath)
498
+ logger.error(logObject, statErr.message.replace(`'${abspath}'`, relpath))
480
499
  }
481
- done(statErr)
500
+ done()
482
501
  }
483
502
  )
484
503
  }),
@@ -510,30 +529,26 @@ function getGitTreeAtStartPath (repo, oid, startPath) {
510
529
  function srcGitTree (repo, root, start) {
511
530
  return new Promise((resolve, reject) => {
512
531
  const files = []
513
- createGitTreeWalker(repo, root, filterGitEntry)
514
- .on('entry', (entry) => files.push(entryToFile(entry)))
532
+ createGitTreeWalker(repo, root, filterGitEntry, gitEntryToFile)
533
+ .on('entry', (file) => files.push(file))
515
534
  .on('error', reject)
516
- .on('end', () => resolve(Promise.all(files)))
535
+ .on('end', () => resolve(files))
517
536
  .walk(start)
518
537
  })
519
538
  }
520
539
 
521
- function createGitTreeWalker (repo, root, filter) {
540
+ function createGitTreeWalker (repo, root, filter, convert) {
522
541
  return Object.assign(new EventEmitter(), {
523
542
  walk (start) {
524
- return (
525
- visitGitTree(this, repo, root, filter, start)
526
- // NOTE if error is thrown, promises already being resolved won't halt
527
- .then(
528
- () => this.emit('end'),
529
- (err) => this.emit('error', err)
530
- )
543
+ return visitGitTree(this, repo, root, filter, convert, start).then(
544
+ () => this.emit('end'),
545
+ (err) => this.emit('error', err)
531
546
  )
532
547
  },
533
548
  })
534
549
  }
535
550
 
536
- function visitGitTree (emitter, repo, root, filter, parent, dirname = '', following = new Set()) {
551
+ function visitGitTree (emitter, repo, root, filter, convert, parent, dirname = '', following = new Set()) {
537
552
  const reads = []
538
553
  for (const entry of parent.tree) {
539
554
  const filterVerdict = filter(entry)
@@ -543,7 +558,7 @@ function visitGitTree (emitter, repo, root, filter, parent, dirname = '', follow
543
558
  reads.push(
544
559
  git.readTree(Object.assign({ oid: entry.oid }, repo)).then((subtree) => {
545
560
  Object.assign(subtree, { dirname: path.join(parent.dirname, entry.path) })
546
- return visitGitTree(emitter, repo, root, filter, subtree, vfilePath, following)
561
+ return visitGitTree(emitter, repo, root, filter, convert, subtree, vfilePath, following)
547
562
  })
548
563
  )
549
564
  } else if (entry.type === 'blob') {
@@ -553,56 +568,70 @@ function visitGitTree (emitter, repo, root, filter, parent, dirname = '', follow
553
568
  readGitSymlink(repo, root, parent, entry, following).then(
554
569
  (target) => {
555
570
  if (target.type === 'tree') {
556
- return visitGitTree(emitter, repo, root, filter, target, vfilePath, new Set(following).add(entry.oid))
571
+ return visitGitTree(emitter, repo, root, filter, convert, target, vfilePath, target.following)
557
572
  } else if (target.type === 'blob' && filterVerdict === true && (mode = FILE_MODES[target.mode])) {
558
- emitter.emit('entry', Object.assign({ mode, oid: target.oid, path: vfilePath }, repo))
573
+ return convert(Object.assign({ mode, oid: target.oid, path: vfilePath }, repo)).then((result) =>
574
+ emitter.emit('entry', result)
575
+ )
559
576
  }
560
577
  },
561
578
  (err) => {
562
- // NOTE this error could be caught after promise chain has already been rejected
563
- if (err instanceof NotFoundError) {
564
- err.message = `Broken symbolic link detected at ${vfilePath}`
565
- } else if (err.code === 'SymbolicLinkCycleError') {
566
- err.message = `Symbolic link cycle detected at ${vfilePath}`
579
+ if (err.symlink) {
580
+ err.message =
581
+ (err.code === 'ELOOP' ? 'ELOOP: symbolic link cycle' : 'ENOENT: broken symbolic link') +
582
+ `, ${vfilePath} -> ${err.symlink}`
567
583
  }
568
584
  throw err
569
585
  }
570
586
  )
571
587
  )
572
588
  } else if ((mode = FILE_MODES[entry.mode])) {
573
- emitter.emit('entry', Object.assign({ mode, oid: entry.oid, path: vfilePath }, repo))
589
+ reads.push(
590
+ convert(Object.assign({ mode, oid: entry.oid, path: vfilePath }, repo)).then((result) =>
591
+ emitter.emit('entry', result)
592
+ )
593
+ )
574
594
  }
575
595
  }
576
596
  }
577
597
  }
578
- return Promise.all(reads)
598
+ // NOTE preserve scan order so error for symbolic link cycle is deterministic; ensures no rejections after resolve
599
+ return Promise.allSettled(reads).then((results) => {
600
+ const rejected = results.find(({ reason }) => reason)
601
+ if (rejected) throw rejected.reason
602
+ })
579
603
  }
580
604
 
581
- function readGitSymlink (repo, root, parent, { oid }, following) {
582
- if (following.size !== (following = new Set(following).add(oid)).size) {
583
- return git.readBlob(Object.assign({ oid }, repo)).then(({ blob: target }) => {
584
- target = decodeUint8Array(target)
585
- let targetParent
586
- if (parent.dirname) {
587
- const dirname = parent.dirname + '/'
588
- target = path.join(dirname, target) // join doesn't remove trailing separator
589
- if (target.startsWith(dirname)) {
590
- target = target.substr(dirname.length)
591
- targetParent = parent
592
- } else {
593
- targetParent = root
594
- }
595
- } else {
596
- target = path.normalize(target) // normalize doesn't remove trailing separator
597
- targetParent = root
605
+ function readGitSymlink (repo, root, parent, { oid, path: name }, following) {
606
+ const dirname = parent.dirname
607
+ if (following.size === (following = new Set(following)).add(oid).size) {
608
+ const err = { name: 'SymbolicLinkCycleError', code: 'ELOOP', oid, path: `${path.join(dirname, name)}` }
609
+ return Promise.reject(Object.assign(new Error(`Symbolic link cycle detected at ${oid}:${err.path}`), err))
610
+ }
611
+ return git.readBlob(Object.assign({ oid }, repo)).then(({ blob: symlink }) => {
612
+ symlink = decodeUint8Array(symlink)
613
+ let target
614
+ let targetParent = root
615
+ if (dirname) {
616
+ if (!(target = path.join('/', dirname, symlink).substr(1)) || target === dirname) {
617
+ target = '.'
618
+ } else if (target.startsWith(dirname + '/')) {
619
+ target = target.substr(dirname.length + 1) // join doesn't remove trailing separator
620
+ targetParent = parent
598
621
  }
599
- const targetSegments = target.split('/')
600
- if (!targetSegments[targetSegments.length - 1]) targetSegments.pop()
601
- return readGitObjectAtPath(repo, root, targetParent, targetSegments, following)
622
+ } else {
623
+ target = path.normalize(symlink) // normalize doesn't remove trailing separator
624
+ }
625
+ if (target === '.') {
626
+ const err = { name: 'SymbolicLinkCycleError', code: 'ELOOP', oid, path: `${path.join(dirname, name)}`, symlink }
627
+ return Promise.reject(Object.assign(new Error(`Symbolic link cycle detected at ${oid}:${err.path}`), err))
628
+ }
629
+ const targetSegments = target.split('/')
630
+ targetSegments[targetSegments.length - 1] || targetSegments.pop()
631
+ return readGitObjectAtPath(repo, root, targetParent, targetSegments, following).catch((err) => {
632
+ throw Object.assign(err, { symlink })
602
633
  })
603
- }
604
- const err = { name: 'SymbolicLinkCycleError', code: 'SymbolicLinkCycleError', oid }
605
- return Promise.reject(Object.assign(new Error(`Symbolic link cycle found at oid: ${err.oid}`), err))
634
+ })
606
635
  }
607
636
 
608
637
  // QUESTION: could we use this to resolve the start path too?
@@ -615,14 +644,14 @@ function readGitObjectAtPath (repo, root, parent, pathSegments, following) {
615
644
  Object.assign(subtree, { dirname: path.join(parent.dirname, entry.path) })
616
645
  return (pathSegments = pathSegments.slice(1)).length
617
646
  ? readGitObjectAtPath(repo, root, subtree, pathSegments, following)
618
- : Object.assign(subtree, { type: 'tree' })
647
+ : Object.assign(subtree, { type: 'tree', following }) // Q: should this create copy?
619
648
  })
620
649
  : entry.mode === SYMLINK_FILE_MODE
621
650
  ? readGitSymlink(repo, root, parent, entry, following)
622
651
  : Promise.resolve(entry)
623
652
  }
624
653
  }
625
- return Promise.reject(new NotFoundError(`No file or directory found at "${parent.oid}:${pathSegments.join('/')}"`))
654
+ return Promise.reject(new NotFoundError(`${parent.oid}:${pathSegments.join('/')}`))
626
655
  }
627
656
 
628
657
  /**
@@ -637,7 +666,7 @@ function filterGitEntry (entry) {
637
666
  return entryPath.charAt(entryPath.length - 1) !== '~'
638
667
  }
639
668
 
640
- function entryToFile (entry) {
669
+ function gitEntryToFile (entry) {
641
670
  return git.readBlob(entry).then(({ blob: contents }) => {
642
671
  contents = Buffer.from(contents.buffer)
643
672
  const stat = Object.assign(new fs.Stats(), { mode: entry.mode, mtime: undefined, size: contents.byteLength })
@@ -691,53 +720,7 @@ function loadComponentDescriptor (files, ref, version) {
691
720
  throw new Error(`version in ${COMPONENT_DESC_FILENAME} cannot have path segments: ${version}`)
692
721
  }
693
722
  data.version = version
694
- return camelCaseKeys(data, { deep: true, stopPaths: ['asciidoc'] })
695
- }
696
-
697
- function computeOrigin (url, authStatus, gitdir, ref, startPath, worktreePath = undefined, editUrl = true) {
698
- const { shortname: refname, oid: refhash, type: reftype } = ref
699
- const origin = { type: 'git', url, gitdir, refname, [reftype]: refname, startPath }
700
- if (authStatus) origin.private = authStatus
701
- if (worktreePath === undefined) {
702
- origin.refhash = refhash
703
- } else {
704
- if (worktreePath) {
705
- origin.fileUriPattern =
706
- (posixify ? 'file:///' + posixify(worktreePath) : 'file://' + worktreePath) +
707
- (startPath ? '/' + startPath + '/%s' : '/%s')
708
- } else {
709
- origin.refhash = refhash
710
- }
711
- origin.worktree = worktreePath
712
- if (url.startsWith('file://')) url = undefined
713
- }
714
- if (url) origin.webUrl = url.replace(GIT_SUFFIX_RX, '')
715
- if (editUrl === true) {
716
- let match
717
- if (url && (match = url.match(HOSTED_GIT_REPO_RX))) {
718
- const host = match[1]
719
- let action
720
- let category = ''
721
- if (host === 'pagure.io') {
722
- action = 'blob'
723
- category = 'f'
724
- } else if (host === 'bitbucket.org') {
725
- action = 'src'
726
- } else {
727
- action = reftype === 'branch' ? 'edit' : 'blob'
728
- }
729
- origin.editUrlPattern = 'https://' + path.join(match[1], match[2], action, refname, category, startPath, '%s')
730
- }
731
- } else if (editUrl) {
732
- const vars = {
733
- path: () => (startPath ? path.join(startPath, '%s') : '%s'),
734
- refhash: () => refhash,
735
- refname: () => refname,
736
- web_url: () => origin.webUrl || '',
737
- }
738
- origin.editUrlPattern = editUrl.replace(EDIT_URL_TEMPLATE_VAR_RX, (_, name) => vars[name]())
739
- }
740
- return origin
723
+ return camelCaseKeys(data, ['asciidoc'])
741
724
  }
742
725
 
743
726
  function assignFileProperties (file, origin) {
@@ -823,17 +806,17 @@ function onGitProgress ({ phase, loaded, total }) {
823
806
  const scaleFactor = this.scaleFactor
824
807
  let ratio = ((loaded / total) * scaleFactor) / GIT_PROGRESS_PHASES.length
825
808
  if (phaseIdx) ratio += (phaseIdx * scaleFactor) / GIT_PROGRESS_PHASES.length
826
- // NOTE: updates are automatically throttled based on renderThrottle option
809
+ // NOTE updates are automatically throttled based on renderThrottle option
827
810
  this.update(ratio > scaleFactor ? scaleFactor : ratio)
828
811
  }
829
812
  }
830
813
 
831
814
  function onGitComplete (err) {
832
815
  if (err) {
833
- // TODO: could use progressBar.interrupt() to replace bar with message instead
816
+ // TODO could use progressBar.interrupt() to replace bar with message instead
834
817
  this.chars.incomplete = '?'
835
818
  this.update(0)
836
- // NOTE: force progress bar to update regardless of throttle setting
819
+ // NOTE force progress bar to update regardless of throttle setting
837
820
  this.render(undefined, true)
838
821
  } else {
839
822
  this.update(1)
@@ -871,7 +854,7 @@ function resolveCredentials (credentialsFromUrlHolder, url, auth) {
871
854
  function generateCloneFolderName (url) {
872
855
  let normalizedUrl = url.toLowerCase()
873
856
  if (posixify) normalizedUrl = posixify(normalizedUrl)
874
- normalizedUrl = normalizedUrl.replace(GIT_SUFFIX_RX, '')
857
+ normalizedUrl = removeGitSuffix(normalizedUrl)
875
858
  const basename = normalizedUrl.split(ANY_SEPARATOR_RX).pop()
876
859
  const hash = createHash('sha1')
877
860
  hash.update(normalizedUrl)
@@ -914,9 +897,14 @@ function isDirectory (url) {
914
897
  function symlinkAwareStat (path_) {
915
898
  return fsp.lstat(path_).then((lstat) => {
916
899
  if (!lstat.isSymbolicLink()) return lstat
917
- return fsp.stat(path_).catch((statErr) => {
918
- throw Object.assign(statErr, { symlink: true })
919
- })
900
+ return fsp.stat(path_).catch((statErr) =>
901
+ fsp
902
+ .readlink(path_)
903
+ .catch(invariably.void)
904
+ .then((symlink) => {
905
+ throw Object.assign(statErr, { symlink })
906
+ })
907
+ )
920
908
  })
921
909
  }
922
910
 
@@ -994,23 +982,35 @@ function transformGitCloneError (err, displayUrl) {
994
982
  if (trimMessage) {
995
983
  wrappedMsg = ~(wrappedMsg = wrappedMsg.trimRight()).indexOf('. ') ? wrappedMsg : wrappedMsg.replace(/\.$/, '')
996
984
  }
997
- const wrappedErr = new Error(`${wrappedMsg} (url: ${displayUrl})`)
998
- wrappedErr.stack += `\nCaused by: ${err.stack || 'unknown'}`
999
- return wrappedErr
985
+ const errWrapper = new Error(`${wrappedMsg} (url: ${displayUrl})`)
986
+ errWrapper.stack += `\nCaused by: ${err.stack || 'unknown'}`
987
+ return errWrapper
1000
988
  }
1001
989
 
1002
990
  function splitRefPatterns (str) {
1003
991
  return ~str.indexOf('{') ? str.split(VENTILATED_CSV_RX) : str.split(CSV_RX)
1004
992
  }
1005
993
 
1006
- function coerceToString (value) {
1007
- return value == null ? '' : String(value)
994
+ function camelCaseKeys (o, stopPaths = [], p = '') {
995
+ if (Array.isArray(o)) return o.map((it) => camelCaseKeys(it, stopPaths, p))
996
+ if (o == null || o.constructor !== Object) return o
997
+ const pathPrefix = p && p + '.'
998
+ const accum = {}
999
+ for (const [k, v] of Object.entries(o)) {
1000
+ const camelKey = k.toLowerCase().replace(/[_-]([a-z0-9])/g, (_, l, idx) => (idx ? l.toUpperCase() : l))
1001
+ accum[camelKey] = ~stopPaths.indexOf(pathPrefix + camelKey) ? v : camelCaseKeys(v, stopPaths, pathPrefix + camelKey)
1002
+ }
1003
+ return accum
1008
1004
  }
1009
1005
 
1010
1006
  function cleanStartPath (value) {
1011
1007
  return value && ~value.indexOf('/') ? value.replace(SUPERFLUOUS_SEPARATORS_RX, '') : value
1012
1008
  }
1013
1009
 
1010
+ function coerceToString (value) {
1011
+ return value == null ? '' : String(value)
1012
+ }
1013
+
1014
1014
  function findWorktrees (repo, patterns) {
1015
1015
  if (!patterns.length) return new Map()
1016
1016
  const linkedOnly = patterns[0] === '.' ? !(patterns = patterns.slice(1)) : true
@@ -1047,4 +1047,3 @@ function findWorktrees (repo, patterns) {
1047
1047
  }
1048
1048
 
1049
1049
  module.exports = aggregateContent
1050
- module.exports._computeOrigin = computeOrigin
@@ -0,0 +1,54 @@
1
+ 'use strict'
2
+
3
+ const { posix: path } = require('path')
4
+ const posixify = require('./posixify')
5
+ const removeGitSuffix = require('./remove-git-suffix')
6
+
7
+ const EDIT_URL_TEMPLATE_VAR_RX = /\{(web_url|ref(?:hash|name|type)|path)\}/g
8
+ const HOSTED_GIT_REPO_RX = /^(?:https?:\/\/|.+@)(git(?:hub|lab)\.com|bitbucket\.org|pagure\.io)[/:](.+?)(?:\.git)?$/
9
+
10
+ function computeOrigin (url, authStatus, gitdir, ref, startPath, worktreePath = undefined, editUrl = true) {
11
+ const { shortname: refname, oid: refhash, remote, type: reftype } = ref
12
+ const origin = { type: 'git', url, gitdir, reftype, refname, [reftype]: refname, refhash, startPath }
13
+ if (worktreePath !== undefined) {
14
+ if ((origin.worktree = worktreePath)) {
15
+ delete origin.refhash
16
+ origin.fileUriPattern =
17
+ (posixify ? 'file:///' + posixify(worktreePath) : 'file://' + worktreePath) +
18
+ (startPath ? '/' + startPath + '/%s' : '/%s')
19
+ } else if (remote) {
20
+ origin.remote = remote
21
+ }
22
+ if (url.startsWith('file://')) url = undefined
23
+ }
24
+ if (authStatus) origin.private = authStatus
25
+ if (url) origin.webUrl = removeGitSuffix(url)
26
+ if (editUrl === true) {
27
+ const match = url && url.match(HOSTED_GIT_REPO_RX)
28
+ if (match) {
29
+ const host = match[1]
30
+ let action = 'blob'
31
+ let category = ''
32
+ if (host === 'pagure.io') {
33
+ category = 'f'
34
+ } else if (host === 'bitbucket.org') {
35
+ action = 'src'
36
+ } else if (reftype === 'branch') {
37
+ action = 'edit'
38
+ }
39
+ origin.editUrlPattern = 'https://' + path.join(match[1], match[2], action, refname, category, startPath, '%s')
40
+ }
41
+ } else if (editUrl) {
42
+ const vars = {
43
+ path: () => (startPath ? path.join(startPath, '%s') : '%s'),
44
+ refhash: () => refhash,
45
+ reftype: () => reftype,
46
+ refname: () => refname,
47
+ web_url: () => origin.webUrl || '',
48
+ }
49
+ origin.editUrlPattern = editUrl.replace(EDIT_URL_TEMPLATE_VAR_RX, (_, name) => vars[name]())
50
+ }
51
+ return origin
52
+ }
53
+
54
+ module.exports = computeOrigin
@@ -0,0 +1,18 @@
1
+ 'use strict'
2
+
3
+ function deepClone (o) {
4
+ switch (o.constructor) {
5
+ case Object:
6
+ return Object.keys(o).reduce((accum, k) => {
7
+ const v = o[k]
8
+ accum[k] = !v || typeof v !== 'object' ? v : deepClone(v)
9
+ return accum
10
+ }, {})
11
+ case Array:
12
+ return o.map((it) => (!it || typeof it !== 'object' ? it : deepClone(it)))
13
+ default:
14
+ return o
15
+ }
16
+ }
17
+
18
+ module.exports = deepClone
@@ -1,9 +1,9 @@
1
1
  'use strict'
2
2
 
3
- function flattenDeep (array, accum = []) {
3
+ function deepFlatten (array, accum = []) {
4
4
  const len = array.length
5
- for (let i = 0, it; i < len; i++) Array.isArray((it = array[i])) ? flattenDeep(it, accum) : accum.push(it)
5
+ for (let i = 0, it; i < len; i++) Array.isArray((it = array[i])) ? deepFlatten(it, accum) : accum.push(it)
6
6
  return accum
7
7
  }
8
8
 
9
- module.exports = flattenDeep
9
+ module.exports = deepFlatten
package/lib/logger.js ADDED
@@ -0,0 +1,3 @@
1
+ 'use strict'
2
+
3
+ module.exports = require('@antora/logger')(require('../package.json').name)
@@ -0,0 +1,3 @@
1
+ 'use strict'
2
+
3
+ module.exports = require('path').sep === '\\' ? (p) => p.replace(/\\/g, '/') : undefined
@@ -0,0 +1,9 @@
1
+ 'use strict'
2
+
3
+ const GIT_SUFFIX_RX = /(?:(?:(?:\.git)?\/)?\.git|\/)$/
4
+
5
+ function removeGitSuffix (url) {
6
+ return url.replace(GIT_SUFFIX_RX, '')
7
+ }
8
+
9
+ module.exports = removeGitSuffix
@@ -1,6 +1,6 @@
1
1
  'use strict'
2
2
 
3
- const flattenDeep = require('./flatten-deep')
3
+ const deepFlatten = require('./deep-flatten')
4
4
  const { promises: fsp } = require('fs')
5
5
  const git = require('./git')
6
6
  const invariably = require('./invariably')
@@ -56,7 +56,7 @@ async function glob (base, patternSegments, listDirents, retrievePath, { oid, pa
56
56
  }
57
57
  let dirents = await listDirents(base, oid || path)
58
58
  if (explicit) dirents = dirents.filter((dirent) => !explicit.has(dirent.name))
59
- const discovered = flattenDeep(
59
+ const discovered = deepFlatten(
60
60
  await Promise.all(
61
61
  dirents.map((dirent) =>
62
62
  dirent.isDirectory() && isMatch(dirent.name)
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@antora/content-aggregator",
3
- "version": "3.0.3",
3
+ "version": "3.1.0",
4
4
  "description": "Fetches and aggregates content from distributed sources for use in an Antora documentation pipeline.",
5
5
  "license": "MPL-2.0",
6
6
  "author": "OpenDevise Inc. (https://opendevise.com)",
@@ -16,15 +16,26 @@
16
16
  "url": "https://gitlab.com/antora/antora/issues"
17
17
  },
18
18
  "main": "lib/index.js",
19
+ "exports": {
20
+ ".": "./lib/index.js",
21
+ "./git": "./lib/git.js",
22
+ "./git/http-plugin": "./lib/git-plugin-http.js",
23
+ "./lib/git-plugin-http": "./lib/git-plugin-http.js",
24
+ "./package.json": "./package.json"
25
+ },
26
+ "imports": {
27
+ "#compute-origin": "./lib/compute-origin.js",
28
+ "#constants": "./lib/constants.js"
29
+ },
19
30
  "dependencies": {
20
31
  "@antora/expand-path-helper": "~2.0",
32
+ "@antora/logger": "3.1.0",
21
33
  "@antora/user-require-helper": "~2.0",
22
34
  "braces": "~3.0",
23
35
  "cache-directory": "~2.0",
24
- "camelcase-keys": "~7.0",
25
36
  "glob-stream": "~7.0",
26
- "hpagent": "~0.1.0",
27
- "isomorphic-git": "~1.10",
37
+ "hpagent": "~1.0",
38
+ "isomorphic-git": "~1.19",
28
39
  "js-yaml": "~4.1",
29
40
  "multi-progress": "~4.0",
30
41
  "picomatch": "~2.3",
@@ -34,7 +45,7 @@
34
45
  "vinyl": "~2.2"
35
46
  },
36
47
  "engines": {
37
- "node": ">=12.21.0"
48
+ "node": ">=16.0.0"
38
49
  },
39
50
  "files": [
40
51
  "lib/"