Add Name Search Scope direcives to endpoints

Author: ChrisPenner

sql/2025-09-17_optional_transitive_names.sql

@@ -1,5 +1,5 @@
 -- Add an additional argument for whether to include dependencies or transitive dependencies.
-CREATE OR REPLACE FUNCTION term_names_for_ref_within_namespace(
+CREATE FUNCTION term_names_for_ref(
   arg_bh_id integer,
   arg_namespace_prefix text,
   arg_reversed_name_prefix text,
@@ -8,8 +8,8 @@ CREATE OR REPLACE FUNCTION term_names_for_ref_within_namespace(
   arg_referent_component_hash_id integer,
   arg_referent_component_index bigint,
   arg_referent_constructor_index bigint,
-  arg_include_dependencies boolean DEFAULT true,
-  arg_include_transitive_dependencies boolean DEFAULT true
+  arg_include_dependencies boolean,
+  arg_include_transitive_dependencies boolean
 ) RETURNS TABLE (
   reversed_name text,
   suffixified_name text
@@ -100,16 +100,16 @@ END;
 $$ LANGUAGE plpgsql STABLE;
 
 
-CREATE OR REPLACE FUNCTION type_names_for_ref_within_namespace(
+CREATE FUNCTION type_names_for_ref(
   arg_bh_id integer,
   arg_namespace_prefix text,
   arg_reversed_name_prefix text,
   arg_should_suffixify boolean,
   arg_reference_builtin text,
   arg_reference_component_hash_id integer,
   arg_reference_component_index bigint,
-  arg_include_dependencies boolean DEFAULT true,
-  arg_include_transitive_dependencies boolean DEFAULT true
+  arg_include_dependencies boolean,
+  arg_include_transitive_dependencies boolean
 ) RETURNS TABLE (
   reversed_name text,
   suffixified_name text

src/Share/BackgroundJobs/Search/DefinitionSync.hs

@@ -30,6 +30,7 @@ import Share.Postgres qualified as PG
 import Share.Postgres.Cursors qualified as Cursors
 import Share.Postgres.IDs (BranchHashId)
 import Share.Postgres.NameLookups.Ops qualified as NLOps
+import Share.Postgres.NameLookups.Queries (NameSearchScope (..))
 import Share.Postgres.NamesPerspective.Ops qualified as NPOps
 import Share.Postgres.NamesPerspective.Types (NamesPerspective (..))
 import Share.Postgres.Notifications qualified as Notif
@@ -243,7 +244,7 @@ syncTerms codebase namesPerspective rootBranchHashId termsCursor = do
 
     -- It's much more efficient to build only one PPE per batch.
     let allDeps = setOf (folded . folding tokens . folded . to LD.TypeReference) refDocs
-    pped <- PG.timeTransaction "Build PPED" $ PPEPostgres.ppedForReferences namesPerspective allDeps
+    pped <- PG.timeTransaction "Build PPED" $ PPEPostgres.ppedForReferences TransitiveDependencies namesPerspective allDeps
     let ppe = PPED.unsuffixifiedPPE pped
     let namedDocs :: [DefinitionDocument Name (Name, ShortHash)]
         namedDocs =
@@ -426,7 +427,7 @@ syncTypes codebase codeCache namesPerspective rootBranchHashId typesCursor = do
                 }
     -- It's much more efficient to build only one PPE per batch.
     let allDeps = setOf (folded . folding tokens . folded . to LD.TypeReference) defDocuments
-    pped <- PPEPostgres.ppedForReferences namesPerspective allDeps
+    pped <- PPEPostgres.ppedForReferences TransitiveDependencies namesPerspective allDeps
     let ppe = PPED.unsuffixifiedPPE pped
     let namedDocs :: V.Vector (DefinitionDocument Name (Name, ShortHash))
         namedDocs =

src/Share/Names/Postgres.hs

@@ -7,7 +7,7 @@ import Data.Set qualified as Set
 import Share.Postgres qualified as PG
 import Share.Postgres.NameLookups.Conversions qualified as CV
 import Share.Postgres.NameLookups.Ops qualified as NameLookupOps
-import Share.Postgres.NameLookups.Queries (ShouldSuffixify (NoSuffixify))
+import Share.Postgres.NameLookups.Queries (NameSearchScope, ShouldSuffixify (NoSuffixify))
 import Share.Postgres.NameLookups.Types qualified as NameLookups
 import Share.Postgres.NamesPerspective.Types (NamesPerspective)
 import Share.Postgres.Refs.Types
@@ -19,8 +19,8 @@ import Unison.Names qualified as Names
 import Unison.Reference qualified as V1
 import Unison.Referent qualified as V1
 
-namesForReferences :: forall m. (PG.QueryM m) => NamesPerspective m -> Set LabeledDependency -> m Names
-namesForReferences namesPerspective refs = do
+namesForReferences :: forall m. (PG.QueryM m) => NameSearchScope -> NamesPerspective m -> Set LabeledDependency -> m Names
+namesForReferences namesScope namesPerspective refs = do
   (pgRefTerms, pgRefTypes) <-
     Set.toList refs
       & CV.labeledDependencies1ToPG
@@ -38,7 +38,7 @@ namesForReferences namesPerspective refs = do
         & asListOf trav %%~ \refs -> do
           let pgRefs = snd <$> refs
           typeNames :: [[(NameLookups.ReversedName, NameLookups.ReversedName)]] <-
-            NameLookupOps.typeNamesForRefsWithinNamespaceOf namesPerspective Nothing NoSuffixify traversed pgRefs
+            NameLookupOps.typeNamesForRefsWithinNamespaceOf namesPerspective Nothing NoSuffixify namesScope traversed pgRefs
           pure $ do
             ((ref, _pgRef), names) <- zip refs typeNames
             pure $ do
@@ -51,7 +51,7 @@ namesForReferences namesPerspective refs = do
         & asListOf trav %%~ \refs -> do
           let pgRefs = snd <$> refs
           termNames :: [[(NameLookups.ReversedName, NameLookups.ReversedName)]] <-
-            NameLookupOps.termNamesForRefsWithinNamespaceOf namesPerspective Nothing NoSuffixify traversed pgRefs
+            NameLookupOps.termNamesForRefsWithinNamespaceOf namesPerspective Nothing NoSuffixify namesScope traversed pgRefs
           pure $ do
             ((ref, _pgRef), names) <- zip refs termNames
             pure $ do

src/Share/NamespaceDiffs.hs

@@ -53,6 +53,7 @@ import Share.Postgres qualified as PG
 import Share.Postgres.Definitions.Queries qualified as DefnsQ
 import Share.Postgres.IDs (BranchHashId)
 import Share.Postgres.NameLookups.Ops qualified as NL
+import Share.Postgres.NameLookups.Queries (NameSearchScope (TransitiveDependencies))
 import Share.Postgres.NameLookups.Types (NameLookupReceipt)
 import Share.Postgres.NameLookups.Types qualified as NL
 import Share.Postgres.NamesPerspective.Ops qualified as NPOps
@@ -298,7 +299,7 @@ computeThreeWayNamespaceDiff codebaseEnvs2 aliceCodeCache bobCodeCache branchHas
             traverse NPOps.namesPerspectiveForRoot branchHashIds
         names <-
           PG.transactionSpan "load names" mempty do
-            sequence (PGNames.namesForReferences <$> perspectives <*> ThreeWay.toTwoOrThreeWay dependencies)
+            sequence (PGNames.namesForReferences TransitiveDependencies <$> perspectives <*> ThreeWay.toTwoOrThreeWay dependencies)
         pure (TwoOrThreeWay.toThreeWay Names.empty names)
 
   Merge.makeDiffblob

src/Share/Postgres/NameLookups/Ops.hs

@@ -74,20 +74,20 @@ fuzzySearchDefinitions includeDependencies namesPerspective@NamesPerspective {re
 
 -- | Get the list of (fqn, suffixified) names for a given Referent.
 -- If 'shouldSuffixify' is 'NoSuffixify', the suffixified name will be the same as the fqn.
-termNamesForRefsWithinNamespaceOf :: (PG.QueryM m) => NamesPerspective m -> Maybe ReversedName -> ShouldSuffixify -> Traversal s t PGReferent [(ReversedName, ReversedName)] -> s -> m t
-termNamesForRefsWithinNamespaceOf namesPerspective maySuffix shouldSuffixify trav s = do
+termNamesForRefsWithinNamespaceOf :: (PG.QueryM m) => NamesPerspective m -> Maybe ReversedName -> ShouldSuffixify -> Q.NameSearchScope -> Traversal s t PGReferent [(ReversedName, ReversedName)] -> s -> m t
+termNamesForRefsWithinNamespaceOf namesPerspective maySuffix shouldSuffixify nameScope trav s = do
   s
     & asListOf trav %%~ \refs -> do
-      NameLookupQ.termNamesForRefsWithinNamespaceOf namesPerspective maySuffix shouldSuffixify traversed refs
+      NameLookupQ.termNamesForRefsWithinNamespaceOf namesPerspective maySuffix shouldSuffixify nameScope traversed refs
         <&> (fmap . fmap) \(NameWithSuffix {reversedName, suffixifiedName}) -> (reversedName, suffixifiedName)
 
 -- | Get the list of (fqn, suffixified) names for a given Reference.
 -- If 'shouldSuffixify' is 'NoSuffixify', the suffixified name will be the same as the fqn.
-typeNamesForRefsWithinNamespaceOf :: (PG.QueryM m) => NamesPerspective m -> Maybe ReversedName -> ShouldSuffixify -> Traversal s t PGReference [(ReversedName, ReversedName)] -> s -> m t
-typeNamesForRefsWithinNamespaceOf namesPerspective maySuffix shouldSuffixify trav s = do
+typeNamesForRefsWithinNamespaceOf :: (PG.QueryM m) => NamesPerspective m -> Maybe ReversedName -> ShouldSuffixify -> Q.NameSearchScope -> Traversal s t PGReference [(ReversedName, ReversedName)] -> s -> m t
+typeNamesForRefsWithinNamespaceOf namesPerspective maySuffix shouldSuffixify nameScope trav s = do
   s
     & asListOf trav %%~ \refs -> do
-      NameLookupQ.typeNamesForRefsWithinNamespaceOf namesPerspective maySuffix shouldSuffixify traversed refs
+      NameLookupQ.typeNamesForRefsWithinNamespaceOf namesPerspective maySuffix shouldSuffixify nameScope traversed refs
         <&> (fmap . fmap) \(NameWithSuffix {reversedName, suffixifiedName}) -> (reversedName, suffixifiedName)
 
 termRefsForExactNamesOf :: (PG.QueryM m) => NamesPerspective m -> Traversal s t ReversedName [NamedRef V1.Referent] -> s -> m t

src/Share/Postgres/NameLookups/Queries.hs

@@ -4,6 +4,7 @@
 module Share.Postgres.NameLookups.Queries
   ( termNamesForRefsWithinNamespaceOf,
     typeNamesForRefsWithinNamespaceOf,
+    NameSearchScope (..),
     ShouldSuffixify (..),
     termRefsForExactNamesOf,
     typeRefsForExactNamesOf,
@@ -52,13 +53,19 @@ import Unison.Util.Monoid qualified as Monoid
 
 data ShouldSuffixify = Suffixify | NoSuffixify
 
+data NameSearchScope
+  = ProjectDefinitions
+  | Dependencies
+  | TransitiveDependencies
+  deriving (Show, Eq, Ord)
+
 -- | Get the list of term names and suffixifications for a given Referent within a given root namespace perspective.
 -- Considers one level of dependencies, but not transitive dependencies.
 --
 -- If NoSuffixify is provided, the suffixified name will be the same as the fqn.
 termNamesForRefsWithinNamespaceOf ::
-  (PG.QueryM m) => NamesPerspective m -> Maybe ReversedName -> ShouldSuffixify -> Traversal s t PGReferent [NameWithSuffix] -> s -> m t
-termNamesForRefsWithinNamespaceOf np maySuffix shouldSuffixify trav s = do
+  (PG.QueryM m) => NamesPerspective m -> Maybe ReversedName -> ShouldSuffixify -> NameSearchScope -> Traversal s t PGReferent [NameWithSuffix] -> s -> m t
+termNamesForRefsWithinNamespaceOf np maySuffix shouldSuffixify nameScope trav s = do
   s & asListOf trav \refs -> do
     let refsTable :: [(Int32, Maybe Text, Maybe ComponentHashId, Maybe Int64, Maybe Int64)]
         refsTable =
@@ -74,22 +81,28 @@ termNamesForRefsWithinNamespaceOf np maySuffix shouldSuffixify trav s = do
           -- Need COALESCE because array_agg will return NULL rather than the empty array
           -- if there are no results.
           SELECT COALESCE(array_agg((names.reversed_name, names.suffixified_name) ORDER BY length(names.reversed_name) ASC), '{}')
-          FROM term_names_for_ref_within_namespace(
+          FROM term_names_for_ref(
             #{bhId},
             #{namespacePrefix},
             #{reversedNamePrefix},
             #{shouldSuffixifyArg},
             refs.referent_builtin,
             refs.referent_component_hash_id,
             refs.referent_component_index,
-            refs.referent_constructor_index
+            refs.referent_constructor_index,
+            #{includeDependencies},
+            #{includeTransitiveDependencies}
           ) AS names(reversed_name, suffixified_name)
         ) AS ref_names
         FROM refs
         ORDER BY refs.ord ASC
       |]
       <&> over (traversed . traversed . field @"reversedName") (qualifyNameToPerspective np)
   where
+    (includeDependencies, includeTransitiveDependencies) = case nameScope of
+      ProjectDefinitions -> (False, False)
+      Dependencies -> (True, False)
+      TransitiveDependencies -> (True, True)
     -- Look in the current mount.
     bhId = perspectiveCurrentMountBranchHashId np
     shouldSuffixifyArg = case shouldSuffixify of
@@ -104,8 +117,8 @@ termNamesForRefsWithinNamespaceOf np maySuffix shouldSuffixify trav s = do
 -- Considers one level of dependencies, but not transitive dependencies.
 --
 -- If NoSuffixify is provided, the suffixified name will be the same as the fqn.
-typeNamesForRefsWithinNamespaceOf :: (PG.QueryM m) => NamesPerspective m -> Maybe ReversedName -> ShouldSuffixify -> Traversal s t PGReference [NameWithSuffix] -> s -> m t
-typeNamesForRefsWithinNamespaceOf np maySuffix shouldSuffixify trav s = do
+typeNamesForRefsWithinNamespaceOf :: (PG.QueryM m) => NamesPerspective m -> Maybe ReversedName -> ShouldSuffixify -> NameSearchScope -> Traversal s t PGReference [NameWithSuffix] -> s -> m t
+typeNamesForRefsWithinNamespaceOf np maySuffix shouldSuffixify nameScope trav s = do
   s & asListOf trav \refs -> do
     let refsTable :: [(Int32, Maybe Text, Maybe ComponentHashId, Maybe Int64)]
         refsTable =
@@ -121,21 +134,27 @@ typeNamesForRefsWithinNamespaceOf np maySuffix shouldSuffixify trav s = do
           -- Need COALESCE because array_agg will return NULL rather than the empty array
           -- if there are no results.
           SELECT COALESCE(array_agg((names.reversed_name, names.suffixified_name) ORDER BY length(names.reversed_name) ASC), '{}')
-          FROM type_names_for_ref_within_namespace(
+          FROM type_names_for_ref(
             #{bhId},
             #{namespacePrefix},
             #{reversedNamePrefix},
             #{shouldSuffixifyArg},
             refs.reference_builtin,
             refs.reference_component_hash_id,
-            refs.reference_component_index
+            refs.reference_component_index,
+            #{includeDependencies},
+            #{includeTransitiveDependencies}
           ) AS names(reversed_name, suffixified_name)
         ) AS ref_names
         FROM refs
         ORDER BY refs.ord ASC
       |]
       <&> over (traversed . traversed . field @"reversedName") (qualifyNameToPerspective np)
   where
+    (includeDependencies, includeTransitiveDependencies) = case nameScope of
+      ProjectDefinitions -> (False, False)
+      Dependencies -> (True, False)
+      TransitiveDependencies -> (True, True)
     bhId = perspectiveCurrentMountBranchHashId np
     shouldSuffixifyArg = case shouldSuffixify of
       Suffixify -> True

src/Share/PrettyPrintEnvDecl/Postgres.hs

@@ -7,7 +7,7 @@ import Data.Set qualified as Set
 import Share.Postgres qualified as PG
 import Share.Postgres.NameLookups.Conversions qualified as CV
 import Share.Postgres.NameLookups.Ops qualified as NameLookupOps
-import Share.Postgres.NameLookups.Queries (ShouldSuffixify (..))
+import Share.Postgres.NameLookups.Queries (NameSearchScope, ShouldSuffixify (..))
 import Share.Postgres.NameLookups.Types qualified as NameLookups
 import Share.Postgres.NamesPerspective.Types (NamesPerspective)
 import Share.Postgres.Refs.Types
@@ -20,8 +20,8 @@ import Unison.PrettyPrintEnvDecl qualified as PPED
 import Unison.Reference qualified as V1
 import Unison.Referent qualified as V1
 
-ppedForReferences :: forall m. (PG.QueryM m) => NamesPerspective m -> Set LabeledDependency -> m PPED.PrettyPrintEnvDecl
-ppedForReferences namesPerspective refs = do
+ppedForReferences :: forall m. (PG.QueryM m) => NameSearchScope -> NamesPerspective m -> Set LabeledDependency -> m PPED.PrettyPrintEnvDecl
+ppedForReferences nameScope namesPerspective refs = do
   (pgRefTerms, pgRefTypes) <-
     Set.toList refs
       & CV.labeledDependencies1ToPG
@@ -38,7 +38,7 @@ ppedForReferences namesPerspective refs = do
         & asListOf trav %%~ \refs -> do
           let pgRefs = snd <$> refs
           termNames :: [[(NameLookups.ReversedName, NameLookups.ReversedName)]] <-
-            NameLookupOps.termNamesForRefsWithinNamespaceOf namesPerspective Nothing Suffixify traversed pgRefs
+            NameLookupOps.termNamesForRefsWithinNamespaceOf namesPerspective Nothing Suffixify nameScope traversed pgRefs
           pure $ do
             ((ref, _pgRef), names) <- zip refs termNames
             pure $ do
@@ -50,7 +50,7 @@ ppedForReferences namesPerspective refs = do
         & asListOf trav %%~ \refs -> do
           let pgRefs = snd <$> refs
           typeNames :: [[(NameLookups.ReversedName, NameLookups.ReversedName)]] <-
-            NameLookupOps.typeNamesForRefsWithinNamespaceOf namesPerspective Nothing Suffixify traversed pgRefs
+            NameLookupOps.typeNamesForRefsWithinNamespaceOf namesPerspective Nothing Suffixify nameScope traversed pgRefs
           pure $ do
             ((ref, _pgRef), names) <- zip refs typeNames
             pure $ do

src/Share/Web/Share/Diffs/Impl.hs

@@ -23,6 +23,7 @@ import Share.Postgres.Causal.Queries qualified as CausalQ
 import Share.Postgres.Contributions.Queries qualified as ContributionQ
 import Share.Postgres.Hashes.Queries qualified as HashQ
 import Share.Postgres.IDs (BranchHash, BranchHashId, CausalId)
+import Share.Postgres.NameLookups.Queries (NameSearchScope (TransitiveDependencies))
 import Share.Postgres.NameLookups.Types (NameLookupReceipt)
 import Share.Postgres.NamesPerspective.Ops qualified as NLOps
 import Share.Postgres.NamesPerspective.Types (NamesPerspective (..))
@@ -294,7 +295,7 @@ getTermDefinitionsOf codebase rt namesPerspective trav s = do
       Definitions.termDefinitionByNamesOf codebase ppedBuilder namesPerspective renderWidth rt includeDocs traversed names
   where
     includeDocs = False
-    ppedBuilder deps = PPEPostgres.ppedForReferences namesPerspective deps
+    ppedBuilder deps = PPEPostgres.ppedForReferences TransitiveDependencies namesPerspective deps
     renderWidth :: Width
     renderWidth = 80
 
@@ -336,7 +337,7 @@ expectTermDefinitionsByNamedRefsOf codebase rt namesPerspective toReferent trav
         (map (\name -> (name, toReferent name)) names)
   where
     includeDocs = False
-    ppedBuilder deps = PPEPostgres.ppedForReferences namesPerspective deps
+    ppedBuilder deps = PPEPostgres.ppedForReferences TransitiveDependencies namesPerspective deps
     renderWidth :: Width
     renderWidth = 80
 
@@ -371,7 +372,7 @@ getTypeDefinitionsOf codebase rt namesPerspective trav s = do
       Definitions.typeDefinitionsByNamesOf codebase ppedBuilder namesPerspective renderWidth rt includeDocs traversed names
   where
     includeDocs = False
-    ppedBuilder = PPEPostgres.ppedForReferences namesPerspective
+    ppedBuilder = PPEPostgres.ppedForReferences TransitiveDependencies namesPerspective
     renderWidth :: Width
     renderWidth = 80
 
@@ -398,7 +399,7 @@ expectTypeDefinitionsByNamedRefsOf codebase rt namesPerspective toReference trav
         (map (\name -> (name, toReference name)) names)
   where
     includeDocs = False
-    ppedBuilder = PPEPostgres.ppedForReferences namesPerspective
+    ppedBuilder = PPEPostgres.ppedForReferences TransitiveDependencies namesPerspective
     renderWidth :: Width
     renderWidth = 80