Removing deprecations related to data system options

Author: Todd Anderson

packages/shared/sdk-server/__tests__/options/Configuration.test.ts

@@ -22,7 +22,7 @@ function logger(options: LDOptions): TestLogger {
 describe.each([undefined, null, 'potat0', 17, [], {}])('constructed without options', (input) => {
   it('should have default options', () => {
     // JavaScript is not going to stop you from calling this with whatever
-    // you want. So we need to tell TS to ingore our bad behavior.
+    // you want. So we need to tell TS to ignore our bad behavior.
     // @ts-ignore
     const config = new Configuration(input);
 
@@ -421,7 +421,7 @@ describe('when setting different options', () => {
     ]);
   });
 
-  it('drops invalid dataystem data source options and replaces with defaults', () => {
+  it('drops invalid datasystem data source options and replaces with defaults', () => {
     const config = new Configuration(
       withLogger({
         dataSystem: { dataSource: { bogus: 'myBogusOptions' } as unknown as DataSourceOptions },
@@ -436,7 +436,7 @@ describe('when setting different options', () => {
     ]);
   });
 
-  it('validates the datasystem persitent store is a factory or object', () => {
+  it('validates the datasystem persistent store is a factory or object', () => {
     const config1 = new Configuration(
       withLogger({
         dataSystem: {
@@ -501,7 +501,7 @@ describe('when setting different options', () => {
     expect(logger(config).getCount()).toEqual(0);
   });
 
-  it('ignores top level featureStore in favor of the datasystem persitent store', () => {
+  it('ignores top level featureStore in favor of the datasystem persistent store', () => {
     const shouldNotBeUsed = new InMemoryFeatureStore();
     const shouldBeUsed = new InMemoryFeatureStore();
     const config = new Configuration(

packages/shared/sdk-server/src/api/options/LDDataSystemOptions.ts

@@ -37,9 +37,9 @@ export interface LDDataSystemOptions {
    * type and the optional fields you want to customize.
    *
    * If not specified, this defaults to using the {@link StandardDataSourceOptions} which
-   * pefroms a combination of streaming and polling.
+   * performs a combination of streaming and polling.
    *
-   * See {@link LDDataSystemOptions} decoumentation for exmaples.
+   * See {@link LDDataSystemOptions} documentation for examples.
    */
   dataSource?: DataSourceOptions;
 
@@ -48,11 +48,11 @@ export interface LDDataSystemOptions {
    * data from the persistent store. Once fresh data has arrived from LaunchDarkly, the
    * SDK will no longer read from the persistent store, although it will keep it up-to-date
    * for future startups.
-   * 
+   *
    * Some implementations provide the store implementation object itself, while others
    * provide a factory function that creates the store implementation based on the SDK
    * configuration; this property accepts either.
-   * 
+   *
    * @param clientContext whose properties may be used to influence creation of the persistent store.
    */
   persistentStore?: LDFeatureStore | ((clientContext: LDClientContext) => LDFeatureStore);
@@ -68,7 +68,7 @@ export interface LDDataSystemOptions {
 
   /**
    * A component that obtains feature flag data and puts it in the feature store. Setting
-   * this supercedes {@link LDDataSystemOptions#dataSource}.
+   * this supersedes {@link LDDataSystemOptions#dataSource}.
    */
   updateProcessor?:
     | object

packages/shared/sdk-server/src/api/options/LDOptions.ts

@@ -70,20 +70,14 @@ export interface LDOptions {
    * Some implementations provide the store implementation object itself, while others
    * provide a factory function that creates the store implementation based on the SDK
    * configuration; this property accepts either.
-   *
-   * @deprecated This is now superceded by {@link LDOptions#dataSystem} using property
-   * {@link LDDataSystemOptions#persistentStore}. The scope of the {@link LDFeatureStore}
-   * that you provide is being reduced in the next major version to only being responsible
-   * for persistence. See documention on {@link LDDataSystemOptions#persistentStore} for
-   * more information.
    */
   featureStore?: LDFeatureStore | ((clientContext: LDClientContext) => LDFeatureStore);
 
   /**
    * Configuration options for the Data System that the SDK uses to get and maintain flags and other
    * data from LaunchDarkly and other sources.
    *
-   * Setting this option supercedes
+   * Setting this option supersedes
    *
    * Example (Recommended):
    * ```typescript
@@ -127,9 +121,6 @@ export interface LDOptions {
    * A component that obtains feature flag data and puts it in the feature store.
    *
    * If you specify the {@link LDOptions#dataSystem}, this setting will be ignored.
-   *
-   * @deprecated This has moved to {@link LDOptions#dataSystem}. Use property
-   * {@link LDDataSystemOptions#updateProcessor} instead.
    */
   updateProcessor?:
     | object
@@ -149,10 +140,6 @@ export interface LDOptions {
    * The time between polling requests, in seconds. Ignored in streaming mode.
    *
    * If you specify the {@link LDOptions#dataSystem}, this setting will be ignored.
-   *
-   * @deprecated This functionality is now controlled by {@link LDOptions#dataSystem} by
-   * specifying the {@link LDDataSystemOptions#dataSource}. Specifying the polling interval is still
-   * available when using {@link StandardDataSourceOptions} or {@link PollingDataSourceOptions}.
    */
   pollInterval?: number;
 
@@ -173,11 +160,6 @@ export interface LDOptions {
    *
    * This is true by default. If you set it to false, the client will use polling.
    * Streaming should only be disabled on the advice of LaunchDarkly support.
-   *
-   * @deprecated This functionality is now controlled by {@link LDOptions#dataSystem}
-   * by specifying {@link LDDataSystemOptions#dataSource} options. To opt out of
-   * streaming, you can use the {@link PollingDataSourceOptions}.  Streaming should
-   * only be disabled on the advice of LaunchDarkly support.
    */
   stream?: boolean;
 
@@ -191,12 +173,6 @@ export interface LDOptions {
    * increase exponentially for any subsequent connection failures.
    *
    * The default value is 1.
-   *
-   *
-   * @deprecated This functionality is now controlled by {@link LDOptions#dataSystem}
-   * by specifying {@link LDDataSystemOptions#dataSource} options. Specifying the reconnect
-   * delay is still available when using {@link StandardDataSourceOptions} or
-   * {@link StreamingDataSourceOptions}.
    */
   streamInitialReconnectDelay?: number;
 
@@ -208,9 +184,6 @@ export interface LDOptions {
    * In this configuration, the client will not connect to LaunchDarkly to get feature flags,
    * but will instead get feature state from a database (Redis or another supported feature
    * store integration) that is populated by the relay. By default, this is false.
-   *
-   * @deprecated This functionality is now controlled by {@link LDOptions#dataSystem}
-   * by specifying {@link LDDataSystemOptions#useLdd}.
    */
   useLdd?: boolean;
 
@@ -220,7 +193,7 @@ export interface LDOptions {
   sendEvents?: boolean;
 
   /**
-   * Whether all context attributes (except the contexy key) should be marked as private, and
+   * Whether all context attributes (except the context key) should be marked as private, and
    * not sent to LaunchDarkly.
    *
    * By default, this is false.