fix: make it compile with strictNullChecks set to true like in our config file

Author: chriswk

package.json

@@ -35,21 +35,21 @@
   "scripts": {
     "start": "TZ=UTC node ./dist/server.js",
     "copy-templates": "copyfiles -u 1 src/mailtemplates/**/* dist/",
-    "build:backend": "tsc --pretty --strictNullChecks false",
+    "build:backend": "tsc --pretty",
     "build:frontend": "yarn --cwd ./frontend run build",
     "build:frontend:if-needed": "./scripts/build-frontend-if-needed.sh",
     "build": "yarn run clean && concurrently \"yarn:copy-templates\" \"yarn:build:frontend\" \"yarn:build:backend\"",
-    "dev:backend": "TZ=UTC NODE_ENV=development tsc-watch --strictNullChecks false --onSuccess \"node dist/server-dev.js\"",
+    "dev:backend": "TZ=UTC NODE_ENV=development tsc-watch --onSuccess \"node dist/server-dev.js\"",
     "dev:frontend": "wait-on tcp:4242 && yarn --cwd ./frontend run dev",
     "dev:frontend:cloud": "UNLEASH_BASE_PATH=/demo/ yarn run dev:frontend",
     "dev": "concurrently \"yarn:dev:backend\" \"yarn:dev:frontend\"",
     "prepare:backend": "concurrently \"yarn:copy-templates\" \"yarn:build:backend\"",
-    "start:dev": "yarn run clean && TZ=UTC NODE_ENV=development tsc-watch --strictNullChecks false --onSuccess \"node dist/server-dev.js\"",
+    "start:dev": "yarn run clean && TZ=UTC NODE_ENV=development tsc-watch --onSuccess \"node dist/server-dev.js\"",
     "db-migrate": "db-migrate --migrations-dir ./src/migrations",
     "lint": "biome check .",
     "lint:fix": "biome check . --write",
     "local:package": "del-cli --force build && mkdir build && cp -r dist docs CHANGELOG.md LICENSE README.md package.json build",
-    "build:watch": "yarn run clean && tsc -w --strictNullChecks false",
+    "build:watch": "tsc -w",
     "prepare": "husky && yarn --cwd ./frontend install && if [ ! -d ./dist ]; then yarn build; fi",
     "test": "NODE_ENV=test PORT=4243 node --trace-warnings node_modules/.bin/jest",
     "test:unit": "NODE_ENV=test PORT=4243 jest --testPathIgnorePatterns=src/test/e2e --testPathIgnorePatterns=dist",
@@ -60,7 +60,7 @@
     "test:coverage": "NODE_ENV=test PORT=4243 jest --coverage --testLocationInResults --outputFile=\"coverage/report.json\" --forceExit",
     "test:coverage:jest": "NODE_ENV=test PORT=4243 jest --silent --ci --json --coverage --testLocationInResults --outputFile=\"report.json\" --forceExit",
     "test:updateSnapshot": "NODE_ENV=test PORT=4243 jest --updateSnapshot",
-    "seed:setup": "ts-node --compilerOptions '{\"strictNullChecks\": false}' src/test/e2e/seed/segment.seed.ts",
+    "seed:setup": "ts-node src/test/e2e/seed/segment.seed.ts",
     "seed:serve": "UNLEASH_DATABASE_NAME=unleash_test UNLEASH_DATABASE_SCHEMA=seed yarn run start:dev",
     "clean": "del-cli --force dist",
     "heroku-postbuild": "cd frontend && yarn && yarn build",
@@ -220,7 +220,7 @@
     "supertest": "7.0.0",
     "ts-node": "10.9.2",
     "tsc-watch": "6.2.1",
-    "typescript": "5.4.5",
+    "typescript": "5.8.2",
     "wait-on": "^7.2.0"
   },
   "resolutions": {

src/lib/addons/datadog.ts

@@ -32,7 +32,7 @@ interface DDRequestBody {
 export default class DatadogAddon extends Addon {
     private msgFormatter: FeatureEventFormatter;
 
-    flagResolver: IFlagResolver;
+    declare flagResolver: IFlagResolver;
 
     constructor(config: IAddonConfig) {
         super(definition, config);

src/lib/addons/new-relic.ts

@@ -39,7 +39,7 @@ interface INewRelicRequestBody {
 export default class NewRelicAddon extends Addon {
     private msgFormatter: FeatureEventFormatter;
 
-    flagResolver: IFlagResolver;
+    declare flagResolver: IFlagResolver;
 
     constructor(config: IAddonConfig) {
         super(definition, config);

src/lib/addons/slack-app.ts

@@ -34,7 +34,7 @@ interface ISlackAppAddonParameters {
 export default class SlackAppAddon extends Addon {
     private msgFormatter: FeatureEventFormatter;
 
-    flagResolver: IFlagResolver;
+    declare flagResolver: IFlagResolver;
 
     private accessToken?: string;
 

src/lib/addons/slack.ts

@@ -25,7 +25,7 @@ interface ISlackAddonParameters {
 export default class SlackAddon extends Addon {
     private msgFormatter: FeatureEventFormatter;
 
-    flagResolver: IFlagResolver;
+    declare flagResolver: IFlagResolver;
 
     constructor(args: IAddonConfig) {
         super(slackDefinition, args);

src/lib/addons/teams.ts

@@ -38,7 +38,7 @@ interface ITeamsParameters {
 export default class TeamsAddon extends Addon {
     private msgFormatter: FeatureEventFormatter;
 
-    flagResolver: IFlagResolver;
+    declare flagResolver: IFlagResolver;
 
     constructor(args: IAddonConfig) {
         if (args.flagResolver.isEnabled('teamsIntegrationChangeRequests')) {

src/lib/addons/webhook.ts

@@ -25,7 +25,7 @@ interface IParameters {
 export default class Webhook extends Addon {
     private msgFormatter: FeatureEventFormatter;
 
-    flagResolver: IFlagResolver;
+    declare flagResolver: IFlagResolver;
 
     constructor(args: IAddonConfig) {
         super(definition, args);

src/lib/app.test.ts

@@ -18,10 +18,10 @@ jest.mock(
         },
 );
 
-const getApp = require('./app').default;
-
+import getApp from './app';
 test('should not throw when valid config', async () => {
     const config = createTestConfig();
+    // @ts-expect-error - We're passing in empty stores and services
     const app = await getApp(config, {}, {});
     expect(typeof app.listen).toBe('function');
 });
@@ -33,6 +33,7 @@ test('should call preHook', async () => {
             called++;
         },
     });
+    // @ts-expect-error - We're passing in empty stores and services
     await getApp(config, {}, {});
     expect(called).toBe(1);
 });
@@ -44,6 +45,7 @@ test('should call preRouterHook', async () => {
             called++;
         },
     });
+    // @ts-expect-error - We're passing in empty stores and services
     await getApp(config, {}, {});
     expect(called).toBe(1);
 });
@@ -82,6 +84,7 @@ describe('compression middleware', () => {
                     disableCompression: disableCompression as any,
                 },
             });
+            // @ts-expect-error - We're passing in empty stores and services
             await getApp(config, {}, {});
             expect(compression).toBeCalledTimes(+expectCompressionEnabled);
         },

src/lib/app.ts

@@ -195,6 +195,7 @@ export default async function getApp(
     }
 
     // Setup API routes
+    // @ts-expect-error - our db is possibly undefined and our indexrouter doesn't currently handle that
     app.use(`${baseUriPath}/`, new IndexRouter(config, services, db).router);
 
     if (process.env.NODE_ENV !== 'production') {

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/db/client-instance-store.ts

@@ -7,9 +7,8 @@ import type {
 } from '../types/stores/client-instance-store';
 import { subDays } from 'date-fns';
 import type { Db } from './db';
-
-const metricsHelper = require('../util/metrics-helper');
-const { DB_TIME } = require('../metric-events');
+import metricsHelper from '../util/metrics-helper';
+import { DB_TIME } from '../metric-events';
 
 const COLUMNS = [
     'app_name',

src/lib/db/public-signup-token-store.ts

@@ -153,6 +153,7 @@ export class PublicSignupTokenStore implements IPublicSignupTokenStore {
         newToken: IPublicSignupTokenCreate,
     ): Promise<PublicSignupTokenSchema> {
         const response = await this.db<ITokenRow>(TABLE).insert(
+            // @ts-expect-error - knex expects us to return a DbRecordArr<OurType>, we return OurType, which works fine.
             toRow(newToken),
             ['secret'],
         );

src/lib/db/user-feedback-store.ts

@@ -25,7 +25,7 @@ const fieldToRow = (fields: IUserFeedback): IUserFeedbackTable => ({
 });
 
 const rowToField = (row: IUserFeedbackTable): IUserFeedback => ({
-    neverShow: row.nevershow,
+    neverShow: row.nevershow || false,
     feedbackId: row.feedback_id,
     given: row.given,
     userId: row.user_id,
@@ -71,7 +71,7 @@ export default class UserFeedbackStore implements IUserFeedbackStore {
             .merge()
             .returning(COLUMNS);
 
-        return rowToField(insertedFeedback[0]);
+        return rowToField(insertedFeedback[0] as IUserFeedbackTable);
     }
 
     async delete({ userId, feedbackId }: IUserFeedbackKey): Promise<void> {

src/lib/db/user-splash-store.ts

@@ -23,7 +23,7 @@ const fieldToRow = (fields: IUserSplash): IUserSplashTable => ({
 });
 
 const rowToField = (row: IUserSplashTable): IUserSplash => ({
-    seen: row.seen,
+    seen: row.seen || false,
     splashId: row.splash_id,
     userId: row.user_id,
 });
@@ -65,7 +65,7 @@ export default class UserSplashStore implements IUserSplashStore {
             .merge()
             .returning(COLUMNS);
 
-        return rowToField(insertedSplash[0]);
+        return rowToField(insertedSplash[0] as IUserSplashTable);
     }
 
     async delete({ userId, splashId }: IUserSplashKey): Promise<void> {

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;
 
         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,
+                    ),
+            ) || []
         );
     }