Feature/90 add option to change the key #876

JoernBerkefeld · 2023-04-22T10:52:17Z

PR details

What changes did you make? (Give an overview)

closes [FEATURE] add option to rename the key #90

To-Dos

generic solution

generic solution with --changeKeyField
generic solution with --changeKeyValue

custom solutions (types have custom `createOrUpdate` and/or `upsert` logic)

test all types for compatibility:

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 (in part via [TASK] write tests for #90 / changeKeyX #890)
Wiki updated (via [TASK] update documentation for 5.0.0 release #722)

github-actions · 2023-04-22T10:53:34Z

Coverage Report

Commit: 1b78136
Base: develop@ed70fc0

Type	Base	This PR
Total Statements Coverage	40.81%	40.9% (+0.09%)
Total Branches Coverage	31.75%	32.43% (+0.68%)
Total Functions Coverage	46.35%	47.17% (+0.82%)
Total Lines Coverage	40.77%	40.84% (+0.07%)

Details (changed testable files):

File	Statements	Branches	Functions	Lines
lib/Deployer.js	63.53%	54.63%	71.42%	63.88%
lib/cli.js	0%	0%	0%	0%
lib/index.js	41.01%	35.06%	43.47%	41.01%
lib/metadataTypes/DataExtension.js	68.93%	57.05%	82.6%	69.16%
lib/metadataTypes/DataExtensionField.js	58.41%	55.1%	66.66%	58%
lib/metadataTypes/Journey.js	52.31%	39.43%	92.3%	52.31%
lib/metadataTypes/MetadataType.js	61.38%	59.82%	71.25%	61.15%
lib/metadataTypes/MobileKeyword.js	81.01%	58.33%	88.88%	80.76%
lib/metadataTypes/MobileMessage.js	79.43%	55.76%	100%	79.24%
lib/util/cli.js	22.79%	21.73%	13.04%	22.89%
lib/util/util.js	58.4%	44.53%	77.77%	57.72%

…ude generic createOrUpdate()

…tension names

originally, we were not including the ObjectID in our update callout which breaks renaming the key

…tension key at the same time

…rt updating the key

previous version also worked. seemed like a good choice nonetheless

…ssible null for types without deploy capability

…eve folder after deploy for mobileX

lib/metadataTypes/definitions/MobileCode.definition.js

… this point and dont know better

… error

…o user

JoernBerkefeld added 4 commits April 22, 2023 11:16

#90: add new CLI options to deploy method

937f7fd

#90: equalize try-catch in soap and rest methods

a4ed58a

#90: add generic error checks for --changeKeyValue

948acc0

Merge branch 'develop' into feature/90-add-option-to-rename-the-key

6eef879

JoernBerkefeld added the c/Generic label Apr 22, 2023

JoernBerkefeld added this to the 5.0.0 milestone Apr 22, 2023

JoernBerkefeld self-assigned this Apr 22, 2023

github-actions bot added the enhancement New feature or request; requires increasing the minor version of mcdev. Jira issue-type "Story" label Apr 22, 2023

JoernBerkefeld added 10 commits April 22, 2023 13:02

#90: adding generic changeKeyField logic

6516e7d

#90: adding generic changeKeyField logic

c1aeee6

#90: adding generic changeKeyValue logic

8ace3e5

#90: fix order of execution of logs vs field overwrite

e670f50

#90: ensure we dont set a key with leading or trailing spaces

bb76633

Merge branch 'develop' into feature/90-add-option-to-rename-the-key

5d72e71

#90: delete metadata with prior key-value after --changeKeyX ran

b518b82

#90: improved variable name

6d62408

#90: block types from changeKey that use their ID as key

96275f8

Merge branch 'develop' into feature/90-add-option-to-rename-the-key

e9e2fa2

JoernBerkefeld linked an issue Apr 27, 2023 that may be closed by this pull request

[FEATURE] add option to rename the key #90

Closed

JoernBerkefeld added 10 commits April 28, 2023 00:04

#90: refactoring

10ceb5e

#90: bringing dataExtension.upsert closer to generic version and incl…

b9456f9

…ude generic createOrUpdate()

#90: adjust dataExtension test to be standard testing scheme compliant

ecb68d3

#90: upgrade tests with new "prefix" market variable & changed dataEx…

0b5e36e

…tension names

#90: improve visibility on missing test files via exitCode 404

bfd173f

#90: renaming and 404 code

e631056

#90: add test placeholders

7b7150e

#90: refactoring

b20afab

#90: refactoring

b142d2e

#90: enable changeKey for dataExtension, emailSend and triggeredSend

00db266

originally, we were not including the ObjectID in our update callout which breaks renaming the key

JoernBerkefeld added 4 commits April 28, 2023 13:38

#90: fix MD file not getting deleted on changeKeyX and delete

9cbc185

#90: refactoring

0052f91

#90: ensure fields are listed and MD file is created after changeKeyX

9d9afc4

#90: ensure we dont try to update dataExtension fields AND the dataEx…

2bf9e57

…tension key at the same time

JoernBerkefeld changed the title ~~Feature/90 add option to rename the key~~ Feature/90 add option to change the key Apr 28, 2023

JoernBerkefeld added 11 commits April 28, 2023 16:51

#90: introduce keyIsFixed to easily signal that a type does not suppo…

9e5b347

…rt updating the key

#90: refactoring

bca3d0b

#90: switch to id-specific version of update-API

fa22b0c

previous version also worked. seemed like a good choice nonetheless

#90: adapt journey update-test to new key-based endpoint

ecaaa3a

#90: add changeKey to the explainTypes --json response

ac507e6

#90: introduce definition.keyIsFixed to signal key changes are not po…

0413b3f

…ssible null for types without deploy capability

#90: changeKeyX type support specified via definition.keyIsFixed

b5b22e7

#90: enabling changeKeyX for mobileKeyword and fixing update to retri…

f859999

…eve folder after deploy for mobileX

#90: enhancing explainTypes.changeKey check

7cb9280

#90: ensuring changeKey never sets a key longer than 36 chars

a0f8941

#90: changeKeyX type support specified via definition.keyIsFixed

9c15b5b

JoernBerkefeld commented May 3, 2023

View reviewed changes

lib/metadataTypes/definitions/MobileCode.definition.js Outdated Show resolved Hide resolved

JoernBerkefeld requested a review from DougMidgley May 4, 2023 06:27

JoernBerkefeld added 5 commits May 4, 2023 09:43

#90: change keyIsFixed back to null because we dont support update at…

65a6615

… this point and dont know better

#90: sort changeKey tests into warn and error and stop deployments on…

d7fc7f3

… error

#90: tests for --changeKeyX

42eff4f

#90: ensure explainTypes adheres to loggerLevel

11c1809

#0: ensure wrong entries in .mcdevrc.json are properly communicated t…

a7bb591

…o user

JoernBerkefeld mentioned this pull request May 4, 2023

[TASK] update documentation for 5.0.0 release #722

Closed

JoernBerkefeld added 2 commits May 4, 2023 16:11

#90: added buildTemplate to json output

77ca06d

#90: adapted test to property rename default to retrieveByDefault

1b78136

JoernBerkefeld merged commit e3e237e into develop May 4, 2023

JoernBerkefeld deleted the feature/90-add-option-to-rename-the-key branch May 4, 2023 14:44

github-actions bot mentioned this pull request May 4, 2023

[FEATURE] add option to rename the key #90

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feature/90 add option to change the key #876

Feature/90 add option to change the key #876

JoernBerkefeld commented Apr 22, 2023 •

edited

Loading

github-actions bot commented Apr 22, 2023 •

edited

Loading

Feature/90 add option to change the key #876

Feature/90 add option to change the key #876

Conversation

JoernBerkefeld commented Apr 22, 2023 • edited Loading

PR details

What changes did you make? (Give an overview)

To-Dos

generic solution

custom solutions (types have custom createOrUpdate and/or upsert logic)

test all types for compatibility:

Checklist

github-actions bot commented Apr 22, 2023 • edited Loading

Coverage Report

JoernBerkefeld commented Apr 22, 2023 •

edited

Loading

custom solutions (types have custom `createOrUpdate` and/or `upsert` logic)

github-actions bot commented Apr 22, 2023 •

edited

Loading