-
Notifications
You must be signed in to change notification settings - Fork 18
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: usage analytics report for project types status - ON HOLD - DO NOT MERGE!!! #315
Open
NetaMolcho
wants to merge
5
commits into
main
Choose a base branch
from
projectType
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+2,728
−1,683
Open
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
77 changes: 77 additions & 0 deletions
77
packages/app-studio-toolkit/src/usage-report/usage-analytics-wrapper.ts
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,77 @@ | ||
| import { | ||
| initTelemetrySettings, | ||
| BASClientFactory, | ||
| BASTelemetryClient, | ||
| } from "@sap/swa-for-sapbas-vsx"; | ||
| import { join } from "path"; | ||
| import { readFileSync } from "fs"; | ||
| import { getLogger } from "../logger/logger"; | ||
|
|
||
| type Properties = { [key: string]: string | boolean }; | ||
| type Measurements = { [key: string]: number }; | ||
| type ProjectData = { [typeName: string]: number }; | ||
|
|
||
| /** | ||
| * A Simple Wrapper for reporting usage analytics | ||
| */ | ||
| export class AnalyticsWrapper { | ||
| private static readonly EVENT_TYPES = { | ||
| PROJECT_TYPES_STATUS: "Project Types Status", | ||
| }; | ||
|
|
||
| public static getTracker(): BASTelemetryClient { | ||
| return BASClientFactory.getBASTelemetryClient(); | ||
| } | ||
|
|
||
| public static createTracker(extensionPath: string): void { | ||
| try { | ||
| const packageJsonPath = join(extensionPath, "package.json"); | ||
| const packageJson = JSON.parse(readFileSync(packageJsonPath, "utf-8")); | ||
| const vscodeExtentionFullName = `${packageJson.publisher}.${packageJson.name}`; | ||
| initTelemetrySettings(vscodeExtentionFullName, packageJson.version); | ||
| getLogger().info( | ||
| `SAP Web Analytics tracker was created for ${vscodeExtentionFullName}` | ||
| ); | ||
| } catch (error: any) { | ||
| getLogger().error(error); | ||
| } | ||
| } | ||
|
|
||
| private static report(opt: { | ||
| eventName: string; | ||
| properties: Properties; | ||
| measurements?: Measurements; | ||
| }): void { | ||
| // We want to report only if we are not in Local VSCode environment | ||
| if (process.env.LANDSCAPE_ENVIRONMENT) { | ||
| void AnalyticsWrapper.getTracker().report( | ||
| opt.eventName, | ||
| { ...opt.properties }, | ||
| { ...opt.measurements } | ||
| ); | ||
| getLogger().trace("SAP Web Analytics tracker was called", { | ||
| eventName: opt.eventName, | ||
| }); | ||
| } | ||
| } | ||
|
|
||
| public static traceProjectTypesStatus( | ||
| devSpacePackName: string, | ||
| projects: ProjectData | ||
| ): void { | ||
| try { | ||
| const eventName = AnalyticsWrapper.EVENT_TYPES.PROJECT_TYPES_STATUS; | ||
| for (const projectType in projects) { | ||
| AnalyticsWrapper.report({ | ||
| eventName, | ||
| properties: { projectType , devSpacePackName }, | ||
| measurements: { projectTypeQuantity: projects[projectType] }, | ||
| }); | ||
| } | ||
| } catch (error: any) { | ||
| getLogger().error(error); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| export { BASClientFactory, BASTelemetryClient }; |
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
133 changes: 133 additions & 0 deletions
133
packages/app-studio-toolkit/test/usage-analytics-wrapper.spec.ts
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,133 @@ | ||
| import chai from "chai"; | ||
| import sinon from "sinon"; | ||
| const { expect } = chai; | ||
|
|
||
| import { | ||
| AnalyticsWrapper, | ||
| BASClientFactory, | ||
| BASTelemetryClient, | ||
| } from "../src/usage-report/usage-analytics-wrapper"; | ||
| import * as logger from "../src/logger/logger"; | ||
|
|
||
| describe("AnalyticsWrapper", () => { | ||
| let sandbox: sinon.SinonSandbox; | ||
| let getBASTelemetryClientStub: any; | ||
| let mockClient: any; | ||
| let getLoggerStub: any; | ||
|
|
||
| beforeEach(() => { | ||
| sandbox = sinon.createSandbox(); | ||
| mockClient = sandbox.createStubInstance(BASTelemetryClient); | ||
| mockClient.report = sandbox.stub(); | ||
| getBASTelemetryClientStub = sandbox.stub( | ||
| BASClientFactory, | ||
| "getBASTelemetryClient" | ||
| ); | ||
| getBASTelemetryClientStub.returns(mockClient); | ||
|
|
||
| getLoggerStub = sandbox.stub(logger, "getLogger").returns({ | ||
| info: sandbox.stub(), | ||
| error: sandbox.stub(), | ||
| changeLevel: sandbox.stub(), | ||
| changeSourceLocationTracking: sandbox.stub(), | ||
| fatal: sandbox.stub(), | ||
| warn: sandbox.stub(), | ||
| debug: sandbox.stub(), | ||
| trace: sandbox.stub(), | ||
| getChildLogger: sandbox.stub(), | ||
| }); | ||
| }); | ||
|
|
||
| afterEach(() => { | ||
| sandbox.restore(); | ||
| }); | ||
|
|
||
| describe("getTracker", () => { | ||
| it("should return a BASTelemetryClient instance", () => { | ||
| const tracker = AnalyticsWrapper.getTracker(); | ||
| expect(tracker).to.be.an.instanceOf(BASTelemetryClient); | ||
| }); | ||
| }); | ||
|
|
||
| describe("createTracker", () => { | ||
| it("should create a tracker", () => { | ||
| const extensionPath = "."; | ||
| AnalyticsWrapper.createTracker(extensionPath); | ||
| expect( | ||
| getLoggerStub().info.calledOnceWith( | ||
| `SAP Web Analytics tracker was created for SAPOSS.app-studio-toolkit` | ||
| ) | ||
| ).to.be.true; | ||
| }); | ||
|
|
||
| it("should handle errors while creating a tracker", () => { | ||
| const extensionPath = "/wrong/path/to/extension"; | ||
| AnalyticsWrapper.createTracker(extensionPath); | ||
| expect(getLoggerStub().error.calledOnce).to.be.true; | ||
| }); | ||
| }); | ||
|
|
||
| describe("traceProjectTypesStatus", () => { | ||
| it("LANDSCAPE_ENVIRONMENT does not exist, should not report", () => { | ||
| delete process.env.LANDSCAPE_ENVIRONMENT; | ||
|
|
||
| const devSpacePackName = "devSpacePackName"; | ||
| const projects = { | ||
| "com.sap.cap": 2, | ||
| }; | ||
|
|
||
| AnalyticsWrapper.traceProjectTypesStatus(devSpacePackName, projects); | ||
| expect(mockClient.report.callCount).to.equal(0); | ||
| expect(getLoggerStub().trace.callCount).to.equal(0); | ||
| }); | ||
|
|
||
| it("should report project types status correctly", () => { | ||
| process.env.LANDSCAPE_ENVIRONMENT = "true"; | ||
|
|
||
| const devSpacePackName = "devSpacePackName"; | ||
| const projects = { | ||
| "CAP": 2, | ||
| "UI5": 1, | ||
| "Fiori Freestyle": 3, | ||
| }; | ||
|
|
||
| AnalyticsWrapper.traceProjectTypesStatus(devSpacePackName, projects); | ||
|
|
||
| expect(mockClient.report.callCount).to.equal(3); | ||
| expect( | ||
| mockClient.report.calledWith( | ||
| "Project Types Status", | ||
| { projectType: "CAP", devSpacePackName }, | ||
| { projectTypeQuantity: 2 } | ||
| ) | ||
| ).to.be.true; | ||
| expect( | ||
| mockClient.report.calledWith( | ||
| "Project Types Status", | ||
| { projectType: "UI5", devSpacePackName }, | ||
| { projectTypeQuantity: 1 } | ||
| ) | ||
| ).to.be.true; | ||
| expect( | ||
| mockClient.report.calledWith( | ||
| "Project Types Status", | ||
| { projectType: "Fiori Freestyle", devSpacePackName }, | ||
| { projectTypeQuantity: 3 } | ||
| ) | ||
| ).to.be.true; | ||
| }); | ||
|
|
||
| it("report throw error", () => { | ||
| const err = new Error("report error"); | ||
| mockClient.report.throws(err); | ||
|
|
||
| const devSpacePackName = "devSpacePackName"; | ||
| const projects = { | ||
| "CAP": 2, | ||
| }; | ||
|
|
||
| AnalyticsWrapper.traceProjectTypesStatus(devSpacePackName, projects); | ||
| expect(getLoggerStub().error.calledOnceWith(err)).to.be.true; | ||
| }); | ||
| }); | ||
| }); |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
missing the function return type