feature/2422 implement onlyPublished optional param to filter retrieved journeys

[yuliialikhyt]

PR details

What changes did you make? (Give an overview)

Added a new optional parameter for the retrieve function. If --onlyPublished is true, the published version of the journeys is retrieved.

• closes [FEATURE] Retrieve last published version of the journeys #2422

Further details (optional)

...

Checklist

• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• test scripts updated
• Wiki updated (if applicable)

[github-actions]

Coverage Report

Commit:4f95da3
Base: develop@c314d04

Type	Base	This PR
Total Statements Coverage	71.02%	71%  (-0.02%)
Total Branches Coverage	70.8%	70.81%  (+0.01%)
Total Functions Coverage	83.71%	83.71%  (+0%)
Total Lines Coverage	71.02%	71%  (-0.02%)

Details (changed files):

File	Statements	Branches	Functions	Lines
lib/cli.js	0%	0%	0%	0%
lib/index.js	70.64%	64.98%	77.08%	70.64%
lib/metadataTypes/Journey.js	68.71%	67.2%	96%	68.71%

[yuliialikhyt]

Suggested documentation updates

---

retrieve

Command: mcdev retrieve [business unit] [metadata type] [metadata key] [--like] [--metadata] [--format] [--no-format] [--purge] [--onlyPublished]

...

retrieve only published version of journeys with --onlyPublished option:

This optional parameter can be used with the retrieve command when retrieving journeys. When specified, only published versions of journeys are retrieved. If a journey does not have a published version, no version of that journey is retrieved.

Examples:

mcdev retrieve MyProject/DEV journey --onlyPublished
mcdev r cred/bu -m journey:name:myName --onlyPublished
mcdev r cred/bu journey "key" --onlyPublished

[JoernBerkefeld]

somehow this didnt work. had a look into fixing this but couldnt find a quick one´. do you wanna push it forward or shall I?

[yuliialikhyt]

somehow this didnt work. had a look into fixing this but couldnt find a quick one´. do you wanna push it forward or shall I?

Would you be able to take a look on your end? It retrieved only journeys with the status Published when I ran it on my end. Without the filter, it retrieves over 800 journeys. I also looked up by status in the search, I can see only Published status

[JoernBerkefeld]

ok, now i see the difference:

when i tried this, i did so by trying to retrieve a single journey, specified by name and key respectively. your test did a retrieve without name or key.

mcdev r cred/bu -m journey --onlyPublished # works 
mcdev r cred/bu -m journey:myKey --onlyPublished # does not work
mcdev r cred/bu -m journey:name:myName --onlyPublished # does not work 

[yuliialikhyt]

@JoernBerkefeld I couldn't get the API endpoint to work when the key or the id has been specified. It just ignores the query param and retrieves the latest version. So for single key/id retrieve if the onlyPublished param is enabled, retrieve retrieves all published journeys and then finds the one the user asked for and retrieves that journey version with activities.

mcdev r cred/bu -m journey:name:myName --onlyPublished
mcdev r cred/bu -m journey --onlyPublished
mcdev r cred/bu journey "key" --onlyPublished
mcdev r cred/bu journey "id" --onlyPublished
mcdev r cred/bu -m journey:journey:%23 --onlyPublished
mcdev r cred/bu -m journey:journey:%23/ --onlyPublished (disregards the version and retrieves the published version)

[JoernBerkefeld]

few minor changes - i took the liberty of providing commit-ready options for you.

fyi: i removed the inline /** @type {object} */ because it wasnt flagged on my computer as missing when i tried removing it locally - and it didnt add much value.

[JoernBerkefeld]

Thank you for your good work & effort @yuliialikhyt ❤️