forked from jlandersen/vscode-kafka
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Support for local Avro schema in CONSUMER/PRODUCER of kafka-file
Fixes jlandersen#114 Signed-off-by: azerr <[email protected]>
- Loading branch information
1 parent
edd4597
commit eec0f66
Showing
14 changed files
with
465 additions
and
61 deletions.
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
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 |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
|
|
||
| { | ||
| "$schema": "http://json-schema.org/draft-06/schema#", | ||
| "title": "Avro Schema Definition", | ||
| "description": "Json-Schema definition for Avro AVSC files.", | ||
| "definitions": { | ||
| "avroSchema": { | ||
| "title": "Avro Schema", | ||
| "description": "Root Schema", | ||
| "oneOf": [ | ||
| { "$ref": "#/definitions/types" } | ||
| ] | ||
| }, | ||
| "types": { | ||
| "title": "Avro Types", | ||
| "description": "Allowed Avro types", | ||
| "oneOf": [ | ||
| { "$ref": "#/definitions/primitiveType" }, | ||
| { "$ref": "#/definitions/primitiveTypeWithMetadata" }, | ||
| { "$ref": "#/definitions/customTypeReference" }, | ||
| { "$ref": "#/definitions/avroRecord" }, | ||
| { "$ref": "#/definitions/avroEnum" }, | ||
| { "$ref": "#/definitions/avroArray" }, | ||
| { "$ref": "#/definitions/avroMap" }, | ||
| { "$ref": "#/definitions/avroFixed" }, | ||
| { "$ref": "#/definitions/avroUnion" } | ||
| ] | ||
| }, | ||
| "primitiveType": { | ||
| "title": "Primitive Type", | ||
| "description": "Basic type primitives.", | ||
| "type":"string", | ||
| "enum": [ | ||
| "null", | ||
| "boolean", | ||
| "int", | ||
| "long", | ||
| "float", | ||
| "double", | ||
| "bytes", | ||
| "string" | ||
| ] | ||
| }, | ||
| "primitiveTypeWithMetadata": { | ||
| "title": "Primitive Type With Metadata", | ||
| "description": "A primitive type with metadata attached.", | ||
| "type": "object", | ||
| "properties": { | ||
| "type": { "$ref": "#/definitions/primitiveType" } | ||
| }, | ||
| "required": ["type"] | ||
| }, | ||
| "customTypeReference": { | ||
| "title": "Custom Type", | ||
| "description": "Reference to a ComplexType", | ||
| "not": { "$ref": "#/definitions/primitiveType" }, | ||
| "type": "string", | ||
| "pattern": "^[A-Za-z_][A-Za-z0-9_]*(\\.[A-Za-z_][A-Za-z0-9_]*)*$" | ||
| }, | ||
| "avroUnion": { | ||
| "title": "Union", | ||
| "description": "A Union of types", | ||
| "type": "array", | ||
| "items": { "$ref": "#/definitions/avroSchema" }, | ||
| "minItems": 1 | ||
| }, | ||
| "avroField": { | ||
| "title": "Field", | ||
| "description": "A field within a Record", | ||
| "type": "object", | ||
| "properties": { | ||
| "name": { "$ref": "#/definitions/name" }, | ||
| "type": { "$ref": "#/definitions/types" }, | ||
| "doc": { "type": "string" }, | ||
| "default": { }, | ||
| "order": { "enum": ["ascending", "descending", "ignore"] }, | ||
| "aliases": { "type": "array", "items": { "$ref": "#/definitions/name" } } | ||
| }, | ||
| "required": ["name", "type"] | ||
| }, | ||
| "avroRecord": { | ||
| "title": "Record", | ||
| "description": "A Record", | ||
| "type": "object", | ||
| "properties": { | ||
| "type": {"type":"string", "enum": ["record"]}, | ||
| "name": { "$ref": "#/definitions/name" }, | ||
| "namespace": { "$ref": "#/definitions/namespace" }, | ||
| "doc": { "type": "string" }, | ||
| "aliases": { "type": "array", "items": { "$ref": "#/definitions/name" } }, | ||
| "fields": { "type": "array", "items": { "$ref": "#/definitions/avroField" } } | ||
| }, | ||
| "required": ["type", "name", "fields"] | ||
| }, | ||
| "avroEnum": { | ||
| "title": "Enum", | ||
| "description": "An enumeration", | ||
| "type": "object", | ||
| "properties": { | ||
| "type": {"type":"string", "enum": ["enum"]}, | ||
| "name": { "$ref": "#/definitions/name" }, | ||
| "namespace": { "$ref": "#/definitions/namespace" }, | ||
| "doc": { "type": "string" }, | ||
| "aliases": { "type": "array", "items": { "$ref": "#/definitions/name" } }, | ||
| "symbols": { "type": "array", "items": { "$ref": "#/definitions/name" } } | ||
| }, | ||
| "required": ["type", "name", "symbols"] | ||
| }, | ||
| "avroArray": { | ||
| "title": "Array", | ||
| "description": "An array", | ||
| "type": "object", | ||
| "properties": { | ||
| "type": {"type":"string", "enum": ["array"]}, | ||
| "name": { "$ref": "#/definitions/name" }, | ||
| "namespace": { "$ref": "#/definitions/namespace" }, | ||
| "doc": { "type": "string" }, | ||
| "aliases": { "type": "array", "items": { "$ref": "#/definitions/name" } }, | ||
| "items": { "$ref": "#/definitions/types" } | ||
| }, | ||
| "required": ["type", "items"] | ||
| }, | ||
| "avroMap": { | ||
| "title": "Map", | ||
| "description": "A map of values", | ||
| "type": "object", | ||
| "properties": { | ||
| "type": {"type":"string", "enum": ["map"]}, | ||
| "name": { "$ref": "#/definitions/name" }, | ||
| "namespace": { "$ref": "#/definitions/namespace" }, | ||
| "doc": { "type": "string" }, | ||
| "aliases": { "type": "array", "items": { "$ref": "#/definitions/name" } }, | ||
| "values": { "$ref": "#/definitions/types" } | ||
| }, | ||
| "required": ["type", "values"] | ||
| }, | ||
| "avroFixed": { | ||
| "title": "Fixed", | ||
| "description": "A fixed sized array of bytes", | ||
| "type": "object", | ||
| "properties": { | ||
| "type": {"type":"string", "enum": ["fixed"]}, | ||
| "name": { "$ref": "#/definitions/name" }, | ||
| "namespace": { "$ref": "#/definitions/namespace" }, | ||
| "doc": { "type": "string" }, | ||
| "aliases": { "type": "array", "items": { "$ref": "#/definitions/name" } }, | ||
| "size": {"type":"number"} | ||
| }, | ||
| "required": ["type", "name", "size"] | ||
| }, | ||
| "name": { | ||
| "type": "string", | ||
| "pattern": "^[A-Za-z_][A-Za-z0-9_]*$" | ||
| }, | ||
| "namespace": { | ||
| "type": "string", | ||
| "pattern": "^([A-Za-z_][A-Za-z0-9_]*(\\.[A-Za-z_][A-Za-z0-9_]*)*)*$" | ||
| } | ||
| }, | ||
| "oneOf": [ | ||
| { "$ref": "#/definitions/avroSchema" } | ||
| ] | ||
| } |
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,39 @@ | ||
| import * as fs from 'fs'; | ||
| import * as avro from 'avsc'; | ||
| import { Disposable, ExtensionContext, TextDocument, window, workspace, WorkspaceFolder } from "vscode"; | ||
| import { registerAvroSerialization } from "./serialization"; | ||
|
|
||
| const ENCODING = 'utf-8'; | ||
|
|
||
| export function registerAvroFileSupport(context: ExtensionContext): Disposable { | ||
| // register avro serializer/deserializer from a local *.avro file | ||
| registerAvroSerialization(); | ||
|
|
||
| return { | ||
| dispose() { | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| export function resolvePath(path: string): string { | ||
| const currentFile: TextDocument | undefined = (window.activeTextEditor && window.activeTextEditor.document && window.activeTextEditor.document.languageId === 'kafka') ? window.activeTextEditor.document : undefined; | ||
| // const currentFileUri: string |undefined = (currentFile && currentFile.uri) ? currentFile.uri.fsPath : undefined; | ||
| const currentWorkspace: WorkspaceFolder | undefined = (currentFile && currentFile.uri) ? workspace.getWorkspaceFolder(currentFile.uri) : undefined; | ||
| const currentWorkspaceUri: string | undefined = (currentWorkspace && currentWorkspace.uri.fsPath) | ||
| || (workspace.workspaceFolders && workspace.workspaceFolders[0].uri.fsPath); | ||
| const resolvedPath = currentWorkspaceUri + '/' + path; | ||
| return resolvedPath; | ||
| } | ||
|
|
||
| export function readAVSC(path: string): avro.Type { | ||
| const resolvedPath = resolvePath(path); | ||
| const rawSchema = JSON.parse(fs.readFileSync(resolvedPath, ENCODING)); | ||
| return avro.Type.forSchema(rawSchema); | ||
| } | ||
|
|
||
| export function checkAVSC(path: string) : string | undefined{ | ||
| const resolvedPath = resolvePath(path); | ||
| if (!fs.existsSync(resolvedPath)) { | ||
| return `The '${path}' resolved with the file '${resolvedPath}' cannot be found.`; | ||
| } | ||
| } |
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,40 @@ | ||
| import { Deserializer, registerDeserializer, registerSerializer, SerializationException, SerializationSetting, Serializer } from "../client/serialization"; | ||
| import { readAVSC } from "./avroFileSupport"; | ||
|
|
||
| export function registerAvroSerialization() { | ||
| registerSerializer("avro", new AvroSerializer()); | ||
| registerDeserializer("avro", new AvroDeserializer()); | ||
| } | ||
| class AvroSerializer implements Serializer { | ||
|
|
||
| serialize(value: string, settings: SerializationSetting[]): Buffer | string | null { | ||
| if (!settings) { | ||
| throw new SerializationException("The avro file path is required"); | ||
| } | ||
| const path = settings[0].value; | ||
| if (!path) { | ||
| throw new SerializationException("The avro file path is required"); | ||
| } | ||
| const data = JSON.parse(value); | ||
| const type = readAVSC(path); | ||
| return type.toBuffer(data); | ||
| } | ||
| } | ||
|
|
||
| class AvroDeserializer implements Deserializer { | ||
|
|
||
| deserialize(data: Buffer | null, settings?: SerializationSetting[]): any { | ||
| if (data === null) { | ||
| return null; | ||
| } | ||
| if (!settings) { | ||
| throw new SerializationException("The avro file path is required"); | ||
| } | ||
| const path = settings[0].value; | ||
| if (!path) { | ||
| throw new SerializationException("The avro file path is required"); | ||
| } | ||
| const type = readAVSC(path); | ||
| return type.fromBuffer(data); | ||
| } | ||
| } |
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
Oops, something went wrong.