build: 0.0.23

fix: fc 480

.github/workflows/registry-publish.yml

@@ -21,9 +21,9 @@ jobs:
           python -m pip install --upgrade pip
           pip install setuptools wheel twine
           pip install requests
-#      - name: NPM install
-#        run: |
-#          npm install --production
+      - name: Build
+        run: |
+          npm run build
       - name: Add publish file
         run: |
           wget https://serverless-registry.oss-cn-hangzhou.aliyuncs.com/publish-file/python3/hub-publish.py

.signore

@@ -1,8 +1,7 @@
 node_modules
 .s
-tsconfig.json
 LICENSE
-package-lok.json
+package-lock.json
 .prettierrc.js
 .gitignore
 
@@ -15,3 +14,4 @@ package-lok.json
 README.md
 ./example
 ./.signore
+./src

Makefile

@@ -0,0 +1,26 @@
+.PHONY: push
+
+CURRENT_BRANCH_NAME := $(shell git symbolic-ref --short HEAD)
+
+add:
+	git add .
+
+commit: add
+	git-cz
+
+rebase-main: commit
+	git pull --rebase origin master
+
+push:
+	git push --force-with-lease origin $(CURRENT_BRANCH_NAME)
+
+release-dev: push
+	-gh release delete dev -y
+	-git tag -d dev
+	-git push origin :refs/tags/dev
+	gh release create dev --notes "dev release" --target dev --title "Release dev"
+
+roll-back-dev:
+	git reset --soft HEAD~1
+	git restore --staged publish.yaml
+	git restore publish.yaml

README.md

@@ -23,9 +23,9 @@ services:
 
 
 ````
-$ s exec -- invoke --invocation-type sync --event ${payload}
-$ s exec -- invoke --invocation-type async --event-file ${path}
-$ s exec -- invoke --event-stdin
+$ s invoke --invocation-type sync --event ${payload}
+$ s invoke --invocation-type async --event-file ${path}
+$ s invoke --event-stdin
 ````
 
 ## CLI 用法

example/http.json

@@ -1,11 +1,16 @@
 {
-  "body": 123,
   "method": "POST",
   "headers": {
-    "key": "value"
+    "key": "value",
+    "Content-Type": "application/json"
   },
   "queries": {
     "key": "value"
   },
-  "path": "string"
+  "body": {
+    "abc": "body",
+    "tmpNasZipPath": "/tmpNasZipPath",
+    "body": "body"
+  },
+  "path": "download"
 }

lib/common/help.d.ts

@@ -1,44 +0,0 @@
-declare const _default: ({
-    header: string;
-    content: string;
-    optionList?: undefined;
-} | {
-    header: string;
-    optionList: ({
-        name: string;
-        description: string;
-        type: StringConstructor;
-        alias?: undefined;
-    } | {
-        name: string;
-        description: string;
-        alias: string;
-        type: StringConstructor;
-    } | {
-        name: string;
-        description: string;
-        type: BooleanConstructor;
-        alias?: undefined;
-    })[];
-    content?: undefined;
-} | {
-    header: string;
-    optionList: {
-        name: string;
-        description: string;
-        alias: string;
-        type: BooleanConstructor;
-    }[];
-    content?: undefined;
-} | {
-    header: string;
-    content: string[];
-    optionList?: undefined;
-} | {
-    header: string;
-    content: {
-        example: string;
-    }[];
-    optionList?: undefined;
-})[];
-export default _default;

lib/common/logger.d.ts

@@ -1,10 +0,0 @@
-export default class ComponentLogger {
-    static CONTENT: string;
-    static setContent(content: any): void;
-    static log(m: any, color?: 'black' | 'red' | 'green' | 'yellow' | 'blue' | 'magenta' | 'cyan' | 'white' | 'whiteBright' | 'gray'): void;
-    static info(m: any): void;
-    static debug(m: any): void;
-    static error(m: any): void;
-    static warning(m: any): void;
-    static success(m: any): void;
-}

lib/common/stdout-formatter.d.ts

@@ -1,4 +0,0 @@
-export default class StdoutFormatter {
-    static stdoutFormatter: any;
-    static initStdout(): Promise<void>;
-}

