feat: Add bundling and TS support #576

bboure · 2023-03-09T21:33:40Z

No description provided.

mlafeldt · 2023-03-10T14:18:07Z

src/resources/JsResolver.ts

+      bundle: true,
+      write: false,
+      external: ['@aws-appsync/utils'],
+      format: 'esm',


@bboure Thanks for sharing. Love it! I didn't know getting TS support + bundling was that simple. 🚀

I'm now using something similar in one of my CDK projects. However, I found one case where the resulting JS code didn't work. Here's a simplified version of the resolver:

import { util } from '@aws-appsync/utils' import type { Context } from '@aws-appsync/utils' export function response(ctx: Context) { const { result, error } = ctx if (error) { return util.error(error.message, error.type) } if (result.items.length === 0) { return util.error('user not found') } const user = result.items[0] return { id: user.UserID, slack: { enabled: user.Slack?.Enabled ?? false, webhookUrl: user.Slack?.WebhookURL, channel: user.Slack?.Channel, }, } }

Transpiled to JS with esbuild:

// esbuild --bundle --external:@aws-appsync/utils --format=esm resolvers/getUser.ts import { util } from "@aws-appsync/utils"; function response(ctx) { var _a, _b, _c, _d; const { result, error } = ctx; if (error) { return util.error(error.message, error.type); } if (result.items.length === 0) { return util.error("user not found"); } const user = result.items[0]; return { id: user.UserID, slack: { enabled: (_b = (_a = user.Slack) == null ? void 0 : _a.Enabled) != null ? _b : false, webhookUrl: (_c = user.Slack) == null ? void 0 : _c.WebhookURL, channel: (_d = user.Slack) == null ? void 0 : _d.Channel } }; } export { response };

However, at runtime, the resolver will return ReferenceError: _a is not defined.

I don't know why that is tbh. The fix was to target ES2020, which introduced optional chaining:

// esbuild --bundle --external:@aws-appsync/utils --format=esm --target=es2020 resolvers/getUser.ts import { util } from "@aws-appsync/utils"; function response(ctx) { const { result, error } = ctx; if (error) { return util.error(error.message, error.type); } if (result.items.length === 0) { return util.error("user not found"); } const user = result.items[0]; return { id: user.UserID, slack: { enabled: user.Slack?.Enabled ?? false, webhookUrl: user.Slack?.WebhookURL, channel: user.Slack?.Channel } }; } export { response };

This resolver works just fine.

So you might consider passing target: 'es2020' too.

Thanks!
That's super useful! I definitely need to investigate more and do more testing.
In my research, I noticed I needed at least to target es2018. For some reason, I omitted this here.

Scott-Allen-Mind-Gyn · 2023-04-18T11:40:51Z

This is super cool, I'm trying to avoid having 2 separate build process for building the pipelineFunctions. Serverless (with the right config) will transpile our TS resolvers (i.e our custom authorizer in the general "functions" section of serverless config) but not the typescript functions within appSync pipelineFunctions section.

If there's anything I can do to help with this PR rather than going down my own path please share.

bboure · 2023-06-29T09:34:20Z

I took some time to polish this PR based on the official doc guidelines.

If anyone is interested in testing this before we ship it 🚀, it would be much appreciated.

clone this repo, then

npm install
git checkout add-typescript-support
npm run build
npm link

in your project's folder

npm link serverless-appsync-plugin

ebisbe · 2023-06-30T13:17:11Z

I can test it.

ebisbe

The CloudFormation Resource to generate the appsync definition is in that PR? I don't see the code.
Also the ctx.indentity.claims is not properly defined. I see that ctx.identity is from the type Identity and that is an OR of different types which one is AppSyncIdentityOIDC that includes the claims but it says it's missing.

ebisbe · 2023-07-04T09:35:39Z

doc/general-config.md

+
+## Esbuild
+
+By default, this plugin uses esbuild in order to bundle Javascript resolvers. TypeSCript fiels are also transpiled into compatible JavaScript. This option allows you to pass custom options that must be passed to the esbuild command.


