Add custom error handling for github module

Author: deepal

constants/index.js

@@ -0,0 +1,13 @@
+exports.fileTypes = {
+ MARKDOWN_NOTE: 'MARKDOWN_NOTE',
+ SNIPPET_NOTE: 'SNIPPET_NOTE',
+ MULTIMEDIA: 'MULTIMEDIA',
+ RAW_CSON: 'RAW_CSON',
+ UNKNOWN: 'UNKNOWN'
+};
+
+exports.events = {
+ FILE_CREATE_OR_UPDATE: 'FILE_CREATE_OR_UPDATE',
+ FILE_DELETE: 'FILE_DELETE',
+ FILE_CHANGE: 'FILE_CHANGE'
+};

definitions/constants.js

@@ -0,0 +1,30 @@
+class BaseError extends Error {
+ constructor(...args) {
+ super(...args);
+ this.stack = `${this.message}\n${new Error().stack}`;
+ }
+}
+
+exports.FileSystemError = class FileSystemError extends BaseError {
+ constructor(...args) {
+ super(...args);
+ this.code = 'FILE_SYSTEM_ERROR';
+ this.name = 'FileSystemError';
+ }
+};
+
+exports.ValidationError = class ValidationError extends BaseError {
+ constructor(...args) {
+ super(...args);
+ this.code = 'VALIDATION_ERROR';
+ this.name = 'ValidationError';
+ }
+};
+
+exports.QueueError = class QueueError extends BaseError {
+ constructor(...args) {
+ super(...args);
+ this.code = 'QUEUE_ERROR';
+ this.name = 'QueueError';
+ }
+};

definitions/errors.js

@@ -0,0 +1,9 @@
+const constants = require('./constants');
+const errors = require('./errors');
+
+module.exports = class definitions {
+ constructor() {
+ this.constants = constants;
+ this.errors = errors;
+ }
+};

definitions/index.js

@@ -6,19 +6,22 @@
 const requestFn = require('request');
 const { resolve } = require('url');
 const { promisify } = require('util');
-const httpStatus = require('../httpStatus');
-const errorCode = require('./errors');
+const httpStatus = require('./httpStatus');
+const {
+ RepositoryEmptyError,
+ GitHubInternalError,
+ AuthorizationError
+} = require('./errors');
+
 const {
  trimSlashes,
  decodeToUtf8
-} = require('../helpers');
+} = require('./helpers');
 
 const GITHUB_BLOB_MODE = '100644';
 const GITHUB_BLOB_TYPE = 'blob';
-const ERR_FILE_NOT_FOUND = 'ENOENT';
 
