@geek-fun/serverlessinsight 0.4.0 → 0.5.0

package/samples/README_TENCENT_SCF.md

@@ -0,0 +1,272 @@
+# Tencent Cloud SCF (Serverless Cloud Function) Support
+
+This guide demonstrates how to use ServerlessInsight with Tencent Cloud SCF using the new state-based deployment engine.
+
+## Overview
+
+The Tencent SCF support introduces a Terraform-like infrastructure management approach with:
+
+- **State Management**: Local state tracking in `.serverlessinsight/state.json`
+- **Plan & Apply Flow**: Preview changes before applying them
+- **Drift Detection**: Detect manual changes made outside ServerlessInsight
+- **Idempotent Operations**: Safe to re-run deployments
+
+## Prerequisites
+
+1. Tencent Cloud account with API credentials
+2. ServerlessInsight CLI installed
+3. Function code packaged as a ZIP file
+
+## Configuration
+
+Create a `serverless-insight.yml` file:
+
+```yaml
+version: 0.0.1
+provider:
+  name: tencent
+  region: ap-guangzhou
+
+vars:
+  handler: index.handler
+
+stages:
+  default:
+    node_env: default
+  dev:
+    node_env: development
+  prod:
+    node_env: production
+
+service: my-service
+
+functions:
+  my_function:
+    name: my-function-name
+    code:
+      runtime: Nodejs18.15
+      handler: index.handler
+      path: path/to/function.zip
+    memory: 512
+    timeout: 10
+    environment:
+      NODE_ENV: ${stages.node_env}
+      API_KEY: your-api-key
+```
+
+## Supported Runtimes
+
+- Nodejs18.15
+- Nodejs16.13
+- Python3.7
+- Python3.9
+- And other Tencent SCF supported runtimes
+
+## Commands
+
+### Plan
+
+Preview changes before deployment:
+
+```bash
+si plan my-stack \
+  -f serverless-insight.yml \
+  -r ap-guangzhou \
+  -k YOUR_SECRET_ID \
+  -x YOUR_SECRET_KEY
+```
+
+Output shows:
+
+- Resources to be **created** (green `+`)
+- Resources to be **updated** (yellow `~`)
+- Resources to be **deleted** (red `-`)
+- Resources with **no changes** (blue `=`)
+
+### Deploy
+
+Apply the infrastructure changes:
+
+```bash
+si deploy my-stack \
+  -f serverless-insight.yml \
+  -r ap-guangzhou \
+  -k YOUR_SECRET_ID \
+  -x YOUR_SECRET_KEY
+```
+
+The deploy command will:
+
+1. Generate a plan
+2. Execute the plan (create/update/delete functions)
+3. Save the state to `.serverlessinsight/state.json`
+
+### Validate
+
+Validate your YAML configuration:
+
+```bash
+si validate my-stack -f serverless-insight.yml
+```
+
+## State Management
+
+State is stored locally in `.serverlessinsight/state.json`:
+
+```json
+{
+  "version": "0.1",
+  "provider": "tencent",
+  "resources": {
+    "functions.my_function": {
+      "type": "SCF",
+      "physicalId": "my-function-name",
+      "region": "ap-guangzhou",
+      "configHash": "abc123...",
+      "lastUpdated": "2025-01-01T12:00:00Z"
+    }
+  }
+}
+```
+
+**Important**: Add `.serverlessinsight/` to your `.gitignore` if you don't want to commit state files.
+
+## Idempotency
+
+Running `si deploy` multiple times with the same configuration is safe:
+
+```bash
+# First run - creates the function
+si deploy my-stack -f serverless-insight.yml
+
+# Second run - detects no changes needed
+si deploy my-stack -f serverless-insight.yml
+```
+
+## Drift Detection
+
+If someone modifies the function in Tencent Cloud Console, the plan command will detect the drift:
+
+```bash
+si plan my-stack -f serverless-insight.yml
+```
+
+Output will show:
+
+```
+[UPDATE] Resources to be updated:
+  ~ functions.my_function (SCF)
+    [DRIFTED] Remote configuration differs from state
+```
+
+## Environment Variables
+
+Use stages to manage different environments:
+
+```yaml
+stages:
+  default:
+    node_env: default
+    api_url: https://api.example.com
+  dev:
+    node_env: development
+    api_url: https://dev.api.example.com
+  prod:
+    node_env: production
+    api_url: https://api.example.com
+
+functions:
+  my_function:
+    environment:
+      NODE_ENV: ${stages.node_env}
+      API_URL: ${stages.api_url}
+```
+
+Deploy to different stages:
+
+```bash
+# Deploy to dev
+si deploy my-stack -f serverless-insight.yml --stage dev
+
+# Deploy to prod
+si deploy my-stack -f serverless-insight.yml --stage prod
+```
+
+## Function Configuration
+
+### Memory
+
+Set function memory (in MB):
+
+```yaml
+functions:
+  my_function:
+    memory: 512 # 128-3072 MB
+```
+
+### Timeout
+
+Set function timeout (in seconds):
+
+```yaml
+functions:
+  my_function:
+    timeout: 10 # 1-900 seconds
+```
+
+### Handler
+
+Specify the entry point:
+
+```yaml
+functions:
+  my_function:
+    code:
+      handler: index.handler # <file>.<function>
+```
+
+## Examples
+
+See `samples/tencent-poc-scf.yml` for a complete example.
+
+## Troubleshooting
+
+### Authentication Errors
+
+Ensure your Secret ID and Secret Key are correct:
+
+```bash
+export TENCENTCLOUD_SECRET_ID=your_secret_id
+export TENCENTCLOUD_SECRET_KEY=your_secret_key
+
+si deploy my-stack -f serverless-insight.yml
+```
+
+### Function Not Found
+
+If you see "ResourceNotFound.FunctionName", the function doesn't exist yet. Run `si deploy` to create it.
+
+### State File Conflicts
+
+If you encounter state conflicts, you can:
+
+1. Delete `.serverlessinsight/state.json` and re-deploy (will recreate resources)
+2. Manually edit the state file (advanced users only)
+
+## Limitations
+
+Current limitations:
+
+- No support for VPC configuration
+- No support for triggers (API Gateway, COS, etc.)
+- No support for layers
+- No remote state backends
+- No cross-resource dependencies
+
+These features will be added in future releases.
+
+## Next Steps
+
+1. Try the example: `samples/tencent-poc-scf.yml`
+2. Read the [main documentation](../README.md)
+3. Explore other cloud providers (Aliyun, Huawei)

