pkgsite: golang.org/x/pkgsite/internal Index | Files | Directories

package internal

import "golang.org/x/pkgsite/internal"

Package internal contains data used through x/pkgsite.

Index

Package Files

datasource.go discovery.go experiment.go legacy_discovery.go nonredist.go unit.go

Constants

const (
    // LatestVersion signifies the latest available version in requests to the
    // proxy client.
    LatestVersion = "latest"

    // MasterVersion signifies the version at master.
    MasterVersion = "master"

    // UnknownModulePath signifies that the module path for a given package
    // path is ambiguous or not known. This is because requests to the
    // frontend can come in the form of <import-path>[@<version>], and it is
    // not clear which part of the import-path is the module path.
    UnknownModulePath = "unknownModulePath"
)
const (
    ExperimentAutocomplete = "autocomplete"
    ExperimentSidenav      = "sidenav"
    ExperimentUnitPage     = "unit-page"
    ExperimentUseUnits     = "use-units"
)
const StringFieldMissing = "!MISSING"

StringFieldMissing is the value for string fields that are not present in a struct. We use it to distinguish a (possibly valid) empty string from a field that was never populated.

Variables

var Experiments = map[string]string{
    ExperimentAutocomplete: "Enable autocomplete with search.",
    ExperimentSidenav:      "Display documentation index on the left sidenav.",
    ExperimentUnitPage:     "Enable the redesigned details page.",
    ExperimentUseUnits:     "Read from paths, documentation, readmes, and package_imports tables.",
}

Experiments represents all of the active experiments in the codebase and a description of each experiment.

func SeriesPathForModule Uses

func SeriesPathForModule(modulePath string) string

SeriesPathForModule returns the series path for the provided modulePath.

func Suffix Uses

func Suffix(fullPath, basePath string) string

Suffix returns the suffix of the fullPath. It assumes that basePath is a prefix of fullPath. If fullPath and basePath are the same, the empty string is returned.

func V1Path Uses

func V1Path(fullPath, modulePath string) string

V1Path returns the path for version 1 of the package whose import path is fullPath. If modulePath is the standard library, then V1Path returns fullPath.

type DataSource Uses

type DataSource interface {

    // GetLatestMajorVersion returns the latest major version of a series path.
    GetLatestMajorVersion(ctx context.Context, seriesPath string) (_ string, err error)
    // GetNestedModules returns the latest major version of all nested modules
    // given a modulePath path prefix.
    GetNestedModules(ctx context.Context, modulePath string) ([]*ModuleInfo, error)
    // GetUnitMeta returns information about a path.
    GetUnitMeta(ctx context.Context, path, requestedModulePath, requestedVersion string) (_ *UnitMeta, err error)
    // GetUnit returns information about a directory, which may also be a module and/or package.
    // The module and version must both be known.
    GetUnit(ctx context.Context, pathInfo *UnitMeta, fields FieldSet) (_ *Unit, err error)

    // TODO(golang/go#39629): Deprecate these methods.
    //
    // LegacyGetDirectory returns packages whose import path is in a (possibly
    // nested) subdirectory of the given directory path. When multiple
    // package paths satisfy this query, it should prefer the module with
    // the longest path.
    LegacyGetDirectory(ctx context.Context, dirPath, modulePath, version string, fields FieldSet) (_ *LegacyDirectory, err error)
    // LegacyGetImports returns a slice of import paths imported by the package
    // specified by path and version.
    LegacyGetImports(ctx context.Context, pkgPath, modulePath, version string) ([]string, error)
    // LegacyGetLicenses returns licenses at the given path for given modulePath and version.
    LegacyGetLicenses(ctx context.Context, fullPath, modulePath, resolvedVersion string) ([]*licenses.License, error)
    // LegacyGetModuleInfo returns the LegacyModuleInfo corresponding to modulePath and
    // version.
    LegacyGetModuleInfo(ctx context.Context, modulePath, version string) (*LegacyModuleInfo, error)
    // LegacyGetModuleLicenses returns all top-level Licenses for the given modulePath
    // and version. (i.e., Licenses contained in the module root directory)
    LegacyGetModuleLicenses(ctx context.Context, modulePath, version string) ([]*licenses.License, error)
    // LegacyGetPackage returns the LegacyVersionedPackage corresponding to the given package
    // pkgPath, modulePath, and version. When multiple package paths satisfy this query, it
    // should prefer the module with the longest path.
    LegacyGetPackage(ctx context.Context, pkgPath, modulePath, version string) (*LegacyVersionedPackage, error)
    // LegacyGetPackagesInModule returns LegacyPackages contained in the module version
    // specified by modulePath and version.
    LegacyGetPackagesInModule(ctx context.Context, modulePath, version string) ([]*LegacyPackage, error)
    // LegacyGetPackageLicenses returns all Licenses that apply to pkgPath, within the
    // module version specified by modulePath and version.
    LegacyGetPackageLicenses(ctx context.Context, pkgPath, modulePath, version string) ([]*licenses.License, error)
    // LegacyGetPsuedoVersionsForModule returns ModuleInfo for all known
    // pseudo-versions for the module corresponding to modulePath.
    LegacyGetPsuedoVersionsForModule(ctx context.Context, modulePath string) ([]*ModuleInfo, error)
    // LegacyGetPsuedoVersionsForModule returns ModuleInfo for all known
    // pseudo-versions for any module containing a package with the given import
    // path.
    LegacyGetPsuedoVersionsForPackageSeries(ctx context.Context, pkgPath string) ([]*ModuleInfo, error)
    // LegacyGetTaggedVersionsForModule returns ModuleInfo for all known tagged
    // versions for the module corresponding to modulePath.
    LegacyGetTaggedVersionsForModule(ctx context.Context, modulePath string) ([]*ModuleInfo, error)
    // LegacyGetTaggedVersionsForModule returns ModuleInfo for all known tagged
    // versions for any module containing a package with the given import path.
    LegacyGetTaggedVersionsForPackageSeries(ctx context.Context, pkgPath string) ([]*ModuleInfo, error)
}

