configs for the multiple user session

Author: xieguigang

R/application/hook.R

@@ -5,7 +5,8 @@
 #' @details the application module will be add to the ``context$workflow`` tuple list.
 #' 
 const hook = function(app) {
-    const context   = .get_context();
+    const ssid      = NULL;
+    const context   = .get_context(ssid);
     const pool      = context$workflow;
     const symbolMap = context$symbols;
     const verbose   = as.logical(getOption("verbose"));
@@ -44,7 +45,7 @@ const hook = function(app) {
     context$symbols  = symbolMap; 
 
     # update the global context symbol
-    set(globalenv(), __global_ctx, context);
+    set(globalenv(), paste([ __global_ctx,ssid],sep="-"), context);
 
     invisible(NULL);
 }

R/context/context.R

@@ -2,6 +2,7 @@
 #'
 #' @param outputdir the directory path to the workflow analysis workspace,
 #'    default path value is current directory.
+#' @param ssid the session id for multiple user environment, default NULL means global user environment
 #' 
 #' @return this function has no return value. and the constructed 
 #'   analysis environment context object will be saved in the 
@@ -24,7 +25,7 @@
 #'                ``app`` function. 
 #'   6. pipeline: a character vector for run the application workflow.
 #' 
-const init_context = function(outputdir = "./") {
+const init_context = function(outputdir = "./", ssid = NULL) {
     const analysis_output = normalizePath(`${outputdir}/analysis/`);
     const temp_dir = normalizePath(`${outputdir}/tmp/`);
     const context = list(
@@ -38,18 +39,19 @@ const init_context = function(outputdir = "./") {
     );
 
     sink(file = `${temp_dir}/run_analysis-${get_timestamp()}.log`);
-    set(globalenv(), __global_ctx, context);
+    set(globalenv(), paste([__global_ctx,ssid], sep = "-"), context);
 
     invisible(NULL);
 }
 
 #' create an in-memory context object just used for run debug
 #' 
+#' @param ssid the session id for multiple user environment, default NULL means global user environment
 #' @param mounts should be a callable function for mounts the 
 #'    application modules into the workflow registry.
 #' 
-const create_memory_context = function(mounts = NULL) {
-    set(globalenv(), __global_ctx, list(
+const create_memory_context = function(mounts = NULL,ssid = NULL) {
+    set(globalenv(), paste( [__global_ctx,ssid], sep ="-"), list(
         root     = NULL,  # set all workspace to empty
         analysis = NULL,
         temp_dir = NULL,
@@ -68,11 +70,13 @@ const __global_ctx = "&[workflow_render]";
 
 #' get current workflow environment context
 #' 
+#' @param ssid the session id for multiple user environment, default NULL means global user environment
+#' 
 #' @return the context object which is generated via the 
 #'    ``init_context`` function.
 #'
-const .get_context = function() {
-    const workflow_render as string = __global_ctx;
+const .get_context = function(ssid = NULL) {
+    const workflow_render as string = paste([__global_ctx, ssid], sep = "-");
 
     if (exists(workflow_render, globalenv())) {
         get(workflow_render, globalenv());

R/context/workspace.R

@@ -3,16 +3,17 @@
 #' 
 #' @param app the app list object or just the app name its 
 #'    character text value.
-#'
+#' @param ssid the session id for multiple user environment, default NULL means global user environment
+#' 
 #' @return a character vector of the workspace directory path
 #'    of the specific analysis application. 
 #' 
 #' @details the verbose option could be config from the 
 #'    commandline option: ``--verbose``
 #'
-const workspace = function(app) {
+const workspace = function(app, ssid = NULL) {
     const verbose   = as.logical(getOption("verbose"));
-    const context   = .get_context();
+    const context   = .get_context(ssid);
     const temp_root = context$temp_dir;
     const app_name  = get_app_name(app);
     const workdir   = normalizePath(`${temp_root}/workflow_tmp/${app_name}/`);
@@ -42,42 +43,47 @@ const workspace = function(app) {
 #'    1. app tuple list object, which is created via the ``app`` function.
 #'    2. the app name character vector
 #'    3. the workfile path expression, should be in format like: ``app://relpath/to/file.ext``
+#' @param ssid the session id for multiple user environment, default NULL means global user environment
+#' 
+#' @return the data file path of the required reference file inside this workflow 
 #' 
 #' @details the workfile path expression is in format string of: ``app://filepath``,
 #'    example as ``getMzSet://mzset.txt``, where we could parse the reference information
 #'    from this character string: app name is ``getMzSet``, and the relpath data is
 #'    ``mzset.txt``. so, such configuation could be equals to the function invoke
 #'    of the workfile function: ``workfile("getMzSet", "/mzset.txt");``.
 #' 
-const workfile = function(app, relpath = NULL) {
+const workfile = function(app, relpath = NULL, ssid = NULL) {
     if (is.empty(relpath)) {
         if (is.character(app)) {
             relpath <- __workfile_uri_parser(app);
 
             # gets the internal workfile reference
             # its physical file path
-            file.path(WorkflowRender::workspace(relpath$app), relpath$file);
+            file.path(WorkflowRender::workspace(relpath$app, ssid), relpath$file);
         } else {
             throw_err("the given expression value should be an internal workfile path reference!");
         }
     } else {
-        file.path(WorkflowRender::workspace(app), relpath);
+        file.path(WorkflowRender::workspace(app, ssid), relpath);
     }
 }
 
 #' Get workspace root directory
 #'
+#' @param ssid the session id for multiple user environment, default NULL means global user environment
 #' @details actually this function will returns the ``output`` dir 
 #'    path which is set via the ``init_context`` function
 #' 
-const workdir_root = function() {
-    .get_context()$root;
+const workdir_root = function(ssid = NULL) {
+    .get_context(ssid)$root;
 }
 
 #' get directory folder path for the analysis output result
 #' 
+#' @param ssid the session id for multiple user environment, default NULL means global user environment
 #' @details a character vector of the analysis result output directory.
 #' 
-const result_dir = function() {
-    .get_context()$analysis;
+const result_dir = function(ssid = NULL) {
+    .get_context(ssid)$analysis;
 }

R/definePipeline.R

@@ -4,9 +4,11 @@
 #' 
 const definePipeline = function(seq) {
     const ctx = .get_context();
+    const ssid = NULL;
+
     ctx$pipeline = seq;
     # update the global context symbol
-    set(globalenv(), __global_ctx, ctx);
+    set(globalenv(), paste([__global_ctx,ssid],sep ="-"), ctx);
 
     invisible(NULL);
 }

R/finalize.R

@@ -1,15 +1,18 @@
 #' Mark end of the analysis workflow
 #' 
+#' @details this function used for unload a specific workflow environment
+#' 
+#' @param ssid the session id for the multiple user environment,default NULL means global session environment
 #' @details release the resources of the pipeline workflow modules
 #' 
-const finalize = function() {
+const finalize = function(ssid=NULL) {
     # saveRDS(.get_context(), file = `${.get_context()$root}/.workflow.rds`);
 
     print("workflow finalize, ");
     print(`*** Elapsed time '${time_span(now() - .get_context()$t0)}' ***`);
 
     # unload the workflow context environment
-    rm(list = __global_ctx);
+    rm(list = paste([__global_ctx,ssid], sep="-"));
 
     sink();
 }

R/utils/utils.R

@@ -4,8 +4,8 @@
 #' @param msg a character vector of the warning message that this
 #'    workflow produced.
 #'
-const echo_warning = function(msg, app = NULL) {
-    const warning_log = `${.get_context()$temp_dir}/warning`;
+const echo_warning = function(msg, app = NULL, ssid = NULL) {
+    const warning_log = `${.get_context(ssid)$temp_dir}/warning`;
     const link = file(warning_log, "append");
     const app_name = get_app_name(app);