feat: add abstract-cli as a dependency

BREAKING CHANGE: cliPath is no longer configurable
goabstract · Aug 19, 2019 · 65911c4 · 65911c4
1 parent 6c2d9db
commit 65911c4
Show file tree

Hide file tree

Showing 13 changed files with 20 additions and 77 deletions.
diff --git a/abstract-sdk.d.ts b/abstract-sdk.d.ts
@@ -6,7 +6,6 @@ interface ErrorData {
 
 export class APITokenError extends BaseError {}
 export class BaseError extends Error {}
-export class CLIPathError extends BaseError {}
 export class FileAPIError extends BaseError {}
 
 export class EndpointUndefinedError extends BaseError {
@@ -96,7 +95,6 @@ interface EndpointRequest<T> {
 
 interface Endpoint {
   apiUrl: string | Promise<string>;
-  cliPath?: string | Promise<string>;
   client: Client;
   lastCalledEndpoint?: string;
   maxCacheSize: number;
@@ -1717,7 +1715,6 @@ type AccessTokenOption =
 type CommandOptions = {
   accessToken: AccessTokenOption,
   apiUrl: string | Promise<string>,
-  cliPath: string | Promise<string>,
   maxCacheSize: number,
   previewsUrl: string | Promise<string>,
   transportMode: "auto" | "api" | "cli",

diff --git a/docs/configuration.md b/docs/configuration.md
@@ -29,12 +29,6 @@ _Default value: `https://api.goabstract.com`_
 
 This option can be used to specify a custom URL that points to an instance of the Abstract HTTP API. This is used when building the request URLs used by the [API transport](/docs/transports). This option is useful if HTTP requests should be routed locally or through a proxy server.
 
-### `cliPath`
-
-_Default value: `/Applications/Abstract.app/Contents/Resources/app.asar.unpacked/node_modules/@elasticprojects/abstract-cli/bin/abstract-cli`_
-
-This option can be used to specify a custom file location that points to the Abstract CLI included with the Abstract desktop application. This option is useful if the Abstract desktop application exists at a non-default application path outside of `/Applications`.
-
 ### `maxCacheSize`
 
 _Default value: `0`_

diff --git a/docs/transports.md b/docs/transports.md
@@ -15,7 +15,6 @@ The Abstract API is a transport mode that uses HTTP to interact with Abstract's
 
 The Abstract CLI is a transport mode that uses the Abstract desktop application to interact with data stored locally on a given machine. This transport does not require internet connectivity or authentication, and requests are not subject to rate limits. This transport does require access to the Abstract desktop application and its underlying data, as such it can only be used on macOS currently.
 
-
 ## Auto
 
 The SDK provides an "auto" transport that can be used in environments where both the API and the CLI transports are available. Any time an SDK method is called, the auto transport will first check the CLI, then the API, for an available implementation. This allows transport-specific SDK methods to be called without worrying about which transport is being used. This transport also helps to reduce rate limit errors since the CLI transport will be favored in most cases.

diff --git a/package.json b/package.json
@@ -67,6 +67,7 @@
   },
   "dependencies": {
     "@babel/runtime-corejs2": "^7.3.4",
+    "@elasticprojects/abstract-cli": "^2.3.0",
     "cross-fetch": "^3.0.1",
     "debug": "^4.0.1",
     "flow-typed": "^2.5.1",

diff --git a/src/Client.js b/src/Client.js
@@ -48,8 +48,6 @@ export default class Client {
     options = {
       accessToken: process.env.ABSTRACT_TOKEN,
       apiUrl: "https://api.goabstract.com",
-      cliPath:
-        "/Applications/Abstract.app/Contents/Resources/app.asar.unpacked/node_modules/@elasticprojects/abstract-cli/bin/abstract-cli",
       maxCacheSize: 0,
       previewsUrl: "https://previews.goabstract.com",
       transportMode: "api",

diff --git a/src/endpoints/Commits.test.js b/src/endpoints/Commits.test.js
@@ -50,27 +50,15 @@ describe("#list", () => {
   });
 
   test("cli - file id", async () => {
-    mockCLI(
-      [
-        "commits",
-        "project-id",
-        "branch-id",
-        "--file-id",
-        "file-id",
-        "--limit",
-        "10"
-      ],
-      { commits: [] }
-    );
-    const response = await CLI_CLIENT.commits.list(
-      {
-        projectId: "project-id",
-        branchId: "branch-id",
-        fileId: "file-id",
-        sha: "sha"
-      },
-      { limit: 10 }
-    );
+    mockCLI(["commits", "project-id", "branch-id", "--file-id", "file-id"], {
+      commits: []
+    });
+    const response = await CLI_CLIENT.commits.list({
+      projectId: "project-id",
+      branchId: "branch-id",
+      fileId: "file-id",
+      sha: "sha"
+    });
 
     expect(response).toEqual([]);
   });

diff --git a/src/endpoints/Endpoint.js b/src/endpoints/Endpoint.js
@@ -2,7 +2,7 @@
 /* global fetch */
 /* istanbul ignore file */
 import "cross-fetch/polyfill";
-import { existsSync } from "fs";
+import { join } from "path";
 import { spawn } from "child_process";
 import uuid from "uuid/v4";
 import Client from "../Client";
@@ -11,10 +11,8 @@ import { log } from "../debug";
 import { version } from "../../package.json";
 import {
   APITokenError,
-  CLIPathError,
   EndpointUndefinedError,
   logAPIError,
-  logCLIError,
   throwAPIError,
   throwCLIError
 } from "../errors";
@@ -40,7 +38,6 @@ export type EndpointRequest<T> = {
 export default class Endpoint {
   _optionAccessToken: ?AccessTokenOption;
   apiUrl: string | Promise<string>;
-  cliPath: ?string | Promise<?string>;
   client: Client;
   lastCalledEndpoint: ?string;
   maxCacheSize: number;
@@ -56,7 +53,6 @@ export default class Endpoint {
   constructor(client: Client, options: CommandOptions) {
     this._optionAccessToken = options.accessToken;
     this.apiUrl = options.apiUrl;
-    this.cliPath = options.cliPath;
     this.client = client;
     this.maxCacheSize = options.maxCacheSize;
     this.previewsUrl = options.previewsUrl;
@@ -137,16 +133,11 @@ export default class Endpoint {
 
   async cliRequest(args: string[]) {
     const token = await this.accessToken();
-    const cliPath = await this.cliPath;
+    const cliPath = join(
+      __dirname,
+      "../../node_modules/@elasticprojects/abstract-cli/bin/abstract-cli"
+    );
     const tokenArgs = typeof token === "string" ? ["--user-token", token] : [];
-
-    if (!cliPath || !existsSync(cliPath)) {
-      const error = new CLIPathError();
-      /* istanbul ignore next */
-      logCLIError.enabled && logCLIError(error);
-      throw error;
-    }
-
     const spawnArgs = [
       cliPath,
       [...tokenArgs, "--api-url", await this.apiUrl, ...args]

diff --git a/src/errors.js b/src/errors.js
@@ -17,12 +17,6 @@ export class BaseError extends Error {
   }
 }
 
-export class CLIPathError extends BaseError {
-  constructor() {
-    super("Cannot find abstract-cli.");
-  }
-}
-
 export class FileAPIError extends BaseError {
   constructor() {
     super(

diff --git a/src/errors.test.js b/src/errors.test.js
@@ -3,7 +3,6 @@ import { CLI_CLIENT } from "./testing";
 import Client from "./Client";
 import {
   APITokenError,
-  CLIPathError,
   EndpointUndefinedError,
   FileAPIError,
   ForbiddenError,
@@ -35,24 +34,6 @@ describe("errors", () => {
     global.Blob = globalBlob;
   });
 
-  test("CLIPathError", async () => {
-    const client = new Client({
-      cliPath: "./nonexistent",
-      transportMode: "cli"
-    });
-
-    try {
-      await client.commits.list({
-        projectId: "project-id",
-        branchId: "branch-id",
-        fileId: "file-id",
-        sha: "sha"
-      });
-    } catch (error) {
-      expect(error).toBeInstanceOf(CLIPathError);
-    }
-  });
-
   test("FileAPIError", async () => {
     try {
       await CLI_CLIENT.previews.url({

diff --git a/src/index.js b/src/index.js
@@ -6,7 +6,6 @@ import * as sketch from "./sketch";
 import {
   APITokenError,
   BaseError,
-  CLIPathError,
   EndpointUndefinedError,
   FileAPIError,
   ForbiddenError,
@@ -23,7 +22,6 @@ export {
   // Custom errors
   APITokenError,
   BaseError,
-  CLIPathError,
   EndpointUndefinedError,
   FileAPIError,
   ForbiddenError,

diff --git a/src/testing.js b/src/testing.js
@@ -31,7 +31,6 @@ export const API_CLIENT = new Client({
 export const CLI_CLIENT = new Client({
   accessToken: "accessToken",
   apiUrl: "http://apiUrl",
-  cliPath: ".",
   previewsUrl: "http://previewsUrl",
   transportMode: "cli"
 });
@@ -47,7 +46,6 @@ export const API_CLIENT_CACHED = new Client({
 export const CLI_CLIENT_CACHED = new Client({
   accessToken: "accessToken",
   apiUrl: "http://apiUrl",
-  cliPath: ".",
   maxCacheSize: 10,
   previewsUrl: "http://previewsUrl",
   transportMode: "cli"

diff --git a/src/types.js b/src/types.js
@@ -1465,7 +1465,6 @@ export type AccessTokenOption =
 export type CommandOptions = {
   accessToken: AccessTokenOption,
   apiUrl: string | Promise<string>,
-  cliPath: string | Promise<string>,
   maxCacheSize: number,
   previewsUrl: string | Promise<string>,
   transportMode: "auto" | "api" | "cli",

diff --git a/yarn.lock b/yarn.lock
@@ -832,6 +832,11 @@
   dependencies:
     find-up "^2.1.0"
 
+"@elasticprojects/abstract-cli@^2.3.0":
+  version "2.3.0"
+  resolved "https://registry.yarnpkg.com/@elasticprojects/abstract-cli/-/abstract-cli-2.3.0.tgz#c52879563bff4a4f3fae5e96349cba072b72d3bc"
+  integrity sha512-gBjYGBVPZgkRKyjpCVsYoYxt8/woQ7NDnP26NEFye8ZzxIgbcVwEufPRLazHKRzp6MUWB1Vo8Inbm1CsWQuyjw==
+
 "@elasticprojects/eslint-config-abstract@^4.1.0":
   version "4.1.0"
   resolved "https://registry.yarnpkg.com/@elasticprojects/eslint-config-abstract/-/eslint-config-abstract-4.1.0.tgz#879707dde84d05126c7eb452eda51def433c5e25"