Method ServeModule

engine/server/session.go:1516–1563

Stitch in the given module to the list being served to the current client. When includeDependencies is true, dependency modules and toolchains are also served with their constructors on the Query root. When entrypoint is true, the module's main-object methods are promoted onto the Query root.

(ctx context.Context, mod dagql.ObjectResult[*core.Module], includeDependencies bool, entrypoint bool)

// When entrypoint is true, the module's main-object methods are promoted
// onto the Query root.
func (srv *Server) ServeModule(ctx context.Context, mod dagql.ObjectResult[*core.Module], includeDependencies bool, entrypoint bool) error {
	client, err := srv.clientFromContext(ctx)
	if err != nil {
		return err
	}

	client.stateMu.Lock()
	defer client.stateMu.Unlock()

	if err := srv.serveModule(client, core.NewUserMod(mod), core.InstallOpts{Entrypoint: entrypoint}); err != nil {
		return err
	}
	if includeDependencies {
		for _, dep := range mod.Self().Deps.Mods() {
			if err := srv.serveModule(client, dep, core.InstallOpts{}); err != nil {
				return fmt.Errorf("error serving dependency %s: %w", dep.Name(), err)
			}
		}

		// Also serve toolchains so their functions are available in the
		// client schema (e.g. when `dagger shell` `.cd`s into a module).
		if mod.Self().Source.Valid && mod.Self().Source.Value.Self() != nil {
			src := mod.Self().Source.Value
			defaultPathContextSrc := src
			if mod.Self().ContextSource.Valid && mod.Self().ContextSource.Value.Self() != nil {
				defaultPathContextSrc = mod.Self().ContextSource.Value
			}
			for i, tcSrc := range src.Self().Toolchains {
				if tcSrc.Self() == nil {
					continue
				}
				var cfg *modules.ModuleConfigDependency
				if i < len(src.Self().ConfigToolchains) {
					cfg = src.Self().ConfigToolchains[i]
				}
				pending := pendingRelatedModule(defaultPathContextSrc, tcSrc.Self(), cfg, false)
				tcMod, err := srv.resolveModuleSourceAsModule(ctx, client.dag, tcSrc, pending)
				if err != nil {
					return fmt.Errorf("error resolving toolchain module: %w", err)
				}
				if err := srv.serveModule(client, core.NewUserMod(tcMod), core.InstallOpts{}); err != nil {
					return fmt.Errorf("error serving toolchain %s: %w", tcMod.Self().Name(), err)
				}
			}
		}
	}
	return nil
}

// serveModule adds a module to the client's served set with the given install
// policy.