@cloudbase/app 1.5.2-alpha.0 → 1.8.1

package/src/libs/request.ts

@@ -1,18 +1,21 @@
+/* eslint-disable no-plusplus */
+/* eslint-disable no-prototype-builtins */
+/* eslint-disable no-restricted-syntax */
+/* eslint-disable @typescript-eslint/no-misused-promises */
 import {
   DATA_VERSION,
   LOGINTYPE,
   getSdkVersion,
   getEndPoint,
-  OAUTH2_LOGINTYPE_PREFIX
 } from '../constants/common';
 import {
   IRequestOptions,
   SDKRequestInterface,
   ResponseObject,
   IUploadRequestOptions,
-  IRequestConfig
+  IRequestConfig,
 } from '@cloudbase/adapter-interface';
-import { utils, jwt, adapters, constants } from '@cloudbase/utilities';
+import { utils, adapters, constants } from '@cloudbase/utilities';
 import { KV } from '@cloudbase/types';
 import { IGetAccessTokenResult, ICloudbaseRequestConfig, IAppendedRequestInfo, IRequestBeforeHook } from '@cloudbase/types/request';
 import { ICloudbaseCache } from '@cloudbase/types/cache';
@@ -20,15 +23,11 @@ import { cloudbase } from '..';
 import { getCacheByEnvId, getLocalCache } from './cache';
 import { EVENTS } from '../constants/events';
 import { Platform } from './adapter';
-const { getSdkName, ERRORS } = constants;
+
+const { ERRORS } = constants;
 const { genSeqId, isFormData, formatUrl, createSign } = utils;
 const { RUNTIME } = adapters;
 