lib/index.d.ts

@@ -1,11 +0,0 @@
-import { InputProps } from './interface/entity';
-export default class FcRemoteInvoke {
-    /**
-     * event 函数本地调试
-     * @param inputs
-     * @returns
-     */
-    invoke(inputs: InputProps): Promise<any>;
-    private report;
-    private handlerInputs;
-}

lib/interface/entity.d.ts

@@ -1,34 +0,0 @@
-export interface ICredentials {
-    AccountID?: string;
-    AccessKeyID?: string;
-    AccessKeySecret?: string;
-    SecurityToken?: string;
-}
-export interface InputProps {
-    props?: IProperties;
-    credentials: ICredentials;
-    appName: string;
-    project: {
-        component: string;
-        access: string;
-        projectName: string;
-    };
-    command: string;
-    args: string;
-    path: {
-        configPath: string;
-    };
-}
-export interface IProperties {
-    region: string;
-    serviceName: string;
-    functionName: string;
-    qualifier?: string;
-    domainName?: string;
-}
-export declare function isProperties(args: any): args is IProperties;
-export interface IEventPayload {
-    event?: string;
-    eventFile?: string;
-    eventStdin?: boolean;
-}

lib/lib/client.d.ts

@@ -1,5 +0,0 @@
-import { ICredentials } from '../interface/entity';
-export default class Client {
-    static buildFcClient(region: string, credentials: ICredentials): Promise<any>;
-    private static getFcEndpoint;
-}

lib/lib/event.d.ts

@@ -1,4 +0,0 @@
-export default class File {
-    static getEvent(eventFile: any): Promise<unknown>;
-    static eventPriority(eventPriority: any): Promise<any>;
-}

lib/lib/remote-invoke.d.ts

@@ -1,39 +0,0 @@
-import { IProperties, IEventPayload } from '../interface/entity';
-export default class RemoteInvoke {
-    fcClient: any;
-    accountId: string;
-    constructor(fcClient: any, accountId: string);
-    invoke(props: IProperties, eventPayload: IEventPayload, { invocationType }: {
-        invocationType: any;
-    }): Promise<void>;
-    requestDomain(url: string, event: string): Promise<void>;
-    getHttpTrigger(serviceName: any, functionName: any): Promise<any>;
-    eventInvoke({ serviceName, functionName, event, qualifier, invocationType }: {
-        serviceName: any;
-        functionName: any;
-        event: any;
-        qualifier?: string;
-        invocationType: any;
-    }): Promise<void>;
-    httpInvoke({ region, serviceName, functionName, event, qualifier }: {
-        region: any;
-        serviceName: any;
-        functionName: any;
-        event: any;
-        qualifier: any;
-    }): Promise<void>;
-    /**
-     * @param event: { body, headers, method, queries, path }
-     * path 组装后的路径 /proxy/serviceName/functionName/path ,
-     */
-    request(event: any): Promise<void>;
-    handlerHttpParmase(event: any): {
-        headers: any;
-        queries: any;
-        method: any;
-        path: any;
-        body: any;
-    };
-    private showLog;
-    private getJsonEvent;
-}

lib/lib/stdin.d.ts

