revert improvised defaults and be clearer in types that these fields are nullable

Author: chriswk

src/lib/create-config.ts

@@ -335,17 +335,22 @@ const parseEnvVarInitialAdminUser = (): UsernameAdminUser | undefined => {
     return username && password ? { username, password } : undefined;
 };
 
-const defaultAuthentication: IAuthOption = {
-    demoAllowAdminLogin: parseEnvVarBoolean(
-        process.env.AUTH_DEMO_ALLOW_ADMIN_LOGIN,
-        false,
-    ),
-    enableApiToken: parseEnvVarBoolean(process.env.AUTH_ENABLE_API_TOKEN, true),
-    type: authTypeFromString(process.env.AUTH_TYPE),
-    customAuthHandler: defaultCustomAuthDenyAll,
-    createAdminUser: true,
-    initialAdminUser: parseEnvVarInitialAdminUser(),
-    initApiTokens: [],
+const buildDefaultAuthOption = () => {
+    return {
+        demoAllowAdminLogin: parseEnvVarBoolean(
+            process.env.AUTH_DEMO_ALLOW_ADMIN_LOGIN,
+            false,
+        ),
+        enableApiToken: parseEnvVarBoolean(
+            process.env.AUTH_ENABLE_API_TOKEN,
+            true,
+        ),
+        type: authTypeFromString(process.env.AUTH_TYPE),
+        customAuthHandler: defaultCustomAuthDenyAll,
+        createAdminUser: true,
+        initialAdminUser: parseEnvVarInitialAdminUser(),
+        initApiTokens: [],
+    };
 };
 
 const defaultImport: WithOptional<IImportOption, 'file'> = {
@@ -563,7 +568,7 @@ export function createConfig(options: IUnleashOptions): IUnleashConfig {
     const initApiTokens = loadInitApiTokens();
 
     const authentication: IAuthOption = mergeAll([
-        defaultAuthentication,
+        buildDefaultAuthOption(),
         (options.authentication
             ? removeUndefinedKeys(options.authentication)
             : options.authentication) || {},

src/lib/domain/project-health/project-health.ts

@@ -22,14 +22,17 @@ const getPotentiallyStaleCount = (
     const today = new Date().valueOf();
 
     return features.filter((feature) => {
-        const diff = today - feature.createdAt!.valueOf();
+        const diff = feature.createdAt
+            ? today - feature.createdAt.valueOf()
+            : 0;
         const featureTypeExpectedLifetime = featureTypes.find(
             (t) => t.id === feature.type,
-        )!.lifetimeDays;
+        )?.lifetimeDays;
 
         return (
             !feature.stale &&
             featureTypeExpectedLifetime !== null &&
+            featureTypeExpectedLifetime !== undefined &&
             diff >= featureTypeExpectedLifetime * hoursToMilliseconds(24)
         );
     }).length;

src/lib/features/client-feature-toggles/fakes/fake-client-feature-toggle-store.ts

@@ -38,7 +38,7 @@ export default class FakeClientFeatureToggleStore
             ...t,
             enabled: true,
             strategies: [],
-            description: t.description || '',
+            description: t.description,
             type: t.type || 'Release',
             stale: t.stale || false,
             variants: [],

src/lib/features/context/context-field-store.ts

@@ -50,7 +50,7 @@ const mapRow = (row: ContextFieldDB): IContextField => ({
 
 interface ICreateContextField {
     name: string;
-    description: string;
+    description?: string | null;
     stickiness: boolean;
     sort_order: number;
     legal_values?: string;
@@ -80,8 +80,8 @@ class ContextFieldStore implements IContextFieldStore {
         return {
             name: data.name,
             description: data.description,
-            stickiness: data.stickiness,
-            sort_order: data.sortOrder, // eslint-disable-line
+            stickiness: data.stickiness || false,
+            sort_order: data.sortOrder || 0,
             legal_values: JSON.stringify(data.legalValues || []),
         };
     }

src/lib/features/context/context-service.ts

@@ -21,7 +21,7 @@ import {
 import type { IPrivateProjectChecker } from '../private-project/privateProjectCheckerType';
 import type EventService from '../events/event-service';
 import { contextSchema, legalValueSchema } from '../../services/context-schema';
-import { NameExistsError } from '../../error';
+import { NameExistsError, NotFoundError } from '../../error';
 import { nameSchema } from '../../schema/feature-schema';
 import type { LegalValueSchema } from '../../openapi';
 
@@ -63,7 +63,13 @@ class ContextService {
     }
 
     async getContextField(name: string): Promise<IContextField> {
-        return this.contextFieldStore.get(name);
+        const field = await this.contextFieldStore.get(name);
+        if (field === undefined) {
+            throw new NotFoundError(
+                `Could not find context field with name ${name}`,
+            );
+        }
+        return field;
     }
 
     async getStrategiesByContextField(
@@ -125,6 +131,11 @@ class ContextService {
         const contextField = await this.contextFieldStore.get(
             updatedContextField.name,
         );
+        if (contextField === undefined) {
+            throw new NotFoundError(
+                `Could not find context field with name: ${updatedContextField.name}`,
+            );
+        }
         const value = await contextSchema.validateAsync(updatedContextField);
 
         await this.contextFieldStore.update(value);
@@ -147,6 +158,11 @@ class ContextService {
         const contextField = await this.contextFieldStore.get(
             contextFieldLegalValue.name,
         );
+        if (contextField === undefined) {
+            throw new NotFoundError(
+                `Context field with name ${contextFieldLegalValue.name} was not found`,
+            );
+        }
         const validatedLegalValue = await legalValueSchema.validateAsync(
             contextFieldLegalValue.legalValue,
         );
@@ -186,6 +202,11 @@ class ContextService {
         const contextField = await this.contextFieldStore.get(
             contextFieldLegalValue.name,
         );
+        if (contextField === undefined) {
+            throw new NotFoundError(
+                `Could not find context field with name ${contextFieldLegalValue.name}`,
+            );
+        }
 
         const newContextField = {
             ...contextField,

src/lib/features/export-import-toggles/export-import-permissions.e2e.test.ts

@@ -262,7 +262,7 @@ beforeAll(async () => {
     contextFieldStore = db.stores.contextFieldStore;
 
     const roles = await accessService.getRootRoles();
-    adminRole = roles.find((role) => role.name === RoleName.ADMIN);
+    adminRole = roles.find((role) => role.name === RoleName.ADMIN)!;
 
     await createUserEditorAccess(
         regularUserName,

src/lib/features/export-import-toggles/export-import-service.ts

@@ -463,7 +463,7 @@ export default class ExportImportService
                 this.contextService.createContextField(
                     {
                         name: contextField.name,
-                        description: contextField.description || '',
+                        description: contextField.description,
                         legalValues: contextField.legalValues,
                         stickiness: contextField.stickiness,
                     },

src/lib/features/export-import-toggles/import-permissions-service.ts

@@ -48,12 +48,14 @@ export class ImportPermissionsService {
     ): Promise<ContextFieldSchema[]> {
         const availableContextFields = await this.contextService.getAll();
 
-        return dto.data.contextFields?.filter(
-            (contextField) =>
-                !availableContextFields.some(
-                    (availableField) =>
-                        availableField.name === contextField.name,
-                ),
+        return (
+            dto.data.contextFields?.filter(
+                (contextField) =>
+                    !availableContextFields.some(
+                        (availableField) =>
+                            availableField.name === contextField.name,
+                    ),
+            ) || []
         );
     }
 

src/lib/features/feature-search/feature-search-store.ts

@@ -253,7 +253,7 @@ class FeatureSearchStore implements IFeatureSearchStore {
 
                 const rankingSql = this.buildRankingSql(
                     favoritesFirst,
-                    sortBy,
+                    sortBy || '',
                     validatedSortOrder,
                     lastSeenQuery,
                 );
@@ -705,12 +705,14 @@ const applyMultiQueryParams = (
     ) => (dbSubQuery: Knex.QueryBuilder) => Knex.QueryBuilder,
 ): void => {
     queryParams.forEach((param) => {
-        const values = param.values.map((val) =>
-            (Array.isArray(fields)
-                ? val.split(/:(.+)/).filter(Boolean)
-                : [val]
-            ).map((s) => s.trim()),
-        );
+        const values = param.values
+            .filter((v) => typeof v === 'string')
+            .map((val) =>
+                (Array.isArray(fields)
+                    ? val!.split(/:(.+)/).filter(Boolean)
+                    : [val]
+                ).map((s) => s.trim()),
+            );
         const baseSubQuery = createBaseQuery(values);
 
         switch (param.operator) {

src/lib/features/feature-toggle/fakes/fake-feature-strategies-store.ts

@@ -67,7 +67,7 @@ export default class FakeFeatureStrategiesStore
         return this.featureStrategies.some((s) => s.id === id);
     }
 
-    async get(id: string): Promise<IFeatureStrategy> {
+    async get(id: string): Promise<IFeatureStrategy | undefined> {
         return this.featureStrategies.find((s) => s.id === id);
     }
 
@@ -180,8 +180,8 @@ export default class FakeFeatureStrategiesStore
         archived: boolean = false,
     ): Promise<IFeatureToggleClient[]> {
         const rows = this.featureToggles.filter((toggle) => {
-            if (featureQuery.namePrefix) {
-                if (featureQuery.project) {
+            if (featureQuery?.namePrefix) {
+                if (featureQuery?.project) {
                     return (
                         (toggle.name.startsWith(featureQuery.namePrefix) &&
                             featureQuery.project.some((project) =>
@@ -192,7 +192,7 @@ export default class FakeFeatureStrategiesStore
                 }
                 return toggle.name.startsWith(featureQuery.namePrefix);
             }
-            if (featureQuery.project) {
+            if (featureQuery?.project) {
                 return (
                     featureQuery.project.some((project) =>
                         project.includes(toggle.project),
@@ -205,7 +205,7 @@ export default class FakeFeatureStrategiesStore
             ...t,
             enabled: true,
             strategies: [],
-            description: t.description || '',
+            description: t.description,
             type: t.type || 'Release',
             stale: t.stale || false,
             variants: [],
@@ -233,7 +233,7 @@ export default class FakeFeatureStrategiesStore
             this.environmentAndFeature.set(environment, []);
         }
         this.environmentAndFeature
-            .get(environment)
+            .get(environment)!
             .push({ feature: feature_name, enabled });
         return Promise.resolve();
     }
@@ -245,7 +245,7 @@ export default class FakeFeatureStrategiesStore
         this.environmentAndFeature.set(
             environment,
             this.environmentAndFeature
-                .get(environment)
+                .get(environment)!
                 .filter((e) => e.featureName !== feature_name),
         );
         return Promise.resolve();
@@ -271,7 +271,9 @@ export default class FakeFeatureStrategiesStore
             }
             return f;
         });
-        return Promise.resolve(this.featureStrategies.find((f) => f.id === id));
+        return Promise.resolve(
+            this.featureStrategies.find((f) => f.id === id)!,
+        );
     }
 
     async deleteConfigurationsForProjectAndEnvironment(

src/lib/features/feature-toggle/fakes/fake-feature-toggle-store.ts

@@ -87,8 +87,11 @@ export default class FakeFeatureToggleStore implements IFeatureToggleStore {
         return this.features.filter((f) => names.includes(f.name));
     }
 
-    async getProjectId(name: string): Promise<string> {
-        return this.get(name).then((f) => f.project);
+    async getProjectId(name: string | undefined): Promise<string | undefined> {
+        if (name === undefined) {
+            return Promise.resolve(undefined);
+        }
+        return Promise.resolve(this.get(name).then((f) => f.project));
     }
 
     private getFilterQuery(query: Partial<IFeatureToggleStoreQuery>) {

src/lib/features/feature-toggle/feature-toggle-store.ts

@@ -44,15 +44,15 @@ const FEATURE_COLUMNS = [
 
 export interface FeaturesTable {
     name: string;
-    description: string;
-    type: string;
-    stale: boolean;
+    description: string | null;
+    type?: string;
+    stale?: boolean | null;
     project: string;
     last_seen_at?: Date;
     created_at?: Date;
-    impression_data: boolean;
+    impression_data?: boolean | null;
     archived?: boolean;
-    archived_at?: Date;
+    archived_at?: Date | null;
     created_by_user_id?: number;
 }
 
@@ -472,13 +472,13 @@ export default class FeatureToggleStore implements IFeatureToggleStore {
     insertToRow(project: string, data: FeatureToggleInsert): FeaturesTable {
         const row = {
             name: data.name,
-            description: data.description,
+            description: data.description || null,
             type: data.type,
             project,
             archived_at: data.archived ? new Date() : null,
-            stale: data.stale,
+            stale: data.stale || false,
             created_at: data.createdAt,
-            impression_data: data.impressionData,
+            impression_data: data.impressionData || false,
             created_by_user_id: data.createdByUserId,
         };
         if (!row.created_at) {
@@ -494,7 +494,7 @@ export default class FeatureToggleStore implements IFeatureToggleStore {
     ): Omit<FeaturesTable, 'created_by_user_id'> {
         const row = {
             name: data.name,
-            description: data.description,
+            description: data.description || null,
             type: data.type,
             project,
             archived_at: data.archived ? new Date() : null,

src/lib/features/feature-toggle/types/feature-toggle-store-type.ts

@@ -23,7 +23,7 @@ export interface IFeatureToggleStore extends Store<FeatureToggle, string> {
 
     setLastSeen(data: LastSeenInput[]): Promise<void>;
 
-    getProjectId(name: string): Promise<string | undefined>;
+    getProjectId(name: string | undefined): Promise<string | undefined>;
 
     create(project: string, data: FeatureToggleInsert): Promise<FeatureToggle>;
 

src/lib/features/project/project-service.e2e.test.ts

@@ -2472,7 +2472,7 @@ test('should not delete project-bound api tokens still bound to project', async
     await projectService.deleteProject(project1, user, auditUser);
     const fetchedToken = await apiTokenService.getToken(token.secret);
     expect(fetchedToken).not.toBeUndefined();
-    expect(fetchedToken.project).toBe(project2);
+    expect(fetchedToken!.project).toBe(project2);
 });
 
 test('should delete project-bound api tokens when all projects they belong to are deleted', async () => {

src/lib/services/api-token-service.ts

@@ -36,7 +36,6 @@ import { FUNCTION_TIME } from '../metric-events';
 import type { ResourceLimitsSchema } from '../openapi';
 import { throwExceedsLimitError } from '../error/exceeds-limit-error';
 import type EventEmitter from 'events';
-import { NotFoundError } from '../error';
 
 const resolveTokenPermissions = (tokenType: string) => {
     if (tokenType === ApiTokenType.ADMIN) {
@@ -128,12 +127,8 @@ export class ApiTokenService {
         }
     }
 
-    async getToken(secret: string): Promise<IApiToken> {
-        const token = await this.store.get(secret);
-        if (token === undefined) {
-            throw new NotFoundError();
-        }
-        return token;
+    async getToken(secret: string): Promise<IApiToken | undefined> {
+        return this.store.get(secret);
     }
 
     async getTokenWithCache(secret: string): Promise<IApiToken | undefined> {