feat: introduce the new BaseServiceV2 class by smartcontracts · Pull Request #2210 · ethereum-optimism/optimism

smartcontracts · 2022-02-14T00:20:08Z

Description
This PR introduces a new BaseServiceV2 class. BaseServiceV2 is a more advanced version of the original BaseService class with the following key advantages over the original:

BaseServiceV2 automatically picks names of environment variables and command-line arguments based on the service's defined options.
BaseServiceV2 automatically pulls inputs from the environment, .env files, and command-line arguments as well as the normal options object passed to the service constructor. This means that services based on BaseServiceV2 can be started without an extra boilerplate run.ts file that parses variables.
BaseServiceV2 requires that all options come with validators so inputs can be checked before the service starts. No more input validation outside of the service.
BaseServiceV2 has built-in looping, removing the need to include looping logic within every long-running service (but still has the option to only run once with loop: false).
BaseServiceV2 includes an optional init function that allows services to run once-on-init logic reliably.

changeset-bot · 2022-02-14T00:20:10Z

🦋 Changeset detected

Latest commit: 860fef4

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

This PR includes changesets to release 5 packages

Name	Type
@eth-optimism/message-relayer	Minor
@eth-optimism/common-ts	Patch
@eth-optimism/sdk	Patch
@eth-optimism/data-transport-layer	Patch
@eth-optimism/replica-healthcheck	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

codecov-commenter · 2022-02-14T00:30:26Z

Codecov Report

Merging #2210 (947783d) into develop (51a527b) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff            @@
##           develop    #2210   +/-   ##
========================================
  Coverage    80.08%   80.08%           
========================================
  Files           77       77           
  Lines         2460     2460           
  Branches       450      450           
========================================
  Hits          1970     1970           
  Misses         490      490

