schema: identify handlers by name instead of id (#154)

tidbyt · Feb 10, 2022 · 83f1711 · 83f1711
1 parent 655cf67
commit 83f1711
Show file tree

Hide file tree

Showing 3 changed files with 29 additions and 18 deletions.
diff --git a/runtime/applet.go b/runtime/applet.go
@@ -182,12 +182,12 @@ func (a *Applet) Run(config map[string]string, initializers ...ThreadInitializer
 	return roots, nil
 }
 
-// CallSchemaHandler calls the schema handler for a field, passing it a single
+// CallSchemaHandler calls a schema handler, passing it a single
 // string parameter and returning a single string value.
-func (app *Applet) CallSchemaHandler(ctx context.Context, fieldId, parameter string) (result string, err error) {
-	handler, found := app.schema.Handlers[fieldId]
+func (app *Applet) CallSchemaHandler(ctx context.Context, handlerName, parameter string) (result string, err error) {
+	handler, found := app.schema.Handlers[handlerName]
 	if !found {
-		return "", fmt.Errorf("no handler exported for field id %s", fieldId)
+		return "", fmt.Errorf("no exported handler named '%s'", handlerName)
 	}
 
 	resultVal, err := app.Call(
@@ -196,7 +196,7 @@ func (app *Applet) CallSchemaHandler(ctx context.Context, fieldId, parameter str
 		attachContext(ctx),
 	)
 	if err != nil {
-		return "", fmt.Errorf("calling schema handler for field %s: %v", fieldId, err)
+		return "", fmt.Errorf("calling schema handler %s: %v", handlerName, err)
 	}
 
 	switch handler.ReturnType {
@@ -231,7 +231,7 @@ func (app *Applet) CallSchemaHandler(ctx context.Context, fieldId, parameter str
 		return str, nil
 	}
 
-	return "", fmt.Errorf("a very unexpected error happened for field \"%s\"", fieldId)
+	return "", fmt.Errorf("a very unexpected error happened for handler \"%s\"", handlerName)
 }
 
 // GetSchema returns the config for the applet.

diff --git a/schema/schema.go b/schema/schema.go
@@ -173,7 +173,7 @@ func FromStarlark(
 					i, schemaField.Type)
 			}
 
-			schema.Handlers[schemaField.ID] = SchemaHandler{Function: handlerFun, ReturnType: handlerType}
+			schema.Handlers[schemaField.Handler] = SchemaHandler{Function: handlerFun, ReturnType: handlerType}
 		}
 	}
 

diff --git a/schema/schema_test.go b/schema/schema_test.go
@@ -524,7 +524,12 @@ def main():
 	app, err := loadApp(code)
 	assert.NoError(t, err)
 
-	jsonSchema, err := app.CallSchemaHandler(context.Background(), "generatedid", "foobar")
+	// Handlers are not identified by ID
+	_, err = app.CallSchemaHandler(context.Background(), "generatedid", "foobar")
+	assert.Error(t, err)
+
+	// They're identified by function name
+	jsonSchema, err := app.CallSchemaHandler(context.Background(), "generate_schema", "foobar")
 	assert.NoError(t, err)
 
 	var s schema.Schema
@@ -563,12 +568,15 @@ def get_schema():
     ]
 
 def generate_schema(param):
-    return [{"type": "text",
-            # this missing field is required:  "id": "generatedid",
+    field = {"type": "text",
              "name": "Generated Text",
              "description": "This Text is generated",
              "default": "-%s-" % param,
-            }]
+            }
+    if param == "win":
+        # this missing field is required
+        field["id"] = "generatedid"
+    return [field]
 
 def main():
     return None
@@ -577,7 +585,10 @@ def main():
 	app, err := loadApp(code)
 	assert.NoError(t, err)
 
-	_, err = app.CallSchemaHandler(context.Background(), "generatedid", "foobar")
+	_, err = app.CallSchemaHandler(context.Background(), "generate_schema", "win")
+	assert.NoError(t, err)
+
+	_, err = app.CallSchemaHandler(context.Background(), "generate_schema", "fail")
 	assert.Error(t, err)
 }
 
@@ -663,7 +674,7 @@ def main():
 	app, err := loadApp(code)
 	assert.NoError(t, err)
 
-	stringValue, err := app.CallSchemaHandler(context.Background(), "locationbasedid", "fart")
+	stringValue, err := app.CallSchemaHandler(context.Background(), "handle_location", "fart")
 	assert.NoError(t, err)
 	assert.Equal(t, "[{\"display\":\"\",\"text\":\"Your only option is\",\"value\":\"fart\"}]", stringValue)
 }
@@ -691,7 +702,7 @@ def main():
 	app, err := loadApp(code)
 	assert.NoError(t, err)
 
-	_, err = app.CallSchemaHandler(context.Background(), "locationbasedid", "fart")
+	_, err = app.CallSchemaHandler(context.Background(), "handle_location", "fart")
 	assert.Error(t, err)
 }
 
@@ -718,7 +729,7 @@ def main():
 	app, err := loadApp(code)
 	assert.NoError(t, err)
 
-	stringValue, err := app.CallSchemaHandler(context.Background(), "typeaheadid", "farts")
+	stringValue, err := app.CallSchemaHandler(context.Background(), "handle_typeahead", "farts")
 	assert.NoError(t, err)
 	assert.Equal(t, "[{\"display\":\"\",\"text\":\"You searched for\",\"value\":\"farts\"}]", stringValue)
 }
@@ -746,7 +757,7 @@ def main():
 	app, err := loadApp(code)
 	assert.NoError(t, err)
 
-	_, err = app.CallSchemaHandler(context.Background(), "typeaheadid", "fart")
+	_, err = app.CallSchemaHandler(context.Background(), "handle_typeahead", "fart")
 	assert.Error(t, err)
 }
 
@@ -777,7 +788,7 @@ def main():
 	app, err := loadApp(code)
 	assert.NoError(t, err)
 
-	stringValue, err := app.CallSchemaHandler(context.Background(), "oauth2id", "farts")
+	stringValue, err := app.CallSchemaHandler(context.Background(), "oauth2handler", "farts")
 	assert.NoError(t, err)
 	assert.Equal(t, "a-refresh-token", stringValue)
 }
@@ -809,7 +820,7 @@ def main():
 	app, err := loadApp(code)
 	assert.NoError(t, err)
 
-	_, err = app.CallSchemaHandler(context.Background(), "oauth2id", "farts")
+	_, err = app.CallSchemaHandler(context.Background(), "oauth2handler", "farts")
 	assert.Error(t, err)
 }