Skip to content

Commit

Permalink
Add onUpdate event listener for installing starter blueprints on Play…
Browse files Browse the repository at this point in the history 
…ground urls (#4249)

* add tabs onUpdated event listener for starter blueprints

* install stater blueprints on playground urls

* fix starter blueprint tests

* refactor extract install starter blueprints loop

* extract more installation methods

* refactor installStarterBlueprints

* update starter blueprint onUpdate url

* fix starterBlueprint test

* fix test typo

* add installation lock

* add debounce to starter blueprint installation for onUpdate events

* remove trailing param

* readd trailing

* add boolean return on error

* call debouncedInstallStarterBlueprints for first time installs also

* fix jest tests for new debounce refactor with fake timers'

Co-authored-by: Misha Holtz <mishmish@Mishas-MacBook-Pro.local>
  • Loading branch information
@mnholtz
mnholtz and Misha Holtz authored Sep 8, 2022
1 parent bf02a10 commit 238f5eb
Show file tree
Hide file tree
Showing 2 changed files with 153 additions and 53 deletions.
67 changes: 47 additions & 20 deletions src/background/starterBlueprints.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,13 @@
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/

import { installStarterBlueprints } from "@/background/starterBlueprints";
import { firstTimeInstallStarterBlueprints } from "@/background/starterBlueprints";
import { loadOptions, saveOptions } from "@/store/extensionsStorage";
import MockAdapter from "axios-mock-adapter";
import axios from "axios";
import { isLinked } from "@/auth/token";
import { extensionFactory, recipeFactory } from "@/testUtils/factories";
import { PersistedExtension } from "@/core";
import { PersistedExtension, RecipeMetadata } from "@/core";

const axiosMock = new MockAdapter(axios);

Expand All @@ -38,9 +38,11 @@ jest.mock("@/background/util", () => ({

const isLinkedMock = isLinked as jest.Mock;
const openPlaygroundPage = browser.tabs.create as jest.Mock;
jest.useFakeTimers();

beforeEach(async () => {
jest.resetModules();
jest.runAllTimers();

// Reset local options state
await saveOptions({
Expand All @@ -55,10 +57,15 @@ describe("installStarterBlueprints", () => {
test("user has starter blueprints available to install", async () => {
isLinkedMock.mockResolvedValue(true);

axiosMock.onGet().reply(200, [recipeFactory()]);
axiosMock.onPost().reply(204);
axiosMock
.onGet("/api/onboarding/starter-blueprints/install/")
.reply(200, { install_starter_blueprints: true });
axiosMock
.onGet("/api/onboarding/starter-blueprints/")
.reply(200, [recipeFactory()]);
axiosMock.onPost("/api/onboarding/starter-blueprints/install/").reply(204);

await installStarterBlueprints();
await firstTimeInstallStarterBlueprints();
const { extensions } = await loadOptions();

expect(extensions.length).toBe(1);
Expand All @@ -68,10 +75,15 @@ describe("installStarterBlueprints", () => {
test("user does not have starter blueprints available to install", async () => {
isLinkedMock.mockResolvedValue(true);

axiosMock.onGet().reply(200, []);
axiosMock.onPost().reply(204);
axiosMock
.onGet("/api/onboarding/starter-blueprints/install/")
.reply(200, { install_starter_blueprints: false });
axiosMock
.onGet("/api/onboarding/starter-blueprints/")
.reply(200, [recipeFactory()]);
axiosMock.onPost("/api/onboarding/starter-blueprints/install/").reply(204);

await installStarterBlueprints();
await firstTimeInstallStarterBlueprints();
const { extensions } = await loadOptions();

expect(extensions.length).toBe(0);
Expand All @@ -81,10 +93,13 @@ describe("installStarterBlueprints", () => {
test("starter blueprints request fails", async () => {
isLinkedMock.mockResolvedValue(true);

axiosMock.onGet().reply(500);
axiosMock.onPost().reply(204);
axiosMock
.onGet("/api/onboarding/starter-blueprints/install/")
.reply(200, { install_starter_blueprints: true });
axiosMock.onGet("/api/onboarding/starter-blueprints/").reply(500);
axiosMock.onPost("/api/onboarding/starter-blueprints/install/").reply(204);

await installStarterBlueprints();
await firstTimeInstallStarterBlueprints();
const { extensions } = await loadOptions();

expect(extensions.length).toBe(0);
Expand All @@ -94,10 +109,15 @@ describe("installStarterBlueprints", () => {
test("starter blueprints installation request fails", async () => {
isLinkedMock.mockResolvedValue(true);

axiosMock.onGet().reply(200, []);
axiosMock.onPost().reply(500);
axiosMock
.onGet("/api/onboarding/starter-blueprints/install/")
.reply(200, { install_starter_blueprints: true });
axiosMock
.onGet("/api/onboarding/starter-blueprints/")
.reply(200, [recipeFactory()]);
axiosMock.onPost("/api/onboarding/starter-blueprints/install/").reply(500);

await installStarterBlueprints();
await firstTimeInstallStarterBlueprints();
const { extensions } = await loadOptions();

expect(extensions.length).toBe(0);
Expand All @@ -107,22 +127,29 @@ describe("installStarterBlueprints", () => {
test("starter blueprint already installed", async () => {
isLinkedMock.mockResolvedValue(true);

const extension = extensionFactory() as PersistedExtension;
const recipe = recipeFactory();

const extension = extensionFactory({
_recipe: { id: recipe.metadata.id } as RecipeMetadata,
}) as PersistedExtension;
await saveOptions({
extensions: [extension],
});

axiosMock.onGet().reply(200, [
axiosMock
.onGet("/api/onboarding/starter-blueprints/install/")
.reply(200, { install_starter_blueprints: true });

axiosMock.onGet("/api/onboarding/starter-blueprints/").reply(200, [
{
updated_at: "",
extensionPoints: [extension],
sharing: {},
...recipe,
},
]);

axiosMock.onPost().reply(204);
axiosMock.onPost("/api/onboarding/starter-blueprints/install/").reply(204);

await installStarterBlueprints();
await firstTimeInstallStarterBlueprints();
const { extensions } = await loadOptions();

expect(extensions.length).toBe(1);
Expand Down
139 changes: 106 additions & 33 deletions src/background/starterBlueprints.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,74 +23,147 @@ import { forEachTab } from "@/background/util";
import { queueReactivateTab } from "@/contentScript/messenger/api";
import { ExtensionOptionsState } from "@/store/extensionsTypes";
import reportError from "@/telemetry/reportError";
import { debounce } from "lodash";

const { reducer, actions } = extensionsSlice;

function installStarterBlueprint(
const PLAYGROUND_URL = "https://www.pixiebrix.com/playground";
let isInstallingBlueprints = false;
const BLUEPRINT_INSTALLATION_DEBOUNCE_MS = 10_000;
const BLUEPRINT_INSTALLATION_MAX_MS = 60_000;

function installBlueprint(
state: ExtensionOptionsState,
starterBlueprint: RecipeDefinition
blueprint: RecipeDefinition
): ExtensionOptionsState {
return reducer(
state,
actions.installRecipe({
recipe: starterBlueprint,
extensionPoints: starterBlueprint.extensionPoints,
recipe: blueprint,
extensionPoints: blueprint.extensionPoints,
})
);
}

export async function installStarterBlueprints(): Promise<void> {
async function installBlueprints(
blueprints: RecipeDefinition[]
): Promise<boolean> {
let installed = false;
if (blueprints.length === 0) {
return installed;
}

let extensionsState = await loadOptions();
for (const blueprint of blueprints) {
const blueprintAlreadyInstalled = extensionsState.extensions.some(
(extension) => extension._recipe.id === blueprint.metadata.id
);

if (!blueprintAlreadyInstalled) {
extensionsState = installBlueprint(extensionsState, blueprint);
installed = true;
}
}

await saveOptions(extensionsState);
await forEachTab(queueReactivateTab);
return installed;
}

async function getShouldFirstTimeInstall(): Promise<boolean> {
const client = await maybeGetLinkedApiClient();
if (client == null) {
console.debug(
"Skipping starter blueprint installation because the extension is not linked to the PixieBrix service"
);
return;
return false;
}

try {
const {
data: { install_starter_blueprints: shouldInstall },
} = await client.get("/api/onboarding/starter-blueprints/install/");

if (shouldInstall) {
// If the starter blueprint request fails for some reason, or the user's primary organization
// gets removed, we'd still like to mark starter blueprints as installed for this user
// so that they don't see onboarding views/randomly have starter blueprints installed
// the next time they open the extension
await client.post("/api/onboarding/starter-blueprints/install/");
}

return shouldInstall;
} catch (error) {
reportError(error);
return false;
}
}

async function getStarterBlueprints(): Promise<RecipeDefinition[]> {
const client = await maybeGetLinkedApiClient();
if (client == null) {
console.debug(
"Skipping starter blueprint installation because the extension is not linked to the PixieBrix service"
);
return [];
}

try {
const { data: starterBlueprints } = await client.get<RecipeDefinition[]>(
"/api/onboarding/starter-blueprints/"
);
return starterBlueprints;
} catch (error) {
reportError(error);
return [];
}
}

// If the starter blueprint request fails for some reason, or the user's primary organization
// gets removed, we'd still like to mark starter blueprints as installed for this user
// so that they don't see onboarding views/randomly have starter blueprints installed
// the next time they open the extension
await client.post("/api/onboarding/starter-blueprints/install/");

if (starterBlueprints.length === 0) {
return;
}
const _installStarterBlueprints = async (): Promise<boolean> => {
if (isInstallingBlueprints) {
return false;
}

let extensionsState = await loadOptions();
isInstallingBlueprints = true;
const starterBlueprints = await getStarterBlueprints();
const installed = await installBlueprints(starterBlueprints);
isInstallingBlueprints = false;
return installed;
};

for (const starterBlueprint of starterBlueprints) {
const blueprintAlreadyInstalled = extensionsState.extensions.some(
(extension) => extension._recipe.id === starterBlueprint.metadata.id
);
const debouncedInstallStarterBlueprints = debounce(
_installStarterBlueprints,
BLUEPRINT_INSTALLATION_DEBOUNCE_MS,
{
leading: true,
trailing: false,
maxWait: BLUEPRINT_INSTALLATION_MAX_MS,
}
);

if (!blueprintAlreadyInstalled) {
extensionsState = installStarterBlueprint(
extensionsState,
starterBlueprint
);
}
}
export async function firstTimeInstallStarterBlueprints(): Promise<void> {
const shouldInstall = await getShouldFirstTimeInstall();
if (!shouldInstall) {
return;
}

await saveOptions(extensionsState);
const installed = await debouncedInstallStarterBlueprints();

await forEachTab(queueReactivateTab);
if (installed) {
void browser.tabs.create({
url: "https://www.pixiebrix.com/playground",
url: PLAYGROUND_URL,
});
} catch (error) {
reportError(error);
}
}

function initStarterBlueprints(): void {
void installStarterBlueprints();
browser.tabs.onUpdated.addListener((tabId, changeInfo, tab) => {
if (tab?.url?.startsWith(PLAYGROUND_URL)) {
void debouncedInstallStarterBlueprints();
}
});

void firstTimeInstallStarterBlueprints();
}

export default initStarterBlueprints;

0 comments on commit 238f5eb

Please sign in to comment.