DataSource is the interface used by the frontend to interact with module data.

type Documentation Uses

type Documentation struct {
    // The values of the GOOS and GOARCH environment variables used to parse the
    // package.
    GOOS     string
    GOARCH   string
    Synopsis string
    HTML     safehtml.HTML
}

Documentation is the rendered documentation for a given package for a specific GOOS and GOARCH.

type Experiment Uses

type Experiment struct {

    // Name is the name of the feature.
    Name string

    // Rollout is the percentage of requests enrolled in the experiment.
    Rollout uint

    // Description provides a description of the experiment.
    Description string
}

Experiment holds data associated with an experimental feature for frontend or worker.

type FieldSet Uses

type FieldSet int64

A FieldSet is a bit set of struct fields. It is used to avoid reading large struct fields from the data store. FieldSet is also the type of the individual bit values. (Think of them as singleton sets.)

MinimalFields (the zero value) is the empty set. AllFields is the set containing every field.

FieldSet bits are unique across the entire project, because some types are concatenations (via embedding) of others. For example, a LegacyVersionedPackage contains the fields of both a LegacyModuleInfo and a LegacyPackage, so we can't use the same bits for both LegacyModuleInfo's LegacyReadmeContents field and LegacyPackage's DocumentationHTML field.

const (
    WithReadme FieldSet = 1 << iota
    WithDocumentation
    WithImports
    WithLicenses
    WithSubdirectories
)

FieldSet bits for fields that can be conditionally read from the data store.

const AllFields FieldSet = -1

AllFields is the FieldSet that contains all fields.

const MinimalFields FieldSet = 0

MinimalFields is the empty FieldSet.

type IndexVersion Uses

type IndexVersion struct {
    Path      string
    Version   string
    Timestamp time.Time
}

IndexVersion holds the version information returned by the module index.

type LegacyDirectory Uses

type LegacyDirectory struct {
    LegacyModuleInfo
    Path     string
    Packages []*LegacyPackage
}

LegacyDirectory represents a directory in a module version, and all of the packages inside that directory.

func (*LegacyDirectory) RemoveNonRedistributableData Uses

func (d *LegacyDirectory) RemoveNonRedistributableData()

type LegacyModuleInfo Uses

type LegacyModuleInfo struct {
    ModuleInfo
    LegacyReadmeFilePath string
    LegacyReadmeContents string
}

LegacyModuleInfo holds metadata associated with a module.

func (*LegacyModuleInfo) RemoveNonRedistributableData Uses

func (m *LegacyModuleInfo) RemoveNonRedistributableData()

type LegacyPackage Uses

type LegacyPackage struct {
    Path              string
    Name              string
    Synopsis          string
    IsRedistributable bool
    Licenses          []*licenses.Metadata // metadata of applicable licenses
    Imports           []string
    DocumentationHTML safehtml.HTML
    // The values of the GOOS and GOARCH environment variables used to parse the
    // package.
    GOOS   string
    GOARCH string

    // V1Path is the package path of a package with major version 1 in a given
    // series.
    V1Path string
}

