Skip to content

feat: Implement GetSpecSchema plugin gRPC API call #133

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

Merged
merged 2 commits into from
Feb 12, 2024
Merged

feat: Implement GetSpecSchema plugin gRPC API call #133

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bd0305b
feat: Implement `GetSpecSchema` plugin gRPC API call
candiduslynx Feb 12, 2024
ceaffae
npm run format
candiduslynx Feb 12, 2024
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
8 changes: 4 additions & 4 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@
},
"dependencies": {
"@apache-arrow/esnext-esm": "^12.0.1",
"@cloudquery/plugin-pb-javascript": "^0.0.14",
"@cloudquery/plugin-pb-javascript": "^0.0.15",
"@grpc/grpc-js": "^1.9.0",
"@types/luxon": "^3.3.1",
"ajv": "^8.12.0",
Expand Down
14 changes: 14 additions & 0 deletions src/grpc/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,20 @@ export class PluginServer extends pluginV3.cloudquery.plugin.v3.UnimplementedPlu
): void {
return callback(null, new pluginV3.cloudquery.plugin.v3.GetVersion.Response({ version: this.plugin.version() }));
}

GetSpecSchema(
call: grpc.ServerUnaryCall<
pluginV3.cloudquery.plugin.v3.GetSpecSchema.Request,
pluginV3.cloudquery.plugin.v3.GetSpecSchema.Response
>,
callback: grpc.sendUnaryData<pluginV3.cloudquery.plugin.v3.GetSpecSchema.Response>,
): void {
return callback(
null,
new pluginV3.cloudquery.plugin.v3.GetSpecSchema.Response({ json_schema: this.plugin.jsonSchema() }),
);
}

Init(
call: grpc.ServerUnaryCall<pluginV3.cloudquery.plugin.v3.Init.Request, pluginV3.cloudquery.plugin.v3.Init.Response>,
callback: grpc.sendUnaryData<pluginV3.cloudquery.plugin.v3.Init.Response>,
Expand Down
23 changes: 22 additions & 1 deletion src/memdb/memdb.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,28 @@ export const newMemDBPlugin = (): Plugin => {
return Promise.resolve(pluginClient);
};

const plugin = newPlugin('memdb', '0.0.1', newClient, { team: 'cloudquery', kind: 'source' });
const plugin = newPlugin('memdb', '0.0.1', newClient, {
team: 'cloudquery',
kind: 'source',
jsonSchema: `{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://github.com/cloudquery/plugin-sdk-javascript/memdb/spec",
"$ref": "#/$defs/Spec",
"$defs": {
"Spec": {
"properties": {
"concurrency": {
"type": "integer",
"minimum": 1,
"description": "Concurrency."
}
},
"additionalProperties": false,
"type": "object",
},
}
}`,
});
pluginClient.plugin = plugin;
return plugin;
};
3 changes: 3 additions & 0 deletions src/plugin/plugin.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ export type PluginOptions = {
kind: PluginKind;
dockerFile?: string;
buildTargets?: BuildTarget[];
jsonSchema?: string;
};

export interface SourceClient {
Expand All @@ -65,6 +66,7 @@ export interface Plugin extends Client {
version: () => string;
team: () => string | undefined;
kind: () => PluginKind | undefined;
jsonSchema: () => string | undefined;
dockerFile: () => string;
buildTargets: () => BuildTarget[];
init: (spec: string, options: NewClientOptions) => Promise<void>;
Expand Down Expand Up @@ -102,6 +104,7 @@ export const newPlugin = (
version: () => version,
team: () => options?.team,
kind: () => options?.kind,
jsonSchema: () => options?.jsonSchema,
dockerFile: () => options?.dockerFile || 'Dockerfile',
buildTargets: () => options?.buildTargets || defaultBuildTargets,
write: (stream: WriteStream) => {
Expand Down