#8791: Migrate /api/me/ from version 1.0 to 1.1

.secrets.baseline

@@ -253,16 +253,16 @@
         "filename": "src/testUtils/factories/authFactories.ts",
         "hashed_secret": "d15e5a27160ace913d22871497c05a7e5bbbe2ef",
         "is_verified": false,
-        "line_number": 160
+        "line_number": 162
       },
       {
         "type": "Hex High Entropy String",
         "filename": "src/testUtils/factories/authFactories.ts",
         "hashed_secret": "ff998abc1ce6d8f01a675fa197368e44c8916e9c",
         "is_verified": false,
-        "line_number": 175
+        "line_number": 177
       }
     ]
   },
-  "generated_at": "2024-07-14T14:40:50Z"
+  "generated_at": "2024-07-16T20:20:53Z"
 }

src/auth/authSelectors.ts

@@ -27,6 +27,3 @@ export const selectOrganizations = (state: AuthRootState) =>
   selectAuth(state).organizations;
 export const selectOrganization = (state: AuthRootState) =>
   selectAuth(state).organization;
-
-export const selectTelemetryOrganizationId = (state: AuthRootState) =>
-  selectAuth(state).telemetryOrganizationId;

src/auth/authTypes.ts

@@ -53,10 +53,6 @@ export type UserData = Partial<{
    * The user's primary organization.
    */
   organizationId: UUID | null;
-  /**
-   * The user's organization for engagement and error attribution
-   */
-  telemetryOrganizationId: UUID | null;
   /**
    * Organizations the user is a member of
    */
@@ -102,7 +98,6 @@ export type UserDataUpdate = Required<Except<UserData, "hostname" | "user">>;
 export const USER_DATA_UPDATE_KEYS: Array<keyof UserDataUpdate> = [
   "email",
   "organizationId",
-  "telemetryOrganizationId",
   "organizations",
   "groups",
   "enforceUpdateMillis",
@@ -157,6 +152,10 @@ export type OrganizationAuthState = {
    * The human-readable name of the organization.
    */
   readonly name: string;
+  /**
+   * Whether the organization is an enterprise organization.
+   */
+  readonly isEnterprise: boolean;
   /**
    * The package scope of the organization, or null if not set.
    */
@@ -230,14 +229,6 @@ export type AuthState = {
    */
   readonly organization?: OrganizationAuthState | null;
 
-  /**
-   * The enterprise organization used for telemetry collection, or null. Generally, if set, this will be the same as the
-   * user's primary organization.
-   *
-   * @since 1.7.35
-   */
-  readonly telemetryOrganizationId?: UUID | null;
-
   /**
    * Organizations the user is a member of
    */

src/auth/authUtils.ts

@@ -27,7 +27,6 @@ import { UserRole } from "@/types/contract";
 export function selectUserDataUpdate({
   email,
   primaryOrganization,
-  telemetryOrganization,
   organizationMemberships,
   groupMemberships,
   partner,
@@ -47,7 +46,6 @@ export function selectUserDataUpdate({
     -- email is always present, pending above type refactoring */
     email: email!,
     organizationId: primaryOrganization?.organizationId ?? null,
-    telemetryOrganizationId: telemetryOrganization?.organizationId ?? null,
     organizations,
     groups,
     partner: partner ?? null,
@@ -61,7 +59,6 @@ export function selectExtensionAuthState({
   email,
   scope,
   primaryOrganization,
-  telemetryOrganization,
   isOnboarded,
   isTestAccount,
   userMilestones: milestones,
@@ -81,6 +78,7 @@ export function selectExtensionAuthState({
       : {
           id: primaryOrganization.organizationId,
           name: primaryOrganization.organizationName,
+          isEnterprise: primaryOrganization.isEnterprise,
           scope: primaryOrganization.scope,
           theme: primaryOrganization.organizationTheme,
           control_room: primaryOrganization.controlRoom,
@@ -95,7 +93,6 @@ export function selectExtensionAuthState({
     isTestAccount,
     extension: true,
     organization,
-    telemetryOrganizationId: telemetryOrganization?.organizationId,
     organizations,
     groups,
     milestones,

src/background/deploymentUpdater.ts

@@ -70,7 +70,6 @@ import { checkDeploymentPermissions } from "@/permissions/deploymentPermissionsH
 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 { integrationConfigLocator } from "@/background/messenger/api";
 import type { ActivatableDeployment } from "@/types/deploymentTypes";
@@ -562,10 +561,6 @@ export async function syncDeployments(): Promise<void> {
       active: selectInstalledDeployments(activatedModComponents),
       campaignIds,
     },
-    {
-      // @since 1.8.10 -- API version 1.1 excludes the package config
-      headers: getRequestHeadersByAPIVersion("1.1"),
-    },
   );
 
   const isInitialDeploymentUpdate =

src/components/floatingActions/initFloatingActions.ts

@@ -17,10 +17,11 @@
 
 import { isLoadedInIframe } from "@/utils/iframeUtils";
 import { getSettingsState } from "@/store/settings/settingsStorage";
-import { getUserData } from "@/background/messenger/api";
 import { DEFAULT_THEME } from "@/themes/themeTypes";
 import { flagOn } from "@/auth/featureFlagStorage";
 import { isLinked as getIsLinked } from "@/auth/authStorage";
+import { transformMeResponse } from "@/data/model/Me";
+import { getMe } from "@/data/service/backgroundApi";
 
 /**
  * Add the floating action button to the page if the user is not an enterprise/partner user.
@@ -33,18 +34,19 @@ export default async function initFloatingActions(): Promise<void> {
     return;
   }
 
-  const [settings, { telemetryOrganizationId }, isLinked] = await Promise.all([
+  const [settings, isLinked] = await Promise.all([
     getSettingsState(),
-    getUserData(),
     getIsLinked(),
   ]);
 
-  // `telemetryOrganizationId` indicates user is part of an enterprise organization
-  // See https://github.com/pixiebrix/pixiebrix-app/blob/39fac4874402a541f62e80ab74aaefd446cc3743/api/models/user.py#L68-L68
+  const meApiResponse = await getMe();
+  const meData = transformMeResponse(meApiResponse);
+
   // Just get the theme from the store instead of using getActive theme to avoid extra Chrome storage reads
   // In practice, the Chrome policy should not change between useGetTheme and a call to initFloatingActions on a page
   const isEnterpriseOrPartnerUser =
-    Boolean(telemetryOrganizationId) || settings.theme !== DEFAULT_THEME;
+    meData?.primaryOrganization?.isEnterprise ||
+    settings.theme !== DEFAULT_THEME;
 
   const hasFeatureFlag = await flagOn("floating-quickbar-button-freemium");
 

src/data/model/Me.ts

@@ -93,11 +93,6 @@ export type Me = {
    * The user's primary organization, if they belong to one
    */
   primaryOrganization?: MeOrganization;
-  /**
-   * The enterprise organization used for telemetry collection. Generally,
-   * if set, this will be the same as the user's primary organization.
-   */
-  telemetryOrganization?: MeOrganization;
   /**
    * The partner, controlling theme, documentation links, etc.
    */
@@ -151,12 +146,6 @@ export function transformMeResponse(response: components["schemas"]["Me"]): Me {
     );
   }
 
-  if (response.telemetry_organization) {
-    me.telemetryOrganization = transformMeOrganizationResponse(
-      response.telemetry_organization,
-    );
-  }
-
   if (response.partner) {
     me.partner = transformUserPartnerResponse(response.partner);
   }

src/data/model/MeOrganization.ts

@@ -37,6 +37,10 @@ export type MeOrganization = {
    * The organization's name.
    */
   organizationName: string;
+  /**
+   * Whether the organization is an enterprise organization.
+   */
+  isEnterprise: boolean;
   /**
    * The organization's scope for saving modsmods, if set. A string beginning with "@".
    */
@@ -60,6 +64,7 @@ export function transformMeOrganizationResponse(
   const organization: MeOrganization = {
     organizationId: validateUUID(response.id),
     organizationName: response.name,
+    isEnterprise: response.is_enterprise ?? false,
   };
 
   if (response.scope) {

src/data/service/api.ts

@@ -38,7 +38,6 @@ import {
 import { type components } from "@/types/swagger";
 import { dumpBrickYaml } from "@/runtime/brickYaml";
 import { isAxiosError } from "@/errors/networkErrorHelpers";
-import { getRequestHeadersByAPIVersion } from "@/data/service/apiVersioning";
 import { type IntegrationDefinition } from "@/integrations/integrationTypes";
 import {
   type ModDefinition,
@@ -462,8 +461,6 @@ export const appApi = createApi({
         url: "/api/deployments/",
         method: "post",
         data,
-        // @since 1.8.10 -- API version 1.1 excludes the package config
-        headers: getRequestHeadersByAPIVersion("1.1"),
       }),
       providesTags: ["Deployments"],
     }),

src/data/service/apiClient.ts

@@ -31,6 +31,7 @@ import {
 import { isUrlRelative } from "@/utils/urlUtils";
 import createAuthRefreshInterceptor from "axios-auth-refresh";
 import { selectAxiosError } from "@/data/service/requestErrorUtils";
+import { getURLApiVersion } from "@/data/service/apiVersioning";
 import { isAuthenticationAxiosError } from "@/auth/isAuthenticationAxiosError";
 import { refreshPartnerAuthentication } from "@/background/messenger/api";
 
@@ -69,12 +70,25 @@ async function setupApiClient(): Promise<void> {
 
   apiClientInstance = axios.create({
     baseURL: await getBaseURL(),
-    headers: {
-      ...authHeaders,
-      // Version 2.0 is paginated. Explicitly pass version, so we can switch the default version on the server
-      // once clients are all passing an explicit version number
-      Accept: "application/json; version=1.0",
-    },
+    headers: { ...authHeaders },
+  });
+
+  apiClientInstance.interceptors.request.use(async (config) => {
+    const apiVersion = getURLApiVersion(config.url);
+
+    // Create a clone to avoid the no-param-reassign eslint rule
+    const newConfig = config;
+
+    // If apiVersion is the default version (see DEFAULT_API_VERSION), we don't necessarily need the header,
+    // but let's include it because it has the following benefits:
+    // - The explicit version header makes troubleshooting easier
+    // - Allows us to change the default version without breaking clients, see https://github.com/pixiebrix/pixiebrix-app/issues/5060
+    newConfig.headers = {
+      ...config.headers,
+      Accept: `application/json; version=${apiVersion}`,
+    };
+
+    return newConfig;
   });
 
   // Create auth interceptor for partner auth refresh tokens

src/data/service/apiVersioning.ts

@@ -17,16 +17,28 @@
 
 // See similar file in the App codebase
 
+// See REST_FRAMEWORK["DEFAULT_VERSION"] in the Django settings
+const DEFAULT_API_VERSION = "1.0";
+
 // See REST_FRAMEWORK["ALLOWED_VERSIONS"] in the Django settings
-const API_VERSIONS = ["1.0", "1.1", "2.0"] as const;
+const API_VERSIONS = [DEFAULT_API_VERSION, "1.1", "2.0"];
 export type ApiVersion = (typeof API_VERSIONS)[number];
 
-export function getRequestHeadersByAPIVersion(apiVersion: ApiVersion) {
-  // The default version doesn't require a header, but pass it anyway to be explicit
-  // and make troubleshooting easier.
-  if (API_VERSIONS.includes(apiVersion)) {
-    return { Accept: `application/json; version=${apiVersion}` };
+// Don't include the baseURL in the map keys because the base URL is baked into the axios instance,
+// see setupApiClient(), so the URL we're matching against will always be relative.
+// Also, the URL must be the full path string. We're not currently doing any regex or substring matching,
+// see getURLApiVersion().
+const API_VERSION_MAP = new Map<string, ApiVersion>([
+  // @since 1.8.10 -- excludes the package config
+  ["/api/deployments/", "1.1"],
+  // @since 2.0.6 -- includes organization.is_enterprise and excludes telemetry_organization
+  ["/api/me/", "1.1"],
+]);
+
+export function getURLApiVersion(url: string | undefined): string {
+  if (!url) {
+    return DEFAULT_API_VERSION;
   }
 
-  throw new Error("Unknown API version");
+  return API_VERSION_MAP.get(url) || DEFAULT_API_VERSION;
 }

src/data/service/errorService.ts

@@ -155,11 +155,11 @@ export async function reportToErrorService(
   }
 
   const { extensionVersion, ...data } = await selectExtraContext(error);
-  const { telemetryOrganizationId, organizationId } = await getUserData();
+  const { organizationId } = await getUserData();
 
   const payload: ErrorItem = {
     uuid: uuidv4(),
-    organization: telemetryOrganizationId ?? organizationId,
+    organization: organizationId,
     class_name: error.name,
     message,
     deployment: flatContext.deploymentId,

src/hooks/useIsEnterpriseUser.ts

@@ -16,16 +16,16 @@
  */
 
 import { useSelector } from "react-redux";
-import { selectTelemetryOrganizationId } from "@/auth/authSelectors";
+import { selectOrganization } from "@/auth/authSelectors";
 import useTheme from "@/hooks/useTheme";
 import { DEFAULT_THEME } from "@/themes/themeTypes";
 
 function useIsEnterpriseUser() {
-  const telemetryOrganizationId = useSelector(selectTelemetryOrganizationId);
+  const organization = useSelector(selectOrganization);
   const {
     activeTheme: { themeName },
   } = useTheme();
-  return Boolean(telemetryOrganizationId) || themeName !== DEFAULT_THEME;
+  return organization?.isEnterprise || themeName !== DEFAULT_THEME;
 }
 
 export default useIsEnterpriseUser;

src/telemetry/telemetryHelpers.ts

@@ -78,12 +78,12 @@ export async function mapAppUserToTelemetryUser(
   data: UserData,
 ): Promise<TelemetryUser> {
   const browserId = await getUUID();
-  const { user, email, telemetryOrganizationId, organizationId } = data;
+  const { user, email, organizationId } = data;
 
   return {
     id: user ?? browserId,
     email,
-    organizationId: telemetryOrganizationId ?? organizationId,
+    organizationId,
   };
 }
 

src/testUtils/factories/authFactories.ts

@@ -101,8 +101,11 @@ export const authStateFactory = define<AuthState>({
     ];
   },
   organization: derive<AuthState, OrganizationAuthState>(
-    // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion -- Entries defined above, this is non-null, non-empty
-    ({ organizations }) => organizations![0]!,
+    ({ organizations }) => ({
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion -- Entries defined above, this is non-null, non-empty
+      ...organizations![0]!,
+      isEnterprise: false,
+    }),
     "organizations",
   ),
   groups() {
@@ -134,7 +137,6 @@ export const meApiResponseFactory = define<components["schemas"]["Me"]>({
   flags: (): components["schemas"]["Me"]["flags"] => [],
   is_onboarded: true,
   organization: undefined,
-  telemetry_organization: undefined,
   organization_memberships:
     (): components["schemas"]["Me"]["organization_memberships"] => [],
   group_memberships: (): components["schemas"]["Me"]["group_memberships"] => [],