Max min values #1396

Rakesh-Ranga-Buram · 2024-11-27T13:12:09Z

Description

This code is related to the create and edit unit changes to incorporate the max and min value checks, and also the changes to make the max and min value associated with the unit to reflect when unit is selected on meter(both create and edit).

Partly Addresses #1307

(In general, OED likes to have at least one issue associated with each pull request. Replace [issue] with the OED GitHub issue number. In the preview you will see an issue description if you hover over that number. You can create one yourself before doing this pull request. This is where details are normally given on what is being addressed. Note you should not use the word "Fixes" if it does not completely address the issue since the issue would automatically be closed on merging the pull request. In that case use "Partly Addresses #[issue].)

Type of change

(Check the ones that apply by placing an "x" instead of the space in the [ ] so it becomes [x])

Note merging this changes the database configuration.
This change requires a documentation update

Checklist

(Note what you have done by placing an "x" instead of the space in the [ ] so it becomes [x]. It is hoped you do all of them.)

I have followed the OED pull request ideas
I have removed text in ( ) from the issue request
You acknowledge that every person contributing to this work has signed the OED Contributing License Agreement and each author is listed in the Description section.

Limitations

The work related to the trinary changes related to disable checks is still pending

create unit changes

edit unit changes

huss

Thanks to @lawsj, @mmehta2669 & @Rakesh-Ranga-Buram for working on this issue. Review and testing found it generally works but I have made several comments where issues where found. One comment that could not be easily placed into the code was:

src/server/util/compareUnits.js needs to have expectUnitToBeEquivalent updated to test min/max. src/server/test/db/unitTests.js & src/server/test/web/unitsTest.js need to be updated so it properly tests these values (and not just default values for all of them).

Please let me know if anything is not clear or you have thoughts.

huss · 2024-11-28T15:37:59Z

src/client/app/components/unit/CreateUnitModalComponent.tsx

+								min={MIN_VAL}
+								max={state.maxVal}
+								defaultValue={state.minVal}
+								invalid={state?.minVal < MIN_VAL || state?.minVal > state?.maxVal} />


This invalid check conditions should be added to validUnit setting so the save is disabled as done for other checks.

huss · 2024-11-28T15:43:20Z

src/client/app/components/unit/CreateUnitModalComponent.tsx

@@ -267,6 +270,34 @@ export default function CreateUnitModalComponent() {
 							</FormFeedback>
 						</FormGroup></Col>
 					</Row>
+					<Row xs='1' lg='2'>


The min/max exist on create/edit unit pages but not in UnitsDetailComponent.tsx. I think that is fine but the "Edit Unit" button on that page should become "Details/Edit Unit" to mirror meter where it both shows more info and allows editing. I could not put a comment in that file so doing here.

huss · 2024-11-28T15:51:18Z

src/server/models/Unit.js

@@ -19,7 +19,7 @@ class Unit {
 	 * @param {*} preferredDisplay True if this unit is always displayed. If not, the user needs to ask to see (for future enhancement).
 	 * @param {*} note Note about this unit.
 	 */
-	constructor(id, name, identifier = name, unitRepresent, secInRate = 3600, typeOfUnit, suffix = '', displayable, preferredDisplay, note) {
+	constructor(id, name, identifier = name, unitRepresent, secInRate = 3600, typeOfUnit, suffix = '', displayable, preferredDisplay, note, minVal, maxVal) {


This changed the signature of the unit constructor. There are a number of places where new Unit(...) is done but was not updated. The value of min/maxVal is undefined in these cases and that is causing issues. For example, I believe that is why a number of tests are failing. The two options are:

Give the two new parameters default values of the min/max on the create page. I think this would be okay in this case.

Change all the calls to have the desired min/max value. This is a little safer but since I think (almost) all cases that would be changed the min/max would not matter the default would be used. Given this, either solution can be used.

I tested doing this and it fixed the failing tests after other fixes applied. On my machine without the change all the tests seem to run so I'm unsure why only 14 ran on GitHub for the PR. Hopefully that will go away but needs to be verified (or addressed if still an issue).

huss · 2024-11-28T16:12:26Z

src/server/util/insertData.js

@@ -427,8 +427,8 @@ async function insertMeters(metersToInsert, conn) {
 					await conn.none(query);
 				}
 				const conditionSet = {
-					minVal: meter.minVal,
-					maxVal: meter.maxVal,
+					minVal: minVal,


I'm not sure what this is supposed to be but minVal & maxVal variables are not defined.

huss · 2024-11-28T16:23:57Z

src/server/services/csvPipeline/uploadReadings.js

@@ -189,8 +189,8 @@ async function uploadReadings(req, res, filepath, conn) {
 	const mapRowToModel = row => { return row; }; // STUB function to satisfy the parameter of loadCsvInput.

 	const conditionSet = {
-		minVal: meter.minVal,
-		maxVal: meter.maxVal,
+		minVal: minVal,


See other comment. minVal & maxVal are undefined.

huss · 2024-11-28T17:23:29Z

src/server/models/Unit.js

@@ -19,7 +19,7 @@ class Unit {
 	 * @param {*} preferredDisplay True if this unit is always displayed. If not, the user needs to ask to see (for future enhancement).
 	 * @param {*} note Note about this unit.


The JSDoc needs to be updated.

huss · 2024-11-28T17:28:02Z

src/client/app/utils/input.ts

@@ -82,7 +82,9 @@ export const NoUnit: UnitData = {
 	suffix: '',
 	displayable: DisplayableType.none,
 	preferredDisplay: false,
-	note: ''
+	note: '',
+	minVal: -Infinity,


Other places use adminSelectors to get the max/min allowed. I think it makes sense to do that here if possible. My only concern is this is outside a React component but it may work fine since not altering a value.

huss · 2024-11-28T17:28:36Z

src/client/app/types/redux/units.ts

-	preferredDisplay: boolean;
-	note: string;
-}
+// export interface UnitEditData {


Since this interface seems not to be used it should be removed rather than commented out.

huss · 2024-11-28T17:29:22Z

src/client/app/translations/data.ts

@@ -339,8 +339,8 @@ const LocaleTranslationData = {
 		"meter.enabled": "Updates:",
 		"meter.endOnlyTime": "Only End Times:",
 		"meter.endTimeStamp": "End Time Stamp:",
-		"meter.minVal": "Minimum Reading Value Check",
-		"meter.maxVal": "Maximum Reading Value Check",
+		"minVal": "Minimum Reading Value Check",


This should be placed alphabetically in all languages. Also, it does not follow the key naming conventions. I know the old value was something similar to this but lets use min.value. Similar for max.

huss · 2024-11-28T17:38:02Z

src/client/app/components/meters/EditMeterModalComponent.tsx

@@ -67,6 +67,17 @@ export default function EditMeterModalComponent(props: EditMeterModalComponentPr

 	const [validMeter, setValidMeter] = useState(isValidMeter(localMeterEdits));

+	useEffect(() => {


I'm unclear on the relationship of this useEffect and handleUnitChange. They seem to do similar work. I tried commenting this out and it did not seem to matter. It is not in create unit. I may be missing something so let me know.

Also, a comment on what this is doing would be nice. For example, it is getting the min/max reading value from the unit to make that the starting value for the meter when a unit is selected.

Disable changes

mmehta2669 and others added 5 commits November 25, 2024 19:59

create unit changes

92afc55

edit unit changes

8953030

Merge pull request #32 from oss-slu/create_unit_1307

4edc46d

create unit changes

Merge pull request #33 from oss-slu/edit_unit_1307

c29b70c

edit unit changes

adding coulumns to the units table

a9380c9

huss requested changes Nov 28, 2024

View reviewed changes

Rakesh-Ranga-Buram and others added 2 commits December 4, 2024 20:52

Disable changes

e72f18e

Merge pull request #34 from oss-slu/Rakesh_disable_changes

fb0b593

Disable changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Max min values #1396

Max min values #1396

Rakesh-Ranga-Buram commented Nov 27, 2024

huss left a comment

huss Nov 28, 2024

huss Nov 28, 2024

huss Nov 28, 2024

huss Nov 28, 2024

huss Nov 28, 2024

huss Nov 28, 2024

huss Nov 28, 2024

huss Nov 28, 2024

huss Nov 28, 2024

huss Nov 28, 2024

		@@ -19,7 +19,7 @@ class Unit {
		* @param {*} preferredDisplay True if this unit is always displayed. If not, the user needs to ask to see (for future enhancement).
		* @param {*} note Note about this unit.

		@@ -67,6 +67,17 @@ export default function EditMeterModalComponent(props: EditMeterModalComponentPr

		const [validMeter, setValidMeter] = useState(isValidMeter(localMeterEdits));

		useEffect(() => {

Max min values #1396

Are you sure you want to change the base?

Max min values #1396

Conversation

Rakesh-Ranga-Buram commented Nov 27, 2024

Description

Type of change

Checklist

Limitations

huss left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment