扩展 key 的支持范围 (#463)

* 扩展 key 的支持范围

* update version

* fix review

* locaStorage key 区分

* add test;

* 删除无用的代码

* 优化逻辑

Author: winddies

README.md

@@ -180,7 +180,7 @@ qiniu.compressImage(file, options).then(data => {
 
   * **bucket**: 上传的目标空间
   * **file**: `File` 对象，上传的文件
-  * **key**: 文件资源名
+  * **key**: 文件资源名，为空字符串时则文件资源名也为空，为 `null` 或者 `undefined` 时则自动使用文件的 `hash` 作为文件名
   * **token**: 上传验证信息，前端通过接口请求后端获得
   * **config**: `object`，其中的每一项都为可选
 

package-lock.json

@@ -1,7 +1,7 @@
 {
   "name": "qiniu-js",
   "jsName": "qiniu",
-  "version": "3.1.0",
+  "version": "3.1.1",
   "private": false,
   "description": "Javascript SDK for Qiniu Resource (Cloud) Storage AP",
   "main": "lib/index.js",

package.json

@@ -0,0 +1,8 @@
+import { createLocalKey } from '../utils'
+
+describe('api function test', () => {
+  test('createLocalKey', () => {
+    expect(createLocalKey('test', null, 1024)).toMatch('qiniu_js_sdk_upload_file_name_test_size_1024')
+    expect(createLocalKey('test', 'demo', 1024)).toMatch('qiniu_js_sdk_upload_file_name_test_key_demo_size_1024')
+  })
+})

src/__tests__/utils.test.ts

@@ -43,9 +43,9 @@ export async function getUploadUrl(config: Config, token: string): Promise<strin
  * @param key 目标文件名
  * @param uploadInfo 上传信息
  */
-function getBaseUrl(bucket: string, key: string, uploadInfo: UploadInfo) {
+function getBaseUrl(bucket: string, key: string | null | undefined, uploadInfo: UploadInfo) {
   const { url, id } = uploadInfo
-  return `${url}/buckets/${bucket}/objects/${urlSafeBase64Encode(key)}/uploads/${id}`
+  return `${url}/buckets/${bucket}/objects/${key != null ? urlSafeBase64Encode(key) : '~'}/uploads/${id}`
 }
 
 export interface InitPartsData {
@@ -64,10 +64,10 @@ export interface InitPartsData {
 export function initUploadParts(
   token: string,
   bucket: string,
-  key: string,
+  key: string | null | undefined,
   uploadUrl: string
 ): utils.Response<InitPartsData> {
-  const url = `${uploadUrl}/buckets/${bucket}/objects/${urlSafeBase64Encode(key)}/uploads`
+  const url = `${uploadUrl}/buckets/${bucket}/objects/${key != null ? urlSafeBase64Encode(key) : '~'}/uploads`
   return utils.request<InitPartsData>(
     url,
     {
@@ -90,7 +90,7 @@ export interface UploadChunkData {
  */
 export function uploadChunk(
   token: string,
-  key: string,
+  key: string | null | undefined,
   index: number,
   uploadInfo: UploadInfo,
   options: Partial<utils.RequestOptions>
@@ -114,7 +114,7 @@ export type UploadCompleteData = any
  */
 export function uploadComplete(
   token: string,
-  key: string,
+  key: string | null | undefined,
   uploadInfo: UploadInfo,
   options: Partial<utils.RequestOptions>
 ): utils.Response<UploadCompleteData> {
@@ -134,7 +134,7 @@ export function uploadComplete(
  */
 export function deleteUploadedChunks(
   token: string,
-  key: string,
+  key: string | null | undefined,
   uploadinfo: UploadInfo
 ): utils.Response<void> {
   const bucket = utils.getPutPolicy(token).bucket

src/api.ts

@@ -17,7 +17,7 @@ const statisticsLogger = new StatisticsLogger()
  */
 function upload(
   file: File,
-  key: string,
+  key: string | null | undefined,
   token: string,
   putExtra?: Partial<Extra>,
   config?: Partial<Config>

src/index.ts

@@ -44,7 +44,7 @@ export interface Config {
 
 export interface UploadOptions {
   file: File
-  key: string
+  key: string | null | undefined
   token: string
   putExtra?: Partial<Extra>
   config?: Partial<Config>
@@ -88,7 +88,7 @@ export default abstract class Base {
   protected putExtra: Extra
   protected xhrList: XMLHttpRequest[] = []
   protected file: File
-  protected key: string
+  protected key: string | null | undefined
   protected aborted = false
   protected retryCount = 0
   protected token: string

src/upload/base.ts

@@ -53,8 +53,9 @@ export function setLocalFileInfo(localKey: string, info: LocalInfo) {
   }
 }
 
-export function createLocalKey(name: string, key: string, size: number): string {
-  return `qiniu_js_sdk_upload_file_name_${name}_key_${key}_size_${size}`
+export function createLocalKey(name: string, key: string | null | undefined, size: number): string {
+  const localKey = key == null ? '_' : `_key_${key}_`
+  return `qiniu_js_sdk_upload_file_name_${name}${localKey}size_${size}`
 }
 
 export function removeLocalFileInfo(localKey: string) {