github-aws-runners · npalm · Nov 30, 2022 · Nov 26, 2022 · Nov 30, 2022 · Nov 30, 2022
@@ -109,7 +109,7 @@ The setup consists of running Terraform to create all AWS resources and manually
 
 ### Setup GitHub App (part 1)
 
-Go to GitHub and [create a new app](https://docs.github.com/en/developers/apps/creating-a-github-app). Beware you can create apps your organization or for a user. For now we support only organization level apps.
+Go to GitHub and [create a new app](https://docs.github.com/en/developers/apps/creating-a-github-app). Beware you can create apps for your organization or for a user. For now we support only organization level apps.
 
 1. Create app in Github
 2. Choose a name

@@ -289,5 +289,8 @@ module "runner_binaries" {
   log_type  = var.log_type
   log_level = var.log_level
 
+  lambda_subnet_ids         = var.lambda_subnet_ids
+  lambda_security_group_ids = var.lambda_security_group_ids
+
   lambda_principals = var.lambda_principals
 }
@@ -23,18 +23,18 @@
     "@typescript-eslint/eslint-plugin": "^4.33.0",
     "@typescript-eslint/parser": "^4.33.0",
     "@vercel/ncc": "^0.34.0",
-    "aws-sdk": "^2.1256.0",
+    "aws-sdk": "^2.1265.0",
     "eslint": "^7.32.0",
     "eslint-plugin-prettier": "4.2.1",
     "jest": "^29.3",
     "jest-mock": "^29.3.1",
-    "prettier": "2.7.1",
+    "prettier": "2.8.0",
     "ts-jest": "^29.0.3",
     "ts-node-dev": "^2.0.0",
-    "typescript": "^4.8.4"
+    "typescript": "^4.9.3"
   },
   "dependencies": {
-    "axios": "^1.1.3",
+    "axios": "^1.2.0",
     "tslog": "^3.3.4"
   }
 }
@@ -1392,10 +1392,10 @@ available-typed-arrays@^1.0.5:
   resolved "https://registry.yarnpkg.com/available-typed-arrays/-/available-typed-arrays-1.0.5.tgz#92f95616501069d07d10edb2fc37d3e1c65123b7"
   integrity sha512-DMD0KiN46eipeziST1LPP/STfDU0sufISXmjSgvVsoU2tqxctQeASejWcfNtxYKqETM1UxQ8sp2OrSBWpHY6sw==
 
-aws-sdk@^2.1256.0:
-  version "2.1256.0"
-  resolved "https://registry.yarnpkg.com/aws-sdk/-/aws-sdk-2.1256.0.tgz#4cac62e8bbd1f8a363cd506328103b3498bfa767"
-  integrity sha512-/Dh81PZdjqyZwA3BMBUO2PMUakv0hqjxCReE59sskIFdQJdSOW+26EQ4LcV07YP6umz3n5TKC28bEfx6l2kTJQ==
+aws-sdk@^2.1265.0:
+  version "2.1265.0"
+  resolved "https://registry.yarnpkg.com/aws-sdk/-/aws-sdk-2.1265.0.tgz#ec034b10126d7c81242b2501567cb4d5179a4e61"
+  integrity sha512-PcW3VAxatnOgSwdENkXpFAKnE6P5GJeI7yxjEhjHSLXFyOzQZQZIT5NMCs7B25nB6iACzxizjKaYbU0kNA/8/Q==
   dependencies:
     buffer "4.9.2"
     events "1.1.1"
@@ -1408,10 +1408,10 @@ aws-sdk@^2.1256.0:
     uuid "8.0.0"
     xml2js "0.4.19"
 
