Merge pull request #124 from lucafaggianelli/dev

Release v0.3.0
lucafaggianelli · Jun 6, 2023 · b508884 · b508884
2 parents 6864770 + c620843
commit b508884
Show file tree

Hide file tree

Showing 14 changed files with 113 additions and 76 deletions.
diff --git a/README.md b/README.md
@@ -139,8 +139,14 @@ pip install -r requirements-dev.txt
 for development purposes, it's useful to run the example application:
 ```sh
 cd examples/
-export PYTHONPATH=$(pwd)/..
-uvicorn dummy.app:app --reload --reload-dir ..
+
+# Create a venv for the example app
+python -m venv .venv
+source .venv/bin/activate
+pip install -r requirements
+
+./run.sh
+# or ./run.ps1 on windows
 ```
 
 The React frontend is in the `frontend/` folder, enter the folder

diff --git a/examples/requirements.txt b/examples/requirements.txt
@@ -0,0 +1,3 @@
+-e ..
+python-dateutil
+pandas
diff --git a/examples/run.ps1 b/examples/run.ps1
@@ -1,2 +1,2 @@
-$env:PYTHONPATH="$(pwd)/.."
+$env:PYTHONPATH="$(pwd)"
 python src/app.py
diff --git a/examples/run.sh b/examples/run.sh
@@ -1,2 +1,2 @@
-export PYTHONPATH=$(pwd)/..
+export PYTHONPATH=$(pwd)
 python src/app.py
diff --git a/examples/src/app.py b/examples/src/app.py
@@ -4,7 +4,7 @@
 
 from plombery import get_app  # noqa: F401
 
-from examples.src import sales_pipeline, sync_pipeline  # noqa: F401
+from src import sales_pipeline, sync_pipeline  # noqa: F401
 
 
 if __name__ == "__main__":

diff --git a/frontend/src/components/Breadcrumbs.tsx b/frontend/src/components/Breadcrumbs.tsx
@@ -8,57 +8,61 @@ interface Props {
   pipeline: Pipeline
   trigger?: Trigger
   run?: PipelineRun
+  className?: string
 }
 
 const Separator = () => <Text>/</Text>
 
