node-cacache/test/get.js

'use strict'

const fs = require('fs/promises')
const index = require('../lib/entry-index')
const memo = require('../lib/memoization')
const path = require('path')
const t = require('tap')
const ssri = require('ssri')

const CacheContent = require('./fixtures/cache-content')

const CONTENT = Buffer.from('foobarbaz', 'utf8')
const SIZE = CONTENT.length
const KEY = 'my-test-key'
const INTEGRITY = ssri.fromData(CONTENT).toString()
const METADATA = { foo: 'bar' }

const { get } = require('..')

function opts (extra) {
  return Object.assign(
    {
      size: SIZE,
      metadata: METADATA,
    },
    extra
  )
}

// Simple wrapper util cause this gets WORDY
function streamGet (byDigest) {
  const args = [].slice.call(arguments, 1)
  let integrity
  let metadata
  let size
  const stream = (byDigest ? get.stream.byDigest : get.stream).apply(null, args)
  return stream
    .on('integrity', (int) => {
      integrity = ssri.stringify(int)
    })
    .on('metadata', (m) => {
      metadata = m
    })
    .on('size', (s) => {
      size = s
    })
    .concat()
    .then((data) => ({
      data,
      integrity,
      metadata,
      size,
    }))
}

t.test('get.info index entry lookup', async t => {
  const CACHE = t.testdir()
  const indexInsert = await index.insert(CACHE, KEY, INTEGRITY, opts())
  const entry = await get.info(CACHE, KEY)
  t.same(entry, indexInsert, 'get.info() returned the right entry')
})

t.test('get will throw ENOENT if not found', (t) => {
  const CACHE = t.testdir()
  return get(CACHE, KEY)
    .then(() => {
      throw new Error('lookup should fail')
    })
    .catch((err) => {
      t.ok(err, 'got an error')
      t.equal(err.code, 'ENOENT', 'error code is ENOENT')
      return get.info(CACHE, KEY)
    })
    .catch((err) => {
      t.ok(err, 'got an error')
      t.equal(err.code, 'ENOENT', 'error code is ENOENT')
    })
})

t.test('basic bulk get', async t => {
  const CACHE = t.testdir(
    CacheContent({
      [INTEGRITY]: CONTENT,
    })
  )
  await index.insert(CACHE, KEY, INTEGRITY, opts())
  await t.resolveMatch(
    get(CACHE, KEY),
    {
      metadata: METADATA,
      data: CONTENT,
      integrity: INTEGRITY,
      size: SIZE,
    },
    'bulk key get returned proper data'
  )
  await t.resolveMatch(
    get.byDigest(CACHE, INTEGRITY),
    CONTENT,
    'byDigest returned proper data'
  )
})

t.test('get.byDigest without memoization', async t => {
  const CACHE = t.testdir(
    CacheContent({
      [INTEGRITY]: CONTENT,
    })
  )
  await index.insert(CACHE, KEY, INTEGRITY, opts())
  const res = await get(CACHE, KEY)
  t.same(
    res,
    {
      metadata: METADATA,
      data: CONTENT,
      integrity: INTEGRITY,
      size: SIZE,
    },
    'bulk key get returned proper data')

  memo.clearMemoized()
  t.same(memo.get.byDigest(CACHE, INTEGRITY), undefined)
  const resByDig = await get.byDigest(CACHE, INTEGRITY)
  t.same(resByDig, CONTENT, 'byDigest returned proper data')
  t.same(memo.get.byDigest(CACHE, INTEGRITY), undefined)

  const resByDigMemo = await get.byDigest(CACHE, INTEGRITY)
  t.same(resByDigMemo, CONTENT, 'byDigest returned proper data')
})

t.test('get.byDigest with memoization', async t => {
  const CACHE = t.testdir(
    CacheContent({
      [INTEGRITY]: CONTENT,
    })
  )
  await index.insert(CACHE, KEY, INTEGRITY, opts())
  const res = await get(CACHE, KEY)
  t.same(
    res,
    {
      metadata: METADATA,
      data: CONTENT,
      integrity: INTEGRITY,
      size: SIZE,
    },
    'bulk key get returned proper data')

  memo.clearMemoized()
  t.same(memo.get.byDigest(CACHE, INTEGRITY), undefined)
  const resByDig = await get.byDigest(CACHE, INTEGRITY, { memoize: true })
  t.same(resByDig, CONTENT, 'byDigest returned proper data')
  t.notSame(memo.get.byDigest(CACHE, INTEGRITY), undefined)

  const resByDigMemo = await get.byDigest(CACHE, INTEGRITY, { memoize: true })
  t.same(resByDigMemo, CONTENT, 'byDigest returned proper data')
})