-axios@^1.1.3:
-  version "1.1.3"
-  resolved "https://registry.yarnpkg.com/axios/-/axios-1.1.3.tgz#8274250dada2edf53814ed7db644b9c2866c1e35"
-  integrity sha512-00tXVRwKx/FZr/IDVFt4C+f9FYairX517WoGCL6dpOntqLkZofjhu43F/Xl44UOpqa+9sLFDrG/XAnFsUYgkDA==
+axios@^1.2.0:
+  version "1.2.0"
+  resolved "https://registry.yarnpkg.com/axios/-/axios-1.2.0.tgz#1cb65bd75162c70e9f8d118a905126c4a201d383"
+  integrity sha512-zT7wZyNYu3N5Bu0wuZ6QccIf93Qk1eV8LOewxgjOZFd2DenOs98cJ7+Y6703d0wkaXGY6/nZd4EweJaHz9uzQw==
   dependencies:
     follow-redirects "^1.15.0"
     form-data "^4.0.0"
@@ -1693,7 +1693,7 @@ combined-stream@^1.0.6, combined-stream@^1.0.8:
 [email protected]:
   version "0.0.1"
   resolved "https://registry.yarnpkg.com/concat-map/-/concat-map-0.0.1.tgz#d8a96bd77fd68df7793a73036a3ba0d5405d477b"
-  integrity sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=
+  integrity sha512-/Srv4dswyQNBfohGpz9o6Yb3Gz3SrUDqBH5rTuhGR7ahtlbYKnVxw2bCFMRljaA7EXHaXZ8wsHdodFvbkhKmqg==
 
 convert-source-map@^1.6.0, convert-source-map@^1.7.0:
   version "1.8.0"
@@ -3151,9 +3151,9 @@ mimic-fn@^2.1.0:
   integrity sha512-OqbOk5oEQeAZ8WXWydlu9HJjz9WVdEIvamMCcXmuqUYjTknH/sqsWvhQ3vgwKFRR1HpjvNBKQ37nbJgYzGqGcg==
 
 minimatch@^3.0.4:
-  version "3.0.4"
-  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.0.4.tgz#5166e286457f03306064be5497e8dbb0c3d32083"
-  integrity sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==
+  version "3.1.2"
+  resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-3.1.2.tgz#19cd194bfd3e428f049a70817c038d89ab4be35b"
+  integrity sha512-J7p63hRiAjw1NDEww1W7i37+ByIrOWO5XQQAzZ3VOcL0PNybwpfmV/N05zFAzwQ9USyEcX6t3UO+K5aqBQOIHw==
   dependencies:
     brace-expansion "^1.1.7"
 
@@ -3368,10 +3368,10 @@ prettier-linter-helpers@^1.0.0:
   dependencies:
     fast-diff "^1.1.2"
 
-prettier@2.7.1:
-  version "2.7.1"
-  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.7.1.tgz#e235806850d057f97bb08368a4f7d899f7760c64"
-  integrity sha512-ujppO+MkdPqoVINuDFDRLClm7D78qbDt0/NR+wp5FqEZOoTNAjPHWj17QRhu7geIHJfcNhRk1XVQmF8Bp3ye+g==
+prettier@2.8.0:
+  version "2.8.0"
+  resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.8.0.tgz#c7df58393c9ba77d6fba3921ae01faf994fb9dc9"
+  integrity sha512-9Lmg8hTFZKG0Asr/kW9Bp8tJjRVluO8EJQVfY2T7FMw9T5jy4I/Uvx0Rca/XWf50QQ1/SS48+6IJWnrb+2yemA==
 
 pretty-format@^29.0.0, pretty-format@^29.3.1:
   version "29.3.1"
@@ -3882,10 +3882,10 @@ type-fest@^0.21.3:
   resolved "https://registry.yarnpkg.com/type-fest/-/type-fest-0.21.3.tgz#d260a24b0198436e133fa26a524a6d65fa3b2e37"
   integrity sha512-t0rzBq87m3fVcduHDUFhKmyyX+9eo6WQjZvf51Ea/M0Q7+T374Jp1aUiyUl0GKxp8M/OETVHSDvmkyPgvX+X2w==
 
