Skip to content

Commit 58d5891

Browse files
author
AbstractionFactory
authored
Merge branch 'main' into registry-docs
Signed-off-by: AbstractionFactory <[email protected]>
2 parents b8c6fb9 + c1d6aaf commit 58d5891

File tree

6 files changed

+222
-191
lines changed

6 files changed

+222
-191
lines changed

‎backend/go.mod

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ require (
99
github.com/go-enry/go-license-detector/v4 v4.3.1
1010
github.com/lib/pq v1.10.9
1111
github.com/mitchellh/go-spdx v0.1.0
12-
github.com/opentofu/libregistry v0.0.0-20240911130704-36ad231a7168
12+
github.com/opentofu/libregistry v0.0.0-20241009085434-a0be829febc1
1313
github.com/opentofu/tofudl v0.0.0-20240730151408-3bd8529dae09
1414
github.com/opentofu/tofutestutils v0.0.0-20240821111804-5fcfb797e0a7
1515
golang.org/x/sync v0.8.0

‎backend/go.sum

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,8 @@ github.com/opentofu/libregistry v0.0.0-20240911094842-bfb6ed3cfb33 h1:NWhgKmeTGQ
235235
github.com/opentofu/libregistry v0.0.0-20240911094842-bfb6ed3cfb33/go.mod h1:irS/XyfQZdwi3Ggm105FfDyj3d9deFAi5GraORIeMsI=
236236
github.com/opentofu/libregistry v0.0.0-20240911130704-36ad231a7168 h1:2bwgWOJ90nzGuDeQFY6EBA/T6R3C3rnXYw7VFMURQnM=
237237
github.com/opentofu/libregistry v0.0.0-20240911130704-36ad231a7168/go.mod h1:irS/XyfQZdwi3Ggm105FfDyj3d9deFAi5GraORIeMsI=
238+
github.com/opentofu/libregistry v0.0.0-20241009085434-a0be829febc1 h1:1wc2S/a7GvWGI8uQ+njrTdHNsnPRC76M+AXBqcIrdEY=
239+
github.com/opentofu/libregistry v0.0.0-20241009085434-a0be829febc1/go.mod h1:irS/XyfQZdwi3Ggm105FfDyj3d9deFAi5GraORIeMsI=
238240
github.com/opentofu/registry-address v0.0.0-20230922120653-901b9ae4061a h1:NyM/PPbc+kxxv2d4OKfE32C5fLtVTLceyg4YKKCYO9Y=
239241
github.com/opentofu/registry-address v0.0.0-20230922120653-901b9ae4061a/go.mod h1:HzQhpVo/NJnGmN+7FPECCVCA5ijU7AUcvf39enBKYOc=
240242
github.com/opentofu/tofudl v0.0.0-20240730151408-3bd8529dae09 h1:bA3Dy3Be9o896wdcQhK0Ky2Eco0ZwCWZgt73dSaYuDI=

‎backend/internal/moduleindex/generator.go

Lines changed: 42 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import (
1111
"os"
1212
"path"
1313
"slices"
14+
"strings"
1415
"sync"
1516
"text/template"
1617
"time"
@@ -348,7 +349,12 @@ func (g generator) generate(ctx context.Context, moduleList []module.Addr, block
348349
}
349350
for _, m := range modules.Modules {
350351
if err := m.Validate(); err != nil {
351-
return fmt.Errorf("invalid module (%w)", err)
352+
// We are ignoring invalid version numbers here because the dataset contains them, but when a module is
353+
// refreshed, it should be excluded above.
354+
var invalidVersionNumber *module.InvalidVersionNumber
355+
if !errors.As(err, &invalidVersionNumber) {
356+
return fmt.Errorf("invalid module (%w)", err)
357+
}
352358
}
353359
}
354360
marshalled, err := json.Marshal(modules)
@@ -433,7 +439,7 @@ func (g generator) generateModuleVersion(ctx context.Context, moduleAddr ModuleA
433439
}
434440

435441
g.log.Info(ctx, "Updating module details for %s version %s...", moduleAddr, ver.ID)
436-
if err := g.refreshModuleDetails(ctx, moduleAddr, ver, &result.Details, workingCopy, licenseOK, entry.IsBlocked, entry.BlockedReason, ""); err != nil {
442+
if err := g.refreshModuleDetails(ctx, moduleAddr, ver, &result.Details, workingCopy, licenseOK, entry.IsBlocked, entry.BlockedReason, "", ""); err != nil {
437443
return fmt.Errorf("failed to extract module defaults for %s version %s (%w)", moduleAddr, ver.ID, err)
438444
}
439445

@@ -471,9 +477,9 @@ func (g generator) refreshLicense(ctx context.Context, moduleAddr ModuleAddr, mo
471477
return err
472478
}
473479

474-
func (g generator) refreshModuleDetails(ctx context.Context, moduleAddr ModuleAddr, ver ModuleVersionDescriptor, d *Details, workingCopy vcs.WorkingCopy, licenseOK bool, blocked bool, blockedReason string, prefix string) error {
480+
func (g generator) refreshModuleDetails(ctx context.Context, moduleAddr ModuleAddr, ver ModuleVersionDescriptor, d *Details, workingCopy vcs.WorkingCopy, licenseOK bool, blocked bool, blockedReason string, sourcePrefix string, dstPrefix string) error {
475481
var err error
476-
if d.Readme, d.EditLink, err = g.extractReadme(ctx, moduleAddr, ver, workingCopy, licenseOK, blocked, blockedReason, prefix); err != nil {
482+
if d.Readme, d.EditLink, err = g.extractReadme(ctx, moduleAddr, ver, workingCopy, licenseOK, blocked, blockedReason, sourcePrefix, dstPrefix); err != nil {
477483
return err
478484
}
479485

@@ -484,17 +490,17 @@ func (g generator) refreshModuleDetails(ctx context.Context, moduleAddr ModuleAd
484490
return nil
485491
}
486492

487-
dir := path.Join(rawDirectory, prefix)
493+
dir := path.Join(rawDirectory, sourcePrefix)
488494
if err := g.extractModuleSchema(ctx, dir, d, licenseOK, blocked); err != nil {
489495
return err
490496
}
491497

492498
return nil
493499
}
494500

495-
func (g generator) refreshExampleDetails(ctx context.Context, moduleAddr ModuleAddr, ver ModuleVersionDescriptor, e *Example, workingCopy vcs.WorkingCopy, licenseOK bool, blocked bool, blockedReason string, prefix string) error {
501+
func (g generator) refreshExampleDetails(ctx context.Context, moduleAddr ModuleAddr, ver ModuleVersionDescriptor, e *Example, workingCopy vcs.WorkingCopy, licenseOK bool, blocked bool, blockedReason string, sourcePrefix string, dstPrefix string) error {
496502
var err error
497-
if e.Readme, e.EditLink, err = g.extractReadme(ctx, moduleAddr, ver, workingCopy, licenseOK, blocked, blockedReason, prefix); err != nil {
503+
if e.Readme, e.EditLink, err = g.extractReadme(ctx, moduleAddr, ver, workingCopy, licenseOK, blocked, blockedReason, sourcePrefix, dstPrefix); err != nil {
498504
return err
499505
}
500506

@@ -505,18 +511,18 @@ func (g generator) refreshExampleDetails(ctx context.Context, moduleAddr ModuleA
505511
return nil
506512
}
507513

508-
dir := path.Join(rawDirectory, prefix)
514+
dir := path.Join(rawDirectory, sourcePrefix)
509515
if err := g.extractExampleSchema(ctx, dir, e, licenseOK, blocked); err != nil {
510516
return err
511517
}
512518

513519
return nil
514520
}
515521

516-
func (g generator) extractReadme(ctx context.Context, moduleAddr ModuleAddr, ver ModuleVersionDescriptor, workingCopy vcs.WorkingCopy, licenseOK bool, blocked bool, blockedReason string, prefix string) (bool, string, error) {
522+
func (g generator) extractReadme(ctx context.Context, moduleAddr ModuleAddr, ver ModuleVersionDescriptor, workingCopy vcs.WorkingCopy, licenseOK bool, blocked bool, blockedReason string, sourcePrefix string, dstPrefix string) (bool, string, error) {
517523
hasReadme := false
518524
var readme []byte
519-
sourcePath := path.Join(prefix, "README.md")
525+
sourcePath := path.Join(sourcePrefix, "README.md")
520526
fh, err := workingCopy.Open(sourcePath)
521527
if err != nil {
522528
if os.IsNotExist(err) {
@@ -544,8 +550,8 @@ func (g generator) extractReadme(ctx context.Context, moduleAddr ModuleAddr, ver
544550
_ = fh.Close()
545551
}
546552
readmePath := path.Join(moduleAddr.Namespace, moduleAddr.Name, moduleAddr.TargetSystem, string(ver.ID), "README.md")
547-
if prefix != "" {
548-
readmePath = path.Join(moduleAddr.Namespace, moduleAddr.Name, moduleAddr.TargetSystem, string(ver.ID), prefix, "README.md")
553+
if dstPrefix != "" {
554+
readmePath = path.Join(moduleAddr.Namespace, moduleAddr.Name, moduleAddr.TargetSystem, string(ver.ID), dstPrefix, "README.md")
549555
}
550556
if err := g.storage.WriteFile(ctx, indexstorage.Path(readmePath), readme); err != nil {
551557
return hasReadme, "", fmt.Errorf("failed to write README.md at %s (%w)", readmePath, err)
@@ -593,9 +599,15 @@ func (g generator) extractSubmodules(ctx context.Context, addr ModuleAddr, ver M
593599
Resources: []Resource{},
594600
},
595601
}
596-
submodulePrefix := path.Join(directoryPrefix, name)
597-
if err := g.refreshModuleDetails(ctx, addr, ver, &submodule.Details, workingCopy, licenseOK, blocked, blockedReason, submodulePrefix); err != nil {
598-
return fmt.Errorf("failed to refresh details for submodule %s (%w)", submodulePrefix, err)
602+
sourcePrefix := path.Join(directoryPrefix, name)
603+
dstPrefix, err := g.sanitizePath(directoryPrefix, name)
604+
if err != nil {
605+
// Invalid path, ignore.
606+
g.log.Warn(ctx, "Failed to index %s version %s submodule %s (%v)", addr, ver.ID, dstPrefix, err)
607+
continue
608+
}
609+
if err := g.refreshModuleDetails(ctx, addr, ver, &submodule.Details, workingCopy, licenseOK, blocked, blockedReason, sourcePrefix, dstPrefix); err != nil {
610+
return fmt.Errorf("failed to refresh details for submodule %s (%w)", sourcePrefix, err)
599611
}
600612

601613
m.Submodules[name] = submodule
@@ -630,7 +642,13 @@ func (g generator) extractExamples(ctx context.Context, moduleAddr ModuleAddr, v
630642
Outputs: map[string]Output{},
631643
},
632644
}
633-
examplePrefix := path.Join(directoryPrefix, name)
645+
srcPrefix := path.Join(directoryPrefix, name)
646+
dstPrefix, err := g.sanitizePath(directoryPrefix, name)
647+
if err != nil {
648+
// Invalid path, don't include in the index
649+
g.log.Warn(ctx, "Failed to index %s version %s example %s (%v)", moduleAddr, ver.ID, dstPrefix, err)
650+
continue
651+
}
634652
if err := g.refreshExampleDetails(
635653
ctx,
636654
moduleAddr,
@@ -640,9 +658,10 @@ func (g generator) extractExamples(ctx context.Context, moduleAddr ModuleAddr, v
640658
licenseOK,
641659
blocked,
642660
blockedReason,
643-
examplePrefix,
661+
srcPrefix,
662+
dstPrefix,
644663
); err != nil {
645-
return fmt.Errorf("failed to refresh details for example %s (%w)", examplePrefix, err)
664+
return fmt.Errorf("failed to refresh details for example %s (%w)", srcPrefix, err)
646665
}
647666

648667
m.Examples[name] = example
@@ -806,3 +825,8 @@ func (g generator) fetchRepoInfo(ctx context.Context, entry *Module) {
806825
entry.UpstreamPopularity = upstreamRepoInfo.Popularity
807826
entry.UpstreamForkCount = upstreamRepoInfo.ForkCount
808827
}
828+
829+
func (g generator) sanitizePath(prefix string, name string) (string, error) {
830+
name = strings.ReplaceAll(name, " ", "")
831+
return path.Join(prefix, name), indexstorage.Path(name).Validate()
832+
}

‎frontend/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@
5757
"unified": "^11.0.5",
5858
"unplugin-macros": "^0.13.3",
5959
"vfile-matter": "^5.0.0",
60-
"vite": "^5.4.2",
60+
"vite": "^5.4.6",
6161
"vite-tsconfig-paths": "^5.0.1"
6262
},
6363
"devDependencies": {

0 commit comments

Comments
 (0)