Remove local start_date and end_date base fields and fix existing dates

Open on Drupal.org →

Created on 15 August 2023, 11 months ago

Updated 10 November 2023, 8 months ago

Problem/Motivation

start_date and end_date fields are now defined as BaseFields in the parent entity using a slightly different date format to what is expected. Previously the start and end date was stored as a "datetime" of with "'datetime_type' = 'date'". New basefield setting defined in \Drupal\commerce_promotion\Entity\Coupon uses "datetime" with "'datetime_type' = 'datetime'". At least in MySQL, these formats are stored in the same data-type of VARCHAR(20) so changing it should be a matter of reformatting.

All of the previous code for adding those fields to this version need to be removed, any previously written data updated to the new format.

At present, the start_date and end_date values when loaded do not work predictably when used in a site with the two date fields unexpectedly comparing different data formats eg "2023-08-03 >= 2023-08-03T06:00:00"

Steps to reproduce

Install commerce_coupon_conditions 8.x-1.1 with Commerce 8.x-2.18 or earlier, and then upgrade Commerce to a later version.

Patch with:
🐛 Add restriction a coupon usage for limited per-customer Fixed
✨ Drupal 10 Compatibility Fixed

Proposed resolution

Remove all additional code related to the old fields, and add an update to fix all data.

The update should read each value and convert it from "2023-08-03" to "2023-08-03T00:00:00" or whichever appended time is appropriate. eg "23:59:59" for end_date.
NB: Update to include hook_XXXX_alter to allow custom setting of the date to deal with timezones.

Make a 1.2 release with the changes from the last 2 years.

Remaining tasks

Remove remaining deprecated code
Update which will run after base field state has been cleared from cache, to update all of the field data values
Make new release with these large changes documented

User interface changes

Incidental; Coupon Start/End Date now inherited from parent so UI includes time.

API changes

all *StartDate() and *EndDate() function are now moved to \Drupal\commerce_promotion\Entity\Coupon

Data model changes

Base Fields previously defined in this module are now handled by Commerce Promotion module. Data type in database remains the same.

🐛 Bug report

Status

Fixed

Version

1.0

Component

Code

Created by

🇦🇺Australia ELC

Live updates comments and jobs are added and updated live.

Sign in to follow issues

Comments & Activities

Issue created by @ELC
Open on Drupal.org →
Core: 9.5.x + Environment: PHP 8.0 & MySQL 5.7
last update 11 months ago
Waiting for branch to pass
@elc opened merge request.
Status changed to Needs review 11 months ago5:41am 15 August 2023
Comment 11 months ago →
🇦🇺Australia ELC
In combination with 🐛 Add restriction a coupon usage for limited per-customer Fixed this fixes up the start_date and end_date issues this module was having.
First commit to issue fork.
Open on Drupal.org →
Core: 9.5.x + Environment: PHP 8.0 & MySQL 5.7
last update 8 months ago
Waiting for branch to pass
Comment 8 months ago →
System Message

valic → committed d6f43193 on 8.x-1.x authored by ELC →
Issue #3381127 by ELC: Add update to fix start/end date field data...
Comment 8 months ago →
System Message

valic → committed 3646325b on 8.x-1.x authored by ELC →
Issue #3381127 by ELC: Remove code to un/install start/end date fields.
Comment 8 months ago →
🇭🇷Croatia valic Osijek
We need to have the ability to skip hook_update in some instances. I have a project with 69000 coupons, which are eligible for an update.
Those should not run with hook update directly; deployment would take hours if not days.
Status changed to Active 8 months ago1:46pm 10 November 2023

Comment 8 months ago →

valic → committed 5a83dd6a on 8.x-1.x

Issue #3381127 by ELC, valic: Remove local start_date and end_date base...

Status changed to Fixed 8 months ago1:47pm 10 November 2023
Comment 8 months ago →
🇭🇷Croatia valic Osijek
Adding this line in settings.php is going to skip this update hook processing during updatedb

$settings['commerce_coupon_condition_skip_update_8101'] = TRUE;
Comment 7 months ago →
System Message
Automatically closed - issue fixed for 2 weeks with no activity.

contrib.social Blog FAQ Discussions

Production build 0.69.0 2024