Implemented updates check

Author: jurgelenas

graphql.schema.json

@@ -183,6 +183,39 @@
             },
             "isDeprecated": false,
             "deprecationReason": null
+          },
+          {
+            "name": "checkForUpdates",
+            "description": null,
+            "args": [
+              {
+                "name": "currentVersion",
+                "description": null,
+                "type": {
+                  "kind": "NON_NULL",
+                  "name": null,
+                  "ofType": {
+                    "kind": "SCALAR",
+                    "name": "String",
+                    "ofType": null
+                  }
+                },
+                "defaultValue": null,
+                "isDeprecated": false,
+                "deprecationReason": null
+              }
+            ],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "OBJECT",
+                "name": "UpdatesAvailability",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
           }
         ],
         "inputFields": null,
@@ -789,6 +822,65 @@
         ],
         "possibleTypes": null
       },
+      {
+        "kind": "OBJECT",
+        "name": "UpdatesAvailability",
+        "description": null,
+        "fields": [
+          {
+            "name": "updateAvailable",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "Boolean",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "newestVersion",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          },
+          {
+            "name": "releaseUrl",
+            "description": null,
+            "args": [],
+            "type": {
+              "kind": "NON_NULL",
+              "name": null,
+              "ofType": {
+                "kind": "SCALAR",
+                "name": "String",
+                "ofType": null
+              }
+            },
+            "isDeprecated": false,
+            "deprecationReason": null
+          }
+        ],
+        "inputFields": null,
+        "interfaces": [],
+        "enumValues": null,
+        "possibleTypes": null
+      },
       {
         "kind": "OBJECT",
         "name": "Mutation",

package.json

@@ -321,6 +321,7 @@
     "react-router-dom": "^5.2.0",
     "reflect-metadata": "^0.1.13",
     "regenerator-runtime": "^0.13.5",
+    "semver": "^7.3.5",
     "simple-git": "^2.37.0",
     "source-map-support": "^0.5.19",
     "type-graphql": "^1.1.1",

src/api/index.ts

@@ -20,6 +20,8 @@ import './src/graphql/enum/DeviceTarget';
 // eslint-disable-next-line import/extensions
 import './src/graphql/enum/UserDefineKey';
 import UserDefinesBuilder from './src/services/UserDefinesBuilder';
+import UpdatesService from './src/services/Updates';
+import UpdatesResolver from './src/graphql/resolvers/Updates.resolver';
 
 export default class ApiServer {
   app: Express | undefined;
@@ -58,6 +60,13 @@ export default class ApiServer {
         logger
       )
     );
+    Container.set(
+      UpdatesService,
+      new UpdatesService(
+        config.configuratorGit.owner,
+        config.configuratorGit.repositoryName
+      )
+    );
 
     const rawRepoUrl = `https://raw.githubusercontent.com/${config.git.owner}/${config.git.repositoryName}`;
     Container.set(
@@ -66,7 +75,7 @@ export default class ApiServer {
     );
 
     const schema = await buildSchema({
-      resolvers: [FirmwareResolver, SourcesResolver],
+      resolvers: [FirmwareResolver, SourcesResolver, UpdatesResolver],
       container: Container,
       pubSub,
     });

src/api/src/config/index.ts

@@ -3,6 +3,7 @@ import { GitRepo } from '../services/Firmware';
 
 export interface IConfig {
   git: GitRepo;
+  configuratorGit: GitRepo;
   firmwaresPath: string;
   PATH: string;
   env: NodeJS.ProcessEnv;

src/api/src/graphql/resolvers/Sources.resolver.ts

@@ -21,7 +21,7 @@ export default class SourcesResolver {
 
   @Query(() => [String])
   async gitTags() {
-    return new OctopusGitHubClient().loadTags(
+    return this.gitClient.loadTags(
       this.config.git.owner,
       this.config.git.repositoryName
     );

src/api/src/graphql/resolvers/Updates.resolver.ts

@@ -0,0 +1,15 @@
+import { Arg, Query, Resolver } from 'type-graphql';
+import { Service } from 'typedi';
+import UpdatesAvailability from '../../models/UpdatesAvailability';
+import UpdatesService from '../../services/Updates';
+
+@Service()
+@Resolver()
+export default class UpdatesResolver {
+  constructor(private updatesService: UpdatesService) {}
+
+  @Query(() => UpdatesAvailability)
+  async checkForUpdates(@Arg('currentVersion') currentVersion: string) {
+    return this.updatesService.checkForNewerReleases(currentVersion);
+  }
+}

src/api/src/models/UpdatesAvailability.ts

@@ -0,0 +1,19 @@
+import { Field, ObjectType } from 'type-graphql';
+
+@ObjectType('UpdatesAvailability')
+export default class UpdatesAvailability {
+  @Field()
+  updateAvailable: boolean;
+
+  @Field()
+  newestVersion: string;
+
+  @Field()
+  releaseUrl: string;
+
+  constructor(updateAvailable: boolean, newestVersion = '', releaseUrl = '') {
+    this.updateAvailable = updateAvailable;
+    this.newestVersion = newestVersion;
+    this.releaseUrl = releaseUrl;
+  }
+}

src/api/src/services/Updates/index.ts

@@ -0,0 +1,41 @@
+import { Octokit } from '@octokit/rest';
+import { Service } from 'typedi';
+import semver from 'semver/preload';
+import UpdatesAvailability from '../../models/UpdatesAvailability';
+
+@Service()
+export default class UpdatesService {
+  client: Octokit;
+
+  constructor(private repositoryOwner: string, private repositoryName: string) {
+    this.client = new Octokit();
+  }
+
+  async checkForNewerReleases(
+    currentVersion: string
+  ): Promise<UpdatesAvailability> {
+    const response = await this.client.repos.listReleases({
+      owner: this.repositoryOwner,
+      repo: this.repositoryName,
+      per_page: 100,
+    });
+
+    if (response.status !== 200 || response.data.length === 0) {
+      return new UpdatesAvailability(false);
+    }
+
+    const newestVersion = semver.coerce(response.data[0].tag_name);
+    if (newestVersion === null) {
+      return new UpdatesAvailability(false);
+    }
+
+    if (semver.gt(newestVersion, currentVersion)) {
+      return new UpdatesAvailability(
+        true,
+        newestVersion.format(),
+        response.data[0].html_url
+      );
+    }
+    return new UpdatesAvailability(false);
+  }
+}

src/main.dev.ts

@@ -237,6 +237,12 @@ const createWindow = async () => {
         owner: 'ExpressLRS',
         repositoryName: 'ExpressLRS',
       },
+      configuratorGit: {
+        cloneUrl: 'https://github.com/ExpressLRS/ExpressLRS-Configurator',
+        url: 'https://github.com/ExpressLRS/ExpressLRS-Configurator',
+        owner: 'ExpressLRS',
+        repositoryName: 'ExpressLRS-Configurator',
+      },
       firmwaresPath,
       getPlatformioPath,
       platformioStateTempStoragePath,

src/ui/components/DeviceTargetForm/index.tsx

@@ -103,7 +103,7 @@ const deviceTargetToCategory = (deviceTarget: DeviceTarget): string => {
       'DIY 2.4 Ghz',
 
     // DIY_2400_RX_STM32_CCG_Nano_v0_5
-    [DeviceTarget.DIY_2400_RX_STM32_CCG_Nano_v0_5]: 'DIY 2.4 Ghz',
+    [DeviceTarget.DIY_2400_RX_STM32_CCG_Nano_v0_5_via_STLINK]: 'DIY 2.4 Ghz',
     [DeviceTarget.DIY_2400_RX_STM32_CCG_Nano_v0_5_via_BetaflightPassthrough]:
       'DIY 2.4 Ghz',
   };

src/ui/components/Header/index.tsx

@@ -11,6 +11,7 @@ import FacebookIcon from '@material-ui/icons/Facebook';
 import { Config } from '../../config';
 import LogotypeIcon from '../../../../assets/logotype.svg';
 import DiscordIcon from '../../../../assets/DiscordIcon.svg';
+import { useCheckForUpdatesQuery } from '../../gql/generated/types';
 
 const useStyles = makeStyles((theme) => ({
   title: {
@@ -27,6 +28,11 @@ const useStyles = makeStyles((theme) => ({
   version: {
     fontSize: '0.4em',
   },
+  updateAvailable: {
+    fontSize: '0.4em',
+    marginLeft: '0.4em',
+    color: 'rgb(52 216 52) !important',
+  },
   toolbar: {
     display: 'flex',
     justifyContent: 'space-between',
@@ -54,6 +60,11 @@ interface HeaderProps {
 
 const Header: FunctionComponent<HeaderProps> = memo(({ className }) => {
   const styles = useStyles();
+  const { data: updateResponse } = useCheckForUpdatesQuery({
+    variables: {
+      currentVersion: process.env.EXPRESSLRS_CONFIGURATOR_VERSION || '0.0.1',
+    },
+  });
   return (
     <AppBar position="static" color="default" className={className}>
       <Toolbar className={styles.toolbar}>
@@ -68,6 +79,17 @@ const Header: FunctionComponent<HeaderProps> = memo(({ className }) => {
             <span className={styles.version}>
               v{process.env.EXPRESSLRS_CONFIGURATOR_VERSION}
             </span>
+            {updateResponse?.checkForUpdates?.updateAvailable && (
+              <a
+                href={updateResponse?.checkForUpdates?.releaseUrl}
+                target="_blank"
+                title="Click to download a newest release"
+                rel="noreferrer noreferrer"
+                className={styles.updateAvailable}
+              >
+                Update is available!
+              </a>
+            )}
           </Typography>
         </div>
         <div className={styles.social}>