Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

test(test-tooling): fix circular deps, sample-cordapp const enum export #3394

Conversation

petermetz
Copy link
Member

  1. This issue started out from the SampleCordappEnum problem where in
    some test cases it was being undefined instead of the actual string values
    that are defined for it's properties.
  2. Suggestions on the internet said that if your enum is undefined after
    importing it then it's most likely a circular dependency problem.
  3. So on that clue, I added a script that checks the entire project for
    Typescript circular dependencies and fixed one that was present in the
    test-tooling package (there hundreds more in other packages...)
  4. Ultimately though this did not help with the original issue which was
    solved by simply removing the "const" modifier from the enum's declaration.
    This way the compiled .js sources retain the actual values defined for the
    enum instead of the compiler completely eliminating them.

Signed-off-by: Peter Somogyvari [email protected]

Pull Request Requirements

  • Rebased onto upstream/main branch and squashed into single commit to help maintainers review it more efficient and to avoid spaghetti git commit graphs that obfuscate which commit did exactly what change, when and, why.
  • Have git sign off at the end of commit message to avoid being marked red. You can add -s flag when using git commit command. You may refer to this link for more information.
  • Follow the Commit Linting specification. You may refer to this link for more information.

Character Limit

  • Pull Request Title and Commit Subject must not exceed 72 characters (including spaces and special characters).
  • Commit Message per line must not exceed 80 characters (including spaces and special characters).

A Must Read for Beginners
For rebasing and squashing, here's a must read guide for beginners.

1. This issue started out from the SampleCordappEnum problem where in
some test cases it was being undefined instead of the actual string values
that are defined for it's properties.
2. Suggestions on the internet said that if your enum is undefined after
importing it then it's most likely a circular dependency problem.
3. So on that clue, I added a script that checks the entire project for
Typescript circular dependencies and fixed one that was present in the
test-tooling package (there hundreds more in other packages...)
4. Ultimately though this did not help with the original issue which was
solved by simply removing the "const" modifier from the enum's declaration.
This way the compiled .js sources retain the actual values defined for the
enum instead of the compiler completely eliminating them.

Signed-off-by: Peter Somogyvari <[email protected]>
@petermetz petermetz force-pushed the ci-add-circular-typescript-dependency-check branch from e6fd933 to 5a828b0 Compare July 11, 2024 00:28
Copy link
Contributor

@jagpreetsinghsasan jagpreetsinghsasan left a comment

Choose a reason for hiding this comment

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

LGTM

@petermetz petermetz merged commit f75d60e into hyperledger:main Jul 11, 2024
137 of 146 checks passed
@petermetz petermetz deleted the ci-add-circular-typescript-dependency-check branch July 11, 2024 03:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants