feat!: Plugsy can now work in agent mode.

It can now gather statuses from within a cluster and push to another plugsy endpoint, docs to follow. Huge refactor. breaking change: the types for each of the config plugins is now capitalised.
plugsy · Jun 25, 2021 · 8a41ed1 · 8a41ed1
1 parent 1ea53b1
commit 8a41ed1
Show file tree

Hide file tree

Showing 42 changed files with 2,575 additions and 708 deletions.
diff --git a/.github/workflows/build-publish.yml b/.github/workflows/build-publish.yml
@@ -92,7 +92,7 @@ jobs:
         uses: jacobtomlinson/gha-find-replace@master
         with:
           find: "https:\\/\\/github\\.com\\/plugsy\\/core\\/releases\\/download\\/(.*?)\\/schema\\.json"
-          replace: "https://github.com/plugsy/core/releases/download/v${{ steps.extractver.outputs.version }}/schema.json"
+          replace: "https://github.com/plugsy/core/releases/download/v${{ steps.extractver.outputs.version }}/config-schema.json"
 
       - name: Create Pull Request with updated package files
         if: steps.initversion.outputs.version != steps.extractver.outputs.version

diff --git a/README.md b/README.md
@@ -97,14 +97,14 @@ config.json
 
 ```jsonc
 {
-  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/schema.json",
+  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/config-schema.json",
   "connectors": [
     {
-      "type": "docker",
+      "type": "DOCKER",
       "config": {}
     },
     {
-      "type": "raw",
+      "type": "RAW",
       "config": {
         "id": "file",
         "items": [
@@ -165,14 +165,14 @@ Example using the [raw connector](docs/connectors/raw.md):
 
 ```jsonc
 {
-  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/schema.json",
+  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/config-schema.json",
   "connectors": [
     {
-      "type": "docker",
+      "type": "DOCKER",
       "config": {}
     },
     {
-      "type": "raw",
+      "type": "RAW",
       "config": {
         "id": "file",
         "items": [

diff --git a/client/components/Favicon/index.tsx b/client/components/Favicon/index.tsx
@@ -5,19 +5,13 @@ export interface FaviconProps {
 }
 
 export const Favicon: React.FC<FaviconProps> = ({ state = "GREEN" }) => {
+  const href =
+    state === "GREEN" ? "/favicon-success.svg" : "/favicon-error.svg";
   return (
     <Head>
-      <link
-        rel="icon"
-        type="image/svg+xml"
-        href={state === "GREEN" ? '/favicon-success.svg' : '/favicon-error.svg'}
-      />
-      <link
-        rel="mask-icon"
-        type="image/svg+xml"
-        href={state === "GREEN" ? '/favicon-success.svg' : '/favicon-error.svg'}
-      />
-      <link rel="alternate icon" href={'/favicon.ico'}/>
+      <link rel="icon" type="image/svg+xml" href={href} />
+      <link rel="mask-icon" type="image/svg+xml" href={href} />
+      <link rel="alternate icon" href={"/favicon.ico"} />
     </Head>
   );
 };
diff --git a/client/components/Item/index.tsx b/client/components/Item/index.tsx
@@ -11,8 +11,8 @@ import { SSRPopover } from "../SSRPopover";
 import { ArrowContainer } from "react-tiny-popover";
 
 interface ItemData {
-  icon?: string;
-  iconPack?: string;
+  iconName?: string | null;
+  iconPack?: string | null;
   text?: string;
   link?: string;
   status?: string;
@@ -53,14 +53,14 @@ const TextContainer = styled.div`
 const Popover: React.FC<{ entities: ItemData[] }> = ({ entities }) => {
   return (
     <PopoverContainer>
-      {entities.map(({ text, icon, status, iconPack, state }, i) => (
+      {entities.map(({ text, iconName, status, iconPack, state }, i) => (
         <Fragment key={`child-${text}`}>
           <PopoverEntity>
             <StatusBar state={state} />
             <TagInfo>
-              {icon && iconPack ? (
+              {iconName && iconPack ? (
                 <Icon>
-                  <DynamicIcon icon={icon} iconPack={iconPack} />
+                  <DynamicIcon icon={iconName} iconPack={iconPack} />
                 </Icon>
               ) : null}
               <TextContainer>
@@ -155,7 +155,7 @@ const Margins = styled.div`
 `;
 
 export const Item: React.FC<ItemProps> = ({
-  icon,
+  iconName,
   iconPack,
   text,
   link,
@@ -201,9 +201,9 @@ export const Item: React.FC<ItemProps> = ({
           <StatusBar state={state} />
           <Margins>
             <TagInfo>
-              {icon && iconPack ? (
+              {iconName && iconPack ? (
                 <Icon>
-                  <DynamicIcon icon={icon} iconPack={iconPack} />
+                  <DynamicIcon icon={iconName} iconPack={iconPack} />
                 </Icon>
               ) : null}
               <TextContainer>

diff --git a/client/pages/Home/Home.graphql b/client/pages/Home/Home.graphql
@@ -3,14 +3,16 @@ fragment FullCategory on Category {
   items {
     name
     status
-    icon
+    iconName
+    iconPack
     link
     state
     connectorType
     children {
       name
       state
-      icon
+      iconName
+      iconPack
       status
       connectorType
     }

diff --git a/client/pages/Home/Home.tsx b/client/pages/Home/Home.tsx
@@ -4,7 +4,7 @@ import parseISO from "date-fns/parseISO";
 import Head from "next/head";
 import React, { useCallback, useEffect, useState } from "react";
 import styled from "styled-components";
-import { apolloClient } from "../../../lib/apollo";
+import { createApolloClient } from "../../../lib/apollo";
 import { State } from "../../../types.graphql";
 import { ConnectionStatus } from "../../components/ConnectionStatus";
 import { Category } from "../../components/Category";
@@ -19,6 +19,9 @@ import {
 } from "./Home.generated.graphql";
 import { useHarmonicIntervalFn } from "react-use";
 import { Favicon } from "../../components/Favicon";
+import { createIsomorphLink } from "../../../lib/apollo/links";
+import { GetServerSideProps } from "next";
+import absoluteUrl from "next-absolute-url";
 
 interface Props {
   initialCategories?: FullCategoryFragment[];
@@ -140,7 +143,8 @@ export function Home({
                 ({
                   name,
                   link,
-                  icon,
+                  iconName,
+                  iconPack,
                   state,
                   children,
                   status,
@@ -150,22 +154,29 @@ export function Home({
                     key: name,
                     text: name,
                     link: link ?? undefined,
-                    iconPack: icon?.split("/")[0],
-                    icon: icon?.split("/")[1],
+                    iconPack,
+                    iconName,
                     connectorType,
                     state: statesToStatus([
                       state,
                       ...children.map((child) => child.state),
                     ]),
                     status: status ? toTitleCase(status) : undefined,
                     children: children.map(
-                      ({ name, icon, state, status, connectorType }) => ({
+                      ({
+                        name,
+                        iconName,
+                        iconPack,
+                        state,
+                        status,
+                        connectorType,
+                      }) => ({
                         key: name,
                         connectorType,
+                        iconName,
+                        iconPack,
                         text: name,
                         status: status ? toTitleCase(status) : undefined,
-                        iconPack: icon?.split("/")[0],
-                        icon: icon?.split("/")[1],
                         state: statesToStatus([state]),
                       })
                     ),
@@ -194,7 +205,11 @@ export function Home({
   );
 }
 
-export async function getServerSideProps() {
+export const getServerSideProps: GetServerSideProps = async ({ req }) => {
+  const { origin } = absoluteUrl(req);
+  const apolloClient = createApolloClient({
+    links: [createIsomorphLink(origin)],
+  });
   const { data, error } = await apolloClient.query<InitQuery>({
     query: InitDocument,
     fetchPolicy: "no-cache",
@@ -211,4 +226,4 @@ export async function getServerSideProps() {
       initialServerTime: data?.serverTime ?? null,
     } as Props,
   };
-}
+};
diff --git a/codegen.yml b/codegen.yml
@@ -1,13 +1,32 @@
 schema: "**/*.server.graphql"
 generates:
+  server/agent/agent.generated.graphql.ts:
+    documents: "server/agent/*.graphql"
+    plugins:
+      - add:
+          content: "/* eslint-disable */"
+      - typescript
+      - typescript-graphql-request
+      - typescript-operations
+    config:
+      enumsAsTypes: true
+      avoidOptionals: true
+      rawRequest: true
+
   ./types.graphql.ts:
+    config:
+      enumsAsTypes: true
+      avoidOptionals: true
     plugins:
       - add:
           content: "/* eslint-disable */"
       - typescript
   ./:
-    documents: "**/*.graphql"
+    documents: "client/**/*.graphql"
     preset: near-operation-file
+    config:
+      enumsAsTypes: true
+      avoidOptionals: true
     presetConfig:
       extension: .generated.graphql.ts
       baseTypesPath: types.graphql.ts
@@ -28,8 +47,11 @@ generates:
       - typescript-operations
       - typed-document-node
     config:
+      enumsAsTypes: true
+      avoidOptionals: true
       contextType: ../context#Context
       useIndexSignature: true
       defaultMapper: DeepPartial<{T}>
-      scalars: 
+      scalars:
         Date: Date
+        Void: void
diff --git a/config.json b/config.json
@@ -1,12 +1,12 @@
 {
-  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/schema.json",
+  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/config-schema.json",
   "connectors": [
     {
-      "type": "docker",
+      "type": "DOCKER",
       "config": {}
     },
     {
-      "type": "website",
+      "type": "WEBSITE",
       "config": {
         "sites": [
           {
@@ -40,4 +40,4 @@
       }
     }
   ]
-}
+}
diff --git a/docs/connectors.md b/docs/connectors.md
@@ -24,14 +24,14 @@ Can use a list of website urls (And other request formats) for Plugsy to ping an
 
 ```
 {
-  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/schema.json",
+  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/config-schema.json",
   "connectors": [
     {
-      "type": "docker",
+      "type": "DOCKER",
       "config": {}
     },
     {
-      "type": "website",
+      "type": "WEBSITE",
       "config": {
         "sites": [
           {
@@ -45,7 +45,7 @@ Can use a list of website urls (And other request formats) for Plugsy to ping an
       }
     },
     {
-      "type": "raw",
+      "type": "RAW",
       "config": {
         "items": [
           {

diff --git a/docs/connectors/docker.md b/docs/connectors/docker.md
@@ -6,10 +6,10 @@ A docker connector, provides access directly to a docker socket or URL mapping e
 
 ```jsonc
 {
-  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/schema.json",
+  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/config-schema.json",
   "connectors": [
     {
-      "type": "docker",
+      "type": "DOCKER",
       "config": {}
     }
   ]
@@ -95,10 +95,10 @@ services:
 
 ```jsonc
 {
-  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/schema.json",
+  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/config-schema.json",
   "connectors": [
     {
-      "type": "docker",
+      "type": "DOCKER",
       "config": {
         "containerMap": {
           "vikunjafrontend": {
@@ -130,10 +130,10 @@ See [Dockerode](https://www.npmjs.com/package/dockerode) for alternative connect
 
 ```jsonc
 {
-  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/schema.json",
+  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/config-schema.json",
   "connectors": [
     {
-      "type": "docker",
+      "type": "DOCKER",
       "config": {
         "id": "", // Optional defaults to "docker"
         "dockerOptions": {

diff --git a/docs/connectors/raw.md b/docs/connectors/raw.md
@@ -6,10 +6,10 @@ Provides items in the dashboard directly from the config itself
 
 ```jsonc
 {
-  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/schema.json",
+  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/config-schema.json",
   "connectors": [
     {
-      "type": "raw",
+      "type": "RAW",
       "config": {
         "items": [
           {
@@ -28,10 +28,10 @@ Provides items in the dashboard directly from the config itself
 
 ```jsonc
 {
-  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/schema.json",
+  "$schema": "https://github.com/plugsy/core/releases/download/v2.2.0/config-schema.json",
   "connectors": [
     {
-      "type": "raw",
+      "type": "RAW",
       "config": {
         "items": [
           {