feat: add 'enableServiceConnect' for client services

Author: bvtujo

src/service.ts

@@ -292,6 +292,11 @@ export class Service extends Construct {
       throw new Error(`Unknown capacity type for service ${this.id}`);
     }
 
+    // Enable service connect if requested and it has not been enabled by an extension.
+    if (props.enableServiceConnect && !serviceProps.serviceConnectConfiguration) {
+      this.enableServiceConnect();
+    }
+
     // Create the auto scaling target and configure target tracking policies after the service is created
     if (props.autoScaleTaskCount) {
       this.scalableTaskCount = this.ecsService.autoScaleTaskCount({
@@ -376,4 +381,18 @@ export class Service extends Construct {
   public enableAutoScalingPolicy() {
     this.autoScalingPoliciesEnabled = true;
   }
+
+  /**
+   * This method allows a service to opt in to ECS Service Connect as a client.
+   * If this method is not called, the service will not be able to reach other
+   * Service Connect enabled services via their terse DNS aliases.
+   */
+  public enableServiceConnect() {
+    if (!this.environment.cluster.defaultCloudMapNamespace) {
+      throw new Error('Environment must have a default CloudMap namespace to enable Service Connect.');
+    }
+    this.ecsService.enableServiceConnect({
+      namespace: this.environment.cluster.defaultCloudMapNamespace.namespaceName,
+    });
+  }
 }

test/aliased-port.test.ts

@@ -117,4 +117,65 @@ describe('aliased port', () => {
       },
     });
   });
+
+  test('when enabling service connect on a client service', () => {
+    serviceDescription.add(new Container({
+      cpu: 256,
+      memoryMiB: 512,
+      trafficPort: 80,
+      image: ecs.ContainerImage.fromRegistry('nathanpeck/name'),
+    }));
+
+    environment.addDefaultCloudMapNamespace({
+      name: environment.id,
+    });
+
+    const svc = new Service(stack, 'my-service', {
+      environment,
+      serviceDescription,
+    });
+    svc.enableServiceConnect();
+
+    Template.fromStack(stack).hasResourceProperties('AWS::ECS::Service', {
+      ServiceConnectConfiguration: {
+        Enabled: true,
+        Namespace: 'production',
+      },
+    });
+  });
+
+  test('cannot enable service connect on a cluster with no namespace', () => {
+    serviceDescription.add(new Container({
+      cpu: 256,
+      memoryMiB: 512,
+      trafficPort: 80,
+      image: ecs.ContainerImage.fromRegistry('nathanpeck/name'),
+    }));
+    const svc = new Service(stack, 'my-service', {
+      environment,
+      serviceDescription,
+    });
+
+    expect(() => {
+      svc.enableServiceConnect();
+    }).toThrow('Environment must have a default CloudMap namespace to enable Service Connect.');
+  });
+
+  test('cannot add two Aliased Port extensions', () => {
+    serviceDescription.add(new Container({
+      cpu: 256,
+      memoryMiB: 512,
+      trafficPort: 80,
+      image: ecs.ContainerImage.fromRegistry('nathanpeck/name'),
+    }));
+    serviceDescription.add(new AliasedPortExtension({
+      alias: 'name',
+    }));
+    expect(() => {
+      serviceDescription.add(new AliasedPortExtension({
+        alias: 'name2',
+        aliasPort: 8080,
+      }));
+    }).toThrow('An extension called aliasedPort has already been added');
+  });
 });