App Configuration: recurring time window filter #40093

ivywei0125 · 2024-05-09T12:54:33Z

Add "Recurrence" parameter for TimeWindowFilter using Outlook-style schema:
https://learn.microsoft.com/en-us/graph/outlook-schedule-recurring-events#using-patterns-and-ranges-to-create-recurring-events

Example:

feature-management:
  feature-flags:
    feature-v:
      enabled-for:
        -
         name: TimeWindowFilter
          parameters:
            start: "Fri, 22 Mar 2024 20:00:00 GMT",
            end: "Mon, 01 July 2019 00:00:00 GMT",
            recurrence:
              pattern:
                type: "Daily",
                interval: 1
              range:
                type: "NoEnd"

The main logic of how to check whether current time is within any recurring time window:
Find the previous occurrence of the recurring time window, let's call it prevOccurrenceStart
Check whether the current time: time is within the time window: prevOccurrenceStart ~ prevOccurrenceStart + End - Start

… to time window settings

azure-sdk · 2024-05-09T13:02:01Z

API change check

APIView has identified API level changes in this PR and created following API reviews.

com.azure.spring:spring-cloud-azure-feature-management

sdk/spring/spring-cloud-azure-feature-management/README.md

mrm9084 · 2024-05-10T16:21:42Z

sdk/spring/spring-cloud-azure-feature-management/README.md

+                type: "Daily",
+                interval: 1
+              range:
+                type: "NoEnd"


Why is end needed if there is a range type that is "NoEnd"

When using the recurrence pattern, we need to provide both start and end. The time window is end - start.
If the range type is "NoEnd", then we don't need to provide other paramters(endDate, numberOfOccurrences) in range scope.
For example, if we want to enable a feature flag in 2:00 AM ~3:00 AM every day from 2024/05/11. Then the config yaml should be:

start: "Sat, 11 May 2024 02:00:00 GMT", end: "Sat, 11 May 2024 03:00:00 GMT", recurrence: pattern: type: "Daily", interval: 1 range: type: "NoEnd"

If we want to enable a feature flag in 2:00 AM ~3:00 AM every day from 2024/05/11 to 2024/06/11. Then the config yaml should be:

start: "Sat, 11 May 2024 02:00:00 GMT", end: "Sat, 11 May 2024 03:00:00 GMT", recurrence: pattern: type: "Daily", interval: 1 range: type: "EndDate", endDate: "Tue, 11 June 2024 00:00:00 GMT"

I think the intro paragraph no longer works as it goes agains the recurring items. Maybe instead of what we have here where both are one section we make it 2 different sections. I know it's the same filter, but they don't operate the same.

But if we make it into 2 difference sections, then it's also confused. It looks like we have 2 fiters with same name "TimeWindowFilter", different parameters.
Another solution, how about updating the example, not using NoEnd, use Numbered instaed?

start: "Fri, 22 Mar 2024 20:00:00 GMT", end: "Sat, 23 Mar 2024 02:00:00 GMT", recurrence: pattern: type: "Daily", interval: 1 range: type: "Numbered" numberOfOccurrences: 3

sdk/spring/spring-cloud-azure-feature-management/README.md

mrm9084 · 2024-05-10T18:52:03Z

...pring/cloud/feature/management/implementation/timewindow/recurrence/RecurrenceValidator.java