A LegacyPackage is a group of one or more Go source files with the same package header. LegacyPackages are part of a module.

func (*LegacyPackage) RemoveNonRedistributableData Uses

func (p *LegacyPackage) RemoveNonRedistributableData()

type LegacyVersionedPackage Uses

type LegacyVersionedPackage struct {
    LegacyPackage
    LegacyModuleInfo
}

LegacyVersionedPackage is a LegacyPackage along with its corresponding module information.

func (*LegacyVersionedPackage) RemoveNonRedistributableData Uses

func (p *LegacyVersionedPackage) RemoveNonRedistributableData()

type Module Uses

type Module struct {
    LegacyModuleInfo
    // Licenses holds all licenses within this module version, including those
    // that may be contained in nested subdirectories.
    Licenses []*licenses.License
    Units    []*Unit

    LegacyPackages []*LegacyPackage
}

A Module is a specific, reproducible build of a module.

func (*Module) RemoveNonRedistributableData Uses

func (m *Module) RemoveNonRedistributableData()

type ModuleInfo Uses

type ModuleInfo struct {
    ModulePath        string
    Version           string
    CommitTime        time.Time
    IsRedistributable bool
    HasGoMod          bool // whether the module zip has a go.mod file
    SourceInfo        *source.Info
}

ModuleInfo holds metadata associated with a module.

func (*ModuleInfo) SeriesPath Uses

func (v *ModuleInfo) SeriesPath() string

SeriesPath returns the series path for the module.

A series is a group of modules that share the same base path and are assumed to be major-version variants.

The series path is the module path without the version. For most modules, this will be the module path for all module versions with major version 0 or 1. For gopkg.in modules, the series path does not correspond to any module version.

Examples: The module paths "a/b" and "a/b/v2" both have series path "a/b". The module paths "gopkg.in/yaml.v1" and "gopkg.in/yaml.v2" both have series path "gopkg.in/yaml".

type ModuleVersionState Uses

type ModuleVersionState struct {
    ModulePath string
    Version    string

    // IndexTimestamp is the timestamp received from the Index for this version,
    // which should correspond to the time this version was committed to the
    // Index.
    IndexTimestamp time.Time
    // CreatedAt is the time this version was originally inserted into the
    // module version state table.
    CreatedAt time.Time

    // Status is the most recent HTTP status code received from the Fetch service
    // for this version, or nil if no request to the fetch service has been made.
    Status int
    // Error is the most recent HTTP response body received from the Fetch
    // service, for a response with an unsuccessful status code. It is used for
    // debugging only, and has no semantic significance.
    Error string
    // TryCount is the number of times a fetch of this version has been
    // attempted.
    TryCount int
    // LastProcessedAt is the last time this version was updated with a result
    // from the fetch service.
    LastProcessedAt *time.Time
    // NextProcessedAfter is the next time a fetch for this version should be
    // attempted.
    NextProcessedAfter time.Time

    // AppVersion is the value of the GAE_VERSION environment variable, which is
    // set by app engine. It is a timestamp in the format 20190709t112655 that
    // is close to, but not the same as, the deployment time. For example, the
    // deployment time for the above timestamp might be Jul 9, 2019, 11:29:59 AM.
    AppVersion string

    // GoModPath is the path declared in the go.mod file.
    GoModPath string

    // NumPackages it the number of packages that were processed as part of the
    // module (regardless of whether the processing was successful).
    NumPackages *int
}

ModuleVersionState holds a worker module version state.

type PackageMeta Uses

type PackageMeta struct {
    Path              string
    Name              string
    Synopsis          string
    IsRedistributable bool
    Licenses          []*licenses.Metadata // metadata of applicable licenses
}

PackageMeta represents the metadata of a package in a module version.

func (*PackageMeta) RemoveNonRedistributableData Uses

func (p *PackageMeta) RemoveNonRedistributableData()

type PackageVersionState Uses

type PackageVersionState struct {
    PackagePath string
    ModulePath  string
    Version     string
    Status      int
    Error       string
}

PackageVersionState holds a worker package version state. It is associated with a given module version state.

type Readme Uses

type Readme struct {
    Filepath string
    Contents string
}

Readme is a README at the specified filepath.

type SearchResult Uses

type SearchResult struct {
    Name        string
    PackagePath string
    ModulePath  string
    Version     string
    Synopsis    string
    Licenses    []string

    CommitTime time.Time
    // Score is used to sort items in an array of SearchResult.
    Score float64

    // NumImportedBy is the number of packages that import PackagePath.
    NumImportedBy uint64

    // NumResults is the total number of packages that were returned for this
    // search.
    NumResults uint64
    // Approximate reports whether NumResults is an approximate count. NumResults
    // can be approximate if search scanned only a subset of documents, and
    // result count is estimated using the hyperloglog algorithm.
    Approximate bool
}

