@tarojs/plugin-http 3.6.0-beta.2

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@tarojs/plugin-http",
+  "version": "3.6.0-beta.2",
+  "description": "Taro 小程序端支持使用 web 请求 的插件",
+  "main": "index.js",
+  "files": [
+    "src",
+    "dist",
+    "index.js",
+    "package.json"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/NervJS/taro.git"
+  },
+  "keywords": [
+    "Taro"
+  ],
+  "author": "bigmeow <https://github.com/bigmeow>",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/NervJS/taro/issues"
+  },
+  "homepage": "https://github.com/NervJS/taro#readme",
+  "dependencies": {
+    "@tarojs/runtime": "3.6.0-beta.2",
+    "@tarojs/service": "3.6.0-beta.2",
+    "@tarojs/shared": "3.6.0-beta.2"
+  },
+  "devDependencies": {
+    "@rollup/plugin-json": "^4.1.0",
+    "@rollup/plugin-node-resolve": "^15.0.1",
+    "rollup": "^3.8.1",
+    "tslib": "^2.4.0"
+  },
+  "scripts": {
+    "dev": "rollup -c -w --bundleConfigAsCjs",
+    "build": "rollup -c --bundleConfigAsCjs",
+    "test": "jest",
+    "test:ci": "jest --ci -i --coverage false"
+  }
+}

package/src/__tests__/cookie.spec.js

