Remove package config from deployments response

src/background/deploymentUpdater.ts

@@ -64,10 +64,14 @@ import { type UUID } from "@/types/stringTypes";
 import { type UnresolvedModComponent } from "@/types/modComponentTypes";
 import { type RegistryId } from "@/types/registryTypes";
 import { type OptionsArgs } from "@/types/runtimeTypes";
+import { type ModDefinition } from "@/types/modDefinitionTypes";
 import { checkDeploymentPermissions } from "@/permissions/deploymentPermissionsHelpers";
 import { Events } from "@/telemetry/events";
 import { allSettled } from "@/utils/promiseUtils";
 import type { Manifest } from "webextension-polyfill";
+import { getRequestHeadersByAPIVersion } from "@/data/service/apiVersioning";
+import { fetchDeploymentModDefinitions } from "@/modDefinitions/modDefinitionRawApiCalls";
+import { services } from "@/background/messenger/api";
 
 // eslint-disable-next-line local-rules/persistBackgroundData -- Static
 const { reducer: optionsReducer, actions: optionsActions } = extensionsSlice;
@@ -219,11 +223,17 @@ async function uninstallRecipe(
   return { options, editor };
 }
 
-async function installDeployment(
-  optionsState: ModComponentState,
-  editorState: EditorState | undefined,
-  deployment: Deployment,
-): Promise<{
+async function installDeployment({
+  optionsState,
+  editorState,
+  deployment,
+  deploymentModDefinition,
+}: {
+  optionsState: ModComponentState;
+  editorState: EditorState | undefined;
+  deployment: Deployment;
+  deploymentModDefinition: ModDefinition;
+}): Promise<{
   options: ModComponentState;
   editor: EditorState | undefined;
 }> {
@@ -248,12 +258,13 @@ async function installDeployment(
   options = optionsReducer(
     options,
     optionsActions.installMod({
-      modDefinition: deployment.package.config,
+      modDefinition: deploymentModDefinition,
       deployment,
-      configuredDependencies: await mergeDeploymentIntegrationDependencies(
+      configuredDependencies: await mergeDeploymentIntegrationDependencies({
         deployment,
-        locateAllForService,
-      ),
+        deploymentModDefinition,
+        locate: services.locateAllForId,
+      }),
       // Assume backend properly validates the options
       optionsArgs: deployment.options_config as OptionsArgs,
       screen: "background",
@@ -272,20 +283,30 @@ async function installDeployment(
 /**
  * Install all deployments
  * @param deployments deployments that PixieBrix already has permission to run
+ * @param deploymentsModDefinitionMap map of deployment package UUIDs to mod definitions
  */
-async function installDeployments(deployments: Deployment[]): Promise<void> {
+async function installDeployments({
+  deployments,
+  deploymentsModDefinitionMap,
+}: {
+  deployments: Deployment[];
+  deploymentsModDefinitionMap: Map<Deployment["package"]["id"], ModDefinition>;
+}): Promise<void> {
   let [optionsState, editorState] = await Promise.all([
     getModComponentState(),
     getEditorState(),
   ]);
 
   for (const deployment of deployments) {
     // eslint-disable-next-line no-await-in-loop -- running reducer, need to update states serially
-    const result = await installDeployment(
+    const result = await installDeployment({
       optionsState,
       editorState,
       deployment,
-    );
+      deploymentModDefinition: deploymentsModDefinitionMap.get(
+        deployment.package.id,
+      ),
+    });
     optionsState = result.options;
     editorState = result.editor;
   }
@@ -296,6 +317,7 @@ async function installDeployments(deployments: Deployment[]): Promise<void> {
 
 type DeploymentConstraint = {
   deployment: Deployment;
+  deploymentModDefinition: ModDefinition;
   hasPermissions: boolean;
   extensionVersion: SemVer;
 };
@@ -310,23 +332,25 @@ type DeploymentConstraint = {
  */
 async function canAutomaticallyInstall({
   deployment,
+  deploymentModDefinition,
   hasPermissions,
   extensionVersion,
 }: DeploymentConstraint): Promise<boolean> {
   if (!hasPermissions) {
     return false;
   }
 
-  const requiredRange = deployment.package.config.metadata.extensionVersion;
+  const requiredRange = deploymentModDefinition.metadata.extensionVersion;
   if (requiredRange && !satisfies(extensionVersion, requiredRange)) {
     return false;
   }
 
   const personalConfigs =
-    await findLocalDeploymentConfiguredIntegrationDependencies(
+    await findLocalDeploymentConfiguredIntegrationDependencies({
       deployment,
-      locateAllForService,
-    );
+      deploymentModDefinition,
+      locate: locateAllForService,
+    });
   return personalConfigs.every(({ configs }) => configs.length === 1);
 }
 
@@ -482,15 +506,21 @@ export async function updateDeployments(): Promise<void> {
   void updateUserData(selectUserDataUpdate(profile));
 
   const { data: deployments, status: deploymentResponseStatus } =
-    await client.post<Deployment[]>("/api/deployments/", {
-      uid: await getUUID(),
-      version: getExtensionVersion(),
-      active: selectInstalledDeployments(extensions),
-      campaignIds,
-    });
+    await client.post<Deployment[]>(
+      "/api/deployments/",
+      {
+        uid: await getUUID(),
+        version: getExtensionVersion(),
+        active: selectInstalledDeployments(extensions),
+        campaignIds,
+      },
+      {
+        headers: getRequestHeadersByAPIVersion("1.1"),
+      },
+    );
 
   if (deploymentResponseStatus >= 400) {
-    // Our server is active up, check again later
+    // Our server is acting up, check again later
     console.debug(
       "Skipping deployments update because /api/deployments/ request failed",
     );
@@ -550,7 +580,11 @@ export async function updateDeployments(): Promise<void> {
     return;
   }
 
-  // `clipboardWrite` is no strictly required to use the clipboard brick, so allow it to auto-install.
+  const deploymentsModDefinitionMap =
+    await fetchDeploymentModDefinitions(deployments);
+  console.log(deploymentsModDefinitionMap);
+
+  // `clipboardWrite` is not strictly required to use the clipboard brick, so allow it to auto-install.
   // Behind a feature flag in case it causes problems for enterprise customers.
   // Could use browser.runtime.getManifest().optional_permissions here, but that also technically supports the Origin
   // type so the types wouldn't match with checkDeploymentPermissions
@@ -562,7 +596,12 @@ export async function updateDeployments(): Promise<void> {
   const deploymentRequirements = await Promise.all(
     updatedDeployments.map(async (deployment) => ({
       deployment,
-      ...(await checkDeploymentPermissions(deployment, locateAllForService, {
+      ...(await checkDeploymentPermissions({
+        deployment,
+        deploymentModDefinition: deploymentsModDefinitionMap.get(
+          deployment.package.id,
+        ),
+        locate: locateAllForService,
         optionalPermissions,
       })),
     })),
@@ -574,6 +613,9 @@ export async function updateDeployments(): Promise<void> {
       isAutomatic: await canAutomaticallyInstall({
         ...requirement,
         extensionVersion,
+        deploymentModDefinition: deploymentsModDefinitionMap.get(
+          requirement.deployment.package.id,
+        ),
       }),
     })),
   );
@@ -584,7 +626,10 @@ export async function updateDeployments(): Promise<void> {
 
   if (automatic.length > 0) {
     try {
-      await installDeployments(automatic.map((x) => x.deployment));
+      await installDeployments({
+        deployments: automatic.map((x) => x.deployment),
+        deploymentsModDefinitionMap,
+      });
     } catch (error) {
       reportError(error);
       automaticError = true;

src/data/service/api.ts

@@ -29,8 +29,9 @@ import {
   type Milestone,
   type Organization,
   type Package,
+  type PackageConfigDetail,
   type PackageUpsertResponse,
-  type PackageVersion,
+  type PackageVersionDeprecated,
   type PendingInvitation,
   type RecipeResponse,
   type RemoteIntegrationConfig,
@@ -357,6 +358,19 @@ export const appApi = createApi({
       query: ({ id }) => ({ url: `/api/bricks/${id}/`, method: "get" }),
       providesTags: (result, error, { id }) => [{ type: "Package", id }],
     }),
+    getPackageViaRegistryId: builder.query<
+      PackageConfigDetail,
+      { registryId: RegistryId; version?: string }
+    >({
+      query: ({ registryId, version }) => ({
+        url: `/api/registry/bricks/${encodeURIComponent(registryId)}/`,
+        method: "get",
+        params: { version },
+      }),
+      providesTags: (result, error, { registryId }) => [
+        { type: "Package", id: registryId },
+      ],
+    }),
     createPackage: builder.mutation<PackageUpsertResponse, UnknownObject>({
       query(data) {
         return {
@@ -396,7 +410,10 @@ export const appApi = createApi({
         "EditablePackages",
       ],
     }),
-    listPackageVersions: builder.query<PackageVersion[], { id: UUID }>({
+    listPackageVersions: builder.query<
+      PackageVersionDeprecated[],
+      { id: UUID }
+    >({
       query: ({ id }) => ({
         url: `/api/bricks/${id}/versions/`,
         method: "get",
@@ -462,6 +479,7 @@ export const {
   useUpdateRecipeMutation,
   useGetInvitationsQuery,
   useGetPackageQuery,
+  useGetPackageViaRegistryIdQuery,
   useCreatePackageMutation,
   useUpdatePackageMutation,
   useDeletePackageMutation,

src/data/service/apiVersioning.ts

@@ -0,0 +1,45 @@
+/*
+ * Copyright (C) 2024 PixieBrix, Inc.
+ *
+ * This program is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Affero General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Affero General Public License for more details.
+ *
+ * You should have received a copy of the GNU Affero General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+// See similar file in the App codebase
+
+// See REST_FRAMEWORK["ALLOWED_VERSIONS"] in the Django settings
+const API_VERSIONS = ["1.0", "1.1", "2.0"] as const;
+export type ApiVersion = (typeof API_VERSIONS)[number];
+
+// See REST_FRAMEWORK["DEFAULT_VERSION"] in the Django settings
+const DEFAULT_API_VERSION = "1.0";
+
+export function getRequestHeadersByAPIVersion(
+  apiVersion: ApiVersion | undefined,
+) {
+  if (!apiVersion || apiVersion === DEFAULT_API_VERSION) {
+    // No headers are required for the default version.
+    // But we set as a default axios header in baseQuery.ts anyway.
+    return {};
+  }
+
+  const nonDefaultApiVersions = API_VERSIONS.filter(
+    (version) => version !== DEFAULT_API_VERSION,
+  );
+
+  if (nonDefaultApiVersions.includes(apiVersion)) {
+    return { Accept: `application/json; version=${apiVersion}` };
+  }
+
+  throw new Error("Unknown API version");
+}

src/data/service/baseQuery.ts

@@ -51,6 +51,11 @@ type QueryArgs = {
    * Optional URL parameters to be sent with the request
    */
   params?: AxiosRequestConfig["params"];
+
+  /**
+   * Optional headers to be sent with the request
+   */
+  headers?: AxiosRequestConfig["headers"];
 };
 
 // https://redux-toolkit.js.org/rtk-query/usage/customizing-queries#axios-basequery
@@ -61,12 +66,13 @@ const baseQuery: BaseQueryFn<QueryArgs> = async ({
   requireLinked = true,
   meta,
   params,
+  headers,
 }) => {
   try {
     const client = await (requireLinked
       ? getLinkedApiClient()
       : getApiClient());
-    const result = await client({ url, method, data, params });
+    const result = await client({ url, method, data, params, headers });
 
     return { data: result.data, meta };
   } catch (error) {

src/extensionConsole/pages/brickEditor/BrickHistory.test.tsx

@@ -25,7 +25,7 @@ import { uuidSequence } from "@/testUtils/factories/stringFactories";
 import selectEvent from "react-select-event";
 import { waitForEffect } from "@/testUtils/testHelpers";
 import { render } from "@/extensionConsole/testHelpers";
-import { type Package, type PackageVersion } from "@/types/contract";
+import { type Package, type PackageVersionDeprecated } from "@/types/contract";
 import { type Timestamp } from "@/types/stringTypes";
 
 const axiosMock = new MockAdapter(axios);
@@ -45,7 +45,7 @@ describe("BrickHistory", () => {
   };
 
   it("renders select components for choosing versions and displays the diff", async () => {
-    const testVersions: PackageVersion[] = [
+    const testVersions: PackageVersionDeprecated[] = [
       {
         id: testBrickId,
         version: "1.0.1",

src/extensionConsole/pages/brickEditor/BrickHistory.tsx

@@ -102,7 +102,7 @@ const BrickHistory: React.FunctionComponent<{
   // We look up the large rawConfig up separately instead of including it in the versionOptions array because
   // it's a large string, and it causes the UI to hang.
   // TODO: use a specific endpoint for fetching just version metadata without the entire mod config
-  //   https://github.com/pixiebrix/pixiebrix-app/issues/4627
+  //   https://github.com/pixiebrix/pixiebrix-extension/issues/7692
   const versionARawConfig = useMemo(
     () =>
       packageVersions?.find((version) => version.version === versionA?.value)