[BD-46] feat: added Segment track for CLI scripts #2617

PKulkoRaccoonGang · 2023-09-11T15:15:37Z

Description

added Segment track for CLI scripts.

Merge Checklist

If your update includes visual changes, have they been reviewed by a designer? Send them a link to the Netlify deploy preview, if applicable.
Does your change adhere to the documented style conventions?
Do any prop types have missing descriptions in the Props API tables in the documentation site (check deploy preview)?
Were your changes tested using all available themes (see theme switcher in the header of the deploy preview, under the "Settings" icon)?
Were your changes tested in the example app?
Is there adequate test coverage for your changes?
Consider whether this change needs to reviewed/QA'ed for accessibility (a11y). If so, please add wittjeff and adamstankiewicz as reviewers on this PR.

Post-merge Checklist

Verify your changes were released to NPM at the expected version.
If you'd like, share your contribution in #show-and-tell.
🎉 🙌 Celebrate! Thanks for your contribution.

openedx-webhooks · 2023-09-11T15:15:42Z

Thanks for the pull request, @PKulkoRaccoonGang!

When this pull request is ready, tag your edX technical lead.

netlify · 2023-09-11T15:15:43Z

✅ Deploy Preview for paragon-openedx ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`cae891e`
🔍 Latest deploy log	https://app.netlify.com/sites/paragon-openedx/deploys/65425f1351afae00082d1af6
😎 Deploy Preview	https://deploy-preview-2617--paragon-openedx.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

PKulkoRaccoonGang · 2023-09-11T15:21:23Z

Waiting #2609

monteri · 2023-09-12T09:09:18Z

utils.js

@@ -0,0 +1,22 @@
+const axios = require('axios');


Since we use paragon CLI in production axios it is required to have in dependencies instead of devDependencies.

monteri · 2023-09-12T09:12:25Z

bin/paragon-scripts.js

  const executor = COMMANDS[command];

+  sendTrackInfo(command, 'trackCLICommands');


I would track only for specific command

These functions will differ only in the transmitted parameter, otherwise, the logic will remain unchanged. I think it's better to reuse the code and not duplicate it

codecov · 2023-10-30T15:37:23Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (096ffab) 93.28% compared to head (cae891e) 93.28%.
Report is 2 commits behind head on alpha.

Additional details and impacted files

@@           Coverage Diff           @@
##            alpha    #2617   +/-   ##
=======================================
  Coverage   93.28%   93.28%           
=======================================
  Files         215      215           
  Lines        3635     3635           
  Branches      898      898           
=======================================
  Hits         3391     3391           
  Misses        239      239           
  Partials        5        5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

viktorrusakov · 2023-10-31T07:48:14Z

www/netlify/functions/trackCLICommands.js

+const { v4: uuidv4 } = require('uuid');
+const Analytics = require('analytics-node');
+
+const analytics = new Analytics(process.env.SEGMENT_KEY);
+
+exports.handler = async function eventHandler(event) {
+  // Only allow POST
+  if (event.httpMethod !== 'POST') {
+    return { statusCode: 405, body: 'Method Not Allowed' };
+  }
+  const { eventName } = JSON.parse(event.body);
+  // dispatch event to Segment
+  analytics.track({
+    anonymousId: uuidv4(),
+    event: 'openedx.paragon.functions.track-cli-commands.run',
+    properties: { eventName },
+  });
+
+  return {
+    statusCode: 200,
+    body: JSON.stringify({ success: true }),
+  };
+};


I don't think you need to create another netlify function here, instead we should modify the one we have, because they do the same thing.

I would do the following

Rename this file to sendAnalyticsData.js and modify the function as follows:

