most of the code written, need to work out why the compilation error

Author: Dan Lee

definitions/example.js

@@ -1,7 +1,7 @@
 const segment = require("../");
 
 const segmentModels = segment({
-  declareSources: false,
+  declareSources: true,
   sessionTimeoutMillis: 30 * 60 * 1000,
   defaultConfig: {
     schema: "segment_package_example",
@@ -10,25 +10,32 @@ const segmentModels = segment({
   },
   customPageFields: ["url_hash", "category"],
   customUserFields: ["email", "name", "company_name", "created_at"],
+  includeScreens: false
 });
 
-declare({
-  database: "tada-analytics",
-  schema: "javascript",
-  name: "pages"
-});
+// declare({
+//   database: "tada-analytics",
+//   schema: "javascript",
+//   name: "pages"
+// });
 
-declare({
-  database: "tada-analytics",
-  schema: "javascript",
-  name: "tracks"
-});
+// declare({
+//   database: "tada-analytics",
+//   schema: "javascript",
+//   name: "screens"
+// });
 
-declare({
-  database: "tada-analytics",
-  schema: "javascript",
-  name: "identifies"
-});
+// declare({
+//   database: "tada-analytics",
+//   schema: "javascript",
+//   name: "tracks"
+// });
+
+// declare({
+//   database: "tada-analytics",
+//   schema: "javascript",
+//   name: "identifies"
+// });
 
 // Override the sessions and user table type to "table".
 segmentModels.sessions.type("table").config({

includes/common.js

@@ -2,24 +2,81 @@
 
 // From here: https://segment.com/docs/connections/spec/page/
 let PAGE_FIELDS = {
-    url: "url",
-    referrer: "referrer",
-    title: "title",
-    name: "name",
-    search: "search",
-    path: "path",
-    context_campaign_content: "utm_content",
-    context_campaign_medium: "utm_medium",
-    context_campaign_source: "utm_source",
-    context_campaign_name: "utm_campaign",
-    context_campaign_term: "utm_term"};
+  url: "url",
+  referrer: "referrer",
+  title: "title",
+  name: "name",
+  search: "search",
+  path: "path",
+  context_campaign_content: "utm_content",
+  context_campaign_medium: "utm_medium",
+  context_campaign_source: "utm_source",
+  context_campaign_name: "utm_campaign",
+  context_campaign_term: "utm_term"
+};
 
 // From here: https://segment.com/docs/connections/spec/track/
 let TRACK_FIELDS = {
   event: "event"
 };
 
+// From here: https://segment.com/docs/connections/spec/screen/
+let SCREEN_FIELDS = {
+  event: "name"
+};
+
+function allPageFields(params) {
+  const customPageFieldsObj = params.customPageFields.reduce((acc, item) => ({
+    ...acc,
+    [item]: item
+  }), {});
+  return {
+    ...PAGE_FIELDS,
+    ...customPageFieldsObj
+  };
+}
+
+function allTrackFields(params) {
+  const customTrackFieldsObj = params.customTrackFields.reduce((acc, item) => ({
+    ...acc,
+    [item]: item
+  }), {});
+  return {
+    ...TRACK_FIELDS,
+    ...customTrackFieldsObj
+  };
+}
+
+function allScreenFields(params) {
+  const customScreenFieldsObj = params.customScreenFields.reduce((acc, item) => ({
+    ...acc,
+    [item]: item
+  }), {});
+  return {
+    ...SCREEN_FIELDS,
+    ...customScreenFieldsObj
+  };
+}
+
+function enabledEvents(params) {
+  const events = [];
+
+  if (params.includeTracks) {
+    events.push("track");
+  }
+  if (params.includePages) {
+    events.push("page");
+  }
+  if (params.includeScreens) {
+    events.push("screen");
+  }
+
+  return events;
+}
+
 module.exports = {
-  PAGE_FIELDS,
-  TRACK_FIELDS
-}
+  allTrackFields,
+  allPageFields,
+  allScreenFields,
+  enabledEvents
+}

includes/page_events.js

@@ -2,21 +2,17 @@ const segmentCommon = require("./common");
 
 module.exports = (params) => {
 
-  const customPageFieldsObj = params.customPageFields.reduce((acc, item) => ({...acc, [item]: item }), {});
-
-  const customTrackFieldsObj = params.customTrackFields.reduce((acc, item) => ({...acc, [item]: item }), {});
-
   return publish("segment_page_events", {
     ...params.defaultConfig
   }).query(ctx => `
 
--- format page calls into a format suitable to join with track calls
+-- format page calls into a format suitable to join with all other events
 select distinct
   pages.timestamp,
   user_id,
   anonymous_id,
   id as page_id,
-  ${Object.entries({...segmentCommon.PAGE_FIELDS, ...customPageFieldsObj}).map(
+  ${Object.entries(segmentCommon.allPageFields(params)).map(
       ([key, value]) => `${key} as ${value}`).join(",\n    ")}
 from
   ${ctx.ref(params.segmentSchema, "pages")} as pages

includes/screen_events.js

@@ -0,0 +1,21 @@
+const segmentCommon = require("./common");
+
+module.exports = (params) => {
+
+  return publish("segment_screen_events", {
+    ...params.defaultConfig
+  }).query(ctx => `
+
+-- format screen calls into a format suitable to join with other events
+select distinct
+  screens.timestamp,
+  user_id,
+  anonymous_id,
+  id as screen_id,
+  ${Object.entries(segmentCommon.allScreenFields(params)).map(
+      ([key, value]) => `${key} as ${value}`).join(",\n    ")}
+from
+  ${ctx.ref(params.segmentSchema, "screens")} as screens
+
+`)
+}

includes/sessionized_events.js

@@ -1,4 +1,5 @@
 const crossdb = require("./crossdb");
+const segmentCommon = require("./common");
 
 module.exports = (params) => {
 
@@ -7,24 +8,16 @@ module.exports = (params) => {
   }).query(ctx => `
 
 with segment_events_combined as (
--- combine page and track tables into a full events table
-select
-  track_events.timestamp,
-  user_id,
-  anonymous_id,
-  track_id,
-  null as page_id
-from 
-  ${params.segmentSchema, ctx.ref("segment_track_events")} as track_events
-union all
-select
-  page_events.timestamp,
+-- combine all enabled events tables into one combined events tables
+${segmentCommon.enabledEvents(params).map((event) => 
+`select
+  ${event}_events.timestamp,
   user_id,
   anonymous_id,
-  null as track_id,
-  page_id
+  ${segmentCommon.enabledEvents(params).map((event_id) => 
+  `${event==event_id ? `` : `null as `}${event_id}_id`).join(`,\n  `)}
 from 
-  ${params.segmentSchema, ctx.ref("segment_page_events")} as page_events
+  ${params.segmentSchema, ctx.ref(`segment_${event}_events`)} as ${event}_events`).join(`\nunion all \n`)}
 ),
 
 segment_events_mapped as (
@@ -36,8 +29,7 @@ select
     segment_user_anonymous_map.user_id,
     segment_events_combined.anonymous_id
   ) as user_id,
-  track_id,
-  page_id
+  ${segmentCommon.enabledEvents(params).map((event) => `${event}_id`).join(`,\n  `)}
 from
   segment_events_combined
   left join ${ctx.ref(params.defaultConfig.schema, "segment_user_map")} as segment_user_anonymous_map

includes/sessionized_pages.js

@@ -2,22 +2,18 @@ const segmentCommon = require("./common");
 
 module.exports = (params) => {
 
-  const customPageFieldsObj = params.customPageFields.reduce((acc, item) => ({...acc, [item]: item }), {});
-
-  const customTrackFieldsObj = params.customTrackFields.reduce((acc, item) => ({...acc, [item]: item }), {});
-  
   return publish("segment_sessionized_pages", {
     ...params.defaultConfig
   }).query(ctx => `
 
--- annotate track records with session details
+-- annotate page records with session details
 select
   segment_sessionized_events.timestamp,
   segment_sessionized_events.user_id,
   segment_sessionized_events.page_id,
   segment_sessionized_events.session_index,
   segment_sessionized_events.session_id,
-  ${Object.entries({...segmentCommon.PAGE_FIELDS, ...customPageFieldsObj}).map(
+  ${Object.entries(segmentCommon.allPageFields(params)).map(
       ([key, value]) => `segment_page_events.${value}`).join(",\n  ")}
 from 
   ${params.segmentSchema, ctx.ref("segment_sessionized_events")} as segment_sessionized_events

includes/sessionized_screens.js

@@ -0,0 +1,26 @@
+const segmentCommon = require("./common");
+
+module.exports = (params) => {
+
+  return publish("segment_sessionized_screens", {
+    ...params.defaultConfig
+  }).query(ctx => `
+
+-- annotate screen records with session details
+select
+  segment_sessionized_events.timestamp,
+  segment_sessionized_events.user_id,
+  segment_sessionized_events.screen_id,
+  segment_sessionized_events.session_index,
+  segment_sessionized_events.session_id,
+  ${Object.entries(segmentCommon.allScreenFields(params)).map(
+      ([key, value]) => `segment_screen_events.${value}`).join(",\n  ")}
+from 
+  ${params.segmentSchema, ctx.ref("segment_sessionized_events")} as segment_sessionized_events
+  left join ${params.segmentSchema, ctx.ref("segment_screen_events")} as segment_screen_events
+    on segment_sessionized_events.screen_id = segment_screen_events.screen_id
+where
+  segment_sessionized_events.screen_id is not null
+
+`)
+}

includes/sessionized_tracks.js

@@ -2,10 +2,6 @@ const segmentCommon = require("./common");
 
 module.exports = (params) => {
 
-  const customPageFieldsObj = params.customPageFields.reduce((acc, item) => ({...acc, [item]: item }), {});
-
-  const customTrackFieldsObj = params.customTrackFields.reduce((acc, item) => ({...acc, [item]: item }), {});
-
   return publish("segment_sessionized_tracks", {
     ...params.defaultConfig
   }).query(ctx => `
@@ -17,7 +13,7 @@ select
   segment_sessionized_events.track_id,
   segment_sessionized_events.session_index,
   segment_sessionized_events.session_id,
-  ${Object.entries({...segmentCommon.TRACK_FIELDS, ...customTrackFieldsObj}).map(
+  ${Object.entries(segmentCommon.allTrackFields(params)).map(
       ([key, value]) => `segment_track_events.${value}`).join(",\n  ")}
 from 
   ${params.segmentSchema, ctx.ref("segment_sessionized_events")} as segment_sessionized_events