Typo: TypeSCript fiels => TypeScript fields

ebisbe · 2023-07-04T10:37:18Z

Also I think that the checkout of this branch has to be done before running npm install otherwise esbuild is missing.

git checkout add-typescript-support
npm install
npm run build
npm link

And had to remove / upgrade some packages that are not up to date with TS 5. So if the code is TS 4 compatible then our live will be easier.

bboure · 2023-07-04T14:11:32Z

@ebisbe

The CloudFormation Resource to generate the appsync definition is in that PR? I don't see the code.
Also the ctx.indentity.claims is not properly defined. I see that ctx.identity is from the type Identity and that is an OR of different types which one is AppSyncIdentityOIDC that includes the claims but it says it's missing

Not sure I understood the question. This PR is changing the following:

take the code js file path and pass it through esbuild in order to bundle it.
transpile TypeScript code to valid APPSYNC_JS

I think you are referring to the Context type that you can include from @aws-appsync/utils. This does not live in this PR. It's another packagel. Unfortunately it's not open source and I do not have hand on it. Maybe @onlybakam can help.

ebisbe · 2023-07-05T14:04:17Z

ok, sorry as I didn't explain me well enough. I meant having types for the appsync configuration defined in this package. It's pretty complex and can get complex. So having types to define the configuration would be really good. It's probably for a different PR reading all the context of this one.

bboure · 2023-07-05T14:41:03Z

@ebisbe this should do the trick, and it makes sense to add it in this PR.

import type { AppSyncConfig } from 'serverless-appsync-plugin';

lmk if this works

ebisbe · 2023-07-06T10:49:05Z

It works but some parts are missing. All this issues come from my configuration that is currently working so it should be valid.

Appsync.schema: type should be string | string[] it's string[]
Appsync.dataSource.name: Should be optional.
PipelineFunctionConfig.name should be optional.
BaseResolverConfig.field should be optional.
BaseResolverConfig.type should be optional.
PipelineResolverConfig.functions should accept also a pipelineFunctionConfig object functions: string[] | PipelineFunctionConfig[]; Edit: I think it should allow mixing both. Not sure how would be the resulting type.
Conditional ( and others ) CF operations should be accepted. I have this:

PaddleHttpDataSource: {
      type: "HTTP",
      config: {
        endpoint: {
          "Fn::If": ["IsProd", "https://vendors.paddle.com", "https://sandbox-vendors.paddle.com"],
        },
      },
    },

That's all I found but looking awesome!

ebisbe · 2023-10-04T10:16:30Z

For me the esbuild configuration is not working. The bundle resolver ends up like: import{runtime as U,util as D}from\"@aws-appsync/utils\";

ebisbe · 2023-10-04T11:22:55Z

src/resources/JsResolver.ts

+      sourcemap: 'inline',
+      treeShaking: true,
+      minifyWhitespace: true,
+      minifyIdentifiers: true,


Suggested change

minifyIdentifiers: true,

minifyIdentifiers: false,

Otherwise it converts: import{runtime}from\"@aws-appsync/utils\"; into import{runtime as $}from\"@aws-appsync/utils\";

Do you have a way to reproduce this?

In my case it is transpiled to

import{util as e,runtime as r}from\"@aws-appsync/utils\";

(from this)

import { Context, DynamoDBGetItemRequest, util, runtime, } from '@aws-appsync/utils';

and it's working as expected at runtime.

Sorry. You are right. I had other issues that the eslint appsync configuration was not caching and I thought it was that.

OK, it seems like this sometimes causes issues after all.

Someone recently asked me for help with an issue on AppSync, using esbuild.
He hit an Runtime error without any explanation from AppSync.

After some debugging, we figured out he used the --minify-identifiers option with esbuild which was renaming a variable to _.

That variable was then passed into a custom function as an argument.
For some reason, AppSync does not like that.

Debugging in the appsync code evaluator gives this error:

Lexical error, Encountered: "_" (95), after : "." at *unset*[line 1, column 876]

example code

const { foo: _ } = ctx.args; const r = test(_)

It sounds like a rare use case but we might need to consider removing any minification for now (minifyWhitespace might be safe to keep though) to avoid any issue.

The official AppSync doc does not include modification in their guides.

we can leave it as opt-in though thought the esbuild config.
We could even consider allowing different esbuild options per resolver/funciton to allow fine-tuning each one and work around those kind of issues when they are found

I'm not sure minifying make sense anyway. Is there a limit on each function size? Otherwise I would rather be able to read the whole request/response in case I need what has been deployed

There is a limit.
4kb for inline code (which is what this plugin does at the moment), or 10kb if uploaded to S3.

I've had feedback of people hitting the 4kb limit 😄

github-actions · 2023-11-09T09:05:40Z

🎉 This PR is included in version 2.5.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Add bundling and TS support

2fd0b26

mlafeldt reviewed Mar 10, 2023

View reviewed changes

target es2020

0abc535

This was referenced Mar 12, 2023

RFC: JavaScript Resolvers in AWS AppSync aws/aws-appsync-community#147

Closed

Javascript runtime resolver bundling #577

Open

bboure added 3 commits June 29, 2023 07:50

Merge remote-tracking branch 'origin/master' into add-typescript-support

12904a8

improvements

eee7f00

fix

b73a965

ebisbe reviewed Jul 4, 2023

View reviewed changes

Merge remote-tracking branch 'origin/master' into add-typescript-support

bb8ae10

export types

965e2f4

ebisbe reviewed Oct 4, 2023

View reviewed changes

bboure added 7 commits October 12, 2023 08:04

Merge remote-tracking branch 'origin/master' into add-typescript-support

5a27124

fixes

ad4de74

Fixes

0f03ca1

fix

a61a85c

improve doc

afef04a

promote GraphBolt 🙂

03f73b2

Do not minify

d268daa

bboure merged commit 4c9c66f into master Nov 9, 2023
2 checks passed

bboure deleted the add-typescript-support branch November 9, 2023 09:04

github-actions bot added the released label Nov 9, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add bundling and TS support #576

feat: Add bundling and TS support #576

bboure commented Mar 9, 2023

mlafeldt Mar 10, 2023

bboure Mar 10, 2023

Scott-Allen-Mind-Gyn commented Apr 18, 2023

bboure commented Jun 29, 2023

ebisbe commented Jun 30, 2023

ebisbe left a comment

ebisbe Jul 4, 2023

ebisbe commented Jul 4, 2023

bboure commented Jul 4, 2023

ebisbe commented Jul 5, 2023

bboure commented Jul 5, 2023

ebisbe commented Jul 6, 2023 •

edited

Loading

ebisbe commented Oct 4, 2023

ebisbe Oct 4, 2023

bboure Oct 13, 2023

ebisbe Oct 13, 2023

bboure Oct 31, 2023

bboure Oct 31, 2023

ebisbe Oct 31, 2023

bboure Oct 31, 2023

github-actions bot commented Nov 9, 2023


		## Esbuild

		By default, this plugin uses esbuild in order to bundle Javascript resolvers. TypeSCript fiels are also transpiled into compatible JavaScript. This option allows you to pass custom options that must be passed to the esbuild command.

feat: Add bundling and TS support #576

feat: Add bundling and TS support #576

Conversation

bboure commented Mar 9, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Scott-Allen-Mind-Gyn commented Apr 18, 2023

bboure commented Jun 29, 2023

ebisbe commented Jun 30, 2023

ebisbe left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ebisbe commented Jul 4, 2023

bboure commented Jul 4, 2023

ebisbe commented Jul 5, 2023

bboure commented Jul 5, 2023

ebisbe commented Jul 6, 2023 • edited Loading

ebisbe commented Oct 4, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Nov 9, 2023

ebisbe commented Jul 6, 2023 •

edited

Loading