Merge pull request #545 from Beckn-One/540-dedi-wrapper

Issue 540 - fix: remove hardcoded value and add test cases

Author: nirmay

pkg/plugin/implementation/dediregistry/README.md

@@ -1,162 +1,142 @@
 # DeDi Registry Plugin
 
-A **registry type plugin** for Beckn-ONIX that integrates with DeDi (Decentralized Digital Infrastructure) registry services.
+A **registry type plugin** for Beckn-ONIX that integrates with DeDi (Decentralized Digital Infrastructure) registry services via the new DeDi Wrapper API.
 
 ## Overview
 
-The DeDi Registry plugin is a **registry implementation** that enables Beckn-ONIX to lookup participant records from remote DeDi registries via REST API calls.
+The DeDi Registry plugin implements the `RegistryLookup` interface to retrieve public keys and participant information from DeDi registry services. It's used by the KeyManager for **signature validation of incoming requests** from other network participants.
 
-## Configuration
-
-```yaml
-plugins:
-  registry:
-    id: dediregistry
-    config:
-      baseURL: "https://dedi-api.example.com"
-      apiKey: "your-bearer-token"
-      namespaceID: "76EU8BF1gzRGGatgw7wZZb7nEVx77XSwkKDv4UDLdxh8ztty4zmbYU"
-      registryName: "dedi_registry"
-      timeout: "30"  # seconds
-```
 
-### Configuration Parameters
 
-| Parameter | Required | Description | Default |
-|-----------|----------|-------------|---------|
-| `baseURL` | Yes | DeDi registry API base URL | - |
-| `apiKey` | Yes | Bearer token for API authentication | - |
-| `namespaceID` | Yes | DeDi namespace identifier | - |
-| `registryName` | Yes | Registry name to query | - |
-| `timeout` | No | Request timeout in seconds | 30 |
 
-## Usage
 
-### In Module Configuration
+## Configuration
 
 ```yaml
-modules:
-  - name: bapTxnReceiver
-    handler:
-      plugins:
-        registry:
-          id: dediregistry
-          config:
-            baseURL: "https://dedi-registry.example.com"
-            apiKey: "your-api-key"
-            namespaceID: "beckn-network"
-            registryName: "participants"
+registry:
+  id: dediregistry
+  config:
+    url: "https://dedi-wrapper.example.com/dedi"
+    registryName: "subscribers.beckn.one"
+    timeout: 30
 ```
 
-### In Code
-
-```go
-// Load DeDi registry plugin (same as any registry plugin)
-dediRegistry, err := manager.Registry(ctx, &plugin.Config{
-    ID: "dediregistry",  // Plugin ID specifies DeDi implementation
-    Config: map[string]string{
-        "baseURL": "https://dedi-registry.example.com",
-        "apiKey": "your-api-key",
-        "namespaceID": "beckn-network",
-        "registryName": "participants",
-    },
-})
-
-// Lookup participant with dynamic subscriber ID (from request context)
-subscription := &model.Subscription{
-    Subscriber: model.Subscriber{
-        SubscriberID: "bap-network", // Extracted from Authorization header or request body
-    },
-}
-results, err := dediRegistry.Lookup(ctx, subscription)
-if err != nil {
-    return err
-}
+### Configuration Parameters
 
-// Extract public key from result (standard Beckn format)
-if len(results) > 0 {
-    publicKey := results[0].SigningPublicKey
-    subscriberID := results[0].SubscriberID
-}
-```
+| Parameter | Required | Description | Default |
+|-----------|----------|-------------|---------|
+| `url` | Yes | DeDi wrapper API base URL (include /dedi path) | - |
+| `registryName` | Yes | Registry name for lookup path | - |
+| `timeout` | No | Request timeout in seconds | Client default |
 
 ## API Integration
 
-### DeDi API URL Pattern
+### DeDi Wrapper API Format
 ```
-{baseURL}/dedi/lookup/{namespaceID}/{registryName}/{subscriberID}
+GET {url}/lookup/{subscriber_id}/{registryName}/{key_id}
 ```
 
-**Example**: `https://dedi-api.com/dedi/lookup/76EU8BF1gzRGGatgw7wZZb7nEVx77XSwkKDv4UDLdxh8ztty4zmbYU/dedi_registry/bap-network`
+**Example**: `https://dedi-wrapper.com/dedi/lookup/bpp.example.com/subscribers.beckn.one/key-1`
 
 ### Authentication
-```
-Authorization: Bearer {apiKey}
-```
+**No authentication required** - DeDi wrapper API is public.
 
