修复 eslint & 为 QiniuRequestError 添加 data 字段 & 为 chunk 添加 isLocalCached 字段 (#511)

* 修复 eslint & 为 QiniuRequestError 添加 data 字段

Author: yinxulai

.travis.yml

@@ -1,16 +1,24 @@
 language: node_js
+
 node_js:
-- '12'
+  - "12"
+
 cache:
   directories:
-  - node_modules
+    - node_modules
+
 install:
-- npm install
+  - npm install
+
 script:
-- npm run build
-- jest --coverage
-- npx codecov
-before_deploy: npm run build
+  - npm run lint
+  - npm run test
+  - npx codecov
+  - npm run build
+
+before_deploy:
+  - npm run build
+
 deploy:
   provider: npm
   email: [email protected]

README.md

@@ -167,7 +167,13 @@ qiniu.compressImage(file, options).then(data => {
         * uploadInfo: `object`，只有分片上传时才返回该字段
           * uploadInfo.id: 上传任务的唯一标识。
           * uploadInfo.url: 上传地址。
-        * total: 包含`loaded`、`total`、`percent`三个属性:
+        * chunks: `Array<ProgressCompose>` 每个 `chunk` 的上传信息，只有分片上传有此字段
+          * ProgressCompose 的信息如下
+            * size: `number` chunk 的尺寸
+            * loaded: `number` 已经发送完毕的尺寸
+            * percent: `number` 进度比例，范围在 0 - 100
+            * fromCache?: `boolean` 是否是来自缓存
+        * total: 包含 `loaded`、`total`、`percent` 三个属性:
           * total.loaded: `number`，已上传大小，单位为字节。
           * total.total: `number`，本次上传的总量控制信息，单位为字节，注意这里的 total 跟文件大小并不一致。
           * total.percent: `number`，当前上传进度，范围：0～100。
@@ -178,6 +184,7 @@ qiniu.compressImage(file, options).then(data => {
           * message: `string` 错误的信息。
           * stack: `string` 调用堆栈信息。
         * `QiniuRequestError` 继承自 `QiniuError`
+          * data: `any` 服务端返回的错误信息，如果不是标准的 `json` 格式，则该字段为 `undefined`。
           * reqId: `string` xhr 请求错误的 `X-Reqid`。
           * code: `number` 请求错误状态码，可查阅码值对应 [说明](https://developer.qiniu.com/kodo/api/3928/error-responses)。
           * isRequestError: 固定为 `true`，*不推荐使用，即将废弃*。

package.json

@@ -8,11 +8,11 @@
   "types": "esm/index.d.ts",
   "module": "esm/index.js",
   "scripts": {
-    "clean": "del \"./(lib|dist|esm)\"",
     "test": "jest --coverage",
+    "clean": "del \"./(lib|dist|esm)\"",
     "build": "npm run clean && tsc && babel esm --out-dir lib && webpack --optimize-minimize --config webpack.prod.js",
-    "dev": "npm run lint && webpack-dev-server --open --config webpack.dev.js",
-    "lint": "tsc --noEmit && eslint --ext .ts",
+    "dev": "webpack-dev-server --open --config webpack.dev.js",
+    "lint": "tsc --noEmit && eslint --ext .ts src/",
     "server": "node test/server.js"
   },
   "repository": {
@@ -43,19 +43,22 @@
     "@babel/plugin-proposal-object-rest-spread": "^7.10.1",
     "@babel/plugin-transform-runtime": "^7.10.1",
     "@babel/preset-env": "^7.10.2",
-    "@qiniu/eslint-config": "0.0.4",
-    "@types/jest": "^25.2.3",
-    "@types/node": "^13.1.4",
+    "@qiniu/eslint-config": "0.0.6-beta.7",
+    "@types/jest": "^26.0.23",
+    "@types/node": "^15.3.1",
     "@types/spark-md5": "^3.0.2",
-    "@typescript-eslint/eslint-plugin": "^2.34.0",
-    "@typescript-eslint/parser": "^2.14.0",
+    "@typescript-eslint/eslint-plugin": "~4.10.0",
     "babel-loader": "^8.1.0",
     "babel-plugin-syntax-flow": "^6.18.0",
     "body-parser": "^1.18.2",
     "connect-multiparty": "^2.1.0",
     "del-cli": "^3.0.1",
-    "eslint": "^6.8.0",
-    "eslint-plugin-import": "^2.20.2",
+    "eslint": "~7.2.0",
+    "eslint-import-resolver-typescript": "~2.3.0",
+    "eslint-plugin-import": "~2.22.1",
+    "eslint-plugin-jsx-a11y": "~6.3.0",
+    "eslint-plugin-react": "~7.20.0",
+    "eslint-plugin-react-hooks": "~4.2.0",
     "express": "^4.16.2",
     "jest": "^26.0.1",
     "multiparty": "^4.1.3",

src/api/index.mock.ts

@@ -12,7 +12,7 @@ export const errorMap = {
   serviceTimeout: new QiniuRequestError(504, 'mock', 'message'), // 服务超时
   serviceError: new QiniuRequestError(599, 'mock', 'message'), // 服务错误
 
-  invalidUploadId: new QiniuRequestError(612, 'mock', 'message'), // 无效的 upload id
+  invalidUploadId: new QiniuRequestError(612, 'mock', 'message') // 无效的 upload id
 }
 
 export type ApiName =

src/api/index.test.ts

@@ -23,7 +23,7 @@ jest.mock('../utils', () => ({
 
 describe('api function test', () => {
   test('getUploadUrl', async () => {
-    let config: Config = {
+    const config: Config = {
       useCdnDomain: true,
       disableStatisticsReport: false,
       retryCount: 3,

src/errors/index.ts

@@ -42,16 +42,22 @@ export class QiniuRequestError extends QiniuError {
    */
   public isRequestError = true
 
-  constructor(public code: number, public reqId: string, message: string) {
+  /**
+   * @description 发生错误时服务端返回的错误信息，如果返回不是一个合法的 json、则该字段为 undefined
+   */
+  public data?: any
+
+  constructor(public code: number, public reqId: string, message: string, data?: any) {
     super(QiniuErrorName.RequestError, message)
+    this.data = data
   }
 }
 
 /**
  * @description 由于跨域、证书错误、断网、host 解析失败、系统拦截等原因导致的错误
  */
 export class QiniuNetworkError extends QiniuRequestError {
-  constructor(reqId = '', message: string) {
+  constructor(message: string, reqId = '') {
     super(0, reqId, message)
   }
 }

src/image/index.test.ts

@@ -7,23 +7,26 @@ describe('image func test', () => {
   const key = 'test.png'
 
   test('imageView2', () => {
-    let m = {
-      'fop': 'imageView2',
-      'mode': 2,
-      'h': 450,
-      'q': 100
+    const m = {
+      fop: 'imageView2',
+      mode: 2,
+      h: 450,
+      q: 100
     }
-    let url = imageView2(m, key, domain)
+    const url = imageView2(m, key, domain)
     expect(url).toBe(
-      'http://otxza7yo2.bkt.clouddn.com/' + key + '?' +
-      'imageView2/' + encodeURIComponent(m.mode) +
-      '/h' + '/' + encodeURIComponent(m.h) +
-      '/q' + '/' + encodeURIComponent(m.q)
+      'http://otxza7yo2.bkt.clouddn.com/' + key + '?'
+      + 'imageView2/' + encodeURIComponent(m.mode)
+      + '/h'
+      + '/'
+      + encodeURIComponent(m.h)
+      + '/q'
+      + '/' + encodeURIComponent(m.q)
     )
   })
 
   test('imageMogr2', () => {
-    let m = {
+    const m = {
       thumbnail: 1,
       strip: true,
       gravity: 1,
@@ -34,27 +37,27 @@ describe('image func test', () => {
       blur: 1
     }
 
-    let url = imageMogr2(m, key, domain)
+    const url = imageMogr2(m, key, domain)
     expect(url).toBe(
-      'http://otxza7yo2.bkt.clouddn.com/' + key + '?imageMogr2/' +
-      'thumbnail/1/strip/gravity/1/quality/1/crop/1/rotate/1/format/1/blur/1'
+      'http://otxza7yo2.bkt.clouddn.com/' + key + '?imageMogr2/'
+      + 'thumbnail/1/strip/gravity/1/quality/1/crop/1/rotate/1/format/1/blur/1'
     )
   })
 
   test('watermark', () => {
-    let m = {
+    const m = {
       fop: 'watermark',
       mode: 1,
       image: 'http://www.b1.qiniudn.com/images/logo-2.png',
       dissolve: 100,
       dx: 100,
       dy: 100
     }
-    let url = watermark(m, key, domain)
+    const url = watermark(m, key, domain)
     expect(url).toBe(
-      'http://otxza7yo2.bkt.clouddn.com/' + key + '?' +
-      'watermark/' + m.mode + '/image/' + urlSafeBase64Encode(m.image) +
-      '/dissolve/100/dx/100/dy/100'
+      'http://otxza7yo2.bkt.clouddn.com/' + key + '?'
+      + 'watermark/' + m.mode + '/image/' + urlSafeBase64Encode(m.image)
+      + '/dissolve/100/dx/100/dy/100'
     )
     m.mode = 3
     expect(() => {

src/logger/index.test.ts

@@ -41,15 +41,15 @@ describe('test logger', () => {
   test('level', () => {
     const infoLogger = new Logger('', true, 'INFO')
     infoLogger.info('test1')
-    // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     expect(logMessage).toStrictEqual([infoLogger.getPrintPrefix('INFO'), 'test1'])
     infoLogger.warn('test2')
-    // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     expect(warnMessage).toStrictEqual([infoLogger.getPrintPrefix('WARN'), 'test2'])
     infoLogger.error('test3')
-    // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     expect(errorMessage).toStrictEqual([infoLogger.getPrintPrefix('ERROR'), 'test3'])
 
@@ -62,11 +62,11 @@ describe('test logger', () => {
     warnLogger.info('test1')
     expect(logMessage).toStrictEqual([])
     warnLogger.warn('test2')
-    // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     expect(warnMessage).toStrictEqual([warnLogger.getPrintPrefix('WARN'), 'test2'])
     warnLogger.error('test3')
-    // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     expect(errorMessage).toStrictEqual([warnLogger.getPrintPrefix('ERROR'), 'test3'])
 
@@ -81,7 +81,7 @@ describe('test logger', () => {
     errorLogger.warn('test2')
     expect(warnMessage).toStrictEqual([])
     errorLogger.error('test3')
-    // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     expect(errorMessage).toStrictEqual([errorLogger.getPrintPrefix('ERROR'), 'test3'])
 
@@ -100,15 +100,15 @@ describe('test logger', () => {
   })
 
   test('unique id', () => {
-    // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     const startId = Logger.id
     // eslint-disable-next-line no-new
     new Logger('', true, 'OFF')
     // eslint-disable-next-line no-new
     new Logger('', true, 'OFF')
     const last = new Logger('', true, 'OFF')
-    // eslint-disable-next-line @typescript-eslint/ban-ts-ignore
+    // eslint-disable-next-line @typescript-eslint/ban-ts-comment
     // @ts-ignore
     expect(last.id).toStrictEqual(startId + 3)
   })

src/upload/base.ts

@@ -49,11 +49,11 @@ export interface InternalConfig {
 }
 
 /** 上传任务的配置信息 */
-export interface Config extends Omit<InternalConfig, 'upprotocol' | 'uphost'> {
+export interface Config extends Partial<Omit<InternalConfig, 'upprotocol' | 'uphost'>> {
   /** 上传域名协议 */
-  upprotocol: InternalConfig['upprotocol'] | 'https:' | 'http:'
+  upprotocol?: InternalConfig['upprotocol'] | 'https:' | 'http:'
   /** 自定义上传域名 */
-  uphost: InternalConfig['uphost'] | string
+  uphost?: InternalConfig['uphost'] | string
 }
 
 export interface UploadOptions {
@@ -83,14 +83,15 @@ export interface UploadHandlers {
 }
 
 export interface Progress {
-  loaded: number
   total: number
+  loaded: number
 }
 
 export interface ProgressCompose {
-  loaded: number
   size: number
+  loaded: number
   percent: number
+  fromCache?: boolean
 }
 
 export type XHRHandler = (xhr: XMLHttpRequest) => void
@@ -325,10 +326,11 @@ export default abstract class Base {
     })
   }
 
-  public getProgressInfoItem(loaded: number, size: number) {
+  public getProgressInfoItem(loaded: number, size: number, fromCache?: boolean): ProgressCompose {
     return {
-      loaded,
       size,
+      loaded,
+      fromCache,
       percent: loaded / size * 100
     }
   }

src/upload/hosts.ts

@@ -118,8 +118,8 @@ export class HostPool {
 
     // 无可用的，去取离解冻最近的 host
     const priorityQueue = cachedHostList
-      .slice().sort((hostA, hostB) => (
-        hostA.getUnfreezeTime() || 0) - (hostB.getUnfreezeTime() || 0)
+      .slice().sort(
+        (hostA, hostB) => (hostA.getUnfreezeTime() || 0) - (hostB.getUnfreezeTime() || 0)
       )
 
     return priorityQueue[0]