feat(service-spec-importers): expose importers via DatabaseBuilder #631
Conversation
mrgrain
force-pushed
the
mrgrain/feat/loaders-importers
branch
from
96e17ac to
1dd2845
Compare
mrgrain
force-pushed
the
mrgrain/feat/loaders-importers
branch
from
1dd2845 to
df5fe20
Compare
| .importScrutinies() | ||
| .importAugmentations() |
There was a problem hiding this comment.
Are these built into the importers package?
There was a problem hiding this comment.
Unfortunately yes. Should we change that? WDYT?
| export type SourceImporter = (db: SpecDatabase, report: ProblemReport) => Promise<void>; | ||
|
|
||
| export class DatabaseBuilder { | ||
| private readonly sourceImporters = new Array<SourceImporter>(); |
There was a problem hiding this comment.
Mostly to improve UX, this enables a fluent interface. Otherwise it's a bunch of statements that need to be awaited.
I don't have strong feelings about this. It made sense to me to expose the importers as methods on a class.
| import { SpecDatabase, emptyDatabase } from '@aws-cdk/service-spec-types'; | ||
| import { DatabaseBuilder, DatabaseBuilderOptions } from './db-builder'; | ||
|
|
||
| const SOURCES = path.join(__dirname, '../../../../sources'); |
There was a problem hiding this comment.
This makes me think this file needs to live somewhere else. Can it be an unpackaged build tool for aws-service-spec ?
Otherwise, make this directory a parameter I think and call it with the right relative directory from the aws-service-spec build.
There was a problem hiding this comment.
Yes planning to do exactly this in the next PR!
Preparing the
service-spec-importerspackage for a public release, pt2.This change replaces existing exports of everything with explicit exports for:
DatabaseBuildera new class that helps importing data into a databaseDbDiffa class that helps diff'ing to databasesProblemReporta class to collect & report problems encountered during importWhile this change is already enough to import additional specs on top of an existing database, we will need one further change to decouple the package from the source files in this repo.