implement server-side redirects for @_exported paths

Author: tayloraswift

Sources/UnidocDB/Mongo.CollectionModel (ext).swift

@@ -2,9 +2,26 @@ import MongoDB
 
 //  TODO: we need to unify ``Unidoc.Scalar`` and ``Unidoc.Group`, most likely by introducing
 //  a new type ``Unidoc.Vertex``.
-extension Mongo.CollectionModel // where Element.ID == Unidoc.Scalar
+extension Mongo.CollectionModel where Element.ID == Unidoc.Scalar
 {
-    /// Deletes all records from the collection within the specified zone.
+    /// Deletes all records from the collection within the specified volume.
+    func deleteAll(in range:Unidoc.Edition) async throws
+    {
+        try await self.clear(range: range)
+    }
+}
+extension Mongo.CollectionModel where Element.ID == Unidoc.Group
+{
+    /// Deletes all records from the collection within the specified volume.
+    func deleteAll(in range:Unidoc.Edition) async throws
+    {
+        try await self.clear(range: range)
+    }
+}
+extension Mongo.CollectionModel
+{
+    /// Deletes all records from the collection within the specified volume.
+    private
     func clear(range:Unidoc.Edition) async throws
     {
         let response:Mongo.DeleteResponse = try await session.run(

Sources/UnidocDB/Unidoc.DB.swift

@@ -149,6 +149,12 @@ extension Unidoc.DB
         .init(database: self.id, session: self.session)
     }
 
+    @inlinable public
+    var redirects:Redirects
+    {
+        .init(database: self.id, session: self.session)
+    }
+
     @inlinable public
     var vertices:Vertices
     {
@@ -204,6 +210,7 @@ extension Unidoc.DB:Mongo.DatabaseModel
         try await self.packageDependencies.setup()
         try await self.editionDependencies.setup()
         try await self.volumes.setup()
+        try await self.redirects.setup()
         try await self.vertices.setup()
         try await self.groups.setup()
         try await self.search.setup()
@@ -575,9 +582,10 @@ extension Unidoc.DB
         try await self.editionDependencies.clear(dependent: volume.id)
         try await self.packageDependencies.clear(dependent: volume.id)
 
-        try await self.vertices.clear(range: volume.id)
-        try await self.groups.clear(range: volume.id)
-        try await self.trees.clear(range: volume.id)
+        try await self.redirects.deleteAll(in: volume.id)
+        try await self.vertices.deleteAll(in: volume.id)
+        try await self.groups.deleteAll(in: volume.id)
+        try await self.trees.deleteAll(in: volume.id)
 
         try await self.search.delete(id: volume.symbol)
         //  Delete this last, otherwise if one of the other steps fails, we won’t
@@ -661,6 +669,7 @@ extension Unidoc.DB
         try await self.search.insert(search)
         try await self.trees.insert(mesh.trees)
 
+        try await self.redirects.insert(mesh.redirects)
         try await self.vertices.insert(mesh.vertices)
         try await self.groups.insert(mesh.groups,
             realm: mesh.metadata.latest ? mesh.metadata.realm : nil)

Sources/UnidocDB/Vertices/Unidoc.DB.Redirects.swift

@@ -0,0 +1,60 @@
+import MongoDB
+import MongoQL
+import Unidoc
+import UnidocRecords
+
+extension Unidoc.DB
+{
+    @frozen public
+    struct Redirects
+    {
+        public
+        let database:Mongo.Database
+        public
+        let session:Mongo.Session
+
+        @inlinable
+        init(database:Mongo.Database, session:Mongo.Session)
+        {
+            self.database = database
+            self.session = session
+        }
+    }
+}
+extension Unidoc.DB.Redirects
+{
+    public static
+    let indexPaths:Mongo.CollectionIndex = .init("Paths",
+        collation: VolumeCollation.spec,
+        unique: true)
+    {
+        $0[Element[.id] / Unidoc.Redirect[.volume]] = (+)
+        $0[Element[.stem]] = (+)
+        $0[Element[.hash]] = (+)
+    }
+}
+extension Unidoc.DB.Redirects:Mongo.CollectionModel
+{
+    public
+    typealias Element = Unidoc.RedirectVertex
+
+    @inlinable public static
+    var name:Mongo.Collection { "VolumeRedirects" }
+
+    @inlinable public static
+    var indexes:[Mongo.CollectionIndex] { [ Self.indexPaths ] }
+}
+extension Unidoc.DB.Redirects:Mongo.RecodableModel
+{
+}
+extension Unidoc.DB.Redirects
+{
+    @discardableResult
+    func deleteAll(in volume:Unidoc.Edition) async throws -> Int
+    {
+        try await self.deleteAll
+        {
+            $0[Element[.id] / Unidoc.Redirect[.volume]] = volume
+        }
+    }
+}

Sources/UnidocDB/Vertices/Unidoc.Redirect (ext).swift

@@ -0,0 +1,6 @@
+import MongoQL
+import UnidocRecords
+
+extension Unidoc.Redirect:Mongo.MasterCodingModel
+{
+}

Sources/UnidocDB/Vertices/Unidoc.RedirectVertex (ext).swift

@@ -0,0 +1,6 @@
+import MongoQL
+import UnidocRecords
+
+extension Unidoc.RedirectVertex:Mongo.MasterCodingModel
+{
+}

Sources/UnidocLinker/Sema/Unidoc.Linker.Tables.swift

@@ -36,6 +36,7 @@ extension Unidoc.Linker
 
         private(set)
         var extensions:Unidoc.Linker.Table<Unidoc.Extension>
+        var redirects:[Unidoc.RedirectVertex]
         var articles:[Unidoc.ArticleVertex]
         var decls:[Unidoc.DeclVertex]
 
@@ -59,6 +60,7 @@ extension Unidoc.Linker
             self.next = .init(base: self.context.current.id)
 
             self.extensions = extensions
+            self.redirects = []
             self.articles = []
             self.decls = []
 
@@ -388,6 +390,10 @@ extension Unidoc.Linker.Tables
             {
                 self.link(articles: articles, under: namespace)
             }
+
+            //  Create redirects
+            self.redirect(decls: culture.reexports.unhashed, hashed: false, from: namespace)
+            self.redirect(decls: culture.reexports.hashed, hashed: true, from: namespace)
         }
 
         return self.modules.map
@@ -518,7 +524,7 @@ extension Unidoc.Linker.Tables
                     route: decl.route),
                 signature: decl.signature.map { self.current.scalars.decls[$0] },
                 symbol: symbol,
-                stem: .decl(namespace.module, decl.path, orientation: decl.phylum.orientation),
+                stem: .decl(namespace.module, decl.path, decl.phylum),
                 _requirements: [],
                 superforms: self.context.sort(superforms, by: Unidoc.SemanticPriority.self),
                 namespace: namespace.id,
@@ -548,4 +554,32 @@ extension Unidoc.Linker.Tables
 
         return miscellaneous
     }
