@grouparoo/core/__tests__/actions/oAuth.ts

The Grouparoo Core

process.env.GROUPAROO_AUTH_URL = "http://localhost:8080";

import { helper } from "@grouparoo/spec-helper";
import { specHelper } from "actionhero";
import { OAuthRequest, plugin } from "../../src";
import {
  OAuthListProviders,
  OAuthClientStart,
  OAuthClientEdit,
} from "../../src/actions/oAuth";

const customerId = "tcs_abc";
const requestId = "req_123";
let realRequestId: string;

// These tests can be re-nocked against a locally-running telemetry server via:
//  GROUPAROO_AUTH_URL="http://localhost:8080" NOCK=true pnpm test __tests__/actions/oAuth.ts
const updater = {
  rewrite: function (nockCall: string) {
    nockCall = nockCall.replace(
      new RegExp('"http://localhost:18081/oauth/callback"', "g"),
      "/http:\\/\\/localhost:\\d+\\/oauth\\/callback/"
    );

    return nockCall;
  },
};
helper.useNock(__filename, updater);

describe("actions/oAuth", () => {
  helper.grouparooTestServer({ truncate: true, resetSettings: true });

  beforeAll(async () => {
    await plugin.updateSetting("telemetry", "customer-id", customerId);
  });

  test("oauth providers can be listed", async () => {
    const { providers, error } = await specHelper.runAction<OAuthListProviders>(
      "oAuth:listProviders"
    );
    expect(error).toBeUndefined();
    expect(providers).toEqual([
      {
        authTypes: ["user"],
        description: "Sign in with GitHub",
        icon: "http://localhost:8080/images/auth-providers/github.png",
        name: "github",
      },
      {
        authTypes: ["user"],
        description: "Sign in with Google",
        icon: "http://localhost:8080/images/auth-providers/google.png",
        name: "google",
      },
      {
        authTypes: ["app"],
        description: "Connect to Mailchimp",
        icon: "http://localhost:8080/images/auth-providers/mailchimp.png",
        name: "mailchimp",
      },
    ]);
  });

  test("oauth providers can be listed and filtered by type", async () => {
    const { providers, error } = await specHelper.runAction<OAuthListProviders>(
      "oAuth:listProviders",
      { type: "user" }
    );
    expect(error).toBeUndefined();
    expect(providers).toEqual([
      {
        authTypes: ["user"],
        description: "Sign in with GitHub",
        icon: "http://localhost:8080/images/auth-providers/github.png",
        name: "github",
      },
      {
        authTypes: ["user"],
        description: "Sign in with Google",
        icon: "http://localhost:8080/images/auth-providers/google.png",
        name: "google",
      },
    ]);
  });

  test("an oauth request can be started", async () => {
    const { location, error } = await specHelper.runAction<OAuthClientStart>(
      "oAuth:client:start",
      {
        id: requestId, // this id would not normally be passed, but we need it for the test & nocking
        provider: "github",
        type: "user",
      }
    );

    expect(error).toBeUndefined();

    const localRequest = await OAuthRequest.findById(requestId);
    expect(localRequest).toBeTruthy();
    realRequestId = localRequest.id;

    expect(location).toMatch(
      /https:\/\/github.com\/login\/oauth\/authorize\?client_id=.*&scope=user%20user:email&state=req_123/
    );
  });

  // TODO: How can we test this without making real oAuth requests?
  test.todo("an oAuth token and identities can be retrieved");

  test("an oAuthRequest can be edited", async () => {
    const { oAuthRequest, error } = await specHelper.runAction<OAuthClientEdit>(
      "oAuth:client:edit",
      { requestId: realRequestId }
    );

    expect(error).toBeUndefined();

    expect(oAuthRequest).toEqual({
      id: realRequestId,
      provider: "github",
      type: "user",
      identities: [],
      consumed: false,
      appId: null,
      appOption: null,
      token: null,
    });
  });
});