package/samples/aliyun-poc-api.yml

@@ -46,4 +46,4 @@ events:
         path: /api/hello
         backend: ${functions.insight_poc_fn}
     domain:
-      domain_name: insight-api.serverlessinsight.com
+      domain_name: insight-api.serverlessinsights.com

package/samples/aliyun-poc-bucket.yml

@@ -4,7 +4,6 @@ provider:
   name: aliyun
   region: cn-chengdu
 
-
 service: insight-bucket-poc
 
 tags:

package/samples/aliyun-poc-domain.yml

@@ -4,7 +4,6 @@ provider:
   name: aliyun
   region: cn-hongkong
 
-
 service: insight-poc-domain
 
 tags:

package/samples/aliyun-poc-es.yml

@@ -2,8 +2,7 @@ version: 0.0.1
 
 provider:
   name: aliyun
-  region: cn-chengdu
-
+  region: cn-hangzhou
 
 service: insight-db-poc
 
@@ -11,20 +10,22 @@ tags:
   owner: geek-fun
 
 databases:
-  #  insight_es_db:
-  #    name: insight-poc-es
-  #    type: ELASTICSEARCH_SERVERLESS
-  #    version: '7.10'
-  #    engine_mode: SEARCH
-  #    cu: 1
-  #    storage_size: 20
-  #    security:
-  #      basic_auth:
-  #        password: 'U34I6InQ8elseTgqTWT2t2oFXpoqFg'
-  insight_poc_db:
+  insight_poc_es:
+    name: insight-poc-es
+    type: ELASTICSEARCH_SERVERLESS
+    version: ES_SEARCH_7.10
+    cu:
+      min: 3
+      max: 4
+    security:
+      basic_auth:
+        master_user: admin
+        password: 'U34I6InQ8elseTgqTWT2t2oFXpoqFg'
+  insight_poc_rds:
     name: insight-poc-rds
     type: RDS_PGSQL_SERVERLESS
     version: PGSQL_16
     security:
       basic_auth:
+        master_user: admin
         password: 'U34I6InQ8elseTgqTWT2t2oFXpoqFg'

package/samples/aliyun-poc-rds.yml

@@ -4,7 +4,6 @@ provider:
   name: aliyun
   region: cn-chengdu
 
-
 service: insight-rds-poc
 
 tags:
@@ -21,4 +20,3 @@ databases:
         password: 'U34I6InQ8elseTgqTWT2t2oFXpoqFg'
     network:
       type: 'PRIVATE'
-

package/samples/aliyun-poc-table.yml

@@ -4,7 +4,6 @@ provider:
   name: aliyun
   region: cn-hangzhou
 
