Use flow-go Components for composing #682

janezpodhostnik · 2024-11-27T19:26:54Z

Closes: onflow/flow-go#6776
Depends on: onflow/flow-go#6769

Description

Use flow-go component model and node framework to compose the Gatway and handle shutdown.

Main advantage is that the re-use of the component management system from flow-go automatically gives us nicer error handling an resource closing on error. To use the error handling, just make sure to use irrecoverable.SignalerContext.Throw(err) for any unexpected error. This will start the shutdown procedure and properly release all resources.

Changes:

api/profiler.go is now a component
api/server.go is now a component
bootstrap/bootstrap.go is changed a lot and is modeled after flow-go ExecutionNodeBuilder
bootstrap/utils.go were moved into services/requester/key_store_component.go which is a component that handles the keystore. It should have a Close for the KMS client, but the KMS client is currently not a io.Closer (which should be addresses)
cmd/run/cmd.go was simplified because the startup logic is now actually in flow-go
models/engine.go was removed because its no longer needed
models/stream.go was converted into a component. This lets it force shutdown the gateway in case of an error in Notify
services/ingestion/engine.go is now component. In case of errors in events processing it shuts down the node.

This depends on onflow/flow-go#6769

For contributor use:

Targeted PR against master branch
Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
Code follows the standards mentioned here.
Updated relevant documentation
Re-reviewed Files changed in the Github PR explorer
Added appropriate labels

coderabbitai · 2024-11-27T19:27:02Z

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

m-Peter · 2024-12-18T12:36:04Z

bootstrap/bootstrap.go

+	DB       *pebble.DB
+	Client   *requester.CrossSporkClient
+	Storages *Storages
+	// Signer is used for signing flow transactions


Suggested change

// Signer is used for signing flow transactions

m-Peter · 2024-12-18T12:39:34Z

bootstrap/bootstrap.go

+func (fnb *EVMGatewayNodeBuilder) apiServerComponent(cfg config.Config) (module.ReadyDoneAware, error) {
+	log := fnb.Logger
+
+	log.Info().Msg("bootstrap starting Metrics server")


Suggested change

log.Info().Msg("bootstrap starting Metrics server")

log.Info().Msg("bootstrap starting API server")

m-Peter

Nice 👏 👏 👏

peterargue

thanks for making this consistent with flow-go. will make it much easier to reason with.

a general comment about the component usage. In some places you used a component manager, and in others you wrote your own. I'm OK with custom handling where it's easier, but I think we should avoid non-idempotent Ready/Done methods

peterargue · 2024-12-18T20:38:52Z

api/profiler.go

 	server   *http.Server
 	endpoint string
+
+	startupCompleted chan struct{}


What do you think about using a component manager here? I think we should stick to the idempotent Ready()/Done() pattern.

peterargue · 2024-12-18T20:41:03Z

tests/integration_test.go

-	}()
-
-	<-ready
+	startGateway(t, ctx, cfg)


the previous version waited for Run to be called. should we wait for Ready() here?

peterargue · 2024-12-18T20:51:29Z

cmd/run/cmd.go


+		node, err := builder.Build()
+		if err != nil {
+			builder.Logger.Fatal().Err(err).Send()


Suggested change

builder.Logger.Fatal().Err(err).Send()

builder.Logger.Fatal().Err(err).Msg("failed to build node")

peterargue · 2024-12-18T20:51:38Z

cmd/run/cmd.go

-		case <-done:
-			log.Info().Msg("done, shutting down")
+		if err := builder.Initialize(); err != nil {
+			builder.Logger.Fatal().Err(err).Send()


Suggested change

builder.Logger.Fatal().Err(err).Send()

builder.Logger.Fatal().Err(err).Msg("failed to initialize node")

peterargue · 2024-12-18T20:55:36Z

bootstrap/bootstrap.go

+		return nil
+	})
+
+	return err


Suggested change

return err

return nil

peterargue · 2024-12-18T20:56:47Z

bootstrap/bootstrap.go

 	}
+	fnb.Logger.Info().Msg("database has been closed")


this belongs in the db shutdown callback

peterargue · 2024-12-18T20:57:45Z

bootstrap/bootstrap.go