-typescript@^4.8.4:
-  version "4.8.4"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.8.4.tgz#c464abca159669597be5f96b8943500b238e60e6"
-  integrity sha512-QCh+85mCy+h0IGff8r5XWzOVSbBO+KfeYrMQh7NJ58QujwcE22u+NUSmUxqF+un70P9GXKxa2HCNiTTMJknyjQ==
+typescript@^4.9.3:
+  version "4.9.3"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.9.3.tgz#3aea307c1746b8c384435d8ac36b8a2e580d85db"
+  integrity sha512-CIfGzTelbKNEnLpLdGFgdyKhG23CKdKgQPOBc+OUNrkJ2vr+KSzsSV5kq5iWhEQbok+quxgGzrAtGWCyU7tHnA==
 
 unbox-primitive@^1.0.2:
   version "1.0.2"

@@ -28,24 +28,24 @@
     "jest": "^29.3",
     "jest-mock": "^29.3.1",
     "jest-mock-extended": "^3.0.1",
-    "moment-timezone": "^0.5.38",
+    "moment-timezone": "^0.5.39",
     "nock": "^13.2.9",
     "prettier": "2.7.1",
     "ts-jest": "^29.0.3",
     "ts-node": "^10.9.1",
     "ts-node-dev": "^2.0.0"
   },
   "dependencies": {
-    "@aws-sdk/client-ssm": "^3.210.0",
+    "@aws-sdk/client-ssm": "^3.218.0",
     "@octokit/auth-app": "4.0.7",
     "@octokit/rest": "^19.0.5",
     "@octokit/types": "^8.0.0",
     "@types/aws-lambda": "^8.10.108",
     "@types/express": "^4.17.14",
     "@types/node": "^18.11.9",
-    "aws-sdk": "^2.1253.0",
+    "aws-sdk": "^2.1265.0",
     "cron-parser": "^4.6.0",
     "tslog": "^3.3.4",
-    "typescript": "^4.8.4"
+    "typescript": "^4.9.3"
   }
 }
@@ -15,41 +15,53 @@ const ORG_NAME = 'SomeAwesomeCoder';
 const REPO_NAME = `${ORG_NAME}/some-amazing-library`;
 const ENVIRONMENT = 'unit-test-environment';
 