-exports.constants = { GITHUB_BLOB_MODE, GITHUB_BLOB_TYPE, ERR_FILE_NOT_FOUND };
-exports.errorCode = errorCode;
+exports.constants = { GITHUB_BLOB_MODE, GITHUB_BLOB_TYPE };
 
 exports.Client = class GithubClient {
  /**
@@ -75,6 +78,19 @@ exports.Client = class GithubClient {
  return this.userId;
  }
 
+ /**
+ * Generate an error object based on the status code
+ * @param {number} statusCode
+ * @returns {Error}
+ */
+ static generateError(statusCode) {
+ return (message) => {
+ if (statusCode === httpStatus.UNAUTHORIZED) return new AuthorizationError(message);
+ if (statusCode === httpStatus.CONFLICT) return new RepositoryEmptyError(message);
+ return new GitHubInternalError(message);
+ };
+ }
+
  /**
  * Get github user id
  * @returns {void}
@@ -86,8 +102,7 @@ exports.Client = class GithubClient {
  });
 
  if (status !== httpStatus.OK) {
- this.logger.error(body);
- throw new Error('Failed to fetch user details');
+ throw GithubClient.generateError(status)(`Failed to fetch user details: ${body.message}`);
  }
 
  const { login } = body;
@@ -106,15 +121,8 @@ exports.Client = class GithubClient {
  path: `/repos/${this.userId}/${this.repoConfig.name}/git/refs/${refs}` // default notes branch is 'master'
  });
 
- if (status === httpStatus.CONFLICT) {
- const error = new Error(body.message);
- error.code = errorCode.ERR_REPOSITORY_EMPTY;
- throw error;
- }
-
  if (status !== httpStatus.OK) {
- this.logger.error(body);
- throw new Error('Failed to fetch head');
+ throw GithubClient.generateError(status)(`Failed to fetch head: ${body.message}`);
  }
 
  const { object } = body;
@@ -133,8 +141,7 @@ exports.Client = class GithubClient {
  });
 
  if (status !== httpStatus.OK) {
- this.logger.error(body);
- throw new Error('Failed to fetch commit stats');
+ throw GithubClient.generateError(status)(`Failed to fetch commit stats: ${body.message}`);
  }
 
  const { message, tree } = body;
@@ -156,8 +163,7 @@ exports.Client = class GithubClient {
  body: { content, encoding }
  });
  if (status !== httpStatus.CREATED) {
- this.logger.error(body);
- throw new Error('Failed to create blob from content');
+ throw GithubClient.generateError(status)(`Failed to create blob from content: ${body.message}`);
  }
 
  const { sha } = body;
@@ -170,8 +176,7 @@ exports.Client = class GithubClient {
  path: `/repos/${this.userId}/${this.repoConfig.name}/git/blobs/${blobSHA}`
  });
  if (status !== httpStatus.OK) {
- this.logger.error(body);
- throw new Error(`Failed to get blob ${blobSHA}`);
+ throw GithubClient.generateError(status)(`Failed to get blob ${blobSHA}: ${body.message}`);
  }
 
  const { content, encoding } = body;
@@ -201,8 +206,7 @@ exports.Client = class GithubClient {
  }
 
  if (status !== httpStatus.OK) {
- this.logger.error(body);
- throw new Error(`Failed to get tree ${treeHash}`);
+ throw GithubClient.generateError(status)(`Failed to get tree ${treeHash}: ${body.message}`);
  }
  const { tree, truncated } = body;
  return { tree, truncated };
@@ -233,8 +237,7 @@ exports.Client = class GithubClient {
  });
 
  if (status !== httpStatus.CREATED) {
- this.logger.error(body);
- throw new Error('Failed to update tree');
+ throw GithubClient.generateError(status)(`Failed to update tree: ${body.message}`);
  }
  return body.sha;
  }
@@ -252,8 +255,7 @@ exports.Client = class GithubClient {
  });
 
  if (status !== httpStatus.CREATED) {
- this.logger.error(body);
- throw new Error('Failed to update tree');
+ throw GithubClient.generateError(status)(`Failed to update tree: ${body.message}`);
  }
  return body.sha;
  }
@@ -283,8 +285,7 @@ exports.Client = class GithubClient {
  });
 
  if (status !== httpStatus.CREATED) {
- this.logger.error(body);
- throw new Error('Failed to commit file');
+ throw GithubClient.generateError(status)(`Failed to commit file: ${body.message}`);
  }
  return body.sha;
  }
@@ -305,8 +306,7 @@ exports.Client = class GithubClient {
  });
 
  if (status !== httpStatus.OK) {
- this.logger.error(body);
- throw new Error('Failed to update head');
+ throw GithubClient.generateError(status)(`Failed to update head: ${body.message}`);
  }
  return body;
  }
@@ -330,8 +330,7 @@ exports.Client = class GithubClient {
  });
 
  if (status !== httpStatus.CREATED) {
- this.logger.error(body.message);
- throw new Error('Failed to initialize repository');
+ throw GithubClient.generateError(status)(`Failed to initialize repository: ${body.message}`);
  }
 
  const { commit } = body;

github/client/index.js renamed to github/client.js

@@ -0,0 +1,44 @@
+exports.RepositoryEmptyError = class RepositoryEmptyError extends Error {
+ constructor(...args) {
+ super(...args);
+ this.code = 'ERR_REPOSITORY_EMPTY';
+ this.name = 'RepositoryEmptyError';
+ this.stack = `${this.message}\n${new Error().stack}`;
+ }
+};
+
+exports.AuthorizationError = class AuthorizationError extends Error {
+ constructor(...args) {
+ super(...args);
+ this.code = 'ERR_AUTHORIZATION';
+ this.name = 'AuthorizationError';
+ this.stack = `${this.message}\n${new Error().stack}`;
+ }
+};
+
+exports.ConnectionError = class ConnectionError extends Error {
+ constructor(...args) {
+ super(...args);
+ this.code = 'ERR_CONNECTION';
+ this.name = 'ConnectionError';
+ this.stack = `${this.message}\n${new Error().stack}`;
+ }
+};
+
+exports.RemoteFileNotFoundError = class RemoteFileNotFoundError extends Error {
+ constructor(...args) {
+ super(...args);
+ this.code = 'ERR_REMOTE_FILE_NOT_FOUND';
+ this.name = 'RemoteFileNotFoundError';
+ this.stack = `${this.message}\n${new Error().stack}`;
+ }
+};
+
+exports.GitHubInternalError = class GitHubError extends Error {
+ constructor(...args) {
+ super(...args);
+ this.code = 'ERR_GITHUB_INTERNAL';
+ this.name = 'GitHubInternalError';
+ this.stack = `${this.message}\n${new Error().stack}`;
+ }
+};

github/client/errors.js

@@ -14,7 +14,10 @@ const {
  getRemoteMarkdownPath,
  getRemoteRawPath
 } = require('./helpers');
-const { Client, constants, errorCode } = require('./client');
+const { RemoteFileNotFoundError } = require('./errors');
+const { Client, constants } = require('./client');
+
+const ERR_REPOSITORY_EMPTY = 'ERR_REPOSITORY_EMPTY';
 
 module.exports = class GithubHelper {
  /**
@@ -53,13 +56,13 @@ module.exports = class GithubHelper {
  if (!this.userId) await this.client.fetchGithubUser();
  await this.client.getHead();
  } catch (err) {
- if (err.code === errorCode.ERR_REPOSITORY_EMPTY) {
+ if (err.code === ERR_REPOSITORY_EMPTY) {
  this.logger.debug('Repository seems to be empty. Initializing with a README.md');
  await this.client.initializeReadMe();
  return;
  }
 
- throw new Error('Failed to initialize repository', err);
+ throw err;
  }
  }
 
@@ -79,9 +82,7 @@ module.exports = class GithubHelper {
  const blob = tree.find(({ type, path }) => type === constants.GITHUB_BLOB_TYPE && path === trimSlashes(filePath));
 
  if (!blob) {
- const error = new Error(`File not found. [truncated_result=${truncated}]`);
- error.code = constants.ERR_FILE_NOT_FOUND;
- throw error;
+ throw new RemoteFileNotFoundError(`File not found. [truncated_result=${truncated}]`);
  }
 
  return this.client.getBlob(blob.sha);
@@ -100,7 +101,7 @@ module.exports = class GithubHelper {
  this.logger.debug(`Fetched metadata file at ${this.repoConfig.metadataFile}`);
  return JSON.parse(content);
  } catch (err) {
- if (err.code === constants.ERR_FILE_NOT_FOUND) {
+ if (err.code === 'ERR_REMOTE_FILE_NOT_FOUND') {
  this.logger.info(`Metadata file not found on branch ${this.repoConfig.branch}. Creating new file...`);
  const timestamp = new Date().toISOString();
  const metadataContent = {
@@ -118,7 +119,7 @@ module.exports = class GithubHelper {
  return metadataContent;
  }
 
- this.logger.error('Unknown error while fetching or creating sync metadata', err);
+ this.logger.error('Unknown error while fetching or creating sync metadata');
  throw err;
  }
  }

github/errors.js

@@ -11,7 +11,7 @@ launcher
  .withLoggerConfig({
  level: 'debug'
  })
- .module({ name: 'constants', path: './constants' })
+ .module({ name: 'definitions', path: './definitions' })
  .module({ name: 'github', path: './github' })
  .module({ name: 'preprocessor', path: './preprocessor' })
  .module({ name: 'sync', path: './sync' })

github/index.js

@@ -13,7 +13,9 @@ class PreProcessor {
  this.container = container;
  this.logger = logger;
  this.platform = process.platform;
- this.constants = this.container.module('constants');
+ const { constants, errors } = this.container.module('definitions');
+ this.constants = constants;
+ this.errors = errors;
  }
 
  async processChangeSet(event, changedFile) {