Arcade Party for Amazon Alexa - NodeJS

This is a basic port of Arcade Party, an Alexa skill that streams Andy Hofle's Arcade Ambience project files from archive.org.

I originally wrote Arcade Party in Python with Flask-Ask, using Redis to save user/session state, and it's hosted on an EC2 server running Apache and Python WSGI. It was a quick turnaround project to get familiar with Alexa skill development before I wrote the more complicated Radio Fun Time. It turned out to be much more popular than Radio Fun Time.

The project I'm sharing in this tutorial is a quick, initial prototype for an Arcade Party clone using NodeJS, hosted on AWS Lambda with DynamoDB to save user/session state. As this is a quick prototype, it's missing some features (like explicitly choosing a track by year--you instead navigate using Next and Previous), while it inherits other features from the Amazon Alexa NodeJS Audio Player Sample I adapted it from, like looping and shuffle. These are initial steps towards porting something more complicated and my intention with this tutorial is to share the code and tutorial so that anyone can get a simple audioplayer skill for Alexa up and running quickly so that they can concentrate on their skill logic vs. deployment.

What follows is a complete walkthrough of Alexa skill deployment using the ASK and AWS command line interface. We don't use the browser at all, unless you count authentication pop-ups when you configure your ASK and AWS client credentials---so, conceivably, a daring person could script the entire deployment!

• Prerequisites
• Create ASK and AWS User Profiles
• Prepare the skill infrastructure
• Configure DynamoDB access
• Customize your skill
• Clean up unused resources
• Testing
• Troubleshooting

---

If you find this demo and tutorial helpful, please consider contributing to Archive.org. Don't forget to try out the official Arcade Party skill on Alexa and, if you're a big fan of classic video games, be sure to check out 8bitworkshop.com, where you can write and prototype games for classic video game systems in your browser.

---

Prerequisites

Before you begin, you'll need the following:

• An Amazon AWS account
• Node.js and npm installed
• The latest ASK CLI installed and configured
• The latest AWS CLI installed and configured
• Git

Create ASK and AWS User Profiles

If this is your first time deploying a skill using the ASK SDK v2 command line interface, you should re-run ask configure to generate both a new IAM user and profile with the permissions you'll need to deploy. Even if it's not your first skill deployment, creating a new profile helps ensure that you don't run into permissions problems later.

To create and use a new IAM account for ASK:

1. At the command line, run:

   $ ask configure
   

2. When prompted to select an ASK profile, select Create New Profile.

3. Provide a name you'll remember, like alexa-deploy.

4. When prompted, a browser window will appear and prompt you to log in and allow access to the Alexa Skills Kit.

5. After successfully logging in and allowing access, return to your command line, type Y and press Enter to link the new account to your AWS account.

6. When prompted to select an AWS profile, select Create New Profile.

7. Provide an AWS profile name, for example, AWS_Profile_for_Alexa_Deploy and press Enter.

   Another browser window will open to the IAM Dashboard, listing the permissions summary. This should include IAMFullAccess, AWSCloudFormationFullAccess, AmazonS3FullAccess, and AWSLambdaFullAccess.

8. Click Create User.

9. Copy and save the Access key ID and Secret access key, then return to the terminal to supply them to the ASK configuration wizard.

Prepare the skill infrastructure

Now that you have installed and configured your prerequisites, you can clone the project and prepare the skill infrastructure for your first deployment.

1. Clone the project onto your system:

   $ git clone https://github.com/jenh/ArcadeParty
   

