feat: add few headers and body tests

Author: egor-romanov

README.md

@@ -4,3 +4,22 @@ JS Client library to interact with Supabase Functions.
 
 ## Docs
 https://supabase.github.io/functions-js/index.html
+
+## testing
+
+You are going to need docker daemon running to execute tests.
+
+To start test run use the following command:
+
+```sh
+npm i
+npm run test
+```
+
+Projects includes reporting with allure. Use the following command get more detailed test reports:
+
+```sh
+test:report
+```
+
+You may need to have Java8 installed to generate the report.

test/functions/mirror.ts

@@ -0,0 +1,40 @@
+import { serve } from 'https://deno.land/std/http/server.ts'
+
+serve(async (request: Request) => {
+  let body
+  switch (request.headers.get('content-type')) {
+    case 'application/json': {
+      body = await request.json()
+      break
+    }
+    case 'application/x-www-form-urlencoded': {
+      const formBody = await request.formData()
+      body = []
+      for (const e of formBody.entries()) {
+        body.push(e)
+      }
+      break
+    }
+    default: {
+      body = await request.text()
+      break
+    }
+  }
+  const headers = []
+  for (const h of request.headers.entries()) {
+    headers.push(h)
+  }
+  const resp = {
+    url: request.url ?? 'empty',
+    method: request.method ?? 'empty',
+    headers: headers ?? 'empty',
+    body: body ?? 'empty',
+  }
+
+  return new Response(JSON.stringify(resp), {
+    status: 200,
+    headers: {
+      'content-type': 'application/json',
+    },
+  })
+})

test/models/mirrorResponse.ts

@@ -0,0 +1,6 @@
+export interface MirrorResponse {
+  url: string
+  method: string
+  headers: string | {}
+  body: string | {}
+}

test/spec/params.spec.ts