-import { v4 as uuidv4 } from 'uuid'
-
-// import FingerprintJS from '@fingerprintjs/fingerprintjs'
-// const fpPromise = FingerprintJS.load()
-
 // 下面几种 action 不需要 access token
 const ACTIONS_WITHOUT_ACCESSTOKEN = [
   'auth.getJwt',
@@ -41,7 +40,7 @@ const ACTIONS_WITHOUT_ACCESSTOKEN = [
   'auth.activateEndUserMail',
   'auth.sendPasswordResetEmail',
   'auth.resetPasswordWithToken',
-  'auth.isUsernameRegistered'
+  'auth.isUsernameRegistered',
 ];
 
 function bindHooks(instance: SDKRequestInterface, name: string, hooks: IRequestBeforeHook[]) {
@@ -49,7 +48,7 @@ function bindHooks(instance: SDKRequestInterface, name: string, hooks: IRequestB
   instance[name] = function (options: IRequestOptions) {
     const data = {};
     const headers = {};
-    hooks.forEach(hook => {
+    hooks.forEach((hook) => {
       const { data: appendedData, headers: appendedHeaders } = hook.call(instance, options);
       Object.assign(data, appendedData);
       Object.assign(headers, appendedHeaders);
@@ -64,12 +63,12 @@ function bindHooks(instance: SDKRequestInterface, name: string, hooks: IRequestB
       }
       options.data = {
         ...originData,
-        ...data
+        ...data,
       };
     })();
     options.headers = {
       ...(options.headers || {}),
-      ...headers
+      ...headers,
     };
     return (originMethod as Function).call(instance, options);
   };
@@ -78,16 +77,15 @@ function beforeEach(): IAppendedRequestInfo {
   const seqId = genSeqId();
   return {
     data: {
-      seqId
+      seqId,
     },
     headers: {
       'X-SDK-Version': `@cloudbase/js-sdk/${getSdkVersion()}`,
-      'x-seqid': seqId
-    }
+      'x-seqid': seqId,
+    },
   };
 }
 export interface ICloudbaseRequest {
-  fetch: (urlOrPath: string, init?: RequestInit) => Promise<Response>;
   post: (options: IRequestOptions) => Promise<ResponseObject>;
   upload: (options: IUploadRequestOptions) => Promise<ResponseObject>;
   download: (options: IRequestOptions) => Promise<ResponseObject>;
@@ -102,8 +100,8 @@ export interface ICloudbaseRequest {
  */
 export class CloudbaseRequest implements ICloudbaseRequest {
   config: ICloudbaseRequestConfig;
-  _shouldRefreshAccessTokenHook: Function
-  _refreshAccessTokenPromise: Promise<IGetAccessTokenResult> | null
+  _shouldRefreshAccessTokenHook: Function;
+  _refreshAccessTokenPromise: Promise<IGetAccessTokenResult> | null;
   _reqClass: SDKRequestInterface;
   // 请求失败是否抛出Error
   private _throwWhenRequestFail = false;
@@ -120,7 +118,7 @@ export class CloudbaseRequest implements ICloudbaseRequest {
     this._reqClass = new Platform.adapter.reqClass(<IRequestConfig>{
       timeout: this.config.timeout,
       timeoutMsg: `[@cloudbase/js-sdk] 请求在${this.config.timeout / 1000}s内未完成，已中断`,
-      restrictedMethods: ['post']
+      restrictedMethods: ['post'],
     });
     this._throwWhenRequestFail = config.throw || false;
     this._cache = getCacheByEnvId(this.config.env);
@@ -129,49 +127,6 @@ export class CloudbaseRequest implements ICloudbaseRequest {
     bindHooks(this._reqClass, 'upload', [beforeEach]);
     bindHooks(this._reqClass, 'download', [beforeEach]);
   }
-
-  /**
-   * 套一层 fetch，方便处理请求地址
-   * @param {string}      urlOrPath
-   * @param {RequestInit} init
-   * @returns
-   */
-  public async fetch(urlOrPath: string, init?: RequestInit): Promise<Response> {
-    const deviceId = await this.getDeviceId();
-
-    const headers = {
-      'X-Project-Id': this.config.env,
-      'X-SDK-Version': `@cloudbase/js-sdk/${getSdkVersion()}`,
-      'X-Request-Id': genSeqId(),
-      'X-Request-Timestamp': Date.now(),
-      'X-Device-Id': deviceId
-    }
-    // 非web平台使用凭证检验有效性
-    if (Platform.runtime !== RUNTIME.WEB) {
-      const { appSign, appSecret } = this.config
-      const timestamp = Date.now()
-      const { appAccessKey, appAccessKeyId } = appSecret
-      const sign = createSign({
-        // data: init.body,
-        data: {},
-        timestamp,
-        appAccessKeyId,
-        appSign
-      }, appAccessKey)
-
-      headers['X-TCB-App-Source'] = `timestamp=${timestamp};appAccessKeyId=${appAccessKeyId};appSign=${appSign};sign=${sign}`
-    }
-
-    init.headers = Object.assign({}, init.headers, headers)
-
-    const { PROTOCOL, BASE_URL } = getEndPoint()
-    const webEndpoint = `${PROTOCOL}${BASE_URL}`
-    const url = urlOrPath.startsWith('http')
-      ? urlOrPath
-      : `${new URL(webEndpoint).origin}${urlOrPath}`
-    return await fetch(url, init)
-  }
-
   public async post(options: IRequestOptions): Promise<ResponseObject> {
     const res = await this._reqClass.post(options);
     return res;
@@ -207,51 +162,15 @@ export class CloudbaseRequest implements ICloudbaseRequest {
     return result;
   }
 
-  public async refreshAccessTokenFromOauthServer(clientId: string): Promise<IGetAccessTokenResult> {
-    // 可能会同时调用多次刷新 access token，这里把它们合并成一个
-    if (!this._refreshAccessTokenPromise) {
-      // 没有正在刷新，那么正常执行刷新逻辑
-      this._refreshAccessTokenPromise = this._refreshAccessTokenFromOauthServer(clientId);
-    }
-
-    let result;
-    let err;
-    try {
-      result = await this._refreshAccessTokenPromise;
-    } catch (e) {
-      err = e;
-    }
-    this._refreshAccessTokenPromise = null;
-    this._shouldRefreshAccessTokenHook = null;
-    if (err) {
-      throw err;
-    }
-    return result;
-  }
-
-  // 获取 OAuth accesstoken
-  public async getOauthAccessToken(): Promise<IGetAccessTokenResult> {
-    const { oauthClient } = this.config
-    if (oauthClient) {
-      const validAccessToken = await oauthClient.getAccessToken()
-      const credentials = await oauthClient._getCredentials()
-      return {
-        accessToken: validAccessToken,
-        accessTokenExpire: new Date(credentials.expires_at).getTime()
-      }
-    }
-  }
-
-  // 获取 access token
+  // 获取access token
   public async getAccessToken(): Promise<IGetAccessTokenResult> {
-    const { loginTypeKey, accessTokenKey, accessTokenExpireKey, refreshTokenKey } = this._cache.keys;
-    const loginType = await this._cache.getStoreAsync(loginTypeKey);
+    const { accessTokenKey, accessTokenExpireKey, refreshTokenKey } = this._cache.keys;
     const refreshToken = await this._cache.getStoreAsync(refreshTokenKey);
     if (!refreshToken) {
       // 不该出现的状态：有 access token 却没有 refresh token
       throw new Error(JSON.stringify({
         code: ERRORS.OPERATION_FAIL,
-        msg: 'refresh token is not exist, your local data might be messed up, please retry after clear localStorage or sessionStorage'
+        msg: 'refresh token is not exist, your local data might be messed up, please retry after clear localStorage or sessionStorage',
       }));
     }
     // 如果没有access token或者过期，那么刷新
@@ -265,43 +184,18 @@ export class CloudbaseRequest implements ICloudbaseRequest {
     }
 
     if ((!accessToken || !accessTokenExpire || accessTokenExpire < Date.now()) && shouldRefreshAccessToken) {
-      if (loginType.startsWith(OAUTH2_LOGINTYPE_PREFIX)) {
-        // NOTE: 这里需要从 accessToken 解出来部分信息，用于刷新 accessToken
-        // 所以过期的 accessToken 不能删除，而是用新 accessToken 覆盖
-        if (accessToken) {
-          let header = null
-          let payload = null
-          try {
-            header = jwt.decode(accessToken, { header: true })
-            payload = jwt.decode(accessToken)
-          }
-          catch (e) {
-            throw new Error(`[DECODE_ACCESS_TOKEN_ERROR] ${e.message}, accesstoken: ${accessToken}`)
-          }
-          if (header?.kid && payload?.project_id) {
-            return await this.refreshAccessTokenFromOauthServer(payload?.project_id)
-          }
-        }
-        else {
-          // 这里用 env 试一下
-          return await this.refreshAccessTokenFromOauthServer(this.config.env)
-        }
-      }
-      else {
-        return await this.refreshAccessToken();
-      }
-    } else {
-      // 返回本地的access token
-      return {
-        accessToken,
-        accessTokenExpire
-      };
+      // 返回新的access tolen
+      return await this.refreshAccessToken();
     }
+    // 返回本地的access token
+    return {
+      accessToken,
+      accessTokenExpire,
+    };
   }
 
   /* eslint-disable complexity */
   public async request(action: string, params: KV<any>, options?: KV<any>): Promise<ResponseObject> {
-    const { oauthClient } = this.config
     const tcbTraceKey = `x-tcb-trace_${this.config.env}`;
     let contentType = 'application/x-www-form-urlencoded';
     // const webDeviceId = await getTcbFingerprintId();
@@ -310,13 +204,9 @@ export class CloudbaseRequest implements ICloudbaseRequest {
       // webDeviceId,
       dataVersion: DATA_VERSION,
       env: this.config.env,
-      ...params
+      ...params,
     };
 
-    // 若识别到注册了 Oauth 模块，则使用oauth getAccessToken
-    if (oauthClient) {
-      tmpObj.access_token = (await this.getOauthAccessToken()).accessToken
-    }
 
     if (ACTIONS_WITHOUT_ACCESSTOKEN.indexOf(action) === -1) {
       const { refreshTokenKey } = this._cache.keys;
@@ -332,7 +222,7 @@ export class CloudbaseRequest implements ICloudbaseRequest {
     let payload;
     if (action === 'storage.uploadFile') {
       payload = new FormData();
-      for (let key in payload) {
+      for (const key in payload) {
         if (payload.hasOwnProperty(key) && payload[key] !== undefined) {
           payload.append(key, tmpObj[key]);
         }
@@ -341,19 +231,19 @@ export class CloudbaseRequest implements ICloudbaseRequest {
     } else {
       contentType = 'application/json;charset=UTF-8';
       payload = {};
-      for (let key in tmpObj) {
+      for (const key in tmpObj) {
         if (tmpObj[key] !== undefined) {
           payload[key] = tmpObj[key];
         }
       }
     }
-    let opts: any = {
+    const opts: any = {
       headers: {
-        'content-type': contentType
-      }
+        'content-type': contentType,
+      },
     };
-    if (options?.['onUploadProgress']) {
-      opts.onUploadProgress = options['onUploadProgress'];
+    if (options?.onUploadProgress) {
+      opts.onUploadProgress = options.onUploadProgress;
     }
 
     if (this.config.region) {
@@ -373,7 +263,7 @@ export class CloudbaseRequest implements ICloudbaseRequest {
         data: {}, // 校验签名流程实际未用到，可设空
         timestamp,
         appAccessKeyId,
-        appSign
+        appSign,
       }, appAccessKey);
 
       opts.headers['X-TCB-App-Source'] = `timestamp=${timestamp};appAccessKeyId=${appAccessKeyId};appSign=${appSign};sign=${sign}`;
@@ -384,13 +274,13 @@ export class CloudbaseRequest implements ICloudbaseRequest {
     // 请求链接支持添加动态 query 参数，方便用户调试定位请求
     const { parse, inQuery, search } = params;
     let formatQuery: Record<string, any> = {
-      env: this.config.env
+      env: this.config.env,
     };
     // 尝试解析响应数据为 JSON
     parse && (formatQuery.parse = true);
     inQuery && (formatQuery = {
       ...inQuery,
-      ...formatQuery
+      ...formatQuery,
     });
     const { BASE_URL, PROTOCOL } = getEndPoint();
     // 生成请求 url
@@ -403,7 +293,7 @@ export class CloudbaseRequest implements ICloudbaseRequest {
     const res: ResponseObject = await this.post({
       url: newUrl,
       data: payload,
-      ...opts
+      ...opts,
     });
 
     // 保存 trace header
@@ -430,7 +320,7 @@ export class CloudbaseRequest implements ICloudbaseRequest {
     if (response.data.code && this._throwWhenRequestFail) {
       throw new Error(JSON.stringify({
         code: ERRORS.OPERATION_FAIL,
-        msg: `[${response.data.code}] ${response.data.message}`
+        msg: `[${response.data.code}] ${response.data.message}`,
       }));
     }
 
@@ -443,15 +333,15 @@ export class CloudbaseRequest implements ICloudbaseRequest {
     await this._cache.removeStoreAsync(accessTokenKey);
     await this._cache.removeStoreAsync(accessTokenExpireKey);
 
-    let refreshToken = await this._cache.getStoreAsync(refreshTokenKey);
+    const refreshToken = await this._cache.getStoreAsync(refreshTokenKey);
     if (!refreshToken) {
       throw new Error(JSON.stringify({
         code: ERRORS.INVALID_OPERATION,
-        msg: 'not login'
+        msg: 'not login',
       }));
     }
     const params: KV<string> = {
-      refresh_token: refreshToken
+      refresh_token: refreshToken,
     };
     const response = await this.request('auth.fetchAccessTokenWithRefreshToken', params);
     if (response.data.code) {
@@ -469,26 +359,23 @@ export class CloudbaseRequest implements ICloudbaseRequest {
           const refresh_token = await this._cache.getStoreAsync(refreshTokenKey);
           const res = await this.send('auth.signInAnonymously', {
             anonymous_uuid,
-            refresh_token
+            refresh_token,
           });
           this._setRefreshToken(res.refresh_token);
           if (retryNum >= 1) {
             return this._refreshAccessToken(--retryNum);
-          } else {
-            throw new Error(
-              JSON.stringify({
-                code: ERRORS.OPERATION_FAIL,
-                message: '重试获取 refresh token 失败'
-              })
-            )
           }
+          throw new Error(JSON.stringify({
+            code: ERRORS.OPERATION_FAIL,
+            message: '重试获取 refresh token 失败',
+          }));
         }
         cloudbase.fire(EVENTS.LOGIN_STATE_EXPIRED);
         await this._cache.removeStoreAsync(refreshTokenKey);
       }
       throw new Error(JSON.stringify({
         code: ERRORS.NETWORK_ERROR,
-        msg: `refresh access_token failed：${response.data.code}`
+        msg: `refresh access_token failed：${response.data.code}`,
       }));
     }
     if (response.data.access_token) {
@@ -498,7 +385,7 @@ export class CloudbaseRequest implements ICloudbaseRequest {
       await this._cache.setStoreAsync(accessTokenExpireKey, response.data.access_token_expire + Date.now());
       return {
         accessToken: response.data.access_token,
-        accessTokenExpire: response.data.access_token_expire
+        accessTokenExpire: response.data.access_token_expire,
       };
     }
     // 匿名登录refresh_token过期情况下返回refresh_token
@@ -509,103 +396,13 @@ export class CloudbaseRequest implements ICloudbaseRequest {
       await this._refreshAccessToken();
     }
   }
-
-  private async _fetchAccessTokenFromOauthServer(refreshToken: string, clientId: string) {
-    const resp = await this.fetch('/auth/v1/token', {
-      method: 'POST',
-      headers: {
-        'Accept': 'application/json',
-        'Content-Type': 'application/json'
-      },
-      body: JSON.stringify({
-        grant_type: 'refresh_token',
-        client_id: clientId,
-        refresh_token: refreshToken
-      })
-    })
-    // Resp:
-    // {
-    //   "token_type": "Bearer",
-    //   "access_token": "",
-    //   "refresh_token":"",
-    //   "expires_in": 259200,
-    //   "sub": ""
-    // }
-    // 以下代码重复
-    const seqIdFromHeader = resp.headers.get('SeqId') || resp.headers.get('RequestId')
-    if (resp.status >= 400 && resp.status < 500) {
-      const body: any = await resp.json()
-      const seqId = body.request_id || seqIdFromHeader
-      throw new Error(`[${getSdkName()}/${getSdkVersion()}][OAuth2AuthProvider][status:${resp.status}][${body.error}(${body.error_code})] ${body.error_description} (${seqId})`)
-    }
-    else if (resp.status >= 500) {
-      const body: any = await resp.json()
-      const seqId = body.request_id || seqIdFromHeader
-      throw new Error(`[${getSdkName()}/${getSdkVersion()}][OAuth2AuthProvider][status:${resp.status}][${body.error}(${body.error_code})] ${body.error_description} (${seqId})`)
-    }
-    return resp.json()
-  }
-
-  // 调用接口刷新access token，并且返回
-  private async _refreshAccessTokenFromOauthServer(clientId: string): Promise<IGetAccessTokenResult> {
-    const { accessTokenKey, accessTokenExpireKey, refreshTokenKey } = this._cache.keys;
-    const refreshToken = await this._cache.getStoreAsync(refreshTokenKey);
-    if (!refreshToken) {
-      throw new Error(JSON.stringify({
-        code: ERRORS.INVALID_OPERATION,
-        msg: 'not login'
-      }));
-    }
-
-    const token = await this._fetchAccessTokenFromOauthServer(refreshToken, clientId);
-    const { refresh_token: newRefreshToken, access_token: accessToken, expires_in: accessTokenExpire } = token
-
-    // 错误处理
-    if (!accessToken || !accessTokenExpire) {
-      throw new Error(JSON.stringify({
-        code: ERRORS.NETWORK_ERROR,
-        msg: 'refresh access_token failed'
-      }));
-    }
-    if (accessToken && accessTokenExpire) {
-      if (newRefreshToken === refreshToken) {
-        await this._cache.setStoreAsync(refreshTokenKey, newRefreshToken);
-      }
-      await this._cache.setStoreAsync(accessTokenKey, accessToken);
-      await this._cache.setStoreAsync(accessTokenExpireKey, accessTokenExpire * 1000 + Date.now());
-      cloudbase.fire(EVENTS.ACCESS_TOKEN_REFRESHD);
-      return {
-        accessToken: accessToken,
-        accessTokenExpire: accessTokenExpire
-      };
-    }
-  }
-
   private async _setRefreshToken(refreshToken: string) {
     const { accessTokenKey, accessTokenExpireKey, refreshTokenKey } = this._cache.keys;
     // refresh token设置前，先清掉 access token
-    // 设置是直接拉取新 access token 覆盖，而不是 remove
     await this._cache.removeStoreAsync(accessTokenKey);
     await this._cache.removeStoreAsync(accessTokenExpireKey);
     await this._cache.setStoreAsync(refreshTokenKey, refreshToken);
   }
-
-  private async getDeviceId(): Promise<string> {
-    const { deviceIdKey } = this._cache.keys
-    const deviceId = await this._cache.getStoreAsync(deviceIdKey)
-
-    if (!deviceId) {
-      // const fp = await fpPromise
-      // const result = await fp.get()
-      // const deviceId = result.visitorId
-      const newDeviceId = uuidv4()
-      this._cache.setStoreAsync(deviceIdKey, newDeviceId)
-      return newDeviceId
-    }
-    else {
-      return deviceId
-    }
-  }
 }
 
 const requestMap: KV<CloudbaseRequest> = {};
@@ -613,10 +410,10 @@ const requestMap: KV<CloudbaseRequest> = {};
 export function initRequest(config: ICloudbaseRequestConfig) {
   requestMap[config.env] = new CloudbaseRequest({
     ...config,
-    throw: true
+    throw: true,
   });
 }
 
 export function getRequestByEnvId(env: string): CloudbaseRequest {
   return requestMap[env];
-}
+}

package/.eslintrc

@@ -1,29 +0,0 @@
-{
-    "extends": [
-        "eslint-config-alloy/typescript"
-    ],
-    "rules": {
-        "indent": [
-            "error",
-            2,
-            {
-                "SwitchCase": 1,
-                "flatTernaryExpressions": true
-            }
-        ],
-        "guard-for-in": 0,
-        "no-param-reassign": 0,
-        "no-undefined": 0,
-        "@typescript-eslint/explicit-member-accessibility": 0,
-        "@typescript-eslint/consistent-type-assertions": 0,
-        "@typescript-eslint/no-loss-of-precision": 0,
-        "@typescript-eslint/no-duplicate-imports": 0
-    },
-    "parserOptions": {
-        "ecmaVersion": 6,
-        "sourceType": "module",
-        "ecmaFeatures": {
-            "modules": true
-        }
-    }
-}