SearchResult represents a single search result from SearchDocuments.

type Unit Uses

type Unit struct {
    UnitMeta
    Readme          *Readme
    Documentation   *Documentation
    Subdirectories  []*PackageMeta
    Imports         []string
    LicenseContents []*licenses.License
}

Unit represents the contents of some path in the Go package/module namespace. It might be a module, a package, both a module and a package, or none of the above: a directory within a module that has no .go files, but contains other units, licenses and/or READMEs."

func (*Unit) RemoveNonRedistributableData Uses

func (u *Unit) RemoveNonRedistributableData()

type UnitMeta Uses

type UnitMeta struct {
    // Unit level information
    //
    Path              string
    Name              string
    IsRedistributable bool
    Licenses          []*licenses.Metadata

    // Module level information
    //
    Version    string
    ModulePath string
    CommitTime time.Time
    SourceInfo *source.Info
}

UnitMeta represents metadata about a unit.

func (*UnitMeta) IsCommand Uses

func (um *UnitMeta) IsCommand() bool

IsCommand reports whether the path represents a package path.

func (*UnitMeta) IsModule Uses

func (um *UnitMeta) IsModule() bool

IsModule reports whether the path represents a module path.

func (*UnitMeta) IsPackage Uses

func (um *UnitMeta) IsPackage() bool

IsPackage reports whether the path represents a package path.

type VersionMap Uses

type VersionMap struct {
    ModulePath       string
    RequestedVersion string
    ResolvedVersion  string
    GoModPath        string
    Status           int
    Error            string
    UpdatedAt        time.Time
}

VersionMap holds metadata associated with module queries for a version.

Directories

PathSynopsis
authPackage auth authorizes programs to make HTTP requests to the discovery site.
breakerPackage breaker implements the circuit breaker pattern.
completePackage complete defines a Completion type that is used in auto-completion, along with Encode and Decode methods that can be used for storing this type in redis.
configPackage config resolves shared configuration for Go Discovery services, and provides functions to access this configuration.
config/dynconfigPackage dynconfig supports dynamic configuration for pkgsite services.
databasePackage database adds some useful functionality to a sql.DB.
dcensusPackage dcensus provides functionality for debug instrumentation.
derrorsPackage derrors defines internal error values to categorize the different types error semantics we support.
experimentPackage experiment provides functionality for experiments.
fetchPackage fetch provides a way to fetch modules from a proxy.
fetch/dochtmlPackage dochtml renders Go package documentation into HTML.
fetch/dochtml/internal/renderPackage render formats Go documentation as HTML.
fetch/internal/docPackage doc extracts source code documentation from a Go AST.
frontendPackage frontend provides functionality for running the pkg.go.dev site.
godocPackage godoc returns a section of the dochtml, based on the template from internal/fetch/dochtml.
indexPackage index provides a client for communicating with the module index.
licensesPackage licenses detects licenses and determines whether they are redistributable.
logPackage log supports structured and unstructured logging with levels.
middlewarePackage middleware implements a simple middleware pattern for http handlers, along with implementations for some common middlewares.
postgresPackage postgres provides functionality for reading and writing to the postgres database.
proxyPackage proxy provides a client for interacting with a proxy.
proxydatasourcePackage proxydatasource implements an internal.DataSource backed solely by a proxy instance.
queuePackage queue provides queue implementations that can be used for asynchronous scheduling of fetch actions.
secretsPackage secrets is used to interact with secretmanager.
sourcePackage source constructs public URLs that link to the source files in a module.
stdlibPackage stdlib supports special handling of the Go standard library.
teeproxyPackage teeproxy provides functionality for running a service which tees traffic to pkg.go.dev.
testing/dbtestPackage dbtest supports testing with a database.
testing/htmlcheckPackage htmlcheck provides a set of functions that check for properties of a parsed HTML document.
testing/pagecheckPackage pagecheck implements HTML checkers for discovery site pages.
testing/samplePackage sample provides functionality for generating sample values of the types contained in the internal package.
testing/testhelperPackage testhelper provides shared functionality and constants to be used in Discovery tests.
versionPackage version handles version types.
workerPackage worker provides functionality for running a worker service.
xcontextPackage xcontext is a package to offer the extra functionality we need from contexts that is not available from the standard context package.

Package internal imports 9 packages (graph) and is imported by 20 packages. Updated 2020-09-29. Refresh now. Tools for package owners.