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(cleanup): big cleanup #752

Merged
merged 5 commits into from
Dec 5, 2024
Merged

chore(cleanup): big cleanup #752

merged 5 commits into from
Dec 5, 2024

Conversation

TheDivic
Copy link
Collaborator

@TheDivic TheDivic commented Dec 3, 2024

📖 Context

Type of change

  • Non-breaking change (backwards compatible)

Why are we doing this?

  • We had a lot of dead, legacy code, config files and various junk
  • Tests suites were breaking and I was unable to add my new tests
  • There were side effects causing tests to fail
  • We had no smoke or e2e tests

What did we do?

  • Cleanup dead code, unused files, broken tests, unnecessary config variables etc.
  • Added new config variables to disable features in tests that cause side effects
  • Wrote minimal e2e & smoke tests

Also some additional smaller changes to the devenv:

  • Fix docker volumes so node_modules are not synced with the container
  • Make nodemon use tsx instead of ts-node because it transpiles faster
  • Delete some dead chains
  • Add a "smoke test" that calls the health checks to make sure my RPC URLs were working.
  • Update the docker-compose file

How Has This Been Tested?

  • Compiles, unit, e2e & smoke tests pass without error

Cleanup dead code, unused files, broken tests, unnecessary config varaibles etc
@TheDivic TheDivic added the 🧹 Chore Catch-all label for all boring tasks that can't be classified into any other category label Dec 3, 2024
@TheDivic TheDivic self-assigned this Dec 3, 2024
fichiokaku
fichiokaku previously approved these changes Dec 3, 2024
throw new Error(
"Slack token or channel name for relayer node is not present in slack configuration",
);
// if (!this.web) {
Copy link
Contributor

Choose a reason for hiding this comment

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

why is this hanging?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I'm removing the SlackNotification service from the Bundler completely since it's not working anyway and I don't want to send notifications from code but use an external alerting system

Remove the deprecated 'version' tag, update redis to latest & rename the service to 'bundler' as it
should be
…e side effects

Stuff like funding relayers, validating the config, checking the relayers that we don't want to do
in tests for example

BREAKING CHANGE: Make sure you never change these variables in production, their default values are
the correct ones
Smoke tests atm just check the health of a target bundler instance, e2e tests actually require a
private key and funds to perform the full user opration flow. Refer to the docstrings and .env to
see how to use them
@TheDivic TheDivic merged commit 6629fb8 into master Dec 5, 2024
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧹 Chore Catch-all label for all boring tasks that can't be classified into any other category
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants