fix: add tokowaka client #1025
fix: add tokowaka client #1025
Conversation
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
|
This PR will trigger a patch release when merged. |
| const response = await this.client.send(command); | ||
| const invalidation = response.Invalidation; | ||
|
|
||
| this.log.info(`CloudFront cache invalidation initiated: ${invalidation.Id}`); |
There was a problem hiding this comment.
lets also log the time to invalidate the cache
| * @private | ||
| */ | ||
| #initializeClient() { | ||
| /* c8 ignore start */ |
There was a problem hiding this comment.
lets use nock to. mock the cdn requests.
There was a problem hiding this comment.
used aws-sdk-client-mock, nock faces some issues with aws clients.
| import { S3Client } from '@aws-sdk/client-s3'; | ||
|
|
||
| export interface TokawakaPatch { | ||
| op: 'replace' | 'add' | 'prerender'; |
There was a problem hiding this comment.
replace
appendChild
insertBefore
insertAfter
|
|
||
| export interface TokawakaPatch { | ||
| op: 'replace' | 'add' | 'prerender'; | ||
| selector?: string; |
There was a problem hiding this comment.
Updated index.d.ts
| selector?: string; | ||
| value?: string; | ||
| attribute?: string; | ||
| element?: string; |
There was a problem hiding this comment.
Updated index.d.ts
| /** | ||
| * Akamai CDN client implementation | ||
| */ | ||
| export class AkamaiCdnClient extends BaseCdnClient { |
There was a problem hiding this comment.
lets remove AkamaiCdnClient. its not required.
There was a problem hiding this comment.
Updated index.d.ts
| return s3Path; | ||
| } catch (error) { | ||
| this.log.error(`Failed to upload Tokowaka config to S3: ${error.message}`, error); | ||
| throw this.#createError(`S3 upload failed: ${error.message}`, HTTP_INTERNAL_SERVER_ERROR); |
There was a problem hiding this comment.
for displaying error in UI, we should not highlight internal impl details like S3.
There was a problem hiding this comment.
This error is not going to the UI, in case of unexpected errors - UI will get "Deployment failed - Internal Server Error"
| this.log.info(`CDN cache invalidation completed: ${JSON.stringify(result)}`); | ||
| return result; | ||
| } catch (error) { | ||
| this.log.error(`Failed to invalidate CDN cache: ${error.message}`, error); |
| const newConfig = this.generateConfig(site, opportunity, eligibleSuggestions); | ||
|
|
||
| if (Object.keys(newConfig.tokowakaOptimizations).length === 0) { | ||
| this.log.warn(''); |
Introduces a new API for deploying LLMO Opportunity suggestions on Edge (Project Tokowaka).
Implementation details are captured in https://wiki.corp.adobe.com/display/AEMSites/Tokowaka+-+Spacecat+Integration and https://wiki.corp.adobe.com/display/AEMSites/Tokowaka+Spacecat+Integration+-+Implementation+Internals.
Briefly, the API first fetches LLMO opportunity - Empty Headings for first iteration, generates a json patch config, uploads on S3, and invalidates the Tokowaka Cloudfront CDN cache.
The API is expected to be called from LLMO UI when the user clicks on deploy suggestion button.