+
+    private mutating
+    func redirect(decls:[Int32],
+        hashed:Bool,
+        from namespace:SymbolGraph.NamespaceContext<Void>)
+    {
+        for local:Int32 in decls
+        {
+            let symbol:Symbol.Decl = self.current.decls.symbols[local]
+
+            guard
+            let id:Unidoc.Scalar = self.current.scalars.decls[local],
+            let decl:SymbolGraph.Decl = self.context[decl: id]
+            else
+            {
+                continue
+            }
+
+            let redirect:Unidoc.RedirectVertex = .init(id: .init(
+                    volume: self.current.id,
+                    target: id),
+                stem: .decl(namespace.module, decl.path, decl.phylum),
+                hash: .decl(symbol),
+                hashed: hashed)
+
+            self.redirects.append(redirect)
+        }
+    }
 }

Sources/UnidocLinker/Sema/Unidoc.Linker.TreeMapper.swift

@@ -151,7 +151,7 @@ extension Unidoc.Linker.TreeMapper
                 phylum: decl.phylum,
                 kinks: decl.kinks,
                 route: decl.route),
-            stem: .decl(namespace, decl.path, orientation: decl.phylum.orientation),
+            stem: .decl(namespace, decl.path, decl.phylum),
             hash: .decl(symbol))
     }
 }

Sources/UnidocLinker/Sema/Unidoc.LinkerTables.swift

@@ -451,7 +451,7 @@ extension Unidoc.LinkerTables
                 route: decl.route),
             signature: decl.signature.map { self.current.scalars.decls[$0] },
             symbol: symbol,
-            stem: .decl(namespace.symbol, decl.path, orientation: decl.phylum.orientation),
+            stem: .decl(namespace.symbol, decl.path, decl.phylum),
             _requirements: [],
             superforms: self.linker.sort(superforms, by: Unidoc.SemanticPriority.self),
             namespace: namespace.colony,

Sources/UnidocLinker/Unidoc.Mesh.Interior.swift