@@ -0,0 +1,89 @@
+const { delay } = require('./utils')
+
+describe('cookie', () => {
+  const runtime = require('../../dist/runtime')
+
+  const cookie = new runtime.Cookie()
+  const url1 = 'http://sub.taro.com/p/a/t/h?query=string#hash'
+  const url2 = 'http://xxx.sub.taro.com/p/a/t/h?query=string#hash'
+  const url3 = 'http://sub2.taro.com/p/a/t/h?query=string#hash'
+  const url4 = 'https://sub.taro.com/p/a/t/h?query=string#hash'
+
+  it('key-value', () => {
+    cookie.setCookie('aaa=bbb', url1)
+    expect(cookie.getCookie(url1)).toBe('aaa=bbb')
+    cookie.setCookie('ccc=ddd\nasdf', url1)
+    cookie.setCookie('eee=fff;asdf', url1)
+    cookie.setCookie('ggg=;asdf', url1)
+    cookie.setCookie('hhh\n=;asdf', url1)
+    expect(cookie.getCookie(url1)).toBe('aaa=bbb; ccc=ddd; eee=fff; ggg=')
+    cookie.setCookie('aaa=abc', url1)
+    cookie.setCookie('ccc=cba\nasdf', url1)
+    expect(cookie.getCookie(url1)).toBe('aaa=abc; ccc=cba; eee=fff; ggg=')
+  })
+
+  it('maxAge', async () => {
+    cookie.setCookie('aaa=bbb; max-age=1', url1)
+    await delay(1001)
+    expect(cookie.getCookie(url1)).toBe('ccc=cba; eee=fff; ggg=')
+    cookie.setCookie('ccc=ddd; max-age=-10', url1)
+    expect(cookie.getCookie(url1)).toBe('eee=fff; ggg=')
+    cookie.setCookie('eee=fff; max-age=', url1)
+    expect(cookie.getCookie(url1)).toBe('eee=fff; ggg=')
+    cookie.setCookie('eee=fff; max-age=abc', url1)
+    expect(cookie.getCookie(url1)).toBe('eee=fff; ggg=')
+  })
+
+  it('expires', async () => {
+    cookie.setCookie(`eee=fff; expires=${new Date(Date.now()).toUTCString()}`, url1)
+    expect(cookie.getCookie(url1)).toBe('ggg=')
+    cookie.setCookie(`ggg=fff; expires=${new Date(Date.now() + 1000).toUTCString()}`, url1)
+    expect(cookie.getCookie(url1)).toBe('ggg=fff')
+    await delay(1001)
+    expect(cookie.getCookie(url1)).toBe('')
+  })
+
+  it('max-age 优先于 expires', async () => {
+    cookie.setCookie(`aaa=bbb; max-age=1000; expires=${new Date(Date.now()).toUTCString()}`, url1)
+    expect(cookie.getCookie(url1)).toBe('aaa=bbb')
+    cookie.setCookie(`aaa=bbb; max-age=0; expires=${new Date(Date.now() + 1000 * 1000).toUTCString()}`, url1)
+    expect(cookie.getCookie(url1)).toBe('')
+  })
+
+  it('domain', async () => {
+    cookie.setCookie('aaa=bbb; domain=taro.com', url1)
+    cookie.setCookie('abc=cba; domain=sub.taro.com', url1)
+    expect(cookie.getCookie(url1)).toBe('aaa=bbb; abc=cba')
+    cookie.setCookie('ccc=ddd; domain=xxx.sub.taro.com', url1) // 不符合 domain，不写入 cookie
+    expect(cookie.getCookie(url1)).toBe('aaa=bbb; abc=cba')
+    cookie.setCookie('eee=fff; domain=xxx.sub.taro.com', url2)
+    cookie.setCookie('ggg=; domain=sub2.taro.com', url3)
+    expect(cookie.getCookie(url1)).toBe('aaa=bbb; abc=cba')
+    expect(cookie.getCookie(url2)).toBe('aaa=bbb; abc=cba; eee=fff')
+    expect(cookie.getCookie(url3)).toBe('aaa=bbb; ggg=')
+  })
+
+  it('path', async () => {
+    cookie.setCookie('eee=fff; path=/p/a/t/x', url1)
+    expect(cookie.getCookie(url1)).toBe('aaa=bbb; abc=cba')
+    cookie.setCookie('ggg=hhh; path=/p/a/t', url1)
+    expect(cookie.getCookie(url1)).toBe('aaa=bbb; abc=cba; ggg=hhh')
+    cookie.setCookie('iii=jjj; path=/p/a/x', url1)
+    expect(cookie.getCookie(url1)).toBe('aaa=bbb; abc=cba; ggg=hhh')
+    cookie.setCookie('kkk=lll; path=/p/a', url1)
+    expect(cookie.getCookie(url1)).toBe('aaa=bbb; abc=cba; ggg=hhh; kkk=lll')
+  })
+
+  it('secure', async () => {
+    cookie.setCookie('mmm=nnn; secure', url1)
+    expect(cookie.getCookie(url1)).toBe('aaa=bbb; abc=cba; ggg=hhh; kkk=lll')
+    expect(cookie.getCookie(url4)).toBe('aaa=bbb; abc=cba; ggg=hhh; kkk=lll; mmm=nnn')
+  })
+
+  it('httpOnly', async () => {
+    cookie.setCookie('ooo=ppp; httpOnly', url1)
+    expect(cookie.getCookie(url1)).toBe('aaa=bbb; abc=cba; ggg=hhh; kkk=lll; ooo=ppp')
+    expect(cookie.getCookie(url4)).toBe('aaa=bbb; abc=cba; ggg=hhh; kkk=lll; mmm=nnn')
+  })
+
+})

package/src/__tests__/dom.spec.js

@@ -0,0 +1,20 @@
+describe('DOM', () => {
+  process.env.FRAMEWORK = 'nerv'
+  const runtime = require('../../dist/runtime')
+  const document = runtime.document
+  global.document = runtime.document
+  
+  describe('document', () => {
+
+    it('document setCookie', async () => {
+      expect(document.cookie).toBe('')
+      document.cookie = 'aaa=1111-2222-33-444-abcdefgasd; path=/; expires=Mon, 18 Jan 2038 19:14:07 GMT; secure;'
+      document.cookie = 'bbb=23123-aswe-4a7a-a740-f55dfd296b1d; path=/; expires=Mon, 18 Jan 2038 19:14:07 GMT'
+      document.cookie = 'ccc=69asd3d81234668942; path=/; expires=Mon, 18 Jan 2038 19:14:07 GMT'
+      expect(document.cookie).toBe(
+        'aaa=1111-2222-33-444-abcdefgasd; bbb=23123-aswe-4a7a-a740-f55dfd296b1d; ccc=69asd3d81234668942'
+      )
+    })
+    
+  })
+})

