chore: implement variation functions #298

yusinto · 2023-10-12T21:12:03Z

Share EventFactory and friends
Implement variation, typedVariation, allFlags and other functions for sdk-client

… server override for evalEvent.

…r client. break public api close function to match sserver. move EventFactory to events folder.

shortcut-integration · 2023-10-12T21:12:08Z

This pull request has been linked to Shortcut Story #220491: Move evaluation classes to shared/common.

packages/shared/common/src/internal/evaluation/ErrorKinds.ts

yusinto · 2023-10-12T21:17:32Z

packages/shared/common/src/internal/evaluation/EventFactoryBase.ts

This is mostly ripped from the previous EventFactory implementation. All functions are identical as previously, except evalEvent. Each sdk-server and sdk-client implements their own copy of evalEvent, and then calling this base function. There maybe a better way to achieve this in typescript, and I'm open for suggestions.

yusinto · 2023-10-12T21:18:10Z

packages/shared/sdk-client/src/LDClientImpl.test.ts

Just rudimentary tests so not complete coverage yet. I'll add more in future prs.

yusinto · 2023-10-12T21:20:18Z

packages/shared/sdk-client/src/LDClientImpl.ts

+    const result: LDFlagSet = {};
+    Object.entries(this.rawFlags).forEach(([k, r]) => {
+      result[k] = r.value;
+    });
+    return result;


This is different from the existing js-sdk allFlags. Here I am following the server sdk to not send events on allFlags, thus getting rid of sendEventsOnlyForVariation. I don't understand the use case for sending events in allFlags, and I am pushing for a consistent behavior with the server sdk.

yusinto · 2023-10-12T21:21:18Z

packages/shared/sdk-client/src/LDClientImpl.ts

-  close(onDone?: () => void): Promise<void> {
-    return Promise.resolve(undefined);
+  close(): void {
+    this.eventProcessor.close();
  }


Breaking api change here, again I am pushing for consistency with the server sdk by getting rid of the callback arg and returning void instead of a promise.

yusinto · 2023-10-12T21:23:06Z

packages/shared/sdk-client/src/LDClientImpl.ts

+  async flush(callback?: (err: Error | null, res: boolean) => void): Promise<void> {
+    try {
+      await this.eventProcessor.flush();
+    } catch (err) {
+      callback?.(err as Error, false);
+    }
+    callback?.(null, true);
  }


This is a duplicate of sdk-server. We may be able to refactor this plus other similar functions to an LDClientImplBase class (a mouthful).

yusinto · 2023-10-12T21:25:05Z

packages/shared/sdk-client/src/LDClientImpl.ts

+  track(key: string, data?: any, metricValue?: number): void {
+    const checkedContext = Context.fromLDContext(this.context);
+    if (!checkedContext.valid) {
+      this.logger?.warn(ClientMessages.missingContextKeyNoEvent);
+      return;
+    }
+
+    this.eventProcessor.sendEvent(
+      this.eventFactoryDefault.customEvent(key, checkedContext!, data, metricValue),
+    );
+  }


Another function which is almost a carbon copy of sdk-server, differing only in the LDContext argument.

yusinto · 2023-10-12T21:26:57Z

packages/shared/sdk-client/src/LDClientImpl.ts

+    );
+  }
+
+  private sendEvalEvent(


And another

yusinto · 2023-10-12T21:29:15Z

packages/shared/sdk-client/src/LDClientImpl.ts

+    );
+  }
+
+  private variationInternal(


The logic here is copied from sdk-server, however this version is synchronous so does not have callbacks like the server counterpart. Still a lot of opportunities for dry, but I think this is good enough for now.

packages/shared/sdk-client/src/evaluation/fetchFlags.ts

packages/shared/common/src/internal/evaluation/Reasons.ts

kinyoklion · 2023-10-12T21:42:31Z

packages/shared/common/src/internal/evaluation/EvalResult.ts

@@ -1,16 +1,14 @@
-import { internal, LDEvaluationDetail, LDEvaluationReason } from '@launchdarkly/js-sdk-common';
-
+import { LDEvaluationDetail, LDEvaluationReason } from '../../api';


I am a little hesitant on this file. Server SDKs do an eval, so they always produce details and reasons, but client SDKs either have reasons or do not have reasons based on how they were initialized and maybe some other factors. So, for typing I would prefer they remain required in server, but tney are going to need to be optional for clients.

Ok I understand your concerns. I re-visited sdk-client's variationInternal and I think I can accommodate your request. I'll put refactor and submit a secondary PR. This should address your other comment re Reasons as well.

kinyoklion · 2023-10-12T21:43:16Z

packages/shared/sdk-client/src/LDClientImpl.ts

  }

