Skip to content

Add option to choose a custom bucket #759

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.

Sign up for GitHub

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

Merged
merged 8 commits into from
Jul 18, 2023
Merged

Add option to choose a custom bucket #759

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
0116f93
Add option to choose a custom bucket
paco-walkme Jun 1, 2023
90d1366
fix typo
paco-walkme Jun 1, 2023
42ad08e
forcing use the `bucket` option
paco-walkme Jun 1, 2023
2388376
update literal to friendly name
paco-walkme Jun 14, 2023
099020d
fix typo
paco-walkme Jul 5, 2023
168ebb0
fix typo
varadarajan-tw Jul 5, 2023
e9878ae
fix: dont use ES6
paco-walkme Jul 12, 2023
9f9f0f3
change customDirectory option name to customDirecotry as in partner p…
varadarajan-tw Jul 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions integrations/walkme/lib/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ var WalkMe = module.exports = integration('WalkMe')
.option('trackWalkMeEvents', false)
.option('loadWalkMeInIframe', false)
.option('integrityHash', '')
.option('customDirecotry', 'users')
.tag('<script async="true" src="{{ url }}" crossorigin="" integrity="{{ hash }}">')

/**
Expand All @@ -37,7 +38,7 @@ WalkMe.prototype.initialize = function() {
window.walkme_load_in_iframe = true;
}

var env = "\/" + (this.options.environment && this.options.environment.toLowerCase());
var env = (this.options.environment && this.options.environment.toLowerCase());

if (!env || env == "\/" || env == "\/production") {
env = "";
Expand Down Expand Up @@ -67,7 +68,8 @@ WalkMe.prototype.initialize = function() {
sriSuffix = 'private_';
}

var url = 'https://cdn.walkme.com/users/' + walkMeSystemId + env + '/walkme_' + sriSuffix + walkMeSystemId + '_https.js';
var bucket = (this.options.customDirecotry) ? this.options.customDirecotry : 'users';
var url = 'https://cdn.walkme.com/' + bucket + '/' + walkMeSystemId + '/' + env + '/walkme_' + sriSuffix + walkMeSystemId + '_https.js';

this.load({
url,
Expand Down
43 changes: 40 additions & 3 deletions integrations/walkme/test/index.test.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ describe('WalkMe', function() {
environment: 'test',
trackWalkMeEvents: false,
loadWalkMeInIframe: true,
integrityHash: ''
integrityHash: '',
customDirecotry: '',
};

beforeEach(function() {
Expand Down Expand Up @@ -46,6 +47,7 @@ describe('WalkMe', function() {
.option('trackWalkMeEvents', false)
.option('loadWalkMeInIframe', false)
.option('integrityHash', '')
.option('customDirecotry', 'users')
);
});

Expand Down Expand Up @@ -133,8 +135,43 @@ describe('WalkMe', function() {
done();
};

walkme.options.walkMeSystemId = '42b2849a0ca54749bd485bcbd5bcc64e';
walkme.options.integrityHash = 'sha256-FjbibNOUzdIz+mtyFRU7NHj1G5tPgzOuJNCkRyDmXr8=';
walkme.options.walkMeSystemId = walkMeSystemId;
walkme.options.integrityHash = integrityHash;

analytics.load(walkme, function() {
analytics.loaded(tag);
});
} catch (e) {
done(e);
}
}).timeout(10000);

it('should setup bucket', function(done) {
try {
var walkMeSystemId = '42b2849a0ca54749bd485bcbd5bcc64e';
var integrityHash = 'sha256-FjbibNOUzdIz+mtyFRU7NHj1G5tPgzOuJNCkRyDmXr8=';
var bucket = 'users';

var tag = fmt(
'<script src="https://cdn.walkme.com/%s/%s/%s/walkme_%s_https.js" crossorigin="" >',
bucket,
walkMeSystemId,
'test',
walkMeSystemId
);

window.walkme_ready = function() {
analytics.assert(
!!window.WalkMeAPI,
'Expected WalkMeAPI to be present on the page'
);

done();
};

walkme.options.walkMeSystemId = walkMeSystemId;
walkme.options.integrityHash = integrityHash;
walkme.options.customDirecotry = bucket;

analytics.load(walkme, function() {
analytics.loaded(tag);
Expand Down