Function NewNode

core/builder.go:61–147

Alias for compatibility until we properly refactor the constructor interface NewNode constructs and returns an IpfsNode using the given cfg.

(ctx context.Context, cfg *BuildCfg)

// NewNode constructs and returns an IpfsNode using the given cfg.
func NewNode(ctx context.Context, cfg *BuildCfg) (*IpfsNode, error) {
	// save this context as the "lifetime" ctx.
	lctx := ctx

	// derive a new context that ignores cancellations from the lifetime ctx.
	ctx, cancel := context.WithCancel(valueContext{ctx})

	// add a metrics scope.
	ctx = metrics.CtxScope(ctx, "ipfs")

	n := &IpfsNode{
		ctx: ctx,
	}

	opts := []fx.Option{
		node.IPFS(ctx, cfg),
		fx.NopLogger,
	}
	for _, optFunc := range fxOptionFuncs {
		var err error
		opts, err = optFunc(FXNodeInfo{FXOptions: opts})
		if err != nil {
			cancel()
			return nil, fmt.Errorf("building fx opts: %w", err)
		}
	}
	//nolint:staticcheck // https://github.com/ipfs/kubo/pull/9423#issuecomment-1341038770
	opts = append(opts, fx.Extract(n))

	app := fx.New(opts...)

	var once sync.Once
	var stopErr error
	n.stop = func() error {
		once.Do(func() {
			// Bound app.Stop with a deadline so an FX OnStop hook that
			// never returns cannot hang the daemon. ShutdownTimeout==0
			// opts out of the cap entirely and restores the legacy
			// behavior of waiting forever for hooks to complete. The
			// daemon's watchdog in cmd/ipfs/kubo/daemon.go fires at the
			// same deadline and is the unconditional os.Exit fallback.
			stopCtx := context.Background()
			if cfg.ShutdownTimeout > 0 {
				var stopCancel context.CancelFunc
				stopCtx, stopCancel = context.WithTimeout(stopCtx, cfg.ShutdownTimeout)
				defer stopCancel()
			}
			stopErr = app.Stop(stopCtx)
			if stopErr != nil {
				log.Errorf("failure on stop: %v", stopErr)
			}
			// Cancel the context _after_ the app has stopped.
			cancel()
		})
		return stopErr
	}
	n.IsOnline = cfg.Online