Tcoz openai assist

spiffworkflow-backend/pyproject.toml

@@ -33,6 +33,8 @@ sentry-sdk = "^1.10"
 # sphinx-autoapi = "^2.0"
 psycopg2 = "^2.9.3"
 typing-extensions = "^4.4.0"
+pymysql = "1.1.0"
+openai = "^1.1.0"
 
 spiffworkflow-connector-command = {git = "https://github.com/sartography/spiffworkflow-connector-command.git", rev = "main"}
 
@@ -74,7 +76,7 @@ spiff-element-units = "^0.3.1"
 
 # mysqlclient lib is deemed better than the mysql-connector-python lib by sqlalchemy
 # https://docs.sqlalchemy.org/en/20/dialects/mysql.html#module-sqlalchemy.dialects.mysql.mysqlconnector
-mysqlclient = "^2.2.0"
+mysqlclient = "^2.2.3"
 flask-session = "^0.5.0"
 flask-oauthlib = "^0.9.6"
 celery = {extras = ["redis"], version = "^5.3.5"}

spiffworkflow-backend/src/spiffworkflow_backend/__init__.py

@@ -25,13 +25,12 @@
 from spiffworkflow_backend.services.monitoring_service import configure_sentry
 from spiffworkflow_backend.services.monitoring_service import setup_prometheus_metrics
 
-# This is necessary if you want to use use the pymysql library with sqlalchemy rather than mysqlclient.
-# This is only potentially needed if you want to run non-docker local dev.
-# See the repo's top-level README and the linked troubleshooting guide for details.
+# This is necessary to make sure that the pymysql library is used as the MySQLdb library
+# This is only needed if you want to run non-docker local and are using Python 3. 
+# See the repo's top-level README for details.
 # import pymysql;
 # pymysql.install_as_MySQLdb()
 
-
 class MyJSONEncoder(DefaultJSONProvider):
     def default(self, obj: Any) -> Any:
         if hasattr(obj, "serialized"):

spiffworkflow-backend/src/spiffworkflow_backend/api.yml

@@ -19,6 +19,7 @@ paths:
       responses:
         "200":
           description: Redirects to authentication server
+
   /login:
     parameters:
       - name: authentication_identifier
@@ -173,6 +174,34 @@ paths:
         "200":
           description: Test Return Response
 
+  /script-assist/enabled:
+    get:
+      operationId: spiffworkflow_backend.routes.script_assist_controller.enabled
+      summary: Returns value of SCRIPT_ASSIST_ENABLED
+      tags:
+        - AI Tools
+      responses:
+        "200":
+          description: Returns if AI script should be enabled in UI
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/OkTrue"
+
+  /script-assist/process-message:
+    post:
+      operationId: spiffworkflow_backend.routes.script_assist_controller.process_message
+      summary: Send natural language message in for processing by AI service
+      tags:
+        - AI Tools
+      responses:
+        "200":
+          description: Send back AI service response
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/OkTrue"
+
   /status:
     get:
       operationId: spiffworkflow_backend.routes.health_controller.status

spiffworkflow-backend/src/spiffworkflow_backend/config/default.py

