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

cleanup crypto utils #838

Merged
merged 8 commits into from
Aug 20, 2024
Merged

cleanup crypto utils #838

merged 8 commits into from
Aug 20, 2024

Conversation

shamilovtim
Copy link
Contributor

@shamilovtim shamilovtim commented Aug 13, 2024

  • fixes a bug in the codecov yml where the config was not being respected
  • bump the codecov action version
  • exports the crypto utils only one way through the CryptoUtils namespace (rather than 3 different ways)
  • deletes a few unused methods

* cleanup crypto utils

* changeset

* Update index.ts

* finish: delete package.json utils export
Copy link

changeset-bot bot commented Aug 13, 2024

🦋 Changeset detected

Latest commit: 918c97c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 9 packages
Name Type
@web5/crypto-aws-kms Patch
@web5/identity-agent Patch
@web5/credentials Patch
@web5/proxy-agent Patch
@web5/user-agent Patch
@web5/crypto Patch
@web5/agent Patch
@web5/dids Patch
@web5/api Patch

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

Copy link
Contributor

github-actions bot commented Aug 13, 2024

TBDocs Report

🛑 Errors: 0
⚠️ Warnings: 5

@web5/api

  • Project entry file: packages/api/src/index.ts

@web5/crypto

  • Project entry file: packages/crypto/src/index.ts
📄 File: ./packages/crypto/src/utils.ts
⚠️ extractor:typedoc:missing-docs: CryptoUtils (Variable) does not have any documentation.
⚠️ extractor:typedoc:missing-docs: CryptoUtils.__type.randomPin (Property) does not have any documentation.
⚠️ extractor:typedoc:missing-docs: CryptoUtils.__type.randomUuid (Property) does not have any documentation.
⚠️ extractor:typedoc:missing-docs: CryptoUtils.__type.randomBytes (Property) does not have any documentation.
⚠️ extractor:typedoc:missing-docs: CryptoUtils.__type.getJoseSignatureAlgorithmFromPublicKey (Property) does not have any documentation.

@web5/crypto-aws-kms

  • Project entry file: packages/crypto-aws-kms/src/index.ts

@web5/dids

  • Project entry file: packages/dids/src/index.ts

@web5/credentials

  • Project entry file: packages/credentials/src/index.ts

TBDocs Report Updated at 2024-08-19T17:41:13Z 918c97c

Copy link

codecov bot commented Aug 16, 2024

Codecov Report

Attention: Patch coverage is 92.85714% with 2 lines in your changes missing coverage. Please review.

Project coverage is 93.27%. Comparing base (0862ffc) to head (918c97c).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #838      +/-   ##
==========================================
- Coverage   93.30%   93.27%   -0.03%     
==========================================
  Files         115      115              
  Lines       32555    32447     -108     
  Branches     2560     2547      -13     
==========================================
- Hits        30374    30266     -108     
  Misses       2143     2143              
  Partials       38       38              
Components Coverage Δ
agent 86.88% <88.88%> (ø)
api 99.53% <ø> (ø)
common 98.68% <ø> (ø)
credentials 94.95% <100.00%> (ø)
crypto 93.79% <100.00%> (-0.10%) ⬇️
dids 97.77% <100.00%> (ø)
identity-agent 96.42% <ø> (ø)
crypto-aws-kms 100.00% <ø> (ø)
proxy-agent 96.42% <ø> (ø)
user-agent 96.42% <ø> (ø)

Copy link
Member

@LiranCohen LiranCohen left a comment

Choose a reason for hiding this comment

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

Just a question about the codecov change.

Any idea why the type docs aren't picking up for those CryptoUtils methods? I see there are comments above them.

- type: patch
target: 90
informational: true
if_ci_failed: success
Copy link
Member

Choose a reason for hiding this comment

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

Why is this being done again? Can this be removed to a different PR that's in scope?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

It's the same lines that are already in the config copy pasted to a different spot because the config was broken and not doing inheritance correctly

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Any idea why the type docs aren't picking up for those CryptoUtils methods? I see there are comments above them.

Because the tbdocs thing is broken. It relies on typedoc internals that no longer function on newer typescript / typedoc versions. From what I can tell it was an incubation project that got adopted on a couple of repos and we should probably just tear it out

Copy link
Contributor Author

Choose a reason for hiding this comment

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

but FYI that's unrelated to this PR. I'm just trying to standardize one way of importing crypto utils here

@shamilovtim shamilovtim merged commit 2d0b423 into main Aug 20, 2024
35 checks passed
@shamilovtim shamilovtim deleted the tshamilov/crypto-exports-fixes branch August 20, 2024 15:56
@github-actions github-actions bot mentioned this pull request Aug 19, 2024
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.

2 participants