Fn::Split support? #38

Activity

1. omar-dulaimi

   changed the title [-]Fn::Join support?[/-] [+]Fn::Split support?[/+] on Apr 7, 2021
2. omar-dulaimi commented on Apr 7, 2021

   

   omar-dulaimi

   on Apr 7, 2021

   Author

   More actions

   Okay, So I ended up doing this:

           vpc: ({
               securityGroupIds: {
                   'Fn::Split': [',', '${env:SECURITY_GROUP_IDS}'],
               },
               subnetIds: {
                   'Fn::Split': [',', '${env:SUBNET_IDS}'],
               },
           } as unknown) as AwsLambdaVpcConfig,
   

   But I get this warning while deploying:

   Serverless: Configuration warning:
   Serverless:   at 'provider.vpc.securityGroupIds': should be array
   Serverless:   at 'provider.vpc.subnetIds': should be array
   
3. fredericbarthelet

   added

   enhancementNew feature or requestNew feature or request

   on Apr 8, 2021
4. fredericbarthelet commented on Apr 8, 2021

   

   fredericbarthelet

   on Apr 8, 2021

   Contributor

   More actions

   Hi @omar-dulaimi and thanks for reporting your issue.
   This repository aims to contains only TypeScript definitions compiled from Serverless core framework internal validation logic.
   If you ignore the TS error showing that using Fn::Split is not a valid property for securityGroupIds, you'd still have the framework complaining about it (hence the warning you got on your second try).

   I opened a PR aiming at allowing such use of Fn::Split, but I'm not sure wether additional development should be done in https://github.com/serverless/serverless/blob/dac06c8ce644f0d219329474cb83c644ca61d880/lib/plugins/aws/deployFunction.js#L283-L289 and https://github.com/serverless/serverless/blob/dac06c8ce644f0d219329474cb83c644ca61d880/lib/plugins/aws/package/compile/functions.js#L364-L376

   👍React with 👍1Reacted by Omar Dulaimi
5. pveller commented on Apr 9, 2021

   

   pveller

   on Apr 9, 2021

   Last edited by pveller

   More actions

   Not a directly related question but I would appreciate your guidance. Now that type definitions are auto-generated, certain things are much clearer and certain things are not. Please take a look at stream event definition:

   I do this:

         events: [
           {
             stream: {
               arn: {
                 'Fn::GetAtt': ['MyTable', 'StreamArm'],
               },
               batchSize: 1,
             },
           },
         ],
   

   and serverless fails fast on functions.propagate.events[0].stream.arn': should be string with configValidationMode: 'error'. If I turn off configValidationMode, serverless package fails on EventSourceArn.split is not a function. This has been talked about long time ago here serverless/serverless#2365 and later fixed here serverless/serverless#3111.

   The fix was simple - adding an explicit type attribute to the stream event definition. DefinitelyTyped has it (https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/serverless/plugins/aws/provider/awsProvider.d.ts#L408):

       interface Stream {
           arn: string | { [key: string]: any };
           batchSize?: number | string;
           startingPosition?: number | string;
           enabled?: boolean;
           type?: 'dynamodb' | 'kinesis';
       }
   

   but it's lost in auto-generated types:

           {
               stream:
                 | AwsArnString
                 | (
                     | {
                         arn: AwsCfFunction;
                         [k: string]: unknown;
                       }
                     | {
                         arn: AwsArnString;
                         [k: string]: unknown;
                       }
                   );
             }
   

   So my question is - where to submit a PR or an Issue to get back those typed attributes into the generated type definitions? Adding type solved my problem but it would be nice if it was visible on the type def and thus accessible via auto-complete

   Thanks!
6. pgrzesik

   closed this as completedin serverless#9266on Apr 13, 2021