Merge pull request #1 from wangsha/pullrequests/refactoring-setup

allow multiple custom domains

Author: wangsha

.github/workflows/main.yml

@@ -21,6 +21,7 @@ jobs:
         with:
           node-version: 12
       - run: npm install
+      - run: npm run test-unit
       - name:  'Automated Version Bump'
         uses:  'phips28/gh-action-bump-version@master'
         env:

README.md

@@ -24,10 +24,12 @@ plugins:
 
 custom:
   urlDomain:
-    apiDomain: ${env:SUBDOMAIN}.yourdomain.com  # change by your custom domain
+    domains: 
+      - ${env:SUBDOMAIN}.yourdomain.com  # custom domain 1
+      - ${env:SUBDOMAIN}-alt.yourdomain.com  # custom domain 2
     hostedZoneName: yourdomain.com.  # your domain Route 53 hosted zone name
     certificateArn: 'arn:aws:acm:us-east-1:xxxxx:certificate/xxxxx' # need to be located at NVirgina 
-    
+    route53: false # disable route 53 integration
 functions:
   api:
     handler: wsgi_handler.handler

index.js

@@ -2,29 +2,42 @@ const path = require('path');
 const _ = require('lodash');
 const yaml = require('js-yaml');
 const fs = require('fs');
+const Mustache = require('mustache');
 
 class ServerlessAWSFunctionURLCustomDomainPlugin {
   constructor(serverless, options) {
     this.serverless = serverless;
     this.options = options;
 
     this.hooks = {
-      'before:package:createDeploymentArtifacts': this.createDeploymentArtifacts.bind(this),
+      'before:package:finalize': this.createDeploymentArtifacts.bind(this),
       'aws:info:displayStackOutputs': this.printSummary.bind(this),
     };
   }
 
   createDeploymentArtifacts() {
     const baseResources = this.serverless.service.provider.compiledCloudFormationTemplate;
 
-    const filename = path.resolve(__dirname, 'resources.yml');
-    const content = fs.readFileSync(filename, 'utf-8');
-    const resources = yaml.load(content, {
-      filename,
-    });
+    var functionURLResourceName = null;
+    for(var key in baseResources.Resources) {
+      if (baseResources.Resources[key]['Type'] === "AWS::Lambda::Url") {
+        functionURLResourceName = key
+      }
+    }
+
+    if (functionURLResourceName === null) {
+      this.serverless.cli.consoleLog("no function url defined");
+      return baseResources;
+    }
+    
+    const config = this.serverless.service.custom.urlDomain;
+    config['lambdaFunctionUrl'] = functionURLResourceName
+
+    const resources = this.prepareResources(config);
 
-    this.prepareResources(resources);
     const combinedResouces = _.merge(baseResources, resources);
+    console.log(JSON.stringify(combinedResouces));
+
     return combinedResouces;
   }
 
@@ -37,7 +50,7 @@ class ServerlessAWSFunctionURLCustomDomainPlugin {
     }
 
     const { outputs } = awsInfo.gatheredData;
-    const apiDistributionDomain = _.find(outputs, (output) => output.OutputKey === 'ApiCloudFrontDistributionDomain');
+    const apiDistributionDomain = _.find(outputs, (output) => output.OutputKey === 'CloudFrontDistributionDomain');
 
     if (!apiDistributionDomain || !apiDistributionDomain.OutputValue) {
       return;
@@ -46,39 +59,66 @@ class ServerlessAWSFunctionURLCustomDomainPlugin {
     const cnameDomain = this.getConfig('apiDomain', '-');
 
     this.serverless.cli.consoleLog('CloudFront domain name');
-    this.serverless.cli.consoleLog(`  ${apiDistributionDomain.OutputValue} (CNAME: ${cnameDomain})`);
+    this.serverless.cli.consoleLog(`${apiDistributionDomain.OutputValue} (CNAME: ${cnameDomain})`);
   }
 
-  prepareResources(resources) {
-    const distributionConfig = resources.Resources.ApiCloudFrontDistribution.Properties.DistributionConfig;
-    const apiRecordsConfig = resources.Resources.ApiRecordSetGroup.Properties;
-    this.prepareDomain(distributionConfig, apiRecordsConfig);
-    this.prepareAcmCertificateArn(distributionConfig);
-    this.prepareHostedZoneName(apiRecordsConfig);
-  }
-
-  prepareHostedZoneName(apiRecordsConfig) {
-    const name = this.getConfig('hostedZoneName', null);
+  prepareResources(config) {
 
-    apiRecordsConfig.HostedZoneName = name;
+    const route53 = this.getConfig('route53', true);
+    var resources = this.getCloudfrontResources(config);
+    if (route53) {
+      resources = _.merge(resources, this.getRoute53Resources(config));
+    }
+    return resources
   }
 
-  prepareAcmCertificateArn(distributionConfig) {
-    const arn = this.getConfig('certificateArn', null);
-    distributionConfig.ViewerCertificate.AcmCertificateArn = arn;
+  getCloudfrontResources(config) {
+    const filename = path.resolve(__dirname, 'resources.yml');
+    const content = fs.readFileSync(filename, 'utf-8');
+    const resources = yaml.load(content, {
+      filename,
+    });
+    var output = Mustache.render(JSON.stringify(resources), config);
+    output = JSON.parse(output)
+    output['Resources']['CloudFrontDistribution']['Properties']['DistributionConfig']['Aliases'] = config['domains']
+    return output;
   }
 
-  prepareDomain(distributionConfig, apiRecordsConfig) {
-    const domain = this.getConfig('apiDomain', null);
-
-    if (domain !== null) {
-      const domains = Array.isArray(domain) ? domain : [domain];
-      distributionConfig.Aliases = domains;
-      apiRecordsConfig.RecordSets[0].Name = domains[0];
-      distributionConfig.Comment = `Api distribution for ${domains[0]}`;
-    } else {
-      delete distributionConfig.Aliases;
+  getRoute53Resources(config) {
+    const domains = this.getConfig('domains', null);
+    const hostedZoneName = this.getConfig('hostedZoneName', null);
+
+    const template = JSON.stringify({
+      "Type": "AWS::Route53::RecordSetGroup",
+      "DeletionPolicy": "Delete",
+      "DependsOn": [
+        "CloudFrontDistribution"
+      ],
+      "Properties": {
+        "HostedZoneName": hostedZoneName,
+        "RecordSets": [
+          {
+            "Name": "{{{ domain }}}",
+            "Type": "A",
+            "AliasTarget": {
+              "HostedZoneId": "Z2FDTNDATAQYW2",
+              "DNSName": {
+                "Fn::GetAtt": [
+                  "CloudFrontDistribution",
+                  "DomainName"
+                ]
+              }
+            }
+          }
+        ]
+      }
+    })
+    var resources = {}
+    for (var idx in domains) {
+      var output = Mustache.render(template, {'domain': domains[idx]});
+      resources[`Route53Record${idx}`] = JSON.parse(output);
     }
+    return {'Resources': resources}
   }
 
   getConfig(field, defaultValue) {

index.test.js

@@ -0,0 +1,19 @@
+var assert = require('assert');
+describe('Array', function () {
+  describe('#getCloudfrontResources()', function () {
+    it('domains should be a list', function () {
+      const ServerlessAWSFunctionURLCustomDomainPlugin = require('./index')
+      config = {
+        domains: ['sudomain1.yourdomain.com', 'subdomain2.yourdomain.com'],
+        hostedZoneName: 'yourdomain.com.',
+        certificateArn: 'arn:aws:acm:us-east-1:xxxxx:certificate/xxxxxxx',
+        route53: true
+      }
+      var plugin = new ServerlessAWSFunctionURLCustomDomainPlugin();
+      var resources = plugin.getCloudfrontResources(config);
+      console.log(resources['Resources']['CloudFrontDistribution']['Properties']['DistributionConfig']['Comment'])
+      assert(resources['Resources']['CloudFrontDistribution']['Properties']['DistributionConfig']['Aliases'] == config['domains']);
+
+    });
+  });
+});