package/src/__tests__/setup.js

@@ -0,0 +1 @@
+process.env.TARO_ENV = 'weapp'

package/src/__tests__/utils.js

@@ -0,0 +1,8 @@
+
+export const delay = (ms = 2) => {
+  return new Promise(resolve => {
+    setTimeout(() => {
+      resolve()
+    }, ms)
+  })
+}

package/src/index.ts

@@ -0,0 +1,52 @@
+import { isArray, isString } from '@tarojs/shared'
+import path from 'path'
+
+import { name as packageName } from '../package.json'
+
+import type { IPluginContext, TaroPlatformBase } from '@tarojs/service'
+
+interface IOptions {
+  /** 支持 document.cookie 和 http 设置 cookie (默认false) */
+  enableCookie?: boolean
+  /** 禁用掉 FormData 全局对象 (默认true禁用) */
+  disabledFormData?: boolean
+  /** 禁用掉 Blob 全局对象 (默认true禁用) */
+  disabledBlob?: boolean
+}
+
+export default (ctx: IPluginContext, options: IOptions) => {
+  if (!['h5', 'rn'].includes(ctx.runOpts.options.platform)) {
+    ctx.modifyWebpackChain(({ chain }) => {
+      chain.plugin('definePlugin').tap((args) => {
+        args[0].ENABLE_COOKIE = options.enableCookie ?? false
+        return args
+      })
+
+      const runtimeAlia = `${packageName}/dist/runtime`
+      chain.resolve.alias.set(runtimeAlia, path.join(__dirname, 'runtime.js'))
+      // 注入相关全局BOM对象
+      chain.plugin('providerPlugin').tap((args) => {
+        args[0].XMLHttpRequest = [runtimeAlia, 'XMLHttpRequest']
+
+        // 实际上本runtime 没有实现 FormData 和 Blob 对象， 所以第三方库中的这2个对象会被替换成 undefined
+        // （axios这类请求库用到了这2个对象，所以要么实现它要么把它替换掉, 这里我们选择把它替换掉，这样可以确保除了上传以外的功能可以继续使用）
+        ;(options.disabledFormData ?? true) && (args[0].FormData ||= [runtimeAlia, 'FormData'])
+        ;(options.disabledBlob ?? true) && (args[0].Blob ||= [runtimeAlia, 'Blob'])
+
+        return args
+      })
+    })
+
+    ctx.registerMethod({
+      name: 'onSetupClose',
+      fn (platform: TaroPlatformBase) {
+        const injectedPath = `post:${packageName}/dist/runtime`
+        if (isArray(platform.runtimePath)) {
+          platform.runtimePath.push(injectedPath)
+        } else if (isString(platform.runtimePath)) {
+          platform.runtimePath = [platform.runtimePath, injectedPath]
+        }
+      },
+    })
+  }
+}

package/src/runtime/Cookie.ts