+	fnb.Component("API Server", fnb.apiServerComponent)
+	fnb.Component("Event Ingestion Engine", fnb.eventIngestionEngineComponent)
+	fnb.Component("Metrics Server", fnb.metricsServerComponent)
+	fnb.Component("Profiler Server", fnb.profilerServerComponent)


nit: put profiles and metrics first so we can capture debug data during startup

peterargue · 2024-12-18T21:47:05Z

bootstrap/bootstrap.go

+		Uint64("start-cadence-height", latestCadenceHeight).
+		Uint64("latest-cadence-height", latestCadenceBlock.Height).


these names are confusing. consider renaming

peterargue · 2024-12-18T21:56:32Z

services/ingestion/engine.go

 			}
 			if events.Err != nil {
-				return fmt.Errorf(


why don't we need to handle this error anymore?

janezpodhostnik self-assigned this Nov 27, 2024

janezpodhostnik mentioned this pull request Nov 27, 2024

Expose node component management onflow/flow-go#6769

Open

janezpodhostnik force-pushed the janez/config-instance branch from 1d626c7 to a2386c1 Compare November 29, 2024 14:02

Base automatically changed from janez/config-instance to janez/switch-to-flow-go-metrics-server November 29, 2024 14:28

janezpodhostnik changed the base branch from janez/switch-to-flow-go-metrics-server to janez/config-instance-2 November 29, 2024 14:36

janezpodhostnik changed the base branch from janez/config-instance-2 to feature/local-tx-reexecution December 2, 2024 13:22

janezpodhostnik force-pushed the janez/use-flow-go-components branch from 33d6278 to 67136f9 Compare December 2, 2024 15:11

janezpodhostnik force-pushed the janez/use-flow-go-components branch 4 times, most recently from 9e3947b to 50d77d2 Compare December 16, 2024 15:17

janezpodhostnik marked this pull request as ready for review December 16, 2024 15:17

janezpodhostnik requested review from peterargue, m-Peter and zhangchiqing as code owners December 16, 2024 15:17

j1010001 added the Improvement label Dec 16, 2024

m-Peter force-pushed the feature/local-tx-reexecution branch from 2121836 to a746c82 Compare December 18, 2024 11:30

m-Peter reviewed Dec 18, 2024

View reviewed changes

m-Peter approved these changes Dec 18, 2024

View reviewed changes

janezpodhostnik added 8 commits December 18, 2024 17:57

Use flow-go Components for composing

7b6bf22

fix stream tests

4f9b51f

update flow-go

b5de26d

update tests

c3fb296

fix tests and rebase

e7181ce

fix rebase

16c6a3c

fix remaining tests

fa4847d

apply review comments

453f201

janezpodhostnik force-pushed the janez/use-flow-go-components branch from 87a1102 to 453f201 Compare December 18, 2024 17:01

peterargue reviewed Dec 18, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use flow-go Components for composing #682

Use flow-go Components for composing #682

janezpodhostnik commented Nov 27, 2024 •

edited

Loading

coderabbitai bot commented Nov 27, 2024 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

m-Peter Dec 18, 2024

m-Peter Dec 18, 2024

m-Peter left a comment

peterargue left a comment

peterargue Dec 18, 2024

peterargue Dec 18, 2024

peterargue Dec 18, 2024

peterargue Dec 18, 2024

peterargue Dec 18, 2024

peterargue Dec 18, 2024

peterargue Dec 18, 2024

peterargue Dec 18, 2024

peterargue Dec 18, 2024

	log.Info().Msg("bootstrap starting Metrics server")
	log.Info().Msg("bootstrap starting API server")

	builder.Logger.Fatal().Err(err).Send()
	builder.Logger.Fatal().Err(err).Msg("failed to build node")

		Uint64("start-cadence-height", latestCadenceHeight).
		Uint64("latest-cadence-height", latestCadenceBlock.Height).

Use flow-go Components for composing #682

Are you sure you want to change the base?

Use flow-go Components for composing #682

Conversation

janezpodhostnik commented Nov 27, 2024 • edited Loading

Description

coderabbitai bot commented Nov 27, 2024 • edited Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-Peter left a comment

Choose a reason for hiding this comment

peterargue left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

janezpodhostnik commented Nov 27, 2024 •

edited

Loading

coderabbitai bot commented Nov 27, 2024 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)