Fix visibility data on ES not deleted (cadence-workflow#2379)

kewu21 · Aug 12, 2019 · 4b95faa · 4b95faa
1 parent 815db6f
commit 4b95faa
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/common/metrics/defs.go b/common/metrics/defs.go
@@ -506,6 +506,8 @@ const (
 	ElasticsearchScanWorkflowExecutionsScope
 	// ElasticsearchCountWorkflowExecutionsScope tracks CountWorkflowExecutions calls made by service to persistence layer
 	ElasticsearchCountWorkflowExecutionsScope
+	// ElasticsearchDeleteWorkflowExecutionsScope tracks DeleteWorkflowExecution calls made by service to persistence layer
+	ElasticsearchDeleteWorkflowExecutionsScope
 
 	// SequentialTaskProcessingScope is used by sequential task processing logic
 	SequentialTaskProcessingScope
@@ -1054,6 +1056,7 @@ var ScopeDefs = map[ServiceIdx]map[int]scopeDefinition{
 		ElasticsearchListWorkflowExecutionsScope:                   {operation: "ListWorkflowExecutions"},
 		ElasticsearchScanWorkflowExecutionsScope:                   {operation: "ScanWorkflowExecutions"},
 		ElasticsearchCountWorkflowExecutionsScope:                  {operation: "CountWorkflowExecutions"},
+		ElasticsearchDeleteWorkflowExecutionsScope:                 {operation: "DeleteWorkflowExecution"},
 		SequentialTaskProcessingScope:                              {operation: "SequentialTaskProcessing"},
 
 		HistoryArchiverScope: {operation: "HistoryArchiver"},

diff --git a/common/persistence/elasticsearch/esVisibilityMetricClients.go b/common/persistence/elasticsearch/esVisibilityMetricClients.go
@@ -246,7 +246,17 @@ func (p *visibilityMetricsClient) CountWorkflowExecutions(request *p.CountWorkfl
 }
 
 func (p *visibilityMetricsClient) DeleteWorkflowExecution(request *p.VisibilityDeleteWorkflowExecutionRequest) error {
-	return nil // not applicable for elastic search, which relies on retention policies for deletion
+	p.metricClient.IncCounter(metrics.ElasticsearchDeleteWorkflowExecutionsScope, metrics.ElasticsearchRequests)
+
+	sw := p.metricClient.StartTimer(metrics.ElasticsearchDeleteWorkflowExecutionsScope, metrics.ElasticsearchLatency)
+	err := p.persistence.DeleteWorkflowExecution(request)
+	sw.Stop()
+
+	if err != nil {
+		p.updateErrorMetric(metrics.ElasticsearchDeleteWorkflowExecutionsScope, err)
+	}
+
+	return err
 }
 
 func (p *visibilityMetricsClient) updateErrorMetric(scope int, err error) {

diff --git a/docs/visibility-on-elasticsearch.md b/docs/visibility-on-elasticsearch.md
@@ -36,7 +36,7 @@ To list only open workflows, add `CloseTime = missing` to the end of query.
 ### start workflow with search attributes 
 
 ```
-cadence --do samples-domain workflow start --tl helloWorldGroup --wt main.Workflow --et 60 --dt 10 -i '"vancexu"' -search_attr_key 'CustomIntField | CustomKeywordField | CustomStringField |  CustomBoolField | CustomDatetimeField' -search_attr_value '5 | keyword1 | vancexu test | true | 2019-06-07T16:16:36-08:00'
+cadence --do samples-domain workflow start --tl helloWorldGroup --wt main.Workflow --et 60 --dt 10 -i '"input arg"' -search_attr_key 'CustomIntField | CustomKeywordField | CustomStringField |  CustomBoolField | CustomDatetimeField' -search_attr_value '5 | keyword1 | my test | true | 2019-06-07T16:16:36-08:00'
 ```
 
 Note: start workflow with search attributes but without ES will succeed as normal, but will not be searchable and will not be shown in list result.