sql: ensure comments are looked up for create_type_statements

Previously, crdb_internal.create_type_statements did not look up comment
metadata for point lookup indexes. This could lead to missing comments
or an assertion firing on test builds. To address this, this patch adds
a new WithMetaData flag in the collections which can be combined for
leased descriptor scenarios like this. This allows a point lookup of
comments to be used when using leased descriptors for catalog views.
Corrected Version

Fixes: #157916
Release note: None

Author: fqazi

pkg/sql/catalog/descs/getters.go

@@ -530,6 +530,14 @@ func (b ByIDGetterBuilder) WithoutSynthetic() ByIDGetterBuilder {
 	return b
 }
 
+// WithMetaData configures the byIDGetterBuilder to read zone configs and comments
+// for lease descriptors. This is always acquired for descriptors from storage,
+// and may need an extra round trip.
+func (b ByIDGetterBuilder) WithMetaData() ByIDGetterBuilder {
+	b.flags.layerFilters.withMetadata = true
+	return b
+}
+
 // WithoutDropped configures the ByIDGetterBuilder to error on descriptors
 // which are in a dropped state.
 func (b ByIDGetterBuilder) WithoutDropped() ByIDGetterBuilder {

pkg/sql/crdb_internal.go

@@ -3227,7 +3227,7 @@ CREATE TABLE crdb_internal.create_type_statements (
 				addRow func(...tree.Datum) error,
 			) (matched bool, err error) {
 				id := descpb.ID(tree.MustBeDInt(unwrappedConstraint))
-				scName, typDesc, err := getSchemaAndTypeByTypeID(ctx, p, id)
+				scName, typDesc, err := getSchemaAndTypeByTypeID(ctx, p, id, true /* includeMetaData */)
 				if err != nil || typDesc == nil {
 					return false, err
 				}

pkg/sql/logictest/testdata/logic_test/crdb_internal

@@ -1,6 +1,6 @@
 # 3node-tenant is blocked from running this file due to heavy reliance on
 # unavailable node IDs in this test.
-# LogicTest: !3node-tenant-default-configs !local-prepared
+# LogicTest: !3node-tenant-default-configs !local-prepared local-leased-descriptors default-configs
 
 query error database "crdb_internal" does not exist
 ALTER DATABASE crdb_internal RENAME TO not_crdb_internal

pkg/sql/logictest/tests/local-leased-descriptors/BUILD.bazel

@@ -12,7 +12,7 @@ go_test(
         "//build/toolchains:is_heavy": {"test.Pool": "heavy"},
         "//conditions:default": {"test.Pool": "large"},
     }),
-    shard_count = 11,
+    shard_count = 12,
     tags = ["cpu:1"],
     deps = [
         "//pkg/base",

pkg/sql/logictest/tests/local-leased-descriptors/generated_test.go

@@ -3796,9 +3796,13 @@ func addPGAttributeRowForCompositeType(
 }
 
 func getSchemaAndTypeByTypeID(
-	ctx context.Context, p *planner, id descpb.ID,
+	ctx context.Context, p *planner, id descpb.ID, includeMetaData bool,
 ) (catalog.SchemaDescriptor, catalog.TypeDescriptor, error) {
-	typDesc, err := descs.GetCatalogDescriptorGetter(p.Descriptors(), p.txn, &p.EvalContext().Settings.SV).WithoutNonPublic().Get().Type(ctx, id)
+	getter := descs.GetCatalogDescriptorGetter(p.Descriptors(), p.txn, &p.EvalContext().Settings.SV)
+	if includeMetaData {
+		getter = getter.WithMetaData()
+	}
+	typDesc, err := getter.WithoutNonPublic().Get().Type(ctx, id)
 	if err != nil {
 		// If the type was not found, it may be a table.
 		if !(errors.Is(err, catalog.ErrDescriptorNotFound) || pgerror.GetPGCode(err) == pgcode.UndefinedObject) {
@@ -3897,7 +3901,7 @@ https://www.postgresql.org/docs/9.5/catalog-pg-type.html`,
 
 				id := typedesc.UserDefinedTypeOIDToID(ooid)
 
-				sc, typDesc, err := getSchemaAndTypeByTypeID(ctx, p, id)
+				sc, typDesc, err := getSchemaAndTypeByTypeID(ctx, p, id, false /* includeMetaData */)
 				if err != nil || typDesc == nil {
 					return false, err
 				}