mudhorn/n8n
1
0
Fork 0
mirror of https://github.com/n8n-io/n8n.git synced 2025-01-11 21:07:28 -08:00
Code Issues Actions Packages Projects Releases Wiki Activity

fix(editor): Defer User saved credentials telemetry event for OAuth credentials (#10215)

Browse source
This commit is contained in:
Iván Ovejero 2024-07-29 11:01:18 +02:00 committed by GitHub
parent c0e37439a8
commit 40a5226e24
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 35 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

41
packages/editor-ui/src/components/CredentialEdit/CredentialEdit.vue
View file

@ -751,6 +751,12 @@ async function testCredential(credentialDetails: ICredentialsDecrypted) {
scrollToTop(); scrollToTop();
} }
function usesExternalSecrets(data: Record<string, unknown>): boolean {
return Object.entries(data).some(
([, value]) => typeof value !== 'object' && /=.*\{\{[^}]*\$secrets\.[^}]+}}.*/.test(`${value}`),
);
}
async function saveCredential(): Promise<ICredentialsResponse | null> { async function saveCredential(): Promise<ICredentialsResponse | null> {
if (!requiredPropertiesFilled.value) { if (!requiredPropertiesFilled.value) {
showValidationWarning.value = true; showValidationWarning.value = true;
@ -844,18 +850,13 @@ async function saveCredential(): Promise<ICredentialsResponse | null> {
testedSuccessfully.value = false; testedSuccessfully.value = false;
} }
const usesExternalSecrets = Object.entries(credentialDetails.data ?? {}).some(
([, value]) =>
typeof value !== 'object' && /=.*\{\{[^}]*\$secrets\.[^}]+}}.*/.test(`${value}`),
);
const trackProperties: ITelemetryTrackProperties = { const trackProperties: ITelemetryTrackProperties = {
credential_type: credentialDetails.type, credential_type: credentialDetails.type,
workflow_id: workflowsStore.workflowId, workflow_id: workflowsStore.workflowId,
credential_id: credential.id, credential_id: credential.id,
is_complete: !!requiredPropertiesFilled.value, is_complete: !!requiredPropertiesFilled.value,
is_new: isNewCredential, is_new: isNewCredential,
uses_external_secrets: usesExternalSecrets, uses_external_secrets: usesExternalSecrets(credentialDetails.data ?? {}),
}; };
if (isOAuthType.value) { if (isOAuthType.value) {
@ -872,7 +873,15 @@ async function saveCredential(): Promise<ICredentialsResponse | null> {
trackProperties.authError = authError.value; trackProperties.authError = authError.value;
} }
/**
* For non-OAuth credentials we track saving on clicking the `Save` button, but for
* OAuth credentials we track saving at the end of the flow (BroastcastChannel event)
* so that the `is_valid` property is correct.
*/
if (!isOAuthType.value) {
telemetry.track('User saved credentials', trackProperties); telemetry.track('User saved credentials', trackProperties);
}
await externalHooks.run('credentialEdit.saveCredential', trackProperties); await externalHooks.run('credentialEdit.saveCredential', trackProperties);
} }
@ -1050,7 +1059,25 @@ async function oAuthCredentialAuthorize() {
const oauthChannel = new BroadcastChannel('oauth-callback'); const oauthChannel = new BroadcastChannel('oauth-callback');
const receiveMessage = (event: MessageEvent) => { const receiveMessage = (event: MessageEvent) => {
if (event.data === 'success') { const successfullyConnected = event.data === 'success';
const trackProperties: ITelemetryTrackProperties = {
credential_type: credentialTypeName.value,
workflow_id: workflowsStore.workflowId,
credential_id: credentialId.value,
is_complete: !!requiredPropertiesFilled.value,
is_new: props.mode === 'new' && !credentialId.value,
is_valid: successfullyConnected,
uses_external_secrets: usesExternalSecrets(credentialData.value),
};
if (ndvStore.activeNode) {
trackProperties.node_type = ndvStore.activeNode.type;
}
telemetry.track('User saved credentials', trackProperties);
if (successfullyConnected) {
oauthChannel.removeEventListener('message', receiveMessage); oauthChannel.removeEventListener('message', receiveMessage);
// Set some kind of data that status changes. // Set some kind of data that status changes.