-### Expected DeDi Response Format
+### Expected Response Format
 
 ```json
 {
-  "message": "Resource retrieved successfully",
+  "message": "Record retrieved from registry cache",
   "data": {
-    "namespace": "dediregistry",
-    "namespace_id": "76EU8BF1gzRGGatgw7wZZb7nEVx77XSwkKDv4UDLdxh8ztty4zmbYU",
-    "registry_name": "dedi_registry",
-    "record_name": "bap-network",
+    "record_id": "76EU8vY9TkuJ9T62Sc3FyQLf5Kt9YAVgbZhryX6mFi56ipefkP9d9a",
     "details": {
-      "key_id": "b692d295-5425-40f5-af77-d62646841dca",
-      "signing_public_key": "YK3Xqc83Bpobc1UT0ObAe6mBJMiAOkceIsNtmph9WTc=",
-      "encr_public_key": "YK3Xqc83Bpobc1UT0ObAe6mBJMiAOkceIsNtmph9WTc=",
-      "status": "SUBSCRIBED",
-      "created": "2024-01-15T10:00:00Z",
-      "updated": "2024-01-15T10:00:00Z",
-      "valid_from": "2024-01-01T00:00:00Z",
-      "valid_until": "2025-12-31T23:59:59Z"
+      "url": "http://dev.np2.com/beckn/bap",
+      "type": "BAP",
+      "domain": "energy",
+      "subscriber_id": "dev.np2.com",
+      "signing_public_key": "384qqkIIpxo71WaJPsWqQNWUDGAFnfnJPxuDmtuBiLo=",
+      "encr_public_key": "test-encr-key"
     },
-    "state": "live",
-    "created_at": "2025-10-09T06:09:48.295Z"
+    "created_at": "2025-10-27T11:45:27.963Z",
+    "updated_at": "2025-10-27T11:46:23.563Z"
   }
 }
 ```
 
-### Field Mapping to Beckn Subscription
+## Usage Context
+
+### Signature Validation Flow
+```
+1. External ONIX → Request with Authorization header
+2. ONIX Receiver → parseHeader() extracts subscriberID/keyID  
+3. validateSign step → KeyManager.LookupNPKeys()
+4. KeyManager → DeDiRegistry.Lookup() with extracted values
+5. DeDi Registry → GET {url}/lookup/{subscriberID}/{registryName}/{keyID}
+6. DeDi Wrapper → Returns participant public keys
+7. SignValidator → Validates signature using retrieved public key
+```
+
+### Module Configuration Example
 
-| DeDi Field | Beckn Field | Description |
-|------------|-------------|-------------|
-| `data.record_name` | `subscriber_id` | Participant identifier |
-| `data.details.key_id` | `key_id` | Unique key identifier |
+```yaml
+modules:
+  - name: bppTxnReceiver
+    handler:
+      plugins:
+        registry:
+          id: dediregistry
+          config:
+            url: "https://dedi-wrapper.example.com/dedi"
+            registryName: "subscribers.beckn.one"
+            timeout: 30
+      steps:
+        - validateSign  # Required for registry lookup
+        - addRoute
+```
+
+## Field Mapping
+
+| DeDi Wrapper Field | Beckn Field | Description |
+|-------------------|-------------|-------------|
+| `data.details.subscriber_id` | `subscriber_id` | Participant identifier |
+| `{key_id from URL}` | `key_id` | Unique key identifier |
 | `data.details.signing_public_key` | `signing_public_key` | Public key for signature verification |
 | `data.details.encr_public_key` | `encr_public_key` | Public key for encryption |
-| `data.details.status` | `status` | Subscription status |
-| `data.details.created` | `created` | Creation timestamp |
-| `data.details.updated` | `updated` | Last update timestamp |
-| `data.details.valid_from` | `valid_from` | Key validity start |
-| `data.details.valid_until` | `valid_until` | Key validity end |
+| `data.is_revoked` | `status` | Not mapped (Status field will be empty) |
+| `data.created_at` | `created` | Creation timestamp |
+| `data.updated_at` | `updated` | Last update timestamp |
 
-### Lookup Flow
+## Features
 
-1. **Request Processing**: Plugin extracts `subscriber_id` from incoming request
-2. **API Call**: Makes GET request to DeDi API with static config + dynamic subscriber ID
-3. **Response Parsing**: Extracts data from `data.details` object
-4. **Format Conversion**: Maps DeDi fields to Beckn Subscription format
-5. **Return**: Returns array of Subscription objects
+- **No Authentication Required**: DeDi wrapper API doesn't require API keys
+- **GET Request Format**: Simple URL-based parameter passing
+- **Comprehensive Error Handling**: Validates required fields and HTTP responses
+- **Simplified Response**: Focuses on public key retrieval for signature validation
+- **Retry Support**: Built-in retry mechanism for network resilience
 
 ## Testing
 
-Run plugin tests:
+Run the test suite:
 
 ```bash
 go test ./pkg/plugin/implementation/dediregistry -v
 ```
 
-Test coverage includes:
+The tests cover:
+- URL construction validation
+- Response parsing for new API format
+- Error handling scenarios
 - Configuration validation