exports.handler = async function eventHandler(event) { // Only allow POST if (event.httpMethod !== 'POST') { return { statusCode: 405, body: 'Method Not Allowed' }; } const { eventId, properties } = JSON.parse(event.body); // dispatch event to Segment analytics.track({ anonymousId: uuidv4(), event: eventId, properties, }); return { statusCode: 200, body: JSON.stringify({ success: true }), }; };

Keep trackGenerateComponent.js in order not to make a breaking change, old version of Paragon will still send data to this function, so wee need to keep this functionality for now. Although, we probably could reuse our new handler here to avoid code duplication, something like this (not sure if it will work):

const { handler: actualHandler } = require('./sendAnalyticsData'); exports.handler = async function eventHandler(event) { const body = JSON.parse(event.body); event.body = JSON.stringify({ ...body, eventId: 'openedx.paragon.functions.track-generate-component.created', properties: { componentName: body.componentName } }) return actualHandler(event); };

Modify sendTrackInfo function to

function sendTrackInfo(eventId, properties) { const { BASE_URL, TRACK_ANONYMOUS_ANALYTICS } = process.env; if (TRACK_ANONYMOUS_ANALYTICS) { const url = `${BASE_URL}/.netlify/functions/sendTrackData`; axios.post(url, { eventId, properties }) .then(result => { // eslint-disable-next-line no-console console.log(`Track info is successfully sent (status ${result.status})`); }).catch(error => { // eslint-disable-next-line no-console console.log(`Track info request failed (${error})`); }); } }

Then you could easily use this one function for any event you want, e.g. to track component generation you would do:

sendTrackInfo('openedx.paragon.functions.track-generate-component.created', { componentName });

to track CLI commands:

sendTrackInfo('openedx.paragon.cli-command.used', { command });

basically it will be able to handle any event you want in the future also without any modifications.

viktorrusakov · 2023-11-01T09:04:34Z

bin/paragon-scripts.js

@@ -173,6 +174,8 @@ const COMMANDS = {
  const [command, ...commandArgs] = process.argv.slice(2);
  const executor = COMMANDS[command];

+  sendTrackInfo('openedx.paragon.cli-command.used', { command });


Hmm, I think it might be a good idea to add additional info about the command, for example if it succeeded or not. What do you think about moving this code into try / catch block below and sending status of execution?
Something like:

try { await executor.executor(commandArgs); sendTrackInfo('openedx.paragon.cli-command.used', { command, status: 'success' }); } catch (error) { // eslint-disable-next-line no-console console.error(chalk.red.bold('An error occurred:', error.message)); sendTrackInfo('openedx.paragon.cli-command.used', { command, status: 'error', errorMsg: error.message }); process.exit(1); }

added, thanks

openedx-webhooks · 2023-11-09T08:15:05Z

@PKulkoRaccoonGang 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

edx-semantic-release · 2023-11-09T08:35:43Z

🎉 This PR is included in version 22.0.0-alpha.14 🎉

The release is available on:

Your semantic-release bot 📦🚀

openedx-semantic-release-bot · 2024-05-14T15:49:49Z

🎉 This PR is included in version 23.0.0-alpha.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 11, 2023

PKulkoRaccoonGang force-pushed the Peter_Kulko/segment-track-for-cli-scripts branch 3 times, most recently from 646851c to c35e0c5 Compare September 11, 2023 15:18

PKulkoRaccoonGang changed the title ~~Peter kulko/segment track for cli scripts~~ [BD-46] feat: added Segment track for CLI scripts Sep 11, 2023

openedx-webhooks added blended PR is managed through 2U's blended developmnt program and removed open-source-contribution PR author is not from Axim or 2U labels Sep 11, 2023

PKulkoRaccoonGang marked this pull request as draft September 11, 2023 15:19

PKulkoRaccoonGang mentioned this pull request Sep 11, 2023

[CLI improvements] Segment events #2543

Closed

PKulkoRaccoonGang requested a review from monteri September 11, 2023 15:30

monteri approved these changes Sep 12, 2023

View reviewed changes

monteri reviewed Sep 12, 2023

View reviewed changes

monteri self-requested a review September 12, 2023 09:12

feat: added Segment track for CLI scripts

222ab8d

PKulkoRaccoonGang force-pushed the Peter_Kulko/segment-track-for-cli-scripts branch from 584a448 to f02a941 Compare October 30, 2023 15:03

refactor: refactoring after review

cb9dcb8

PKulkoRaccoonGang force-pushed the Peter_Kulko/segment-track-for-cli-scripts branch from f02a941 to cb9dcb8 Compare October 30, 2023 15:06

PKulkoRaccoonGang marked this pull request as ready for review October 30, 2023 15:06

refactor: refactoring after review

e6ccd35

PKulkoRaccoonGang requested review from adamstankiewicz and viktorrusakov October 30, 2023 15:43

viktorrusakov reviewed Oct 31, 2023

View reviewed changes

refactor: refactoring after review

9787ccb

PKulkoRaccoonGang force-pushed the Peter_Kulko/segment-track-for-cli-scripts branch from cb9f70d to 9787ccb Compare October 31, 2023 17:13

viktorrusakov reviewed Nov 1, 2023

View reviewed changes

refactor: code refactoring

cae891e

viktorrusakov approved these changes Nov 9, 2023

View reviewed changes

viktorrusakov merged commit 9af9a64 into openedx:alpha Nov 9, 2023
10 checks passed

viktorrusakov linked an issue Nov 9, 2023 that may be closed by this pull request

[CLI improvements] Segment events #2543

Closed

edx-semantic-release added the released on @alpha label Nov 9, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[BD-46] feat: added Segment track for CLI scripts #2617

[BD-46] feat: added Segment track for CLI scripts #2617

PKulkoRaccoonGang commented Sep 11, 2023 •

edited

openedx-webhooks commented Sep 11, 2023 •

edited

netlify bot commented Sep 11, 2023 •

edited

PKulkoRaccoonGang commented Sep 11, 2023

monteri Sep 12, 2023

PKulkoRaccoonGang Oct 30, 2023

monteri Sep 12, 2023

PKulkoRaccoonGang Oct 30, 2023 •

edited

codecov bot commented Oct 30, 2023 •

edited

viktorrusakov Oct 31, 2023

PKulkoRaccoonGang Nov 1, 2023

viktorrusakov Nov 1, 2023

PKulkoRaccoonGang Nov 1, 2023

openedx-webhooks commented Nov 9, 2023

edx-semantic-release commented Nov 9, 2023

openedx-semantic-release-bot commented May 14, 2024

		const executor = COMMANDS[command];

		sendTrackInfo(command, 'trackCLICommands');

[BD-46] feat: added Segment track for CLI scripts #2617

[BD-46] feat: added Segment track for CLI scripts #2617

Conversation

PKulkoRaccoonGang commented Sep 11, 2023 • edited

Description

Merge Checklist

Post-merge Checklist

openedx-webhooks commented Sep 11, 2023 • edited

netlify bot commented Sep 11, 2023 • edited

✅ Deploy Preview for paragon-openedx ready!

PKulkoRaccoonGang commented Sep 11, 2023

monteri Sep 12, 2023

Choose a reason for hiding this comment

PKulkoRaccoonGang Oct 30, 2023

Choose a reason for hiding this comment

monteri Sep 12, 2023

Choose a reason for hiding this comment

PKulkoRaccoonGang Oct 30, 2023 • edited

Choose a reason for hiding this comment

codecov bot commented Oct 30, 2023 • edited

Codecov Report

viktorrusakov Oct 31, 2023

Choose a reason for hiding this comment

PKulkoRaccoonGang Nov 1, 2023

Choose a reason for hiding this comment

viktorrusakov Nov 1, 2023

Choose a reason for hiding this comment

PKulkoRaccoonGang Nov 1, 2023

Choose a reason for hiding this comment

openedx-webhooks commented Nov 9, 2023

edx-semantic-release commented Nov 9, 2023

openedx-semantic-release-bot commented May 14, 2024

PKulkoRaccoonGang commented Sep 11, 2023 •

edited

openedx-webhooks commented Sep 11, 2023 •

edited

netlify bot commented Sep 11, 2023 •

edited

PKulkoRaccoonGang Oct 30, 2023 •

edited

codecov bot commented Oct 30, 2023 •

edited