0

0

使用 TypeScript 构建可测试的 CloudFront 函数

花韻仙語

花韻仙語

发布时间:2024-11-24 08:18:45

|

3250人浏览过

|

来源于dev.to

转载

使用 typescript 构建可测试的 cloudfront 函数

aws cloudfront functions 是一个强大的工具,用于在边缘运行轻量级 javascript 代码,允许您操作请求和响应。

但是,aws 要求这些函数用 vanilla javascript 编写,这对于喜欢 typescript 类型安全和现代语法的开发人员来说可能会受到限制。

在本文中,我将引导您完成在 typescript 中编写 cloudfront 函数、导入其他文件并有效测试它们的解决方案。

挑战

cloudfront functions 必须使用 es5 javascript 编写,缺乏 typescript 的现代功能和类型安全性。对于想要利用 typescript 的优势同时仍部署到 cloudfront 的开发人员来说,这一要求提出了挑战。

解决方案

解决方案涉及使用 typescript 编写 cloudfront 函数,然后将其转换为 es5 javascript。这种方法允许您在开发和测试过程中保持 typescript 的优势,同时仍然满足 aws 的部署要求。

关键部件

typescript 编译器选项:

  1. 配置 typescript 编译器以 es5 为目标并删除模块语法,因为 cloudfront 的 javascript 环境不支持所有 commonjs 运行时模块。
  2. 自定义转换器:使用自定义 typescript 转换器删除导出关键字和 __esmodule 属性,确保输出与 cloudfront 兼容。
  3. 构建脚本:创建一个构建脚本以将 typescript 文件转换为 javascript,应用自定义转换器。
  4. 测试:使用 jest 等测试框架为 typescript 代码编写单元测试,确保部署前逻辑正确。

执行

下面是如何为 cloudfront functions 设置 typescript 项目的简化示例:

typescript 配置 (tsconfig.json)

成新网络商城购物系统
成新网络商城购物系统

使用模板与程序分离的方式构建,依靠专门设计的数据库操作类实现数据库存取,具有专有错误处理模块,通过 Email 实时报告数据库错误,除具有满足购物需要的全部功能外,成新商城购物系统还对购物系统体系做了丰富的扩展,全新设计的搜索功能,自定义成新商城购物系统代码功能代码已经全面优化,杜绝SQL注入漏洞前台测试用户名:admin密码:admin888后台管理员名:admin密码:admin888

下载
{
  "compileroptions": {
    "target": "es5", // must be es5 for cloudfront function support  https://docs.aws.amazon.com/amazoncloudfront/latest/developerguide/functions-javascript-runtime-features.html#writing-functions-javascript-features-core
    "module": "commonjs", // beware cloudfront js environment doesn't contain all commonjs runtime modules    
    "lib": ["es5"],
    "strict": true,
    "removecomments": true
  },
  "include": ["src/**/*"],
  "exclude": ["node_modules"]
}

定制变压器

创建自定义转换器以删除导出关键字:

import * as ts from 'typescript';

export const removeexporttransformer: ts.transformerfactory = (context) => {
  return (sourcefile) => {
    const visitor: ts.visitor = (node) => {
      if (ts.ismodifier(node) && node.kind === ts.syntaxkind.exportkeyword) {
        return undefined;
      }
      return ts.visiteachchild(node, visitor, context);
    };
    return ts.visitnode(sourcefile, visitor);
  };
};

构建脚本

用于转译 typescript 文件的脚本:

import * as ts from 'typescript';
import * as fs from 'fs';
import * as path from 'path';
import { removeexporttransformer } from './removeexporttransformer';

const compileroptions: ts.compileroptions = {
  module: ts.modulekind.none,
  target: ts.scripttarget.es5,
  strict: true,
  removecomments: true,
  lib: ['es5'],
};

function transpilefile(filepath: string) {
  const source = fs.readfilesync(filepath, 'utf-8');
  const result = ts.transpilemodule(source, {
    compileroptions,
    transformers: { before: [removeexporttransformer] },
  });
  const outputfilepath = filepath.replace('.ts', '.js');
  fs.writefilesync(outputfilepath, result.outputtext);
}