-  flush(onDone?: () => void): Promise<void> {
-    return Promise.resolve(undefined);
+  async flush(callback?: (err: Error | null, res: boolean) => void): Promise<void> {


Do we need to keep the callback, or can we just use a promise instead?

kinyoklion · 2023-10-12T21:47:51Z

packages/shared/sdk-client/src/LDClientImpl.ts

  }

  getContext(): LDContext {
-    return { kind: 'user', key: 'test-context-1' };
+    return { ...this.context };


This is problematic. Destructing here only decouples the top level entries. The nested items within the context would still be shared with the original.

It looks like the old implementation did a proper clone (js-sdk-common).

You could clone using cloneWithRedactions and passing an empty private attribute list.

Ok good catch object spread only does first level clone. I'll fix this.

packages/shared/sdk-client/src/api/LDClient.ts

packages/shared/sdk-server/src/LDClientImpl.ts

yusinto · 2023-10-13T08:32:18Z

packages/shared/common/src/internal/events/InputEvalEvent.ts

-    detail: LDEvaluationDetail,
    version?: number,
    variation?: number,


I removed detail because we are only using it for variationIndex and value. We already have variation on line 34 so it's redundant to have both variationIndex and variation. I think it's safe to replace detail with just value and then use variation as is.

packages/shared/sdk-client/src/events/EventFactory.ts

packages/shared/sdk-server/src/LDClientImpl.ts

yusinto · 2023-10-13T19:48:52Z

packages/shared/sdk-client/src/LDClientImpl.ts

  }

  getContext(): LDContext {
-    return { kind: 'user', key: 'test-context-1' };
+    return clone(this.context);


I copied the legacy function from js-common-sdk because cloneWithRedactions takes LDContextCommon and not LDContext.

packages/shared/sdk-client/src/LDClientImpl.ts

kinyoklion · 2023-10-13T20:00:22Z

packages/shared/common/src/utils/clone.ts

@@ -0,0 +1,3 @@
+export default function clone(obj: any) {
+  return JSON.parse(JSON.stringify(obj));


So, this will be fine for now, but it does contain some weaknesses compared to how we do it for filtering.

Primarily this will throw an exception for circular contents and some other situations.

Ok I understand. in the interest of time i will defer improvements to this to a later date.

yusinto added 9 commits October 11, 2023 14:50

chore: move evaluation classes to shared/common.

8a7eeba

chore: move EventFactory to shared/common/EventFactoryBase. implement…

56b2bdc

… server override for evalEvent.

chore: implemented draft variation logic. implemented EventFactory fo…

3281ab1

…r client. break public api close function to match sserver. move EventFactory to events folder.

chore: share ClientMessages

0cded8e

chore: add TODO comment

067c5e8

chore: implemented allFlags. add client tests.

f587aaa

Update LDClientImpl.ts

6ea50c6

Update fetchUtils.test.ts

4162612

chore: added variation tests.

7717fd6

yusinto requested review from kinyoklion and louis-launchdarkly as code owners October 12, 2023 21:12

yusinto marked this pull request as draft October 12, 2023 21:12

Update index.test.ts

cf62a0c

yusinto commented Oct 12, 2023

View reviewed changes

packages/shared/common/src/internal/evaluation/ErrorKinds.ts Outdated Show resolved Hide resolved

yusinto commented Oct 12, 2023

View reviewed changes

packages/shared/sdk-client/src/LDClientImpl.ts Outdated

);

}

private sendEvalEvent(

Copy link

Contributor Author

yusinto Oct 12, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And another

yusinto commented Oct 12, 2023

View reviewed changes

packages/shared/sdk-client/src/evaluation/fetchFlags.ts Outdated Show resolved Hide resolved

kinyoklion reviewed Oct 12, 2023

View reviewed changes

packages/shared/common/src/internal/evaluation/Reasons.ts Outdated Show resolved Hide resolved

kinyoklion reviewed Oct 12, 2023

View reviewed changes

packages/shared/sdk-client/src/api/LDClient.ts Show resolved Hide resolved

fix: bugfix for including eval details

8eb693e

yusinto marked this pull request as ready for review October 12, 2023 23:06

yusinto commented Oct 12, 2023

View reviewed changes

packages/shared/sdk-server/src/LDClientImpl.ts Show resolved Hide resolved

yusinto added 2 commits October 13, 2023 01:16

chore: rollback EvalResult and Reasons.

f4ec951

Update evaluationDetail.ts

2b3723a

yusinto commented Oct 13, 2023

View reviewed changes

packages/shared/sdk-client/src/events/EventFactory.ts Outdated Show resolved Hide resolved

yusinto commented Oct 13, 2023

View reviewed changes

packages/shared/sdk-server/src/LDClientImpl.ts Show resolved Hide resolved

yusinto added 2 commits October 13, 2023 09:56

Update Evaluator.ts

3860421

chore: pr feedback

bdbf1ce

yusinto commented Oct 13, 2023

View reviewed changes

packages/shared/sdk-client/src/LDClientImpl.ts Show resolved Hide resolved

yusinto requested a review from kinyoklion October 13, 2023 19:51

kinyoklion reviewed Oct 13, 2023

View reviewed changes

kinyoklion merged commit fc2c212 into feat/merge-client-and-migrations Oct 13, 2023
14 checks passed

kinyoklion deleted the yus/sc-220491/move-evaluation-classes-to-shared-common branch October 13, 2023 20:13

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: implement variation functions #298

chore: implement variation functions #298

yusinto commented Oct 12, 2023

shortcut-integration bot commented Oct 12, 2023

yusinto Oct 12, 2023

yusinto Oct 12, 2023

yusinto Oct 12, 2023

yusinto Oct 12, 2023

yusinto Oct 12, 2023

yusinto Oct 12, 2023

yusinto Oct 12, 2023

yusinto Oct 12, 2023

kinyoklion Oct 12, 2023

yusinto Oct 12, 2023

kinyoklion Oct 12, 2023

kinyoklion Oct 12, 2023

yusinto Oct 12, 2023

yusinto Oct 13, 2023 •

edited

Loading

yusinto Oct 13, 2023

kinyoklion Oct 13, 2023

yusinto Oct 13, 2023

		@@ -1,16 +1,14 @@
		import { internal, LDEvaluationDetail, LDEvaluationReason } from '@launchdarkly/js-sdk-common';

		import { LDEvaluationDetail, LDEvaluationReason } from '../../api';

		@@ -0,0 +1,3 @@
		export default function clone(obj: any) {
		return JSON.parse(JSON.stringify(obj));

chore: implement variation functions #298

chore: implement variation functions #298

Conversation

yusinto commented Oct 12, 2023

shortcut-integration bot commented Oct 12, 2023

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

yusinto Oct 13, 2023 • edited Loading

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

yusinto Oct 13, 2023 •

edited

Loading