2. Change into the ArcadeParty directory (cd ArcadeParty) and customize the following files:

   • lambda/index.js: Customize your prompts. If you're new to Node.js, you may want to skip this step initially and return to it after you deploy and interact with the skill for the first time.

   • lambda/constants.js: Optionally, specify a new dynamoDBTableName, and add links and titles for the mp3s you want to use. Leave the Alexa skill ID empty for now as we won't have one until we deploy.

   • lambda/package.json: You can change the name and author here (the name controls the autogenerated Lambda function name, so if you're picky about that, change it here), but otherwise skip editing this file on first pass and update after you start hacking lambda/index.js.

   • policies/DynamoDBSecureTable: If you changed the database name in constants.js, make sure it matches here. For example, if you changed the database to Arcade_Party_DB in constants.js, the Resource should be set to "arn:aws:dynamodb:*:*:table/Arcade_Party_DB.

   • skill-package/skill.json: Change metadata as needed for your project. Update the icons to your own icons. The arcade photo used here is courtesy Rob Boudon via Wikimedia Commons (CC BY 2.0).

   • skill-package/interactionModels/custom/en-US.json: Change invocationName (this must be entered in lower case). Because the skill is still in development, it's fine if it collides with another skill name, you can always change it and re-deploy. At this stage, you just want it to be something easy for Alexa to pick out when you test. If you later want to certify the skill, remember to make it as unique and as simple to invoke as possible to avoid collisions with other published skills' namespaces. Optionally, add or remove sample utterances and slots as needed; but, as with index.js, it's a good idea to wait until the skill is deployed and working to customize utterances.

3. Initiate the Alexa skill project:

   $ ask init
   

4. When prompted, you can accept the default values. If you don't expect a lot of usage, you can choose No for CloudFormation (CloudFormation is free for Alexa skills), and you may also want to change Lambda runtime to nodejs12.x.

5. Review the policy that results, then type Y and press Enter to finish.

6. Install npm dependencies in the lambda folder, then return to the main directory:

   $ cd lambda && npm install && cd ..
   

7. You're now ready to deploy the first iteration of your Alexa skill. The following command will create a new Alexa skill, package and upload your NodeJS to Lambda as a new Lambda function, and create an execution role for your function:

   $ ask deploy
   
   ==================== Deploy Skill Metadata ====================
   Skill package deployed successfully.
   Skill ID: amzn1.ask.skill.[your_skill_uuid]
   
   ==================== Build Skill Code ====================
   npm WARN [email protected] No repository field.
   
   audited 256 packages in 1.758s
   found 0 vulnerabilities
   
   Skill code built successfully.
   Code for region default built to /home/jfhh/Arcade_Party/.ask/lambda/build.zip successfully with build flow nodejs-npm.
   
   ==================== Deploy Skill Infrastructure ====================
     ✔ Deploy Alexa skill infrastructure for region "default"
     The api endpoints of skill.json have been updated from the skill infrastructure deploy results.
   Skill infrastructures deployed successfully through @ask-cli/cfn-deployer.
   
   ==================== Enable Skill ====================
   Skill is enabled successfully.
   
   

8. Copy the skill ID that results (this should look like amzn1.ask.skill.fae40d8e-5a83-49d6-8864-71bdb8fc2ead) into the appID attribute in lambda/constants.js.

   Note: If you closed the terminal without copying the skill ID, you can list your skills at any time by running:

   $ ask smapi list-skills-for-vendor
   

9. Re-deploy the skill:

   $ ask deploy
   

Configure DynamoDB access

The skill and Lambda function are now deployed to the AWS Cloud, but it won't work just yet. The Lambda function must have permission to access DynamoDB in order to create and update the table that holds user metadata (user and session IDs and state, including current track, audio offset, and playback preferences). Otherwise, the skill will fail on launch.

To do this, we create a security policy that allows DynamoDB access and attach it to the IAM role that the aws deploy command auto-generated for our Lambda function.

This project contains a JSON file that allows DynamoDB access, but restricts permissions to the table specified inside the policy file. While it's common for developers to give Lambda functions DynamoDBFullAccess permissions, it's just as easy (and good practice) to configure more restrictive permissions.

To generate and attach the table-specific DynamoDB policy:

1. Verify that the Resource in policies/DynamoDBSecureTable.json matches what you set in lambda/constants.js. If it doesn't match, edit it within policies/DynamoDBSecureTable.json. If you decide to change constants.js instead, be sure to run aws redeploy again. If you run the following grep command, the output should look like the following, where ap_demo is the database name you are using:

   $ grep Resource.*arn policies/DynamoDBSecureTable.json && grep dynamo lambda/constants.js 
   
   "Resource": "arn:aws:dynamodb:*:*:table/ap_demo"
   dynamoDBTableName: 'ap_demo',
   

2. Create the policy. Note that the file:// uri inside the policy-document argument is very important and the command will fail if you omit it.

   $ aws iam create-policy --policy-name ap_demo_dynamodb --policy-document file://policies/DynamoDBSecureTable.json
   
   
   {
       "Policy": {
           "PolicyName": "ap_demo_dynamodb",
           "PolicyId": "123456890ABCCDEFGX",
           "Arn": "arn:aws:iam::12345689012:policy/ap_demo_dynamodb",
           "Path": "/",
           "DefaultVersionId": "v1",
           "AttachmentCount": 0,
           "PermissionsBoundaryUsageCount": 0,
           "IsAttachable": true,
           "CreateDate": "2020-08-11T03:26:01+00:00",
           "UpdateDate": "2020-08-11T03:26:01+00:00"
       }
   }
   
   

   If you encounter any errors, add --debug to obtain troubleshooting information.

3. Make a note of the Arn attached to the newly-created policy; we'll need it to attach the policy.

4. Next, we'll locate the role that requires the policy. This role was created by the initial ask deploy and is typically the most recently-created role (and you should see your NodeJS package name from lambda/), so instead of listing all roles with aws iam list-roles, we'll add the --query option to locate the newest role quickly:

   $ aws iam list-roles --query 'reverse(sort_by(Roles[].[CreateDate,RoleName], &[0]))[0]' \
    --output text
   
   > 2020-08-11T00:08:26+00:00 ask-DemoArcadePartyLambda-default-skillStack-15-AlexaSkillIAMRole-1234567890ABC
   

   ---

   Tip: If your organization has a large number of roles that are updated frequently, you can print a list of the newest roles, where YYYY-MM-DD is today's date:

   $ aws iam list-roles --query 'Roles[?CreateDate>=`YYYY-MM-DD`].[RoleName,CreateDate]' \
   --output text
   

   ---

5. We can now attach the policy to our role using the policy Arn and role:

   $ aws iam attach-role-policy --role-name ask-DemoArcadePartyLambda-default-skillStack-15-AlexaSkillIAMRole-123456890AC --policy-arn arn:aws:iam::012345689012:policy/ap_demo_dynamodb
   

6. You're now ready to test the skill! You can test on the command line or Developer Console, but it's more fun for the first try to use an Alexa device or Alexa mobile app: try it out using the invocation you set in the en_US.json model file by saying "Alexa, open invocationName."

Customize your skill

You can now open lambda/index.js and customize your skill even further. Remember to run ask deploy to update your skill after any change.

Test Your Skill

There are a number of ways to test your skill, and you'll probably find yourself using every one of them.

You can test from an IDE (you can install the AWS extension for Visual Studio and test directly from the IDE), from the Lambda console, from a device (an Alexa device or the Alexa app on a mobile device), and from the Alexa Development Console.

For specific errors in NodeJS, you may need to test directly from the Lambda UI, an IDE, or the command line. To generate test cases, the Alexa Development Console is really handy, as you can type your queries, then copy the JSON data out, save to a file, and run test cases from the command line. If you share your test cases or check them into Git, be sure to change any identifiers first!

---

Tip: The uuidgen tool on Linux is handy for generating example skill IDs.

---

To run a test from the command line:

1. To test your Lambda function at the command line, you can use the following command:

   $ aws lambda invoke --function ask-mylambdafunction-AlexaSkillFunction-ABCDEFGHI11 \
   --payload file://tests/mytestfile.json output.log && cat output.log
   

   As when loading policies, you will receive encoding errors if you don't include the file:// uri.

Clean up unused resources

Because deploying skills this way is simple and fast, you may find yourself deploying a number of them for testing purposes. Because DynamoDB is a billable service, you'll want to delete unused DynamoDB tables. It's also good security practice to delete resources you don't need, like the Lambda function and role. You can do this from the AWS console or from the command line.

To delete unused DynamoDB tables using the AWS CLI:

1. Find the table(s) you want to delete by showing all available tables:

   $ aws dynamodb list-tables
   

2. Delete the table. Note that you don't need the full resource URI, you should be able delete with the short table name:

   $ aws dynamodb delete-table --table-name YOUR_TABLE_NAME
   

To delete unused Lambda functions using the AWS CLI:

1. Find the Lambda function you want to delete by showing all available functions:

   $ aws lambda list-functions
   

2. Delete the function. You can use the Function name or Arn.

   $ aws lambda delete-function --function-name ask-ap_demo-default-default-12345678901
   

   ---

   Warning! Be careful here; make sure you are deleting the correct function.

   ---

To delete unused IAM roles using the AWS CLI:

Deleting roles is a little more involved, you must detach all policies from the role before deleting.

1. Find the role you want to delete by showing all available functions:

   $ aws iam list-roles
   

2. Locate the attached policies for the role:

   $ aws iam list-attached-role-policies --role-name ap_demo
   
   {
     "AttachedPolicies": [
       {
         "PolicyName": "ap_demo_dynamodb",
         "PolicyArn": "arn:aws:iam::123456789012:policy/ap_demo_dynamodb"
       }
     ]
   }
   

3. Detach the policy (or policies, if applicable):

   $ aws iam detach-role-policy \
    --role-name "ask-apdemo-default-skillStack-15-AlexaSkillIAMRole-012345ABCDEF10" \
    --policy-arn "arn:aws:iam::123456789012:policy/ap_demo_dynamodb"
   

4. Delete the role.

   aws iam delete-role \
   --role-name ask-apdemo-default-skillStack-15-AlexaSkillIAMRole-012345ABCDEF10
   

---

Warning! Be careful here; make sure you are deleting the correct role.

---

Troubleshooting

I've included a list of helpful commands that I used when porting this skill and issues I ran into.

Viewing CloudWatch logs on the command line

Sometimes you don't have the patience to wait for the CloudWatch console to reload, and it's faster and more fun to tail logs at the command line as they come in. You can use aws logs to do this.

To tail logs:

1. List the log groups available:

   $ aws logs describe-log-groups
   

2. Run tail for the log group you want to track, and you can use follow to watch log events as they arrive (like tail -f):

   $ aws logs tail --follow \
     /aws/lambda/ask-ArcadePartyNodeJSonLambdaEd-AlexaSkillFunction-ABCD789ASD12
   

Common errors

I tried to configure this project so that you shouldn't run into these issues, but you may well encounter them here or in other projects.

• "The trigger setting for the Lambda function is invalid."

  If you change the Lambda function in the manifest and redeploy, even adding the Alexa Skills Kit trigger and skill ID after-the-fact might not 'take.' I was able to work around this by going into the Alexa Console and manually updating the endpoint.

  You can then download the manifest & copy it over (make a backup first!) your old skills.json:

  $ ask smapi get-skill-manifest -s amzn1.ask.skill.YOUR_SKILL_UUID -g development >> new-skills.json
  

• "String instance at property path "$.manifest.apis.custom.endpoint.uri" does not match the regular expression: "^(arn|https://)"

  This and the Unable to deploy target skill-infrastructure when the skillId has not been created yet error are a chicken and egg problem I struggled with for awhile: many thanks to Jose Quinto, who documented the solution. You just need to clear the entire endpoint option from your manifest and start a fresh deployment. ASK will add it back after it creates everything.

  Be careful if you do this a lot; you may find yourself with multiple Lambda functions and might discover that you're testing a stale function! (No wonder your changes didn't take!) Check the manifest to make sure that it matches what you're testing or what you think you're testing, especially if you test Lambda functions directly.

  I removed the endpoint option from the skills.json file I include in this project, but if you copy skill manifests around like most of us do, you will probably run into the error again!

Cloning Your Skill

The ASK v2 CLI no longer has a clone option, but you can access the same functionality by creating and changing into a new directory, running list-skills-for-vendor to obtain a list of skills and then running the ask smapi export-package command:

$ ask smapi list-skills-for-vendor

   {
      "_links": {
        "self": {
          "href": "/v1/skills/amzn1.ask.skill.59d694ce-dd0e-4d52-9853-493c0f131b0f/stages/development/manifest"
        }
      },
      "apis": [
        "custom"
      ],
      "asin": "A123456789",
      "lastUpdated": "2020-01-13T01:51:03.091Z",
      "nameByLocale": {
        "en-AU": "Arcade Party",
        "en-GB": "Arcade Party",
        "en-IN": "Arcade Party",
        "en-US": "Arcade Party"
      },
      "publicationStatus": "DEVELOPMENT",
      "skillId": "amzn1.ask.skill.59d694ce-dd0e-4d52-9853-493c0f131b0f",
      "stage": "development"
    },

$ ask smapi export-package -s amzn1.ask.skill.59d694ce-dd0e-4d52-9853-493c0f131b0f -g development

• Licensing: ArcadeParty tutorial is licensed with Apache License 2.0. Lambda code from adapted from https://github.com/alexa/skill-sample-nodejs-audio-player to enable this tutorial is licensed under the Amazon Software License.