-describe('list instances', () => {
-  const mockDescribeInstances = { promise: jest.fn() };
-  beforeEach(() => {
-    jest.clearAllMocks();
-    mockEC2.describeInstances.mockImplementation(() => mockDescribeInstances);
-    const mockRunningInstances: AWS.EC2.DescribeInstancesResult = {
-      Reservations: [
+const mockDescribeInstances = { promise: jest.fn() };
+mockEC2.describeInstances.mockImplementation(() => mockDescribeInstances);
+const mockRunningInstances: AWS.EC2.DescribeInstancesResult = {
+  Reservations: [
+    {
+      Instances: [
         {
-          Instances: [
-            {
-              LaunchTime: new Date('2020-10-10T14:48:00.000+09:00'),
-              InstanceId: 'i-1234',
-              Tags: [
-                { Key: 'Application', Value: 'github-action-runner' },
-                { Key: 'Type', Value: 'Org' },
-                { Key: 'Owner', Value: 'CoderToCat' },
-              ],
-            },
-            {
-              LaunchTime: new Date('2020-10-11T14:48:00.000+09:00'),
-              InstanceId: 'i-5678',
-              Tags: [
-                { Key: 'Owner', Value: REPO_NAME },
-                { Key: 'Type', Value: 'Repo' },
-                { Key: 'Application', Value: 'github-action-runner' },
-              ],
-            },
+          LaunchTime: new Date('2020-10-10T14:48:00.000+09:00'),
+          InstanceId: 'i-1234',
+          Tags: [
+            { Key: 'ghr:Application', Value: 'github-action-runner' },
+            { Key: 'Type', Value: 'Org' },
+            { Key: 'Owner', Value: 'CoderToCat' },
           ],
         },
       ],
-    };
-    mockDescribeInstances.promise.mockReturnValue(mockRunningInstances);
+    },
+  ],
+};
+const mockRunningInstancesLegacy: AWS.EC2.DescribeInstancesResult = {
+  Reservations: [
+    {
+      Instances: [
+        {
+          LaunchTime: new Date('2020-10-11T14:48:00.000+09:00'),
+          InstanceId: 'i-5678',
+          Tags: [
+            { Key: 'Owner', Value: REPO_NAME },
+            { Key: 'Type', Value: 'Repo' },
+            { Key: 'Application', Value: 'github-action-runner' },
+          ],
+        },
+      ],
+    },
+  ],
+};
+
+describe('list instances', () => {
+  beforeEach(() => {
+    jest.resetModules();
+    jest.clearAllMocks();
   });
 
   it('returns a list of instances', async () => {
+    mockDescribeInstances.promise
+      .mockReturnValueOnce(mockRunningInstances)
+      .mockReturnValueOnce(mockRunningInstancesLegacy);
     const resp = await listEC2Runners();
     expect(resp.length).toBe(2);
     expect(resp).toContainEqual({
@@ -67,41 +79,61 @@ describe('list instances', () => {
   });
 
   it('calls EC2 describe instances', async () => {
+    mockDescribeInstances.promise
+      .mockReturnValueOnce(mockRunningInstances)
+      .mockReturnValueOnce(mockRunningInstancesLegacy);
     await listEC2Runners();
     expect(mockEC2.describeInstances).toBeCalled();
   });
 
   it('filters instances on repo name', async () => {
+    mockDescribeInstances.promise
+      .mockReturnValueOnce(mockRunningInstances)
+      .mockReturnValueOnce(mockRunningInstancesLegacy);
     await listEC2Runners({ runnerType: 'Repo', runnerOwner: REPO_NAME, environment: undefined });
     expect(mockEC2.describeInstances).toBeCalledWith({
       Filters: [
-        { Name: 'tag:Application', Values: ['github-action-runner'] },
         { Name: 'instance-state-name', Values: ['running', 'pending'] },
         { Name: 'tag:Type', Values: ['Repo'] },
         { Name: 'tag:Owner', Values: [REPO_NAME] },
+        { Name: 'tag:ghr:Application', Values: ['github-action-runner'] },
+      ],
+    });
+    expect(mockEC2.describeInstances).toBeCalledWith({
+      Filters: [
+        { Name: 'instance-state-name', Values: ['running', 'pending'] },
+        { Name: 'tag:Type', Values: ['Repo'] },
+        { Name: 'tag:Owner', Values: [REPO_NAME] },
+        { Name: 'tag:Application', Values: ['github-action-runner'] },
       ],
     });
   });
 
   it('filters instances on org name', async () => {
+    mockDescribeInstances.promise
+      .mockReturnValueOnce(mockRunningInstances)
+      .mockReturnValueOnce(mockRunningInstancesLegacy);
     await listEC2Runners({ runnerType: 'Org', runnerOwner: ORG_NAME, environment: undefined });
     expect(mockEC2.describeInstances).toBeCalledWith({
       Filters: [
-        { Name: 'tag:Application', Values: ['github-action-runner'] },
         { Name: 'instance-state-name', Values: ['running', 'pending'] },
         { Name: 'tag:Type', Values: ['Org'] },
         { Name: 'tag:Owner', Values: [ORG_NAME] },
+        { Name: 'tag:ghr:Application', Values: ['github-action-runner'] },
       ],
     });
   });
 
   it('filters instances on environment', async () => {
+    mockDescribeInstances.promise
+      .mockReturnValueOnce(mockRunningInstances)
+      .mockReturnValueOnce(mockRunningInstancesLegacy);
     await listEC2Runners({ environment: ENVIRONMENT });
     expect(mockEC2.describeInstances).toBeCalledWith({
       Filters: [
-        { Name: 'tag:Application', Values: ['github-action-runner'] },
         { Name: 'instance-state-name', Values: ['running', 'pending'] },
         { Name: 'tag:ghr:environment', Values: [ENVIRONMENT] },
+        { Name: 'tag:ghr:Application', Values: ['github-action-runner'] },
       ],
     });
   });
@@ -123,7 +155,7 @@ describe('list instances', () => {
         },
       ],
     };
-    mockDescribeInstances.promise.mockReturnValue(noInstances);
+    mockDescribeInstances.promise.mockReturnValueOnce(noInstances).mockReturnValueOnce(noInstances);
     const resp = await listEC2Runners();
     expect(resp.length).toBe(0);
   });
@@ -142,7 +174,7 @@ describe('list instances', () => {
         },
       ],
     };
-    mockDescribeInstances.promise.mockReturnValue(noInstances);
+    mockDescribeInstances.promise.mockReturnValueOnce(noInstances).mockReturnValue({});
     const resp = await listEC2Runners();
     expect(resp.length).toBe(1);
   });
@@ -459,7 +491,7 @@ function expectedCreateFleetRequest(expectedValues: ExpectedFleetRequestValues):
       {
         ResourceType: 'instance',
         Tags: [
-          { Key: 'Application', Value: 'github-action-runner' },
+          { Key: 'ghr:Application', Value: 'github-action-runner' },
           { Key: 'Type', Value: expectedValues.type },
           { Key: 'Owner', Value: REPO_NAME },
         ],

@@ -45,24 +45,47 @@ export interface RunnerInputParameters {
   amiIdSsmParameterName?: string;
 }
 
+interface Ec2Filter {
+  Name: string;
+  Values: string[];
+}
+
 export async function listEC2Runners(filters: ListRunnerFilters | undefined = undefined): Promise<RunnerList[]> {
-  const ec2Statuses = filters?.statuses ? filters.statuses : ['running', 'pending'];
-  const ec2 = new EC2();
-  const ec2Filters = [
-    { Name: 'tag:Application', Values: ['github-action-runner'] },
-    { Name: 'instance-state-name', Values: ec2Statuses },
-  ];
+  const ec2Filters = constructFilters(filters);
+  const runners: RunnerList[] = [];
+  for (const filter of ec2Filters) {
+    runners.push(...(await getRunners(filter)));
+  }
+  return runners;
+}
 
+function constructFilters(filters?: ListRunnerFilters): Ec2Filter[][] {
+  const ec2Statuses = filters?.statuses ? filters.statuses : ['running', 'pending'];
+  const ec2Filters: Ec2Filter[][] = [];
+  const ec2FiltersBase = [{ Name: 'instance-state-name', Values: ec2Statuses }];
   if (filters) {
     if (filters.environment !== undefined) {
-      ec2Filters.push({ Name: 'tag:ghr:environment', Values: [filters.environment] });
+      ec2FiltersBase.push({ Name: 'tag:ghr:environment', Values: [filters.environment] });
     }
     if (filters.runnerType && filters.runnerOwner) {
-      ec2Filters.push({ Name: `tag:Type`, Values: [filters.runnerType] });
-      ec2Filters.push({ Name: `tag:Owner`, Values: [filters.runnerOwner] });
+      ec2FiltersBase.push({ Name: `tag:Type`, Values: [filters.runnerType] });
+      ec2FiltersBase.push({ Name: `tag:Owner`, Values: [filters.runnerOwner] });
     }
   }
 
+  // ***Deprecation Notice***
+  // Support for legacy `Application` tag keys
+  // will be removed in next major release.
+  for (const key of ['tag:ghr:Application', 'tag:Application']) {
+    const filter = [...ec2FiltersBase];
+    filter.push({ Name: key, Values: ['github-action-runner'] });
+    ec2Filters.push(filter);
+  }
+  return ec2Filters;
+}
+
+async function getRunners(ec2Filters: Ec2Filter[]): Promise<RunnerList[]> {
+  const ec2 = new EC2();
   const runners: RunnerList[] = [];
   let nextToken;
   let hasNext = true;
@@ -191,7 +214,7 @@ export async function createRunner(runnerParameters: RunnerInputParameters): Pro
           {
             ResourceType: 'instance',
             Tags: [
-              { Key: 'Application', Value: 'github-action-runner' },
+              { Key: 'ghr:Application', Value: 'github-action-runner' },
               { Key: 'Type', Value: runnerParameters.runnerType },
               { Key: 'Owner', Value: runnerParameters.runnerOwner },
             ],