-
-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat: pull OpenAPI & GraphQL specifications (#35)
* feat: add service to pull specs from remote * refactor: change specifications to specs * chore: typo in split option * feat: pull system graphql specs * refactor: explicitly store items schema as item.graphql * fix: avoid specs option override * docs: add details in README.md * docs: re-order options list * docs: add spaces in options list
- Loading branch information
1 parent
bd56e8e
commit 5d41d07
Showing
9 changed files
with
161 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| export * from './config'; | ||
| export * from './migration-client'; | ||
| export * from './snapshot'; | ||
| export * from './specifications'; | ||
| export * from './collections'; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export * from './specifications-client'; |
96 changes: 96 additions & 0 deletions
96
packages/cli/src/lib/services/specifications/specifications-client.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,96 @@ | ||
| import { Inject, Service } from 'typedi'; | ||
| import { MigrationClient } from '../migration-client'; | ||
| import { | ||
| OpenApiSpecOutput, | ||
| readGraphqlSdl, | ||
| readOpenApiSpec, | ||
| } from '@directus/sdk'; | ||
| import path from 'path'; | ||
| import { mkdirpSync, removeSync, writeJsonSync } from 'fs-extra'; | ||
| import { LOGGER } from '../../constants'; | ||
| import pino from 'pino'; | ||
| import { getChildLogger } from '../../helpers'; | ||
| import { ConfigService } from '../config'; | ||
| import { writeFileSync } from 'node:fs'; | ||
|
|
||
| const ITEM_GRAPHQL_FILENAME = 'item.graphql'; | ||
| const SYSTEM_GRAPHQL_FILENAME = 'system.graphql'; | ||
| const OPENAPI_FILENAME = 'openapi.json'; | ||
|
|
||
| @Service() | ||
| export class SpecificationsClient { | ||
| protected readonly dumpPath: string; | ||
|
|
||
| protected readonly enabled: boolean; | ||
|
|
||
| protected readonly logger: pino.Logger; | ||
|
|
||
| constructor( | ||
| config: ConfigService, | ||
| @Inject(LOGGER) baseLogger: pino.Logger, | ||
| protected readonly migrationClient: MigrationClient, | ||
| ) { | ||
| this.logger = getChildLogger(baseLogger, 'snapshot'); | ||
| const { dumpPath, enabled } = config.getSpecificationsConfig(); | ||
| this.dumpPath = dumpPath; | ||
| this.enabled = enabled; | ||
| } | ||
|
|
||
| /** | ||
| * Save the snapshot locally | ||
| */ | ||
| async pull() { | ||
| if (!this.enabled) { | ||
| return; | ||
| } | ||
|
|
||
| const itemGraphQL = await this.getGraphQL('item'); | ||
| this.saveGraphQLData(itemGraphQL, ITEM_GRAPHQL_FILENAME); | ||
| this.logger.debug(`Saved Item GraphQL schema to ${this.dumpPath}`); | ||
|
|
||
| const systemGraphQL = await this.getGraphQL('system'); | ||
| this.saveGraphQLData(systemGraphQL, SYSTEM_GRAPHQL_FILENAME); | ||
| this.logger.debug(`Saved System GraphQL schema to ${this.dumpPath}`); | ||
|
|
||
| const openapi = await this.getOpenAPI(); | ||
| this.saveOpenAPIData(openapi); | ||
| this.logger.debug(`Saved OpenAPI specification to ${this.dumpPath}`); | ||
| } | ||
|
|
||
| /** | ||
| * Get GraphQL SDL from the server | ||
| */ | ||
| protected async getGraphQL(scope?: 'item' | 'system') { | ||
| const directus = await this.migrationClient.get(); | ||
| const response = await directus.request<Response>(readGraphqlSdl(scope)); | ||
| return await response.text(); | ||
| } | ||
|
|
||
| /** | ||
| * Get OpenAPI specifications from the server | ||
| */ | ||
| protected async getOpenAPI() { | ||
| const directus = await this.migrationClient.get(); | ||
| return await directus.request(readOpenApiSpec()); | ||
| } | ||
|
|
||
| /** | ||
| * Save the GraphQL data to the dump file. | ||
| */ | ||
| protected saveGraphQLData(data: string, filename: string): void { | ||
| mkdirpSync(this.dumpPath); | ||
| const filePath = path.join(this.dumpPath, filename); | ||
| removeSync(filePath); | ||
| writeFileSync(filePath, data); | ||
| } | ||
|
|
||
| /** | ||
| * Save the OpenAPI JSON data to the dump file. | ||
| */ | ||
| protected saveOpenAPIData(data: OpenApiSpecOutput): void { | ||
| mkdirpSync(this.dumpPath); | ||
| const filePath = path.join(this.dumpPath, OPENAPI_FILENAME); | ||
| removeSync(filePath); | ||
| writeJsonSync(filePath, data, { spaces: 2 }); | ||
| } | ||
| } |