-- Successful API responses
-- HTTP error handling
-- Network failures
-- Invalid JSON responses
-- Missing required fields
+- Plugin provider functionality
+
+## Migration Notes
+
+This plugin replaces direct DeDi API integration with the new DeDi Wrapper API format:
+
+- **Removed**: API key authentication, namespaceID parameters
+- **Added**: Configurable registryName parameter
+- **Changed**: POST requests → GET requests
+- **Updated**: Response structure parsing (`data.details` object)
+- **Added**: New URL path parameter format
 
 ## Dependencies
 
@@ -165,19 +145,8 @@ Test coverage includes:
 
 ## Error Handling
 
-- **Configuration Errors**: Missing required config parameters
+- **Configuration Errors**: Missing url or registryName
 - **Network Errors**: Connection failures, timeouts
-- **HTTP Errors**: Non-200 status codes from DeDi API
+- **HTTP Errors**: Non-200 status codes from DeDi wrapper
 - **Data Errors**: Missing required fields in response
-- **Validation Errors**: Empty subscriber ID in request
-
-
-### Integration Notes
-
-- **Plugin Type**: Registry implementation
-- **Interface**: Implements `RegistryLookup` interface with `Lookup(ctx, *model.Subscription) ([]model.Subscription, error)`
-- **Manager Access**: Available via `manager.Registry()` method (same as standard registry)
-- **Dynamic Lookup**: Uses `req.SubscriberID` from request context, not static configuration
-- **Data Conversion**: Automatically converts DeDi API format to Beckn Subscription format
-- **Build Integration**: Included in `build-plugins.sh`, compiles to `dediregistry.so`
-- **Usage Pattern**: Configure with `id: dediregistry` in registry plugin configuration
+- **Validation Errors**: Empty subscriber ID or key ID in request

pkg/plugin/implementation/dediregistry/cmd/plugin.go

@@ -21,7 +21,8 @@ func (d dediRegistryProvider) New(ctx context.Context, config map[string]string)
 
 	// Create dediregistry.Config directly from map - validation is handled by dediregistry.New
 	dediConfig := &dediregistry.Config{
-		BaseURL: config["baseURL"],
+		URL:          config["url"],
+		RegistryName: config["registryName"],
 	}
 
 	// Parse timeout if provided

pkg/plugin/implementation/dediregistry/cmd/plugin_test.go

@@ -10,11 +10,8 @@ func TestDediRegistryProvider_New(t *testing.T) {
 	provider := dediRegistryProvider{}
 
 	config := map[string]string{
-		"baseURL":      "https://test.com",
-		"apiKey":       "test-key",
-		"namespaceID":  "test-namespace",
-		"registryName": "test-registry",
-		"recordName":   "test-record",
+		"url":          "https://test.com/dedi",
+		"registryName": "subscribers.beckn.one",
 		"timeout":      "30",
 	}
 
@@ -47,12 +44,12 @@ func TestDediRegistryProvider_New_InvalidConfig(t *testing.T) {
 		config map[string]string
 	}{
 		{
-			name:   "missing baseURL",
-			config: map[string]string{"apiKey": "test-key"},
+			name:   "missing url",
+			config: map[string]string{"registryName": "subscribers.beckn.one", "timeout": "30"},
 		},
 		{
-			name:   "missing apiKey",
-			config: map[string]string{"baseURL": "https://test.com"},
+			name:   "missing registryName",
+			config: map[string]string{"url": "https://test.com/dedi", "timeout": "30"},
 		},
 		{
 			name:   "empty config",
@@ -75,11 +72,8 @@ func TestDediRegistryProvider_New_InvalidTimeout(t *testing.T) {
 	provider := dediRegistryProvider{}
 
 	config := map[string]string{
-		"baseURL":      "https://test.com",
-		"apiKey":       "test-key",
-		"namespaceID":  "test-namespace",
-		"registryName": "test-registry",
-		"recordName":   "test-record",
+		"url":          "https://test.com/dedi",
+		"registryName": "subscribers.beckn.one",
 		"timeout":      "invalid",
 	}
 
@@ -95,3 +89,20 @@ func TestDediRegistryProvider_New_InvalidTimeout(t *testing.T) {
 		closer()
 	}
 }
+
+func TestDediRegistryProvider_New_NilContext(t *testing.T) {
+	provider := dediRegistryProvider{}
+
+	config := map[string]string{
+		"url":          "https://test.com/dedi",
+		"registryName": "subscribers.beckn.one",
+	}
+
+	_, _, err := provider.New(nil, config)
+	if err == nil {
+		t.Error("New() with nil context should return error")
+	}
+	if err.Error() != "context cannot be nil" {
+		t.Errorf("Expected specific error message, got %v", err)
+	}
+}