chore: Prepare for publishing

Signed-off-by: Richie Bendall <[email protected]>

Author: Richienb

.travis.yml

@@ -12,6 +12,7 @@ install: yarn install --non-interactive
 
 script:
     - yarn lint
+    - yarn test
     - yarn build
     - if [ -n "$TRAVIS_TAG" ]; then npm version $TRAVIS_TAG; fi
 
@@ -23,14 +24,6 @@ deploy:
       on:
           tags: true
 
-    - provider: releases
-      api_key: $github_token
-      file_glob: true
-      file: dist/*
-      skip_cleanup: true
-      on:
-          tags: true
-
     - provider: pages
       skip_cleanup: true
       github_commit: "chore: Published documentation [skip ci]"

README.md

@@ -9,9 +9,14 @@ Convert a buffer and headers to UTF-8 text, originally from `node-fetch`.
 From your NodeJS application:
 
 ```js
-const charsetDetection = require("fetch-charset-detection");
+const {
+    convertBody,
+    extractContentType,
+    getTotalBytes,
+    writeToStream
+} = require("fetch-charset-detection");
 ```
 
-## Usage
+## API
 
-Read the [documentation](https://richienb.github.io/fetch-charset-detection).
+Refer to the [documentation](https://richienb.github.io/fetch-charset-detection).

package.json

@@ -18,30 +18,46 @@
     "author": "Richie Bendall <[email protected]>",
     "license": "MIT",
     "scripts": {
-        "dev": "microbundle --target node --watch",
+        "dev": "yarn js --watch",
         "build": "yarn js && yarn docs",
-        "js": "microbundle --target node --format es,cjs --external http,https,stream,zlib,cheerio,content-type,iconv-lite",
+        "js": "tsc --outDir dist/",
         "docs": "typedoc --out ./docs --mode file --target ES6 --ignoreCompilerErrors ./src",
-        "lint": "eslint src/**/*"
+        "lint": "eslint src/**/*",
+        "test": "ava"
     },
     "dependencies": {
         "cheerio": "^1.0.0-rc.3",
         "content-type": "^1.0.4",
-        "iconv-lite": "^0.5.0"
+        "iconv-lite": "^0.5.0",
+        "lodash": "^4.17.15"
     },
     "devDependencies": {
         "@types/cheerio": "^0.22.13",
         "@types/content-type": "^1.1.3",
+        "@types/lodash": "^4.14.144",
+        "ava": "^2.4.0",
         "eslint": "^6.6.0",
         "eslint-config-richienb": "^0.2.2",
-        "microbundle": "^0.11.0",
-        "typedoc": "^0.15.0"
-    },
-    "resolutions": {
-        "microbundle/rollup-plugin-typescript2/rollup-pluginutils/micromatch/braces": "^3.0.2",
-        "microbundle/rollup-plugin-postcss/cssnano/postcss-svgo/svgo/js-yaml": "^3.13.1"
+        "express": "^4.17.1",
+        "fetch-blob": "^1.0.4",
+        "form-data": "^2.5.1",
+        "get-port": "^5.0.0",
+        "node-fetch": "^2.6.0",
+        "resumer": "^0.0.0",
+        "ts-node": "^8.4.1",
+        "typedoc": "^0.15.0",
+        "typescript": "^3.6.4"
     },
     "eslintConfig": {
         "extends": "richienb/ts"
+    },
+    "ava": {
+        "compileEnhancements": false,
+        "extensions": [
+            "ts"
+        ],
+        "require": [
+            "ts-node/register"
+        ]
     }
 }

src/lib/convert-body.ts

@@ -1,6 +1,7 @@
 import getCharset from "../utils/get-charset"
 import { decode as convert } from "iconv-lite"
 import { load as $ } from "cheerio"
