Merge pull request #223 from Clever/embedded-allow-setting-execution-…

…name

Embedded allow setting execution name

docs/definitions.md

@@ -219,12 +219,13 @@
 <a name="startworkflowrequest"></a>
 ### StartWorkflowRequest
 
-|Name|Schema|
-|---|---|
-|**input**  <br>*optional*|string|
-|**namespace**  <br>*optional*|string|
-|**queue**  <br>*optional*|string|
-|**workflowDefinition**  <br>*optional*|[WorkflowDefinitionRef](#workflowdefinitionref)|
+|Name|Description|Schema|
+|---|---|---|
+|**idSuffix**  <br>*optional*|idSuffix is exclusively used for embedded workflow-manager to append human readable information to the newly created workflow's ID. Workflow IDs are truncated to 80 characters, so some or all of the suffix may be lost|string|
+|**input**  <br>*optional*||string|
+|**namespace**  <br>*optional*||string|
+|**queue**  <br>*optional*||string|
+|**workflowDefinition**  <br>*optional*||[WorkflowDefinitionRef](#workflowdefinitionref)|
 
 
 <a name="stateresource"></a>

docs/overview.md

@@ -7,7 +7,7 @@ Orchestrator for AWS Step Functions
 
 
 ### Version information
-*Version* : 0.11.0
+*Version* : 0.11.1
 
 
 ### URI scheme

embedded/embedded.go

@@ -394,7 +394,7 @@ New state machine:
 	}
 	workflow := &models.Workflow{
 		WorkflowSummary: models.WorkflowSummary{
-			ID:                 workflowID(stateMachineName),
+			ID:                 workflowID(stateMachineName, i.IDSuffix),
 			CreatedAt:          strfmt.DateTime(time.Now()),
 			LastUpdated:        strfmt.DateTime(time.Now()),
 			WorkflowDefinition: wd,
@@ -507,13 +507,25 @@ func (e *Embedded) NewWorkflowDefinition(ctx context.Context, i *models.NewWorkf
 // The workflow ID will contain the state machine name.
 // This is to support the implementation of `GetWorkflowByID`, which requires
 // the state machine name in order to call `DescribeExecution` in the SFN API.
-func workflowID(smName string) string {
-	return fmt.Sprintf("%s--%s", smName, shortUUID())
+// It will append a suffix, trimming the length to abide the 80 character step functions limit
+// https://docs.aws.amazon.com/step-functions/latest/apireference/API_StartExecution.html
+// If a suffix isn't provided the generated ID will include the first 8 characters of a UUID
+func workflowID(smName, suffix string) string {
+	if suffix == "" {
+		suffix = shortUUID()
+	}
+	id := fmt.Sprintf("%s--%s", smName, suffix)
+
+	// ensure the generated ID is within the 80 character limit
+	if len(id) > 80 {
+		return id[:80]
+	}
+	return id
 }
 
 type workflowIDParts struct {
-	SMName    string
-	ShortUUID string
+	SMName string
+	Suffix string
 }
 
 func parseWorkflowID(wid string) (*workflowIDParts, error) {
@@ -522,8 +534,8 @@ func parseWorkflowID(wid string) (*workflowIDParts, error) {
 		return nil, errors.Errorf("expected workflowID two contain at least two parts: %s", wid)
 	}
 	return &workflowIDParts{
-		SMName:    strings.Join(s[0:len(s)-1], "--"),
-		ShortUUID: s[len(s)-1],
+		SMName: strings.Join(s[0:len(s)-1], "--"),
+		Suffix: s[len(s)-1],
 	}, nil
 }
 

gen-go/server/router.go

@@ -97,6 +97,7 @@ func (s *Server) Serve() error {
 				opentracing.Tag{Key: "deploy_env", Value: os.Getenv("_DEPLOY_ENV")},
 				opentracing.Tag{Key: "team_owner", Value: os.Getenv("_TEAM_OWNER")},
 				opentracing.Tag{Key: "pod_id", Value: os.Getenv("_POD_ID")},
+				opentracing.Tag{Key: "pod_shortname", Value: os.Getenv("_POD_SHORTNAME")},
 				opentracing.Tag{Key: "pod_account", Value: os.Getenv("_POD_ACCOUNT")},
 				opentracing.Tag{Key: "pod_region", Value: os.Getenv("_POD_REGION")},
 			},

gen-js/index.d.ts

@@ -36,6 +36,7 @@ interface GenericOptions {
   logger?: Logger;
   tracer?: Tracer;
   circuit?: CircuitOptions;
+  serviceName?: string;
 }
 
 interface DiscoveryOptions {
@@ -232,6 +233,7 @@ type SLStateMachine = {
 type SLStateType = ("Pass" | "Task" | "Choice" | "Wait" | "Succeed" | "Fail" | "Parallel");
 
 type StartWorkflowRequest = {
+  idSuffix?: string;
   input?: string;
   namespace?: string;
   queue?: string;

gen-js/index.js

@@ -168,9 +168,9 @@ class WorkflowManager {
 
     if (options.discovery) {
       try {
-        this.address = discovery("workflow-manager", "http").url();
+        this.address = discovery(options.serviceName || "workflow-manager", "http").url();
       } catch (e) {
-        this.address = discovery("workflow-manager", "default").url();
+        this.address = discovery(options.serviceName || "workflow-manager", "default").url();
       }
     } else if (options.address) {
       this.address = options.address;
@@ -193,7 +193,7 @@ class WorkflowManager {
     if (options.logger) {
       this.logger = options.logger;
     } else {
-      this.logger =  new kayvee.logger("workflow-manager-wagclient");
+      this.logger = new kayvee.logger((options.serviceName || "workflow-manager") + "-wagclient");
     }
     if (options.tracer) {
       this.tracer = options.tracer;
@@ -202,7 +202,7 @@ class WorkflowManager {
     }
 
     const circuitOptions = Object.assign({}, defaultCircuitOptions, options.circuit);
-    this._hystrixCommand = commandFactory.getOrCreate("workflow-manager").
+    this._hystrixCommand = commandFactory.getOrCreate(options.serviceName || "workflow-manager").
       errorHandler(this._hystrixCommandErrorHandler).
       circuitBreakerForceClosed(circuitOptions.forceClosed).
       requestVolumeRejectionThreshold(circuitOptions.maxConcurrentRequests).

gen-js/package.json

@@ -1,6 +1,6 @@
 {
   "name": "workflow-manager",
-  "version": "0.11.0",
+  "version": "0.11.1",
   "description": "Orchestrator for AWS Step Functions",
   "main": "index.js",
   "dependencies": {

swagger.yml

@@ -4,7 +4,7 @@ info:
   description: Orchestrator for AWS Step Functions
   # when changing the version here, make sure to
   # re-run `make generate` to generate clients and server
-  version: 0.11.0
+  version: 0.11.1
   x-npm-package: workflow-manager
 schemes:
   - http
@@ -592,6 +592,9 @@ definitions:
         description: "tags: object with key-value pairs; keys and values should be strings"
         additionalProperties:
           type: object
+      idSuffix:
+        description: "idSuffix is exclusively used for embedded workflow-manager to append human readable information to the newly created workflow's ID. Workflow IDs are truncated to 80 characters, so some or all of the suffix may be lost"
+        type: string
 
   WorkflowDefinitionRef:
     type: object