t.test('get without memoization', async t => {
  const CACHE = t.testdir(
    CacheContent({
      [INTEGRITY]: CONTENT,
    })
  )
  await index.insert(CACHE, KEY, INTEGRITY, opts())
  const res = await get(CACHE, KEY)
  t.same(
    res,
    {
      metadata: METADATA,
      data: CONTENT,
      integrity: INTEGRITY,
      size: SIZE,
    },
    'bulk key get returned proper data')

  memo.clearMemoized()
  t.same(memo.get(CACHE, KEY), undefined)
  const resByDig = await get(CACHE, KEY)
  t.same(resByDig, {
    metadata: METADATA,
    data: CONTENT,
    integrity: INTEGRITY,
    size: SIZE,
  }, 'get returned proper data')
  t.same(memo.get(CACHE, KEY), undefined)

  const resByDigMemo = await get(CACHE, KEY)
  t.same(resByDigMemo, {
    metadata: METADATA,
    data: CONTENT,
    integrity: INTEGRITY,
    size: SIZE,
  }, 'get returned proper data')
})

t.test('get with memoization', async t => {
  const CACHE = t.testdir(
    CacheContent({
      [INTEGRITY]: CONTENT,
    })
  )
  await index.insert(CACHE, KEY, INTEGRITY, opts())
  const res = await get(CACHE, KEY)
  t.same(
    res,
    {
      metadata: METADATA,
      data: CONTENT,
      integrity: INTEGRITY,
      size: SIZE,
    },
    'bulk key get returned proper data')

  memo.clearMemoized()
  t.same(memo.get(CACHE, KEY), undefined)
  const resByDig = await get(CACHE, KEY, { memoize: true })
  t.same(resByDig, {
    metadata: METADATA,
    data: CONTENT,
    integrity: INTEGRITY,
    size: SIZE,
  }, 'get returned proper data')
  t.notSame(memo.get(CACHE, KEY), undefined)

  const resByDigMemo = await get(CACHE, KEY, { memoize: true })
  t.same(resByDigMemo, {
    metadata: METADATA,
    data: CONTENT,
    integrity: INTEGRITY,
    size: SIZE,
  }, 'get returned proper data')
})

t.test('basic stream get', async t => {
  const CACHE = t.testdir(
    CacheContent({
      [INTEGRITY]: CONTENT,
    })
  )
  await index.insert(CACHE, KEY, INTEGRITY, opts())
  const [byKey, byDigest] = await Promise.all([
    streamGet(false, CACHE, KEY),
    streamGet(true, CACHE, INTEGRITY),
  ])
  t.same(
    byKey,
    {
      data: CONTENT,
      integrity: INTEGRITY,
      metadata: METADATA,
      size: SIZE,
    },
    'got all expected data and fields from key fetch'
  )
  t.same(byDigest.data, CONTENT, 'got correct data from digest fetch')
})

t.test('get.stream add new listeners post stream creation', async (t) => {
  const CACHE = t.testdir(
    CacheContent({
      [INTEGRITY]: CONTENT,
    })
  )

  return index.insert(CACHE, KEY, INTEGRITY, opts()).then(() => {
    const OPTS = { memoize: false, size: CONTENT.length }
    const stream = get.stream(CACHE, KEY, OPTS)
    return Promise.all([
      new Promise((resolve) => stream.on('integrity', resolve)),
      new Promise((resolve) => stream.on('metadata', resolve)),
      new Promise((resolve) => stream.on('size', resolve)),
    ]).then(() => {
      [
        'integrity',
        'metadata',
        'size',
      ].forEach(ev => {
        stream.on(ev, () => {
          t.ok(`${ev} listener added`)
        })
      })
      return stream.concat()
    })
  })
})

t.test('get.copy will throw ENOENT if not found', (t) => {
  const CACHE = t.testdir()
  const DEST = path.join(CACHE, 'not-found')
  return get.copy(CACHE, 'NOT-FOUND', DEST)
    .then(() => {
      throw new Error('lookup should fail')
    })
    .catch((err) => {
      t.ok(err, 'got an error')
      t.equal(err.code, 'ENOENT', 'error code is ENOENT')
    })
})

t.test('get.copy with fs.copyfile', (t) => {
  const CACHE = t.testdir(
    CacheContent({
      [INTEGRITY]: CONTENT,
    })
  )
  const DEST = path.join(CACHE, 'copymehere')
  return index
    .insert(CACHE, KEY, INTEGRITY, opts())
    .then(() => get.copy(CACHE, KEY, DEST))
    .then((res) => {
      t.same(
        res,
        {
          metadata: METADATA,
          integrity: INTEGRITY,
          size: SIZE,
        },
        'copy operation returns basic metadata'
      )
      return fs.readFile(DEST)
    })
    .then((data) => {
      t.same(data, CONTENT, 'data copied by key matches')
      return fs.rm(DEST, { recursive: true, force: true })
    })
    .then(() => get.copy.byDigest(CACHE, INTEGRITY, DEST))
    .then(() => fs.readFile(DEST))
    .then((data) => {
      t.same(data, CONTENT, 'data copied by digest matches')
      return fs.rm(DEST, { recursive: true, force: true })
    })
})