+import _ from "lodash"
 
 /**
 * Detect buffer encoding and convert to target encoding
@@ -10,27 +11,27 @@ import { load as $ } from "cheerio"
 * @param headers Headers provided with the request.
 */
 export function convertBody(buffer: Buffer, headers?: Headers): string {
-    const contentType = headers instanceof Headers ? headers.get("content-type") : null
+    const contentType = !_.isNil(headers) ? headers.get("content-type") : null
     let charset: string
 
     // Header
     if (contentType) charset = getCharset(contentType)
 
     // No charset in content type, peek at response body for at most 1024 bytes
-    const res = buffer.slice(0, 1024).toString()
+    const res = _.toString(buffer.slice(0, 1024))
 
     // HTML5, HTML4 and XML
     if (!charset && res) {
         charset = getCharset(
             $(res)("meta[charset]").attr("charset") || // HTML5
             $(res)("meta[http-equiv][content]").attr("content") || // HTML4
-            $(res.replace(/<\?(.*)\?>/im, "<$1>"), { xmlMode: true }).root().find("xml").attr("encoding"), // XML
+            $(_.replace(res, /<\?(.*)\?>/im, "<$1>"), { xmlMode: true }).root().find("xml").attr("encoding"), // XML
         )
     }
 
     // Prevent decode issues when sites use incorrect encoding
     // ref: https://hsivonen.fi/encoding-menu/
-    if (charset && charset.toLowerCase() in ["gb2312", "gbk"]) charset = "gb18030"
+    if (charset && _.lowerCase(charset) in ["gb2312", "gbk"]) charset = "gb18030"
 
     // Turn raw buffers into a single utf-8 buffer
     return convert(

src/lib/extract-content-type.ts

@@ -1,5 +1,6 @@
 import { Stream } from "stream"
 import { isBlob, isURLSearchParams, isArrayBuffer } from "../utils/is"
+import _ from "lodash"
 
 /**
  * Performs the operation "extract a `Content-Type` value from |object|" as
@@ -11,8 +12,11 @@ import { isBlob, isURLSearchParams, isArrayBuffer } from "../utils/is"
  * @param body Any options.body input
  */
 export function extractContentType(body: any): string | null {
+    // Body is null or undefined
+    if (_.isNil(body)) return null
+
     // Body is string
-    if (typeof body === "string") return "text/plain;charset=UTF-8"
+    if (_.isString(body)) return "text/plain;charset=UTF-8"
 
     // Body is a URLSearchParams
     if (isURLSearchParams(body)) return "application/x-www-form-urlencoded;charset=UTF-8"
@@ -24,7 +28,7 @@ export function extractContentType(body: any): string | null {
     if (Buffer.isBuffer(body) || isArrayBuffer(body) || ArrayBuffer.isView(body)) return null
 
     // Detect form data input from form-data module
-    if (typeof body.getBoundary === "function") return `multipart/form-data;boundary=${body.getBoundary()}`
+    if (body && _.isFunction(body.getBoundary)) return `multipart/form-data;boundary=${body.getBoundary()}`
 
     // Body is stream - can't really do much about this
     if (body instanceof Stream) return null

src/lib/get-total-bytes.ts

@@ -1,4 +1,5 @@
 import { isBlob } from "../utils/is"
+import _ from "lodash"
 
 /**
  * The Fetch Standard treats this as if "total bytes" is a property on the body.
@@ -8,7 +9,7 @@ import { isBlob } from "../utils/is"
  *
  * @param body Body object from the Body instance.
  */
-export function getTotalBytes(body: any): number | null {
+export function getTotalBytes({ body }: { body: any }): number | null {
     // Body is null or undefined
     if (body == null) return 0
 
@@ -19,7 +20,7 @@ export function getTotalBytes(body: any): number | null {
     if (Buffer.isBuffer(body)) return body.length
 
     // Detect form data input from form-data module
-    if (body && typeof body.getLengthSync === "function") return body.hasKnownLength && body.hasKnownLength() ? body.getLengthSync() : null
+    if (body && _.isFunction(body.getLengthSync)) return body.hasKnownLength && body.hasKnownLength() ? body.getLengthSync() : null
 
     // Body is stream
     return null

src/lib/write-to-stream.ts

@@ -7,7 +7,7 @@ import { isBlob } from "../utils/is"
  * @param body Body object from the Body instance.
  * @param dest The stream to write to.
  */
-export function writeToStream(body: any, dest: Writable): void {
+export function writeToStream(dest: Writable, { body }: { body: any }): void {
     // Body is null
     if (body == null) dest.end()
 

src/utils/get-charset.ts

@@ -1,9 +1,10 @@
 import { parse as parseContentType } from "content-type"
+import _ from "lodash"
 
 /**
  * Get the character set from a Content-Type header.
  * @param contentType The Content-Type HTTP header.
  */
 export default function getCharSet(contentType: string): string | null {
-    return contentType != null ? parseContentType(contentType).parameters.charset : null
+    return !_.isNil(contentType) ? parseContentType(contentType).parameters.charset : null
 }

src/utils/is.ts

@@ -1,3 +1,5 @@
+import _ from "lodash"
+
 const NAME = Symbol.toStringTag
 
 /**
@@ -8,14 +10,14 @@ const NAME = Symbol.toStringTag
  */
 export function isURLSearchParams(obj: any): obj is URLSearchParams {
     return (
-        typeof obj === "object" &&
-        typeof obj.append === "function" &&
-        typeof obj.delete === "function" &&
-        typeof obj.get === "function" &&
-        typeof obj.getAll === "function" &&
-        typeof obj.has === "function" &&
-        typeof obj.set === "function" &&
-        typeof obj.sort === "function" &&
+        !_.isNil(obj) &&
+        _.isFunction(obj.append) &&
+        _.isFunction(obj.delete) &&
+        _.isFunction(obj.get) &&
+        _.isFunction(obj.getAll) &&
+        _.isFunction(obj.has) &&
+        _.isFunction(obj.set) &&
+        _.isFunction(obj.sort) &&
         obj[NAME] === "URLSearchParams"
     )
 }
@@ -34,11 +36,11 @@ declare interface FetchBlob extends Blob {
  */
 export function isBlob(obj: any): obj is FetchBlob {
     return (
-        typeof obj === "object" &&
-        typeof obj.arrayBuffer === "function" &&
-        typeof obj.type === "string" &&
-        typeof obj.stream === "function" &&
-        typeof obj.constructor === "function" &&
+        !_.isNil(obj) &&
+        _.isFunction(obj.arrayBuffer) &&
+        _.isString(obj.type) &&
+        _.isFunction(obj.stream) &&
+        _.isFunction(obj.constructor) &&
         /^(Blob|File)$/.test(obj[NAME])
     )
 }
@@ -50,7 +52,7 @@ export function isBlob(obj: any): obj is FetchBlob {
  */
 export function isAbortSignal(obj: any): obj is AbortSignal {
     return (
-        typeof obj === "object" &&
+        _.isObject(obj) &&
         obj[NAME] === "AbortSignal"
     )
 }
@@ -61,7 +63,10 @@ export function isAbortSignal(obj: any): obj is AbortSignal {
  * @param obj The object to check.
  */
 export function isArrayBuffer(obj: any): obj is ArrayBuffer {
-    return obj[NAME] === "ArrayBuffer"
+    return (
+        _.isObject(obj) &&
+        obj[NAME] === "ArrayBuffer"
+    )
 }
 
 declare class AbortError extends Error {

test.js

@@ -0,0 +1,79 @@
+import test, { before, after } from "ava"
+import resumer from "resumer"
+import FormData from "form-data"
+import * as stream from "stream"
+import { extractContentType, getTotalBytes } from "./src"
+import express from "express"
+import getPort from "get-port" // eslint-disable-line import/default
+import { Request } from "node-fetch"
+import Blob from "fetch-blob"
+const app = express()
+
+before(async (t) => {
+    t.context.port = await getPort()
+    t.context.server = app.listen(t.context.port)
+    t.context.baseURL = `http://localhost:${t.context.port}/`
+})
+
+after.always((t) => t.context.server.close())
+
+test("should calculate content length and extract content type for each body type", (t) => {
+    const url = `${t.context.baseURL}hello`
+    const bodyContent = "a=1"
+
+    let streamBody = resumer().queue(bodyContent).end()
+    streamBody = streamBody.pipe(new stream.PassThrough())
+    const streamRequest = new Request(url, {
+        method: "POST",
+        body: streamBody,
+        size: 1024,
+    })
+
+    const blobBody = new Blob([bodyContent], { type: "text/plain" })
+    const blobRequest = new Request(url, {
+        method: "POST",
+        body: blobBody,
+        size: 1024,
+    })
+
+    const formBody = new FormData()
+    formBody.append("a", "1")
+    const formRequest = new Request(url, {
+        method: "POST",
+        body: formBody,
+        size: 1024,
+    })
+
+    const bufferBody = Buffer.from(bodyContent)
+    const bufferRequest = new Request(url, {
+        method: "POST",
+        body: bufferBody,
+        size: 1024,
+    })
+
+    const stringRequest = new Request(url, {
+        method: "POST",
+        body: bodyContent,
+        size: 1024,
+    })
+
+    const nullRequest = new Request(url, {
+        method: "GET",
+        body: null,
+        size: 1024,
+    })
+
+    t.is(getTotalBytes(streamRequest), null)
+    t.is(getTotalBytes(blobRequest), blobBody.size)
+    t.not(getTotalBytes(formRequest), null)
+    t.is(getTotalBytes(bufferRequest), bufferBody.length)
+    t.is(getTotalBytes(stringRequest), bodyContent.length)
+    t.is(getTotalBytes(nullRequest), 0)
+
+    t.is(extractContentType(streamBody), null)
+    t.is(extractContentType(blobBody), "text/plain")
+    t.true(extractContentType(formBody).startsWith("multipart/form-data"))
+    t.is(extractContentType(bufferBody), null)
+    t.is(extractContentType(bodyContent), "text/plain;charset=UTF-8")
+    t.is(extractContentType(null), null)
+})