node/deps/npm/test/tap/all-package-metadata-entry-stream-unit.js

'use strict'

var common = require('../common-tap.js')
var npm = require('../../')
var test = require('tap').test
var mkdirp = require('mkdirp')
var rimraf = require('rimraf')
var path = require('path')
var mr = require('npm-registry-mock')
var ms = require('mississippi')
var Tacks = require('tacks')
var File = Tacks.File

var _createEntryStream = require('../../lib/search/all-package-metadata.js')._createEntryStream

var ALL = common.registry + '/-/all'
var PKG_DIR = path.resolve(__dirname, 'create-entry-update-stream')
var CACHE_DIR = path.resolve(PKG_DIR, 'cache')

var server

function setup () {
  mkdirp.sync(CACHE_DIR)
}

function cleanup () {
  rimraf.sync(PKG_DIR)
}

test('setup', function (t) {
  mr({port: common.port, throwOnUnmatched: true}, function (err, s) {
    t.ifError(err, 'registry mocked successfully')
    npm.load({ cache: CACHE_DIR, registry: common.registry }, function (err) {
      t.ifError(err, 'npm loaded successfully')
      server = s
      t.pass('all set up')
      t.done()
    })
  })
})

test('createEntryStream full request', function (t) {
  setup()
  var cachePath = path.join(CACHE_DIR, '.cache.json')
  var dataTime = +(new Date())
  server.get('/-/all').once().reply(200, {
    '_updated': dataTime,
    'bar': { name: 'bar', version: '1.0.0' },
    'foo': { name: 'foo', version: '1.0.0' }
  }, {
    date: 1234 // should never be used.
  })
  _createEntryStream(cachePath, ALL, {}, 600, function (err, stream, latest, newEntries) {
    if (err) throw err
    t.equals(latest, dataTime, '`latest` correctly extracted')
    t.ok(newEntries, 'new entries need to be written to cache')
    t.ok(stream, 'returned a stream')
    var results = []
    stream.on('data', function (pkg) {
      results.push(pkg)
    })
    ms.finished(stream, function (err) {
      if (err) throw err
      t.deepEquals(results, [{
        name: 'bar',
        version: '1.0.0'
      }, {
        name: 'foo',
        version: '1.0.0'
      }])
      server.done()
      cleanup()
      t.end()
    })
  })
})

test('createEntryStream cache only', function (t) {
  setup()
  var now = Date.now()
  var cacheTime = now - 100000
  var cachePath = path.join(CACHE_DIR, '.cache.json')
  var fixture = new Tacks(File({
    '_updated': cacheTime,
    bar: { name: 'bar', version: '1.0.0' },
    cool: { name: 'cool', version: '1.0.0' },
    foo: { name: 'foo', version: '2.0.0' },
    other: { name: 'other', version: '1.0.0' }
  }))
  fixture.create(cachePath)
  _createEntryStream(cachePath, ALL, {}, 600, function (err, stream, latest, newEntries) {
    if (err) throw err
    t.equals(latest, cacheTime, '`latest` is cache time')
    t.ok(stream, 'returned a stream')
    t.notOk(newEntries, 'cache only means no need to write to cache')
    var results = []
    stream.on('data', function (pkg) {
      results.push(pkg)
    })
    ms.finished(stream, function (err) {
      t.ifError(err, 'stream finished without error')
      t.deepEquals(
        results.map(function (pkg) { return pkg.name }),
        ['bar', 'cool', 'foo', 'other'],
        'packages deduped and sorted'
      )
      server.done()
      cleanup()
      t.end()
    })
  })
})

test('createEntryStream merged stream', function (t) {
  setup()
  var now = Date.now()
  var cacheTime = now - 6000000
  server.get('/-/all/since?stale=update_after&startkey=' + cacheTime).once().reply(200, {
    'bar': { name: 'bar', version: '2.0.0' },
    'car': { name: 'car', version: '1.0.0' },
    'foo': { name: 'foo', version: '1.0.0' }
  }, {
    date: (new Date(now)).toISOString()
  })
  var cachePath = path.join(CACHE_DIR, '.cache.json')
  var fixture = new Tacks(File({
    '_updated': cacheTime,
    bar: { name: 'bar', version: '1.0.0' },
    cool: { name: 'cool', version: '1.0.0' },
    foo: { name: 'foo', version: '2.0.0' },
    other: { name: 'other', version: '1.0.0' }
  }))
  fixture.create(cachePath)
  _createEntryStream(cachePath, ALL, {}, 600, function (err, stream, latest, newEntries) {
    if (err) throw err
    t.equals(latest, now, '`latest` correctly extracted from header')
    t.ok(stream, 'returned a stream')
    t.ok(newEntries, 'cache update means entries should be written')
    var results = []
    stream.on('data', function (pkg) {
      results.push(pkg)
    })
    ms.finished(stream, function (err) {
      t.ifError(err, 'stream finished without error')
      t.deepEquals(
        results.map(function (pkg) { return pkg.name }),
        ['bar', 'car', 'cool', 'foo', 'other'],
        'packages deduped and sorted'
      )
      t.deepEquals(results[0], {
        name: 'bar',
        version: '2.0.0'
      }, 'update stream version wins on dedupe')
      t.deepEquals(results[3], {
        name: 'foo',
        version: '1.0.0'
      }, 'update stream version wins on dedupe even when the newer one has a lower semver.')
      server.done()
      cleanup()
      t.end()
    })
  })
})

test('createEntryStream no sources', function (t) {
  setup()
  var cachePath = path.join(CACHE_DIR, '.cache.json')
  server.get('/-/all').once().reply(404, {})
  _createEntryStream(cachePath, ALL, {}, 600, function (err, stream, latest, newEntries) {
    t.ok(err, 'no sources, got an error')
    t.notOk(stream, 'no stream returned')
    t.notOk(latest, 'no latest returned')
    t.notOk(newEntries, 'no entries need to be written')
    t.match(err.message, /No search sources available/, 'useful error message')
    server.done()
    cleanup()
    t.end()
  })
})

test('cleanup', function (t) {
  cleanup()
  server.close()
  t.pass('all done')
  t.done()
})