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

chore: fix dokka issues execution oom #1479

Closed
wants to merge 11 commits into from
Closed

Conversation

yamilmedina
Copy link
Contributor

@yamilmedina yamilmedina commented Feb 10, 2023


PR Submission Checklist for internal contributors

  • The PR Title

    • conforms to the style of semantic commits messages¹ supported in Wire's Github Workflow²
    • contains a reference JIRA issue number like SQPIT-764
    • answers the question: If merged, this PR will: ... ³
  • The PR Description

    • is free of optional paragraphs and you have filled the relevant parts to the best of your ability

What's new in this PR?

Issues

If we run Dokka with stacktrace flag, we found out that is failing because of something similiar to Kotlin/dokka#1405
So this PR tries to solve by suggested actions mentioned there.

  • Disabled samples
  • Increase memory metaspace and heap for gradle

PR Post Submission Checklist for internal contributors (Optional)

  • Wire's Github Workflow has automatically linked the PR to a JIRA issue

PR Post Merge Checklist for internal contributors

  • If any soft of configuration variable was introduced by this PR, it has been added to the relevant documents and the CI jobs have been updated.

References
  1. https://sparkbox.com/foundry/semantic_commit_messages
  2. https://github.com/wireapp/.github#usage
  3. E.g. feat(conversation-list): Sort conversations by most emojis in the title #SQPIT-764.

@yamilmedina yamilmedina added WIP work in progress DO NOT MERGE labels Feb 10, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Feb 10, 2023

Unit Test Results

   333 files   -   6     333 suites   - 6   25s ⏱️ -51s
1 752 tests  - 17  1 656 ✔️  - 62  96 💤 +45  0 ±0 

Results for commit d14d30c. ± Comparison against base commit 912a6ab.

♻️ This comment has been updated with latest results.

@vitorhugods
Copy link
Member

It seems it fails mainly due to Unresolved reference: otr:

> Task :network:compileCommonMainKotlinMetadata
e: /Users/runner/work/kalium/kalium/network/src/commonMain/kotlin/com/wire/kalium/network/api/base/authenticated/message/EnvelopeProtoMapper.kt: (22, 33): Unresolved reference: otr

🤔 Curious about this one, considering it usually builds nicely

@vitorhugods
Copy link
Member

One thing is quite curious:

This problem started EXACTLY when we added darwin source sets for network, calling and logic IIRC

@yamilmedina
Copy link
Contributor Author

yamilmedina commented Feb 11, 2023

One thing is quite curious:

This problem started EXACTLY when we added darwin source sets for network, calling and logic IIRC

Yees ! exactly around that date started, the thing is Dokka seems to have failed in the past with memory management 😓 -like now, having a StackOverFlowError- so I opened also an issue there, just in case they can help us. Kotlin/dokka#2853

The other thing is to create many partials docs (this seems fine) but would be a bit overkill to merge it later, I think we still can try a couple of things more 🤞

@stale stale bot removed the stale label Feb 27, 2023
@codecov-commenter
Copy link

Codecov Report

Merging #1479 (d14d30c) into develop (912a6ab) will decrease coverage by 0.01%.
The diff coverage is 0.00%.

@@              Coverage Diff              @@
##             develop    #1479      +/-   ##
=============================================
- Coverage      52.76%   52.76%   -0.01%     
  Complexity      1392     1392              
=============================================
  Files            903      903              
  Lines          33421    33421              
  Branches        2927     2927              
=============================================
- Hits           17636    17634       -2     
- Misses         14619    14621       +2     
  Partials        1166     1166              

@yamilmedina
Copy link
Contributor Author

yamilmedina commented Apr 3, 2023

I think I'll close this one, as I tried we many approaches, some insights:

  • dokka is well known for having bad memory management
  • network module is causing a big pain
  • executing each task htmlPartial by itself in separate runs, doesn't brake it
  • because logic and cli modules depends on network, these modules never get to finish running or generating docs.
  • excluding cli, logic, and network make it "pass" but loses the point
  • maybe is worth taking a shot at https://github.com/adamko-dev/dokkatoo

@yamilmedina yamilmedina closed this Apr 3, 2023
@yamilmedina yamilmedina deleted the chore/dokka-issues branch April 3, 2023 16:48
@yamilmedina yamilmedina restored the chore/dokka-issues branch April 3, 2023 16:49
@yamilmedina yamilmedina deleted the chore/dokka-issues branch April 13, 2023 15:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants