-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
fix: Invalid Date Display in Table Widget's Date Column When Using Un…
…ix Timestamp (ms) (#36455) ## Description **Problem** When populating a table widget with data that includes dates in Unix timestamp (milliseconds) format, setting the column type to "Date," the input format to "Unix timestamp (ms)," and selecting a display format leads to an issue during inline editing. While the date picker behaves correctly, selecting a new date results in the table cell showing an "Invalid Date" error. **Root Cause** The platform currently uses DateInputFormat.MILLISECONDS for Unix timestamp (ms) formatting. However, this value is not a valid option for the moment.format() function, which expects the input format to be 'x' for Unix timestamps in milliseconds. This mismatch leads to the "Invalid Date" error. **Solution** Modify the logic to map DateInputFormat.MILLISECONDS to the correct moment format string 'x'. Adjust the table's transformDataPureFn to correctly process and display dates in Unix timestamp (ms) format after inline edits, ensuring the moment library can handle the input properly. **Outcome** This fix ensures that when a user selects a date via the date picker in inline editing mode, the selected date is displayed correctly in the table without any errors. Fixes #35631, #25081 ## Automation /ok-to-test tags="@tag.Sanity, @tag.Binding, @tag.Table, @tag.Datepicker" ### 🔍 Cypress test results <!-- This is an auto-generated comment: Cypress test results --> > [!TIP] > 🟢 🟢 🟢 All cypress tests have passed! 🎉 🎉 🎉 > Workflow run: <https://github.com/appsmithorg/appsmith/actions/runs/11101758400> > Commit: 6a3cae7 > <a href="https://internal.appsmith.com/app/cypress-dashboard/rundetails-65890b3c81d7400d08fa9ee5?branch=master&workflowId=11101758400&attempt=1" target="_blank">Cypress dashboard</a>. > Tags: `@tag.Sanity, @tag.Binding, @tag.Table, @tag.Datepicker` > Spec: > <hr>Mon, 30 Sep 2024 08:54:58 UTC <!-- end of auto-generated comment: Cypress test results --> ## Communication Should the DevRel and Marketing teams inform users about this change? - [ ] Yes - [ ] No <!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit ## Summary by CodeRabbit - **New Features** - Enhanced date column editing in table widgets to accept Unix timestamps in milliseconds without errors. - Introduced a new enumeration for improved date formatting options. - Added mock data structures for testing various date formats and transformations in the table widget. - New method for generating formatted date strings for tomorrow in both verbose and ISO formats. - **Bug Fixes** - Improved validation logic for date inputs in the table, ensuring proper handling of different date formats. - **Tests** - Added new test cases to validate date handling and input formats in the table widget. - Introduced a new test suite for transforming table data based on specified column metadata. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
- Loading branch information
1 parent
43b675e
commit 6f27959
Showing
8 changed files
with
440 additions
and
8 deletions.
There are no files selected for viewing
149 changes: 149 additions & 0 deletions
149
...nt/cypress/e2e/Regression/ClientSide/Widgets/TableV2/Date_column_types_validation_spec.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,149 @@ | ||
import { tableDateColumnTypes } from "../../../../../fixtures/tableDateColumnTypes"; | ||
import { | ||
agHelper, | ||
entityExplorer, | ||
propPane, | ||
table, | ||
} from "../../../../../support/Objects/ObjectsCore"; | ||
|
||
import EditorNavigation, { | ||
EntityType, | ||
} from "../../../../../support/Pages/EditorNavigation"; | ||
|
||
describe( | ||
"Table widget date column type validation", | ||
{ tags: ["@tag.Widget", "@tag.Table"] }, | ||
() => { | ||
before(() => { | ||
entityExplorer.DragNDropWidget("tablewidgetv2", 350, 500); | ||
EditorNavigation.SelectEntityByName("Table1", EntityType.Widget); | ||
propPane.ToggleJSMode("Table data", true); | ||
propPane.UpdatePropertyFieldValue("Table data", tableDateColumnTypes); | ||
table.EditColumn("unixs", "v2"); | ||
}); | ||
|
||
beforeEach(() => { | ||
propPane.NavigateBackToPropertyPane(false); | ||
}); | ||
|
||
const setEditableDateFormats = (format: string) => { | ||
// Update date format property | ||
propPane.ToggleJSMode("Date format", true); | ||
propPane.UpdatePropertyFieldValue("Date format", format); | ||
|
||
// Update display format property | ||
propPane.ToggleJSMode("Display format", true); | ||
propPane.UpdatePropertyFieldValue("Display format", "YYYY-MM-DD"); | ||
|
||
// Toggle editable | ||
propPane.TogglePropertyState("Editable", "On"); | ||
}; | ||
|
||
const clickAndValidateDateCell = (row: number, column: number) => { | ||
// Click unix cell edit | ||
table.ClickOnEditIcon(row, column); | ||
|
||
// Click on specific date within | ||
agHelper.GetNClick( | ||
`${table._dateInputPopover} [aria-label='${table.getFormattedTomorrowDates().verboseFormat}']`, | ||
); | ||
|
||
// Check that date is set in column | ||
table | ||
.ReadTableRowColumnData(row, column, "v2") | ||
.then((val) => | ||
expect(val).to.equal(table.getFormattedTomorrowDates().isoFormat), | ||
); | ||
}; | ||
|
||
it("1. should allow inline editing of Unix Timestamp in seconds (unix/s)", () => { | ||
table.ChangeColumnType("unixs", "Date"); | ||
setEditableDateFormats("Epoch"); | ||
clickAndValidateDateCell(0, 0); | ||
}); | ||
|
||
it("2. should allow inline editing of Unix Timestamp in milliseconds (unix/ms)", () => { | ||
table.ChangeColumnType("unixms", "Date"); | ||
setEditableDateFormats("Milliseconds"); | ||
clickAndValidateDateCell(0, 1); | ||
}); | ||
|
||
it("3. should allow inline editing of date in YYYY-MM-DD format", () => { | ||
table.EditColumn("yyyymmdd", "v2"); | ||
setEditableDateFormats("YYYY-MM-DD"); | ||
clickAndValidateDateCell(0, 2); | ||
}); | ||
|
||
it("4. should allow inline editing of date in YYYY-MM-DD HH:mm format", () => { | ||
table.EditColumn("yyyymmddhhmm", "v2"); | ||
setEditableDateFormats("YYYY-MM-DD HH:mm"); | ||
clickAndValidateDateCell(0, 3); | ||
}); | ||
|
||
it("5. should allow inline editing of date in ISO 8601 format (YYYY-MM-DDTHH:mm:ss)", () => { | ||
table.EditColumn("iso8601", "v2"); | ||
setEditableDateFormats("YYYY-MM-DDTHH:mm:ss"); | ||
clickAndValidateDateCell(0, 4); | ||
}); | ||
|
||
it("6. should allow inline editing of date in YYYY-MM-DD HH:mm format", () => { | ||
table.EditColumn("yyyymmddTHHmmss", "v2"); | ||
setEditableDateFormats("YYYY-MM-DD HH:mm"); | ||
clickAndValidateDateCell(0, 5); | ||
}); | ||
|
||
it("7. should allow inline editing of date in 'do MMM yyyy' format", () => { | ||
table.ChangeColumnType("yyyymmddhhmmss", "Date"); | ||
setEditableDateFormats("YYYY-MM-DDTHH:mm:ss"); | ||
clickAndValidateDateCell(0, 6); | ||
}); | ||
|
||
it("8. should allow inline editing of date in DD/MM/YYYY format", () => { | ||
table.ChangeColumnType("doMMMyyyy", "Date"); | ||
setEditableDateFormats("Do MMM YYYY"); | ||
clickAndValidateDateCell(0, 7); | ||
}); | ||
|
||
it("9. should allow inline editing of date in DD/MM/YYYY HH:mm format", () => { | ||
table.EditColumn("ddmmyyyy", "v2"); | ||
setEditableDateFormats("DD/MM/YYYY"); | ||
clickAndValidateDateCell(0, 8); | ||
}); | ||
|
||
it("10. should allow inline editing of date in LLL (Month Day, Year Time) format", () => { | ||
table.EditColumn("ddmmyyyyhhmm", "v2"); | ||
setEditableDateFormats("DD/MM/YYYY HH:mm"); | ||
clickAndValidateDateCell(0, 9); | ||
}); | ||
|
||
it("11. should allow inline editing of date in LL (Month Day, Year) format", () => { | ||
table.EditColumn("lll", "v2"); | ||
setEditableDateFormats("LLL"); | ||
clickAndValidateDateCell(0, 10); | ||
}); | ||
|
||
it("12. should allow inline editing of date in 'D MMMM, YYYY' format", () => { | ||
table.EditColumn("ll", "v2"); | ||
setEditableDateFormats("LL"); | ||
clickAndValidateDateCell(0, 11); | ||
}); | ||
|
||
it("13. should allow inline editing of date in 'h:mm A D MMMM, YYYY' format", () => { | ||
table.EditColumn("dmmmmyyyy", "v2"); | ||
setEditableDateFormats("D MMMM, YYYY"); | ||
clickAndValidateDateCell(0, 12); | ||
}); | ||
|
||
it("14. should allow inline editing of date in MM-DD-YYYY format", () => { | ||
table.EditColumn("hmmAdmmmmyyyy", "v2"); | ||
setEditableDateFormats("H:mm A D MMMM, YYYY"); | ||
clickAndValidateDateCell(0, 13); | ||
}); | ||
|
||
it("15. should allow inline editing of date in DD-MM-YYYY format", () => { | ||
table.EditColumn("mm1dd1yyyy", "v2"); | ||
setEditableDateFormats("MM-DD-YYYY"); | ||
clickAndValidateDateCell(0, 14); | ||
}); | ||
}, | ||
); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
export const tableDateColumnTypes = ` | ||
{{ | ||
[ | ||
{ | ||
"unixs": 1727212200, | ||
"unixms": 1727212200000, | ||
"yyyymmdd": "2024-09-25", | ||
"yyyymmddhhmm": "2024-09-25 14:30", | ||
iso8601: "2024-09-25T14:30:00.000Z", | ||
"yyyymmddTHHmmss": "2024-09-25T14:30:00", | ||
"yyyymmddhhmmss": "2024-09-25 02:30:00", | ||
"doMMMyyyy": "25th Sep 2024", | ||
"ddmmyyyy": "25/09/2024", | ||
"ddmmyyyyhhmm": "25/09/2024 14:30", | ||
lll: "September 25, 2024 2:30 PM", | ||
ll: "September 25, 2024", | ||
"dmmmmyyyy": "25 September, 2024", | ||
"hmmAdmmmmyyyy": "2:30 PM 25 September, 2024", | ||
"mm1dd1yyyy": "09-25-2024", | ||
"dd1mm1yyyy": "25-09-2024", | ||
"ddimmiyy": "25/09/24", | ||
"mmddyy": "09/25/24", | ||
}, | ||
] | ||
}} | ||
`; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
54 changes: 54 additions & 0 deletions
54
app/client/src/widgets/TableWidgetV2/widget/reactTableUtils/TransformDataPureFn.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,54 @@ | ||
import type { ReactTableColumnProps } from "widgets/TableWidgetV2/component/Constants"; | ||
import { | ||
columns, | ||
columnsNonDate, | ||
expectedDataNonDate, | ||
tableDataNonDate, | ||
} from "./fixtures"; | ||
import { transformDataPureFn } from "./transformDataPureFn"; | ||
|
||
describe("transformDataPureFn", () => { | ||
it("should handle invalid date values", () => { | ||
const invalidTableData = [ | ||
{ | ||
epoch: "invalid_epoch", | ||
milliseconds: "invalid_milliseconds", | ||
iso_8601: "invalid_iso_8601", | ||
yyyy_mm_dd: "invalid_date", | ||
lll: "invalid_date", | ||
}, | ||
]; | ||
|
||
const expectedInvalidData = [ | ||
{ | ||
epoch: "Invalid date", | ||
milliseconds: "Invalid date", | ||
iso_8601: "8601-01-01", | ||
yyyy_mm_dd: "Invalid date", | ||
lll: "Invalid date", | ||
}, | ||
]; | ||
|
||
const result = transformDataPureFn( | ||
invalidTableData, | ||
columns as ReactTableColumnProps[], | ||
); | ||
|
||
expect(result).toEqual(expectedInvalidData); | ||
}); | ||
|
||
it("should return an empty array when tableData is empty", () => { | ||
const result = transformDataPureFn([], columns as ReactTableColumnProps[]); | ||
|
||
expect(result).toEqual([]); | ||
}); | ||
|
||
it("should not transform non-date data", () => { | ||
const result = transformDataPureFn( | ||
tableDataNonDate, | ||
columnsNonDate as ReactTableColumnProps[], | ||
); | ||
|
||
expect(result).toEqual(expectedDataNonDate); | ||
}); | ||
}); |
Oops, something went wrong.