Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove 'Non leaf-type cannot be used here' rule #2648

Merged
merged 1 commit into from
Jun 25, 2024
Merged

Remove 'Non leaf-type cannot be used here' rule #2648

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 0 additions & 48 deletions compiler/src/steps/validate-model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,6 @@ import { JsonSpec } from '../model/json-spec'
import assert from 'assert'
import { TypeName } from '../model/metamodel'

// Superclasses (i.e. non-leaf types, who are inherited or implemented) that are ok to be used as field types because
// they're used as definition reuse and not as polymorphic types.
// See also validateIsLeafType() below.
const allowedSuperclasses = new Set([
'_types:ErrorCause'
])

enum TypeDefKind {
type,
behavior
Expand Down Expand Up @@ -231,7 +224,6 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
modelError(`Type ${fqn(endpoint.request)} is not a request definition`)
} else {
validateTypeDef(reqType)
validateIsLeafType(endpoint.request)

// Request path properties and url template properties should be the same
const reqProperties = new Set(reqType.path.map(p => p.name))
Expand Down Expand Up @@ -276,7 +268,6 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
modelError(`Type ${fqn(endpoint.response)} not found`)
} else {
validateTypeDef(respType)
validateIsLeafType(endpoint.response)
}
}
}
Expand Down Expand Up @@ -731,44 +722,6 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
}
}

// Validates that use of non-leaf types (i.e. those who are inherited or implemented) are used either
// in contexts that are distinct from that of their children, or are abstract parent classes providing a way
// way to identify actual concrete implementations in strongly typed languages.
function validateIsLeafType (type: model.TypeName): void {
if (parentTypes.has(fqn(type))) {
// Aggregations are disambiguated with the 'typed_keys' parameter
if (type.namespace === 'aggregations') return

const fqName = fqn(type)

switch (fqName) {
// Base type also used as property, no polymorphic usage
case '_builtins:ErrorCause':
case 'x_pack.enrich:EnrichPolicy':
case 'x_pack.info.x_pack_usage:XPackUsage':
case 'x_pack.info.x_pack_usage:SecurityFeatureToggle':
case 'x_pack.watcher.watcher_stats:WatchRecordQueuedStats':
case 'x_pack.security.user.get_user:XPackUser':
case 'cluster.nodes_stats:MemoryStats':
case 'search.search:SearchResponse':
return

// Have a "type" attribute that identifies the variant
case 'mapping.types:PropertyBase':
case 'analysis.token_filters:TokenFilterBase':
return

// Single subclass with no additional properties, can probably be removed
case 'x_pack.watcher.input:HttpInputRequestDefinition':
return
}

if (!allowedSuperclasses.has(fqName)) {
modelError(`Non-leaf type cannot be used here: '${fqName}'`)
}
}
}

// -----------------------------------------------------------------------------------------------
// Value_Of validations

Expand All @@ -777,7 +730,6 @@ export default async function validateModel (apiModel: model.Model, restSpec: Ma
switch (valueOf.kind) {
case 'instance_of':
validateTypeRef(valueOf.type, valueOf.generics, openGenerics)
validateIsLeafType(valueOf.type)
break

case 'array_of':
Expand Down
Loading
Loading