-const Breadcrumbs: React.FC<Props> = ({ pipeline, trigger, run }) => {
+const Breadcrumbs: React.FC<Props> = ({
+  pipeline,
+  trigger,
+  run,
+  className,
+}) => {
   if (run && !trigger) {
     throw new Error()
   }
 
   return (
-    <div className="breadcrumbs">
-      <Flex className="space-x-2 justify-start">
-        <Text>
-          <Link to="/">Pipelines</Link>
-        </Text>
-        <Separator />
-        <Text>
-          {trigger ? (
-            <Link to={`/pipelines/${pipeline.id}`}>{pipeline.name}</Link>
-          ) : (
-            pipeline.name
-          )}
-        </Text>
-
-        {trigger && (
-          <>
-            <Separator />
-            <Text>Triggers</Text>
-            <Separator />
-            <Text>
-              {run ? (
-                <Link to={`/pipelines/${pipeline.id}/triggers/${trigger.id}`}>
-                  {trigger.name}
-                </Link>
-              ) : (
-                trigger.name
-              )}
-            </Text>
-          </>
+    <Flex className={`gap-x-2 justify-start flex-wrap ${className || ''}`}>
+      <Text>
+        <Link to="/">Pipelines</Link>
+      </Text>
+      <Separator />
+      <Text>
+        {trigger ? (
+          <Link to={`/pipelines/${pipeline.id}`}>{pipeline.name}</Link>
+        ) : (
+          pipeline.name
         )}
+      </Text>
 
-        {run && trigger && (
-          <>
-            <Separator />
-            <Text>Runs</Text>
-            <Separator />
-            <Text>#{run.id}</Text>
-          </>
-        )}
-      </Flex>
-    </div>
+      {trigger && (
+        <>
+          <Separator />
+          <Text>Triggers</Text>
+          <Separator />
+          <Text>
+            {run ? (
+              <Link to={`/pipelines/${pipeline.id}/triggers/${trigger.id}`}>
+                {trigger.name}
+              </Link>
+            ) : (
+              trigger.name
+            )}
+          </Text>
+        </>
+      )}
+
+      {run && trigger && (
+        <>
+          <Separator />
+          <Text>Runs</Text>
+          <Separator />
+          <Text>#{run.id}</Text>
+        </>
+      )}
+    </Flex>
   )
 }
 

diff --git a/frontend/src/components/ManualRunDialog.tsx b/frontend/src/components/ManualRunDialog.tsx
@@ -195,7 +195,7 @@ const ManualRunDialog: React.FC<Props> = ({ pipeline }) => {
         icon={PlayIcon}
         onClick={() => setOpen(true)}
       >
-        Run pipeline
+        Run
       </Button>
 
       <Dialog

diff --git a/frontend/src/components/PageLayout.tsx b/frontend/src/components/PageLayout.tsx
@@ -14,7 +14,7 @@ const PageLayout: React.FC<Props> = ({ children, header }) => {
   return (
     <div className="bg-slate-50 p-6 sm:p-10 min-h-screen">
       <Flex className="items-start">
-        {header && <div className="flex-grow">{header}</div>}
+        {header && <div className="flex-grow max-w-full">{header}</div>}
         {isAuthenticated && isAuthenticationEnabled && <UserMenu />}
       </Flex>
 

diff --git a/frontend/src/components/PipelinesList.tsx b/frontend/src/components/PipelinesList.tsx
@@ -27,8 +27,8 @@ const PipelinesList: React.FC = () => {
       <List>
         {pipelines.map((pipeline) => (
           <ListItem key={pipeline.id}>
-            <div>
-              <Text>
+            <div className="min-w-0">
+              <Text className="truncate">
                 <Bold>
                   <Link to={`/pipelines/${pipeline.id}`}>{pipeline.name}</Link>
                 </Bold>

diff --git a/frontend/src/pages/pipelines/[pipelineId]/index.tsx b/frontend/src/pages/pipelines/[pipelineId]/index.tsx
@@ -53,21 +53,25 @@ const PipelineView: React.FC = () => {
   return (
     <PageLayout
       header={
-        <Flex className="items-start">
-          <div>
-            <Flex className="justify-start space-x-2">
-              <Title>Pipeline {pipeline.name}</Title>
+        <div>
+          <Flex className="items-start">
+            <Flex className="justify-start items-start md:items-center flex-col md:flex-row min-w-0">
+              <Title className="truncate max-w-full">
+                Pipeline {pipeline.name}
+              </Title>
               {pipeline.description && (
-                <Text className="truncate">
-                  &middot; {pipeline.description}
+                <Text className="truncate max-w-full">
+                  <span className="hidden md:inline mx-2">&middot;</span>
+                  {pipeline.description}
                 </Text>
               )}
             </Flex>
-            <Breadcrumbs pipeline={pipeline} />
-          </div>
 
-          <ManualRunDialog pipeline={pipeline} />
-        </Flex>
+            <ManualRunDialog pipeline={pipeline} />
+          </Flex>
+
+          <Breadcrumbs pipeline={pipeline} className="mt-4" />
+        </div>
       }
     >
       <Grid numColsMd={2} numColsLg={3} className="gap-6 mt-6">

diff --git a/frontend/src/pages/pipelines/[pipelineId]/triggers/[triggerId]/index.tsx b/frontend/src/pages/pipelines/[pipelineId]/triggers/[triggerId]/index.tsx
@@ -79,26 +79,36 @@ const TriggerView: React.FC = () => {
     <Button
       size="xs"
       color="indigo"
+      variant="secondary"
       icon={PlayIcon}
       onClick={() => {
         runPipelineMutation.mutateAsync()
       }}
     >
-      Run trigger
+      Run
     </Button>
   )
 
   return (
     <PageLayout
       header={
-        <Flex className="items-start">
-          <div>
-            <Title>Trigger {trigger.name}</Title>
-            <Breadcrumbs pipeline={pipeline} trigger={trigger} />
-          </div>
-
-          {runTriggerButton}
-        </Flex>
+        <div>
+          <Flex className="items-start">
+            <Flex className="justify-start items-start md:items-center flex-col md:flex-row min-w-0">
+              <Title className="truncate max-w-full">Trigger {trigger.name}</Title>
+              {trigger.description && (
+                <Text className="truncate max-w-full">
+                  <span className="hidden md:inline mx-2">&middot;</span>
+                  {trigger.description}
+                </Text>
+              )}
+            </Flex>
+
+            {runTriggerButton}
+          </Flex>
+
+          <Breadcrumbs pipeline={pipeline} trigger={trigger} className="mt-4" />
+        </div>
       }
     >
       <Grid numColsMd={2} numColsLg={3} className="gap-6 mt-6">

diff --git a/frontend/vite.config.ts b/frontend/vite.config.ts
@@ -11,6 +11,6 @@ export default defineConfig({
   },
   plugins: [react(), splitVendorChunkPlugin()],
   build: {
-    outDir: path.resolve('..', 'plombery', 'static'),
+    outDir: path.resolve('..', 'src', 'plombery', 'static'),
   },
 })
diff --git a/src/plombery/__init__.py b/src/plombery/__init__.py
@@ -1,5 +1,6 @@
-import logging
 from typing import List, Type
+import logging
+import os
 
 from apscheduler.schedulers.base import SchedulerAlreadyRunningError
 from pydantic import BaseModel
@@ -20,15 +21,15 @@
 _logger.addHandler(logging.StreamHandler())
 
 
+if os.getenv("DEBUG_APS"):
+    logging.basicConfig()
+    logging.getLogger("apscheduler").setLevel(logging.DEBUG)
+
+
 class _Plombery:
     def __init__(self) -> None:
         self._apply_settings()
 
-        try:
-            orchestrator.start()
-        except SchedulerAlreadyRunningError:
-            pass
-
     def _apply_settings(self):
         for notification in settings.notifications or []:
             self.add_notification_rule(notification)
@@ -51,6 +52,14 @@ async def __call__(self, scope, receive, send):
 _app = _Plombery()
 
 
+@app.on_event("startup")
+def on_fastapi_start():
+    try:
+        orchestrator.start()
+    except SchedulerAlreadyRunningError:
+        pass
+
+
 def get_app():
     return _app
 

diff --git a/src/plombery/orchestrator/__init__.py b/src/plombery/orchestrator/__init__.py
@@ -1,5 +1,5 @@
-from datetime import datetime, timedelta
 from typing import Any, Dict, Tuple
+from datetime import datetime, timedelta
 
 from apscheduler.executors.asyncio import AsyncIOExecutor
 from apscheduler.job import Job
@@ -37,6 +37,7 @@ def register_pipeline(self, pipeline: Pipeline):
 
             self.scheduler.add_job(
                 id=job_id,
+                name=job_id,
                 func=run,
                 trigger=trigger.schedule,
                 kwargs=dict(pipeline=pipeline, trigger=trigger),