-
 service: insight-table-poc
 
 tags:
@@ -18,7 +17,7 @@ tables:
     type: TABLE_STORE_H
     network:
       type: 'PRIVATE'
-      vpc_id: "vpc-12345678"
+      vpc_id: 'vpc-12345678'
       ingress_rules:
         - TCP:0.0.0.0/0:80
         - TCP:0.0.0.0/0:443
@@ -45,4 +44,3 @@ tables:
         type: DOUBLE
       - name: active
         type: BOOLEAN
-

package/samples/tencent-poc-cos.yml

@@ -0,0 +1,20 @@
+version: 0.0.1
+provider:
+  name: tencent
+  region: ap-guangzhou
+
+service: insight-poc-cos
+
+tags:
+  owner: geek-fun
+
+buckets:
+  insight_poc_cos_bucket:
+    name: insight-poc-cos-bucket-1234567890 # Must be globally unique
+    security:
+      acl: PUBLIC_READ # PRIVATE, PUBLIC_READ, or PUBLIC_READ_WRITE
+    website:
+      code: dist
+      index: index.html
+      error_page: 404.html
+      error_code: 404

package/samples/tencent-poc-scf.yml

@@ -0,0 +1,36 @@
+version: 0.0.1
+provider:
+  name: tencent
+  region: ap-guangzhou
+
+vars:
+  testv: testVarValue
+  handler: index.handler
+
+stages:
+  default:
+    node_env: default
+  dev:
+    node_env: development
+    memory: 512
+  prod:
+    node_env: production
+    memory: 1024
+
+service: insight-poc-scf
+
+tags:
+  owner: geek-fun
+
+functions:
+  insight_poc_fn:
+    name: insight-poc-api-fn
+    code:
+      runtime: nodejs18
+      handler: index.handler
+      path: artifacts/scf_code.zip
+    memory: ${stages.memory}
+    timeout: 10
+    environment:
+      NODE_ENV: ${stages.node_env}
+      TEST_VAR: ${vars.testv}

package/dist/src/commands/index.d.ts

@@ -1,2 +0,0 @@
-#! /usr/bin/env node
-export {};

package/dist/src/common/index.d.ts

@@ -1,11 +0,0 @@
-export * from './providerEnum';
-export * from './logger';
-export * from './getVersion';
-export * from './rosClient';
-export * from './context';
-export * from './iacHelper';
-export * from './constants';
-export * from './imsClient';
-export * from './base64';
-export * from './rosAssets';
-export * from './requestHelper';

package/dist/src/common/rosAssets.js

