@sanity/client 3.3.2 → 3.4.0-beta.esm.1

package/test/encodeQueryString.test.js

@@ -1,36 +0,0 @@
-const test = require('tape')
-const encode = require('../src/data/encodeQueryString')
-
-test('can encode basic query without parameters', (t) => {
-  const query = 'gamedb.game[maxPlayers == 64]'
-  t.equal(encode({query}), '?query=gamedb.game%5BmaxPlayers%20%3D%3D%2064%5D')
-  t.end()
-})
-
-test('can encode queries with basic numeric parameters', (t) => {
-  const query = 'gamedb.game[maxPlayers == $maxPlayers && score == $score]'
-  t.equal(
-    encode({query, params: {maxPlayers: 64, score: 3.45678}}),
-    '?query=gamedb.game%5BmaxPlayers%20%3D%3D%20%24maxPlayers%20%26%26%20score%20%3D%3D%20%24score%5D' +
-      '&%24maxPlayers=64&%24score=3.45678'
-  )
-  t.end()
-})
-
-test('can encode queries with basic string parameters', (t) => {
-  const query = 'gamedb.game[name == $name]'
-  t.equal(
-    encode({query, params: {name: 'foobar'}}),
-    '?query=gamedb.game%5Bname%20%3D%3D%20%24name%5D&%24name=%22foobar%22'
-  )
-  t.end()
-})
-
-test('can encode queries with booleans', (t) => {
-  const query = 'gamedb.game[isReleased == $released]'
-  t.equal(
-    encode({query, params: {released: true}}),
-    '?query=gamedb.game%5BisReleased%20%3D%3D%20%24released%5D&%24released=true'
-  )
-  t.end()
-})

package/test/helpers/sseServer.js

@@ -1,26 +0,0 @@
-/* eslint-disable strict */
-// (Node 4 compat)
-
-'use strict'
-
-const http = require('http')
-const SseChannel = require('sse-channel')
-
-module.exports = (onRequest, cb) => {
-  const server = http.createServer((request, response) => {
-    let channel
-    if (
-      request.url.indexOf('/v1/data/listen/') === 0 ||
-      request.url.indexOf('/listen/beerns?query=') === 0
-    ) {
-      channel = new SseChannel({jsonEncode: true})
-      channel.addClient(request, response)
-    }
-
-    onRequest({request, channel, response})
-  })
-
-  server.listen(0, '127.0.0.1', (err) => {
-    cb(err, err ? null : server)
-  })
-}

package/test/listen.test.js

@@ -1,205 +0,0 @@
-/* eslint-disable strict */
-// (Node 4 compat)
-
-'use strict'
-
-const test = require('tape')
-const assign = require('xtend')
-const sanityClient = require('../src/sanityClient')
-const sseServer = require('./helpers/sseServer')
-
-const getClient = (options) =>
-  sanityClient(
-    assign(
-      {
-        dataset: 'prod',
-        namespace: 'beerns',
-        apiHost: `http://127.0.0.1:${options.port}`,
-        useProjectHostname: false,
-        useCdn: false,
-        apiVersion: '1',
-      },
-      options
-    )
-  )
-
-const testSse = (onRequest, options) =>
-  new Promise((resolve, reject) => {
-    sseServer(onRequest, (err, server) => {
-      if (err) {
-        return reject(err)
-      }
-
-      const client = getClient(assign({port: server.address().port}, options))
-      return resolve({server, client})
-    })
-  })
-
-/*****************
- * LISTENER      *
- *****************/
-test('[listener] can listen for mutations', (t) => {
-  const eventData = {
-    documentId: 'beer-123',
-    eventId: 'blah#beer-123',
-    identity: 'uid',
-    mutations: [{patch: {id: 'beer-123', set: {abv: 8}}}],
-    previousRev: 'MOmofa',
-    result: {
-      _id: 'beer-123',
-      _type: 'beer',
-      brewery: 'Trillium',
-      title: 'Headroom Double IPA',
-      abv: 8,
-    },
-    resultRev: 'Blatti',
-    timestamp: '2017-03-29T12:36:20.506516Z',
-    transactionId: 'foo',
-    transition: 'update',
-  }
-
-  testSse(({request, channel}) => {
-    t.equal(
-      request.url,
-      [
-        '/v1/data/listen/prod',
-        '?query=*%5B_type%20%3D%3D%20%22beer%22%20%26%26%20title%20%3D%3D%20%24beerName%5D',
-        '&%24beerName=%22Headroom%20Double%20IPA%22&includeResult=true',
-      ].join(''),
-      'url should be correct'
-    )
-
-    channel.send({event: 'mutation', data: eventData})
-    process.nextTick(() => channel.close())
-  })
-    .then(({server, client}) => {
-      const query = '*[_type == "beer" && title == $beerName]'
-      const params = {beerName: 'Headroom Double IPA'}
-
-      const subscription = client.listen(query, params).subscribe({
-        next: (msg) => {
-          t.deepEqual(
-            msg,
-            assign({}, eventData, {type: 'mutation'}),
-            'event data should be correct'
-          )
-          subscription.unsubscribe()
-          server.close()
-          t.end()
-        },
-        error: (err) => {
-          subscription.unsubscribe()
-          server.close()
-          t.end(err)
-        },
-      })
-    })
-    .catch(t.end)
-})
-
-test('[listener] listener sends auth token if given (node)', (t) => {
-  let httpServer = null
-  testSse(
-    ({request, channel}) => {
-      t.equal(request.headers.authorization, 'Bearer foobar', 'should send token')
-      channel.send({event: 'disconnect'})
-      process.nextTick(() => {
-        channel.close()
-        httpServer.close()
-        t.end()
-      })
-    },
-    {token: 'foobar'}
-  )
-    .then(({server, client}) => {
-      httpServer = server
-      const subscription = client.listen('*').subscribe({
-        error: (err) => {
-          subscription.unsubscribe()
-          server.close()
-          t.end(err)
-        },
-      })
-    })
-    .catch(t.end)
-})
-
-test('[listener] reconnects if disconnected', (t) => {
-  testSse(({request, channel}) => {
-    channel.send({event: 'welcome'})
-    channel.close()
-    process.nextTick(() => channel.close())
-  })
-    .then(({server, client}) => {
-      const subscription = client.listen('*', {}, {events: ['reconnect']}).subscribe({
-        next: (msg) => {
-          t.equal(msg.type, 'reconnect', 'emits reconnect events if told to')
-          subscription.unsubscribe()
-          server.close()
-          t.end()
-        },
-        error: (err) => {
-          subscription.unsubscribe()
-          server.close()
-          t.end(err)
-        },
-      })
-    })
-    .catch(t.end)
-})
-
-test('[listener] emits channel errors', (t) => {
-  testSse(({request, channel}) => {
-    channel.send({event: 'channelError', data: {message: 'Unfortunate error'}})
-    channel.close()
-    process.nextTick(() => channel.close())
-  })
-    .then(({server, client}) => {
-      const subscription = client.listen('*').subscribe({
-        error: (err) => {
-          t.equal(err.message, 'Unfortunate error', 'should have passed error message')
-          subscription.unsubscribe()
-          server.close()
-          t.end()
-        },
-      })
-    })
-    .catch(t.end)
-})
-
-test('[listener] emits channel errors with deep error description', (t) => {
-  testSse(({request, channel}) => {
-    channel.send({event: 'channelError', data: {error: {description: 'Expected error'}}})
-    channel.close()
-    process.nextTick(() => channel.close())
-  })
-    .then(({server, client}) => {
-      const subscription = client.listen('*').subscribe({
-        error: (err) => {
-          t.equal(err.message, 'Expected error', 'should have passed error message')
-          subscription.unsubscribe()
-          server.close()
-          t.end()
-        },
-      })
-    })
-    .catch(t.end)
-})
-
-test('[listener] emits error if request URL is too large', (t) => {
-  testSse(({request, channel}) => {
-    channel.close()
-    process.nextTick(() => channel.close())
-  })
-    .then(({server, client}) => {
-      const pad = '_'.repeat(16000)
-      client.listen(`*{"foo":"${pad}"`).subscribe({
-        error: (err) => {
-          t.equal(err.message, 'Query too large for listener', 'should have passed error message')
-          server.close()
-          t.end()
-        },
-      })
-    })
-    .catch(t.end)
-})

