Merge pull request #10907 from NolwennD/10897-handle-null-in-optional

Handle null in TypeScript optional
jhipster · Sep 27, 2024 · 3241db3 · 3241db3
2 parents 3332511 + 8e01c70
commit 3241db3
Show file tree

Hide file tree

Showing 7 changed files with 23 additions and 19 deletions.
diff --git a/...n/resources/generator/typescript/test/webapp/unit/common/domain/optional/Optional.spec.ts b/...n/resources/generator/typescript/test/webapp/unit/common/domain/optional/Optional.spec.ts
@@ -1,4 +1,5 @@
 import { Optional } from '@/common/domain/Optional';
+import { expect, it } from 'vitest';
 
 describe('Optional', () => {
   describe('Empty check', () => {
@@ -106,12 +107,12 @@ describe('Optional', () => {
   });
 
   describe('Of undefinable', () => {
-    it('should get empty optional from undefined value', () => {
-      expect(Optional.ofUndefinable(undefined).isEmpty()).toBe(true);
+    it.each([undefined, null, NaN])('should get empty optional from %s value', value => {
+      expect(Optional.ofNullable(value).isEmpty()).toBe(true);
     });
 
     it('should get valuated optional from actual value', () => {
-      expect(Optional.ofUndefinable('toto').isEmpty()).toBe(false);
+      expect(Optional.ofNullable('toto').isEmpty()).toBe(false);
     });
   });
 

diff --git a/src/main/resources/generator/typescript/webapp/common/domain/optional/Optional.ts b/src/main/resources/generator/typescript/webapp/common/domain/optional/Optional.ts
@@ -1,3 +1,5 @@
+const checkIsNaN = <Value>(value: Value) => typeof value === 'number' && isNaN(value);
+
 export abstract class Optional<Value> {
   public static empty<Value>(): Optional<Value> {
     return new EmptyOptional();
@@ -7,8 +9,8 @@ export abstract class Optional<Value> {
     return new ValuatedOptional(value);
   }
 
-  static ofUndefinable<Value>(value: Value | undefined): Optional<Value> {
-    if (value === undefined) {
+  static ofNullable<Value>(value: Value | undefined): Optional<Value> {
+    if (value === undefined || value === null || checkIsNaN(value)) {
       return Optional.empty();
     }
 

diff --git a/src/main/webapp/app/module/domain/landscape/Landscape.ts b/src/main/webapp/app/module/domain/landscape/Landscape.ts
@@ -97,7 +97,7 @@ export class Landscape {
   private appliedModuleInFeature(module: ModuleSlug): Optional<LandscapeModule> {
     return this.projections
       .getModuleFeature(module)
-      .flatMap(feature => Optional.ofUndefinable(feature.modules.find(featureModule => this.state.isApplied(featureModule.slugString()))));
+      .flatMap(feature => Optional.ofNullable(feature.modules.find(featureModule => this.state.isApplied(featureModule.slugString()))));
   }
 
   private incompatibleSelectedModuleInFeature(module: ModuleSlug): Optional<LandscapeModule> {
@@ -350,7 +350,7 @@ export class Landscape {
   }
 
   private getSelectedModule(feature: LandscapeFeature): Optional<LandscapeModule> {
-    return Optional.ofUndefinable(feature.modules.find(featureModule => this.state.isSelected(featureModule.slug().get())));
+    return Optional.ofNullable(feature.modules.find(featureModule => this.state.isSelected(featureModule.slug().get())));
   }
 
   private moduleIs(slug: ModuleSlug, operation: (module: LandscapeModule) => boolean): boolean {
@@ -370,7 +370,7 @@ export class Landscape {
   }
 
   private getModule(module: ModuleSlug): Optional<LandscapeModule> {
-    return Optional.ofUndefinable(this.modules.get(module.get()));
+    return Optional.ofNullable(this.modules.get(module.get()));
   }
 
   public noNotAppliedSelectedModule(): boolean {
@@ -523,14 +523,14 @@ class LevelsProjections {
   }
 
   public getStandaloneModule(module: ModuleId): Optional<LandscapeModule> {
-    return Optional.ofUndefinable(this.standaloneModules.get(module));
+    return Optional.ofNullable(this.standaloneModules.get(module));
   }
 
   public getFeature(feature: LandscapeFeatureSlug): Optional<LandscapeFeature> {
-    return Optional.ofUndefinable(this.features.get(feature.get()));
+    return Optional.ofNullable(this.features.get(feature.get()));
   }
 
   public getModuleFeature(module: ModuleSlug) {
-    return Optional.ofUndefinable(this.moduleFeatures.get(module.get()));
+    return Optional.ofNullable(this.moduleFeatures.get(module.get()));
   }
 }
diff --git a/src/main/webapp/app/module/domain/landscape/LandscapeSelectionTree.ts b/src/main/webapp/app/module/domain/landscape/LandscapeSelectionTree.ts
@@ -16,6 +16,6 @@ export class LandscapeSelectionTree {
   }
 
   public find(element: LandscapeElementId): Optional<LandscapeSelectionElement> {
-    return Optional.ofUndefinable(this.elements.find(selectionElement => selectionElement.slug.get() === element.get()));
+    return Optional.ofNullable(this.elements.find(selectionElement => selectionElement.slug.get() === element.get()));
   }
 }
diff --git a/src/main/webapp/app/module/secondary/RestModulesRepository.ts b/src/main/webapp/app/module/secondary/RestModulesRepository.ts
@@ -62,7 +62,7 @@ export class RestModulesRepository implements ModulesRepository {
 }
 
 const mapToProject = (response: AxiosResponse<ArrayBuffer>): Project => ({
-  filename: Optional.ofUndefinable(response.headers['x-suggested-filename']).orElseThrow(
+  filename: Optional.ofNullable(response.headers['x-suggested-filename']).orElseThrow(
     () => new Error('Impossible to download file without filename'),
   ),
   content: response.data,

diff --git a/src/main/webapp/app/shared/optional/domain/Optional.ts b/src/main/webapp/app/shared/optional/domain/Optional.ts
@@ -1,3 +1,5 @@
+const checkIsNaN = <Value>(value: Value) => typeof value === 'number' && isNaN(value);
+
 export abstract class Optional<Value> {
   public static empty<Value>(): Optional<Value> {
     return new EmptyOptional();
@@ -7,11 +9,10 @@ export abstract class Optional<Value> {
     return new ValuatedOptional(value);
   }
 
-  static ofUndefinable<Value>(value: Value | undefined): Optional<Value> {
-    if (value === undefined) {
+  static ofNullable<Value>(value: Value | undefined | null): Optional<Value> {
+    if (value === undefined || value === null || checkIsNaN(value)) {
       return Optional.empty();
     }
-
     return Optional.of(value);
   }
 

diff --git a/src/test/webapp/unit/shared/optional/domain/Optional.spec.ts b/src/test/webapp/unit/shared/optional/domain/Optional.spec.ts
@@ -110,12 +110,12 @@ describe('Optional', () => {
   });
 
   describe('Of undefinable', () => {
-    it('should get empty optional from undefined value', () => {
-      expect(Optional.ofUndefinable(undefined).isEmpty()).toBe(true);
+    it.each([undefined, null, NaN])('should get empty optional from %s value', value => {
+      expect(Optional.ofNullable(value).isEmpty()).toBe(true);
     });
 
     it('should get valuated optional from actual value', () => {
-      expect(Optional.ofUndefinable('toto').isEmpty()).toBe(false);
+      expect(Optional.ofNullable('toto').isEmpty()).toBe(false);
     });
   });