@@ -1,178 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
-    Object.defineProperty(o, "default", { enumerable: true, value: v });
-}) : function(o, v) {
-    o["default"] = v;
-});
-var __importStar = (this && this.__importStar) || (function () {
-    var ownKeys = function(o) {
-        ownKeys = Object.getOwnPropertyNames || function (o) {
-            var ar = [];
-            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
-            return ar;
-        };
-        return ownKeys(o);
-    };
-    return function (mod) {
-        if (mod && mod.__esModule) return mod;
-        var result = {};
-        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
-        __setModuleDefault(result, mod);
-        return result;
-    };
-})();
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.cleanupAssets = exports.publishAssets = exports.constructAssets = exports.getAssets = void 0;
-const node_fs_1 = __importDefault(require("node:fs"));
-const ossDeployment = __importStar(require("@alicloud/ros-cdk-ossdeployment"));
-const node_path_1 = __importDefault(require("node:path"));
-const jszip_1 = __importDefault(require("jszip"));
-const logger_1 = require("./logger");
-const lodash_1 = require("lodash");
-const ali_oss_1 = __importDefault(require("ali-oss"));
-const context_1 = require("./context");
-const buildAssets = (rootPath, relativePath) => {
-    const location = node_path_1.default.resolve(rootPath, relativePath);
-    if (!node_fs_1.default.existsSync(location)) {
-        throw new Error(`Location: ${location} is not exists!`);
-    }
-    if (node_fs_1.default.lstatSync(location).isFile()) {
-        return [
-            ossDeployment.Source.asset(location, {}, relativePath.substring(0, relativePath.lastIndexOf('/') + 1)),
-        ];
-    }
-    return node_fs_1.default
-        .readdirSync(location)
-        .map((file) => buildAssets(rootPath, `${relativePath}/${file}`.replace(/^\//, '')))
-        .flat();
-};
-const getAssets = (location) => {
-    return buildAssets(location, '');
-};
-exports.getAssets = getAssets;
-const assembleFiles = (folder, zip) => {
-    const files = node_fs_1.default.readdirSync(folder);
-    files.forEach((file) => {
-        const filePath = node_path_1.default.join(folder, file);
-        if (node_fs_1.default.lstatSync(filePath).isFile()) {
-            const content = node_fs_1.default.readFileSync(filePath);
-            zip.file(file, content);
-        }
-        else {
-            const subZip = zip.folder(file);
-            if (subZip) {
-                assembleFiles(filePath, subZip);
-            }
-        }
-    });
-};
-const zipAssets = async (assetsPath) => {
-    const zip = new jszip_1.default();
-    assembleFiles(assetsPath, zip);
-    const zipPath = `${assetsPath.replace(/\/$/, '').trim()}.zip`;
-    await zip
-        .generateAsync({ type: 'nodebuffer' })
-        .then((content) => {
-        node_fs_1.default.writeFileSync(zipPath, content);
-        logger_1.logger.info(`Folder compressed to: ${zipPath}`);
-    })
-        .catch((e) => {
-        logger_1.logger.error(`Failed to compress folder: ${e}`);
-        throw e;
-    });
-    return zipPath;
-};
-const constructAssets = async ({ files, rootPath, }) => {
-    const { region } = (0, context_1.getContext)();
-    const assets = await Promise.all(Object.entries(files)
-        .filter(([, fileItem]) => !fileItem.source.path.endsWith('.template.json'))
-        .map(async ([, fileItem]) => {
-        let sourcePath = `${rootPath}/${fileItem.source.path}`;
-        if (fileItem.source.packaging === 'zip') {
-            sourcePath = await zipAssets(`${rootPath}/${fileItem.source.path}`);
-        }
-        return {
-            bucketName: (0, lodash_1.get)(fileItem, 'destinations.current_account-current_region.bucketName', '').replace('${ALIYUN::Region}', region),
-            source: sourcePath,
-            objectKey: (0, lodash_1.get)(fileItem, 'destinations.current_account-current_region.objectKey'),
-        };
-    }));
-    return !(0, lodash_1.isEmpty)(assets) ? assets : undefined;
-};
-exports.constructAssets = constructAssets;
-const ensureBucketExits = async (bucketName, ossClient) => await ossClient.getBucketInfo(bucketName).catch((err) => {
-    if (err.code === 'NoSuchBucket') {
-        logger_1.logger.info(`Bucket: ${bucketName} not exists, creating...`);
-        return ossClient.putBucket(bucketName, {
-            storageClass: 'Standard',
-            acl: 'private',
-            dataRedundancyType: 'LRS',
-        });
-    }
-    else {
-        throw err;
-    }
-});
-const publishAssets = async (assets) => {
-    if (!assets?.length) {
-        logger_1.logger.info('No assets to publish, skipped!');
-        return;
-    }
-    const context = (0, context_1.getContext)();
-    const bucketName = assets[0].bucketName;
-    const client = new ali_oss_1.default({
-        region: `oss-${context.region}`,
-        accessKeyId: context.accessKeyId,
-        accessKeySecret: context.accessKeySecret,
-        bucket: bucketName,
-        timeout: 600000, // 10 minutes
-    });
-    await ensureBucketExits(bucketName, client);
-    const headers = {
-        'x-oss-storage-class': 'Standard',
-        'x-oss-object-acl': 'default',
-        'x-oss-forbid-overwrite': 'false',
-    };
-    await Promise.all(assets.map(async ({ source, objectKey }) => {
-        await client.put(objectKey, node_path_1.default.normalize(source), { headers });
-        logger_1.logger.debug(`Upload file: ${source} to bucket: ${bucketName} successfully!`);
-    }));
-    return bucketName;
-};
-exports.publishAssets = publishAssets;
-const cleanupAssets = async (assets) => {
-    if (!assets?.length) {
-        logger_1.logger.info('No assets to cleanup, skipped!');
-        return;
-    }
-    const context = (0, context_1.getContext)();
-    const bucketName = assets[0].bucketName;
-    const client = new ali_oss_1.default({
-        region: `oss-${context.region}`,
-        accessKeyId: context.accessKeyId,
-        accessKeySecret: context.accessKeySecret,
-        bucket: bucketName,
-    });
-    await Promise.all(assets.map(async ({ objectKey }) => {
-        await client.delete(objectKey);
-        logger_1.logger.debug(`Cleanup file: ${objectKey} from bucket: ${bucketName} successfully!`);
-    }));
-    // delete the bucket
-    await client.deleteBucket(bucketName);
-    logger_1.logger.debug(`Cleanup bucket: ${bucketName} successfully!`);
-};
-exports.cleanupAssets = cleanupAssets;