@@ -1,5 +0,0 @@
-/// <reference types="node" />
-export declare function getStdin(): Promise<string>;
-export declare namespace getStdin {
-    var buffer: () => Promise<Buffer>;
-}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "fc-remote-invoke",
-  "version": "0.0.16",
+  "version": "0.0.23",
   "description": "This is a component demo for Serverless Devs Tool ",
   "keywords": [
     "Serverless",
@@ -13,7 +13,7 @@
   "author": "Serverless-Devs",
   "contributors": [],
   "license": "MIT",
-  "main": "./lib/index.js",
+  "main": "./dist/index.js",
   "publishConfig": {
     "access": "public"
   },
@@ -24,15 +24,17 @@
   "scripts": {
     "start": "npm run watch",
     "watch": "tsc -w",
-    "prebuild": "rm -rf node_modules && rm -rf package-lock.json && npm i && rimraf lib",
-    "build": "ncc build src/index.ts -m -o lib"
+    "prebuild": "rm -rf node_modules && rm -rf package-lock.json && npm i && rimraf dist",
+    "esbuild": "esbuild src/index.ts --bundle --log-level=error --minify --platform=node --format=cjs --target=node10.4 --external:@serverless-devs/core --outfile=dist/index.js",
+    "build": "npm run esbuild"
   },
   "dependencies": {
-    "@alicloud/fc2": "^2.2.2",
-    "@serverless-devs/core": "^0.0.*",
+    "@serverless-devs/core": "latest",
+    "form-data": "^4.0.0",
     "fs-extra": "^10.0.0",
     "got": "^11.8.2",
     "lodash": "^4.17.21",
+    "qs": "^6.10.1",
     "readline": "^1.3.0"
   },
   "autoInstall": false,
@@ -45,6 +47,6 @@
     "ts-node": "^8.10.2",
     "typedoc": "^0.20.35",
     "typescript": "^3.9.7",
-    "@vercel/ncc": "^0.24.0"
+    "esbuild": "^0.14.0"
   }
 }

publish.yaml

@@ -2,7 +2,7 @@ Type: Component
 Name: fc-remote-invoke
 Provider:
   - 其它
-Version: 0.0.16
+Version: 0.0.23
 Description: 初始化component模板
 HomePage: https://www.serverless-devs.com
 Tags: #标签详情

src/common/help.ts