@@ -17,17 +17,21 @@ extension Unidoc.Mesh
         var index:JSON
         public
         var trees:[Unidoc.TypeTree]
+        public
+        var redirects:[Unidoc.RedirectVertex]
 
         private
         init(vertices:Vertices,
             groups:Groups,
             index:JSON,
-            trees:[Unidoc.TypeTree])
+            trees:[Unidoc.TypeTree],
+            redirects:[Unidoc.RedirectVertex])
         {
             self.vertices = vertices
             self.groups = groups
             self.index = index
             self.trees = trees
+            self.redirects = redirects
         }
     }
 }
@@ -70,6 +74,7 @@ extension Unidoc.Mesh.Interior
         let products:[Unidoc.ProductVertex]
         let cultures:[Unidoc.CultureVertex]
 
+        let redirects:[Unidoc.RedirectVertex]
         let articles:[Unidoc.ArticleVertex]
         let decls:[Unidoc.DeclVertex]
         let groups:Unidoc.Mesh.Groups
@@ -82,6 +87,8 @@ extension Unidoc.Mesh.Interior
             conformances = tables.linkConformingTypes()
             products = tables.linkProducts()
             cultures = tables.linkCultures()
+
+            redirects = tables.redirects
             articles = tables.articles
             decls = tables.decls
             groups = tables.groups
@@ -104,6 +111,7 @@ extension Unidoc.Mesh.Interior
             cultures = tables.linkCultures()
 
             extensions = tables.extensions
+            redirects = []
             groups = tables.groups
 
             linker = tables.linker
@@ -112,6 +120,7 @@ extension Unidoc.Mesh.Interior
         self.init(around: landingVertex,
             conformances: conformances,
             extensions: extensions,
+            redirects: redirects,
             products: products,
             cultures: cultures,
             articles: articles,
@@ -124,6 +133,7 @@ extension Unidoc.Mesh.Interior
     init(around landing:consuming Unidoc.LandingVertex,
         conformances:consuming Unidoc.Linker.Table<Unidoc.Conformers>,
         extensions:consuming Unidoc.Linker.Table<Unidoc.Extension>,
+        redirects:consuming [Unidoc.RedirectVertex],
         products:consuming [Unidoc.ProductVertex],
         cultures:consuming [Unidoc.CultureVertex],
         articles:consuming [Unidoc.ArticleVertex],
@@ -278,6 +288,7 @@ extension Unidoc.Mesh.Interior
                 foreign: foreign),
             groups: groups,
             index: index,
-            trees: trees)
+            trees: trees,
+            redirects: redirects)
     }
 }

Sources/UnidocLinker/Unidoc.Mesh.swift

@@ -50,10 +50,12 @@ extension Unidoc.Mesh
     var trees:[Unidoc.TypeTree] { self.interior.trees }
 
     @inlinable public
-    var volume:Symbol.Volume { self.metadata.symbol }
+    var redirects:[Unidoc.RedirectVertex] { self.interior.redirects }
 }
 extension Unidoc.Mesh
 {
+    @inlinable public
+    var volume:Symbol.Volume { self.metadata.symbol }
     @inlinable public
     var id:Unidoc.Edition { self.metadata.id }
 }

Sources/UnidocQueries/Unidoc.DB (ext).swift

@@ -1,3 +1,4 @@
+import FNV1
 import MongoDB
 import SHA1
 import Symbols
@@ -63,3 +64,37 @@ extension Unidoc.DB
         }
     }
 }
+extension Unidoc.DB
+{
+    public
+    func redirect(exported:Unidoc.Shoot,
+        from volume:Unidoc.Edition) async throws -> Unidoc.RedirectOutput?
+    {
+        try await self.query(with: Unidoc.RedirectByExportQuery.init(
+                volume: volume,
+                stem: exported.stem,
+                hash: exported.hash),
+            on: .nearest)
+    }
+
+    public
+    func redirect(visited shoot:Unidoc.Shoot,
+        in package:Unidoc.Package) async throws -> Unidoc.RedirectOutput?
+    {
+        guard
+        let visited:Unidoc.SearchbotCoverage = try await self.searchbotGrid.find(id: .init(
+            trunk: package,
+            shoot: shoot)),
+        let redirect:Unidoc.RedirectOutput = try await self.query(
+            with: Unidoc.RedirectByInternalHintQuery<Unidoc.Shoot>.init(
+                volume: visited.ok,
+                lookup: shoot),
+            on: .nearest)
+        else
+        {
+            return nil
+        }
+
+        return redirect
+    }
+}