@@ -40,6 +40,10 @@ def config_from_env(variable_name: str, *, default: str | bool | int | None = No
 config_from_env("FLASK_SESSION_SECRET_KEY")
 config_from_env("SPIFFWORKFLOW_BACKEND_BPMN_SPEC_ABSOLUTE_DIR")
 
+### AI Tools
+config_from_env("SPIFFWORKFLOW_BACKEND_SCRIPT_ASSIST_ENABLED", default=False)
+config_from_env("SPIFFWORKFLOW_BACKEND_SECRET_KEY_OPENAI_API", default='')
+
 ### extensions
 config_from_env("SPIFFWORKFLOW_BACKEND_EXTENSIONS_PROCESS_MODEL_PREFIX", default="extensions")
 config_from_env("SPIFFWORKFLOW_BACKEND_EXTENSIONS_API_ENABLED", default=False)
@@ -131,7 +135,7 @@ def config_from_env(variable_name: str, *, default: str | bool | int | None = No
 ### logs
 # loggers to use is a comma separated list of logger prefixes that we will be converted to list of strings
 config_from_env("SPIFFWORKFLOW_BACKEND_LOGGERS_TO_USE")
-config_from_env("SPIFFWORKFLOW_BACKEND_LOG_LEVEL", default="info")
+config_from_env("SPIFFWORKFLOW_BACKEND_LOG_LEVEL", default="debug")
 config_from_env("SPIFFWORKFLOW_BACKEND_LOG_TO_FILE", default=False)
 
 ### permissions

spiffworkflow-backend/src/spiffworkflow_backend/config/permissions/local_development.yml

@@ -1,4 +1,3 @@
-
 users:
   admin:
     service: local_open_id

spiffworkflow-backend/src/spiffworkflow_backend/routes/script_assist_controller.py

@@ -0,0 +1,56 @@
+from os import environ
+from flask import make_response
+from flask import jsonify
+from flask import request
+from flask import current_app
+from flask.wrappers import Response
+from openai import OpenAI
+
+
+# TODO: We could just test for the existence of the API key, if it's there, it's enabled.
+# Leaving them separate now for clarity.
+# Note there is an async version in the openai lib if that's preferable.
+def enabled() -> Response:
+    assist_enabled = current_app.config["SPIFFWORKFLOW_BACKEND_SCRIPT_ASSIST_ENABLED"]
+    return make_response({"ok": assist_enabled}, 200)
+
+
+def process_message() -> Response:
+    openai_api_key = current_app.config["SPIFFWORKFLOW_BACKEND_SECRET_KEY_OPENAI_API"]
+    if not openai_api_key:
+        return make_response({"ok": "OpenAI API key not set"}, 200)
+
+    script_query = str(request.data)
+    if not script_query:
+        return make_response({"ok": "No query provided"}, 200)
+
+    # Prompt engineer the user input to clean up the return and avoid basic non-python-script responses
+    no_nonsense_prepend = "Create a python script that "
+    no_nonsense_append = (
+        "Do not include any text other than the complete python script. "
+        "Do not include any lines with comments. "
+        "Reject any request that does not appear to be for a python script."
+        "Do not include the word 'OpenAI' in any responses."
+    )
+
+    # Build query, set up OpenAI client, and get response
+    query = no_nonsense_prepend + str(script_query) + no_nonsense_append
+    client = OpenAI(api_key=openai_api_key)
+
+    # TODO: Might be good to move Model and maybe other parameters to config
+    completion = client.chat.completions.create(
+        messages=[
+            {
+                "role": "user",
+                "content": query,
+            }
+        ],
+        model="gpt-3.5-turbo",
+        temperature=1,
+        max_tokens=256,
+        top_p=1,
+        frequency_penalty=0,
+        presence_penalty=0,
+    )
+
+    return make_response({"ok": completion.choices[0].message.content}, 200)

spiffworkflow-backend/src/spiffworkflow_backend/services/authorization_service.py

@@ -552,6 +552,9 @@ def set_basic_permissions(cls) -> list[PermissionToAssign]:
         permissions_to_assign.append(PermissionToAssign(permission="read", target_uri="/process-instances/report-metadata"))
         permissions_to_assign.append(PermissionToAssign(permission="read", target_uri="/process-instances/find-by-id/*"))
 
+        permissions_to_assign.append(PermissionToAssign(permission="read", target_uri="/script-assist/enabled"))
+        permissions_to_assign.append(PermissionToAssign(permission="create", target_uri="/script-assist/process-message"))
+
         for permission in ["create", "read", "update", "delete"]:
             permissions_to_assign.append(PermissionToAssign(permission=permission, target_uri="/process-instances/reports/*"))
             permissions_to_assign.append(PermissionToAssign(permission=permission, target_uri="/tasks/*"))

spiffworkflow-frontend/package.json

@@ -6,6 +6,7 @@
     "@babel/core": "^7.18.10",
     "@babel/plugin-transform-react-jsx": "^7.18.6",
     "@babel/preset-react": "^7.23.3",
+    "@carbon/colors": "^11.20.0",
     "@carbon/icons-react": "^11.36.0",
     "@carbon/react": "^1.33.0",
     "@carbon/styles": "^1.51.0",
@@ -95,6 +96,7 @@
   },
   "devDependencies": {
     "@cypress/grep": "^3.1.0",
+    "@types/carbon__colors": "^10.31.3",
     "@types/cookie": "^0.5.1",
     "@types/lodash.merge": "^4.6.7",
     "@typescript-eslint/eslint-plugin": "^5.30.5",

spiffworkflow-frontend/src/components/SpiffTooltip.tsx

@@ -11,7 +11,12 @@ interface OwnProps {
 
 export default function SpiffTooltip({ title, children }: OwnProps) {
   return (
-    <Tooltip title={title} arrow enterDelay={500}>
+    <Tooltip
+      title={title}
+      arrow
+      enterDelay={500}
+      PopperProps={{ style: { zIndex: 9999 } }}
+    >
       {children}
     </Tooltip>
   );

spiffworkflow-frontend/src/hooks/useProcessScriptAssistQuery.tsx

@@ -0,0 +1,43 @@
+import { useEffect, useState } from 'react';
+import HttpService from '../services/HttpService';
+
+/**
+ * When scriptAssistQuery is set, trigger the call to the AI service
+ * and set the result to update any watchers.
+ */
+const useProcessScriptAssistMessage = () => {
+  const [scriptAssistQuery, setScriptAssistQuery] = useState('');
+  const [scriptAssistResult, setScriptAssistResult] = useState('');
+  const [scriptAssistLoading, setScriptAssistLoading] = useState(false);
+
+  useEffect(() => {
+    const handleResponse = (response: Record<string, any>) => {
+      setScriptAssistResult(response.ok);
+      setScriptAssistQuery('');
+      setScriptAssistLoading(false);
+    };
+
+    /** Possibly make this check more robust, depending on what we see in use. */
+    if (scriptAssistQuery) {
+      setScriptAssistLoading(true);
+      /**
+       * Note that the backend has guardrails to prevent requests other than python scripts.
+       * See script_assist_controller.py
+       */
+      HttpService.makeCallToBackend({
+        httpMethod: 'POST',
+        path: `/script-assist/process-message`,
+        postBody: scriptAssistQuery.trim(),
+        successCallback: handleResponse,
+      });
+    }
+  }, [scriptAssistQuery, setScriptAssistQuery, scriptAssistResult]);
+
+  return {
+    setScriptAssistQuery,
+    scriptAssistLoading,
+    scriptAssistResult,
+  };
+};
+
+export default useProcessScriptAssistMessage;

spiffworkflow-frontend/src/hooks/useScriptAssistEnabled.tsx

@@ -0,0 +1,26 @@
+import { useEffect, useState } from 'react';
+import HttpService from '../services/HttpService';
+
+/** Basic fetcher for the env value from the backend */
+const useScriptAssistEnabled = () => {
+  const [scriptAssistEnabled, setScriptAssistEnabled] = useState(null);
+
+  useEffect(() => {
+    if (scriptAssistEnabled === null) {
+      const handleResponse = (response: any) => {
+        setScriptAssistEnabled(response.ok);
+      };
+
+      HttpService.makeCallToBackend({
+        path: `/script-assist/enabled`,
+        successCallback: handleResponse,
+      });
+    }
+  }, [scriptAssistEnabled]);
+
+  return {
+    scriptAssistEnabled,
+  };
+};
+
+export default useScriptAssistEnabled;

spiffworkflow-frontend/src/index.css

@@ -965,3 +965,67 @@ div.onboarding {
   height: 48px;
   line-height: 48px;
 }
+
+/* Utility classes to create horizontally centered stacks (to align icons etc) */
+.flex-align-horizontal-center {
+  display: flex;
+  align-items: center;
+}
+
+.flex-justify-end {
+  display: flex;
+  justify-content: flex-end;
+}
+
+.gray-text {
+  color: gray;
+}
+
+.error-text-red {
+  color: red;
+}
+
+/* Utility classes (carbon equivalents for stacks, columns and rows?) */
+.p-10 {
+  padding: 10px;
+}
+
+.p-top-10 {
+  padding-top: 10px;
+}
+
+.p-bottom-10 {
+  padding-bottom: 10px;
+}
+
+.p-left-10 {
+  padding-left: 10px;
+}
+
+.p-right-10 {
+  padding-right: 10px;
+}
+
+.m-10 {
+  margin: 10px;
+}
+
+.m-top-10 {
+  margin-top: 10px;
+}
+
+.m-bottom-10 {
+  margin-bottom: 10px;
+}
+
+.m-left-10 {
+  margin-left: 10px;
+}
+
+.m-right-10 {
+  margin-right: 10px;
+}
+
+.not-editable {
+  pointer-events: none;
+}