@@ -0,0 +1,212 @@
+import 'mocha'
+import { assert } from 'chai'
+import { nanoid } from 'nanoid'
+import { sign } from 'jsonwebtoken'
+import { ContentType } from 'allure2-js-commons'
+
+import { FunctionsClient } from '../../src/index'
+
+import { Relay, runRelay } from '../relay/container'
+import { attach, log } from '../utils/allure'
+import { MirrorResponse } from '../models/mirrorResponse'
+
+describe('params reached to function', () => {
+  let relay: Relay
+  const jwtSecret = nanoid(10)
+  const apiKey = sign({ name: 'anon' }, jwtSecret)
+
+  before(async () => {
+    relay = await runRelay('mirror', jwtSecret)
+  })
+
+  after(async () => {
+    relay && relay.container && (await relay.container.stop())
+  })
+
+  it('invoke mirror', async () => {
+    log('create FunctionsClient')
+    const fclient = new FunctionsClient(`http://localhost:${relay.container.getMappedPort(8081)}`, {
+      Authorization: `Bearer ${apiKey}`,
+    })
+
+    log('invoke mirror')
+    const { data, error } = await fclient.invoke<MirrorResponse>('mirror', { responseType: 'json' })
+
+    log('assert no error')
+    assert.isNull(error)
+
+    const expected = {
+      url: 'http://localhost:8000/mirror',
+      method: 'POST',
+      headers: data?.headers ?? [],
+      body: '',
+    }
+    attach(
+      'check data from function',
+      `expected: ${JSON.stringify(expected)}\n actual: ${JSON.stringify(data)}`,
+      ContentType.TEXT
+    )
+    assert.deepEqual(data, expected)
+  })
+
+  it('invoke mirror with client header', async () => {
+    log('create FunctionsClient')
+    const fclient = new FunctionsClient(`http://localhost:${relay.container.getMappedPort(8081)}`, {
+      Authorization: `Bearer ${apiKey}`,
+      CustomHeader: 'check me',
+    })
+
+    log('invoke mirror')
+    const { data, error } = await fclient.invoke<MirrorResponse>('mirror', { responseType: 'json' })
+
+    log('assert no error')
+    assert.isNull(error)
+
+    const expected = {
+      url: 'http://localhost:8000/mirror',
+      method: 'POST',
+      headers: data?.headers ?? [],
+      body: '',
+    }
+    attach(
+      'check data from function',
+      `expected: ${JSON.stringify(expected)}\n actual: ${JSON.stringify(data)}`,
+      ContentType.TEXT
+    )
+    assert.deepEqual(data, expected)
+    attach(
+      'check headers from function',
+      `expected to include: ${['customheader', 'check me']}\n actual: ${JSON.stringify(
+        data?.headers
+      )}`,
+      ContentType.TEXT
+    )
+    assert.isTrue(
+      (data?.headers as [Array<string>]).filter(
+        ([k, v]) => k === 'customheader' && v === 'check me'
+      ).length > 0
+    )
+  })
+
+  it('invoke mirror with invoke header', async () => {
+    log('create FunctionsClient')
+    const fclient = new FunctionsClient(`http://localhost:${relay.container.getMappedPort(8081)}`)
+
+    log('invoke mirror')
+    const customHeader = nanoid()
+    const { data, error } = await fclient.invoke<MirrorResponse>('mirror', {
+      responseType: 'json',
+      headers: {
+        'custom-header': customHeader,
+        Authorization: `Bearer ${apiKey}`,
+      },
+    })
+
+    log('assert no error')
+    assert.isNull(error)
+
+    const expected = {
+      url: 'http://localhost:8000/mirror',
+      method: 'POST',
+      headers: data?.headers ?? [],
+      body: '',
+    }
+    attach(
+      'check data from function',
+      `expected: ${JSON.stringify(expected)}\n actual: ${JSON.stringify(data)}`,
+      ContentType.TEXT
+    )
+    assert.deepEqual(data, expected)
+    attach(
+      'check headers from function',
+      `expected to include: ${['custom-header', customHeader]}\n actual: ${JSON.stringify(
+        data?.headers
+      )}`,
+      ContentType.TEXT
+    )
+    assert.isTrue(
+      (data?.headers as [Array<string>]).filter(
+        ([k, v]) => k === 'custom-header' && v === customHeader
+      ).length > 0
+    )
+  })
+
+  it('invoke mirror with body formData', async () => {
+    log('create FunctionsClient')
+    const fclient = new FunctionsClient(`http://localhost:${relay.container.getMappedPort(8081)}`)
+    attach('setAuth', apiKey, ContentType.TEXT)
+    fclient.setAuth(apiKey)
+
+    log('invoke mirror')
+    var form = new URLSearchParams()
+    form.append(nanoid(5), nanoid(10))
+    form.append(nanoid(7), nanoid(5))
+    form.append(nanoid(15), nanoid())
+    const { data, error } = await fclient.invoke<MirrorResponse>('mirror', {
+      responseType: 'json',
+      body: form,
+      headers: {
+        'content-type': 'application/x-www-form-urlencoded',
+      },
+    })
+
+    log('assert no error')
+    assert.isNull(error)
+
+    const body = []
+    for (const e of form.entries()) {
+      body.push(e)
+    }
+    const expected = {
+      url: 'http://localhost:8000/mirror',
+      method: 'POST',
+      headers: data?.headers ?? [],
+      body: body,
+    }
+    attach(
+      'check data from function',
+      `expected: ${JSON.stringify(expected)}\n actual: ${JSON.stringify(data)}`,
+      ContentType.TEXT
+    )
+    assert.deepEqual(data, expected)
+  })
+
+  it('invoke mirror with body json', async () => {
+    log('create FunctionsClient')
+    const fclient = new FunctionsClient(`http://localhost:${relay.container.getMappedPort(8081)}`)
+    attach('setAuth', apiKey, ContentType.TEXT)
+    fclient.setAuth(apiKey)
+
+    log('invoke mirror')
+    const body = {
+      one: nanoid(10),
+      two: nanoid(5),
+      three: nanoid(),
+      num: 11,
+      flag: false,
+    }
+    const { data, error } = await fclient.invoke<MirrorResponse>('mirror', {
+      responseType: 'json',
+      body: JSON.stringify(body),
+      headers: {
+        'content-type': 'application/json',
+      },
+    })
+
+    log('assert no error')
+    assert.isNull(error)
+
+    const expected = {
+      url: 'http://localhost:8000/mirror',
+      method: 'POST',
+      headers: data?.headers ?? [],
+      body: body,
+    }
+    attach(
+      'check data from function',
+      `expected: ${JSON.stringify(expected)}\n actual: ${JSON.stringify(data)}`,
+      ContentType.TEXT
+    )
+    assert.deepEqual(data, expected)
+  })
+})