add fixKeys command / CSCLSROZ-29

[SabrinaEspino]

add fixKeys command that re-uses the --changeKeyField logic together with this.definition.nameField

this is a basic wrapper around --changeKeyField that searches for metadata of the given type with name/key mismatches.

Acceptance Criteria:

• types that cannot be used with this method are identified by:
  • use id as key (this.definition.keyField === this.definition.idField)
  • use the same field for name and key (this.definition.keyField === this.definition.nameField)
• this command should search offline --> do a full retrieve of the BU first before executing the actual find logic.
• after the key-change we need to then iterate over the definition/*.definition.js files to check for types that are dependent on the type you just fixed the keys for

out of scope:

• rewriting assets / scripts based on new key values (handled in [FEATURE] Rewrite scripts and assets after changeKeyField/Value or fixKeys was executed #1001)

basic steps:

1. retrieve selected type
2. find items with key != name (metadata[(this.definition.keyField] !== metadata[(this.definition.nameField])
3. run deploy cred/bu type --fromRetrieve --changeKeyField=${this.definition.nameField} on found keys for selected type
4. iterate over elements in lib\MetadataTypeDefinitions.js to check array in x.definition.dependencies for matches with the selected type
   • do notice that there are sometimes subtypes defined here as well, eg. "asset-message" --> if you applied fixKeys to "asset" then this would be a match
   • run full retrieve on types that have our selected type as a dependency to ensure that we have keys properly updated in our local folder

... the user then has to git add / commit & push on their own.

[JoernBerkefeld]

@phjulia - maybe interesting for you?

[phjulia]

@JoernBerkefeld
so basically mcdev fixKeys Project/BU type key? changeKeyField should be by default name? key and type are optional, but BU name is a required parameter

#1
mcdev fixKeys Project/BU type key

#2
mcdev fixKeys Project/BU type 

#3
mcdev fixKeys Project/BU

(3) would update the key to match the name in of all metadata of all types (where key can be updated)

[JoernBerkefeld]

Took the liberty of adding some formatting to your Post ;-)

Yes, in principle like that. Without type (=for all types), things might become problematic due to interdependencies.
To avoid needing to handle those, it might make sense to make type required.

Also, we should probably enforce a full retrieve of the chose type as a first part of what fixKeys does.

[github-actions]

Closed by #1022.

[github-actions]

Closed by #1062.

[github-actions]

Closed by #1064.

[github-actions]

Closed by #1067.