ac360

aj.stuyvenberg

dschep

eahefnawy

pmuens

@serverless/domain

    "test": "echo \"Error: no test specified\" && exit 1",

const { Component } = require('@serverless/core')

    this.context.debug(`Starting Domain component deployment.`)

    this.context.debug(`Validating inputs.`)

    inputs.region = inputs.region || 'us-east-1'

      throw Error(`"domain" is a required input.`)

    // TODO: Check if domain has changed.

    // On domain change, call remove for all previous state.

    const clients = getClients(this.context.credentials.aws)

    this.context.debug(`Formatting domains and identifying cloud services being used.`)

    const subdomains = prepareSubdomains(inputs)

    this.context.debug(`Getting the Hosted Zone ID for the domain ${inputs.domain}.`)

    const domainHostedZoneId = await getDomainHostedZoneId(clients.route53, inputs.domain)

      `Searching for an AWS ACM Certificate based on the domain: ${inputs.domain}.`

    let certificateArn = await getCertificateArnByDomain(clients.acm, inputs.domain)

      this.context.debug(`No existing AWS ACM Certificates found for the domain: ${inputs.domain}.`)

      this.context.debug(`Creating a new AWS ACM Certificate for the domain: ${inputs.domain}.`)

      certificateArn = await createCertificate(clients.acm, inputs.domain)

    this.context.debug(`Checking the status of AWS ACM Certificate.`)

    const certificate = await describeCertificateByArn(clients.acm, certificateArn)

    if (certificate.Status === 'PENDING_VALIDATION') {

      this.context.debug(`AWS ACM Certificate Validation Status is "PENDING_VALIDATION".`)

      this.context.debug(`Validating AWS ACM Certificate via Route53 "DNS" method.`)

        'Your AWS ACM Certificate has been created and is being validated via DNS.  This could take up to 30 minutes since it depends on DNS propagation.  Continuining deployment, but you may have to wait for DNS propagation.'

    if (certificate.Status !== 'ISSUED' && certificate.Status !== 'PENDING_VALIDATION') {

      // TODO: Should we auto-create a new one in this scenario?

        `Your AWS ACM Certificate for the domain "${inputs.domain}" has an unsupported status of: "${certificate.Status}".  Please remove it manually and deploy again.`

    // Setting up domains for different services

    for (const subdomain of subdomains) {

      if (subdomain.type === 'awsS3Website') {

        this.context.debug(`Configuring domain "${subdomain.domain}" for S3 Bucket Website`)

        this.context.debug(`Checking CloudFront distribution for domain "${subdomain.domain}"`)

        let distribution = await getCloudFrontDistributionByDomain(clients.cf, subdomain.domain)

            `CloudFront distribution for domain "${subdomain.domain}" not found. Creating...`

          distribution = await createCloudfrontDistribution(

        } else if (!distribution.origins.includes(`${subdomain.s3BucketName}.s3.amazonaws.com`)) {

          !distribution.origins.includes(`${subdomain.s3BucketName}.s3.amazonaws.com`) ||

          this.context.debug(`Updating distribution "${distribution.url}".`)

          distribution = await updateCloudfrontDistribution(clients.cf, subdomain, distribution.id)

        this.context.debug(`Configuring DNS for distribution "${distribution.url}".`)

        await configureDnsForCloudFrontDistribution(

        this.context.debug(`Invalidating CloudFront distribution ${distribution.url}`)

        await invalidateCloudfrontDistribution(clients.cf, distribution.id)

        this.context.debug(`Using AWS Cloudfront Distribution with URL: "${subdomain.domain}"`)

      } else if (subdomain.type === 'awsApiGateway') {

        // Map APIG domain to API ID and recursively retry

        // if APIG domain need to be created first, or TooManyRequests error is thrown

          this // passing instance for helpful logs during the process

      // TODO: Remove unused domains that are kept in state

    outputs.domains = subdomains.map((subdomain) => {

      if (subdomain.domain.startsWith('www')) {

      return `https://${subdomain.domain}`

      outputs.domains.unshift(`https://${inputs.domain.replace('www.', '')}`)

    this.context.debug(`Starting Domain component removal.`)

    const clients = getClients(this.context.credentials.aws, this.state.region)

    this.context.debug(`Getting the Hosted Zone ID for the domain ${this.state.domain}.`)

    const domainHostedZoneId = await getDomainHostedZoneId(clients.route53, this.state.domain)

    for (const subdomain in this.state.subdomains) {

      const domainState = this.state.subdomains[subdomain]

      if (domainState.type === 'awsS3Website') {

          `Fetching CloudFront distribution info for removal for domain ${domainState.domain}.`

        const distribution = await getCloudFrontDistributionByDomain(clients.cf, domainState.domain)

          this.context.debug(`Removing DNS records for website domain ${domainState.domain}.`)

          await removeWebsiteDomainDnsRecords(

          if (domainState.domain.startsWith('www')) {

            await removeWebsiteDomainDnsRecords(

              domainState.domain.replace('www.', ''), // it'll move on if it doesn't exist

      } else if (domainState.type === 'awsApiGateway') {

          `Fetching API Gateway domain ${domainState.domain} information for removal.`

        const domainRes = await getApiDomainName(clients.apig, domainState.domain)

const { utils } = require('@serverless/core')

 * - Gets AWS SDK clients to use within this Component

const getClients = (credentials, region = 'us-east-1') => {

    region: 'us-east-1' // ACM must be in us-east-1

 * - Formats component domains & identifies cloud services they're using.

  for (const subdomain in inputs.subdomains || {}) {

    domainObj.domain = `${subdomain}.${inputs.domain}`

    if (inputs.subdomains[subdomain].url.includes('s3')) {

      // Get S3 static hosting endpoint of existing bucket to use w/ CloudFront.

      // todo this doesn't work with bucket names with periods

      domainObj.s3BucketName = inputs.subdomains[subdomain].url.replace('http://', '').split('.')[0]

    // Check if referenced Component is using AWS API Gateway...

    if (inputs.subdomains[subdomain].url.includes('execute-api')) {

      domainObj.apiId = inputs.subdomains[subdomain].url.split('.')[0].split('//')[1]

const getOutdatedDomains = (inputs, state) => {

  for (const domain of state.subdomains) {

    if (!inputs.subdomains[domain.domain]) {

 * - Every Domain on Route53 always has a Hosted Zone w/ 2 Record Sets.

 * - These Record Sets are: "Name Servers (NS)" & "Start of Authority (SOA)"

 * - These don't need to be created and SHOULD NOT be modified.

const getDomainHostedZoneId = async (route53, domain) => {

  const hostedZonesRes = await route53.listHostedZonesByName().promise()

  const hostedZone = hostedZonesRes.HostedZones.find(

    // Name has a period at the end, so we're using includes rather than equals

      origins: distribution.Origins.Items.map((origin) => origin.DomainName)

      origins: distribution.Origins.Items.map((origin) => origin.DomainName),

      errorPages: distribution.CustomErrorResponses.Quantity ? true : false

 * Configure DNS records for a distribution domain

const configureDnsForCloudFrontDistribution = async (

              HostedZoneId: 'Z2FDTNDATAQYW2', // this is a constant that you can get from here https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

              EvaluateTargetHealth: false

  if (subdomain.domain.startsWith('www')) {

    dnsRecordParams.ChangeBatch.Changes.push({

        Name: subdomain.domain.replace('www.', ''),

          HostedZoneId: 'Z2FDTNDATAQYW2', // this is a constant that you can get from here https://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region

  return route53.changeResourceRecordSets(dnsRecordParams).promise()

const createCloudfrontDistribution = async (cf, subdomain, certificateArn) => {

      CallerReference: String(Date.now()),

            Id: `S3-${subdomain.s3BucketName}`,

            DomainName: `${subdomain.s3BucketName}.s3.amazonaws.com`,

        TargetOriginId: `S3-${subdomain.s3BucketName}`,

            ResponsePagePath: '/index.html'

        ACMCertificateArn: certificateArn,

        MinimumProtocolVersion: 'TLSv1.1_2016',

    params.DistributionConfig.Aliases.Quantity = 2

    params.DistributionConfig.Aliases.Items.push(`${subdomain.domain.replace('www.', '')}`)

  const res = await cf.createDistribution(params).promise()

const updateCloudfrontDistribution = async (cf, subdomain, distributionId) => {

  // https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/CloudFront.html#updateDistribution-property

  const params = await cf.getDistributionConfig({ Id: distributionId }).promise()

  params.DistributionConfig.CustomErrorResponses = {

  params.DistributionConfig.Origins.Items = [

      Id: `S3-${subdomain.s3BucketName}`,

      DomainName: `${subdomain.s3BucketName}.s3.amazonaws.com`,

  params.DistributionConfig.DefaultCacheBehavior.TargetOriginId = `S3-${subdomain.s3BucketName}`

  const res = await cf.updateDistribution(params).promise()

const invalidateCloudfrontDistribution = async (cf, distributionId) => {

  await cf.createInvalidation(params).promise()

const removeWebsiteDomainDnsRecords = async (

    await route53.changeResourceRecordSets(params).promise()

    if (e.code !== 'InvalidChangeBatch') {

const removeApiDomain = async (apig, domain) => {

  return apig.deleteDomainName(params).promise()

const removeApiDomainDnsRecords = async (

		{
		"name": "@serverless/domain",
		"version": "2.0.7",
		"version": "2.0.8",
		"main": "./serverless.js",
		@@ -5,0 +5,0 @@ "publishConfig": {

		@@ -392,3 +392,4 @@ const aws = require('aws-sdk')
		url: distribution.DomainName,
		origins: distribution.Origins.Items.map((origin) => origin.DomainName)
		origins: distribution.Origins.Items.map((origin) => origin.DomainName),
		errorPages: distribution.CustomErrorResponses.Quantity ? true : false
		}
		@@ -527,4 +528,11 @@ }
		CustomErrorResponses: {
		Quantity: 0,
		Items: []
		Quantity: 1,
		Items: [
		{
		ErrorCode: 404,
		ErrorCachingMinTTL: 300,
		ResponseCode: '200',
		ResponsePagePath: '/index.html'
		}
		]
		},
		@@ -595,2 +603,13 @@ Comment: '',
		// 5. then make our changes
		params.DistributionConfig.CustomErrorResponses = {
		Quantity: 1,
		Items: [
		{
		ErrorCode: 404,
		ErrorCachingMinTTL: 300,
		ResponseCode: '200',
		ResponsePagePath: '/index.html'
		}
		]
		}
		params.DistributionConfig.Origins.Items = [
		@@ -597,0 +616,0 @@ {

		@@ -105,3 +105,6 @@ const { Component } = require('@serverless/core')
		)
		} else if (!distribution.origins.includes(`${subdomain.s3BucketName}.s3.amazonaws.com`)) {
		} else if (
		!distribution.origins.includes(`${subdomain.s3BucketName}.s3.amazonaws.com`) \|\|
		!distribution.errorPages
		) {
		this.context.debug(`Updating distribution "${distribution.url}".`)
		@@ -108,0 +111,0 @@ distribution = await updateCloudfrontDistribution(clients.cf, subdomain, distribution.id)

Improved metrics