Fix API change for permanent API tokens

Author: NicoBiernat

package-lock.json

@@ -11,6 +11,7 @@ import {
 import { CreateOrUpdateRegistrationKeyPayload } from '@luna/contexts/api/auth/types/CreateOrUpdateRegistrationKeyPayload';
 import { CreateOrUpdateRolePayload } from '@luna/contexts/api/auth/types/CreateOrUpdateRolePayload';
 import { CreateOrUpdateUserPayload } from '@luna/contexts/api/auth/types/CreateOrUpdateUserPayload';
+import { UpdateTokenPayload } from '@luna/contexts/api/auth/types/UpdateTokenPayload';
 import { useInitRef } from '@luna/hooks/useInitRef';
 import { Pagination, slicePage } from '@luna/utils/pagination';
 import { errorResult, okResult, Result } from '@luna/utils/result';
@@ -49,6 +50,9 @@ export interface AuthContextValue {
   /** Invalidates the current token of the given (or current if none is provided) user and creates a new one. */
   cycleToken(id?: number): Promise<Result<void>>;
 
+  /** Updates a  */
+  updateToken(id: number, payload: UpdateTokenPayload): Promise<Result<void>>;
+
   /** Fetches all users. */
   getAllUsers(pagination?: Pagination): Promise<Result<User[]>>;
 
@@ -115,6 +119,7 @@ export const AuthContext = createContext<AuthContextValue>({
   logOut: async () => errorResult('No auth context for logging out'),
   getToken: async () => errorResult('No auth context for fetching token'),
   cycleToken: async () => errorResult('No auth context for cycling token'),
+  updateToken: async () => errorResult('No auth context for updating token'),
   getAllUsers: async () => errorResult('No auth context for fetching users'),
   getUserById: async () => errorResult('No auth context for fetching user'),
   createUser: async () => errorResult('No auth context for creating user'),
@@ -261,6 +266,17 @@ export function AuthContextProvider({ children }: AuthContextProviderProps) {
         }
       },
 
+      async updateToken(id: number, payload: UpdateTokenPayload) {
+        try {
+          await apiRef.current.users.apiTokenUpdate(id, payload);
+          return okResult(undefined);
+        } catch (error) {
+          return errorResult(
+            `Updating token of user with id ${id} to permanent state "${payload}" failed: ${await formatError(error)}`
+          );
+        }
+      },
+
       async getAllUsers(pagination) {
         try {
           const apiUsersResponse = await apiRef.current.users.usersList();

src/contexts/api/auth/AuthContext.tsx

@@ -30,6 +30,7 @@ export function signupToApi(signup: Signup): generated.RegisterPayload {
 export function tokenFromApi(apiToken: generated.APIToken): Token {
   return {
     value: apiToken.api_token!,
+    permanent: apiToken.permanent!,
     expiresAt: new Date(apiToken.expires_at!),
     username: apiToken.username!,
     roles: apiToken.roles!,
@@ -45,7 +46,6 @@ export function userFromApi(apiUser: generated.User): User {
     createdAt: new Date(apiUser.created_at!),
     updatedAt: new Date(apiUser.updated_at!),
     lastSeen: new Date(apiUser.last_login!),
-    permanentApiToken: apiUser.permanent_api_token!,
     registrationKey: apiUser.registration_key
       ? registrationKeyFromApi(apiUser.registration_key)
       : undefined,
@@ -82,7 +82,6 @@ export function createOrUpdateUserPayloadToApi(
     username: payload.username,
     password: payload.password,
     email: payload.email,
-    permanent_api_token: payload.permanent_api_token,
   };
 }
 

src/contexts/api/auth/convert.ts

@@ -9,12 +9,16 @@
  * ---------------------------------------------------------------
  */
 
+import { UpdateTokenPayload } from '@luna/contexts/api/auth/types/UpdateTokenPayload';
+
 /** API token that allows access to the websocket API (beacon) and probably other APIs in the future */
 export interface APIToken {
   /** the actual API token */
   api_token?: string;
   /** expiration date of this token */
   expires_at?: string;
+  /** whether this token is permanent */
+  permanent?: boolean;
   /** roles associated with this token */
   roles?: string[];
   /** unique username associated with this token */
@@ -98,8 +102,6 @@ export interface User {
   id?: number;
   /** ISO 8601 datetime TODO: redundant with UpdatedAt but only because LastLogin is updated on login */
   last_login?: string;
-  /** if set the users API token never automatically expires */
-  permanent_api_token?: boolean;
   /** omitted if null (when user was created and not registered) */
   registration_key?: RegistrationKey;
   /** ISO 8601 datetime */
@@ -132,16 +134,22 @@ export interface FullRequestParams extends Omit<RequestInit, 'body'> {
   cancelToken?: CancelToken;
 }
 
-export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
+export type RequestParams = Omit<
+  FullRequestParams,
+  'body' | 'method' | 'query' | 'path'
+>;
 
 export interface ApiConfig<SecurityDataType = unknown> {
   baseUrl?: string;
   baseApiParams?: Omit<RequestParams, 'baseUrl' | 'cancelToken' | 'signal'>;
-  securityWorker?: (securityData: SecurityDataType | null) => Promise<RequestParams | void> | RequestParams | void;
+  securityWorker?: (
+    securityData: SecurityDataType | null
+  ) => Promise<RequestParams | void> | RequestParams | void;
   customFetch?: typeof fetch;
 }
 
-export interface HttpResponse<D extends unknown, E extends unknown = unknown> extends Response {
+export interface HttpResponse<D extends unknown, E extends unknown = unknown>
+  extends Response {
   data: D;
   error: E;
 }
@@ -160,7 +168,8 @@ export class HttpClient<SecurityDataType = unknown> {
   private securityData: SecurityDataType | null = null;
   private securityWorker?: ApiConfig<SecurityDataType>['securityWorker'];
   private abortControllers = new Map<CancelToken, AbortController>();
-  private customFetch = (...fetchParams: Parameters<typeof fetch>) => fetch(...fetchParams);
+  private customFetch = (...fetchParams: Parameters<typeof fetch>) =>
+    fetch(...fetchParams);
 
   private baseApiParams: RequestParams = {
     credentials: 'same-origin',
@@ -193,9 +202,15 @@ export class HttpClient<SecurityDataType = unknown> {
 
   protected toQueryString(rawQuery?: QueryParamsType): string {
     const query = rawQuery || {};
-    const keys = Object.keys(query).filter(key => 'undefined' !== typeof query[key]);
+    const keys = Object.keys(query).filter(
+      key => 'undefined' !== typeof query[key]
+    );
     return keys
-      .map(key => (Array.isArray(query[key]) ? this.addArrayQueryParam(query, key) : this.addQueryParam(query, key)))
+      .map(key =>
+        Array.isArray(query[key])
+          ? this.addArrayQueryParam(query, key)
+          : this.addQueryParam(query, key)
+      )
       .join('&');
   }
 
@@ -206,8 +221,13 @@ export class HttpClient<SecurityDataType = unknown> {
 
   private contentFormatters: Record<ContentType, (input: any) => any> = {
     [ContentType.Json]: (input: any) =>
-      input !== null && (typeof input === 'object' || typeof input === 'string') ? JSON.stringify(input) : input,
-    [ContentType.Text]: (input: any) => (input !== null && typeof input !== 'string' ? JSON.stringify(input) : input),
+      input !== null && (typeof input === 'object' || typeof input === 'string')
+        ? JSON.stringify(input)
+        : input,
+    [ContentType.Text]: (input: any) =>
+      input !== null && typeof input !== 'string'
+        ? JSON.stringify(input)
+        : input,
     [ContentType.FormData]: (input: any) =>
       Object.keys(input || {}).reduce((formData, key) => {
         const property = input[key];
@@ -224,7 +244,10 @@ export class HttpClient<SecurityDataType = unknown> {
     [ContentType.UrlEncoded]: (input: any) => this.toQueryString(input),
   };
 
-  protected mergeRequestParams(params1: RequestParams, params2?: RequestParams): RequestParams {
+  protected mergeRequestParams(
+    params1: RequestParams,
+    params2?: RequestParams
+  ): RequestParams {
     return {
       ...this.baseApiParams,
       ...params1,
@@ -237,7 +260,9 @@ export class HttpClient<SecurityDataType = unknown> {
     };
   }
 
-  protected createAbortSignal = (cancelToken: CancelToken): AbortSignal | undefined => {
+  protected createAbortSignal = (
+    cancelToken: CancelToken
+  ): AbortSignal | undefined => {
     if (this.abortControllers.has(cancelToken)) {
       const abortController = this.abortControllers.get(cancelToken);
       if (abortController) {
@@ -281,15 +306,26 @@ export class HttpClient<SecurityDataType = unknown> {
     const payloadFormatter = this.contentFormatters[type || ContentType.Json];
     const responseFormat = format || requestParams.format;
 
-    return this.customFetch(`${baseUrl || this.baseUrl || ''}${path}${queryString ? `?${queryString}` : ''}`, {
-      ...requestParams,
-      headers: {
-        ...(requestParams.headers || {}),
-        ...(type && type !== ContentType.FormData ? { 'Content-Type': type } : {}),
-      },
-      signal: (cancelToken ? this.createAbortSignal(cancelToken) : requestParams.signal) || null,
-      body: typeof body === 'undefined' || body === null ? null : payloadFormatter(body),
-    }).then(async response => {
+    return this.customFetch(
+      `${baseUrl || this.baseUrl || ''}${path}${queryString ? `?${queryString}` : ''}`,
+      {
+        ...requestParams,
+        headers: {
+          ...(requestParams.headers || {}),
+          ...(type && type !== ContentType.FormData
+            ? { 'Content-Type': type }
+            : {}),
+        },
+        signal:
+          (cancelToken
+            ? this.createAbortSignal(cancelToken)
+            : requestParams.signal) || null,
+        body:
+          typeof body === 'undefined' || body === null
+            ? null
+            : payloadFormatter(body),
+      }
+    ).then(async response => {
       const r = response.clone() as HttpResponse<T, E>;
       r.data = null as unknown as T;
       r.error = null as unknown as E;
@@ -328,7 +364,9 @@ export class HttpClient<SecurityDataType = unknown> {
  * This is the REST API of Project Lighthouse that manages users, roles, registration keys, API tokens and everything about authentication and authorization.
  * NOTE: This API is an early alpha version that still needs a lot of testing (unit tests, end-to-end tests and security tests)
  */
-export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
+export class Api<
+  SecurityDataType extends unknown,
+> extends HttpClient<SecurityDataType> {
   login = {
     /**
      * @description Log in with username and password (sets a cookie with the session id). Returns the full user information if the login was successful or the user is already logged in.
@@ -417,7 +455,10 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @summary Create registration key
      * @request POST:/registration-keys
      */
-    registrationKeysCreate: (payload: CreateRegistrationKeyPayload, params: RequestParams = {}) =>
+    registrationKeysCreate: (
+      payload: CreateRegistrationKeyPayload,
+      params: RequestParams = {}
+    ) =>
       this.request<void, void>({
         path: `/registration-keys`,
         method: 'POST',
@@ -451,7 +492,11 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @summary Update registration key
      * @request PUT:/registration-keys/{id}
      */
-    registrationKeysUpdate: (id: number, payload: UpdateRegistrationKeyPayload, params: RequestParams = {}) =>
+    registrationKeysUpdate: (
+      id: number,
+      payload: UpdateRegistrationKeyPayload,
+      params: RequestParams = {}
+    ) =>
       this.request<void, void>({
         path: `/registration-keys/${id}`,
         method: 'PUT',
@@ -523,7 +568,10 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @summary Create role
      * @request POST:/roles
      */
-    rolesCreate: (payload: CreateOrUpdateRolePayload, params: RequestParams = {}) =>
+    rolesCreate: (
+      payload: CreateOrUpdateRolePayload,
+      params: RequestParams = {}
+    ) =>
       this.request<void, void>({
         path: `/roles`,
         method: 'POST',
@@ -556,7 +604,11 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @summary Update role
      * @request PUT:/roles/{id}
      */
-    rolesUpdate: (id: number, payload: CreateOrUpdateRolePayload, params: RequestParams = {}) =>
+    rolesUpdate: (
+      id: number,
+      payload: CreateOrUpdateRolePayload,
+      params: RequestParams = {}
+    ) =>
       this.request<void, void>({
         path: `/roles/${id}`,
         method: 'PUT',
@@ -658,7 +710,10 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @summary Create user
      * @request POST:/users
      */
-    usersCreate: (payload: CreateOrUpdateUserPayload, params: RequestParams = {}) =>
+    usersCreate: (
+      payload: CreateOrUpdateUserPayload,
+      params: RequestParams = {}
+    ) =>
       this.request<void, void>({
         path: `/users`,
         method: 'POST',
@@ -691,7 +746,11 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
      * @summary Update user
      * @request PUT:/users/{id}
      */
-    usersUpdate: (id: number, payload: CreateOrUpdateUserPayload, params: RequestParams = {}) =>
+    usersUpdate: (
+      id: number,
+      payload: CreateOrUpdateUserPayload,
+      params: RequestParams = {}
+    ) =>
       this.request<void, void>({
         path: `/users/${id}`,
         method: 'PUT',
@@ -731,6 +790,28 @@ export class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDa
         ...params,
       }),
 
+    /**
+     * @description Updates an API token of a user to be permanent or non-permanent.
+     *
+     * @tags Users
+     * @name apiTokenUpdate
+     * @summary Update a user's API token
+     * @request PUT:/users/{id}/api-token
+     */
+    apiTokenUpdate: (
+      id: number,
+      payload: UpdateTokenPayload,
+      params: RequestParams = {}
+    ) =>
+      this.request<APIToken, void>({
+        path: `/users/${id}/api-token`,
+        method: 'PUT',
+        format: 'json',
+        body: payload,
+        type: ContentType.Json,
+        ...params,
+      }),
+
     /**
      * @description Given a valid user id, invalidates the current API token and generates a new one
      *

src/contexts/api/auth/generated.ts

@@ -2,5 +2,4 @@ export interface CreateOrUpdateUserPayload {
   username: string;
   password: string;
   email: string;
-  permanent_api_token: boolean;
 }

src/contexts/api/auth/types/CreateOrUpdateUserPayload.ts

@@ -2,5 +2,6 @@ export interface Token {
   value: string;
   expiresAt: Date;
   username: string;
+  permanent: boolean;
   roles: string[];
 }

src/contexts/api/auth/types/Token.ts

@@ -0,0 +1,3 @@
+export interface UpdateTokenPayload {
+  permanent: boolean;
+}

src/contexts/api/auth/types/UpdateTokenPayload.ts

@@ -9,7 +9,6 @@ export interface User {
   createdAt: Date;
   updatedAt: Date;
   lastSeen: Date;
-  permanentApiToken: boolean;
   registrationKey?: RegistrationKey;
 }
 
@@ -22,7 +21,6 @@ export function newUninitializedUser(): User {
     createdAt: new Date(0),
     updatedAt: new Date(0),
     lastSeen: new Date(0),
-    permanentApiToken: false,
     registrationKey: {
       id: 0,
       key: '',