+    }
+
+    private boolean validateRecurrencePattern() {
+        if (!validateInterval()) {


If we follow the Spring validation pattern these should be errors thrown and validation methods have void returns.

Updated to use void return

mrm9084 · 2024-05-10T18:54:28Z

...pring/cloud/feature/management/implementation/timewindow/recurrence/RecurrenceValidator.java

+
+        // Time window duration must be shorter than how frequently it occurs
+        final Duration intervalDuration = Duration.ofDays((long) pattern.getInterval() * RecurrenceConstants.DAYS_PER_WEEK);
+        final Duration timeWindowDuration = Duration.between(settings.getStart(), settings.getEnd());


We should move this down to where it is validated.

Updated. Move these logic to the validateTimeWindowDuration function.

...pring/cloud/feature/management/implementation/timewindow/recurrence/RecurrenceValidator.java

mrm9084 · 2024-05-10T18:57:16Z

...pring/cloud/feature/management/implementation/timewindow/recurrence/RecurrenceValidator.java

+            try {
+                DayOfWeek.valueOf(dayOfWeek.toUpperCase());
+            } catch (IllegalArgumentException e) {
+                reason = RecurrenceConstants.UNRECOGNIZED_VALUE;


For the reason we should be clearer that it is an invalid date of the week.

mrm9084 · 2024-05-10T19:00:59Z

...pring/cloud/feature/management/implementation/timewindow/recurrence/RecurrenceValidator.java

+     * @param firstDayOfWeek The first day of the week.
+     * @return True if the duration is compliant with days of week, false otherwise.
+     */
+    private boolean isDurationCompliantWithDaysOfWeek(Duration duration, int interval, List<String> daysOfWeek, String firstDayOfWeek) {


Just to be verify, this method is checking to make sure if I have a time window open the first one closes before the next starts?

This logic seems like it might not work around daylight savings time.

Yes, this method isDurationCompliantWithDaysOfWeek is to make sure the first one close before the next.

mrm9084 · 2024-05-13T20:20:46Z

sdk/spring/spring-cloud-azure-feature-management/README.md

+                type: "Daily",
+                interval: 1
+              range:
+                type: "NoEnd"


I think the intro paragraph no longer works as it goes agains the recurring items. Maybe instead of what we have here where both are one section we make it 2 different sections. I know it's the same filter, but they don't operate the same.

sdk/spring/spring-cloud-azure-feature-management/README.md

…e readability

…more

ivywei0125 · 2024-05-29T05:51:32Z

...pring/cloud/feature/management/implementation/timewindow/recurrence/RecurrenceConstants.java

+    public static final String OUT_OF_RANGE = "The value of parameter %s is out of the accepted range.";
+    public static final String UNRECOGNIZED_VALUE = "The value of parameter %s is unrecognizable.";
+    public static final String REQUIRED_PARAMETER = "Value cannot be null for required parameter: %s";
+    public static final String NOT_MATCHED = "%s date is not a valid first occurrence.";


Not sure if my understanding right. Usually the "%s" will be replaced with the parameter name.
So if there's a NOT_MATCHED error, then the error message will be "The start date Start is not a valid first occurrence. " Would it be repeated when showing "The start date Start"?

…non-null when Recurrence is not null

mrm9084 · 2024-05-23T16:53:39Z

...pring/cloud/feature/management/implementation/timewindow/recurrence/RecurrenceEvaluator.java

+     */
+    public boolean isMatch() {
+        final RecurrenceValidator validator = new RecurrenceValidator(settings);
+        if (!validator.validateSettings()) {


If this was made a static method we don't need to create a new instance of RecurrenceValidator, this should be called in a static way.

mrm9084 · 2024-05-23T17:21:35Z

.../spring/cloud/feature/management/implementation/timewindow/recurrence/RecurrencePattern.java

@@ -0,0 +1,105 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.


I think it was that validation should be done in the model class, moved to the model package (you already did), so did this too have a toString method (You might have cleaned this up.)

ivywei0125 · 2024-05-30T05:18:02Z

sdk/spring/spring-cloud-azure-feature-management/README.md

+
+- Parameters
+
+  | Property | Relevance | Description                                                                                                                                                                                                                                                               |


@mrm9084 I merged all parameters to one table. It's clear that we support these 2 types for recurrence patter. But the shortcoming is that I need to declare the supported and unsupported types for each property.
Please let me know if you have any ideas about how to make it better.

ivywei0125 · 2024-05-30T05:51:47Z

...gement/src/main/java/com/azure/spring/cloud/feature/management/filters/TimeWindowFilter.java


-        if (!StringUtils.hasText(start) && !StringUtils.hasText(end)) {
+        if (settings.getStart() == null && settings.getEnd() == null) {
            LOGGER.warn("The {} feature filter is not valid for feature {}. It must specify either {}, {}, or both.",


@mrm9084 Shall we throw exception here?
In the validations of recurrence, I just throw exception, because if there're invalid value for the enum type, it's easier to throw exception. Maybe we need to keep consistent?

ivywei0125 · 2024-05-30T06:02:28Z

sdk/spring/spring-cloud-azure-feature-management/README.md

+
+  | Property | Relevance | Description                                                                                                                                                                                                                                                               |
+      |-----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+  | **type** | Required  | Two valid values: `Daily`, `Weekly`.                                                                                                                                                                                                                                      |


Actually, this type can be optional, because we have a default value as Daily.
My concern is that if I announce all parameters to be optional, then maybe users will not define any parameters in recurrence pattern like the following.

start: "Mon, 13 May 2024 02:00:00 GMT", end: "Mon, 13 May 2024 03:00:00 GMT", recurrence: range: type: "NoEnd"

Shall we support this? Or throw invalid exception since there's no pattern parameter? @mrm9084

zhiyuanliang-ms · 2024-05-31T06:38:23Z

...in/java/com/azure/spring/cloud/feature/management/implementation/models/RecurrenceRange.java

+    /**
+     * @param numberOfOccurrences the repeat times to be set
+     * */
+    public void setNumberOfOccurrences(int numberOfOccurrences) {


This is different from the setInterval(interger interval)

zhiyuanliang-ms · 2024-05-31T06:39:57Z

.../java/com/azure/spring/cloud/feature/management/implementation/models/RecurrencePattern.java

+    /**
+     * @param interval the time units to be set
+     * */
+    public void setInterval(Integer interval) {


You use int type in public void setNumberOfOccurrences(int numberOfOccurrences)

Is there any reason use Integer here? It doesn't make sense to do null check here, since Interval has default value 1.

zhiyuanliang-ms · 2024-05-31T07:46:31Z

...pring/cloud/feature/management/implementation/timewindow/recurrence/RecurrenceValidator.java

+
+        // Check whether "Start" is a valid first occurrence
+        final RecurrencePattern pattern = settings.getRecurrence().getPattern();
+        if (pattern.getDaysOfWeek().stream().noneMatch((dayOfWeekStr) ->


Should it be dayOfWeek instead of dayOfWeekStr? getDaysOfWeek returns List

ivywei0125 added 13 commits April 27, 2024 11:06

add base class: recurrence range, recurrence pattern

bd2b15a

add object mapper in time window filter for parsing the config string…

56832a9

… to time window settings

implement the logic about recurrence evaluator

18551d6

add validations

21519ab

add test case for validator

bfb0d93

add test case for evaluator

23f13f7

add more test case

20825d7

add more test case

c4f14c6

add calculateClosestStart method to calculate the closest occurrence

122541e

rename function

15e7fa2

add cache logic

c6fa94f

update README.md

449d482

update cache service

6613249

ivywei0125 self-assigned this May 9, 2024

ivywei0125 requested review from mrm9084, chenrujun, Netyyyy, saragluna and moarychan as code owners May 9, 2024 12:54

ivywei0125 changed the title ~~Yuwe/recurring time window filter~~ App Configuration: recurring time window filter May 9, 2024

github-actions bot added the azure-spring All azure-spring related issues label May 9, 2024

ivywei0125 added 4 commits May 9, 2024 21:19

ci

3365d34

ci

ac68532

move to parent path to make the package name shorter

c683ee8

update copy right

6bbbaaa

mrm9084 requested changes May 10, 2024

View reviewed changes

address comments: update README.md

218cfa9

mrm9084 requested changes May 13, 2024

View reviewed changes

zhiyuanliang-ms mentioned this pull request May 14, 2024

Update README to emphasize built-in filters are add automatically and adjust wording microsoft/FeatureManagement-Dotnet#448

Merged

ivywei0125 added 9 commits May 28, 2024 15:15

address comment: simplify code

57042e4

address comment: throw exceptions directly

840b1af

address comment: move the related logic to the function to improve th…

5151259

…e readability

address comment: make as static method

822f432

address comment: extract variables to avoid multi caller

9b6199f

address comment: remove convertToWeekDayNumber method, no need any …

e703d7d

…more

address comment: simplify code

bd614bb

address comment: remove unused code

c4138c5

address comment: rename symbol

567b5c7

ivywei0125 commented May 29, 2024

View reviewed changes

ivywei0125 added 3 commits May 29, 2024 14:21

address comment: add invalid settings check. Start and End must both …

65b98e6

…non-null when Recurrence is not null

address comment: code style

f5017a9

address comment: add more test cases

a52e3f7

mrm9084 requested changes May 29, 2024

View reviewed changes

ivywei0125 added 5 commits May 30, 2024 10:14

address comment: removed unused method

d6d815c

address comment: update symbols

2b928c9

address comment: adjust spaces

59128ac

address comment: add more test case

6ebe56c

address comment: update the README.md

dc659ad

ivywei0125 commented May 30, 2024

View reviewed changes

address comment: code style

631b357

ivywei0125 commented May 30, 2024

View reviewed changes

ivywei0125 added 4 commits May 30, 2024 14:49

address comment: typo error fix

80c6011

address comment: typo error fix

81da607

address comment: update README.md

e1c6007

address comment: update README.md

f2ca9c7

zhiyuanliang-ms reviewed May 31, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

App Configuration: recurring time window filter #40093

App Configuration: recurring time window filter #40093

ivywei0125 commented May 9, 2024

azure-sdk commented May 9, 2024

mrm9084 May 10, 2024

ivywei0125 May 11, 2024

mrm9084 May 13, 2024

ivywei0125 May 14, 2024

mrm9084 May 10, 2024

ivywei0125 May 28, 2024

mrm9084 May 10, 2024

ivywei0125 May 28, 2024

mrm9084 May 10, 2024

mrm9084 May 10, 2024

mrm9084 May 10, 2024

ivywei0125 May 28, 2024

mrm9084 May 13, 2024

ivywei0125 May 29, 2024

mrm9084 May 23, 2024

mrm9084 May 23, 2024

ivywei0125 May 30, 2024

ivywei0125 May 30, 2024

ivywei0125 May 30, 2024

zhiyuanliang-ms May 31, 2024

zhiyuanliang-ms May 31, 2024

zhiyuanliang-ms May 31, 2024 •

edited

		@@ -0,0 +1,105 @@
		// Copyright (c) Microsoft Corporation. All rights reserved.

App Configuration: recurring time window filter #40093

Are you sure you want to change the base?

App Configuration: recurring time window filter #40093

Conversation

ivywei0125 commented May 9, 2024

azure-sdk commented May 9, 2024

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

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

zhiyuanliang-ms May 31, 2024 • edited

Choose a reason for hiding this comment

zhiyuanliang-ms May 31, 2024 •

edited