Drop escaping of strings in the JSON.

[bigkevmcd]

Changes

Add support for the old escaping mechanism through an annotation on the
TriggerTemplate.

This removes the old replacement of " with \" in parameters, which was yielding
invalid JSON when the strings were already quoted.

Fixes: #777

Submitter Checklist

These are the criteria that every PR should meet, please check them off as you
review them:

• Includes tests (if functionality changed/added)
• Includes docs (if user facing)
• Commit messages follow commit message best practices
• Release notes block has been filled in or deleted (only if no user facing changes)

See the contribution guide for more details.

Release Notes

Change the escaping of parameters into TriggerTemplates.

Previously, parameters were escaped as they were being replaced into a TriggerTemplate, by replacing double-quotes " with an escaped version \", this functionality has been removed, as it was breaking quoted strings, and in some cases, rendering the resulting output unparseable.

action required: If you were relying on the escaping, you can retain the old behaviour by adding an annotation to an affected TriggerTemplate, `tekton.dev/old-escape-quotes: true"`

[bigkevmcd]

/test pull-tekton-triggers-integration-tests

[bigkevmcd]

/retest

[dibyom]

/test pull-tekton-triggers-integration-tests

[dibyom]

        {"level":"error","ts":"2020-11-10T16:58:02.248Z","logger":"eventlistener","caller":"sink/sink.go:274","msg":"problem creating obj: &errors.errorString{s:\"couldn't unmarshal json: invalid character 'k' after object key:value pair\"}","knative.dev/controller":"eventlistener","/triggers-eventid":"742ms","/trigger":"","stacktrace":"github.com/tektoncd/triggers/pkg/sink.Sink.CreateResources\n\tgithub.com/tektoncd/triggers/pkg/sink/sink.go:274\ngithub.com/tektoncd/triggers/pkg/sink.Sink.processTrigger\n\tgithub.com/tektoncd/triggers/pkg/sink/sink.go:191\ngithub.com/tektoncd/triggers/pkg/sink.Sink.HandleEvent.func1\n\tgithub.com/tektoncd/triggers/pkg/sink/sink.go:101"}
        {"level":"error","ts":"2020-11-10T16:58:02.248Z","logger":"eventlistener","caller":"sink/sink.go:192","msg":"couldn't unmarshal json: invalid character 'k' after object key:value pair","knative.dev/controller":"eventlistener","/triggers-eventid":"742ms","/trigger":"","stacktrace":"github.com/tektoncd/triggers/pkg/sink.Sink.processTrigger\n\tgithub.com/tektoncd/triggers/pkg/sink/sink.go:192\ngithub.com/tektoncd/triggers/pkg/sink.Sink.HandleEvent.func1\n\tgithub.com/tektoncd/triggers/pkg/sink/sink.go:101"}

[wlynch]

Overall looks good, just some small tweaks.

/lgtm

[wlynch]

Add a comment explaining what this controls, when it can be removed, etc.

[wlynch]

This primarily focuses on what the old behavior was, but doesn't really explain what the current behavior is. Let's add some more details here.

[bigkevmcd]

I'm not sure what to put here, the strings are no longer escaped at all, which means that it's up to you to put the correct quoting around params if you expect the values to be quoted or not.

[dibyom]

One thing that could be useful is an example of what a templated JSON body would look like now and with the annotation. something like- previously or with the annotation {\"foo\": \"bar\"} and while now it will be {"foo": "bar"}

[dibyom]

Looks good. One question -- if I am using a TriggerTemplate that is embedded inside a Trigger resource, can I still use the annotation on the Trigger resource itself or does this only apply TriggerTemplates used via reference?

[tekton-robot]

The following is the coverage report on the affected files.
Say /test pull-tekton-triggers-go-coverage to re-run this coverage report

File	Old Coverage	New Coverage	Delta
pkg/template/resource.go	98.3%	98.3%	0.0

[dibyom]

can I still use the annotation on the Trigger resource itself or does this only apply TriggerTemplates used via reference?

It doesn't work for embedded trigger templates yet but at the WG we decided this would be fine to start off with. We can add the annotation support for embedded templates if users ask for it.

[dibyom]

/approve
/lgtm

[tekton-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: dibyom

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [dibyom]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment