-
Notifications
You must be signed in to change notification settings - Fork 35
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Send audit log event to audit service when deployment is success * remove test endpoint * Minor code fixes and unit tests * Update service endpoints Added unit tests for 100% coverage * adding deploy and undeploy activity event * adding deploy and undeploy activity event * resetting accidental changes * added deploy undeploy for actions and web assets * final changes * added more tests * added lint * added lint * fixed failing test cases * 100% code coverage added --------- Co-authored-by: Amulya Kashyap <[email protected]> Co-authored-by: Shazron Abdullah <[email protected]>
- Loading branch information
3 people
authored
Oct 3, 2024
1 parent
26e8172
commit 32fdd10
Showing
6 changed files
with
715 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,144 @@ | ||
| /* | ||
| Copyright 2024 Adobe. All rights reserved. | ||
| This file is licensed to you 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 http://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 REPRESENTATIONS | ||
| OF ANY KIND, either express or implied. See the License for the specific language | ||
| governing permissions and limitations under the License. | ||
| */ | ||
| const fetch = require('node-fetch') | ||
| const fs = require('fs') | ||
| const path = require('path') | ||
| const chalk = require('chalk') | ||
|
|
||
| const OPERATIONS = { | ||
| AB_APP_DEPLOY: 'ab_app_deploy', | ||
| AB_APP_UNDEPLOY: 'ab_app_undeploy', | ||
| AB_APP_TEST: 'ab_app_test', // todo : remove after testing | ||
| AB_APP_ASSETS_DEPLOYED: 'ab_app_assets_deployed', | ||
| AB_APP_ASSETS_UNDEPLOYED: 'ab_app_assets_undeployed' | ||
| } | ||
|
|
||
| const AUDIT_SERVICE_ENPOINTS = { | ||
| stage: 'https://adp-auditlog-service-stage.adobeioruntime.net/api/v1/web/audit-log-api/event-post', | ||
| prod: 'https://adp-auditlog-service-prod.adobeioruntime.net/api/v1/web/audit-log-api/event-post' | ||
| } | ||
|
|
||
| /** | ||
| * Send audit log events to audit service | ||
| * @param {string} accessToken valid access token | ||
| * @param {object} logEvent logEvent details | ||
| * @param {string} env valid env stage|prod | ||
| */ | ||
| async function sendAuditLogs (accessToken, logEvent, env = 'prod') { | ||
| const url = AUDIT_SERVICE_ENPOINTS[env] | ||
| const payload = { | ||
| event: logEvent | ||
| } | ||
| const options = { | ||
| method: 'POST', | ||
| headers: { | ||
| Authorization: 'Bearer ' + accessToken, | ||
| 'Content-type': 'application/json' | ||
| }, | ||
| body: JSON.stringify(payload) | ||
| } | ||
| const response = await fetch(url, options) | ||
| if (response.status !== 200) { | ||
| const err = await response.text() | ||
| throw new Error('Failed to send audit log - ' + response.status + ' ' + err) | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * | ||
| * @param {object} flags cli flags | ||
| * @param {object} project details | ||
| * @param {string} event log name | ||
| * @returns {object} logEvent | ||
| */ | ||
| function getAuditLogEvent (flags, project, event) { | ||
| let logEvent, logStrMsg | ||
| if (project && project.org && project.workspace) { | ||
| if (event === 'AB_APP_DEPLOY') { | ||
| logStrMsg = `Starting deployment for the App Builder application in workspace ${project.workspace.name}` | ||
| } else if (event === 'AB_APP_UNDEPLOY') { | ||
| logStrMsg = `Starting undeployment for the App Builder application in workspace ${project.workspace.name}` | ||
| } else if (event === 'AB_APP_ASSETS_UNDEPLOYED') { | ||
| logStrMsg = `All static assets for the App Builder application in workspace: ${project.workspace.name} were successfully undeployed from the CDN` | ||
| } else if (event === 'AB_APP_ASSETS_DEPLOYED') { | ||
| logStrMsg = `All static assets for the App Builder application in workspace: ${project.workspace.name} were successfully deployed to the CDN.\n Files deployed - ` | ||
| } | ||
|
|
||
| logEvent = { | ||
| orgId: project.org.id, | ||
| projectId: project.id, | ||
| workspaceId: project.workspace.id, | ||
| workspaceName: project.workspace.name, | ||
| operation: event in OPERATIONS ? OPERATIONS[event] : OPERATIONS.AB_APP_TEST, | ||
| timestamp: new Date().valueOf(), | ||
| data: { | ||
| cliCommandFlags: flags, | ||
| opDetailsStr: logStrMsg | ||
| } | ||
| } | ||
| } | ||
| return logEvent | ||
| } | ||
|
|
||
| /** | ||
| * | ||
| * @param {string} directory | path to assets directory | ||
| * @returns {Array} log | array of log messages | ||
| */ | ||
| function getFilesCountWithExtension (directory) { | ||
| const log = [] | ||
|
|
||
| if (!fs.existsSync(directory)) { | ||
| this.log(chalk.red(chalk.bold(`Error: Directory ${directory} does not exist.`))) | ||
| return log | ||
| } | ||
|
|
||
| const files = fs.readdirSync(directory) | ||
|
|
||
| if (files.length === 0) { | ||
| this.log(chalk.red(chalk.bold(`Error: No files found in directory ${directory}.`))) | ||
| return log | ||
| } | ||
|
|
||
| const fileTypeCounts = {} | ||
|
|
||
| files.forEach(file => { | ||
| const ext = path.extname(file).toLowerCase() || 'no extension' | ||
| if (fileTypeCounts[ext]) { | ||
| fileTypeCounts[ext]++ | ||
| } else { | ||
| fileTypeCounts[ext] = 1 | ||
| } | ||
| }) | ||
|
|
||
| Object.keys(fileTypeCounts).forEach(ext => { | ||
| const count = fileTypeCounts[ext] | ||
| let description | ||
|
|
||
| if (ext === '.js') description = 'Javascript file(s)' | ||
| else if (ext === '.css') description = 'CSS file(s)' | ||
| else if (ext === '.html') description = 'HTML page(s)' | ||
| else if (['.png', '.jpg', '.jpeg', '.gif', '.svg', '.webp'].includes(ext)) description = 'image(s)' | ||
| else if (ext === 'no extension') description = 'file(s) without extension' | ||
| else description = `${ext} file(s)` | ||
|
|
||
| log.push(`${count} ${description}\n`) | ||
| }) | ||
|
|
||
| return log | ||
| } | ||
|
|
||
| module.exports = { | ||
| sendAuditLogs, | ||
| getAuditLogEvent, | ||
| AUDIT_SERVICE_ENPOINTS, | ||
| getFilesCountWithExtension | ||
| } |
Oops, something went wrong.