-
Notifications
You must be signed in to change notification settings - Fork 159
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
(feature, cli): Upload source files to S3 (#4286)
- Loading branch information
Showing
7 changed files
with
176 additions
and
27 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
124 changes: 124 additions & 0 deletions
124
packages/cli/generation/remote-generation/remote-workspace-runner/src/SourceUploader.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,124 @@ | ||
| import { AbsoluteFilePath, join, RelativeFilePath } from "@fern-api/fs-utils"; | ||
| import { ApiDefinitionSource, SourceConfig } from "@fern-api/ir-sdk"; | ||
| import { loggingExeca } from "@fern-api/logging-execa"; | ||
| import { InteractiveTaskContext } from "@fern-api/task-context"; | ||
| import { IdentifiableSource } from "@fern-api/workspace-loader"; | ||
| import { FernRegistry as FdrAPI } from "@fern-fern/fdr-cjs-sdk"; | ||
| import { readFile, unlink } from "fs/promises"; | ||
| import tmp from "tmp-promise"; | ||
|
|
||
| const PROTOBUF_ZIP_FILENAME = "proto.zip"; | ||
|
|
||
| export type SourceType = "asyncapi" | "openapi" | "protobuf"; | ||
|
|
||
| export class SourceUploader { | ||
| public sourceTypes: Set<SourceType>; | ||
| private context: InteractiveTaskContext; | ||
| private sources: Record<string, IdentifiableSource>; | ||
|
|
||
| constructor(context: InteractiveTaskContext, sources: IdentifiableSource[]) { | ||
| this.context = context; | ||
| this.sources = Object.fromEntries(sources.map((source) => [source.id, source])); | ||
| this.sourceTypes = new Set<SourceType>(Object.values(this.sources).map((source) => source.type)); | ||
| } | ||
|
|
||
| public async uploadSources( | ||
| sources: Record<FdrAPI.api.v1.register.SourceId, FdrAPI.api.v1.register.SourceUpload> | ||
| ): Promise<SourceConfig> { | ||
| for (const [id, source] of Object.entries(sources)) { | ||
| const identifiableSource = this.getSourceOrThrow(id); | ||
| await this.uploadSource(identifiableSource, source.uploadUrl); | ||
| } | ||
| return this.convertFdrSourceUploadsToSourceConfig(sources); | ||
| } | ||
|
|
||
| private async uploadSource(source: IdentifiableSource, uploadURL: string): Promise<void> { | ||
| const uploadCommand = await this.getUploadCommand(source); | ||
| const fileData = await readFile(uploadCommand.absoluteFilePath); | ||
| const response = await fetch(uploadURL, { | ||
| method: "PUT", | ||
| body: fileData, | ||
| headers: { | ||
| "Content-Type": "application/octet-stream" | ||
| } | ||
| }); | ||
| await uploadCommand.cleanup(); | ||
| if (!response.ok) { | ||
| this.context.failAndThrow( | ||
| `Failed to upload source file: ${source.absoluteFilePath}. Status: ${response.status}, ${response.statusText}` | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| private async getUploadCommand( | ||
| source: IdentifiableSource | ||
| ): Promise<{ absoluteFilePath: AbsoluteFilePath; cleanup: () => Promise<void> }> { | ||
| if (source.type === "protobuf") { | ||
| const absoluteFilePath = await this.zipSource(source.absoluteFilePath); | ||
| return { | ||
| absoluteFilePath, | ||
| cleanup: async () => { | ||
| this.context.logger.debug(`Removing ${absoluteFilePath}`); | ||
| await unlink(absoluteFilePath); | ||
| } | ||
| }; | ||
| } | ||
| return { | ||
| absoluteFilePath: source.absoluteFilePath, | ||
| cleanup: async () => { | ||
| // Do nothing. | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| private async zipSource(absolutePathToSource: AbsoluteFilePath): Promise<AbsoluteFilePath> { | ||
| const tmpDir = await tmp.dir(); | ||
| const destination = join(AbsoluteFilePath.of(tmpDir.path), RelativeFilePath.of(PROTOBUF_ZIP_FILENAME)); | ||
|
|
||
| this.context.logger.debug(`Zipping source ${absolutePathToSource} into ${destination}`); | ||
| await loggingExeca(this.context.logger, "zip", ["-r", destination, "."], { | ||
| cwd: absolutePathToSource, | ||
| doNotPipeOutput: true | ||
| }); | ||
|
|
||
| return destination; | ||
| } | ||
|
|
||
| private convertFdrSourceUploadsToSourceConfig( | ||
| sources: Record<FdrAPI.api.v1.register.SourceId, FdrAPI.api.v1.register.SourceUpload> | ||
| ): SourceConfig { | ||
| const apiDefinitionSources: ApiDefinitionSource[] = []; | ||
| for (const [id, sourceUpload] of Object.entries(sources)) { | ||
| const identifiableSource = this.getSourceOrThrow(id); | ||
| switch (identifiableSource.type) { | ||
| case "protobuf": | ||
| apiDefinitionSources.push( | ||
| ApiDefinitionSource.proto({ | ||
| id, | ||
| protoRootUrl: sourceUpload.downloadUrl | ||
| }) | ||
| ); | ||
| continue; | ||
| case "openapi": | ||
| apiDefinitionSources.push(ApiDefinitionSource.openapi()); | ||
| continue; | ||
| case "asyncapi": | ||
| // AsyncAPI sources aren't modeled in the IR yet. | ||
| continue; | ||
| } | ||
| } | ||
| return { | ||
| sources: apiDefinitionSources | ||
| }; | ||
| } | ||
|
|
||
| private getSourceOrThrow(id: string): IdentifiableSource { | ||
| const source = this.sources[id]; | ||
| if (source == null) { | ||
| this.context.failAndThrow( | ||
| `Internal error; server responded with source id "${id}" which does not exist in the workspace.` | ||
| ); | ||
| } | ||
| return source; | ||
| } | ||
| } |
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
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.