const files = fs.readdirsync('./src').filter(file => file.endswith('.ts'));
files.foreach(file => transpilefile(path.join('./src', file)));

用法

  1. 在部署之前构建您的 cloudfront typescript 函数:
    ts-node 脚本/build-cloudfront.ts

  2. 定义函数构建输出的路径:

const function= new aws_cloudfront.function(stack, 'cloudfrontfunctionid', {
  functionname: 'cloudfront_function',
  code: aws_cloudfront.functioncode.fromfile({
    filepath: `dist/cloudfrontfunction.js`,
  }),
  runtime: aws_cloudfront.functionruntime.js_2_0,
})

使用 jest 进行测试

设置 jest 来测试您的 typescript 代码:

module.exports = {
  testEnvironment: 'node',
  transform: {
    '^.+\\.tsx?$': 'ts-jest',
  },
  testMatch: ['**/__tests__/**/*.ts'],
};

结论

通过利用 typescript 和自定义转换器,您可以编写、测试和部署具有现代 javascript 功能和类型安全优势的 cloudfront functions。这种方法不仅可以增强您的开发体验,还可以确保您的代码健壮且可维护。

完整的工作代码示例您可以在我的 github 上找到

致谢

特别感谢 typescript-remove-exports 包的作者,它启发了此解决方案中使用的自定义转换器方法。他们的工作为调整 typescript 代码以满足 cloudfront 的要求奠定了基础。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
json数据格式
json数据格式

JSON是一种轻量级的数据交换格式。本专题为大家带来json数据格式相关文章,帮助大家解决问题。

419

2023.08.07

json是什么
json是什么

JSON是一种轻量级的数据交换格式,具有简洁、易读、跨平台和语言的特点,JSON数据是通过键值对的方式进行组织,其中键是字符串,值可以是字符串、数值、布尔值、数组、对象或者null,在Web开发、数据交换和配置文件等方面得到广泛应用。本专题为大家提供json相关的文章、下载、课程内容,供大家免费下载体验。

535

2023.08.23

jquery怎么操作json
jquery怎么操作json

操作的方法有:1、“$.parseJSON(jsonString)”2、“$.getJSON(url, data, success)”;3、“$.each(obj, callback)”;4、“$.ajax()”。更多jquery怎么操作json的详细内容,可以访问本专题下面的文章。

311

2023.10.13

go语言处理json数据方法
go语言处理json数据方法

本专题整合了go语言中处理json数据方法,阅读专题下面的文章了解更多详细内容。

77

2025.09.10

github中文官网入口 github中文版官网网页进入
github中文官网入口 github中文版官网网页进入

github中文官网入口https://docs.github.com/zh/get-started,GitHub 是一种基于云的平台,可在其中存储、共享并与他人一起编写代码。 通过将代码存储在GitHub 上的“存储库”中,你可以: “展示或共享”你的工作。 持续“跟踪和管理”对代码的更改。

993

2026.01.21

java入门学习合集
java入门学习合集

本专题整合了java入门学习指南、初学者项目实战、入门到精通等等内容,阅读专题下面的文章了解更多详细学习方法。

1

2026.01.29

java配置环境变量教程合集
java配置环境变量教程合集

本专题整合了java配置环境变量设置、步骤、安装jdk、避免冲突等等相关内容,阅读专题下面的文章了解更多详细操作。

2

2026.01.29

java成品学习网站推荐大全
java成品学习网站推荐大全

本专题整合了java成品网站、在线成品网站源码、源码入口等等相关内容,阅读专题下面的文章了解更多详细推荐内容。

0

2026.01.29

Java字符串处理使用教程合集
Java字符串处理使用教程合集

本专题整合了Java字符串截取、处理、使用、实战等等教程内容,阅读专题下面的文章了解详细操作教程。

0

2026.01.29

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Git 教程
Git 教程

共21课时 | 3.1万人学习

Git版本控制工具
Git版本控制工具

共8课时 | 1.5万人学习

Git中文开发手册
Git中文开发手册

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号