commands

Documentation

Index

• type Context
  • func (c *Context) ClearCachedNode()
  • func (c *Context) Close()
  • func (c *Context) Context() context.Context
  • func (c *Context) GetAPI() (coreiface.CoreAPI, error)
  • func (c *Context) GetConfig() (*config.Config, error)
  • func (c *Context) GetNode() (*core.IpfsNode, error)
  • func (c *Context) LogRequest(req *cmds.Request) func()
• type ReqLog
  • func (rl *ReqLog) AddEntry(rle *ReqLogEntry)
  • func (rl *ReqLog) ClearInactive()
  • func (rl *ReqLog) Finish(rle *ReqLogEntry)
  • func (rl *ReqLog) Report() []*ReqLogEntry
  • func (rl *ReqLog) SetKeepTime(t time.Duration)
• type ReqLogEntry
  • func (r *ReqLogEntry) Copy() *ReqLogEntry

Types

type Context

type Context struct {
	ConfigRoot string
	ReqLog     *ReqLog

	Plugins *loader.PluginLoader

	Gateway bool

	ConstructNode func() (*core.IpfsNode, error)
	// contains filtered or unexported fields
}

Context represents request context.

func (*Context) ClearCachedNode

func (c *Context) ClearCachedNode()

ClearCachedNode clears any cached node, forcing GetNode to construct a new one.

This method is critical for mitigating racy FX dependency injection behavior that can occur during daemon startup. The daemon may create multiple IpfsNode instances during initialization - first an offline node during early init, then the proper online daemon node. Without clearing the cache, HTTP RPC handlers may end up using the first (offline) cached node instead of the intended online daemon node.

This behavior was likely present forever in go-ipfs, but recent changes made it more prominent and forced us to proactively mitigate FX shortcomings. The daemon calls this method immediately before setting its ConstructNode function to ensure that subsequent GetNode() calls use the correct online daemon node rather than any stale cached offline node from initialization.

func (*Context) Close

func (c *Context) Close()

Close cleans up the application state.

func (*Context) Context

func (c *Context) Context() context.Context

Context returns the node's context.

func (*Context) GetAPI

func (c *Context) GetAPI() (coreiface.CoreAPI, error)

GetAPI returns CoreAPI instance backed by ipfs node. It may construct the node with the provided function.

func (*Context) GetConfig

func (c *Context) GetConfig() (*config.Config, error)

func (*Context) GetNode

func (c *Context) GetNode() (*core.IpfsNode, error)

GetNode returns the node of the current Command execution context. It may construct it with the provided function.

func (*Context) LogRequest

func (c *Context) LogRequest(req *cmds.Request) func()

LogRequest adds the passed request to the request log and returns a function that should be called when the request lifetime is over.

type ReqLog

type ReqLog struct {
	Requests []*ReqLogEntry
	// contains filtered or unexported fields
}

ReqLog is a log of requests.

func (*ReqLog) AddEntry

func (rl *ReqLog) AddEntry(rle *ReqLogEntry)

AddEntry adds an entry to the log.

func (*ReqLog) ClearInactive

func (rl *ReqLog) ClearInactive()

ClearInactive removes stale entries.

func (*ReqLog) Finish

func (rl *ReqLog) Finish(rle *ReqLogEntry)

Finish marks an entry in the log as finished.

func (*ReqLog) Report

func (rl *ReqLog) Report() []*ReqLogEntry

Report generates a copy of all the entries in the requestlog.

func (*ReqLog) SetKeepTime

func (rl *ReqLog) SetKeepTime(t time.Duration)

SetKeepTime sets a duration after which an entry will be considered inactive.

type ReqLogEntry

type ReqLogEntry struct {
	StartTime time.Time
	EndTime   time.Time
	Active    bool
	Command   string
	Options   map[string]interface{}
	Args      []string
	ID        int
	// contains filtered or unexported fields
}

ReqLogEntry is an entry in the request log.

func (*ReqLogEntry) Copy

func (r *ReqLogEntry) Copy() *ReqLogEntry

Copy returns a copy of the ReqLogEntry.