@adobe/spacecat-shared-data-access 1.41.2 → 1.41.3

package/CHANGELOG.md

@@ -1,3 +1,10 @@
+# [@adobe/spacecat-shared-data-access-v1.41.3](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.41.2...@adobe/spacecat-shared-data-access-v1.41.3) (2024-08-15)
+
+
+### Bug Fixes
+
+* refactor hashed api key and query to retrieve API key ([#325](https://github.com/adobe/spacecat-shared/issues/325)) ([a99fc76](https://github.com/adobe/spacecat-shared/commit/a99fc76963fdcd6bce8de7d5b315dbefbb03fd95))
+
 # [@adobe/spacecat-shared-data-access-v1.41.2](https://github.com/adobe/spacecat-shared/compare/@adobe/spacecat-shared-data-access-v1.41.1...@adobe/spacecat-shared-data-access-v1.41.2) (2024-08-14)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adobe/spacecat-shared-data-access",
-  "version": "1.41.2",
+  "version": "1.41.3",
   "description": "Shared modules of the Spacecat Services - Data Access",
   "type": "module",
   "main": "src/index.js",

package/src/dto/api-key.js

@@ -21,7 +21,7 @@ export const ApiKeyDto = {
      *          imsOrgId: *, expiresAt: *}}
      */
   toDynamoItem: (apiKey) => ({
-    hashedKey: apiKey.getHashedKey(),
+    hashedApiKey: apiKey.getHashedApiKey(),
     name: apiKey.getName(),
     imsUserId: apiKey.getImsUserId(),
     imsOrgId: apiKey.getImsOrgId(),
@@ -38,7 +38,7 @@ export const ApiKeyDto = {
      */
   fromDynamoItem: (dynamoItem) => {
     const apiKeyData = {
-      hashedKey: dynamoItem.hashedKey,
+      hashedApiKey: dynamoItem.hashedApiKey,
       name: dynamoItem.name,
       imsUserId: dynamoItem.imsUserId,
       imsOrgId: dynamoItem.imsOrgId,

package/src/index.d.ts

@@ -546,7 +546,7 @@ export interface ApiKey {
     /**
      * Retrieves the hashed key value of the API Key.
      */
-    getHashedKey: () => string;
+    getHashedApiKey: () => string;
 
     /**
      * Retrieves the name of the API Key.
@@ -773,8 +773,8 @@ export interface DataAccess {
       jobId: string,
       status: string,
     ) => Promise<ImportUrl[]>;
-  getApiKeyByHashedKey: (
-      hashedKey: string,
+  getApiKeyByHashedApiKey: (
+      hashedApiKey: string,
     ) => Promise<ApiKey | null>;
   createNewApiKey: (
       apiKeyData: object,
@@ -832,7 +832,7 @@ interface DataAccessConfig {
   indexNameAllImportJobsByStatus: string,
   indexNameAllImportJobsByDateRange: string,
   indexNameAllImportUrlsByJobIdAndStatus: string,
-  indexNameApiKeyByHashedKey: string,
+  indexNameApiKeyByHashedApiKey: string,
   pkAllSites: string;
   pkAllLatestAudits: string;
   pkAllOrganizations: string;

package/src/index.js

@@ -37,7 +37,7 @@ const INDEX_NAME_ALL_SITES_ORGANIZATIONS = 'spacecat-services-all-sites-organiza
 const INDEX_NAME_ALL_IMPORT_JOBS_BY_STATUS = 'spacecat-services-all-import-jobs-by-status-dev';
 const INDEX_NAME_ALL_IMPORT_JOBS_BY_DATE_RANGE = 'spacecat-services-all-import-jobs-by-date-range-dev';
 const INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS = 'spacecat-services-all-import-urls-by-job-id-and-status-dev';
-const INDEX_NAME_API_KEY_BY_HASHED_KEY = 'spacecat-services-api-key-by-hashed-key-dev';
+const INDEX_NAME_API_KEY_BY_HASHED_API_KEY = 'spacecat-services-api-key-by-hashed-api-key-dev';
 
 const PK_ALL_SITES = 'ALL_SITES';
 const PK_ALL_CONFIGURATIONS = 'ALL_CONFIGURATIONS';
@@ -75,7 +75,7 @@ export default function dataAccessWrapper(fn) {
         DYNAMO_INDEX_NAME_ALL_IMPORT_JOBS_BY_DATE_RANGE = INDEX_NAME_ALL_IMPORT_JOBS_BY_DATE_RANGE,
         DYNAMO_INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS =
         INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS,
-        DYNAMO_INDEX_NAME_API_KEY_BY_HASHED_KEY = INDEX_NAME_API_KEY_BY_HASHED_KEY,
+        DYNAMO_INDEX_NAME_API_KEY_BY_HASHED_API_KEY = INDEX_NAME_API_KEY_BY_HASHED_API_KEY,
       } = context.env;
 
       context.dataAccess = createDataAccess({
@@ -101,7 +101,7 @@ export default function dataAccessWrapper(fn) {
         indexNameAllImportJobsByStatus: DYNAMO_INDEX_NAME_ALL_IMPORT_JOBS_BY_STATUS,
         indexNameAllImportJobsByDateRange: DYNAMO_INDEX_NAME_ALL_IMPORT_JOBS_BY_DATE_RANGE,
         indexNameImportUrlsByJobIdAndStatus: DYNAMO_INDEX_NAME_ALL_IMPORT_URLS_BY_JOB_ID_AND_STATUS,
-        indexNameApiKeyByHashedKey: DYNAMO_INDEX_NAME_API_KEY_BY_HASHED_KEY,
+        indexNameApiKeyByHashedApiKey: DYNAMO_INDEX_NAME_API_KEY_BY_HASHED_API_KEY,
         pkAllSites: PK_ALL_SITES,
         pkAllOrganizations: PK_ALL_ORGANIZATIONS,
         pkAllLatestAudits: PK_ALL_LATEST_AUDITS,

package/src/models/api-key.js

@@ -21,7 +21,7 @@ const scopeNames = ['sites.read_all', 'sites.write_all', 'organizations.read_all
 const ApiKey = (data) => {
   const self = Base(data);
 
-  self.getHashedKey = () => self.state.hashedKey;
+  self.getHashedApiKey = () => self.state.hashedApiKey;
   self.getName = () => self.state.name;
   self.getImsUserId = () => self.state.imsUserId;
   self.getImsOrgId = () => self.state.imsOrgId;
@@ -41,8 +41,8 @@ const ApiKey = (data) => {
 export const createApiKey = (data) => {
   const newState = { ...data };
 
-  if (!hasText(newState.hashedKey)) {
-    throw new Error(`Invalid Hashed Key: ${newState.hashedKey}`);
+  if (!hasText(newState.hashedApiKey)) {
+    throw new Error(`Invalid Hashed API Key: ${newState.hashedApiKey}`);
   }
 
   if (!hasText(newState.name)) {

package/src/service/api-key/accessPatterns.js

@@ -14,25 +14,26 @@ import { ApiKeyDto } from '../../dto/api-key.js';
 
 /**
  * Get ApiKey by Hashed Key
- * @param {string} hashedKey
+ * @param {string} hashedApiKey
  * @param {DynamoClient} dynamoClient
  * @param {Object} config
  * @param {Logger} log
  * @returns {Promise<ApiKeyDto>}
  */
-export const getApiKeyByHashedKey = async (hashedKey, dynamoClient, log, config) => {
-  const item = await dynamoClient.query({
+export const getApiKeyByHashedApiKey = async (hashedApiKey, dynamoClient, log, config) => {
+  const items = await dynamoClient.query({
     TableName: config.tableNameApiKeys,
-    IndexName: config.indexNameApiKeyByHashedKey,
-    KeyConditionExpression: '#hashedKey = :hashedKey',
+    IndexName: config.indexNameApiKeyByHashedApiKey,
+    KeyConditionExpression: '#hashedApiKey = :hashedApiKey',
     ExpressionAttributeNames: {
-      '#hashedKey': 'hashedKey',
+      '#hashedApiKey': 'hashedApiKey',
     },
     ExpressionAttributeValues: {
-      ':hashedKey': hashedKey,
+      ':hashedApiKey': hashedApiKey,
     },
+    Limit: 1,
   });
-  return item ? ApiKeyDto.fromDynamoItem(item) : null;
+  return items.length > 0 ? ApiKeyDto.fromDynamoItem(items[0]) : null;
 };
 
 /**

package/src/service/api-key/index.js

@@ -10,9 +10,14 @@
  * governing permissions and limitations under the License.
  */
 
-import { createNewApiKey, getApiKeyByHashedKey } from './accessPatterns.js';
+import { createNewApiKey, getApiKeyByHashedApiKey } from './accessPatterns.js';
 
 export const apiKeyFunctions = (dynamoClient, config, log) => ({
-  getApiKeyByHashedKey: (hashedKey) => getApiKeyByHashedKey(hashedKey, dynamoClient, log, config),
+  getApiKeyByHashedApiKey: (hashedApiKey) => getApiKeyByHashedApiKey(
+    hashedApiKey,
+    dynamoClient,
+    log,
+    config,
+  ),
   createNewApiKey: (apiKey) => createNewApiKey(apiKey, dynamoClient, config, log),
 });