package/test/warnings.test.disabled.js

@@ -1,80 +0,0 @@
-// This test suite fails using tape but should pass if running with as a node script
-const test = require('tape')
-const nock = require('nock')
-const sanityClient = require('../src/sanityClient')
-
-const stub = (target, prop, stubbed) => {
-  const original = target[prop]
-  target[prop] = stubbed
-  return () => {
-    target[prop] = original
-  }
-}
-
-const combine = (...fns) => () => {
-  const [head, ...tail] = fns
-  return tail.reduce((acc, fn) => fn(acc), head())
-}
-
-/**************************
- * CLIENT CONFIG WARNINGS *
- **************************/
-
-test('warns if useCdn is not given', (t) => {
-  const restore = combine(
-    stub(console, 'warn', (message) => {
-      t.equal(
-        message,
-        'You are not using the Sanity CDN. That means your data is always fresh, but the CDN is faster and cheaper. Think about it! For more info, see https://docs.sanity.io/help/js-client-cdn-configuration. To hide this warning, please set the `useCdn` option to either `true` or `false` when creating the client.'
-      )
-      restore()
-      t.end()
-    })
-  )
-  sanityClient({projectId: 'abc123', apiVersion: '1'})
-})
-
-test('warns if in browser on localhost and a token is provided', (t) => {
-  const restore = combine(
-    stub(global, 'window', {location: {hostname: 'localhost'}}),
-    stub(console, 'warn', (message) => {
-      t.equal(
-        message,
-        'You have configured Sanity client to use a token in the browser. This may cause unintentional security issues. See https://docs.sanity.io/help/js-client-browser-token for more information and how to hide this warning.'
-      )
-      restore()
-      t.end()
-    })
-  )
-  sanityClient({projectId: 'abc123', useCdn: false, token: 'foo', apiVersion: '1'})
-})
-
-test('warns a token is provided together with useCdn:true (and not in browser)', (t) => {
-  const restore = combine(
-    stub(console, 'warn', (message) => {
-      t.equal(
-        message,
-        'You have set `useCdn` to `true` while also specifying a token. This is usually not what you want. The CDN cannot be used with an authorization token, since private data cannot be cached. See https://docs.sanity.io/help/js-client-usecdn-token for more information.'
-      )
-      restore()
-      t.end()
-    })
-  )
-  sanityClient({projectId: 'abc123', token: 'foo', useCdn: true, apiVersion: '1'})
-})
-
-test('warns if server sends warning back', (t) => {
-  const restore = combine(
-    stub(console, 'warn', (message) => {
-      t.equal(message, 'Friction endures')
-      restore()
-      t.end()
-    })
-  )
-
-  nock('https://abc123.api.sanity.io')
-    .get('/v1/users/me')
-    .reply(200, {}, {'X-Sanity-Warning': 'Friction endures'})
-
-  sanityClient({projectId: 'abc123', useCdn: true, apiVersion: '1'}).users.getById('me')
-})