@@ -0,0 +1,312 @@
+/******************************************************************************
+Copyright (c) 2019 wechat-miniprogram. 
+Reference and modify code  by miniprogram-render/src/bom/cookie.js.
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.
+***************************************************************************** */
+import { parseUrl } from '@tarojs/runtime'
+import { getStorageSync, setStorage } from '@tarojs/taro'
+
+const STORAGE_KEY = 'PAGE_COOKIE'
+export class Cookie {
+  #map: any
+  constructor () {
+    this.#map = {} // 三维数组，domain - path - key
+  }
+
+  static parse (cookieStr: string) {
+    if (!cookieStr && typeof cookieStr !== 'string') return null
+
+    const cookieStrArr = cookieStr.trim().split(';')
+
+    // key-value
+    // eslint-disable-next-line no-control-regex
+    const parseKeyValue = /^([^=;\x00-\x1F]+)=([^;\n\r\0\x00-\x1F]*).*/.exec(cookieStrArr.shift()!)
+    if (!parseKeyValue) return null
+
+    const key = (parseKeyValue[1] || '').trim()
+    const value = (parseKeyValue[2] || '').trim()
+
+    // 其他字段
+    let path: string | null = null
+    let domain: string | null = null
+    let expires: number | null = null
+    let maxAge: number | null = null
+    let secure = false
+    let httpOnly = false
+
+    for (let item of cookieStrArr) {
+      item = item.trim()
+      if (!item) continue
+
+      let [key, value] = item.split('=')
+      key = (key || '').trim().toLowerCase()
+      value = (value || '').trim()
+
+      if (!key) continue
+
+      switch (key) {
+        case 'path':
+          if (value[0] === '/') path = value
+          break
+        case 'domain':
+          value = value.replace(/^\./, '').toLowerCase()
+          if (value) domain = value
+          break
+        case 'expires':
+          if (value) {
+            const timeStamp = Date.parse(value)
+            if (timeStamp) expires = timeStamp
+          }
+          break
+        case 'max-age':
+          if (/^-?[0-9]+$/.test(value)) maxAge = +value * 1000
+          break
+        case 'secure':
+          secure = true
+          break
+        case 'httponly':
+          httpOnly = true
+          break
+        default:
+          // ignore
+          break
+      }
+    }
+
+    return {
+      key,
+      value,
+      path,
+      domain,
+      expires,
+      maxAge,
+      secure,
+      httpOnly,
+    }
+  }
+
+  /**
+   * 判断 domain
+   */
+  $_checkDomain (host, cookieDomain) {
+    if (host === cookieDomain) return true
+
+    const index = host.indexOf(`.${cookieDomain}`)
+
+    return index > 0 && cookieDomain.length + index + 1 === host.length
+  }
+
+  /**
+   * 判断 path
+   */
+  $_checkPath (path, cookiePath) {
+    if (path === cookiePath) return true
+
+    cookiePath = cookiePath === '/' ? '' : cookiePath
+    return path.indexOf(`${cookiePath}/`) === 0
+  }
+
+  /**
+   * 判断过期
+   */
+  $_checkExpires (cookie) {
+    const now = Date.now()
+
+    // maxAge 优先
+    if (cookie.maxAge !== null) return cookie.createTime + cookie.maxAge > now
+
+    // 判断 expires
+    if (cookie.expires !== null) return cookie.expires > now
+
+    return true
+  }
+
+  /**
+   * 设置 cookie
+   */
+  setCookie (cookie, url) {
+    cookie = Cookie.parse(cookie)
+
+    if (!cookie) return
+
+    const { hostname, port, pathname } = parseUrl(url)
+    const host = (hostname || '') + (port ? ':' + port : '') || ''
+    const path = (pathname || '')[0] === '/' ? pathname : '/'
+
+    if (cookie.domain) {
+      // 判断 domain
+      if (!this.$_checkDomain(host, cookie.domain)) return
+    } else {
+      // 使用 host 作为默认的 domain
+      cookie.domain = host
+    }
+
+    // 需要设置 path 字段的情况，取 url 中除去最后一节的 path
+    if (!cookie.path || cookie.path[0] !== '/') {
+      const lastIndex = path.lastIndexOf('/')
+
+      cookie.path = lastIndex === 0 ? path : path.substr(0, lastIndex)
+    }
+
+    // 存入 cookie
+    const map = this.#map
+    const cookieDomain = cookie.domain
+    const cookiePath = cookie.path
+    const cookieKey = cookie.key
+
+    if (!map[cookieDomain]) map[cookieDomain] = {}
+    if (!map[cookieDomain][cookiePath]) map[cookieDomain][cookiePath] = {}
+
+    const oldCookie = map[cookieDomain][cookiePath][cookieKey]
+    cookie.createTime = (oldCookie && oldCookie.createTime) || Date.now()
+
+    if (this.$_checkExpires(cookie)) {
+      // 未过期
+      map[cookieDomain][cookiePath][cookieKey] = cookie
+    } else if (oldCookie) {
+      // 存在旧 cookie，且被设置为已过期
+      delete map[cookieDomain][cookiePath][cookieKey]
+    }
+
+    // 持久化 cookie
+    setStorage &&
+      setStorage({
+        key: STORAGE_KEY,
+        data: this.serialize(),
+      })
+  }
+
+  /**
+   * 拉取 cookie
+   */
+  getCookie (url: string, includeHttpOnly = false) {
+    const { protocol, hostname, port, pathname } = parseUrl(url)
+    const host = (hostname || '') + (port ? ':' + port : '') || ''
+    const path = (pathname || '')[0] === '/' ? pathname : '/'
+    const res: any[] = []
+
+    const map = this.#map
+    const domainList = Object.keys(map)
+
+    for (const domainItem of domainList) {
+      // 判断 domain
+      if (this.$_checkDomain(host, domainItem)) {
+        const domainMap = map[domainItem] || {}
+        const pathList = Object.keys(domainMap)
+
+        for (const pathItem of pathList) {
+          // 判断 path
+          if (this.$_checkPath(path, pathItem)) {
+            const pathMap = map[domainItem][pathItem] || {}
+
+            Object.keys(pathMap).forEach((key) => {
+              const cookie: any = pathMap[key]
+
+              if (!cookie) return
+
+              // 判断协议
+              if (cookie.secure && protocol !== 'https:' && protocol !== 'wss:') return
+              if (!includeHttpOnly && cookie.httpOnly && protocol && protocol !== 'http:') return
+
+              // 判断过期
+              if (this.$_checkExpires(cookie)) {
+                res.push(cookie)
+              } else {
+                // 过期，删掉
+                delete map[domainItem][pathItem][key]
+              }
+            })
+          }
+        }
+      }
+    }
+
+    return res
+      .sort((a, b) => {
+        const gap = a.createTime - b.createTime
+
+        if (!gap) {
+          return a.key < b.key ? -1 : 1
+        } else {
+          return gap
+        }
+      })
+      .map((cookie) => `${cookie.key}=${cookie.value}`)
+      .join('; ')
+  }
+
+  /**
+   * 序列化
+   */
+  serialize () {
+    try {
+      return JSON.stringify(this.#map)
+    } catch (err) {
+      // eslint-disable-next-line no-console
+      console.log('cannot serialize the cookie')
+      return ''
+    }
+  }
+
+  /**
+   * 反序列化
+   */
+  deserialize (str) {
+    let map = {}
+    try {
+      map = JSON.parse(str)
+    } catch (err) {
+      // eslint-disable-next-line no-console
+      console.log('cannot deserialize the cookie')
+      map = {}
+    }
+
+    // 合并 cookie
+    const domainList = Object.keys(map)
+
+    for (const domainItem of domainList) {
+      const domainMap = map[domainItem] || {}
+      const pathList = Object.keys(domainMap)
+
+      for (const pathItem of pathList) {
+        const pathMap = map[domainItem][pathItem] || {}
+
+        Object.keys(pathMap).forEach((key) => {
+          const cookie = pathMap[key]
+
+          if (!cookie) return
+
+          // 已存在则不覆盖
+          if (!this.#map[domainItem]) this.#map[domainItem] = {}
+          if (!this.#map[domainItem][pathItem]) this.#map[domainItem][pathItem] = {}
+          if (!this.#map[domainItem][pathItem][key]) this.#map[domainItem][pathItem][key] = cookie
+        })
+      }
+    }
+  }
+}
+
+/**
+ * 创建 cookie 实例并反序列化
+ * @returns
+ */
+export function createCookieInstance () {
+  const cookieInstance = new Cookie()
+  try {
+    const cookie = getStorageSync(STORAGE_KEY)
+    if (cookie) cookieInstance.deserialize(cookie)
+  } catch (err) {
+    // ignore
+  }
+  return cookieInstance
+}