fix: GitHub gist export

Author: André Dietrich

src/i18n/de.json

@@ -122,7 +122,8 @@
   },
   "github": {
     "exporting": "Wird zu GitHub Gist exportiert...",
-    "badCredentials": "Ungültige Anmeldedaten, Seite wird neu geladen"
+    "badCredentials": "Ungültige Anmeldedaten, Seite wird neu geladen",
+    "error": "Der Export zu GitHub ist fehlgeschlagen:"
   },
   "nostr": {
     "title": "Via Nostr teilen",

src/i18n/en.json

@@ -122,7 +122,8 @@
   },
   "github": {
     "exporting": "Exporting to GitHub gist...",
-    "badCredentials": "Bad credentials, reloading page"
+    "badCredentials": "Bad credentials, reloading page",
+    "error": "The export to GitHub failed:"
   },
   "nostr": {
     "title": "Share via Nostr",

src/ts/GitHub.ts

@@ -56,15 +56,34 @@ export async function access_token(code: string) {
       { method: 'post' }
     )
 
+    if (!response.ok) {
+      return {
+        error: 'access_token',
+        message: 'GitHub token request failed (' + response.status + ')',
+      }
+    }
+
     const json = await response.json()
 
     // headers not working that is why contents has to be split manually
     const credentials = getParams(json.contents)
 
+    // GitHub returns error=... instead of access_token/scope when the
+    // (single-use) OAuth code is invalid or expired
+    if (!credentials.access_token) {
+      return {
+        error: 'access_token',
+        message: credentials.error_description || 'Could not obtain access token',
+      }
+    }
+
     return credentials
   } catch (e) {
     console.warn(e)
-    return
+    return {
+      error: 'access_token',
+      message: 'Could not obtain access token',
+    }
   }
 }
 
@@ -93,20 +112,36 @@ export async function gistUpload(
     gist_id = ''
   }
 
-  const response = await fetch('https://api.github.com/gists' + gist_id, {
-    headers: {
-      'User-Agent': 'LiaScript',
-      Authorization: credentials.token_type + ' ' + credentials.access_token,
-      Accept: 'application/vnd.github+json',
-    },
-    method: 'post',
-    body: JSON.stringify(gist),
-  })
+  if (!credentials?.access_token) {
+    return {
+      error: 'Bad credentials',
+      message: 'Missing access token',
+    }
+  }
 
-  const json = await response.json()
+  let json
+  try {
+    const response = await fetch('https://api.github.com/gists' + gist_id, {
+      headers: {
+        'User-Agent': 'LiaScript',
+        Authorization: credentials.token_type + ' ' + credentials.access_token,
+        Accept: 'application/vnd.github+json',
+      },
+      method: 'post',
+      body: JSON.stringify(gist),
+    })
+
+    json = await response.json()
+  } catch (e) {
+    console.warn(e)
+    return {
+      error: 'network',
+      message: 'Could not reach GitHub',
+    }
+  }
 
   // the gist does not exist anymore (has been deleted)
-  if (json.message == 'Not Found') {
+  if (json.message == 'Not Found' && gist_id) {
     return await gistUpload(credentials, title, comment, content)
   }
   // probably the user has revoked the credentials,
@@ -118,6 +153,14 @@ export async function gistUpload(
     }
   }
 
+  // any other error (rate limit, validation, 4xx/5xx) has no `files`
+  if (!json.files) {
+    return {
+      error: 'upload',
+      message: json.message || 'Gist upload failed',
+    }
+  }
+
   return {
     url: json.html_url,
     id: json.id,

src/views/Export/GitHub.vue

@@ -34,42 +34,65 @@ export default {
       const provider = new IndexeddbPersistence(id, yDoc);
 
       provider.on("synced", async (_: any) => {
-        const metaData = await meta;
-        const contentData = yDoc.getText(id).toJSON();
-
-        if (!config.credentials?.github?.scope) {
-          config.credentials.github = await GitHub.access_token(code);
-          Utils.storeConfig(config);
-        }
-
-        const gist = await GitHub.gistUpload(
-          config.credentials.github,
-          metaData.meta.title,
-          metaData.meta.macro?.comment || "",
-          contentData,
-          metaData.meta.gist_id
-        );
-
-        if (gist.error == "Bad credentials") {
-          config.credentials.github = undefined;
-          Utils.storeConfig(config);
-
-          this.message = this.$t('github.badCredentials');
-
-          window.location.reload();
-        }
-
-        if (metaData.meta.gist_id != gist.id) {
-          await database.put(id, {
-            gist_id: gist.id,
-            gist_url: gist.raw_url,
-          });
-        }
-
-        this.message = gist.message;
-
-        if (gist.url) {
-          window.location.href = gist.url;
+        try {
+          const metaData = await meta;
+          const contentData = yDoc.getText(id).toJSON();
+
+          if (!config.credentials?.github?.scope) {
+            const credentials = await GitHub.access_token(code);
+
+            // could not obtain a token (e.g. expired/invalid OAuth code)
+            if (credentials?.error) {
+              config.credentials.github = undefined;
+              Utils.storeConfig(config);
+
+              this.message = this.$t('github.error') + "\n" + credentials.message;
+              return;
+            }
+
+            config.credentials.github = credentials;
+            Utils.storeConfig(config);
+          }
+
+          const gist = await GitHub.gistUpload(
+            config.credentials.github,
+            metaData.meta.title,
+            metaData.meta.macro?.comment || "",
+            contentData,
+            metaData.meta.gist_id
+          );
+
+          if (gist.error == "Bad credentials") {
+            config.credentials.github = undefined;
+            Utils.storeConfig(config);
+
+            this.message = this.$t('github.badCredentials');
+
+            window.location.reload();
+            return;
+          }
+
+          // any other upload/network error: show it instead of hanging
+          if (gist.error) {
+            this.message = this.$t('github.error') + "\n" + gist.message;
+            return;
+          }
+
+          if (metaData.meta.gist_id != gist.id) {
+            await database.put(id, {
+              gist_id: gist.id,
+              gist_url: gist.raw_url,
+            });
+          }
+
+          this.message = gist.message;
+
+          if (gist.url) {
+            window.location.href = gist.url;
+          }
+        } catch (e) {
+          console.warn(e);
+          this.message = this.$t('github.error') + "\n" + (e?.message || e);
         }
       });
     },