Add YAML template extension

[vojtechszocs]

This PR makes yamlTemplates in public/models/yaml-templates.ts extensible.

const plugin: Plugin<YAMLTemplate> = [
  {
    type: 'YAMLTemplate',
    properties: {
      model: FooBarModel,
      template: `
apiVersion: ${FooBarModel.apiVersion}
kind: ${FooBarModel.kind}
metadata:
  name: example
  namespace: default
`,
    },
  },
];

Note: due to how multi-line template literals work, leading whitespace within the template string should be removed.

It's also possible to pass a templateName (falls back to default if not specified):

const plugin: Plugin<YAMLTemplate> = [
  {
    type: 'YAMLTemplate',
    properties: {
      model: FooBarModel,
      template: '...',
      templateName: 'fb-compute',
    },
  },
];

Attempts to redefine existing templates (based on tuple key [modelRef, templateName]) will be logged and the conflicting templates will be discarded.

const plugin: Plugin<YAMLTemplate> = [
  {
    type: 'YAMLTemplate',
    properties: {
      model: PodModel,
      template: '...',
    },
  },
];

attempt to redefine YAML template default for model core~v1~Pod

[vojtechszocs]

FYI @mareklibra @jtomasek

[vojtechszocs]

/cc @spadgett

[mareklibra]

What about throwing and Error? IMO, this conflict should be avoided.

[vojtechszocs]

This code gets referenced & evaluated very early during Console startup.

Consequently, throwing an Error here will effectively break the whole application - just a blank page with error stack trace shown in the browser console. This is not the behavior we want.

In good browsers, console.warn and console.error provide you with a link to source code (based on source maps) if you want to investigate the issue.

[christianvogt]

This should be caught at build time.
@vojtechszocs and I talked about fixing this situation by creating unit tests to avoid duplicates and therefore can avoid this type of runtime validation.

[vojtechszocs]

Fresh rebase on top of #1586

[vojtechszocs]

Just realized this should be YAMLTemplate to match current naming conventions, will update.

[vojtechszocs]

PR updated & added packages/console-demo-plugin/src/yaml-templates.ts to encourage plugin developers to keep their YAML templates in a dedicated module.

[vojtechszocs]

/retest

[christianvogt]

/lgtm

[spadgett]

/approve

[openshift-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: christianvogt, spadgett, vojtechszocs

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

The pull request process is described here

Details

Needs approval from an approver in each of these files:

• frontend/OWNERS [spadgett]

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