feat: Add ODP GraphQL AP Interface

packages/optimizely-sdk/lib/core/project_config/project_config_manager.tests.js

@@ -97,7 +97,7 @@ describe('lib/core/project_config/project_config_manager', function() {
     var errorMessage = globalStubErrorHandler.handleError.lastCall.args[0].message;
     assert.strictEqual(
       errorMessage,
-      sprintf(ERROR_MESSAGES.INVALID_DATAFILE, 'JSON_SCHEMA_VALIDATOR', 'projectId', 'is missing and it is required')
+      sprintf(ERROR_MESSAGES.INVALID_DATAFILE, 'JSON_SCHEMA_VALIDATOR (Project Config JSON Schema)', 'projectId', 'is missing and it is required'),
     );
     return manager.onReady().then(function(result) {
       assert.include(result, {

packages/optimizely-sdk/lib/core/project_config/project_config_schema.ts

@@ -21,6 +21,7 @@ import { JSONSchema4 } from 'json-schema';
 
 var schemaDefinition = {
   $schema: 'http://json-schema.org/draft-04/schema#',
+  title: 'Project Config JSON Schema',
   type: 'object',
   properties: {
     projectId: {

packages/optimizely-sdk/lib/plugins/odp/graphql_manager.ts

@@ -0,0 +1,89 @@
+/**
+ * Copyright 2022, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { ConsoleLogHandler, LogHandler, LogLevel } from '../../modules/logging';
+import { Response } from './odp_types';
+import { IOdpClient, OdpClient } from './odp_client';
+import { validate } from '../../utils/json_schema_validator';
+import { OdpResponseSchema } from './odp_response_schema';
+import { QuerySegmentsParameters } from './query_segments_parameters';
+
+const QUALIFIED = 'qualified';
+
+export interface IGraphQLManager {
+  fetchSegments(apiKey: string, apiHost: string, userKey: string, userValue: string, segmentToCheck: string[]): Promise<string[]>;
+}
+
+export class GraphqlManager implements IGraphQLManager {
+  private readonly _logger: LogHandler;
+  private readonly _odpClient: IOdpClient;
+
+  constructor(logger: LogHandler, client: IOdpClient) {
+    this._logger = logger ?? new ConsoleLogHandler();
+    this._odpClient = client ?? new OdpClient(this._logger);
+  }
+
+  public async fetchSegments(apiKey: string, apiHost: string, userKey: string, userValue: string, segmentToCheck: string[]): Promise<string[]> {
+    const parameters = new QuerySegmentsParameters({
+      ApiKey: apiKey,
+      ApiHost: apiHost,
+      UserKey: userKey,
+      UserValue: userValue,
+      SegmentsToCheck: segmentToCheck,
+    });
+    const segmentsResponse = await this._odpClient.querySegments(parameters);
+    if (!segmentsResponse) {
+      this._logger.log(LogLevel.ERROR, 'Audience segments fetch failed (network error)');
+      return [] as string[];
+    }
+
+    const parsedSegments = this.parseSegmentsResponseJson(segmentsResponse);
+    if (!parsedSegments) {
+      this._logger.log(LogLevel.ERROR, 'Audience segments fetch failed (decode error)');
+      return [] as string[];
+    }
+
+    if (parsedSegments.errors?.length > 0) {
+      const errors = parsedSegments.errors.map((e) => e.message).join(';');
+
+      this._logger.log(LogLevel.WARNING, `Audience segments fetch failed (${errors})`);
+
+      return [] as string[];
+    }
+
+    if (parsedSegments?.data?.customer?.audiences?.edges === null) {
+      this._logger.log(LogLevel.WARNING, 'Audience segments fetch failed (decode error)');
+
+      return [] as string[];
+    }
+
+    return parsedSegments.data.customer.audiences.edges.filter(edge => edge.node.state == QUALIFIED).map(edge => edge.node.name);
+  }
+
+  private parseSegmentsResponseJson(jsonResponse: string): Response | undefined {
+    let jsonObject = {};
+    try {
+      jsonObject = JSON.parse(jsonResponse);
+    } catch {
+      this._logger.log(LogLevel.ERROR, 'Attempted to parse invalid segment response JSON.');
+      return;
+    }
+    if (validate(jsonObject, OdpResponseSchema, false)) {
+      return jsonObject as Response;
+    }
+    return;
+  }
+}

packages/optimizely-sdk/lib/plugins/odp/odp_client.ts

@@ -0,0 +1,64 @@
+/**
+ * Copyright 2022, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { LogHandler, LogLevel } from '../../modules/logging';
+import { QuerySegmentsParameters } from './query_segments_parameters';
+
+export interface IOdpClient {
+  querySegments(parameters: QuerySegmentsParameters): Promise<string | undefined>;
+}
+
+export class OdpClient implements IOdpClient {
+  private readonly _logger: LogHandler;
+
+  constructor(logger: LogHandler) {
+    this._logger = logger;
+  }
+
+  public async querySegments(parameters: QuerySegmentsParameters): Promise<string | undefined> {
+    const emptyResponse = undefined;
+
+    if (!parameters?.ApiHost || !parameters?.ApiKey) {
+      this._logger.log(LogLevel.ERROR, 'No ApiHost or ApiKey set before querying segments');
+      return emptyResponse;
+    }
+
+    const fetchFailureMessage = 'Audience segments fetch failed';
+
+    const method = 'POST';
+    const headers = {
+      'Content-Type': 'application/json',
+      'x-api-key': parameters.ApiKey,
+    };
+    const body = parameters.ToJson();
+
+    let response: Response;
+
+    try {
+      response = await fetch(parameters.ApiHost, { method, headers, body });
+    } catch (error) {
+      this._logger.log(LogLevel.ERROR, `${fetchFailureMessage} (network error)`);
+      return emptyResponse;
+    }
+
+    if (!response.ok) {
+      this._logger.log(LogLevel.ERROR, `${fetchFailureMessage} (${response?.status ?? 'network error'})`);
+      return emptyResponse;
+    }
+
+    return response.json();
+  }
+}

packages/optimizely-sdk/lib/plugins/odp/odp_response_schema.ts

@@ -0,0 +1,186 @@
+/**
+ * Copyright 2022, Optimizely
+ *
+ * Licensed under the Apache License, Version 2.0 (the 'License');
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an 'AS IS' BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { JSONSchema4 } from 'json-schema';
+
+/**
+ * ODP Response JSON Schema file used to validate the project json datafile
+ */
+export const OdpResponseSchema = {
+  $schema: 'https://json-schema.org/draft/2019-09/schema',
+  $id: 'https://example.com/example.json',
+  title: 'ODP Response Schema',
+  type: 'object',
+  required: [
+    'data',
+  ],
+  properties: {
+    data: {
+      title: 'The data Schema',
+      type: 'object',
+      required: [
+        'customer',
+      ],
+      properties: {
+        customer: {
+          title: 'The customer Schema',
+          type: 'object',
+          required: [ ],
+          properties: {
+            audiences: {
+              title: 'The audiences Schema',
+              type: 'object',
+              required: [
+                'edges',
+              ],
+              properties: {
+                edges: {
+                  title: 'The edges Schema',
+                  type: 'array',
+                  items: {
+                    title: 'A Schema',
+                    type: 'object',
+                    required: [
+                      'node',
+                    ],
+                    properties: {
+                      node: {
+                        title: 'The node Schema',
+                        type: 'object',
+                        required: [
+                          'name',
+                          'state',
+                        ],
+                        properties: {
+                          name: {
+                            title: 'The name Schema',
+                            type: 'string',
+                            examples: [
+                              'has_email',
+                              'has_email_opted_in',
+                            ],
+                          },
+                          state: {
+                            title: 'The state Schema',
+                            type: 'string',
+                            examples: [
+                              'qualified',
+                            ],
+                          },
+                        },
+                        examples: [],
+                      },
+                    },
+                    examples: [],
+                  },
+                  examples: [],
+                },
+              },
+              examples: [],
+            },
+          },
+          examples: [],
+        },
+      },
+      examples: [],
+    },
+    errors: {
+      title: 'The errors Schema',
+      type: 'array',
+      default: [],
+      items: {
+        title: 'A Schema',
+        type: 'object',
+        required: [
+          'message',
+          'locations',
+          'extensions'
+        ],
+        properties: {
+          message: {
+            title: 'The message Schema',
+            type: 'string',
+            examples: [
+              'Exception while fetching data (/customer) : java.lang.RuntimeException: could not resolve _fs_user_id = asdsdaddddd'
+            ]
+          },
+          locations: {
+            title: 'The locations Schema',
+            type: 'array',
+            items: {
+              title: 'A Schema',
+              type: 'object',
+              required: [
+                'line',
+                'column'
+              ],
+              properties: {
+                line: {
+                  title: 'The line Schema',
+                  type: 'integer',
+                  examples: [
+                    2
+                  ]
+                },
+                column: {
+                  title: 'The column Schema',
+                  type: 'integer',
+                  examples: [
+                    3
+                  ]
+                }
+              },
+              examples: []
+            },
+            examples: []
+          },
+          path: {
+            title: 'The path Schema',
+            type: 'array',
+            items: {
+              title: 'A Schema',
+              type: 'string',
+              examples: [
+                'customer'
+              ]
+            },
+            examples: []
+          },
+          extensions: {
+            title: 'The extensions Schema',
+            type: 'object',
+            required: [
+              'classification'
+            ],
+            properties: {
+              classification: {
+                title: 'The classification Schema',
+                type: 'string',
+                examples: [
+                  'InvalidIdentifierException'
+                ]
+              }
+            },
+            examples: []
+          }
+        },
+        examples: []
+      },
+      examples: []
+    },
+  },
+  examples: [],
+} as JSONSchema4;