t.test('memoizes data on bulk read', (t) => {
  memo.clearMemoized()
  const CACHE = t.testdir(
    CacheContent({
      [INTEGRITY]: CONTENT,
    })
  )
  return index.insert(CACHE, KEY, INTEGRITY, opts()).then((ENTRY) => {
    return get(CACHE, KEY)
      .then(() => {
        t.same(memo.get(CACHE, KEY), null, 'no memoization!')
        return get(CACHE, KEY, { memoize: true })
      })
      .then((res) => {
        t.same(
          res,
          {
            metadata: METADATA,
            data: CONTENT,
            integrity: INTEGRITY,
            size: SIZE,
          },
          'usual data returned'
        )
        t.same(
          memo.get(CACHE, KEY),
          {
            entry: ENTRY,
            data: CONTENT,
          },
          'data inserted into memoization cache'
        )
        return fs.rm(CACHE, { recursive: true, force: true })
      })
      .then(() => {
        return get(CACHE, KEY)
      })
      .then((res) => {
        t.same(
          res,
          {
            metadata: METADATA,
            data: CONTENT,
            integrity: INTEGRITY,
            size: SIZE,
          },
          'memoized data fetched by default'
        )
        return get(CACHE, KEY, { memoize: false })
          .then(() => {
            throw new Error('expected get to fail')
          })
          .catch((err) => {
            t.ok(err, 'got an error from unmemoized get')
            t.equal(err.code, 'ENOENT', 'cached content not found')
            t.same(
              memo.get(CACHE, KEY),
              {
                entry: ENTRY,
                data: CONTENT,
              },
              'data still in memoization cache'
            )
          })
      })
  })
})

t.test('memoizes data on stream read', async t => {
  memo.clearMemoized()
  const CACHE = t.testdir(
    CacheContent({
      [INTEGRITY]: CONTENT,
    })
  )
  const ENTRY = await index.insert(CACHE, KEY, INTEGRITY, opts())
  await Promise.all([
    streamGet(false, CACHE, KEY),
    streamGet(true, CACHE, INTEGRITY),
  ])
  t.same(memo.get(CACHE, KEY), null, 'no memoization by key!')
  t.same(
    memo.get.byDigest(CACHE, INTEGRITY),
    null,
    'no memoization by digest!'
  )
  memo.clearMemoized()
  const byDigest = await streamGet(true, CACHE, INTEGRITY, {
    memoize: true,
  })
  t.same(byDigest.data, CONTENT, 'usual data returned from stream')
  t.same(memo.get(CACHE, KEY), null, 'digest fetch = no key entry')
  t.same(
    memo.get.byDigest(CACHE, INTEGRITY),
    CONTENT,
    'content memoized'
  )
  t.same(
    memo.get.byDigest('whatev', INTEGRITY),
    null,
    'content memoization filtered by cache'
  )
  memo.clearMemoized()
  await t.resolveMatch(
    streamGet(false, CACHE, KEY, { memoize: true }),
    {
      metadata: METADATA,
      data: CONTENT,
      integrity: INTEGRITY,
      size: SIZE,
    },
    'usual data returned from key fetch'
  )
  t.same(
    memo.get(CACHE, KEY),
    {
      entry: ENTRY,
      data: CONTENT,
    },
    'data inserted into memoization cache'
  )
  t.same(
    memo.get.byDigest(CACHE, INTEGRITY),
    CONTENT,
    'content memoized by digest, too'
  )
  t.same(
    memo.get('whatev', KEY),
    null,
    'entry memoization filtered by cache'
  )
  await fs.rm(CACHE, { recursive: true, force: true })
  await t.resolveMatch(
    streamGet(false, CACHE, KEY),
    {
      metadata: METADATA,
      data: CONTENT,
      integrity: INTEGRITY,
      size: SIZE,
    },
    'key fetch fulfilled by memoization cache'
  )
  await t.resolveMatch(
    streamGet(true, CACHE, INTEGRITY),
    { data: CONTENT },
    'digest fetch fulfilled by memoization cache'
  )
  await t.rejects(
    streamGet(false, CACHE, KEY, { memoize: false }),
    { code: 'ENOENT' },
    'key get memoization bypassed'
  )
  await t.rejects(
    streamGet(true, CACHE, INTEGRITY, { memoize: false }),
    { code: 'ENOENT' },
    'digest get memoization bypassed'
  )
})

t.test('get.info uses memoized data', async t => {
  memo.clearMemoized()
  const CACHE = t.testdir()
  const ENTRY = {
    key: KEY,
    integrity: INTEGRITY,
    time: +new Date(),
    size: SIZE,
    metadata: null,
  }
  memo.put(CACHE, ENTRY, CONTENT)
  const info = await get.info(CACHE, KEY)
  t.same(info, ENTRY, 'got the entry from memoization cache')
})

t.test('identical hashes with different algorithms do not conflict')
t.test('throw error if something is really wrong with bucket')