Skip to content

BC-9076 Move documentation to seperate docu repo.#5557

Merged
CeEv merged 8 commits intomainfrom
BC-9076-move-documentation
Mar 13, 2025
Merged

BC-9076 Move documentation to seperate docu repo.#5557
CeEv merged 8 commits intomainfrom
BC-9076-move-documentation

Conversation

@CeEv
Copy link
Contributor

@CeEv CeEv commented Mar 5, 2025

Description

Links to Tickets or other pull requests

Approval for review

  • DEV: If api was changed - generate-client:server was executed in vue frontend and changes were tested and put in a PR with the same branch name.
  • QA: In addition to review, the code has been manually tested (if manual testing is possible)
  • All points were discussed with the ticket creator, support-team or product owner. The code upholds all quality guidelines from the PR-template.

@CeEv CeEv self-assigned this Mar 11, 2025
@CeEv CeEv enabled auto-merge (squash) March 11, 2025 15:24
@CeEv CeEv removed the request for review from bischofmax March 13, 2025 07:44
@sonarqubecloud
Copy link

@CeEv CeEv merged commit eb5f88d into main Mar 13, 2025
77 checks passed
@CeEv CeEv deleted the BC-9076-move-documentation branch March 13, 2025 08:39
constructor(private readonly config: T) {}

public set(key: K, value: T[K]): void {
if (Object.prototype.hasOwnProperty.call(this.config, key)) {
Copy link
Contributor

@uidp uidp Mar 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this runtime-check really necessary? Or can we just rely on the type of the config (which basically defines which properties exist)?
Besides that: Wouldn't be this.config.hasOwnProperty() sufficient? Why the additional function binding?

@@ -0,0 +1,20 @@
export class TestConfigHelper<T, K extends keyof T = Extract<keyof T, string>> {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure about the name suffix Helper. Can we just call the class TestConfig?

export class TestConfigHelper<T, K extends keyof T = Extract<keyof T, string>> {
private originConfigs = new Map<K, T[K]>();

constructor(private readonly config: T) {}
Copy link
Contributor

@uidp uidp Mar 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As I understand the purpose of this class is to first initialize a test configuration and then later be able to reset it to its initial state? If that's the case wouldn't it be a good idea when we copy the initial config to originalConfig in the constructor? The copy in the set() method is quite hard to understand IMHO.

@@ -0,0 +1,20 @@
export class TestConfigHelper<T, K extends keyof T = Extract<keyof T, string>> {
private originConfigs = new Map<K, T[K]>();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would suggest to use the singular originalConfig.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Development

Successfully merging this pull request may close these issues.

3 participants