Flag	Coverage Δ
contracts	`99.29% <ø> (ø)`
core-utils	`86.77% <ø> (ø)`
data-transport-layer	`49.72% <ø> (ø)`
sdk	`55.75% <ø> (ø)`

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
packages/sdk/src/interfaces/types.ts	`100.00% <ø> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 51a527b...947783d. Read the comment docs.

smartcontracts · 2022-02-14T00:29:24Z

packages/message-relayer/bin/run.ts

-
-dotenv.config()
-
-const main = async () => {


We can entirely cut out this configuration and execution file because the new base service handles all of this for us.

packages/common-ts/src/base-service/base-service-v2.ts

smartcontracts · 2022-02-14T00:30:42Z

packages/message-relayer/src/service.ts

-      await sleep(this.options.pollingInterval)
+  protected async main(): Promise<void> {
+    // If we're already at the tip, then update the latest tip and loop again.
+    if (this.state.highestCheckedL2Tx > this.state.highestKnownL2Tx) {


I reimplemented this to take advantage of the fact that the base service now loops around main() by default, meaning we don't need to do our own looping logic.

smartcontracts · 2022-02-14T00:31:17Z

packages/message-relayer/src/service.ts

  }
 }
+
+if (require.main === module) {


Adding this small piece of boilerplate means the service can be run by directly executing this file.

packages/common-ts/src/base-service/base-service-v2.ts

smartcontracts · 2022-02-14T00:35:09Z

packages/common-ts/src/base-service/base-service-v2.ts

+   * @param params.options Options to pass to the service.
+   * @param params.loops Whether or not the service should loop. Defaults to true.
+   * @param params.loopIntervalMs Loop interval in milliseconds. Defaults to zero.
+   */


Note to self: I'd like a nice way of handling "service containers" -- groups of services that run together. Not sure of the best way to represent this. I'm not particularly happy with the current thing of running a service that runs other services.

tynes · 2022-03-04T15:19:32Z

packages/common-ts/src/base-service/base-service-v2.ts

+    const program = new Command()
+    for (const [optionName, optionSpec] of Object.entries(params.optionsSpec)) {
+      program.addOption(
+        new Option(`--${optionName.toLowerCase()}`, `${optionSpec.desc}`).env(


note that this can be done with bcfg to remove a dep

https://github.com/handshake-org/hsd/blob/9c00cff71a3daf06baad2bb2ec23fe9a437a9998/lib/node/node.js#L38
https://github.com/handshake-org/hsd/blob/9c00cff71a3daf06baad2bb2ec23fe9a437a9998/lib/node/node.js#L45

I don't think you need to define upfront bcfg which config options there are

I did it with commander mainly so that I could get the --help command by default (you can run ts-node ./path/to/service --help and get useful help info).

Inphi

LGTM!

Inphi · 2022-03-07T19:15:39Z

packages/common-ts/src/base-service/base-service-v2.ts

+  public run(): void {
+    const _run = async () => {
+      if (this.init) {
+        this.logger.info('initializing service')


Does the logger indicate which service is being initialized? This would be pretty useful info to have.

Yeah the logger includes the name of the service in each log line, so it will be clear which service is being initialized.

netlify · 2022-03-07T21:58:27Z

✔️ Deploy Preview for optimism-sdk ready!

🔨 Explore the source changes: 2b36e73

🔍 Inspect the deploy log: https://app.netlify.com/sites/optimism-sdk/deploys/62267ffe81944400086ed6e2

😎 Browse the preview: https://deploy-preview-2210--optimism-sdk.netlify.app

Introduces the new BaseServiceV2 class to eventually replace the older BaseService class. BaseServiceV2 includes many convenience features like automatic environment variable and argv parsing.

ProviderLike is too loose because it allows "any" to be ProviderLike. This tightens the type to only include strings or ethers.Provider objects.

Rewrites the message-relayer service to use BaseServiceV2. Significantly reduces the footprint of the message-relayer and enforces stronger input validation.

github-actions bot added the 2-reviewers label Feb 14, 2022

smartcontracts commented Feb 14, 2022

View reviewed changes

smartcontracts force-pushed the sc/base-service-v2 branch from a6c949b to 2bf9a98 Compare February 14, 2022 19:50

github-actions bot added the A-pkg-sdk Area: packages/sdk label Feb 16, 2022

smartcontracts force-pushed the sc/base-service-v2 branch 2 times, most recently from 93fc39e to 38a5944 Compare February 19, 2022 20:37

github-actions bot added the M-contracts label Feb 19, 2022

smartcontracts force-pushed the sc/base-service-v2 branch from 38a5944 to 6acf7c1 Compare March 3, 2022 23:49

smartcontracts marked this pull request as ready for review March 3, 2022 23:50

smartcontracts force-pushed the sc/base-service-v2 branch 2 times, most recently from cd82e91 to 04e44a4 Compare March 4, 2022 00:24

github-actions bot added the A-ops Area: ops label Mar 4, 2022

tynes reviewed Mar 4, 2022

View reviewed changes

Inphi approved these changes Mar 7, 2022

View reviewed changes

smartcontracts mentioned this pull request Mar 7, 2022

fix(mr): update README to reflect latest version #2276

Merged

smartcontracts force-pushed the sc/base-service-v2 branch 2 times, most recently from f26a017 to 947783d Compare March 7, 2022 20:05

mslipper approved these changes Mar 7, 2022

View reviewed changes

smartcontracts force-pushed the sc/base-service-v2 branch from 947783d to 2b36e73 Compare March 7, 2022 21:58

smartcontracts added 3 commits March 7, 2022 21:25

feat: introduces the new BaseServiceV2 class

e53b578

Introduces the new BaseServiceV2 class to eventually replace the older BaseService class. BaseServiceV2 includes many convenience features like automatic environment variable and argv parsing.

fix: tighten ProviderLike SDK typings

47e5d11

ProviderLike is too loose because it allows "any" to be ProviderLike. This tightens the type to only include strings or ethers.Provider objects.

feat: rewrite relayer with BaseServiceV2

860fef4

Rewrites the message-relayer service to use BaseServiceV2. Significantly reduces the footprint of the message-relayer and enforces stronger input validation.

smartcontracts force-pushed the sc/base-service-v2 branch from 2b36e73 to 860fef4 Compare March 8, 2022 02:25

smartcontracts merged commit 61ec2ca into develop Mar 8, 2022

smartcontracts deleted the sc/base-service-v2 branch March 8, 2022 02:53

Conversation

smartcontracts commented Feb 14, 2022

Uh oh!

changeset-bot bot commented Feb 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

codecov-commenter commented Feb 14, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tynes Mar 4, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Inphi left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

netlify bot commented Mar 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

changeset-bot bot commented Feb 14, 2022 •

edited

Loading

codecov-commenter commented Feb 14, 2022 •

edited

Loading

tynes Mar 4, 2022 •

edited

Loading

netlify bot commented Mar 7, 2022 •

edited

Loading