@@ -75,9 +75,9 @@ export default [
     content: [
       '$ s invoke',
       '$ s <ProjectName> invoke',
-      '$ s exec -- invoke --invocation-type sync --event <payload>',
-      '$ s exec -- invoke --event-file <file-path>',
-      '$ s exec -- invoke --event-stdin',
+      '$ s invoke --invocation-type sync --event <payload>',
+      '$ s invoke --event-file <file-path>',
+      '$ s invoke --event-stdin',
     ],
   },
   {

src/index.ts

@@ -5,7 +5,6 @@ import HELP from './common/help';
 import { InputProps, isProperties, IProperties } from './interface/entity';
 // import StdoutFormatter from './common/stdout-formatter';
 import RemoteInvoke from './lib/remote-invoke';
-import Client from './lib/client';
 
 export default class FcRemoteInvoke {
   /**
@@ -16,10 +15,12 @@ export default class FcRemoteInvoke {
   async invoke(inputs: InputProps): Promise<any> {
     const {
       props,
+      timeout,
       eventPayload,
       credentials,
       isHelp,
       invocationType,
+      statefulAsyncInvocationId,
     } = await this.handlerInputs(inputs);
     await this.report('fc-remote-invoke', 'invoke', credentials?.AccountID);
 
@@ -30,10 +31,11 @@ export default class FcRemoteInvoke {
 
     let fcClient;
     if (!props.domainName) {
-      fcClient = await Client.buildFcClient(props.region, credentials);
+      const fcCommon = await core.loadComponent('devsapp/fc-common');
+      fcClient = await fcCommon.makeFcClient({ ...inputs, props: { region: props.region, timeout }});
     }
     const remoteInvoke = new RemoteInvoke(fcClient, credentials.AccountID);
-    await remoteInvoke.invoke(props, eventPayload, { invocationType });
+    await remoteInvoke.invoke(props, eventPayload, { invocationType, statefulAsyncInvocationId });
   }
 
   private async report(componentName: string, command: string, accountID: string): Promise<void> {
@@ -50,11 +52,13 @@ export default class FcRemoteInvoke {
 
     const parsedArgs: {[key: string]: any} = core.commandParse({ ...inputs, args }, {
       boolean: ['help', 'event-stdin'],
-      string: ['invocation-type', 'event', 'event-file', 'region', 'domain-name','service-name', 'function-name', 'qualifier'],
+      number: ['timeout'],
+      string: ['invocation-type', 'event', 'event-file', 'region', 'domain-name','service-name', 'function-name', 'qualifier', 'stateful-async-invocation-id'],
       alias: {
         'help': 'h',
         'event': 'e',
         'event-file': 'f',
+        'event-stdin': 's',
       }
     });
 
@@ -73,6 +77,7 @@ export default class FcRemoteInvoke {
       'event-stdin': eventStdin,
       'invocation-type': invocationType = 'sync',
       'domain-name': domainName,
+      'stateful-async-invocation-id': statefulAsyncInvocationId,
     } = argsData;
     const eventPayload = { event, eventFile, eventStdin };
     // @ts-ignore: 判断三个值有几个真
@@ -105,12 +110,25 @@ export default class FcRemoteInvoke {
       throw new Error('region/serviceName(service-name)/functionName(function-name) can not be empty.');
     }
 
+    // 超时时间获取的原理：https://github.com/devsapp/fc/issues/480
+    const propsTimeout = argsData.timeout || inputs.props?.timeout;
+    let timeout = 600;
+    if (_.isNumber(propsTimeout)) {
+      if (_.isEmpty(inputs.props?.runtime) || inputs.props?.runtime === 'custom-container') {
+        timeout = propsTimeout + 7 * 60;
+      } else {
+        timeout = propsTimeout + 2 * 60;
+      }
+    }
+
     return {
       props,
+      timeout,
       credentials: inputs.credentials,
       eventPayload,
       isHelp: false,
       invocationType: _.upperFirst(invocationType),
+      statefulAsyncInvocationId,
     };
   }
 

src/interface/entity.ts

@@ -25,8 +25,10 @@ export interface IProperties {
   region: string;
   serviceName: string;
   functionName: string;
+  runtime?: string;
   qualifier?: string;
   domainName?: string;
+  timeout?: string;
 }
 export function isProperties(args: any): args is IProperties {
   if (!args) {

src/lib/client.ts

@@ -1,24 +0,0 @@
-import FC from '@alicloud/fc2';
-import * as core from '@serverless-devs/core';
-import { ICredentials } from '../interface/entity';
-
-export default class Client {
-  static async buildFcClient(region: string, credentials: ICredentials) {
-    return new FC(credentials.AccountID, {
-      accessKeyID: credentials.AccessKeyID,
-      accessKeySecret: credentials.AccessKeySecret,
-      securityToken: credentials.SecurityToken,
-      region,
-      endpoint: await this.getFcEndpoint(),
-      timeout: 6000000,
-    })
-  }
-
-  private static async getFcEndpoint(): Promise<string | undefined> {
-    const fcDefault = await core.loadComponent('devsapp/fc-default');
-    const fcEndpoint: string = await fcDefault.get({ args: 'fc-endpoint' });
-    if (!fcEndpoint) { return undefined; }
-    const enableFcEndpoint: any = await fcDefault.get({ args: 'enable-fc-endpoint' });
-    return (enableFcEndpoint === true || enableFcEndpoint === 'true') ? fcEndpoint : undefined;
-  }
-}

src/lib/event.ts

@@ -16,9 +16,10 @@ export default class File {
       let input;
 
       if (eventFile === '-') { // read from stdin
-        logger.log('Reading event data from stdin, which can be ended with Enter then Ctrl+D')
+        logger.log('Reading event data from stdin, which can be ended with Enter then Ctrl+D');
         input = process.stdin;
       } else {
+        logger.log('Reading event file content:');
         input = fs.createReadStream(eventFile, {
           encoding: 'utf-8'
         })
@@ -32,7 +33,10 @@ export default class File {
       rl.on('line', (line) => {
         event += line
       })
-      rl.on('close', () => resolve(event))
+      rl.on('close', () => {
+        logger.log('');
+        resolve(event)
+      })
 
       rl.on('SIGINT', () => reject(new Error('^C')))
     })

src/lib/handler-body.ts

@@ -0,0 +1,34 @@
+import _ from 'lodash';
+import qs from 'qs';
+import FormData from 'form-data';
+
+export default function handlerBody(contentType: string, body: any) {
+  if (contentType.includes('text/') || contentType.includes('application/json') || contentType.includes('application/xml')) {
+    if (_.isString(body)) return body;
+    try {
+      return JSON.stringify(body);
+    } catch (_ex) {
+      return body.toString();
+    }
+  }
+
+  if (contentType.includes('application/x-www-form-urlencoded')) {
+    return qs.stringify(body, { indices: false });
+  }
+
+  if (contentType.includes('multipart/form-data')) {
+    const form = new FormData();
+    try {
+      const newBody = _.isObject(body) ? body : JSON.parse(body);
+      for (const [key, value] of Object.entries(newBody)) {
+        form.append(key, value);
+      }
+      return form;
+    } catch (_ex) {
+      throw new Error(`Handler body error: The request header is ${contentType}, but the request body is not an object`);
+    }
+
+  }
+
+  return body;
+}

src/lib/remote-invoke.ts

@@ -13,7 +13,7 @@ export default class RemoteInvoke {
     this.accountId = accountId;
   }
 
-  async invoke (props: IProperties, eventPayload: IEventPayload, { invocationType }) {
+  async invoke (props: IProperties, eventPayload: IEventPayload, { invocationType, statefulAsyncInvocationId }) {
     const event = await Event.eventPriority(eventPayload);
     logger.debug(`event: ${event}`);
 
@@ -32,12 +32,13 @@ export default class RemoteInvoke {
     const payload: any = { event, serviceName, functionName, qualifier };
     if (_.isEmpty(httpTriggers)) {
       payload.invocationType = invocationType;
+      payload.statefulAsyncInvocationId = statefulAsyncInvocationId;
       payload.event = event;
       await this.eventInvoke(payload);
     } else {
       payload.region = region;
       payload.event = this.getJsonEvent(event);
-      
+
       await this.httpInvoke(payload);
     }
   }
@@ -48,9 +49,9 @@ export default class RemoteInvoke {
       payload.headers = {};
     }
     payload.headers['X-Fc-Log-Type'] = 'Tail';
-    
+
     const { body, headers } = await got(url, payload);
-      
+
     this.showLog(headers['x-fc-log-result']);
     logger.log('\nFC Invoke Result:', 'green');
     console.log(body);
@@ -74,13 +75,15 @@ export default class RemoteInvoke {
     functionName,
     event,
     qualifier = 'LATEST',
-    invocationType
+    invocationType,
+    statefulAsyncInvocationId
   }) {
 
     if (invocationType === 'Sync') {
       const rs = await this.fcClient.invokeFunction(serviceName, functionName, event, {
         'X-Fc-Log-Type': 'Tail',
-        'X-Fc-Invocation-Type': invocationType
+        'X-Fc-Invocation-Code-Version': 'Latest',
+        'X-Fc-Invocation-Type': invocationType,
       }, qualifier);
 
       this.showLog(rs.headers['x-fc-log-result']);
@@ -88,8 +91,11 @@ export default class RemoteInvoke {
       console.log(rs.data);
       console.log('\n');
     } else {
+      logger.debug(`Stateful async invocation id: ${statefulAsyncInvocationId}`);
       const { headers } = await this.fcClient.invokeFunction(serviceName, functionName, event, {
-        'X-Fc-Invocation-Type': invocationType
+        'X-Fc-Invocation-Code-Version': 'Latest',
+        'X-Fc-Invocation-Type': invocationType,
+        'X-Fc-Stateful-Async-Invocation-Id': statefulAsyncInvocationId || "",
       }, qualifier);
       const rId = headers['x-fc-request-id'];
 
@@ -101,7 +107,7 @@ export default class RemoteInvoke {
     const q = qualifier ? `.${qualifier}` : '';
     event.path = `/proxy/${serviceName}${q}/${functionName}/${event.path || ''}`;
 
-    logger.log(`https://${this.accountId}.${region}.fc.aliyuncs.com/2016-08-15/proxy/${serviceName}${q}/${functionName}/`);
+    logger.log(`Request url: https://${this.accountId}.${region}.fc.aliyuncs.com/2016-08-15/proxy/${serviceName}${q}/${functionName}/`);
     await this.request(event)
   }
 
@@ -109,8 +115,14 @@ export default class RemoteInvoke {
    * @param event: { body, headers, method, queries, path }
    * path 组装后的路径 /proxy/serviceName/functionName/path ,
    */
-  async request (event) {
-    const { headers, queries, method, path: p, body } = this.handlerHttpParmase(event);
+  async request(event) {
+    const { headers = {}, queries, method = 'GET', path: p, body } = event;
+    if (!headers['X-Fc-Log-Type']) {
+      headers['X-Fc-Log-Type'] = 'Tail';
+    }
+    if (!headers['X-Fc-Invocation-Code-Version']) {
+      headers['X-Fc-Invocation-Code-Version'] = 'Latest';
+    }
 
     let resp;
     try {
@@ -118,18 +130,17 @@ export default class RemoteInvoke {
       logger.debug(`method is ${mt}.`);
       logger.debug(`start invoke.`);
       if (mt === 'GET') {
-        resp = await this.fcClient.get(p, queries, headers);
+        resp = await this.fcClient.costom_request('GET', p, queries, null, headers);
       } else if (mt === 'POST') {
-        resp = await this.fcClient.post(p, body, headers, queries);
+        resp = await this.fcClient.costom_request('POST', p, queries, body, headers);
       } else if (mt === 'PUT') {
-        resp = await this.fcClient.put(p, body, headers);
+        resp = await this.fcClient.costom_request('PUT', p, null, body, headers);
       } else if (mt === 'DELETE') {
-        resp = await this.fcClient.request('DELETE', p, queries, null, headers);
-        /* else if (method.toLocaleUpperCase() === 'PATCH') {
-        resp = await this.fcClient.request('PATCH', p, queries, body, headers);
+        resp = await this.fcClient.costom_request('DELETE', p, queries, null, headers);
+      } else if (method.toLocaleUpperCase() === 'PATCH') {
+        resp = await this.fcClient.costom_request('PATCH', p, queries, body, headers);
       } else if (method.toLocaleUpperCase() === 'HEAD') {
-        resp = await this.fcClient.request('HEAD', p, queries, body, headers);
-      } */
+        resp = await this.fcClient.costom_request('HEAD', p, queries, body, headers);
       } else {
         logger.error(`Does not support ${method} requests temporarily.`);
       }
@@ -142,47 +153,19 @@ export default class RemoteInvoke {
     }
     logger.debug(`end invoke.`);
 
-    if (resp) {
+    if (resp?.err) {
       this.showLog(resp.headers['x-fc-log-result']);
-
-      logger.log('\nFC Invoke Result:', 'green');
+      logger.log(`\nFC Invoke Result[Code: ${resp.code}]:`, 'red');
       console.log(resp.data);
       console.log('\n');
-    }
-  }
+    } else {
+      if (resp) {
+        this.showLog(resp.headers['x-fc-log-result']);
 
-  handlerHttpParmase (event) {
-    const { body = '', headers = {}, method = 'GET', queries = '', path: p = '' } = event;
-
-    let postBody;
-    if (body) {
-      let buff = null;
-      if (Buffer.isBuffer(body)) {
-        buff = body;
-        headers['content-type'] = 'application/octet-stream';
-      } else if (typeof body === 'string') {
-        buff = Buffer.from(body, 'utf8');
-        headers['content-type'] = 'application/octet-stream';
-      } else if (typeof body.pipe === 'function') {
-        buff = body;
-        headers['content-type'] = 'application/octet-stream';
-      } else {
-        buff = Buffer.from(JSON.stringify(body), 'utf8');
-        headers['content-type'] = 'application/json';
+        logger.log(`\nFC Invoke Result[Code: ${resp.code}]:`, 'green');
+        console.log(resp.data);
+        console.log('\n');
       }
-      postBody = buff;
-    }
-
-    if (!headers['X-Fc-Log-Type']) {
-      headers['X-Fc-Log-Type'] = 'Tail';
-    }
-
-    return {
-      headers,
-      queries,
-      method,
-      path: p,
-      body: postBody
     }
   }
 
@@ -203,4 +186,4 @@ export default class RemoteInvoke {
       throw new Error('handler event error. Example: https://github.com/devsapp/fc-remote-invoke/blob/master/example/http.json');
     }
   }
-}
+}

tsconfig.json

@@ -24,7 +24,7 @@
       "./node_modules/@types"
     ],
     "rootDir": "src",
-    "outDir": "lib"
+    "outDir": "dist"
   },
   "exclude": [
     "**/node_modules/**",