Merge pull request #3 from rambler-digital-solutions/transport

feat(transport): add transport

.size-limit.json

@@ -39,6 +39,10 @@
     "path": "packages/splits/dist/index.js",
     "limit": "1.6 KB"
   },
+  {
+    "path": "packages/transport/dist/index.js",
+    "limit": "675 B"
+  },
   {
     "path": "packages/url/dist/index.js",
     "limit": "675 B"

README.md

@@ -17,6 +17,7 @@ Common utils used by Rambler team
 - [@rambler-tech/react](packages/react)
 - [@rambler-tech/session-storage](packages/session-storage)
 - [@rambler-tech/splits](packages/splits)
+- [@rambler-tech/transport](packages/transport)
 - [@rambler-tech/url](packages/url)
 
 ## Contributing

packages/transport/README.md

@@ -0,0 +1,15 @@
+# API transport
+
+Enchanced API transport with timeout and query params
+
+## Install
+
+```
+npm install -D @rambler-tech/transport
+```
+
+or
+
+```
+yarn add -D @rambler-tech/transport
+```

packages/transport/index.test.ts

@@ -0,0 +1,73 @@
+import {request} from '.'
+
+const fetchMock = jest.fn(() =>
+  Promise.resolve({
+    status: 200,
+    json: () => Promise.resolve({data: 'baz'})
+  })
+) as jest.Mock
+
+beforeEach(() => {
+  jest.spyOn(global, 'fetch').mockImplementation(fetchMock)
+})
+
+test('base request api', async () => {
+  await request('/api', {})
+
+  expect(fetchMock).toHaveBeenCalledWith('/api', {
+    method: 'get',
+    headers: {
+      'Content-Type': 'application/json'
+    }
+  })
+})
+
+test('request api with query', async () => {
+  await request('/api', {
+    query: {
+      foo: 'bar'
+    }
+  })
+
+  expect(fetchMock).toHaveBeenCalledWith('/api?foo=bar', {
+    method: 'get',
+    headers: {
+      'Content-Type': 'application/json'
+    }
+  })
+})
+
+test('request api with query', async () => {
+  await request('/api', {
+    method: 'post',
+    body: {
+      foo: 'bar'
+    }
+  })
+
+  expect(fetchMock).toHaveBeenCalledWith('/api', {
+    method: 'post',
+    body: '{"foo":"bar"}',
+    headers: {
+      'Content-Type': 'application/json'
+    }
+  })
+})
+
+test('request api with timeout', async () => {
+  await request('/api', {
+    timeout: 1000
+  })
+
+  expect(fetchMock).toHaveBeenCalledWith('/api', {
+    method: 'get',
+    signal: expect.any(AbortSignal),
+    headers: {
+      'Content-Type': 'application/json'
+    }
+  })
+})
+
+afterEach(() => {
+  jest.clearAllMocks()
+})

packages/transport/index.ts

@@ -0,0 +1,71 @@
+/* eslint-disable import/no-unused-modules */
+
+const OK = 200
+
+/** Request options */
+export interface RequestOptions extends Omit<RequestInit, 'body'> {
+  /** Request query params */
+  query?: Record<string, string>
+  /** Request body */
+  body?: Record<string, any> | BodyInit | null
+  /** Request timeout (ms) */
+  timeout?: number
+}
+
+/** Request */
+export async function request<T>(
+  url = '',
+  requestOptions: RequestOptions = {}
+): Promise<T> {
+  const {
+    method = 'get',
+    query = {},
+    body,
+    timeout,
+    headers,
+    ...options
+  } = requestOptions
+
+  const requestInit: RequestInit = {
+    method,
+    ...options,
+    headers: {
+      'Content-Type': 'application/json',
+      ...headers
+    }
+  }
+
+  let requestUrl = url
+
+  if (query) {
+    const queryString = new URLSearchParams(query).toString()
+
+    if (queryString) {
+      requestUrl += `?${queryString}`
+    }
+  }
+
+  if (body) {
+    requestInit.body =
+      body instanceof FormData || typeof body === 'string'
+        ? body
+        : JSON.stringify(body)
+  }
+
+  if (timeout != null) {
+    const controller = new AbortController()
+
+    requestInit.signal = controller.signal
+    window.setTimeout(() => controller.abort(), timeout)
+  }
+
+  const response = await fetch(requestUrl, requestInit)
+
+  if (response.status !== OK) {
+    throw new Error(
+      `Failed to fetch: ${response.status} ${response.statusText}`
+    )
+  }
+
+  return response.json()
+}

packages/transport/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "@rambler-tech/transport",
+  "version": "0.0.0",
+  "main": "dist",
+  "module": "dist",
+  "types": "dist/index.d.ts",
+  "license": "MIT",
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "public"
+  }
+}

packages/transport/tsconfig.json

@@ -0,0 +1 @@
+../../tsconfig.package.json

packages/transport/typedoc.json

@@ -0,0 +1 @@
+../../typedoc.package.json