Skip to content
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

Jump to bottom

feat!: modify delayLoad functionality #17

Merged
merged 22 commits into from Nov 29, 2022
Merged

feat!: modify delayLoad functionality #17

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
1eb31bf
feat: delayLoad functionaliy modified and loadOptions support added
MoumitaM Nov 18, 2022
c742c33
Update src/gatsby-ssr.js
MoumitaM Nov 18, 2022
9d82636
Update src/gatsby-ssr.js
MoumitaM Nov 18, 2022
245f2f2
refactor: delayload logic
MoumitaM Nov 18, 2022
c61c14d
Update gatsby-ssr.js
MoumitaM Nov 23, 2022
567f458
Update gatsby-ssr.js
MoumitaM Nov 23, 2022
3979180
Update gatsby-ssr.js
MoumitaM Nov 23, 2022
bbe8d75
refactor: sdkSrc logic
MoumitaM Nov 23, 2022
ecf49e0
Version bumped
MoumitaM Nov 23, 2022
fd7aa5a
chore: upgrade babel dependencies
saikumarrs Nov 23, 2022
fece2f5
fix: stop mutating loadOptions input
saikumarrs Nov 23, 2022
2c33aff
refactor: remove unused option
saikumarrs Nov 23, 2022
9eb5987
refactor: plugin options
saikumarrs Nov 23, 2022
48acb9d
chore: package-lock updated
MoumitaM Nov 23, 2022
2182a15
Merge branch 'chore/loadType-syntax-update' of github.com:rudderlabs/…
MoumitaM Nov 23, 2022
de8fa39
doc: updated readme
MoumitaM Nov 24, 2022
a225d2e
doc: updated readme
MoumitaM Nov 24, 2022
2c14b84
doc: updated readme
MoumitaM Nov 24, 2022
931e848
Update README.md
MoumitaM Nov 25, 2022
aa17236
Update README.md
MoumitaM Nov 25, 2022
92df434
Update README.md
MoumitaM Nov 25, 2022
2b70e07
doc: readme updated
MoumitaM Nov 25, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
32 changes: 16 additions & 16 deletions gatsby-ssr.js
View file
Open in desktop
Expand Up @@ -18,39 +18,39 @@ exports.onRenderBody = function (_ref, pluginOptions) {
delayLoadTime = pluginOptions.delayLoadTime,
manualLoad = pluginOptions.manualLoad,
loadType = pluginOptions.loadType,
useNewSDK = pluginOptions.useNewSDK,
sdkURL = pluginOptions.sdkURL,
useBetaSDK = pluginOptions.useBetaSDK,
_pluginOptions$loadOp = pluginOptions.loadOptions,
loadOptions = _pluginOptions$loadOp === undefined ? {} : _pluginOptions$loadOp;


var sdkSrc = "https://cdn.rudderlabs.com/v1/rudder-analytics.min.js";
if (sdkURL) sdkSrc = sdkURL;else if (useBetaSDK) {
sdkSrc = "https://cdn.rudderlabs.com/v1.1/beta/rudder-analytics.min.js";
} else if (useNewSDK) {
sdkSrc = "https://cdn.rudderlabs.com/v1.1/rudder-analytics.min.js";
}
var sdkSrc = "https://cdn.rudderlabs.com/v1.1/rudder-analytics.min.js";
if (sdkURL) sdkSrc = sdkURL;
MoumitaM marked this conversation as resolved.
Show resolved Hide resolved

if (!prodKey || prodKey.length < 10) console.error("Your RudderStack prodKey must be at least 10 char in length.");

if (devKey && devKey.length < 10) console.error("If present, your RudderStack devKey must be at least 10 char in length.");

var writeKey = process.env.NODE_ENV === "production" ? prodKey : devKey;

if (controlPlaneUrl) {
loadOptions.configUrl = controlPlaneUrl;
}
loadOptions.configUrl = controlPlaneUrl || loadOptions.configUrl;
MoumitaM marked this conversation as resolved.
Show resolved Hide resolved

var loadConfig = "'" + writeKey + "', '" + dataPlaneUrl + "'," + JSON.stringify(loadOptions);
var loadConfig = "'" + writeKey + "', '" + dataPlaneUrl + "', " + JSON.stringify(loadOptions);
MoumitaM marked this conversation as resolved.
Show resolved Hide resolved

var scriptTagStr = "var s = document.createElement(\"script\");\n s.type = \"text/javascript\";\n s.src = \"" + sdkSrc + "\";";
if (loadType === "async") {
scriptTagStr += "s.async = true;";
} else if (loadType === "defer") {
scriptTagStr += "s.defer = true;";
}
scriptTagStr += "document.head.appendChild(s);";

var snippet = "rudderanalytics=window.rudderanalytics=[];for(var methods=[\"load\",\"page\",\"track\",\"identify\",\"alias\",\"group\",\"ready\",\"reset\",\"getAnonymousId\",\"setAnonymousId\"],i=0;i<methods.length;i++){var method=methods[i];rudderanalytics[method]=function(a){return function(){rudderanalytics.push([a].concat(Array.prototype.slice.call(arguments)))}}(method)}\n var s = document.createElement(\"script\");\n s.type = \"text/javascript\";\n s.src = \"" + sdkSrc + "\";\n if (\"" + loadType + "\" == \"async\") {\n s.async = true;\n } else if (\"" + loadType + "\" == \"defer\") {\n s.defer = true;\n }\n document.head.appendChild(s);\n";
var snippet = "rudderanalytics=window.rudderanalytics=[];for(var methods=[\"load\",\"page\",\"track\",\"identify\",\"alias\",\"group\",\"ready\",\"reset\",\"getAnonymousId\",\"setAnonymousId\"],i=0;i<methods.length;i++){var method=methods[i];rudderanalytics[method]=function(a){return function(){rudderanalytics.push([a].concat(Array.prototype.slice.call(arguments)))}}(method)}\n " + scriptTagStr + "\n";

var instantLoad = "" + snippet + (delayLoad || manualLoad ? "" : "rudderanalytics.load(" + loadConfig + ")") + ";";
var instantLoader = "" + snippet + (delayLoad || manualLoad ? "" : "rudderanalytics.load(" + loadConfig + ")") + ";";

var delayedLoader = "\n window.rudderSnippetLoaded = false;\n window.rudderSnippetLoading = false;\n window.rudderSnippetLoadedCallback = undefined;\n window.rudderSnippetLoader = function (callback) {\n if (!window.rudderSnippetLoaded && !window.rudderSnippetLoading) {\n window.rudderSnippetLoading = true;\n " + snippet + "\n function loader() {\n window.rudderanalytics.load(" + loadConfig + ");\n window.rudderSnippetLoading = false;\n window.rudderSnippetLoaded = true;\n if (callback) { callback(); }\n if (window.rudderSnippetLoadedCallback) {\n window.rudderSnippetLoadedCallback();\n window.rudderSnippetLoadedCallback = undefined;\n }\n };\n\n \"requestIdleCallback\" in window\n ? requestIdleCallback(function () { loader(); })\n : loader();\n }\n }\n window.addEventListener('scroll',function () {window.rudderSnippetLoader()}, { once: true });\n setTimeout(\n function () {\n \"requestIdleCallback\" in window\n ? requestIdleCallback(function () { window.rudderSnippetLoader(); })\n : window.rudderSnippetLoader();\n },\n " + delayLoadTime + " || 1000\n );\n ";
var delayedLoader = "\n window.rudderSnippetLoaded = false;\n window.rudderSnippetLoading = false;\n window.rudderSnippetLoadedCallback = undefined;\n window.rudderSnippetLoader = function (callback) {\n if (!window.rudderSnippetLoaded && !window.rudderSnippetLoading) {\n window.rudderSnippetLoading = true;\n function loader() {\n " + snippet + "\n window.rudderanalytics.load(" + loadConfig + ");\n window.rudderSnippetLoading = false;\n window.rudderSnippetLoaded = true;\n if (callback) { callback(); }\n if (window.rudderSnippetLoadedCallback) {\n window.rudderSnippetLoadedCallback();\n window.rudderSnippetLoadedCallback = undefined;\n }\n };\n\n \"requestIdleCallback\" in window\n ? requestIdleCallback(function () { loader(); })\n : loader();\n }\n }\n window.addEventListener('scroll',function () {window.rudderSnippetLoader()}, { once: true });\n setTimeout(\n function () {\n \"requestIdleCallback\" in window\n ? requestIdleCallback(function () { window.rudderSnippetLoader(); })\n : window.rudderSnippetLoader();\n },\n " + delayLoadTime + " || 1000\n );\n ";

var snippetToUse = "" + (delayLoad && !manualLoad ? delayedLoader : instantLoad);
var snippetToUse = "" + (delayLoad && !manualLoad ? delayedLoader : instantLoader);

if (writeKey) {
var tags = [_react2.default.createElement("script", {
Expand Down
42 changes: 18 additions & 24 deletions src/gatsby-ssr.js
View file
Open in desktop
Expand Up @@ -11,19 +11,12 @@ exports.onRenderBody = ({ setHeadComponents }, pluginOptions) => {
delayLoadTime,
manualLoad,
loadType,
useNewSDK,
sdkURL,
useBetaSDK,
loadOptions = {},
} = pluginOptions;

var sdkSrc = "https://cdn.rudderlabs.com/v1/rudder-analytics.min.js";
var sdkSrc = "https://cdn.rudderlabs.com/v1.1/rudder-analytics.min.js";
if (sdkURL) sdkSrc = sdkURL;
else if (useBetaSDK) {
sdkSrc = "https://cdn.rudderlabs.com/v1.1/beta/rudder-analytics.min.js";
} else if (useNewSDK) {
sdkSrc = "https://cdn.rudderlabs.com/v1.1/rudder-analytics.min.js";
}

// ensures RudderStack production write key is present
if (!prodKey || prodKey.length < 10)
Expand All @@ -41,25 +34,26 @@ exports.onRenderBody = ({ setHeadComponents }, pluginOptions) => {
// note below, snippet wont render unless writeKey is truthy
const writeKey = process.env.NODE_ENV === "production" ? prodKey : devKey;

if (controlPlaneUrl) {
loadOptions.configUrl = controlPlaneUrl;
}
// Override config URL if provided separately
loadOptions.configUrl = controlPlaneUrl || loadOptions.configUrl;

const loadConfig = `'${writeKey}', '${dataPlaneUrl}',` + JSON.stringify(loadOptions);
const loadConfig = `'${writeKey}', '${dataPlaneUrl}', ${JSON.stringify(loadOptions)}`;

const snippet = `rudderanalytics=window.rudderanalytics=[];for(var methods=["load","page","track","identify","alias","group","ready","reset","getAnonymousId","setAnonymousId"],i=0;i<methods.length;i++){var method=methods[i];rudderanalytics[method]=function(a){return function(){rudderanalytics.push([a].concat(Array.prototype.slice.call(arguments)))}}(method)}
var s = document.createElement("script");
let scriptTagStr = `var s = document.createElement("script");
s.type = "text/javascript";
s.src = "${sdkSrc}";
if ("${loadType}" == "async") {
s.async = true;
} else if ("${loadType}" == "defer") {
s.defer = true;
}
document.head.appendChild(s);
s.src = "${sdkSrc}";`;
if (loadType === "async") {
scriptTagStr += "s.async = true;";
} else if (loadType === "defer") {
scriptTagStr += "s.defer = true;";
}
scriptTagStr += "document.head.appendChild(s);";

const snippet = `rudderanalytics=window.rudderanalytics=[];for(var methods=["load","page","track","identify","alias","group","ready","reset","getAnonymousId","setAnonymousId"],i=0;i<methods.length;i++){var method=methods[i];rudderanalytics[method]=function(a){return function(){rudderanalytics.push([a].concat(Array.prototype.slice.call(arguments)))}}(method)}
${scriptTagStr}
`;

const instantLoad = `${snippet}${delayLoad || manualLoad ? `` : `rudderanalytics.load(${loadConfig})`};`;
const instantLoader = `${snippet}${delayLoad || manualLoad ? `` : `rudderanalytics.load(${loadConfig})`};`;

const delayedLoader = `
window.rudderSnippetLoaded = false;
Expand All @@ -68,8 +62,8 @@ const instantLoad = `${snippet}${delayLoad || manualLoad ? `` : `rudderanalytics
window.rudderSnippetLoader = function (callback) {
if (!window.rudderSnippetLoaded && !window.rudderSnippetLoading) {
window.rudderSnippetLoading = true;
${snippet}
function loader() {
${snippet}
window.rudderanalytics.load(${loadConfig});
window.rudderSnippetLoading = false;
window.rudderSnippetLoaded = true;
Expand Down Expand Up @@ -97,7 +91,7 @@ const instantLoad = `${snippet}${delayLoad || manualLoad ? `` : `rudderanalytics
`;

// if `delayLoad` option is true, use the delayed loader
const snippetToUse = `${delayLoad && !manualLoad ? delayedLoader : instantLoad}`;
const snippetToUse = `${delayLoad && !manualLoad ? delayedLoader : instantLoader}`;

// only render snippet if write key exists
if (writeKey) {
Expand Down