eric/onix
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update nested map to flat map

Browse Source
This commit is contained in:
AshwiniK-protean
2025-03-04 16:33:49 +05:30
parent 4559ac3e5f
commit 02ebd9fd38
10 changed files with 625 additions and 148 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
plugins/config.yaml
View File

@@ -2,6 +2,5 @@ plugins:
validation_plugin:
id: tekuriValidator
config:
#schema_dir: plugins/schemas/ #approach 1
schema_dir: plugins/schemas/ #approach 2
plugin_path: plugins/implementations/ # Path to the directory containing the .so files
schema_dir: plugins/schemas/
plugin_path: plugins/implementations/

162
plugins/implementations/plugin_impl.go
View File

@@ -6,48 +6,56 @@ import (
"fmt"
"os"
"path/filepath"
"strings"
"beckn-onix/plugins"
"github.com/santhosh-tekuri/jsonschema/v6"
)
// tekuriValidator implements the Validator interface using the santhosh-tekuri/jsonschema package.
type tekuriValidator struct {
// TekuriValidator implements the Validator interface using the santhosh-tekuri/jsonschema package.
type TekuriValidator struct {
schema *jsonschema.Schema
}
type tekuriValidatorProvider struct {
schemaCache map[string]map[string]*jsonschema.Schema
//schemaCache map[string]*jsonschema.Schema
// TekuriValidatorProvider is responsible for managing and providing access to the JSON schema validators.
type TekuriValidatorProvider struct {
SchemaCache map[string]*jsonschema.Schema
}
// Validate validates the given data against the schema.
func (v *tekuriValidator) Validate(ctx context.Context, data []byte) error {
func (v *TekuriValidator) Validate(ctx context.Context, data []byte) error {
var jsonData interface{}
if err := json.Unmarshal(data, &jsonData); err != nil {
return err
}
err := v.schema.Validate(jsonData)
if err != nil {
// TODO: Integrate with the logging module once it is ready
fmt.Printf("Validation error: %v\n", err)
}
return err
}
// (Approach 2)(all json files for each schema from sub directories)
func (vp *tekuriValidatorProvider) Initialize(schemaDir string) (map[string]plugins.Validator, error) {
vp.schemaCache = make(map[string]map[string]*jsonschema.Schema)
// Initialize initializes the validator provider by compiling all the JSON schema files
// from the specified directory and storing them in a cache. It returns a map of validators
// indexed by their schema filenames.
func (vp *TekuriValidatorProvider) Initialize(schemaDir string) (map[string]plugins.Validator, error) {
// Initialize the SchemaCache map to store the compiled schemas using a unique key (domain/version/schema).
vp.SchemaCache = make(map[string]*jsonschema.Schema)
// Initialize the validatorCache map to store the Validator instances associated with each schema.
validatorCache := make(map[string]plugins.Validator)
compiler := jsonschema.NewCompiler()
// Walk through the schema directory and process each file.
err := filepath.Walk(schemaDir, func(path string, info os.FileInfo, err error) error {
if err != nil {
return err
}
// Only process files (ignore directories) and ensure the file has a ".json" extension.
if !info.IsDir() && filepath.Ext(info.Name()) == ".json" {
filePath := filepath.Join(schemaDir, info.Name())
compiler := jsonschema.NewCompiler()
compiledSchema, err := compiler.Compile(path)
if err != nil {
return fmt.Errorf("failed to compile JSON schema from file %s: %v", info.Name(), err)
@@ -56,12 +64,31 @@ func (vp *tekuriValidatorProvider) Initialize(schemaDir string) (map[string]plug
return fmt.Errorf("compiled schema is nil for file %s", info.Name())
}
dir := filepath.Base(filepath.Dir(filePath))
if vp.schemaCache[dir] == nil {
vp.schemaCache[dir] = make(map[string]*jsonschema.Schema)
// Use relative path from schemaDir to avoid absolute paths and make schema keys domain/version specific.
relativePath, err := filepath.Rel(schemaDir, path)
if err != nil {
return fmt.Errorf("failed to get relative path for file %s: %v", info.Name(), err)
}
vp.schemaCache[dir][info.Name()] = compiledSchema
validatorCache[info.Name()] = &tekuriValidator{schema: compiledSchema}
// Split the relative path to get domain, version, and schema.
parts := strings.Split(relativePath, string(os.PathSeparator))
// Ensure that the file path has at least 3 parts: domain, version, and schema file.
if len(parts) < 3 {
return fmt.Errorf("invalid schema file structure, expected domain/version/schema.json but got: %s", relativePath)
}
// Extract domain, version, and schema filename from the parts.
domain := parts[0]
version := parts[1]
schemaFileName := parts[2]
// Construct a unique key combining domain, version, and schema name (e.g., ondc_trv10/v2.0.0/schema.json).
uniqueKey := fmt.Sprintf("%s/%s/%s", domain, version, schemaFileName)
// Store the compiled schema in the SchemaCache using the unique key.
vp.SchemaCache[uniqueKey] = compiledSchema
// Store the corresponding validator in the validatorCache using the same unique key.
validatorCache[uniqueKey] = &TekuriValidator{schema: compiledSchema}
}
return nil
})
@@ -72,110 +99,11 @@ func (vp *tekuriValidatorProvider) Initialize(schemaDir string) (map[string]plug
return validatorCache, nil
}
var _ plugins.ValidatorProvider = (*tekuriValidatorProvider)(nil)
var _ plugins.ValidatorProvider = (*TekuriValidatorProvider)(nil)
var providerInstance = &tekuriValidatorProvider{}
var providerInstance = &TekuriValidatorProvider{}
// GetProvider returns the ValidatorProvider instance.
func GetProvider() plugins.ValidatorProvider {
return providerInstance
}
///////////////////////
//(Approach 2)(all json files for each schema)
// Initialize reads all .json files from the given schema directory, validates them using JSON Schema, and prints the result.
// func (vp *tekuriValidatorProvider) Initialize(schemaDir string) (map[string]plugins.Validator, error) {
// //start := time.Now()
// // Initialize the cache
// vp.schemaCache = make(map[string]map[string]*jsonschema.Schema)
// validatorCache := make(map[string]plugins.Validator)
// // Read the directory
// files, err := ioutil.ReadDir(schemaDir)
// if err != nil {
// return nil, fmt.Errorf("failed to read schema directory: %v", err)
// }
// for _, file := range files {
// if filepath.Ext(file.Name()) == ".json" {
// // Read the JSON file
// filePath := filepath.Join(schemaDir, file.Name())
// fmt.Println("file path : ", filePath)
// compiler := jsonschema.NewCompiler()
// compiledSchema, err := compiler.Compile(filePath)
// if err != nil {
// return nil, fmt.Errorf("failed to compile JSON schema from file %s: %v", file.Name(), err)
// }
// if compiledSchema == nil {
// return nil, fmt.Errorf("compiled schema is nil for file %s", file.Name())
// }
// // Extract directory and filename to use in the nested map
// dir := filepath.Base(filepath.Dir(filePath))
// if vp.schemaCache[dir] == nil {
// vp.schemaCache[dir] = make(map[string]*jsonschema.Schema)
// }
// // Store the compiled schema in the nested cache
// vp.schemaCache[dir][file.Name()] = compiledSchema
// validatorCache[file.Name()] = &tekuriValidator{schema: compiledSchema}
// }
// }
// // fmt.Printf("initialize executed in %s\n", time.Since(start))
// return validatorCache, nil
//////////////////////////////////////////////////////////
// (Approach 1)
// func (vp *tekuriValidatorProvider) Initialize(schemaDir string) (map[string]plugins.Validator, error) {
// // start := time.Now()
// vp.schemaCache = make(map[string]*jsonschema.Schema)
// validatorCache := make(map[string]plugins.Validator)
// files, err := ioutil.ReadDir(schemaDir)
// if err != nil {
// return nil, fmt.Errorf("failed to read schema directory: %w", err)
// }
// for _, file := range files {
// if filepath.Ext(file.Name()) == ".json" {
// filePath := filepath.Join(schemaDir, file.Name())
// // Read the file content
// content, err := ioutil.ReadFile(filePath)
// if err != nil {
// return nil, fmt.Errorf("failed to read file %s: %v", filePath, err)
// }
// var schemaDoc map[string]interface{}
// if err := json.Unmarshal(content, &schemaDoc); err != nil {
// return nil, fmt.Errorf("failed to unmarshal JSON schema from file %s: %v", filePath, err)
// }
// if defs, exists := schemaDoc["$defs"]; exists {
// defsMap := defs.(map[string]interface{})
// for name, defSchema := range defsMap {
// _, err := json.Marshal(defSchema)
// if err != nil {
// return nil, fmt.Errorf("failed to marshal schema definition %s: %v", name, err)
// }
// compiler := jsonschema.NewCompiler()
// if err := compiler.AddResource(name, filepath.Dir(filePath)); err != nil {
// return nil, fmt.Errorf("failed to add resource for schema definition %s: %v", name, err)
// }
// compiledSchema, err := compiler.Compile(filePath)
// if err != nil {
// return nil, fmt.Errorf("failed to compile schema definition: %v", err)
// }
// schemaKey := fmt.Sprintf("%s.%s", file.Name(), name)
// vp.schemaCache[schemaKey] = compiledSchema
// validatorCache[schemaKey] = &tekuriValidator{schema: compiledSchema}
// }
// }
// }
// }
// // fmt.Printf("Initialize executed in %s\n", time.Since(start))
// return validatorCache, nil
// }

28
plugins/implementations/plugin_impl_test.go
View File

@@ -20,7 +20,7 @@ type Context struct{}
type Message struct{}
func TestInitializeValidDirectory(t *testing.T) {
provider := &tekuriValidatorProvider{}
provider := &TekuriValidatorProvider{}
schemaDir := "../schemas/"
_, err := provider.Initialize(schemaDir)
if err != nil {
@@ -29,7 +29,7 @@ func TestInitializeValidDirectory(t *testing.T) {
}
func TestInitializeInValidDirectory(t *testing.T) {
provider := &tekuriValidatorProvider{}
provider := &TekuriValidatorProvider{}
schemaDir := "../schema/ondc_trv10_2.0.0/"
_, err := provider.Initialize(schemaDir)
if err != nil {
@@ -42,7 +42,7 @@ func TestInvalidCompileFile(t *testing.T) {
if _, err := os.Stat(schemaDir); os.IsNotExist(err) {
t.Fatalf("Schema directory does not exist: %v", schemaDir)
}
provider := &tekuriValidatorProvider{}
provider := &TekuriValidatorProvider{}
compiledSchema, err := provider.Initialize(schemaDir)
if err != nil {
t.Fatalf("failed to compile JSON schema : %v", err)
@@ -58,7 +58,7 @@ func TestInvalidCompileSchema(t *testing.T) {
if _, err := os.Stat(schemaDir); os.IsNotExist(err) {
t.Fatalf("Schema directory does not exist: %v", schemaDir)
}
provider := &tekuriValidatorProvider{}
provider := &TekuriValidatorProvider{}
compiledSchema, _ := provider.Initialize(schemaDir)
fmt.Println(compiledSchema)
if compiledSchema == nil {
@@ -72,15 +72,15 @@ func TestValidateData(t *testing.T) {
if _, err := os.Stat(schemaDir); os.IsNotExist(err) {
t.Fatalf("Schema directory does not exist: %v", schemaDir)
}
provider := &tekuriValidatorProvider{}
provider := &TekuriValidatorProvider{}
validators, err := provider.Initialize(schemaDir)
if err != nil {
t.Fatalf("Failed to initialize schema provider: %v", err)
}
var validator *tekuriValidator
var validator *TekuriValidator
for _, v := range validators {
var ok bool
validator, ok = v.(*tekuriValidator)
validator, ok = v.(*TekuriValidator)
if ok {
break
}
@@ -89,7 +89,7 @@ func TestValidateData(t *testing.T) {
t.Fatalf("No validators found in the map")
}
payloadFilePath := "../test/payload.json"
payloadFilePath := "../testData/payload.json"
payloadData, err := ioutil.ReadFile(payloadFilePath)
if err != nil {
t.Fatalf("Failed to read payload data: %v", err)
@@ -114,15 +114,15 @@ func TestInValidateData(t *testing.T) {
t.Fatalf("Schema directory does not exist: %v", schemaDir)
}
provider := &tekuriValidatorProvider{}
provider := &TekuriValidatorProvider{}
validators, err := provider.Initialize(schemaDir)
if err != nil {
t.Fatalf("Failed to initialize schema provider: %v", err)
}
var validator *tekuriValidator
var validator *TekuriValidator
for _, v := range validators {
var ok bool
validator, ok = v.(*tekuriValidator)
validator, ok = v.(*TekuriValidator)
if ok {
break
}
@@ -144,15 +144,15 @@ func TestInValidateUnmarshalData(t *testing.T) {
t.Fatalf("Schema directory does not exist: %v", schemaDir)
}
provider := &tekuriValidatorProvider{}
provider := &TekuriValidatorProvider{}
validators, err := provider.Initialize(schemaDir)
if err != nil {
t.Fatalf("Failed to initialize schema provider: %v", err)
}
var validator *tekuriValidator
var validator *TekuriValidator
for _, v := range validators {
var ok bool
validator, ok = v.(*tekuriValidator)
validator, ok = v.(*TekuriValidator)
if ok {
break
}

BIN
plugins/implementations/tekuriValidator.so
View File

Binary file not shown.

BIN
plugins/schemas.zip Normal file
View File

Binary file not shown.

31
plugins/testData/cancel.json Normal file
View File

@@ -0,0 +1,31 @@
{
"context": {
"action": "cancel",
"bap_id": "example-bap.com",
"bap_uri": "https://example-bap.com/prod/trv10",
"bpp_id": "api.beckn.juspay.in/dobpp/beckn/7f7896dd-787e-4a0b-8675-e9e6fe93bb8f",
"bpp_uri": "https://example-bpp.com/prod/seller",
"domain": "ONDC:TRV10",
"location": {
"city": {
"code": "std:080"
},
"country": {
"code": "IND"
}
},
"message_id": "be6a495a-e941-4fbf-9d59-f1e6166cccc8",
"timestamp": "2023-03-23T05:15:08Z",
"transaction_id": "870782be-6757-43f1-945c-8eeaf9536259",
"ttl": "PT30S",
"version": "2.0.0"
},
"message": {
"cancellation_reason_id": "7",
"descriptor": {
"code": "SOFT_CANCEL",
"name": "Ride Cancellation"
},
"order_id": "O1"
}
}

153
plugins/testData/confirm.json Normal file
View File

@@ -0,0 +1,153 @@
{
"context": {
"action": "confirm",
"bap_id": "example-bap.com",
"bap_uri": "https://example-bap.com/prod/trv10",
"bpp_id": "example-bpp.com",
"bpp_uri": "https://example-bpp.com/prod/seller",
"domain": "ONDC:TRV10",
"location": {
"city": {
"code": "std:080"
},
"country": {
"code": "IND"
}
},
"message_id": "6743e9e2-4fb5-487c-92b7-13ba8018f176",
"timestamp": "2023-12-10T04:34:48.031Z",
"transaction_id": "870782be-6757-43f1-945c-8eeaf9536259",
"ttl": "PT30S",
"version": "2.0.0"
},
"message": {
"order": {
"billing": {
"name": "Joe Adams"
},
"fulfillments": [
{
"customer": {
"contact": {
"phone": "9876556789"
},
"person": {
"name": "Joe Adams"
}
},
"id": "F1",
"stops": [
{
"location": {
"gps": "13.008935, 77.644408"
},
"type": "START"
},
{
"location": {
"gps": "12.971186, 77.586812"
},
"type": "END"
}
],
"vehicle": {
"category": "AUTO_RICKSHAW"
}
}
],
"items": [
{
"id": "I1"
}
],
"payments": [
{
"collected_by": "BPP",
"id": "PA1",
"params": {
"bank_account_number": "xxxxxxxxxxxxxx",
"bank_code": "XXXXXXXX",
"virtual_payment_address": "9988199772@okicic"
},
"status": "NOT-PAID",
"tags": [
{
"descriptor": {
"code": "BUYER_FINDER_FEES"
},
"display": false,
"list": [
{
"descriptor": {
"code": "BUYER_FINDER_FEES_PERCENTAGE"
},
"value": "1"
}
]
},
{
"descriptor": {
"code": "SETTLEMENT_TERMS"
},
"display": false,
"list": [
{
"descriptor": {
"code": "SETTLEMENT_WINDOW"
},
"value": "PT60M"
},
{
"descriptor": {
"code": "SETTLEMENT_BASIS"
},
"value": "DELIVERY"
},
{
"descriptor": {
"code": "SETTLEMENT_TYPE"
},
"value": "UPI"
},
{
"descriptor": {
"code": "MANDATORY_ARBITRATION"
},
"value": "true"
},
{
"descriptor": {
"code": "COURT_JURISDICTION"
},
"value": "New Delhi"
},
{
"descriptor": {
"code": "DELAY_INTEREST"
},
"value": "5"
},
{
"descriptor": {
"code": "STATIC_TERMS"
},
"value": "https://example-test-bap.com/static-terms.txt"
},
{
"descriptor": {
"code": "SETTLEMENT_AMOUNT"
},
"value": "1.46"
}
]
}
],
"type": "ON-FULFILLMENT"
}
],
"provider": {
"id": "P1"
}
}
}
}

5
plugins/test/payload.json → plugins/testData/search.json
View File

@@ -1,4 +1,3 @@
{
"context": {
"action": "search",
@@ -79,7 +78,3 @@
}
}
}

352
plugins/testData/select.json Normal file
View File

@@ -0,0 +1,352 @@
{
"context": {
"action": "select",
"bap_id": "example-bap.com",
"bap_uri": "https://example-bap.com/prod/trv10",
"bpp_id": "example-bpp.com",
"bpp_uri": "https://example-bpp.com/prod/seller",
"domain": "ONDC:TRV10",
"location": {
"city": {
"code": "std:080"
},
"country": {
"code": "IND"
}
},
"message_id": "8926b747-0362-4fcc-b795-0994a6287700",
"timestamp": "2023-12-09T14:11:32.859Z",
"transaction_id": "870782be-6757-43f1-945c-8eeaf9536259",
"ttl": "PT30S",
"version": "2.0.0"
},
"message": {
"order": {
"cancellation_terms": [
{
"cancellation_fee": {
"percentage": "0"
},
"fulfillment_state": {
"descriptor": {
"code": "RIDE_ASSIGNED"
}
},
"reason_required": true
},
{
"cancellation_fee": {
"amount": {
"currency": "INR",
"value": "30"
}
},
"fulfillment_state": {
"descriptor": {
"code": "RIDE_ENROUTE_PICKUP"
}
},
"reason_required": true
},
{
"cancellation_fee": {
"amount": {
"currency": "INR",
"value": "50"
}
},
"fulfillment_state": {
"descriptor": {
"code": "RIDE_ARRIVED_PICKUP"
}
},
"reason_required": true
},
{
"cancellation_fee": {
"percentage": "100"
},
"fulfillment_state": {
"descriptor": {
"code": "RIDE_STARTED"
}
},
"reason_required": true
}
],
"fulfillments": [
{
"id": "F1",
"customer": {
"contact": {
"phone": "9876556789"
},
"person": {
"name": "Joe Adams"
}
},
"stops": [
{
"location": {
"gps": "13.008935, 77.644408"
},
"type": "START"
},
{
"location": {
"gps": "12.971186, 77.586812"
},
"type": "END"
}
],
"tags": [
{
"descriptor": {
"code": "ROUTE_INFO",
"name": "Route Information"
},
"display": true,
"list": [
{
"descriptor": {
"code": "ENCODED_POLYLINE",
"name": "Path"
},
"value": "_p~iF~ps|U_ulLnnqC_mqNvxq`@"
},
{
"descriptor": {
"code": "WAYPOINTS",
"name": "Waypoints"
},
"value": "[{\"gps\":\"12.909982, 77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982,77.611822\"},{\"gps\":\"12.909982, 77.611822\"}]"
}
]
}
],
"type": "DELIVERY",
"vehicle": {
"category": "AUTO_RICKSHAW"
}
}
],
"items": [
{
"descriptor": {
"code": "RIDE",
"name": "Auto Ride"
},
"fulfillment_ids": [
"F1"
],
"id": "I1",
"location_ids": [
"L1",
"L3"
],
"payment_ids": [
"PA1"
],
"price": {
"currency": "INR",
"maximum_value": "176",
"minimum_value": "136",
"value": "146"
},
"tags": [
{
"descriptor": {
"code": "FARE_POLICY",
"name": "Daytime Charges"
},
"display": true,
"list": [
{
"descriptor": {
"code": "MIN_FARE"
},
"value": "30"
},
{
"descriptor": {
"code": "MIN_FARE_DISTANCE_KM"
},
"value": "2"
},
{
"descriptor": {
"code": "PER_KM_CHARGE"
},
"value": "15"
},
{
"descriptor": {
"code": "PICKUP_CHARGE"
},
"value": "10"
},
{
"descriptor": {
"code": "WAITING_CHARGE_PER_MIN"
},
"value": "2"
},
{
"descriptor": {
"code": "NIGHT_CHARGE_MULTIPLIER"
},
"value": "1.5"
},
{
"descriptor": {
"code": "NIGHT_SHIFT_START_TIME"
},
"value": "22:00:00"
},
{
"descriptor": {
"code": "NIGHT_SHIFT_END_TIME"
},
"value": "05:00:00"
}
]
},
{
"descriptor": {
"code": "INFO",
"name": "General Information"
},
"display": true,
"list": [
{
"descriptor": {
"code": "DISTANCE_TO_NEAREST_DRIVER_METER"
},
"value": "661"
},
{
"descriptor": {
"code": "ETA_TO_NEAREST_DRIVER_MIN"
},
"value": "3"
}
]
}
]
}
],
"payments": [
{
"collected_by": "BPP",
"id": "PA1",
"params": {
"bank_account_number": "xxxxxxxxxxxxxx",
"bank_code": "XXXXXXXX",
"virtual_payment_address": "9988199772@okicic"
},
"status": "NOT-PAID",
"tags": [
{
"descriptor": {
"code": "BUYER_FINDER_FEES"
},
"display": false,
"list": [
{
"descriptor": {
"code": "BUYER_FINDER_FEES_PERCENTAGE"
},
"value": "1"
}
]
},
{
"descriptor": {
"code": "SETTLEMENT_TERMS"
},
"display": false,
"list": [
{
"descriptor": {
"code": "DELAY_INTEREST"
},
"value": "5"
},
{
"descriptor": {
"code": "SETTLEMENT_TYPE"
},
"value": "UPI"
},
{
"descriptor": {
"code": "SETTLEMENT_WINDOW"
},
"value": "PT2D"
},
{
"descriptor": {
"code": "SETTLEMENT_BASIS"
},
"value": "DELIVERY"
},
{
"descriptor": {
"code": "MANDATORY_ARBITRATION"
},
"value": "true"
},
{
"descriptor": {
"code": "COURT_JURISDICTION"
},
"value": "New Delhi"
},
{
"descriptor": {
"code": "STATIC_TERMS"
},
"value": "https://example-test-bpp.com/static-terms.txt"
},
{
"descriptor": {
"code": "SETTLEMENT_AMOUNT"
},
"value": "1.46"
}
]
}
],
"type": "ON-FULFILLMENT"
}
],
"provider": {
"id": "P1"
},
"quote": {
"breakup": [
{
"price": {
"currency": "INR",
"value": "30"
},
"title": "BASE_FARE"
},
{
"price": {
"currency": "INR",
"value": "116"
},
"title": "DISTANCE_FARE"
}
],
"price": {
"currency": "INR",
"value": "146"
},
"ttl": "PT30S"
}
}
}
}